Action Deploy on Managed Instance

Github action for deployment on managed instance.

Usage

1. Create a .github/workflows/deploy.yml file in your GitHub repo, if one doesn't exist already.
2. Add the following code to the deploy.yml file.

on: push
name: Deploying WordPress Site
jobs:
  deploy:
    name: Deploy
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: Deploy
      uses: docker://ghcr.io/rtcamp/action-deploy-on-managed-instance:latest
      env:
        SSH_PRIVATE_KEY: ${{ secrets.SSH_PRIVATE_KEY }}
        NPM_VERSION: 7.20.5
        NODE_VERSION: 14.17.6
        BUILD_DIRECTORY: buildDirectory/
        BUILD_COMMAND: echo "buildCommand"
        BUILD_SCRIPT: path/to/custom/script.sh
        DEPLOY_LOCATIONS: ./locations.csv
        VIP: false

3. Create SSH_PRIVATE_KEY secret using GitHub Action's Secret and store the private key that you use use to ssh to server(s) defined in hosts.yml.
4. Create .github/hosts.yml inventory file, based on Deployer inventory file format. Make sure you explictly define GitHub branch mapping. Only the GitHub branches mapped in hosts.yml will be deployed, rest will be filtered out. Here is a sample hosts.yml.

Environment Variables

This GitHub action's behavior can be customized using following environment variables:

NOTE (For locations.csv): if trailing slash is not specified, then folder along with all files will be deployed. if trailing slash is appended to it content of the folder will be deployed.

Maintainer

rtCamp Maintainers:

Default Branch

main

Branch naming convention

• For bug - fix/issue-name For example, fix/shell-script-errors
• For feature - feature/issue-name For example, feature/add-plugin

Pull Request and issue notes

• Title should be same as Issue title. Also add issue number before title. For example, AC-3 Added support for EC2.
• Add proper description.
• Assign reviewer.
• PR should have one approval.

Repo integrations

• Runs on Docker 😎
• Now configurable for github modules