Github Actionsの利用メモ

最近Github Actionsを業務で使い始めたので色々と随時メモしていきます｡

なお現時点で参考にしている資料を以下に記載します｡

• GitHub CI/CD実践ガイド

環境構築

GitHub CLI

GitHub CLIをインストールすることでコンソールからプルリクエストの作成などの作業ができるようになるので便利です｡

また､GitHub Actionsの中でプルリクエストなどを作成するのにも同じコマンドを利用するため慣れておくと色々便利になりそうです｡

インストール方法

• Windows

  winget install --id GitHub.cli
  

• mac

  brew install gh
  

インストール確認

gh --version

ログイン

gh auth login

? Where do you use GitHub?  [Use arrows to move, type to filter]
> GitHub.com
  Other
? What is your preferred protocol for Git operations on this host?  [Use arrows to move, type to filter]
> HTTPS
  SSH
? Authenticate Git with your GitHub credentials? (Y/n) Y
? How would you like to authenticate GitHub CLI?  [Use arrows to move, type to filter]
> Login with a web browser
  Paste an authentication token
! First copy your one-time code: 0000-0000
Press Enter to open https://github.com/login/device in your browser...

実行すると色々と聞かれますが私は上記の設定で設定を実施しました｡! First copy your one-time code...の部分でブラウザーに遷移します｡ CLIに表示されたone-time codeをWebブラウザー上に入力すると先に認証が完了します｡

ログイン後に例えば下記のコマンドを実行すると自身のリポジトリのリストが表示されます｡

gh repo list

またその他のコマンドは以下で確認可能です｡

gh --help

GitHub Actionsの実行

とりあえずGitHub Actionsを実行してみます｡

まず任意の方法でリポジトリを作成します｡筆者はGitHub Cliを利用してPublicリポジトリを作成しました｡

gh repo create hello-github-actions-20241103 --public --clone --add-readme

その後Github Actionsに必要なディレクトリとファイルを作成します｡

New-Item -ItemType Directory .github/workflows
New-Item -ItemType File ./.github/workflows/hello.yml

.github/workflowsに配置したYmlファイル(.yml, .yaml)がGithub Actionsで実行されます｡

現時点のファイルツリー

└─.github
    └─workflows
            hello.yml

以下をYamlに記載しプッシュします｡

name: Hello World                      # ワークフローの名前
on: push                               # ワークフローのトリガー(今回はpush)

jobs:                                  # ジョブの定義
  hello-world-job:                     # ジョブの名前
    runs-on: ubuntu-latest             # ジョブが実行されるランナーの環境
    steps:                             # ジョブのステップの定義
      - name: Checkout repository      # ステップの名前
        uses: actions/checkout@v4      # GitHub Actionsのアクションを使用
      - name: Hello World              # ステップの名前
        run: echo "Hello World"        # ステップの実行内容(Hello Worldを出力)
      - name: Hello World              # 複数行実行
        run: |
          echo "Hello"
          echo "World"

Actions > Hello World > 任意のruns を選択します

hello-world-jobが実行されていることが確認できます｡

hello-world-jobをクリックするとより詳細な内容を確認できます｡

GitHubイベント

on: pushには様々なトリガーを設定できます｡

以下はGitHubイベントの例です｡

イベント名	説明
push	リポジトリにコードがプッシュされたときにトリガーされます。
pull_request	プルリクエストが作成、更新、またはマージされたときにトリガーされます。
issues	イシューが作成、更新、またはクローズされたときにトリガーされます。
release	リリースが公開、下書き、または削除されたときにトリガーされます。
workflow_dispatch	手動でワークフローをトリガーするために使用されます。
schedule	定期的にワークフローをトリガーするために使用されます。
fork	リポジトリがフォークされたときにトリガーされます。
star	リポジトリにスターが付けられたときにトリガーされます。
watch	リポジトリがウォッチされたときにトリガーされます。
delete	ブランチやタグが削除されたときにトリガーされます。
create	ブランチやタグが作成されたときにトリガーされます。

scheduleのタイムゾーンはUTCです｡またscheduleは指定した時間ピッタリに実行されません｡そのためある程度ズレが許されるタスクにのみ利用するのが望ましいです｡

アクション

GitHub Actions内で再利用可能なアクションが多数存在します｡

任意のアクションを探す際はGitHub Marketplaceを利用すのが便利です｡

またアクションの中には悪意のあるアクションが含まれている可能性があります｡そのためVerified Creatorsが付与されているアクションを選ぶと､付与されていないアクションに比べると多少安全です｡ただし絶対安全な訳ではないためアクションを利用する際は注意が必要です｡

課金モデル

公式を確認すると以下のような記載があります｡

　GitHub Actions の使用は、パブリック リポジトリの標準の GitHub ホステッド ランナーとセルフホステッド ランナーの場合は無料です。 プライベート リポジトリの場合、アカウントのプランに応じて、GitHub ホステッド ランナーでの使用を対象として、一定量の無料の使用時間 (分) とストレージが各 GitHub アカウントに付与されます。 含まれる量を超える使用は、使用制限によって制御されます。

今回はPublicリポジトリで検証を実施しているので課金は発生しません｡

またPrivateのランナーのOSによって大きく料金が変わります｡2024/11/03時点ではLinuxとMacOsでは料金に10倍の差があります｡

詳細な料金は公式のページを確認してください｡

ワークフロー構文

この章ではワークフローの構文についての説明を記載していきます｡

コンテキスト

コンテキストでは実行中のリポジトリ名などの様々な情報を得ることができます｡

例えば以下のように記載するとリポジトリ名を取得することができます｡

jobs:
  context-job:
    runs-on: ubuntu-latest
    steps:
      - name: Show context
        run: echo "GITHUB_REPOSITORY $GITHUB_REPOSITORY"
        env:
          GITHUB_REPOSITORY: ${{ github.repository }}

上記の通り${{ github.repository }}のように記載することでコンテキストにアクセスできます｡

その他のコンテキストについては公式のページを確認してください｡

環境変数

GitHub Actionsの中で利用される環境変数を自身で定義することも可能です｡環境変数を定義する際はenv:セクションに記入します｡以下に例を示します｡

name: Env Test
on: push

jobs:
  env-test-job:
    runs-on: ubuntu-latest
    env:
      JOB_ENV: "This is a job environment variable" # Job レベルの環境変数
    steps:
      - name: Show environment variables
        run: |
          echo "GITHUB_REPOSITORY $GITHUB_REPOSITORY"
          echo "JOB_ENV: $JOB_ENV"
        env:
          GITHUB_REPOSITORY: ${{ github.repository }} # Step レベルの環境変数

なお公式の以下の記載の通り変数は低いレベルの変数が優先されます｡

複数のレベルで同じ名前の変数が存在する場合、最も低いレベルの変数が優先されます。 たとえば、Organization レベルの変数名がリポジトリレベルの変数名と同じ場合、リポジトリレベルの変数が優先されます。 同様に、Organization、リポジトリ、環境がすべて同じ名前の変数を持つ場合、環境レベルの変数が優先されます。

再利用可能なワークフローの場合は、呼び出し元ワークフローのリポジトリの変数が使用されます。 呼び出されたワークフローを含むリポジトリの変数は、呼び出し元ワークフローでは使用できません。

構成変数の優先順位

またデフォルトの環境変数がいくつか定義されています｡どんな環境変数が定義されているかは公式ページを参照してください

既定の環境変数

また上記の例では環境変数を直接コードに埋め込んでいます(JOB_ENVを直接echoしている)｡この記載方法だと意図しないスクリプトが埋め込まれてしまう可能性があります｡そのため以下のように変更を実施して意図しないスクリプトの埋め込みを防ぐことが重要です｡

name: Env Test
on: push

jobs:
  env-test-job:
    runs-on: ubuntu-latest
    env:
      JOB_ENV: "This is a job environment variable" # Job レベルの環境変数
    steps:
      - name: Show environment variables
        run: |
          echo "GITHUB_REPOSITORY $GITHUB_REPOSITORY"
          echo "JOB_ENV: $JOB_ENV"
        env:
          GITHUB_REPOSITORY: ${{ github.repository }} # Step レベルの環境変数

中間環境変数については公式にも記載されています｡

中間環境変数の使用

Variables

複数のワークフローで使いまわしたい変数はVariablesで定義することが可能です｡

VariablesはSettings > Secrets and variables > Actions > New repository variableから作成可能です｡

VAR1を追加

なおGitHub Cliから追加する際は以下のコマンドを実行します｡

gh variable set VAR2 --body 'VAR2'

追加したVariableを参照する際は${{vars.VAR1}}のように指定します｡

name: Variable Test
on: push
jobs: 
  var-test-job:
    runs-on: ubuntu-latest
    steps:
      - name: Show Variables
        env: 
          VAR1 : ${{vars.VAR1}}
          VAR2 : ${{vars.VAR2}}
        run: |
          echo "${{ env.VAR1 }}"
          echo "${{ env.VAR2 }}"