GitHub Actionsの機能を利用してCI/CDをパッケージ化する

1. 共通化

共通化をするにあたり、以下のどちらの機能に主眼をおくこととするか悩みました。

• composite action
• reusable workflow

どちらにもメリット/デメリットが存在するので、統一するのではなく使い分けることとしました。 感じていることの一部を以下に記載します。

• composite action
  • ◯：1つのワークフロー内で組み合わせて使えるので使い勝手がいい
  • ✕：コンソール上のログが見づらくなる
• reusable workflow
  • ◯：決まりきった処理であれば、コールする側はほとんどコードを書かなくて済む
  • ✕：コール側で少しだけ追加の処理を追加したい場合には不向き

2. 分岐をなくしてシンプルに

例えば、「本番と開発で処理はまったく同じなのだが、デプロイするAWSアカウント/GCPプロジェクトだけ異なる」というケースは度々あるかと思います。 この場合、↓のようにifで分岐して変数をセットして、その変数を使って次のstepにうつる必要があるかに見えます。

- id: set-env
  run: |
    if [ ${{ github.ref_name == 'main' }} == "main" ]; then
       echo "target=production" >> "$GITHUB_OUTPUT"
    else
       echo "target=develop" >> "$GITHUB_OUTPUT"
    fi
- uses: ORG/REPO/.github/actions/hoge@main
  with:
    target: {{ steps.set-env.outputs.target }}

が、Environments機能を使うと、

• 同じ変数名だけど、環境ごとに実態値が異なる

という扱いをすることができるため、次のように記述をシンプルにすることが可能です。 変数が多いほど有用になります。（SettingsからEnvironmentsの設定はしておく必要がある）

environment: |-
      ${{
          github.ref_name == 'main'  && 'production'
      ||  'develop'
      }}
steps:
  - uses: ORG/REPO/.github/actions/hoge@main
    with:
      target: {{ vars.TARGET }}