Github Action to deploy onto Aptible Deploy

This action deploys a Docker image to Aptible Deploy. To use this image, you should use another workflow step to publish your image to a Docker image registry.

If you are using a private registry, you can setup Private Registry Authentication once ahead of time using the Aptible CLI.

aptible config:set \
  --app "$APP_HANDLE" \
  "APTIBLE_PRIVATE_REGISTRY_USERNAME=$USERNAME"
  "APTIBLE_PRIVATE_REGISTRY_PASSWORD=$PASSWORD"

Required input and output arguments

Optional input and output arguments

Secrets the action uses

Environment variables the action uses

The converstion from var to INPUT_VAR is how GitHub Actions handle Inputs.

• username - passed to aptible CLI
• password - passed to aptible CLI
• environment - specifies App to be deployed
• app - specifies App to be deployed
• docker_img - the name of the image you’d like to deploy, including its repository and tag
• private_registry_username - the username for the private registry to pull a docker image from
• private_registry_password - the password for the private registry to pull a docker image from

Example github actions usage

jobs:
  deploy:
    runs-on: ubuntu-latest

    steps:
    - name: Deploy to Aptible
            uses: aptible/aptible-deploy-action@master
            with:
              username: <aptible username>
              password: <aptible password>
              environment: <environment name>
              app: <app name>
              docker_img: <docker image name>
              private_registry_username: <username>
              private_registry_password: <password>