refactor: use common dokku/ci-docker-image for managing pushes

This will allow us to support alternative CI systems by using the same image.

Author: Jose Diaz-Gonzalez

.github/linters/.yamllint.yml

@@ -0,0 +1,5 @@
+---
+extends: default
+
+rules:
+  line-length: disable

.github/workflows/lint.yaml .github/workflows/lint.yml.github/workflows/lint.yaml renamed to .github/workflows/lint.yml

@@ -28,30 +28,6 @@ jobs:
           config: '.github/linters/.markdown-lint.yml'
           args: './README.md'
 
-  shellcheck:
-    name: shellcheck
-    runs-on: ubuntu-20.04
-    steps:
-      - name: Clone
-        uses: actions/checkout@v2
-      - name: Run shellcheck
-        uses: ludeeus/action-shellcheck@d586102c117f97e63d7e3b56629d269efc9a7c60
-        # 1.0.0 => d586102c117f97e63d7e3b56629d269efc9a7c60
-
-  shfmt:
-    name: shfmt
-    runs-on: ubuntu-20.04
-    steps:
-      - name: Clone
-        uses: actions/checkout@v2
-      - name: Run shfmt
-        uses: luizm/action-sh-checker@802b81f66b6c31ea423aa41ad4f49f4b7b869272
-        # v0.1.8 => 802b81f66b6c31ea423aa41ad4f49f4b7b869272
-        env:
-          SHFMT_OPTS: -l -d -i 2
-        with:
-          sh_checker_shellcheck_disable: true
-
   yamllint:
     name: yamllint
     runs-on: ubuntu-20.04
@@ -61,3 +37,5 @@ jobs:
       - name: Run yamllint
         uses: ibiqlik/action-yamllint@b2aeacc1b7eeb8c23e84bba320d04fb5d6a323ee
         # v3.0.0 => b2aeacc1b7eeb8c23e84bba320d04fb5d6a323ee
+        with:
+          config_file: '.github/linters/.yamllint.yml'

Dockerfile

@@ -1,6 +1 @@
-FROM alpine:3.12.1
-
-RUN apk --no-cache add git==2.26.2-r0 openssh==8.3_p1-r0 && \
-    mkdir -p ~/.ssh
-
-COPY bin /bin
+FROM dokku/ci-docker-image:0.0.7

README.md

@@ -12,8 +12,24 @@ Please note that this action is compatible with `dokku >= 0.11.6`.
 
 __Optional__. The branch to deploy when pushing to Dokku (default to `master`). Useful when a [custom deploy branch](http://dokku.viewdocs.io/dokku/deployment/methods/git/#changing-the-deploy-branch) is set on Dokku.
 
+Example Value: `main`
+
+### `ci_branch_name`
+
+__Optional__. The branch name that triggered the deploy. Automatically detected from `GITHUB_REF`.
+
 Example Value: `develop`
 
+### `command`
+
+__Optional__. The command to run for the action (default: deploy).
+
+Valid Values:
+
+- `deploy`
+- `review-apps:create`: Used to create a review app - via `dokku apps:clone` - based on the `appname` configured in the `git_remote_url`. If the review app already exists, this action will not recreate the app. In both cases, the current commit will be pushed to the review app.
+- `review-apps:destroy`: Destroys an existing review app.
+
 ### `git_push_flags`
 
 __Optional__. A string containing a set of flags to set on push. This may be used to enable force pushes, or trigger verbose log output from git.
@@ -26,6 +42,15 @@ Example Value: `--force -vvv`
 
 Example Value: `ssh://dokku@dokku.myhost.ca:22/appname`
 
+### `review_app_name`
+
+__Optional__. The name of the review app to create or destroy. Computed as `review-$APPNAME-$BRANCH_NAME` if not specified, where:
+
+- `$APPNAME`: The parsed app name from the `git_remote_url`
+- `$BRANCH_NAME`: The inflected git branch name
+
+Example Value: `review-appname`
+
 ### `ssh_host_key`
 
 __Optional__. The results of running `ssh-keyscan -t rsa $HOST`. The github-action will otherwise generate this on the fly via `ssh-keyscan`.
@@ -55,30 +80,6 @@ zrrvVLniH+UTjreQkhbFVqLPnL44+LIo30/oQJPISLxMYmZnuwudPN6O6ubyb8MK
 -----END OPENSSH PRIVATE KEY-----
 ```
 
-## Arguments
-
-Arguments are optional, but may change the behavior of the action when specified. The following are the currently supported arguments and examples on how to specify them.
-
-### `review-apps:create`
-
-Used to create a review app - via `dokku apps:clone` - based on the `appname` configured in the `git_remote_url`. If the review app already exists, this action will not recreate the app. In both cases, the current commit will be pushed to the review app. Takes a second required argument as the name of the review app to create.
-
-Example:
-
-```yaml
-args: review-apps:create appname-${{ github.event.pull_request.number }}
-```
-
-### `review-apps:destroy`
-
-Destroys a review app. Takes a second required argument as the name of the review app to destroy.
-
-Example:
-
-```yaml
-args: review-apps:destroy appname-${{ github.event.pull_request.number }}
-```
-
 ## Examples
 
 All examples below are functionally complete and can be copy-pasted into a `.github/workflows/deploy.yaml` file, with some minor caveats:

action.yml

@@ -9,17 +9,29 @@ inputs:
   branch:
     description: 'The branch to deploy when pushing to Dokku (default: master)'
     required: false
-    default: "master"
+    default: 'master'
+  ci_branch_name:
+    description: 'The command to run for the action (default: deploy)'
+    required: false
+    default: ''
+  command:
+    description: 'The command to run for the action (default: deploy)'
+    required: false
+    default: 'deploy'
   git_push_flags:
-    description: "The dokku app's git repository url (in SSH format)"
+    description: 'The dokku app's git repository url (in SSH format)''
     required: true
   git_remote_url:
-    description: "A string containing a set of flags to set on push"
+    description: 'A string containing a set of flags to set on push'
+    required: false
+  review_app_name:
+    description: 'The name of the review app to create or destroy'
     required: false
+    default: ''
   ssh_host_key:
-    description: 'The results of running ssh-keyscan -t rsa $HOST.'
+    description: 'The results of running `ssh-keyscan -t rsa $HOST`'
     required: false
-    default: ""
+    default: ''
   ssh_private_key:
     description: 'A private SSH key that has push acces to your Dokku instance'
     required: true
@@ -31,7 +43,10 @@ runs:
   post-if: cancelled()
   env:
     BRANCH: ${{ inputs.branch }}
+    CI_BRANCH_NAME: ${{ inputs.ci_branch_name }}
+    COMMAND: ${{ inputs.command }}
     GIT_PUSH_FLAGS: ${{ inputs.git_push_flags }}
     GIT_REMOTE_URL: ${{ inputs.git_remote_url }}
+    REVIEW_APP_NAME: ${{ inputs.review_app_name }}
     SSH_HOST_KEY: ${{ inputs.ssh_host_key }}
     SSH_PRIVATE_KEY: ${{ inputs.ssh_private_key }}