Custom Deployment with continuous deployment
Custom Deployment enables application code to be developed in a version control system outside of an application’s wpcomvip GitHub repository. Repositories outside of the wpcomvip GitHub organization cannot utilize CircleCI supplied by WordPress VIP, but they are also not limited to CircleCI and any type of continuous integration and/or a continuous deployment (CI/CD) method can be utilized instead.
Prerequisites
- The target environment for the code deployment has the Custom Deployment feature enabled.
- A Custom Deployment token has been generated and its value is immediately accessible.
To automate the Custom Deployment process, CI/CD methods can be configured to do some or all of the following steps:
- Prepare the code in a built state.
- Archive the built code.
- Run the
vip app deploy
VIP-CLI command to deploy the archived file.
When the vip app deploy
VIP-CLI command is triggered, it must be populated with the correct values for the target environment (i.e. @<app-name>.<env>
) and use a valid Custom Deployment token.
The configurations required for a CD pipeline to perform these actions will vary depending on the CD method in use. The documentation or support resources for the CD method should be consulted for more information and guidance.
GitHub Actions
Code developed in a GitHub repository that has GitHub Actions available can fully automate the Custom Deployment process. An example of a fully-automated Custom Deployment process in a GitHub repository using GitHub Actions is available for reference.
Last updated: August 21, 2024