Connecting GitHub
Sign in with GitHub
Use Continue with GitHub on the sign-in page, or link GitHub to an existing account. Vantrex needs this to know which installations belong to you.
Install the app
From New project, choose Install. GitHub asks which account and which repositories. You can grant a single repository and add more later in GitHub's settings.
Import
Pick the repository, check the detected framework and settings, and confirm. The default branch becomes the production branch.
What happens on a push
- GitHub tells Vantrex about the push. The message is signed and checked before anything happens.
- A deployment is queued for the commit and the build starts. GitHub shows its progress as a commit status.
- On success, the deployment is Ready. For the production branch, production is updated; for any other branch, only that branch's preview address moves.
A failed build never replaces a working deployment, so a broken push cannot take the live site down.
Preview addresses
Every deployment is reachable at three kinds of address:
| Address | Points at |
|---|---|
project.vtrex.app | The current production deployment. |
project-git-branch.vtrex.app | The latest deployment of that branch. Long or unusual branch names are shortened and made safe for use in a hostname. |
project-pr-12.vtrex.app | The latest deployment of pull request 12. |
project-a1b2c3.vtrex.app | One specific deployment. It never changes. |
Pull requests
Each pull request gets its own address that follows its newest commit. Vantrex reports status back to GitHub so reviewers can open the preview from the pull request.
Who can use an installation
A GitHub installation is tied to a GitHub account, not to a Vantrex account. Vantrex asks GitHub, with your own sign-in, which installations you can access, and only lists and imports repositories from those. If you have not signed in with GitHub, or the sign-in has expired, you will be asked to connect it again.
Disconnecting
Removing a project from Vantrex does not touch the repository. To revoke access entirely, uninstall the app from your GitHub account's Applications settings. Projects linked to it keep their existing deployments but stop updating from pushes.