Github deployment pipeline
GitHub is a leading CI/CD tool primarily due to its integrated feature, GitHub Actions, which allows developers to automate build, test, and deployment workflows directly within their repositories.
Last updated
GitHub is a leading CI/CD tool primarily due to its integrated feature, GitHub Actions, which allows developers to automate build, test, and deployment workflows directly within their repositories.
Last updated
(c) 2011 - 2024 ilert GmbH
The ilert Github deployment pipeline offers 2 different modes of installation:
The webhook setup can be done without checking in code into repositories. It simply requires a webhook setup either on the repository itself or globally on the Github account level. The following webhook types are supported to create deployment events in ilert.
(Commit) Push
(Branch) Merge (closed + merge)
Release (published)
Using the ilert Github deployment events action: https://github.com/marketplace/actions/ilert-deployment-events more advanced users can setup fine tuned use cases e.g. to create the deployment event only on successful rollouts by embedding the action as part of their Github action workflows.
In any way a pipeline is required, which will also generate a new integrationKey
required to route deployment events when they occur. Head to your ilert account and navigate to Alert sources -> Deployment events
Head over to the deployment pipelines tab and click on Create new pipeline
Provide a name for your pipeline
Optional: And if you are going to manage branch specific deployments, choose the branches in the branch filter section for which you would like to create deployment events in ilert.
Optional: If you would like to use a global webhook flow, where you coordinate specific deployment events for different repositories across multiple pipelines, you can use the event filters to fine tune, which specific event types should create deployment events in ilert and drop other ones. (This is mainly usefull when using multiple Github account wide webhooks)
We generally recommend Release based deployment events, as these are the easiest to setup while providing the most foundated correlations. Note that Push based deployment events can become very spammy, especially when used with Github account wide webhooks.
In any way, by clicking on Create you should end up on the detail view of your Github deployment pipeline.
Providing you with a freshly generated integrationKey
and the copy & pastable URL ready for your webhook setup.
Head to your (or your organizations) Github accounts settings page Home -> Organization/Account -> Settings (top tab) -> Webhooks (left side menu) -> Add webhook
Create a new webhook by pasting the URL from your freshly created ilert deployment pipeline into the Payload URL field
Make sure to switch the content type to application/json and choose "Let me select individual events". Scroll down the list and choose whichever suits to your setup of Pull requests, Pushes and Releases
(you can also mark all and use the ilert event filter in your pipeline to switch faster in the future)
When you are done click on "Add webhook" for your webhook to be created. You are now all set and should see deployment events coming into your ilert account.
Head to your Github repository and navigate to Settings (top tab) -> Webhooks (left sidebar) -> Add webhook
Follow the account wide webhook setup above ^, to configure the webhook.
If you wish for more fine-tuned controll on when to trigger deployment events e.g. after successfully finishing your Kubernetes rollout, you can use the official ilert deployment events github action https://github.com/iLert/ilert-deployment-events-action to embed deployment events into your Github action workflows.
Shown in the samples above is how your deployment pipeline's integrationKey
is provided to the action via Github secrets variable. Which is the recommended way of embedding it into your flow.