2023-04-08

GitHub Actions で composite action を使ってリファクタリングする

はじめに

GitHub Actions で composite action なるものが 1 年ほど前にリリースされていたが使えてなかったので使ってみた。

Creating a composite action - GitHub Docs

In this guide, you'll learn how to build a composite action.

docs.github.com

npm エコシステムでは npm install や npm run xxx みたいなコマンドを実行するようなアクションを毎回定義しては似たような YAML ファイルが増えていた。今回は composite action を利用してリファクタリングしてみる。

composite action を作る

.github/actions/npm/action.yaml を作成し、共通箇所を抜き出した。

inputs:
  node-version-file:
    required: false
    default: ".tool-versions"
  cache:
    required: false
    default: "npm"
  cache-dependency-path:
    required: false
    default: "./package-lock.json"

runs:
  using: "composite"
  steps:
    - name: Setup node
      uses: actions/setup-[email protected]
      with:
        node-version-file: ${{ inputs.node-version-file }}
        cache: ${{ inputs.cache }}
        cache-dependency-path: ${{ inputs.cache-dependency-path }}
    - name: Install dependencies
      shell: bash
      run: npm ci

ポイントとしては以下になる。

using 句では compose を指定する。
inputs 句で composite action 側にパラメータを渡すことができる。
- 詳細としては他にも require, default , description が指定できる。
- Metadata syntax for GitHub Actions - GitHub Docs
run 句では shell の設定が必須となっている。
- Metadata syntax for GitHub Actions - GitHub Docs

composite action を使う

ここでは、例として .github/workflows/ci.yaml という CI 用に定義しておいた action ファイルを上記で作成した composite action を使用するように修正した。

name: "build"

on:
  pull_request:

jobs:
  build:
    runs-on: ubuntu-latest
    timeout-minutes: 3

    steps:
      - name: Checkout source
        uses: actions/[email protected]
        with:
          ref: ${{ github.head_ref }}

+     - name: Initialize node & npm
+       uses: ./.github/actions/npm

-     - name: Setup node
-       uses: actions/setup-[email protected]
-       with:
-         node-version-file: ${{ inputs.node-version-file }}
-         cache: ${{ inputs.cache }}
-         cache-dependency-path: ${{ inputs.cache-dependency-path }}
-
-     - name: Install dependencies
-       run: npm ci

      - name: Execute prettier
        run: npm run prettier

      - name: Execute eslint
        run: npm run eslint

      - name: Build
        run: npm run build