Add Deployment
Deployments are requests to deploy a certain ref (branch, SHA, tag). When new deployments are generated, Git providers send out a deployment event that external services can listen for and act on. InstaWP allows you to connect your existing Git repos — public or private — from any Git provider (GitHub, GitLab, Bitbucket, etc.) to your account.
In this documentation, we will explore the steps to add a new deployment for both repo types.
Let’s get started 🚀
Add a deployment
Step 1: Go to Settings and select the Deployments option from the drop-down list. Now, click Add New from the top right corner of the screen.
Step 2: A modal window will appear, requesting you to enter the values in the following fields:
| Fields | Description |
|---|---|
| Repo Type | Select Public for a public Git repository or Private for a private one. |
| Repo URL | For a public repo, paste the “HTTPS URL” (for example, https://github.com/yourname/yourplugin.git). For a private repo, paste the “SSH URL” (for example, git@github.com:yourname/yourplugin.git). |
| Branch | Mention the branch to which this deployment points. |
| Destination Folder | The folder to which your repository content will be downloaded. |
| Post Deployment Commands | Shell commands that will run after the git repository is cloned (for example, composer install, npm install, npm run dev, wp-config set WP_DEBUG true --raw). |
| SSH Key Pair | Private repos only. Select an SSH key pair or generate one to work with a private repository easily, without username and password authentication. |
The post-deployment commands feature is available in the Professional plan and above. View Pricing here. If you are not logged in, use this link to view pricing.
Fill out the options with the values and click Add. It'll be added immediately.
Public repository
Select Public for the Repo Type field and paste the HTTPS URL of your repository.
Private repository
Select Private for the Repo Type field, paste the SSH URL of your repository, and select (or generate) an SSH key pair.
Step 3 (private repos only): Open the settings page for your GitHub repository and add the generated public key to the repository’s Deploy keys.
| 💡 Did you know - You can select the repository to deploy when the site is created from the template. Learn about connect deployment to an existing site.
Helpful Links
https://github.com/GatoGraphQL/GatoGraphQL/blob/master/.github/workflows/integration_tests.yml