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 (from any Git provider such as Github, Gitlab, Bitbucket, etc) to your account.
In this documentation, we will explore the steps to add a new deployment.
Let’s get started 🚀
Step 1: Sign In to your InstaWP account to access the dashboard.
Step 2: Click on the Profile icon from the top-right corner and select the Deployment option from the dropdown menu.
This will take you to the Deployment page.
Step 3: Click on the Add New + button from the right top corner of the interface.
A new modal window will appear, requesting you to enter the values in the following fields:
In case you are connecting to a Private repository, you will be asked to generate an SSH Key pair.
Click on the + Generate New button to generate a public key, that you can copy and add to your Git repository.
Then, click on the Add button to add a new deployment to the InstaWP account.
At last, you will see a success message on your screen.
Add & Use SSH Keys
Add Commands
In this documentation, we will explore the steps to add a new deployment.
Let’s get started 🚀
Step 1: Sign In to your InstaWP account to access the dashboard.
Step 2: Click on the Profile icon from the top-right corner and select the Deployment option from the dropdown menu.
This will take you to the Deployment page.
Step 3: Click on the Add New + button from the right top corner of the interface.
A new modal window will appear, requesting you to enter the values in the following fields:
| Fields | Description |
|---|---|
| Repo type | The type of repositories selected from: Public for public repos & Private for private repos |
| Repo URL | Add the URL to your repo (for example - https://github.com/yourcompany/yourplugin). |
| Branch | Mention the branch which this deployment points (more on this later). |
| Destination Folder | The folder to which your repository content will be downloaded. |
| Post Deployment Commands | Shell commands will be run after the git repository is cloned (for example, composer install, npm install, npm run dev, wp-config set WP_DEBUG true --raw). |
In case you are connecting to a Private repository, you will be asked to generate an SSH Key pair.
Click on the + Generate New button to generate a public key, that you can copy and add to your Git repository.
Then, click on the Add button to add a new deployment to the InstaWP account.
At last, you will see a success message on your screen.
Related Articles
Add & Use SSH Keys
Add Commands
Updated on: 20/09/2023
Thank you!