注: GitHub ホステッド ランナーは、現在 GitHub Enterprise Server でサポートされていません。 GitHub public roadmap で、今後の計画的なサポートの詳細を確認できます。
はじめに
このガイドでは、パッケージ化された複合アクションを作成して使用するために必要な基本コンポーネントについて説明します。 アクションのパッケージ化に必要なコンポーネントのガイドに焦点を当てるため、アクションのコードの機能は最小限に留めます。 アクションは「Hello World」と「Goodbye」を出力するか、カスタ� の名前を指定すると「Hello [who-to-greet]」と「Goodbye」を出力します。 このアクションでは、乱数も random-number
出力変数にマップされて、goodbye.sh
という名前のスクリプトが実行されます。
このプロジェクトを完了すれば、独自の複合アクションを作成し、それをワークフローでテストする方法を理解できます。
警告: ワークフローとアクションを作成するときは、コードが攻撃者からの信� �されていない入力を実行する可能性があるかどうかを常に考慮する必要があります。 攻撃者が悪意あるコンテンツを挿入してくるかもしれないので、特定のコンテキストは信� �できない入力として扱うべきです。 詳細については、「スクリプト インジェクションのリスクについて」を参照してく� さい。
前提条件
始める前に、your GitHub Enterprise Server instance にリポジトリを作成します。
-
your GitHub Enterprise Server instance に新しいパブリック リポジトリを作成します。 任意のリポジトリ名を選択することも、次の
hello-world-composite-action
の例を使用することもできます。 これらのファイルは、プロジェクトを GitHub Enterprise Serverにプッシュした後で追� できます。 詳細については、「新しいリポジトリの作成」を参照してく� さい。 -
リポジトリをお手元のコンピューターにクローンします。 詳細については、「リポジトリをクローンする」を参照してく� さい。
-
ターミナルから、ディレクトリを新しいリポジトリに変更します。
cd hello-world-composite-action
-
hello-world-composite-action
リポジトリで、goodbye.sh
という名前の新しいファイルを作成し、次のコード例を追� します。echo "Goodbye"
-
ターミナルから、
goodbye.sh
実行可能ファイルを作成します。chmod +x goodbye.sh
-
ターミナルから、
goodbye.sh
ファイルをチェックインします。git add goodbye.sh git commit -m "Add goodbye script" git push
アクションのメタデータファイルの作成
-
hello-world-composite-action
リポジトリで、action.yml
という名前の新しいファイルを作成し、次のコード例を追� します。 この構文の詳細については、「複合アクションの� �合のruns
」を参照してく� さい。**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 "::set-output name=random-number::$(echo $RANDOM)" 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
スクリプトを実行します。出力の管理の詳細については、「複合アクションの� �合の
outputs
」を参照してく� さい。github.action_path
の使用方法の詳細については、「github context
」を参照してく� さい。 -
ターミナルから、
action.yml
ファイルをチェックインします。git add action.yml git commit -m "Add action" git push
-
ターミナルから、タグを追� します。 この例では、
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@v2
- 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"スクリプトの結果、および乱数が含まれているはずです。