Gearset

Once AWS CodeCommit is connected to Gearset and your CI job, webhook set-up is configured correctly by following our guide on <a href="https://docs.gearset.com/en/articles/2069379-getting-started-with-aws-codecommit-webhooks">Getting started with AWS CodeCommit webhooks</a>. Next, we will look at a few more steps to allow the webhook to trigger a CI job when a new PR is raised, in addition to when the PR is merged. This will create forward-looking validations against the target org when the PR is opened. This is line with the 'Validate pull requests targeting the source branch' option in your CI job settings.

Before you begin, you need your repository ARN from your existing configuration.

<code>Repositories</code> &gt; <code>&lt;Repository Name&gt;</code> (e.g. gearset_demo) &gt; <code>Settings</code>.

It will look something like arn:aws:codecommit:us-east-1:123725757452:SamCDemo.

- <code>Repositories</code> &gt; <code>&lt;Repository Name&gt;</code> (e.g. gearset_demo) &gt; <code>Settings</code>.
- It will look something like arn:aws:codecommit:us-east-1:123725757452:SamCDemo.

<code>Copy</code> and keep <code>&lt;Repository ARN&gt;</code> handy for a future step. Once you have obtained your repo's ARN, you are ready to configure EventBridge to integrate with Gearset:

Firstly, on your AWS console, <code>search</code> for <code>EventBridge</code>.

Click on the Amazon <code>EventBridge</code> service.

1. Select <code>EventBridge Rule</code> and click <code>Create Rule</code>.

Enter the event <code>&lt;Rule Name&gt;</code> and select <code>Rule with an event pattern</code> option. Then click <code>Next</code>.

In step 2 of ‘Build event pattern’ set <code>Event source</code> as <code>AWS events or EventBridge partner events</code>.

It is critical that only Pull Request events for the correct repository are sent. If misconfigured, Gearset may be sent other (or even all) AWS events. Carefully follow each step below to configure the event pattern:

1. Navigate to <code>Creation method</code> section on the same page.
2. Set <code>Method</code> as <code>Use pattern form</code>.
3. Under <code>Event Pattern</code>, select the following options in the drop-down:
 1. <code>Event source</code> = <code>AWS services</code>.
 2. <code>AWS service</code> = <code>CodeCommit</code>.
 3. <code>Event type</code> = <code>CodeCommit Pull Request State Change</code>.
4. Select <code>Specific resource(s) by ARN</code>.
 1. <code>Paste</code> your <code>&lt;Repository ARN&gt;</code> from earlier and click <code>Next</code>.

Go to the <code>Select target(s)</code> page, set <code>Target Type</code> as <code>AWS service</code>.

Under <code>Select a target</code>, choose <code>SNS topic</code>.

Choose the name of the <code>Topic</code> you had created as part of initial <a href="https://docs.gearset.com/en/articles/2069379-getting-started-with-aws-codecommit-webhooks">CodeCommit webhook setup</a>.

1. In the following example, the <code>Topic</code> name selected is <code>Webhook</code>.l

Click <code>Next</code>, <code>Next</code>, leaving each set of settings as their default.

On the final step, <code>Review</code> the setup and <code>Save</code> the configuration. Now, you can see new <code>Event rule</code> which you just created under <code>Events</code> &gt; <code>Rules</code>.

1. Firstly, on your AWS console, <code>search</code> for <code>EventBridge</code>.
 
 
 
2. Click on the Amazon <code>EventBridge</code> service.
 1. Select <code>EventBridge Rule</code> and click <code>Create Rule</code>.
 
 
 
3. Enter the event <code>&lt;Rule Name&gt;</code> and select <code>Rule with an event pattern</code> option. Then click <code>Next</code>.
 
 
 
4. In step 2 of ‘Build event pattern’ set <code>Event source</code> as <code>AWS events or EventBridge partner events</code>.
 
 
 
5. It is critical that only Pull Request events for the correct repository are sent. If misconfigured, Gearset may be sent other (or even all) AWS events. Carefully follow each step below to configure the event pattern:
 1. Navigate to <code>Creation method</code> section on the same page.
 2. Set <code>Method</code> as <code>Use pattern form</code>.
 3. Under <code>Event Pattern</code>, select the following options in the drop-down:
 1. <code>Event source</code> = <code>AWS services</code>.
 2. <code>AWS service</code> = <code>CodeCommit</code>.
 3. <code>Event type</code> = <code>CodeCommit Pull Request State Change</code>.
 4. Select <code>Specific resource(s) by ARN</code>.
 1. <code>Paste</code> your <code>&lt;Repository ARN&gt;</code> from earlier and click <code>Next</code>.
 
 
 
6. Go to the <code>Select target(s)</code> page, set <code>Target Type</code> as <code>AWS service</code>.
7. Under <code>Select a target</code>, choose <code>SNS topic</code>.
8. Choose the name of the <code>Topic</code> you had created as part of initial <a href="https://docs.gearset.com/en/articles/2069379-getting-started-with-aws-codecommit-webhooks">CodeCommit webhook setup</a>. 
 1. In the following example, the <code>Topic</code> name selected is <code>Webhook</code>.l
 
 
 
9. Click <code>Next</code>, <code>Next</code>, leaving each set of settings as their default.
 
 
 
10. On the final step, <code>Review</code> the setup and <code>Save</code> the configuration. Now, you can see new <code>Event rule</code> which you just created under <code>Events</code> &gt; <code>Rules</code>.

To ensure proper CodeCommit trigger configuration, double-check your setup looks like this:

This completes the setup process to allow newly-created PRs to trigger CI jobs and child validation jobs in Gearset using AWS CodeCommit. Test this configuration by creating a new PR to the branch that CI job is associated with, ensuring the validation job appears in Gearset's CI Dashboard:

Still need help? Contact our team, and we'll be happy to assist. See <a href="https://docs.gearset.com/en/articles/2288721-contacting-gearset-support">how to contact Gearset support</a>.

Required configuration for triggering CI validation after PR creation for AWS CodeCommit integration

EventBridge configuration for AWS CodeCommit

Find answers and get help from Intercom Support and Community Experts

Link, Press control-option-right-arrow to exit

Empty Help Center

Uh oh. That page doesn’t exist.

Disappointed

Neutral

Smiley

Thinking...

Searching through sources...

Analyzing...

Tickets submitted through the messenger or by a support agent in your conversation will appear here.