GitHub Integration

GitHub vs Git

Git is a revision control system that means it's a tool for source code history management. GitHub is a service that hosts Git repositories. In short GitHub is a service for projects that use the Git tool.
The Git tool has always been available on our platform through the CLI.

How to setup GitHub Integration

In the CCP, go to your site management section > Application > Github Integration

Setup a GitHub repository. Click here to learn how to do it.

If you created a public repository paste the URL in the Repository URL box and click Enable.

If the repository is private add the provided SSH key in the Settings > Deploy Keys section of your GitHub repository. Write access is not recommended.

Your repository will now be cloned onto the site 

The private key resides on our platform and is never publicly exposed.

Important: Public repos will be visible to public. This could lead to leaked information.

Enabling automated deployment

To enable automated deployment, please follow the mentioned steps:

1. Visit your GitHub repository settings page.
2. Under the Webhooks section, click "Add Webhook" button.
3. Set the Payload URL to the one displayed on your GitHub integration page in CCP
4. Select the event: "Just the push event".
5. Check the "Active" box and click "Add Webhook".
6. You have now successfully set up automatic deployment,
7. You may also use the Payload URL to force pull the repository on your site at any time.