https://github.com/thadeu/easily-dokku-action

⚡️Github action for dokku
https://github.com/thadeu/easily-dokku-action

actions ci-cd dokku

Last synced: 11 days ago
JSON representation

⚡️Github action for dokku

• Host: GitHub
• URL: https://github.com/thadeu/easily-dokku-action
• Owner: thadeu
• License: mit
• Created: 2020-01-30T18:11:18.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2020-01-30T21:10:09.000Z (about 5 years ago)
• Last Synced: 2024-07-07T09:05:57.701Z (7 months ago)
• Topics: actions, ci-cd, dokku
• Language: Shell
• Size: 18.6 KB
• Stars: 14
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Dokku for GitHub Actions

Deploy an application to your Dokku server over SSH.

## Usage

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

```yaml

name: deploy

on:

  push:

    branches:

      - master

jobs:

  deploy:

    runs-on: ubuntu-18.04

    steps:

      - name: Checkout

        uses: actions/checkout@v1

        with:

          fetch-depth: 0

      - name: Deploy the application

        uses: thadeu/[email protected]

        env:

          BRANCH: master # optional

          PROJECT: project-name

          FLAGS: --force # optional

          PORT: 22 # optional

          SSH_PRIVATE_KEY: ${{ secrets.DOKKU_PRIVATE_KEY }}

          SSH_PUBLIC_KEY: ${{ secrets.DOKKU_PUBLIC_KEY }}

          SSH_HOST: ${{ secrets.DOKKU_HOST }}

```

### Required Secrets

You'll need to provide some secrets to use the action.

- DOKKU_PRIVATE_KEY: Your SSH private key.

- DOKKU_PUBLIC_KEY: Your SSH public key.

- DOKKU_HOST: Your Host

# Required Environments

You'll need to provide some env to use the action.

- **BRANCH**: Repository branch that should be used for deploy: ie, `master`, default is `master`

- **PROJECT**: The project is Dokku project name.

- **FLAGS**: Your flags to git push

- **PORT**: Your port ssh server, default is 22

- **SSH_PRIVATE_KEY**: Your SSH private key.

- **SSH_PUBLIC_KEY**: Your SSH public key.

- **SSH_HOST**: The host the action will SSH to run the git push command. ie, `your.site.com`.

## License

The Dockerfile and associated scripts and documentation in this project are released under the [MIT License](LICENSE).