自分で開発したウェブサービスの公開先として、最近は dokku で作った公開プライベート（＝自分専用）クラウド環境が重宝しています。デプロイはソースコードを git clone(pull) して git push するだけ、という非常に簡略化されていることに加え、やはり「自分専用（＝使いたいサブドメインを誰かに先に取られている心配がない）」という気持ちの余裕も以外と大きい気がしています。dokku の導入については過去の記事を参照してください：
・dokku でプライベート PaaS 環境を構築する（１）
・dokku でプライベート PaaS 環境を構築する（２）
【手順１ パスフレーズなしの秘密鍵／公開鍵を作成・登録】
GitHub Actions 内でデプロイを自動実行するため、パスフレーズ無しで作られた秘密鍵が必要です。というわけで、パスフレーズ有りの秘密鍵を使っている場合は作成および登録の再実行が必要になります。
まずは秘密鍵と公開鍵を（再）作成します。dokku サーバーのシェルにログインして、以下のコマンドを実行します：
この後、秘密鍵を作成するパスを入力するよう促されます。デフォルトでは "~/.ssh/id_rsa" が指定されているはずです。変更する場合は正しいファイルパスを入力、デフォルト設定のままで問題なければそのまま Enter を入力します。
次にファイルのパスフレーズを入力するよう促されますが、今回はパスフレーズのない秘密鍵および公開鍵のペアを作りたいので、空のまま Enter を押して先に進めます。パスフレーズの指定が終わると指定されたパスで秘密鍵および公開鍵が作成されます。特に秘密鍵の内容は手順２でも必要になるので、 cat コマンドで一度中身を確認しておきます（"-----BEGIN RSA PRIVATE KEY-----" で始まって "-----END RSA PRIVATE KEY-----" で終わる内容が表示されます）：
秘密鍵が作れたら dokku に登録します。上述のセットアップを既に別の（パスフレーズ付きの）秘密鍵で実施済みで、別の秘密鍵が登録済みの場合は、以下のコマンドで一度削除しておきます：
改めて（再度）秘密鍵をファイルパスを指定して登録します：
これで新しい（パスフレーズのない）秘密鍵が作成され、 dokku に登録されました。続いて GitHub のリポジトリ側で GitHub Actions 側の設定を行います。
【手順２ GitHub の対象アプリケーションに GitHub Actions 用の秘密鍵を設定】
GitHub リポジトリにコミットされたタイミングでデプロイを実行できるよう、対象アプリケーションの GitHub リポジトリに GitHub Actions を設定します。まずは GitHub の対象アプリケーションのページを開き、Settings を選択します（ユーザーの Settings ではなく、アプリケーションの Settings を開きます）：
CI ワークフローを定義する前に、ワークフロー内で使う秘密鍵の情報を先に登録しておきます。Settings ページの左ペインから Secrets - Actions を選択します：
新規に秘密鍵を登録したいので、画面右上の "New repository secret" ボタンをクリックします：
秘密鍵を登録する画面が表示されるので、NAME 欄に SSH_PRIVATE_KEY と入力し、Value 欄には手順１で作成した秘密鍵ファイルの内容（"-----BEGIN RSA PRIVATE KEY-----" から "-----END RSA PRIVATE KEY-----" まで）をそのままコピー＆ペーストして入力し、最後に "Add secret" ボタンをクリックします：
以下のように表示されればリポジトリへの秘密鍵の登録は完了です：
【手順３ 対象アプリケーションに GitHub Actions を設定】
ここまでの準備ができていれば、後はコミット時（プッシュ時）の GitHub Actions を登録することで dokku への自動デプロイを行うことができるようになります。ソースコードに .github/workflows/ というフォルダを追加し、このフォルダ内に以下の内容の deploy.yml ファイルを追加します：
ここまで用意できたら、対象のプロジェクトを GitHub にコミット＆プッシュします（以下の例は main ブランチに直接コミットしている想定です）：
プッシュが成功すると GitHub リポジトリで GitHub Actions が起動するはずです。起動の様子はリポジトリ内の "Actions" メニューから確認できます（画面は Actions が実行中の様子）：
実行が（成功か失敗かで）完了すると、その結果が表示されます（この例では緑マークが付いているので成功しています。失敗は赤）：
成功・失敗に関係なく、Actions 名部分をクリックすると、Actions の実行ログを見ることができます。特に失敗した場合などはこのログが原因を調べるヒントになっている可能性が高いので、失敗に終わった場合はまずログを参照することになると思います：
GitHub Actions が成功していた場合、更新されたアプリケーションが指定 URL で稼働できているはずです。実際にアクセスして動作確認してみましょう：
・dokku でプライベート PaaS 環境を構築する（１）
・dokku でプライベート PaaS 環境を構築する（２）
今回は dokku のいわゆる CI/CD(Continuous Integration / Continuous Delivery) についてブログエントリを書きます。dokku が非常に便利であるが故に、ソースコードが更新されるたびに手作業で push するのは（大した手間ではないのですが）やはり面倒です。というわけで Git リポジトリへのプッシュをフックとする dokku のデプロイ自動化を実現する方法を調べてみました。特に今回紹介するのは GitHub Actions を使った方法で、ソースコードを GitHub リポジトリで管理している人であればちょっとした設定を追加するだけで CI が実現できます。なお、今回 CI/CD を設定する dokku サーバーは "yellowmix.net" というカスタムドメインを有効に設定してあって、"XXXXX.yellowmix.net" というホスト名でアプリケーションをデプロイできるように設定済みである、という前提で紹介します（手順３の中にこの設定に関わる部分があります）。
以下、その手順紹介です。
【手順１ パスフレーズなしの秘密鍵／公開鍵を作成・登録】
GitHub Actions 内でデプロイを自動実行するため、パスフレーズ無しで作られた秘密鍵が必要です。というわけで、パスフレーズ有りの秘密鍵を使っている場合は作成および登録の再実行が必要になります。
まずは秘密鍵と公開鍵を（再）作成します。dokku サーバーのシェルにログインして、以下のコマンドを実行します：
$ ssh-keygen
この後、秘密鍵を作成するパスを入力するよう促されます。デフォルトでは "~/.ssh/id_rsa" が指定されているはずです。変更する場合は正しいファイルパスを入力、デフォルト設定のままで問題なければそのまま Enter を入力します。
次にファイルのパスフレーズを入力するよう促されますが、今回はパスフレーズのない秘密鍵および公開鍵のペアを作りたいので、空のまま Enter を押して先に進めます。パスフレーズの指定が終わると指定されたパスで秘密鍵および公開鍵が作成されます。特に秘密鍵の内容は手順２でも必要になるので、 cat コマンドで一度中身を確認しておきます（"-----BEGIN RSA PRIVATE KEY-----" で始まって "-----END RSA PRIVATE KEY-----" で終わる内容が表示されます）：
$ cat ~/.ssh/id_rsa
秘密鍵が作れたら dokku に登録します。上述のセットアップを既に別の（パスフレーズ付きの）秘密鍵で実施済みで、別の秘密鍵が登録済みの場合は、以下のコマンドで一度削除しておきます：
$ sudo dokku ssh-keys:remove admin
改めて（再度）秘密鍵をファイルパスを指定して登録します：
$ cat ~/.ssh/id_rsa | sudo dokku ssh-keys:add admin
これで新しい（パスフレーズのない）秘密鍵が作成され、 dokku に登録されました。続いて GitHub のリポジトリ側で GitHub Actions 側の設定を行います。
【手順２ GitHub の対象アプリケーションに GitHub Actions 用の秘密鍵を設定】
GitHub リポジトリにコミットされたタイミングでデプロイを実行できるよう、対象アプリケーションの GitHub リポジトリに GitHub Actions を設定します。まずは GitHub の対象アプリケーションのページを開き、Settings を選択します（ユーザーの Settings ではなく、アプリケーションの Settings を開きます）：
CI ワークフローを定義する前に、ワークフロー内で使う秘密鍵の情報を先に登録しておきます。Settings ページの左ペインから Secrets - Actions を選択します：
新規に秘密鍵を登録したいので、画面右上の "New repository secret" ボタンをクリックします：
秘密鍵を登録する画面が表示されるので、NAME 欄に SSH_PRIVATE_KEY と入力し、Value 欄には手順１で作成した秘密鍵ファイルの内容（"-----BEGIN RSA PRIVATE KEY-----" から "-----END RSA PRIVATE KEY-----" まで）をそのままコピー＆ペーストして入力し、最後に "Add secret" ボタンをクリックします：
以下のように表示されればリポジトリへの秘密鍵の登録は完了です：
【手順３ 対象アプリケーションに GitHub Actions を設定】
ここまでの準備ができていれば、後はコミット時（プッシュ時）の GitHub Actions を登録することで dokku への自動デプロイを行うことができるようになります。ソースコードに .github/workflows/ というフォルダを追加し、このフォルダ内に以下の内容の deploy.yml ファイルを追加します：
---
name: 'deploy'
# yamllint disable-line rule:truthy
on:
push:
branches:
- main
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@master
with:
# specify the `main` branch as the remote branch to push to
branch: 'main'
git_remote_url: 'ssh://dokku@yellowmix.net:22/hostname'
ssh_private_key: ${{ secrets.SSH_PRIVATE_KEY }}
このうち、青字部分（main と書かれた部分）は「どのブランチが更新された時に、どのブランチを対象にデプロイするか」を指定しています。今回は「 main ブランチ更新時に main ブランチの内容をデプロイ」したいので、このような設定にしています。master ブランチを使いたい場合はここを master に変更してください。 また赤字部分はデプロイ先のリポジトリ URL です。この例では "yellowmix.net" というドメインホストを使って https://hostname.yellowmix.net/ という URL でアプリケーションを公開するための設定にしています。この部分は皆さんの dokku 環境に合わせて変更する必要があるのでご注意ください。 加えて、最終行に手順２で設定した秘密鍵を使う指定がされています。秘密鍵は外部に漏れてはまずい情報なので、ハードコートや公開変数などは使わずに、このような形で登録済みのシークレット情報を参照するよう指定しています。
なお、この deploy.yml ファイルの中で dokku/github-action というリポジトリが指定されている箇所がありますが、これは dokku から提供されている GitHub Actions 連携用のコンテナイメージです。このコンテナイメージを使ってデプロイを行う、という作業内容になっています。同コンテナイメージのソースコードはこちらで提供されています：
ここまで用意できたら、対象のプロジェクトを GitHub にコミット＆プッシュします（以下の例は main ブランチに直接コミットしている想定です）：
$ git add . $ git commit -m 'node v14' $ git push origin main
プッシュが成功すると GitHub リポジトリで GitHub Actions が起動するはずです。起動の様子はリポジトリ内の "Actions" メニューから確認できます（画面は Actions が実行中の様子）：
実行が（成功か失敗かで）完了すると、その結果が表示されます（この例では緑マークが付いているので成功しています。失敗は赤）：
成功・失敗に関係なく、Actions 名部分をクリックすると、Actions の実行ログを見ることができます。特に失敗した場合などはこのログが原因を調べるヒントになっている可能性が高いので、失敗に終わった場合はまずログを参照することになると思います：
GitHub Actions が成功していた場合、更新されたアプリケーションが指定 URL で稼働できているはずです。実際にアクセスして動作確認してみましょう：
以上、GitHub Actions を使って dokku にアプリケーションを自動デプロイするための設定を紹介しました。dokku は専用のリポジトリに git push するだけでもデプロイが出来て便利ですが、一度 CI/CD の便利さを知ってしまうと「わざわざデプロイする手間が面倒」に感じられてしまうほど便利なので、今後 dokku を使って動かすアプリについては全てこの設定を有効にしてもいいかな、と感じています。
