github-actions-docs

GitHub Actions に関する質問は、古い記憶をもとに簡単に答えてしまいがちです。このスキルを使って、公式の GitHub ドキュメントに基づいて回答し、一般的な CI/CD のアドバイスではなく、最も関連性の高い信頼できるページを案内してください。

使用するタイミング

次のようなリクエストには、このスキルを使用してください。

• GitHub Actions の概念、用語、製品の範囲について
• ワークフロー YAML、トリガー、ジョブ、マトリックス、同時実行、変数、コンテキスト、式について
• GitHub ホステッドランナー、大規模ランナー、セルフホストランナー、Actions Runner Controller について
• アーティファクト、キャッシュ、再利用可能なワークフロー、ワークフローテンプレート、カスタムアクションについて
• シークレット、GITHUB_TOKEN、OpenID Connect、アーティファクトの証明、セキュアなワークフローのパターンについて
• 環境、デプロイ保護ルール、デプロイ履歴、デプロイの例について
• Jenkins、CircleCI、GitLab CI/CD、Travis CI、Azure Pipelines、その他の CI システムからの移行について
• ドキュメント、構文のガイダンス、公式の参考資料が必要なワークフローの動作のトラブルシューティングについて

次の用途には、このスキルを使用しないでください。

• 特定の PR チェックの失敗、ワークフローログの欠落、CI 失敗のトリアージ。gh-fix-ci を使用してください。
• 一般的な GitHub のプルリクエスト、ブランチ、リポジトリの操作。github を使用してください。
• CodeQL 固有の設定やコードスキャンのガイダンス。codeql を使用してください。
• Dependabot の設定、グループ化、依存関係の更新方針。dependabot を使用してください。

ワークフロー

1. リクエストを分類する

検索を始める前に、質問がどのカテゴリに当てはまるか判断してください。

• 入門またはチュートリアル
• ワークフローの作成と構文
• ランナーと実行環境
• セキュリティとサプライチェーン
• デプロイと環境
• カスタムアクションと公開
• モニタリング、ログ、トラブルシューティング
• 移行

すぐに手がかりが必要な場合は、references/topic-map.md を読み込み、最も近いセクションに進んでください。

2. まず GitHub の公式ドキュメントを検索する

• docs.github.com を信頼できる情報源として扱ってください。
• https://docs.github.com/en/actions 以下のページを優先してください。
• ユーザーが使った用語に、「workflow syntax」、「OIDC」、「reusable workflows」、「self-hosted runners」など、対象を絞った Actions 関連の語句を加えて検索してください。
• 複数のページが候補になる場合は、候補ページを 2～3 件比較し、ユーザーの質問に最も直接答えるページを選んでください。

3. 回答する前に最適なページを開く

• 最も関連性の高いページを読み、可能であれば該当するセクションも確認してください。
• トピックマップは、検索範囲を絞ったり、最初に確認すべきページの候補を見つけたりするためにのみ使用してください。
• ページの名称が変更されている、移動している、または内容が不完全と思われる場合は、その旨を明確に伝え、推測するのではなく、最も近い信頼できるページを案内してください。

4. ドキュメントに基づいて回答する

• 平易な言葉で、まず直接答えてください。
• ドキュメントのトップページだけでなく、該当する GitHub ドキュメントへの正確なリンクを含めてください。
• ユーザーが求めている場合、またはドキュメントのページで例が必要な場合にのみ、YAML や手順の例を示してください。
• 推論は明示してください。適切な表現の例：
  • GitHub のドキュメントによると、...
  • 推論：これはおそらく...を意味します。

回答形式

ユーザーが詳しい説明を求めていない限り、簡潔な構成にしてください。

1. 直接的な回答
2. 関連するドキュメント
3. 必要な場合のみ、YAML または手順の例
4. 複数のドキュメントページをつなぎ合わせる必要があった場合のみ、推論であることを明記

根拠となる主張の近くに引用を記載してください。

検索と振り分けのヒント

• 概念に関する質問では、詳細なリファレンスページよりも、概要や概念のページを優先してください。
• 構文に関する質問では、ワークフロー構文、イベント、コンテキスト、変数、式のリファレンスページを優先してください。
• セキュリティに関する質問では、「Secure use」、「Secrets」、「GITHUB_TOKEN」、「OpenID Connect」、「artifact attestation」のドキュメントを優先してください。
• デプロイに関する質問では、クラウド固有の例よりも、環境とデプロイ保護に関するドキュメントを優先してください。
• 移行に関する質問では、まず移行ハブのページを確認し、次にプラットフォーム固有の移行ガイドを確認してください。
• 初心者向けの手順を求められた場合は、リファレンスページだけでなく、チュートリアルまたはクイックスタートから始めてください。

よくある間違い

• 現在のドキュメントを確認せず、記憶だけを頼りに回答する
• より適切な個別ページがあるのに、GitHub Actions ドキュメントのトップページへリンクする
• 再利用可能なワークフローとコンポジットアクションを混同する
• OIDC のほうがドキュメントで推奨されている場合に、長期間有効なクラウド認証情報を提案する
• リポジトリ固有の CI のデバッグをドキュメントに関する質問として扱い、gh-fix-ci に引き継がない
• codeql や dependabot のほうが適している依頼を、隣接する分野に任せてしまう

同梱のリファレンス

references/topic-map.md は、参照先として有力なドキュメントのエントリーポイントを簡潔にまとめた索引としてのみ使用してください。意図的に内容を網羅していないため、最終的な根拠として、常に最新の GitHub ドキュメントに優先して使用してはなりません。