Github ActionsのComposite Actionを使ってみる

Github ActionsのComposite Actionを使ってみる

最近Composite Actionというものを知ったので、試しに使ってみる。
Composite Actionとは複数のアクションを一つのステップ内に集約することができる機能のこと。

複合アクションを使用すると、一連のワークフロー ジョブ ステップを 1 つのアクションに収集し、複数のワークフローで 1 つのジョブ ステップとして実行できます。

今回作成したリポジトリ

コード

action.yml

1. ファイルはどこに置いても良いらしく、自由度が高いが、ファイル名はaction.yml・action.yamlのどちらかにしなければいけない。
2. using: compositeは必ず指定しなければいけない。

name: Composite docker setup
description: composite docker setup

runs:
  using: "composite"
  steps:
    - uses: actions/checkout@v4
    - uses: docker/setup-buildx-action@v2
    - uses: docker/build-push-action@v4
      with:
        context: .
        cache-from: type=gha
        cache-to: type=gha,mode=max

    - name: Setup container
      run: |
        mkdir -p src/node_modules
        chmod 777 src/node_modules
        sudo chown -R 1000:1000 src
        docker compose up -d --build
      shell: bash
          
    - name: Run npm ci
      run : |
        docker compose run --rm --user 1000:1000 app npm ci --ignore-scripts
      shell: bash

呼び出し側

1. リポジトリ内のアクションを呼び出すため、actions/checkout@v4が必須
2. パスはルートディレクトリからの相対パスでファイルパスは含めない。

name: "CI"

on:
  push:

jobs:
  ci:
    runs-on: ubuntu-latest
    steps:
      # checkout必須
      - uses: actions/checkout@v4
      # 相対パス
      # ディレクトリ名まで
      - uses: "./.github/actions/setup"
          
      - name: Run lint
        run: |
          docker compose run --rm --user 1000:1000 app npm run lint

      - name: Run npm run test
        run: |
          docker compose run --rm --user 1000:1000 app npm run test:r

最後に

間違っていることなどあればコメントに書いていただけると幸いです。
よろしくお願いいたします。