Skip to content

Latest commit

 

History

History
73 lines (54 loc) · 2.92 KB

README.md

File metadata and controls

73 lines (54 loc) · 2.92 KB
Raw

Custom dokku deploy for GitHub Actions (BYCODERS)

Deploy an application to bycoders dokku server over SSH.

Usage

To use the action add the following lines to your .github/workflows/main.yml

name: deploy

on: pull_request

jobs:
  deploy:
    runs-on: ubuntu-18.04
    steps:
      - uses: actions/checkout@v1
      - name: Deploy the application
        uses: ByCodersTec/deploy-dokku-action@main
        with:
          PRIVATE_KEY: ${{ secrets.SSH_PRIVATE_KEY }}
          PUBLIC_KEY: ${{ secrets.SSH_PUBLIC_KEY }}
          HOST: ${{ secrets.DOKKU_HOST }}
          PROJECT: project-name
          BRANCH: ${{ github.head_ref }}
          PROJECT_TYPE: ruby

Required variables

  • PRIVATE_KEY: Your SSH private key, preferably from Secrets.
  • PUBLIC_KEY: Your SSH public key, preferably from Secrets.
  • HOST: The host the action will SSH to run the git push command. ie, your.site.com.
  • PROJECT: The project name is used to define the app name.
  • BRANCH: Repository branch that should be used for deploy, master is set by default.
  • PROJECT_TYPE: (ruby, node, python, java, dockerfile) set or not the buildpack according to the project type
  • REVIEW_APP: (default true) generates a unique app name for the current branch (ex: projectname-branchname.bycodersapp.com)

Optional Variables

  • POSTGRES (Optional) if true, set up a postgres instance (Make sure that your app is using default DATABASE_URL env variable)
  • REDIS: (Optional) if true, set up a redis instance (Make sure that your app is using default REDIS_URL env variable)
  • ELASTICSEARCH: (Optional) if true, set up a elasticsearch instance (Make sure that your app is using default ELASTICSEARCH_URL env variable)
  • MONGO (Optional) if true, set up a mongo instance (Make sure that your app is using default MONGO_URL env variable)
  • RABBITMQ (Optional) if true, set up a RabbitMQ instance (Make sure thar your app is using default RABBITMQ_URL env variable)

Additional information

Every project needs a Procfile with initialization configuration. Content example:

web: bundle exec puma -C config/puma.rb
worker: bundle exec sidekiq -C config/sidekiq.yml
release: bundle exec rails db:migrate db:seed

Projects with a Sidekiq instance, require a DOKKU_SCALE configuration file setting number of instances for every resource. Content example:

web=1
worker=1

Projects that needs Elasticsearch instance, require the ELASTICSEARCH=true in deploy.yml file.

Projects that needs a REDIS inscance, require the REDIS=true in deploy.yml file.

Project types different from ruby that requires a postgres instance, needs the POSTGRES=true in deploy.yml file.

Projects that needs a MONGO inscance, require the MONGO=true in deploy.yml file.