Skip to main content

A middleman between GitLab and Discord webhooks to show better formatted messages.

Project description

GitLab Discord Webhook

PyPI - Version PyPI - Python Version PyPI - Downloads

A middleman between GitLab and Discord webhooks to show better formatted messages.

Use instructions

In order to use this, you must have a public IP address, with port 7400 open.

  • Install modules in requirements.txt (python 3.10 or higher)
python -m pip install -r requirements.txt
  • Create a config.ini file, you can copy and rename config-example.ini.
  • Create a discord webhook on the desired channel, and paste the URL in the webhook entry.
  • Execute main.py
  • Go to the desired GitLab project and go to Settings > Integrations
  • Paste the public address of your instance
  • Select the desired Triggers.
  • Click Add Webhook.

From now on, changes to the project will be posted on the specified channel. You can have multiple projects pointing to the same gitlab-discord-webhook instance, but every instance will only post messages through a single Discord webhook.

Supported Triggers

  • Push events
  • Tag push events
  • Comments
  • Confidential Comments
  • Issues events
  • Confidential Issues events
  • Merge request events
  • Job events
  • Pipeline events
  • Wiki Page events

Running from Docker

Docker Image Version Docker Image Size Docker Pulls

The image can be pulled from Docker Hub:

docker pull galarzaa90/gitlab-discord-webhook:latest

Alternatively, the image can be built from the root of the project's source.

docker build . -t gitlab-discord-webhook:local

To run the image:

docker run -p 7400:7400 --rm -ti gitlab-discord-webhook:local

References

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gitlab_discord_webhook-0.2.0.tar.gz (11.3 kB view details)

Uploaded Source

Built Distribution

gitlab_discord_webhook-0.2.0-py3-none-any.whl (9.8 kB view details)

Uploaded Python 3

File details

Details for the file gitlab_discord_webhook-0.2.0.tar.gz.

File metadata

File hashes

Hashes for gitlab_discord_webhook-0.2.0.tar.gz
Algorithm Hash digest
SHA256 d43529c66367a17fb9936e81f53c5ba2bb1d29ca8d4d701100b19c55def63d99
MD5 98a23902ac8596e945eed9ee1891a8ee
BLAKE2b-256 4e25cc2c1969103723c24cc560442c9c3a0c9ed6f05b108d98126046a9f21742

See more details on using hashes here.

File details

Details for the file gitlab_discord_webhook-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for gitlab_discord_webhook-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9aff4418f82a2a56d6b5fbf33c9fec0e2a30588260fdc7448bc5147309f00c3e
MD5 f7130cadf4ee98448ac649656b62fca9
BLAKE2b-256 ac4f587eab1c2cb8963ed8698d31f4e71e4d79a395b65986c0ef0ce94bb0a4f9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page