Velo: Integrating Your Site With GitHub

When you connect your site to GitHub, several changes occur in the workspace. This articles explains these changes, and details how to disconnect your site from GitHub if you want to revert to normal editor use.

The GitHub Integration panel

When you connect your site to GitHub, a GitHub repository is created to store your site's code. Once this happens, the code in the editor is synced with the default branch of this repo.

The name of the connected repo as well as the details of commits to the default branch appear in the GitHub Integration panel of the sidebar.

About read-only mode

While your site is connected to GitHub, the editor is in read-only mode. This involves the following changes:

• Code files are read-only. You can't make any changes to your site's code or add new files. Use your local IDE to add new files and change code.
• You can add dynamic event handlers to elements using code. To see the event handlers supported for each element, check the Velo API Reference.
• Changes to the fields in a collection are immediately reflected on your live site, even before you publish.
• If you duplicate a page on your site, the page's code isn't included in the copy.

Disconnect your site from GitHub

If you need to, you can disconnect your site from GitHub. When you do this, the site retains the code from the most recent commit to its GitHub repo's default branch. After disconnecting, the repo still exists in GitHub but changes to it aren't reflected on your site. Once your site is disconnected from GitHub, the editor exits read-only mode.

To disconnect from GitHub:

1. Click the GitHub Integration icon on the sidebar.

   

2. Hover over your repo's name and click the More Actions icon.

   

3. Select Disconnect from GitHub.

   

4. In the modal, click Disconnect from GitHub.