Update an environment’s deploying branch
Environments with Default Deployment enabled are configured to track a specific branch of an application’s wpcomvip GitHub repository. For example, new production environments are set up to track a branch named production by default. Pushing any changes to this branch (via a push, merge, or rebase) triggers an automatic deployment to the production environment.
The branch of an application’s wpcomvip Github repository that deploys to an environment can be updated in the VIP Dashboard.
Limitation
The suffix *-built is reserved for the naming of branches that are created for a continuous integration and deployment (CI/CD) method.
Do not configure a branch to deploy to an environment that is named with the suffix *-built (e.g. develop-built) and is not part of a CI/CD method.
Access
Prerequisite
To change an environment’s deploying branch, a user must have at minimum an Org admin role or an App admin role for that application.
- Navigate to the VIP Dashboard for an application.
- Select an environment from the environment dropdown located at the upper left of the VIP Dashboard.
- Select “Code” from the sidebar navigation at the left of the screen.
- Select “Repository” from the submenu.
Update the deploying branch
Prerequisite
The branch deploying to an environment can only be updated on an environment that has Default Deployment enabled.
In the Repository Management panel of the VIP Dashboard:
- In the field labeled “Branch Name“, enter the name of the repository branch that should deploy to the environment after the update. As characters are entered into the search field, existing branches of the application repository that match the characters can be selected from a dynamically generated dropdown list. If a repository has more than 100 existing branches, the dropdown list will not be generated and the full name of a branch must be entered by typing instead.
- Select the button labeled “Change Branch and Deploy“.
Successfully updating the deploying branch will trigger a code deployment to the environment from the newly configured branch.
If the branch name entered in the field does not exist in the application’s GitHub repository, the process will fail and no code deployment will occur.
The progress of the code deployment of the updated branch can be monitored in the Deployments panel for that environment.
Last updated: October 24, 2024