playbook/templates/ci/README.md

38 lines
1.0 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# CI 模板templates/ci
本目录提供“目标项目可复制启用”的 CI 模板示例,用于在 CI 中自动化校验部分 Playbook 规范。
当前提供:
- `gitea/`Gitea ActionsGitHub Actions 语法)
说明:`templates/ci/gitea/.gitea/` 结构用于与目标项目根目录的 `.gitea/`
保持一致,便于直接复制到项目根目录。
## 使用Gitea Actions
前提:目标项目已经 vendoring Playbook例如 `docs/standards/playbook/`)。
复制到目标项目根目录:
```sh
cp -R docs/standards/playbook/templates/ci/gitea/.gitea ./
```
提交:
```sh
git add .gitea
git commit -m ":memo: docs(ci): add standards check workflow"
```
## commit message 校验
工作流会运行 `.gitea/ci/commit_message_lint.py`
- 规范来源(自动探测其一):
- `docs/common/commit_message.md`
- `docs/standards/playbook/docs/common/commit_message.md`
- 默认要求 emoji如需允许无 emoji在 workflow 中设置
`COMMIT_LINT_REQUIRE_EMOJI=0`