github-actions-docs

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

GitHub Actions Docs

GitHub Actions 文档

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.

GitHub Actions相关问题很容易凭借陈旧记忆回答。请使用本技能，基于官方GitHub文档给出答案，并返回最相关的权威页面，而非通用CI/CD建议。

When to Use

使用场景

Use this skill when the request is about:

GitHub Actions concepts, terminology, or product boundaries
Workflow YAML, triggers, jobs, matrices, concurrency, variables, contexts, or expressions
GitHub-hosted runners, larger runners, self-hosted runners, or Actions Runner Controller
Artifacts, caches, reusable workflows, workflow templates, or custom actions
Secrets,
```
GITHUB_TOKEN
```
, OpenID Connect, artifact attestations, or secure workflow patterns
Environments, deployment protection rules, deployment history, or deployment examples
Migrating from Jenkins, CircleCI, GitLab CI/CD, Travis CI, Azure Pipelines, or other CI systems
Troubleshooting workflow behavior when the user needs documentation, syntax guidance, or official references

Do not use this skill for:

A specific failing PR check, missing workflow log, or CI failure triage. Use
```
gh-fix-ci
```
.
General GitHub pull request, branch, or repository operations. Use
```
github
```
.
CodeQL-specific configuration or code scanning guidance. Use
```
codeql
```
.
Dependabot configuration, grouping, or dependency update strategy. Use
```
dependabot
```
.

当请求涉及以下内容时，使用本技能：

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
```
。

Workflow

工作流程

1. Classify the request

1. 对请求进行分类

Decide which bucket the question belongs to before searching:

Getting started or tutorials
Workflow authoring and syntax
Runners and execution environment
Security and supply chain
Deployments and environments
Custom actions and publishing
Monitoring, logs, and troubleshooting
Migration

If you need a quick starting point, load

references/topic-map.md

and jump to the closest section.

在搜索前，先确定问题所属类别：

入门或教程
工作流编写与语法
运行器与执行环境
安全与供应链
部署与环境
自定义操作与发布
监控、日志与故障排查
迁移

如果需要快速找到切入点，请加载

references/topic-map.md

并跳转到最相关的章节。

2. Search official GitHub docs first

2. 优先搜索官方GitHub文档

Treat
```
docs.github.com
```
as the source of truth.
Prefer pages under https://docs.github.com/en/actions.
Search with the user's exact terms plus a focused Actions phrase such as
```
workflow syntax
```
,
```
OIDC
```
,
```
reusable workflows
```
, or
```
self-hosted runners
```
.
When multiple pages are plausible, compare 2-3 candidate pages and pick the one that most directly answers the user's question.

将
```
docs.github.com
```
视为权威来源。
优先选择https://docs.github.com/en/actions下的页面。
使用用户的准确术语加上聚焦的Actions相关短语进行搜索，例如
```
workflow syntax
```
、
```
OIDC
```
、
```
reusable workflows
```
或
```
self-hosted runners
```
。
当多个页面看似相关时，对比2-3个候选页面，选择最直接回答用户问题的页面。

3. Open the best page before answering

3. 在回答前打开最佳匹配页面

Read the most relevant page, and the exact section when practical.
Use the topic map only to narrow the search space or surface likely starting pages.
If a page appears renamed, moved, or incomplete, say that explicitly and return the nearest authoritative pages instead of guessing.

阅读最相关的页面，如有可能，阅读具体章节。
仅使用主题地图来缩小搜索范围或找到可能的起始页面。
如果页面已重命名、移动或内容不完整，请明确说明，并返回最接近的权威页面，而非猜测内容。

4. Answer with docs-grounded guidance

4. 基于文档给出指导

Start with a direct answer in plain language.
Include exact GitHub docs links, not just the docs homepage.
Only provide YAML or step-by-step examples when the user asks for them or when the docs page makes an example necessary.

Make any inference explicit. Good phrasing:

```
According to GitHub docs, ...
```
```
Inference: this likely means ...
```

先用直白语言给出直接答案。
包含准确的GitHub文档链接，而非仅文档首页。
仅当用户要求或文档页面明确需要时，才提供YAML或分步示例。

如有推断，请明确说明。例如：

```
根据GitHub文档，……
```
```
推断：这可能意味着……
```

Answer Shape

回答结构

Use a compact structure unless the user asks for depth:

Direct answer
Relevant docs
Example YAML or steps, only if needed
Explicit inference callout, only if you had to connect multiple docs pages

Keep citations close to the claim they support.

除非用户要求深入解释，否则请使用简洁结构：

直接答案
相关文档
YAML示例或步骤（仅在需要时提供）
明确的推断说明（仅当需要关联多个文档页面时提供）

请将引用内容紧邻其支持的结论放置。

Search and Routing Tips

搜索与路由技巧

For concept questions, prefer overview or concept pages before deep reference pages.
For syntax questions, prefer workflow syntax, events, contexts, variables, or expressions reference pages.
For security questions, prefer
```
Secure use
```
,
```
Secrets
```
,
```
GITHUB_TOKEN
```
,
```
OpenID Connect
```
, and artifact attestation docs.
For deployment questions, prefer environments and deployment protection docs before cloud-specific examples.
For migration questions, prefer the migration hub page first, then a platform-specific migration guide.
If the user asks for a beginner walkthrough, start with a tutorial or quickstart instead of a raw reference page.

对于概念类问题，优先选择概述或概念页面，而非深度参考页面。
对于语法类问题，优先选择工作流语法、事件、上下文、变量或表达式参考页面。
对于安全类问题，优先选择
```
安全使用
```
、
```
密钥
```
、
```
GITHUB_TOKEN
```
、
```
OpenID Connect
```
和工件认证相关文档。
对于部署类问题，优先选择环境与部署保护文档，而非云服务商特定示例。
对于迁移类问题，优先选择迁移中心页面，再选择平台特定的迁移指南。
如果用户要求初学者入门教程，请从教程或快速开始页面入手，而非原始参考页面。

Common Mistakes

常见错误

Answering from memory without verifying the current docs
Linking the GitHub Actions docs landing page when a narrower page exists
Mixing up reusable workflows and composite actions
Suggesting long-lived cloud credentials when OIDC is the better documented path
Treating repo-specific CI debugging as a documentation question when it should be handed to
```
gh-fix-ci
```
Letting adjacent domains absorb the request when
```
codeql
```
or
```
dependabot
```
is the sharper fit

未验证当前文档，仅凭记忆回答
当存在更具体的页面时，仍链接GitHub Actions文档首页
混淆可复用工作流与复合操作
当OIDC是文档推荐的更优方案时，仍建议使用长期云凭证
将仓库特定的CI调试视为文档问题，而实际上应交给
```
gh-fix-ci
```
处理
当
```
codeql
```
或
```
dependabot
```
更合适时，仍用本技能处理相关请求

Bundled Reference

内置参考

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.

仅将

references/topic-map.md

作为可能的文档入口点的紧凑索引使用。该文档内容故意不完整，绝不能替代实时GitHub文档作为最终权威来源。