This document is a guide to setting up a webhook for CI jobs or Pipelines in Gearset, that deploys changes from an AWS CodeCommit repository whenever the source branch changes.
Before following this guide, you will need to ensure that:
you have added a connection to your AWS CodeCommit repository - see this guide for how to connect CodeCommit
the AWS CodeCommit repository you are connecting to is not blank and that there is at least one branch (e.g. main) to work with; otherwise, you will get an error when you select the Source repository field on the Add CI deployment job page.
In summary, per CI job or pipeline environment configured to instigate a specific action, you will need the following set up on the AWS side:
1 Simple Notification Service (SNS) Topic
1 Subscription
1 Trigger
1 EventBridge rule (optional - for forward-looking validations when opening a PR)
Creating a CI webhook for CodeCommit
To get started, from the Continuous integration page in Gearset, click
Add new deployment joborAdd new team-shared deployment job.Select
AWS CodeCommitas theSource type.
Under
Deployment behaviour, select when the source branch is updated.
Once you’ve configured the other options, click Save and you’ll see another dialog box with the webhook information in it. You’ll then utilise the Payload URL and Shared secret later on to create and configure your CodeCommit webhooks using this guide.
Creating a Pipelines webhook for CodeCommit
When configuring a Gearset Pipeline using AWS CodeCommit, you will also be asked to add a specific SNS Topic, Subscription & EventBridge Rule to allow all the Pipeline functionality to work as expected.
Head to the Pipeline page, and click on the settings cog, followed by 'Add webhook...'
This will bring up an informational modal explaining how to add in the SNS Topic, Subscription and EventBridge rule for your pipeline.
Note that this is over and above the CI job configuration SNS Topics and supporting elements written above, and is unique to setting up a pipeline.
Once you have noted down your Payload URL and shared secret, you will be able to follow this guide to create and configure your CodeCommit webhooks.