cover image

GitHub Actionsのワークフローファイルをざっくり理解する

カテゴリ
Tech
書いた人
Tatsuya Sasaki
公開日
2021/12/17
💡
概要
GitHub Actionsを目にする機会が増え、興味があったのでtutorialをやってみました。 そのときに学んだワークフローファイルについてざっくりとまとめました。
なんとなくわかった気になることを目的に書いたので、細かい部分に関しては言及していません。GitHub Actionsを触ったことがない方のドキュメントを読むきっかけになれば幸いです。
 
🚀
記事はこちら!
GitHub Actionsのワークフローファイルをざっくり理解する
GitHub Actionsを目にする機会が増え、興味があったのでtutorialをやってみました。そのときに学んだワークフローファイルについてざっくりとまとめました。 なんとなくわかった気になることを目的に書いたので、細かい部分に関しては言及していません。GitHub Actionsを触ったことがない方のドキュメントを読むきっかけになれば幸いです。 ワークフローファイルは以下の要素からできています。詳細を知りたい場合は 公式のドキュメント で確認できます。 ワークフローファイル内に定義されている内容のこと ランナーGitHub Actionsのワークフローからジョブを実行するアプリケーションのことどの仮想環境で実行するかを指定することができる イベントワークフローが実行されるタイミングのことどのタイミングでワークフローを実行するかを指定することができる 指定できるタイミング一覧 ジョブ同一のランナーで実行される一連のステップのこと複数のジョブは並列で実行される ステップジョブ内の個々のアクションまたはシェルコマンドのことステップには作成済みのアクションかシェルコマンドが指定される アクション何らかの処理が設定されているもの 公開されているアクション を使用することで簡単にやりたいことが実現できる 試しに公開されているアクションを使用して、リリース用のPRを作成するワークフローを作成してみました。今回のファイルではシェルコマンドを使う箇所がなく使用していないのですが、ステップでアクションではなくシェルコマンドを使うこともできます。 name: Create a release pull-request # ワークフローの名前を指定 on: workflow_dispatch # どのタイミングで実行されるか jobs: # 以下にジョブを定義 release_pull_request: # ジョブの名前を指定 runs-on: ubuntu-latest # どのランナーで実行するか指定 name: release_pull_request steps: # 以下にステップを定義 - name: checkout # ステップの名前を指定 uses: actions/checkout@v2 # 使用するアクションを指定 - name: create-release-pr uses: grassedge/git-pr-release-action@v1.0 with: # 以下でアクションに与えるパラメータを指定 (何が使えるかはアクションのドキュメントを確認) base: main head: develop token: ${{ secrets.GITHUB_TOKEN }} labels: release assign: true 合わせて公式のドキュメントにある 「ワークフローファイルの視覚化」 を見ていただけると、イメージがつきやすいと思います。 複雑な記述を書かずに自動化できるのが良いと思いました。 まだ基本的なことしか試すことができていないので、他にも公開されているアクションを試してみようと思いました。 publicリポジトリであれば無料で試すことができるので、まだ試したことがなければぜひ試してみてください。 最後まで読んでいただきありがとうございました!