Github Actions やりたいこと別テンプレート集 (1)

tl;dr

最近, Github Actions も触り始めて, 色々と学びがあるのでメモしていきます.

GitHub Actions hosted runners の情報を知りたい

概要

• ビルドで使う環境の情報 (どんなパッケージがインストールされているか等) を知りたい
• 以下のリポジトリに公開されている

リンク

• https://github.com/actions/virtual-environments

環境変数を設定したい

概要

ジョブ内で利用する環境変数を指定したいです！

テンプレ

echo ::set-env name=${VARIABLE}::${VALUE} 構文を使うことで, 環境変数を設定することが出来ます.

name: 'sandox-on-push'

on:
  push:
    branches:
      - 'master'

jobs:
  print_environment_variale:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v2

      - name: Set Environment Variable
        run: |
          echo ::set-env name=TEST_ENV1::foo
          echo ::set-env name=TEST_ENV2::bar

      - name: Print Environment Variable
        run: |
          echo ${TEST_ENV1}
          echo ${{ env.TEST_ENV2 }}

環境変数の値を参照する場合,

• ${TEST_ENV1}
• ${{ env.TEST_ENV2 }}

で参照が可能です.

Marketpace で公開されている Actions を利用する場合には, ${{ env.TEST_ENV2 }} を利用すると良さそうです.

サンプル出力

ブランチ名を取得したい

概要

ジョブ内でブランチ名を取得したい場合, https://github.com/marketplace/actions/get-branch-name を使うと便利です.

テンプレ

name: 'sample'
on:
  push:
    branches:
      - 'master'
jobs:
  deploy:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout code
        uses: actions/checkout@v2

      - name: Get Branch Name
        uses: nelonoel/branch-name@v1

      - name: Print Branch Name
        run: |
          echo ${BRANCH_NAME}

サンプル出力

以上

引続き, 精進してまいります.