Installation

1. Proceed to the integration installation page on Sentry. Ensure that you're signed into the correct organization and click install.

2. Click to install
   
   This will open a new tab where you can configure your github deployment gate

3. Click Login with Github
   

4. Click the link to install the github application
   

5. Install the application
   

6. Select repositories to enable
   

7. Enable github deployment gate protection rules on your repository environments
   From your repository settings, click on Environments in the left-nav. Select the environment to configure. Turn on the protection rule for this application, then save the settings.
   

8. Configure the wait time for your application
   Return to the Github Deployment Gate application dashboard, which should now show your configured repositories. Configure your desired wait time.

How it works

This application assumes a specific workflow.
CI pipeline will register a release in Sentry. This can be done with the CLI or via the Sentry Releases Github Action. Sentry also requires code to be released to report new errors, which is typically accomplished via a canary release environment that is not blocked by a deployment rule. Then the full rollout would be blocked on the deployment rule. If the gate fails, the canary release would be rolled back, and if the gate passes, the full rollout would proceed apace.

There's a very simple example implementation of this in this demo application