docs: add docs for scoped workflows (#447)

Related: https://github.com/go-gitea/gitea/pull/38154
---------

Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
Reviewed-on: https://gitea.com/gitea/docs/pulls/447
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: Zettat123 <zettat123@gmail.com>
Co-committed-by: Zettat123 <zettat123@gmail.com>
This commit is contained in:
Zettat123
2026-06-28 09:32:51 +00:00
committed by Nicolas
parent 7fe73e351f
commit 1fb481c186
6 changed files with 360 additions and 0 deletions

View File

@@ -1570,6 +1570,7 @@ PROXY_HOSTS = *.github.com
- `ABANDONED_JOB_TIMEOUT`: **24h**: 被遗弃的作业超时时间,指具有等待状态但长时间未被 runner 选中并执行的作业。
- `SKIP_WORKFLOW_STRINGS`: **[skip ci],[ci skip],[no ci],[skip actions],[actions skip]**: 提交者可以在提交消息或 PR 标题中放置的字符串,以跳过执行相应的工作流。
- `WORKFLOW_DIRS`**.gitea/workflows,.github/workflows**:以逗号分隔的工作流目录列表,仓库中第一个存在的目录将用于查找 Actions 工作流文件。
- `SCOPED_WORKFLOW_DIRS`**.gitea/scoped_workflows**:以逗号分隔的目录列表,用于存放[作用域工作流](usage/actions/scoped-workflows.md)(在一个中心源仓库中定义、并在其他仓库上运行的工作流)。不得与 `WORKFLOW_DIRS` 重叠。留空则不会扫描任何目录来查找作用域工作流,因此不会找到或运行任何作用域工作流。
- `MAX_RERUN_ATTEMPTS`**50**:单个工作流运行最多可以有的尝试次数(初始运行 + 重新运行)。默认 50。可根据需要设置为任何正整数。
`DEFAULT_ACTIONS_URL` 指示 Gitea 操作运行程序应该在哪里找到带有相对路径的操作。

View File

@@ -0,0 +1,119 @@
---
date: "2026-06-26T00:00:00+00:00"
slug: "scoped-workflows"
sidebar_position: 60
---
# 作用域工作流
作用域工作流Scoped Workflows让你把 Actions 工作流集中维护在一个**源source**仓库中,并让它们自动在许多其他仓库上运行,而无需把工作流文件复制到每个仓库里。
提交到源仓库作用域工作流目录下的工作流文件,会在该源所适用的每个仓库(称为**消费方consuming**仓库)上运行。每次运行都在**消费方仓库自身的上下文**中执行:使用它的 runner、密钥、`GITEA_TOKEN` 和分支,而工作流**内容则读取自源仓库**。这适用于在组织或实例范围内强制推行共享 CI代码检查、安全扫描、合规或策略检查等。
## 级别
源仓库可以在两个级别注册:
- **所有者级别Owner level**:由组织或用户注册。该源的工作流会在该组织或用户拥有的每个仓库上运行。
- **实例级别Instance level**:由站点管理员注册。该源的工作流会在实例上的**每一个**仓库上运行。
同一个仓库可以同时在两个级别注册;对于每个匹配的事件,它仍只会被评估一次。
:::note
实例级别的源适用于实例上的**每一个**仓库且被设为必需required的源无法被选择退出opt out。检测会在每个仓库的每次事件上运行。请谨慎注册。
:::
## 配置
作用域工作流存放在一个与常规工作流分开的目录中,由 `app.ini``[actions]` 段的 `SCOPED_WORKFLOW_DIRS` 控制:
```ini
[actions]
SCOPED_WORKFLOW_DIRS = .gitea/scoped_workflows
```
- 默认值为 `.gitea/scoped_workflows`
- 可以列出多个目录(以逗号分隔)。
- **不得与** `WORKFLOW_DIRS`(常规工作流目录,默认为 `.gitea/workflows``.github/workflows`**重叠**。
- 留空意味着没有任何目录存放作用域工作流,因此不会找到也不会运行任何作用域工作流。设置页面仍会显示、源仍可注册,但不会有任何作用域工作流运行。
把作用域工作流放在它们自己的目录中,意味着源仓库**自身**的 Actions 不受影响:只有 `SCOPED_WORKFLOW_DIRS` 下的文件才会被当作作用域工作流。
## 从一个仓库提供作用域工作流
1. 在准备作为源的仓库中,把工作流文件提交到其**默认分支**上的作用域工作流目录下,例如 `.gitea/scoped_workflows/lint.yaml`
```yaml
name: Lint
on: [push, pull_request]
jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- run: echo "lint the consuming repository here"
```
2. 将该仓库注册为源:
- **组织***组织设置 -> Actions -> 作用域工作流*
- **用户***用户设置 -> Actions -> 作用域工作流*
- **实例(管理员)***管理后台 -> Actions -> 作用域工作流*
搜索并添加该仓库。此后,它的作用域工作流便会适用于该级别下的消费方仓库。
源仓库也在它自己的作用域内,因此它会像其他消费方一样在自身上运行这些工作流。
## 作用域工作流如何运行
- 该运行属于**消费方**仓库,使用它的 runner、密钥、`GITEA_TOKEN` 和 ref。它在那里的表现与普通运行一致包括重跑、日志和提交状态。
- 工作流**内容读取自源**仓库,并钉定在事件发生时源默认分支的 commit 上。
- 检测使用消费方仓库的事件,因此工作流的 `on:` 触发器(例如 `push` 和 `pull_request`)必须与该事件匹配。
## 选择退出Opting out
消费方仓库可以在其 **Actions** 页面(该工作流会显示在其源之下)禁用一个它不想要的作用域工作流。已被标记为**必需required**(见下文)的工作流,消费方仓库永远无法将其禁用,也无法选择退出。
## 必需工作流与合并门禁
在作用域工作流设置页面上,你可以把单个工作流标记为**必需required**,并为每个工作流给定一个或多个**状态检查模式status-check patterns**(每行一个 glob。一个必需的作用域工作流
- 无法被消费方仓库禁用。
- 会对合并请求PR形成合并门禁消费方的 PR 只有在一个匹配**每一个**模式的提交状态都**通过**后才能合并必须存在且通过must-present-and-pass。一个从不产生任何状态的必需检查会**阻止**合并,而不是被静默跳过,因此在消费方关闭 Actions 也无法绕过它。
作用域运行产生的状态检查 context 形如:
```
<源仓库全名>: <工作流显示名> / <job> (<event>)
```
设置页面会为每个工作流预览这些 “Expected status checks预期状态检查并标记出与你的模式匹配的项便于你确认模式是否正确。一种常见模式是对 job 和 event 使用通配符,例如 `my-org/ci-repo: Lint / *`。
强制范围:
- 必需检查会在任何设有**分支保护规则**的目标分支上强制生效,即使该规则自身的状态检查处于关闭状态。
- **没有**保护规则的目标分支不受门禁约束。
:::warning
只有运行在会产生提交状态的事件(`push`、`pull_request`、`pull_request_target`、`release`)上的工作流才能被设为必需。仅运行在 `workflow_dispatch`、`schedule` 或 `workflow_call` 等事件上的工作流不会产生任何状态,因此把它设为必需会**永久**阻止每一个消费方 PR 的合并。设置页面在这种情况下会向你发出警告。
:::
## 可复用工作流(`uses:`
作用域工作流可以调用可复用工作流:
- **本地**引用(`uses: ./...`)会相对于**源**仓库解析:即调用方工作流内容的来源仓库,而非消费方仓库。
- **跨仓库**引用(`uses: owner/repo/...@ref`)会以**消费方仓库的**读取权限来解析。如果它指向一个私有仓库,请确保每个消费方仓库都能读取它,否则工作流会在那里失败。
可复用工作流可以放在源仓库的 `SCOPED_WORKFLOW_DIRS`(或 `WORKFLOW_DIRS`)之下。
## 安全注意事项
源仓库的工作流内容会在它所适用的每个仓库中执行,其步骤脚本及其输出会写入该仓库的 Actions 日志,任何能查看消费方仓库 Actions 的人都能读取这些日志。
- 因此,将一个**私有**仓库注册为源,会通过这些日志泄露其工作流逻辑。只应注册那些其工作流内容可以与每个消费方仓库共享的仓库。
## 限制
- 目前不支持将 `on: schedule` 和 `on: workflow_run` 作为作用域工作流触发器。
- 作用域工作流内容读取自源的默认分支;源的其他分支不会被使用。