Skip to content

Latest commit

 

History

History
123 lines (100 loc) · 3.86 KB

README.md

File metadata and controls

123 lines (100 loc) · 3.86 KB
Raw

ci-docker-image

dokku/ci-docker-image

A Docker image meant for use with CI/CD pipelines

Supported CI Systems

Assuming a Docker image can be run as a CI task with environment variables injected, the following CI systems will have their variables automatically detected:

Usage

This image provides two binaries for external usage:

  • dokku-deploy: Triggers an app deploy at the configured GIT_REMOTE_URL
  • dokku-unlock: Unlocks deploys for an app at the configured GIT_REMOTE_URL

To run either binary, the following docker command can be used from a directory containing a non-shallow clone of the repository being deployed:

# where the `.env` file contains `GIT_REMOTE_URL` and `SSH_PRIVATE_KEY`

# deploy
docker run --rm -v="$PWD:/app" --env-file=.env dokku/ci-docker-image dokku-deploy

# unlock
docker run --rm -v="$PWD:/app" --env-file=.env dokku/ci-docker-image dokku-unlock

Configuration

The following environment variables are supported:

  • BRANCH:
    • description: The branch to deploy when pushing to Dokku
    • required: false
    • default: ''master
  • CI_BRANCH_NAME
    • description: The branch name that triggered the deploy. Interpolated if unavailable.
    • required: false
    • default: ''
  • CI_COMMIT
    • description: The commit sha that will be pushed. Interpolated if unavailable.
    • required: false
    • default: ''
  • COMMAND:
    • description: The command to run for the action
    • required: false
    • default: ''
  • DEPLOY_DOCKER_IMAGE:
    • description: A docker image to deploy via git:from-image
    • required: false
    • default: ''
  • DEPLOY_USER_NAME:
    • description: A username to use when deploying a docker image
    • required: false
    • default: ''
  • DEPLOY_USER_EMAIL:
    • description: The email to use when deploying a docker image
    • required: false
    • default: ''
  • GIT_REMOTE_URL:
    • description: The dokku app's git repository url (in SSH format)
    • required: true
  • GIT_PUSH_FLAGS:
    • 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: 'review-$APP_NAME-$CI_BRANCH_NAME'
  • SSH_HOST_KEY:
    • description: The results of running ssh-keyscan -t rsa $HOST
    • required: false
    • default: ''
  • SSH_PRIVATE_KEY:
    • description: A private SSH key that has push acces to your Dokku instance
    • required: true
  • TRACE:
    • description: Allows users to debug what the action is performing by enabling shell trace mode
    • required: false
    • default: ''

Hooks

bin/ci-pre-deploy

If the file bin/ci-pre-deploy exists, it will be triggered after any app setup but before the app is deployed. This can be used to preconfigure the remote app prior to the actual deploy, but within the context of the SSH setup. The following environment variables are available for usage in the script:

  • APP_NAME: The name of the remote app that will be deployed. This takes the parsed GIT_REMOTE_URL and REVIEW_APP_NAME into account.
  • IS_REVIEW_APP: true if a review app is being deployed, false otherwise.
  • SSH_REMOTE: The parsed ssh remote url.

The following is an example bin/ci-pre-deploy file:

#!/bin/sh -l
if [ "$IS_REVIEW_APP" = "true" ]; then
  ssh "$SSH_REMOTE" -- config:set "$APP_NAME" "DOMAIN=$APP_NAME.dokku.me"
  echo "configured the review app domain"
fi

Building

docker build dokku/ci-docker-image .