GiHub Actionsの手動トリガーを試してみる

はじめに

この記事では、「GiHub Actionsで手動トリガーの方法と試した結果」について書いています。

最近GitHub Actionsのことを色々学んでいて、その中でGitHub Actionsを手動で実行させる方法があることを知ったのが記事を書いたきっかけでした。

自分に向けた備忘録の意味もありますが、「GiHub Actionsで手動トリガーを実装したい」な人の一助になれば嬉しいです。

要点だけ

  • 実行のトリガーに workflow_dispatchを追加する

試してみた

以下のようなymlファイルを作成しました。

# "this is pen", "this is apple"と出力するだけ

name: learn-github-actions
on: [workflow_dispatch]
jobs:
  check-bats-version:
    runs-on: ubuntu-latest
    steps:
      - run: echo "this is pen"
      - run: echo "this is apple"

コードのコメントにある通り、ただ適当な文字列を出力するだけの簡単な処理を行います。

このコードを.github\workflowsフォルダ内に入れてコミット&プッシュをします。

そしてリポジトリActionsタブを開くと以下のようになっています。

画像の中央付近にThis workflow has a workflow_dispatch event trigger.と書かれ(これはon: [workflow_dispatch]のymlファイルをコミットして初めて出てきました)、その右横にあるRun workflowのプルダウンボタンから実行することができます。

また、手動でも出来るようにしたいし、自動でも行って欲しい場合は、onの場所を以下のように書くことで実現できます(下の例は、手動とプッシュ時に実行するようにしてます)

on: [push, workflow_dispatch]

おわりに

「GiHub Actionsで手動トリガーの方法と試した結果」について解説しました。

手動で実行できるようにしたい場面もあるかと思いますが、そういう時にここで書いたことを思い出していただけたらと思います。

さいごに、記事を書く上で参考にしたサイトのリンクを以下に掲載します。合わせて読んでいただくと良いかと思います。

qiita.com