This document is a guide to setting up a webhook for Pipelines in Gearset, that deploys changes from an AWS CodeCommit repository when the source branch changes.
Prerequisites before setting up CodeCommit webhooks:
You have added a repository connection for AWS CodeCommit (see our guide on Integrating with AWS 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 creating your Gearset pipeline
You have followed our documentation for creating CI job webhooks for AWS CodeCommit
For Pipelines you will need:
1 SNS Topic and Subscription
1 Eventbridge Rule
1 Trigger
Creating a Pipeline webhook for CodeCommit
When configuring a Gearset Pipeline using AWS CodeCommit, you will be asked to add a specific SNS Topic, Subscription & EventBridge Rule to allow all the Pipeline functionality to work as expected.
If you haven't yet created a pipeline, see our documentation on creating a pipeline using the pipeline setup wizard.
Head to the Pipeline page, and click on the
Settingscog, followed byAdd webhook...
This will bring up an informational modal explaining how to add in the SNS Topic, Subscription and EventBridge rule for your pipeline.
Note down your
Payload URLandShared secret, and proceed with the following steps to add your webhook.
Adding a Webhook
In the AWS Management Console, go to the
Amazon SNSsection and searchSimple Notification Service.Create a
new topic, then create anew subscriptionfor that topic.Choose a name for your topic, and set its type as
standard.Set
ProtocoltoHTTPS.Set the
Endpointto thePayload URLyou have saved from Gearset’s webhook setup dialog earlier.
The new subscription’s ID will be
Pending confirmation.Click
Request confirmationsand hitrefreshin the table. The subscription should then be assigned a proper subscription ID.In the AWS Management Console, go to
AWS CodeCommit.For the repository you’re deploying, go to
Settings, and then toTriggers.Click
Create new trigger.Under
Events, selectPush to existing branch.Do not select any branches under
Brach namesso the webhook works for all branches in your pipeline.Select the
SNS topicyou created earlier.Under
Custom data, paste in theShared secretfrom Gearset’s webhook setup dialog earlier.
You can click Test trigger to confirm it can connect successfully. The next time you push to this branch, it will trigger the CI job in Gearset.
Setting up an EventBridge rule
Your pipeline webhook will need an EventBridge rule to function correctly. After you've created your Pipeline webhook, please refer to our guide on EventBridge configuration for AWS CodeCommit.