ワークフロー テンプレートの使用

ワークフロー テンプレートについて

ワークフロー テンプレートは、リポジトリ用の独自の GitHub Actions ワークフローを作成するのに役立つテンプレートです。 これらは、空のワークフロー ファイルから開始する代わりに使用でき、作業の一部が既に完了しているため便利です。

GitHub には、さまざまな言語とツール用のワークフロー テンプレートが用意されています。 ユーザーがリポジトリでワークフローを設定するとき、GitHub はリポジトリ内のコードを分析し、リポジトリ内の言語とフレームワークに基づいてワークフローを推奨します。 たとえば、Node.js を使っている場合、GitHub は Node.js パッケージをインストールしてテストを実行するワークフロー テンプレート ファイルを提案します。 検索とフィルタリングを行って、関連するワークフロー テンプレートを見つけることができます。

GitHub には、次の高レベルのカテゴリにすぐに使用できるワークフロー テンプレートが用意されています。

• デプロイ (CD) 。 詳しくは、「Continuous deployment」をご覧ください。

• 継続的インテグレーション (CI) 。 詳しくは、「Continuous integration」をご覧ください。

• オートメーション。 Automation ワークフロー テンプレートには、pull request のトリアージや、pull request で変更されたパスに基づくラベルの適用、リポジトリに初めて投稿する人へのあいさつなど、ワークフローを自動化するためのソリューションが用意されています。

これらのワークフローを、カスタム ワークフローの構築の出発点として使用するか、そのまま利用します。 ワークフロー テンプレートの詳細な一覧は、actions/starter-workflows リポジトリで参照できます。

また、独自のワークフロー テンプレートを作成して、Organization で共有することもできます。 これらのワークフロー テンプレートは、GitHub 提供のワークフロー テンプレートと共に表示されます。 組織の .github リポジトリへの書き込みアクセス権を持つすべてのユーザーが、ワークフロー テンプレートを設定できます。 詳しくは、「組織のワークフロー テンプレートを作成する」をご覧ください。

ワークフロー テンプレートの選択と使用

1. GitHub で、リポジトリのメイン ページに移動します。

2. リポジトリ名の下にある [アクション] をクリックします。

   

3. ワークフローが既にリポジトリ内にある場合は、 [新しいワークフロー] をクリックします。

4. [ワークフローの選択] ページには、推奨されるワークフロー テンプレートの選択が表示されます。 使用するワークフロー テンプレートを見つけて、[構成] をクリックします。 必要なワークフロー テンプレートを検索するのに役立つよう、キーワード (keyword) を検索したり、カテゴリでフィルター処理したりできます。

5. その他の設定手順についての詳しいコメントがワークフロー テンプレートに含まれている場合は、次の手順に従います。

   ワークフロー テンプレートの多くには、プロジェクトをビルドおよびテストするためのガイドが付随しています。 詳しくは、「Building and testing」をご覧ください。

6. 一部のワークフロー テンプレートではシークレットが使用されます。 これには、${{ secrets.npm_token }} などがあります。 ワークフロー テンプレートでシークレットを使う場合は、シークレット名に記述されている値をシークレットとしてリポジトリに格納します。 詳しくは、「GitHub Actions でのシークレットの使用」をご覧ください。

7. 必要に応じて、さらに変更します。 たとえば、ワークフローの実行時に変更する on の値を変更できます。

8. [コミットの開始] をクリックします。

9. コミット メッセージを書き込み、既定のブランチに直接コミットするか、pull request を開くかを決定します。

参考資料

• Continuous integration
• ワークフローの実行と展開の管理
• GitHub Actions の使い方