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

GitHub には、さまざまな言語とツールのワークフロー テンプレートが用意されています。

この記事の内容

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

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

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

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

  • 継続的インテグレーション (CI) 。 詳しくは、「GitHub Actions による継続的インテグレーションについて」を参照してください。
  • オートメーション。 Automation ワークフロー テンプレートには、pull request のトリアージや、pull request で変更されたパスに基づくラベルの適用、リポジトリに初めて投稿する人へのあいさつなど、ワークフローを自動化するためのソリューションが用意されています。

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

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

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

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

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

    "github/docs" リポジトリのタブのスクリーンショット。 [アクション] タブがオレンジ色の枠線で強調表示されています。

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

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

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

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

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

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

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

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

参考資料