たばりばりスタイル

たばりばりスタイル

バリバリバリ⚡︎

GitHub CLIを使ってGitHub ActionsのWorkflowを検証ブランチで試す

repository 内に検証ブランチを作成し、検証に必要なコードや下記のような workflow 定義 yml を配置する
  • workflow 定義 yml で actions/checkout を利用して、検証ブランチを指定
  • 任意のタイミングで実行できるようにトリガーに workflow_dispatch も設定
# 定義例
...
on:
  workflow_dispatch:
  ...

jobs:
  xxxx:
    ...
    steps:
      - uses: actions/checkout@v3
         with:
           ref: <検証ブランチ>

      - name: my job 1
         run: |
           ....
実行する際は GitHub CLI を利用して、下記のようなコマンドで workflow を実行する

GitHub CLI | Take GitHub to the command line

$ gh workflow run [<workflow-id> | <workflow 名>] --ref 検証ブランチ

これで Workflow を検証ブランチで試せます。

この方法で、手元でコードや yml を修正し、検証ブランチへ push。手元でそのまま gh workflow run を実行するような流れで検証しています。

おわり

GitHub Actions に限らずですが、CI・CD 周りの検証には骨が折れます。。。

今回、workflow 内で checkout の設定をしておらず、GitHub CLI では 検証ブランチ に向けて試していて、yml は検証用なのにそれ以外が本流のままだったとうっかりミスで数時間を潰してしまったので、備忘録的に書いてみました。