From 69dd81860f90bf3f77680cd0ceb99df10a58623c Mon Sep 17 00:00:00 2001 From: Jose Diaz-Gonzalez Date: Wed, 30 Dec 2020 03:32:49 -0500 Subject: [PATCH] docs: add github actions documentation --- .../continuous-integration/github-actions.md | 31 +++++++++++++++++++ docs/template.html | 1 + 2 files changed, 32 insertions(+) create mode 100644 docs/deployment/continuous-integration/github-actions.md diff --git a/docs/deployment/continuous-integration/github-actions.md b/docs/deployment/continuous-integration/github-actions.md new file mode 100644 index 000000000..a42e5243d --- /dev/null +++ b/docs/deployment/continuous-integration/github-actions.md @@ -0,0 +1,31 @@ +# Github Actions + +The Dokku project has an official Githb Action available on the [Github Marketplace](https://github.com/marketplace/actions/dokku). The simplest usage example is as follows: + +```yaml +--- +name: 'deploy' + +on: + push: + branches: + - master + +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - name: Cloning repo + uses: actions/checkout@v2 + with: + fetch-depth: 0 + + - name: Push to dokku + uses: dokku/github-action@v1 + with: + git_remote_url: 'ssh://dokku@dokku.me:22/appname' + ssh_private_key: ${{ secrets.SSH_PRIVATE_KEY }} +``` + + +For further usage documentation and other advanced examples, see the entry on the [Github Marketplace](https://github.com/marketplace/actions/dokku). diff --git a/docs/template.html b/docs/template.html index b61210bb3..b7ab04ff6 100644 --- a/docs/template.html +++ b/docs/template.html @@ -176,6 +176,7 @@ Release Process Continuous Integration + Github Actions Gitlab CI Community Contributions