Github Deployments

Github Deployments

In your Account Settings, you can configure Release to create Github Deployments when your environments are being created and deployed.

Access your Account Settings

At the bottom of the Account Info tab in your Account Settings, you will find your Github Settings.

Account Settings for Github

Account Settings for Github

The setting Send deployment updates from Release to Github PR's is off by default. Turning this setting on will create deployments. If you're unfamiliar with them, please refer to Github's Deployments docs.

Release will create either a pending deployment when the environment is being created, a successful deployment if the environment successfully deploys, or an errored deployment if something goes wrong while deploying the environment.

Successful Github Deployment

The format of the name for the deployment is <App Name>: <User Name>-<Environment Name> (<Environment Handle>). The View Deployment button will appear if your application has a single hostname. If your application has multiple hostnames, you can set a Primary App Link to let Release know which hostname it should use.