Skip to main content

スターター ワークフローの使用

GitHub には、さまざまな言語とツールのスターター ワークフローが用意されています。

スターター ワークフローについて

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

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

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

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

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

スターター ワークフローの選択と使用

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

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

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

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

  4. 「ワークフローの選択」ページには、推奨されるスターター ワークフローの選択内容が表示されます。 使いたいスターター ワークフローを見つけたら、 [構成] をクリックします。キーワードで検索したり、カテゴリでフィルター処理したりすると、必要なワークフローを見つけやすくなります。

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

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

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

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

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

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

参考資料