From Github events

Suppose you want to trigger a pipeline or release on a successful PR merge on GitHub or when a code is pushed to a particular branch, they can create a webhook using the webhook type as GitHub.

Steps to create a Github Webhook for release

Pre-requisites:

• An active GitHub account with repositories needs to have the PAT(Personal Access Token) which can be entered while creating GitHub integrations

• An Active cluster

• A Release that has been created from the Release Templates section

Steps

1. On click of the create webhook button, a modal window appears in which you can enter the details for webhook creation

1. Now we need to select the Webhook Type as Github from the Webhook Type dropdown

1. After selecting the webhook type as Github, a dropdown will be shown to select the repository for which the webhook needs to be created

1. Once the repository has been selected, users have the option to select the event for which they want the pipeline or release to be triggered Ozone offers 2 events for which webhooks can be created: - Push branch - whenever code is pushed to the specified branch the webhook is triggered - Pull request - whenever a pull request is merged at that point the webhook will be triggered

1. After selecting the event, users are provided an option to select the branch for the repository for which they want the webhook to be triggered

1. Once the branch has been selected, the next option is provided for the users to select as to whether they want to trigger a release or a pipeline on the successful happening of the event that they had selected

Here we will select the option of Release

1. After this users can select the release which they want to be triggered

1. Once every option has been selected the map parameters option will be enabled and users can click on it to move to the next step

9. After going to the second step users can choose the input run parameters, once all these options have been selected, users can click on the save button to create the webhook

1. Once the webhook has been created, it will be shown in the tabular list view

Here you can see it shows when was the webhook last triggered, as well as we can enable/disable the webhook from the tabular list, and we can click on the edit icon to edit the webhook.

Steps to create webhook for pipeline

Pre-requisites:

• An Active cluster

• A microservice

Follow the same steps until Step 5 of Creating Webhooks for release

Steps:

1. Once the repository name and the branches have been selected select the trigger type as Pipeline

1. Once the Trigger type has been selected, now select the pipeline that needs to be triggered

1. After selecting the pipeline, select the environment in which the webhook needs to be created Remember to select the environment the same in which the cluster has been created

1. After selecting the environment, users will be shown an option to select the cluster

1. Once the cluster has been selected, select the microservice

6. After selecting the microservice, users can move to the Map parameters step, to select the run parameters for the pipeline

7. In Map parameters, users can select all the options as they desire.

8. Once all this is done, users can click on the Save button to create the webhook for the pipeline.

9. The created webhook will be shown in the webhook list view

Users can click on the edit icon to edit the webhook, and click on the toggle button to enable/disable the webhook.

Hurray 🥳This is how you can create the webhooks for GitHub to trigger a release or a pipeline.