|
| 1 | +--- |
| 2 | +name: github-actions-docs |
| 3 | +description: Use when users ask how to write, explain, customize, migrate, secure, or troubleshoot GitHub Actions workflows, workflow syntax, triggers, matrices, runners, reusable workflows, artifacts, caching, secrets, OIDC, deployments, custom actions, or Actions Runner Controller, especially when they need official GitHub documentation, exact links, or docs-grounded YAML guidance. |
| 4 | +--- |
| 5 | + |
| 6 | +GitHub Actions questions are easy to answer from stale memory. Use this skill to ground answers in official GitHub documentation and return the closest authoritative page instead of generic CI/CD advice. |
| 7 | + |
| 8 | +## When to Use |
| 9 | + |
| 10 | +Use this skill when the request is about: |
| 11 | + |
| 12 | +- GitHub Actions concepts, terminology, or product boundaries |
| 13 | +- Workflow YAML, triggers, jobs, matrices, concurrency, variables, contexts, or expressions |
| 14 | +- GitHub-hosted runners, larger runners, self-hosted runners, or Actions Runner Controller |
| 15 | +- Artifacts, caches, reusable workflows, workflow templates, or custom actions |
| 16 | +- Secrets, `GITHUB_TOKEN`, OpenID Connect, artifact attestations, or secure workflow patterns |
| 17 | +- Environments, deployment protection rules, deployment history, or deployment examples |
| 18 | +- Migrating from Jenkins, CircleCI, GitLab CI/CD, Travis CI, Azure Pipelines, or other CI systems |
| 19 | +- Troubleshooting workflow behavior when the user needs documentation, syntax guidance, or official references |
| 20 | + |
| 21 | +Do not use this skill for: |
| 22 | + |
| 23 | +- A specific failing PR check, missing workflow log, or CI failure triage. Use `gh-fix-ci`. |
| 24 | +- General GitHub pull request, branch, or repository operations. Use `github`. |
| 25 | +- CodeQL-specific configuration or code scanning guidance. Use `codeql`. |
| 26 | +- Dependabot configuration, grouping, or dependency update strategy. Use `dependabot`. |
| 27 | + |
| 28 | +## Workflow |
| 29 | + |
| 30 | +### 1. Classify the request |
| 31 | + |
| 32 | +Decide which bucket the question belongs to before searching: |
| 33 | + |
| 34 | +- Getting started or tutorials |
| 35 | +- Workflow authoring and syntax |
| 36 | +- Runners and execution environment |
| 37 | +- Security and supply chain |
| 38 | +- Deployments and environments |
| 39 | +- Custom actions and publishing |
| 40 | +- Monitoring, logs, and troubleshooting |
| 41 | +- Migration |
| 42 | + |
| 43 | +If you need a quick starting point, load `references/topic-map.md` and jump to the closest section. |
| 44 | + |
| 45 | +### 2. Search official GitHub docs first |
| 46 | + |
| 47 | +- Treat `docs.github.com` as the source of truth. |
| 48 | +- Prefer pages under <https://docs.github.com/en/actions>. |
| 49 | +- Search with the user's exact terms plus a focused Actions phrase such as `workflow syntax`, `OIDC`, `reusable workflows`, or `self-hosted runners`. |
| 50 | +- When multiple pages are plausible, compare 2-3 candidate pages and pick the one that most directly answers the user's question. |
| 51 | + |
| 52 | +### 3. Open the best page before answering |
| 53 | + |
| 54 | +- Read the most relevant page, and the exact section when practical. |
| 55 | +- Use the topic map only to narrow the search space or surface likely starting pages. |
| 56 | +- If a page appears renamed, moved, or incomplete, say that explicitly and return the nearest authoritative pages instead of guessing. |
| 57 | + |
| 58 | +### 4. Answer with docs-grounded guidance |
| 59 | + |
| 60 | +- Start with a direct answer in plain language. |
| 61 | +- Include exact GitHub docs links, not just the docs homepage. |
| 62 | +- Only provide YAML or step-by-step examples when the user asks for them or when the docs page makes an example necessary. |
| 63 | +- Make any inference explicit. Good phrasing: |
| 64 | + - `According to GitHub docs, ...` |
| 65 | + - `Inference: this likely means ...` |
| 66 | + |
| 67 | +## Answer Shape |
| 68 | + |
| 69 | +Use a compact structure unless the user asks for depth: |
| 70 | + |
| 71 | +1. Direct answer |
| 72 | +2. Relevant docs |
| 73 | +3. Example YAML or steps, only if needed |
| 74 | +4. Explicit inference callout, only if you had to connect multiple docs pages |
| 75 | + |
| 76 | +Keep citations close to the claim they support. |
| 77 | + |
| 78 | +## Search and Routing Tips |
| 79 | + |
| 80 | +- For concept questions, prefer overview or concept pages before deep reference pages. |
| 81 | +- For syntax questions, prefer workflow syntax, events, contexts, variables, or expressions reference pages. |
| 82 | +- For security questions, prefer `Secure use`, `Secrets`, `GITHUB_TOKEN`, `OpenID Connect`, and artifact attestation docs. |
| 83 | +- For deployment questions, prefer environments and deployment protection docs before cloud-specific examples. |
| 84 | +- For migration questions, prefer the migration hub page first, then a platform-specific migration guide. |
| 85 | +- If the user asks for a beginner walkthrough, start with a tutorial or quickstart instead of a raw reference page. |
| 86 | + |
| 87 | +## Common Mistakes |
| 88 | + |
| 89 | +- Answering from memory without verifying the current docs |
| 90 | +- Linking the GitHub Actions docs landing page when a narrower page exists |
| 91 | +- Mixing up reusable workflows and composite actions |
| 92 | +- Suggesting long-lived cloud credentials when OIDC is the better documented path |
| 93 | +- Treating repo-specific CI debugging as a documentation question when it should be handed to `gh-fix-ci` |
| 94 | +- Letting adjacent domains absorb the request when `codeql` or `dependabot` is the sharper fit |
| 95 | + |
| 96 | +## Bundled Reference |
| 97 | + |
| 98 | +Read `references/topic-map.md` only as a compact index of likely doc entry points. It is intentionally incomplete and should never replace the live GitHub docs as the final authority. |
0 commit comments