GitHubActionsとは

GitHubのサービス

ワークフロー自動化サービスで、開発している時にしたいことをGitHub上で自動化できる。

例:テストツールを実行したい、フォーマッターを自動実行したいなど...

使用するには、GitHub上にリポジトリーが存在していること。

.githubディレクトリ配下にworkflowsディレクトリを作成し、workflows内にymlファイルを記述する。

code:yml

name: pr-ci-test

jobs:

ci-test:

runs-on: ubuntu-latest

steps:

- name: CheckOut

uses: actions/checkout@v5

- name: Check DirFile

run: ls

ワークフローの名前

on

どのタイミングでこのワークフローを実行するか指定する場所。どのブランチで発生した場合に実行するかも指定できる。

大体mainブランチが指定されている印象。

jobs

実際に動作させるワークフローの集合。サンプルでは1つのジョブのみ作成している。

面白い要素として、2つのジョブを作成しているとワークフローの実行は並列で行われる点。

連続してワークフローのステップを実行したい場合は、１つのジョブでまとめる必要がある。

ci-test

私が今回のサンプルで付けたjobの名前

steps

ワークフローの１つ１つの動作をstepと呼ぶ。その集合体。

name

stepに付ける名前。

uses

GitHubActionsに登録されているアクションを使う場合に使用。公式とWorkSpaceに登録されているアクションを利用可能。

様々なオプションが存在する。

run

ターミナル上で実行させたいコマンドを使用する場合に使用する。Makefileが存在すればmakeコマンドも利用可能。

余談

ワークフローがきちんと動作するか確認したい場合は

actが便利。

GitHubLocalActionsも存在するが失敗したのでactを使っている。