複合アクションを作成する

はじめに

このガイドでは、パッケージ化された複合アクションを作成して使用するために必要な基本コンポーネントについて説明します。 アクションのパッケージ化に必要なコンポーネントのガイドに焦点を当てるため、アクションのコードの機能は最小限に留めます。 アクションは「Hello World」と「Goodbye」を出力するか、カスタムの名前を指定すると「Hello [who-to-greet]」と「Goodbye」を出力します。 このアクションでは、乱数も random-number 出力変数にマップされて、goodbye.sh という名前のスクリプトが実行されます。

このプロジェクトを完了すれば、独自の複合アクションを作成し、それをワークフローでテストする方法を理解できます。

前提条件

始める前に、GitHub.com にリポジトリを作成します。

1. GitHub.com に新しいパブリック リポジトリを作成します。 任意のリポジトリ名を選択することも、次の hello-world-composite-action の例を使用することもできます。 これらのファイルは、プロジェクトを GitHub Enterprise Cloudにプッシュした後で追加できます。 詳しくは、「新しいリポジトリの作成」を参照してください。

2. リポジトリをお手元のコンピューターにクローンします。 詳しくは、「リポジトリをクローンする」を参照してください。

3. ターミナルから、ディレクトリを新しいリポジトリに変更します。

   cd hello-world-composite-action

4. hello-world-composite-action リポジトリで、goodbye.sh という名前の新しいファイルを作成し、次のコード例を追加します。

   echo "Goodbye"
   

5. ターミナルから、goodbye.sh 実行可能ファイルを作成します。

   chmod +x goodbye.sh

6. ターミナルから、goodbye.sh ファイルをチェックインします。

   git add goodbye.sh
   git commit -m "Add goodbye script"
   git push

アクションのメタデータファイルの作成

1. hello-world-composite-action リポジトリで、action.yml という名前の新しいファイルを作成し、次のコード例を追加します。 この構文について詳しくは、「GitHub Actions のメタデータ構文」をご覧ください。

   **action.yml**
   

   name: 'Hello World'
   description: 'Greet someone'
   inputs:
     who-to-greet:  # id of input
       description: 'Who to greet'
       required: true
       default: 'World'
   outputs:
     random-number:
       description: "Random number"
       value: ${{ steps.random-number-generator.outputs.random-number }}
   runs:
     using: "composite"
     steps:
       - run: echo Hello ${{ inputs.who-to-greet }}.
         shell: bash
       - id: random-number-generator
         run: echo "random-number=$(echo $RANDOM)" >> $GITHUB_OUTPUT
         shell: bash
       - run: echo "${{ github.action_path }}" >> $GITHUB_PATH
         shell: bash
       - run: goodbye.sh
         shell: bash
   

   このファイルでは、who-to-greet 入力を定義し、ランダムに生成された数値を random-number 出力変数にマップし、アクションのパスをランナーのシステム パスに追加し (実行中に goodbye.sh スクリプトを見つけるため)、goodbye.sh スクリプトを実行します。

   出力の管理について詳しくは、「GitHub Actions のメタデータ構文」をご覧ください。

   github.action_path の使い方について詳しくは、「コンテキスト」をご覧ください。

2. ターミナルから、action.yml ファイルをチェックインします。

   git add action.yml
   git commit -m "Add action"
   git push

3. ターミナルから、タグを追加します。 この例では、v1 という名前のタグを使用します。 詳しくは、「カスタム アクションについて」を参照してください。

   git tag -a -m "Description of this release" v1
   git push --follow-tags

ワークフローでアクションをテストする

次のワークフロー コードでは、「複合アクションを作成する」で完成した hello world アクションを使います。

ワークフロー コードを別のリポジトリの .github/workflows/main.yml ファイルにコピーしますが、actions/hello-world-composite-action@v1 を作成したリポジトリとタグに置き換えます。 who-to-greet 入力を自分の名前に置き換えることもできます。

.github/workflows/main.yml

on: [push]

jobs:
  hello_world_job:
    runs-on: ubuntu-latest
    name: A job to say hello
    steps:
      - uses: actions/checkout@v3
      - id: foo
        uses: actions/hello-world-composite-action@v1
        with:
          who-to-greet: 'Mona the Octocat'
      - run: echo random-number ${{ steps.foo.outputs.random-number }}
        shell: bash

リポジトリから [アクション] タブをクリックして、最新のワークフロー実行を選択します。 出力には、「Hello Mona the Octocat」、"Goodbye"スクリプトの結果、および乱数が含まれているはずです。