GitHub
Connect#
On New project, choose Connect GitHub. You are sent to GitHub to install the HostEdge app on your account or organization and pick which repositories it can read. HostEdge asks only for what it uses: repository contents (read), metadata (read), commit statuses (write) and pull requests (write, for the preview comment).
Import a repository#
Pick a repository from the list. HostEdge detects the framework from the default branch and deploys it. The default branch becomes the production branch; change it in Project › Settings.
Connect a project you already deployed#
Deployed from a folder, the CLI or a template first? Open Project › Settings › Git repository and choose Connect repository. Pick the repository and, if you like, a production branch (the default branch otherwise). From then on, pushes to that branch deploy to this same project and other branches get previews. The project keeps its URL, domains, analytics and history.
Connecting does not deploy anything by default, so the live site stays as it is until the next push. Turn on Deploy this branch now to publish the branch immediately instead. You can still deploy from a folder or the CLI afterwards, and Disconnect unlinks the repository again.
If you have not connected GitHub yet, the dialog sends you to GitHub to install the HostEdge app first; come back to the project's settings afterwards to finish.
Push to deploy#
- A push to the production branch creates a production deployment.
- A push to any other branch creates a preview with its own moving URL.
- Deleting a branch removes its moving preview URL. Each deployment's own URL keeps working.
Commit statuses and pull requests#
Each commit gets a HostEdge (or HostEdge Preview) status that links to the deployment while it builds and to the site when it's ready. Pull requests get one comment with the preview link, updated on every push.
Disconnect#
Remove the HostEdge app from the repository in GitHub's settings. Existing deployments stay online.