How to Automate Git Deployment

Time needed: 3 minutes

Connecting your Git repository with our Admin Panel for your site is easy with the following steps:

1. Create a site on your Bolt for each stage in your pipeline

   One site can only be connected to one branch. If you want a dev/stage/prod setup, you would need one site for dev, one for staging, and one for production.

2. Create branches for each stage in your pipeline.

   Within your Git repository, create a branch for each stage in your pipeline. For most, this would be developing, staging, and master. It’s highly recommended that the staging and master branches be protected to ensure no developer accidentally merges into or commits to them.

3. Set up the Git integration on each site.

   In the Admin Panel, set up the integration by adding the SSH URL and typing in the name of the branch you want to connect to your site. For the dev site on your Bolt, you should connect your development branch, and so on.
   
   When the SSH URL and branch are entered correctly, click “Enable Git”.

4. Create a deploy key.

   After enabling Git, you will see a pop-up window that displays a deployment key. This key needs to be added to your Git repository as a deploy key so that our Admin Panel can read the Git repository.
   
   Click anywhere on the key to copy it.
   
   

5. Add the deploy key to your repository.

   First, navigate to the page in your Git repository where you can add deploy keys. For GitHub, the deploy key is added via Settings -> Deploy key.
   
   Paste the key from the Admin Panel into the “Key” field. Then, give the key a name in the name field that identifies what site it is for. These keys don’t need write access.
   
   Click “Add key” to save.

6. Enable automatic deployment with the Deployment URL
   Once your repository is connected, you’ll see a deployment configuration screen in the Admin Panel.
   
   
   
   To enable automatic deployments, copy the Deployment URL and add it as a webhook in your Git repository settings. This ensures that a deployment will be triggered automatically when you push changes to the selected branch.
   
   You can also trigger a manual deployment anytime by clicking Deploy Now.

7. Configure Git to trigger the webhook.

   Navigate to your repository’s Webhook Admin Page. For GitHub, the Webhook Admin Page is located at Settings -> Webhooks.
   
   Click “Add Webhook” on the Webhook Admin Page.
   
   
   In the Add Webhook form, paste the Webhook URL copied from the Servebolt Admin Panel into the URL/Payload URL field. The content type can be left at the default setting, and the secret should be blank. It is highly recommended that SSL verification be enabled.
   
   It should be set only to send push events unless you have other specific events for which you want to trigger a deployment.