docs(ci): document protected status contexts
All checks were successful
CI / verify (push) Successful in 45s

This commit is contained in:
Your Name
2026-05-06 12:46:22 +08:00
parent 110a16b19f
commit 67922c589a
4 changed files with 13 additions and 0 deletions

View File

@@ -1,3 +1,7 @@
# Keep workflow name stable.
# Branch protection and external CI references rely on:
# - CI / verify (push)
# - CI / verify (pull_request)
name: CI name: CI
on: on:
@@ -9,6 +13,7 @@ on:
jobs: jobs:
verify: verify:
# Keep job id stable. Renaming it changes the status context.
runs-on: ubuntu-latest runs-on: ubuntu-latest
env: env:
WORKSPACE_DIR: ${{ github.workspace }}/repo WORKSPACE_DIR: ${{ github.workspace }}/repo

View File

@@ -1,3 +1,7 @@
# Keep workflow name stable.
# Branch protection and external CI references rely on:
# - CI / verify (push)
# - CI / verify (pull_request)
name: CI name: CI
on: on:
@@ -12,6 +16,7 @@ permissions:
jobs: jobs:
verify: verify:
# Keep job id stable. Renaming it changes the status context.
runs-on: ubuntu-latest runs-on: ubuntu-latest
timeout-minutes: 20 timeout-minutes: 20

View File

@@ -58,6 +58,7 @@ chore(scope): summary
- 新接口是否有明确的错误码和测试 - 新接口是否有明确的错误码和测试
- 平台适配是否仍然只停留在边缘层 - 平台适配是否仍然只停留在边缘层
- callback / outbox / dead letter 是否可追踪、可重放 - callback / outbox / dead letter 是否可追踪、可重放
- `.github/workflows/ci.yml``.gitea/workflows/ci.yml``name: CI``jobs.verify` 是否保持稳定,避免破坏受保护状态上下文
## 参考文档 ## 参考文档

View File

@@ -130,6 +130,8 @@ go vet ./...
GitHub 执行 `go test ./... -count=1``go test -race ./...``go vet ./...`、Gate 脚本语法检查; GitHub 执行 `go test ./... -count=1``go test -race ./...``go vet ./...`、Gate 脚本语法检查;
Gitea/TKSea 因共享测试库约束,执行 `go test ./... -count=1 -p 1``go test -race ./... -p 1``go vet ./...`、Gate 脚本语法检查 Gitea/TKSea 因共享测试库约束,执行 `go test ./... -count=1 -p 1``go test -race ./... -p 1``go vet ./...`、Gate 脚本语法检查
- GitHub 使用 [`.github/workflows/ci.yml`](.github/workflows/ci.yml)Gitea/TKSea 使用 [`.gitea/workflows/ci.yml`](.gitea/workflows/ci.yml) - GitHub 使用 [`.github/workflows/ci.yml`](.github/workflows/ci.yml)Gitea/TKSea 使用 [`.gitea/workflows/ci.yml`](.gitea/workflows/ci.yml)
- `workflow` 名称和 `verify` job 名称属于受保护契约。当前分支保护依赖这两个状态上下文:
`CI / verify (push)``CI / verify (pull_request)`;不要随意改名
- 本地默认共享 PostgreSQL 测试库,所以本地验证命令统一使用 `-p 1` 串行执行,避免跨包并发污染测试表 - 本地默认共享 PostgreSQL 测试库,所以本地验证命令统一使用 `-p 1` 串行执行,避免跨包并发污染测试表
- 变更配置契约时,必须同步更新: - 变更配置契约时,必须同步更新:
- `docs/CONFIG_CONTRACT_BASELINE.md` - `docs/CONFIG_CONTRACT_BASELINE.md`