添加文档自动检查、Actions 工作流与 PR 维护模板
docs / check (push) Failing after 0s

This commit is contained in:
2026-09-16 18:50:57 +00:00
parent cf4430526a
commit e394b2612d
9 changed files with 399 additions and 0 deletions
+20
View File
@@ -0,0 +1,20 @@
## 改了什么
说明具体问题、修改后的使用方法或事实;纯文字修正可简写。
## 依据
关联源码 commit/PR、ticket 或带日期的维护者说明。若来自未提交工作区,明确标注。
## 验证与范围
填写本地检查/CI 结果。现场是否查询、验证了什么、哪些示例未执行?
没有现场验证时,不因编辑文字而刷新 last_verified。
## 文档同步
- [ ] 涉及的服务页已更新;新增/退役服务已同步服务总览。
- [ ] 入口或设计变化已更新相关任务导航/架构约束(不适用可注明)。
- [ ] 已注明来源与尚未完成的部分,未包含实际凭据。
原仓库 README 同步目前暂缓,不是本 PR 的必做项。
+26
View File
@@ -0,0 +1,26 @@
name: docs
on:
push:
branches: [main]
pull_request:
workflow_dispatch:
jobs:
check:
runs-on: [self-hosted, pod]
container:
image: python:3.12-bookworm
steps:
- name: Checkout
uses: actions/checkout@v4
with:
persist-credentials: false
- name: Install checker dependencies
run: python3 -m pip install --disable-pip-version-check -r requirements-docs.txt
- name: Test checker
run: python3 -m unittest discover -s tests -v
- name: Check documentation
run: python3 scripts/check_docs.py
- name: Check whitespace
run: git show --format= --check HEAD