Link your GitHub account with your personal account or team on Vercel from your dashboard by clicking "Import Project" followed by "From Git Repository". Then, click "Install Vercel for GitHub".
The "You own the Repository" section with a prompt to install Vercel for GitHub.
Once you have authorized the GitHub integration, you will be redirected back to the "Import Git Repository" page where you can import a project from an existing repository by clicking the "Import Project from GitHub" button.
Vercel for GitHub installed and ready to set up a project.
Vercel for GitHub will deploy every push by default. This includes pushes and pull requests made to branches. This allows those working within the repository to preview changes made before they are pushed to production.
With each new push, if Vercel is already building a previous commit, the current build will be canceled to build the most recent commit so that you always have the latest changes deployed as quickly as possible.
If Custom Domains are set from a project domains dashboard, pushes and merges to the Production Branch (commonly "main") will be made live to those domains with the latest deployment made with a push.
If you decide to revert a commit that has already been deployed to production, the previous Production Deployment from a commit will automatically be made available at the Custom Domain instantly; providing you with instant rollbacks.
The latest push to any pull request will automatically be made available at a unique preview URL based on the project name, branch, and team or username. These URLs will be provided through a comment on each pull request.
If you receive a pull request from a fork of your repository and there is either a change to the vercel.json file or there are Environment Variables used in your project; Vercel will require an authorization from you or a member of your team to deploy the pull request.
This behavior protects you and your project from a leak of sensitive information.
Extending Your GitHub Workflow
Vercel for GitHub uses the deployment API to bring you an extended user interface both in GitHub, when showing deployments, and Slack, if you have notifications setup using the Slack GitHub app.
Due to using GitHub's Deployments API, you will also be able to integrate with other services through GitHub's checks. Vercel will provide the deployment URL to the checks that require it, for example; to a testing suite such as Checkly.
User permissions allow us to offer an enhanced experience through information about the connected user.
Allows us to associate an email with a GitHub account.
Note: We use the permissions above in order to provide you with the best possible deployment experience. If you have any questions or concerns about any of the permission scopes, please reach out to email@example.com.
Disconnect from GitHub
To disconnect your personal account or team on Vercel from GitHub, take the following steps:
First, click here to go to the Settings page on GitHub.
Then, if you've installed Vercel for your personal GitHub account, click on Applications.
Application Settings on GitHub.
Or, if you've installed Vercel for your organization GitHub account, first click on the organization name: