mirror of
https://github.com/GeWuYou/GFramework.git
synced 2026-05-07 00:39:00 +08:00
Merge pull request #319 from GeWuYou/build/semantic-release-rules
build(release): 支持依赖与安全提交触发补丁发布
This commit is contained in:
commit
69ea92c149
@ -33,6 +33,14 @@
|
|||||||
"type": "refactor",
|
"type": "refactor",
|
||||||
"release": "patch"
|
"release": "patch"
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"type": "deps",
|
||||||
|
"release": "patch"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "security",
|
||||||
|
"release": "patch"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"type": "docs",
|
"type": "docs",
|
||||||
"release": false
|
"release": false
|
||||||
@ -70,6 +78,45 @@
|
|||||||
"@semantic-release/release-notes-generator",
|
"@semantic-release/release-notes-generator",
|
||||||
{
|
{
|
||||||
"preset": "conventionalcommits",
|
"preset": "conventionalcommits",
|
||||||
|
"presetConfig": {
|
||||||
|
"types": [
|
||||||
|
{
|
||||||
|
"type": "feat",
|
||||||
|
"section": "Features",
|
||||||
|
"hidden": false
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "fix",
|
||||||
|
"section": "Bug Fixes",
|
||||||
|
"hidden": false
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "perf",
|
||||||
|
"section": "Performance Improvements",
|
||||||
|
"hidden": false
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "refactor",
|
||||||
|
"section": "Refactoring",
|
||||||
|
"hidden": false
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "deps",
|
||||||
|
"section": "Dependency Updates",
|
||||||
|
"hidden": false
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "security",
|
||||||
|
"section": "Security Fixes",
|
||||||
|
"hidden": false
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "revert",
|
||||||
|
"section": "Reverts",
|
||||||
|
"hidden": false
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
"parserOpts": {
|
"parserOpts": {
|
||||||
"noteKeywords": [
|
"noteKeywords": [
|
||||||
"BREAKING CHANGE",
|
"BREAKING CHANGE",
|
||||||
|
|||||||
@ -60,6 +60,10 @@ All AI agents and contributors must follow these rules when writing, reviewing,
|
|||||||
`minor` segment.
|
`minor` segment.
|
||||||
- Use `fix` for behavior corrections, `perf` for observable performance improvements, and `refactor` only for
|
- Use `fix` for behavior corrections, `perf` for observable performance improvements, and `refactor` only for
|
||||||
non-feature code restructuring; these should raise the next released version's `patch` segment.
|
non-feature code restructuring; these should raise the next released version's `patch` segment.
|
||||||
|
- Use `deps` for dependency version updates, dependency lockfile refreshes, and package maintenance that should raise
|
||||||
|
the next released version's `patch` segment.
|
||||||
|
- Use `security` for vulnerability fixes, dependency security mitigations, and security configuration corrections
|
||||||
|
that should raise the next released version's `patch` segment.
|
||||||
- Use `docs`、`test`、`chore`、`build`、`ci`、`style` for their literal categories; do not encode these changes as
|
- Use `docs`、`test`、`chore`、`build`、`ci`、`style` for their literal categories; do not encode these changes as
|
||||||
`feat` just because they feel important. These categories MUST NOT trigger a release.
|
`feat` just because they feel important. These categories MUST NOT trigger a release.
|
||||||
- Use `BREAKING CHANGE` in the commit footer or `!` after the type / scope header (for example `feat!:` or
|
- Use `BREAKING CHANGE` in the commit footer or `!` after the type / scope header (for example `feat!:` or
|
||||||
|
|||||||
@ -62,6 +62,9 @@ help the current worktree land on the right recovery documents without scanning
|
|||||||
- Branch: `feat/semantic-release-versioning`
|
- Branch: `feat/semantic-release-versioning`
|
||||||
- Worktree hint: `GFramework`
|
- Worktree hint: `GFramework`
|
||||||
- Priority 1: `semantic-release-versioning`
|
- Priority 1: `semantic-release-versioning`
|
||||||
|
- Branch: `build/semantic-release-rules`
|
||||||
|
- Worktree hint: `GFramework`
|
||||||
|
- Priority 1: `semantic-release-versioning`
|
||||||
- Branch: `docs/sdk-update-documentation`
|
- Branch: `docs/sdk-update-documentation`
|
||||||
- Worktree hint: `GFramework-update-documentation`
|
- Worktree hint: `GFramework-update-documentation`
|
||||||
- Priority 1: `documentation-full-coverage-governance`
|
- Priority 1: `documentation-full-coverage-governance`
|
||||||
|
|||||||
@ -8,17 +8,18 @@
|
|||||||
- 用 `cycjimmy/semantic-release-action` 替换 `auto-tag.yml` 的版本判断和打 tag 逻辑
|
- 用 `cycjimmy/semantic-release-action` 替换 `auto-tag.yml` 的版本判断和打 tag 逻辑
|
||||||
- 保留 `publish.yml` 的现有发布实现,不重写 NuGet 流程
|
- 保留 `publish.yml` 的现有发布实现,不重写 NuGet 流程
|
||||||
- 避免 `semantic-release` 与 `publish.yml` 重复创建 GitHub Release
|
- 避免 `semantic-release` 与 `publish.yml` 重复创建 GitHub Release
|
||||||
- 将版本规则固定为 `feat -> minor`、`fix/perf/refactor -> patch`、`BREAKING CHANGE` 或 `! -> major`
|
- 将版本规则固定为 `feat -> minor`、`fix/perf/refactor/deps/security -> patch`、`BREAKING CHANGE` 或 `! -> major`
|
||||||
- 为手动 `workflow_dispatch` 保留 dry-run 验证入口,先验证最近提交会算出什么版本
|
- 为手动 `workflow_dispatch` 保留 dry-run 验证入口,先验证最近提交会算出什么版本
|
||||||
|
|
||||||
## 当前恢复点
|
## 当前恢复点
|
||||||
|
|
||||||
- 恢复点编号:暂无
|
- 恢复点编号:SEMREL-RP-006
|
||||||
- 当前阶段:等待下一轮 semantic-release 维护任务
|
- 当前阶段:处理 PR review 中的 release notes 类型映射漂移
|
||||||
- 当前焦点:
|
- 当前焦点:
|
||||||
- `SEMREL-RP-004` 已归档到
|
- `.releaserc.json` 的 `release-notes-generator` 增加 `presetConfig.types`
|
||||||
`ai-plan/public/semantic-release-versioning/archive/todos/semantic-release-versioning-rp004-2026-05-02.md`
|
- 让 `refactor`、`deps` 与 `security` 这类 patch 级发布原因出现在 semantic-release 生成的 notes 中
|
||||||
- 后续如 CI 或发布流程继续暴露 semantic-release 问题,再从新的恢复点编号开始记录
|
- `AGENTS.md` 和 `docs/zh-CN/contributing.md` 同步提交类型说明
|
||||||
|
- `build/semantic-release-rules` 分支映射到当前 active topic
|
||||||
|
|
||||||
### 已知风险
|
### 已知风险
|
||||||
|
|
||||||
@ -26,6 +27,8 @@
|
|||||||
- `semantic-release` preview 虽然不会真实推送 tag,但仍会执行远端 `git push --dry-run` 权限探测;如果 PAT 仅具备
|
- `semantic-release` preview 虽然不会真实推送 tag,但仍会执行远端 `git push --dry-run` 权限探测;如果 PAT 仅具备
|
||||||
read 权限、没有 `contents:write`,仍然会先于版本分析阶段失败
|
read 权限、没有 `contents:write`,仍然会先于版本分析阶段失败
|
||||||
- `semantic-release` 的版本判断完全依赖 Conventional Commits;不规范提交会直接影响版本计算
|
- `semantic-release` 的版本判断完全依赖 Conventional Commits;不规范提交会直接影响版本计算
|
||||||
|
- patch 级提交类型的发布语义需要同时维护在 `.releaserc.json`、`AGENTS.md`、公开贡献文档和
|
||||||
|
`release-notes-generator` 的 notes 类型映射中,避免版本升级原因与 workflow summary 漂移
|
||||||
- `cycjimmy/semantic-release-action@v6` 需要在 preview / release 两端都安装 `conventional-changelog-conventionalcommits`
|
- `cycjimmy/semantic-release-action@v6` 需要在 preview / release 两端都安装 `conventional-changelog-conventionalcommits`
|
||||||
以保证 `conventionalcommits` preset 在 GitHub Actions 中可解析
|
以保证 `conventionalcommits` preset 在 GitHub Actions 中可解析
|
||||||
- `git-cliff-action` 的 `OUTPUT` 文件需要在 `softprops/action-gh-release` 执行时保留在当前工作目录,后续如调整
|
- `git-cliff-action` 的 `OUTPUT` 文件需要在 `softprops/action-gh-release` 执行时保留在当前工作目录,后续如调整
|
||||||
@ -41,14 +44,26 @@
|
|||||||
- 已为 PAT 校验的 `mktemp` 文件补充 `trap` 清理,避免异常退出时遗留临时文件路径干扰日志
|
- 已为 PAT 校验的 `mktemp` 文件补充 `trap` 清理,避免异常退出时遗留临时文件路径干扰日志
|
||||||
- `SEMREL-RP-004` 的 release notes 模板修复、验证和合并后分支收尾已归档到
|
- `SEMREL-RP-004` 的 release notes 模板修复、验证和合并后分支收尾已归档到
|
||||||
`ai-plan/public/semantic-release-versioning/archive/todos/semantic-release-versioning-rp004-2026-05-02.md`
|
`ai-plan/public/semantic-release-versioning/archive/todos/semantic-release-versioning-rp004-2026-05-02.md`
|
||||||
|
- `SEMREL-RP-005` 已扩展 `deps` / `security` 的 patch 发布规则,并同步提交规范文档
|
||||||
|
- `SEMREL-RP-006` 已根据 PR review 复核结果补齐 release notes 类型映射,避免 patch 发布原因只触发版本而不进入 notes
|
||||||
|
|
||||||
## 验证
|
## 验证
|
||||||
|
|
||||||
- `SEMREL-RP-004` 的本地验证结果已归档。
|
- `SEMREL-RP-004` 的本地验证结果已归档。
|
||||||
|
- `SEMREL-RP-005` 已完成本地验证:
|
||||||
|
- `jq . .releaserc.json` 通过
|
||||||
|
- `semantic-release --dry-run --no-ci` 已成功加载 `commit-analyzer` 和 `release-notes-generator`,随后因远端 tag
|
||||||
|
fetch 会 clobber 本地既有 tags 而终止,未暴露配置解析错误
|
||||||
|
- `dotnet build GFramework.sln -c Release` 通过,`0 warning / 0 error`
|
||||||
|
- `SEMREL-RP-006` 已完成本地验证:
|
||||||
|
- `jq . .releaserc.json` 通过
|
||||||
|
- `semantic-release --dry-run --no-ci` 已成功加载 `commit-analyzer` 和 `release-notes-generator`,随后因远端 tag
|
||||||
|
fetch 会 clobber 本地既有 tags 而终止,未暴露 `presetConfig.types` 配置解析错误
|
||||||
|
- `dotnet build GFramework.sln -c Release` 通过,`0 warning / 0 error`
|
||||||
- 更早阶段的 dry-run / tag /抽象项目验证已归档到
|
- 更早阶段的 dry-run / tag /抽象项目验证已归档到
|
||||||
`ai-plan/public/semantic-release-versioning/archive/todos/semantic-release-versioning-2026-04-26.md`
|
`ai-plan/public/semantic-release-versioning/archive/todos/semantic-release-versioning-2026-04-26.md`
|
||||||
|
|
||||||
## 下一步
|
## 下一步
|
||||||
|
|
||||||
1. 如 CI 仍报告 release notes 发布问题,再优先复查 `git-cliff-action` 输出文件路径与模板渲染结果
|
1. 提交 `SEMREL-RP-006` 的 PR review 修复
|
||||||
2. 下一轮 semantic-release 调整开始时创建新的恢复点编号
|
2. 如后续需要完整 semantic-release 版本预览,先处理本地 tag 与远端 tag 的 clobber 冲突
|
||||||
|
|||||||
@ -1,5 +1,52 @@
|
|||||||
# Semantic Release 版本迁移追踪
|
# Semantic Release 版本迁移追踪
|
||||||
|
|
||||||
|
## 2026-05-04
|
||||||
|
|
||||||
|
### PR review notes 类型映射修复(SEMREL-RP-006)
|
||||||
|
|
||||||
|
- 通过 `$gframework-pr-review` 抓取当前分支 PR #319:
|
||||||
|
- CodeRabbit 在最新 review body 中提出 1 个 nitpick,指出 `deps` / `security` 已触发 patch,但
|
||||||
|
`release-notes-generator` 缺少 `presetConfig.types`,workflow summary 可能看不到对应发布原因
|
||||||
|
- 最新 head commit 没有未解决 review threads
|
||||||
|
- CTRF 测试报告显示 `2264 passed / 0 failed`
|
||||||
|
- 未找到 MegaLinter 明细块
|
||||||
|
- 本地复核结论:
|
||||||
|
- `.releaserc.json` 的 `commit-analyzer` 已配置 `deps -> patch` 与 `security -> patch`
|
||||||
|
- `release-notes-generator` 仍只配置 `conventionalcommits` preset 和 `parserOpts.noteKeywords`
|
||||||
|
- 该 drift 会让 patch 级发布原因与 release notes 可读性不一致,评论成立
|
||||||
|
- 已应用修复:
|
||||||
|
- `.releaserc.json` 为 `release-notes-generator` 增加 `presetConfig.types`
|
||||||
|
- `feat`、`fix`、`perf`、`refactor`、`deps`、`security` 和 `revert` 均保留可见 notes section
|
||||||
|
- 验证:
|
||||||
|
- `jq . .releaserc.json` 通过
|
||||||
|
- `npx --yes -p semantic-release -p conventional-changelog-conventionalcommits@9.1.0 semantic-release --dry-run --no-ci`
|
||||||
|
成功加载 `commit-analyzer` 和 `release-notes-generator`;随后在 `git fetch --tags` 阶段因远端 tag 会 clobber
|
||||||
|
本地既有 tags 而终止,未暴露 `presetConfig.types` 配置解析错误
|
||||||
|
- `dotnet build GFramework.sln -c Release` 通过,`0 warning / 0 error`
|
||||||
|
- 下一步是提交本轮 PR review 修复;如后续需要完整 semantic-release 版本预览,先处理本地 tag 与远端 tag 的
|
||||||
|
clobber 冲突。
|
||||||
|
|
||||||
|
## 2026-05-03
|
||||||
|
|
||||||
|
### patch 级提交类型扩展(SEMREL-RP-005)
|
||||||
|
|
||||||
|
- 本轮目标:
|
||||||
|
- 允许 `deps` 提交触发 patch 发布,用于依赖版本、依赖锁定和包维护变更
|
||||||
|
- 允许 `security` 提交触发 patch 发布,用于安全修复、漏洞缓解和安全配置修正
|
||||||
|
- 同步 `.releaserc.json`、`AGENTS.md`、公开贡献文档和 active topic 映射,避免 release 规则与提交规范漂移
|
||||||
|
- 已更新:
|
||||||
|
- `.releaserc.json`:新增 `deps -> patch` 和 `security -> patch`
|
||||||
|
- `AGENTS.md`:补充 `deps` / `security` 的 release 语义
|
||||||
|
- `docs/zh-CN/contributing.md`:补充公开贡献指南中的 Type 说明
|
||||||
|
- `ai-plan/public/README.md`:新增 `build/semantic-release-rules` 到 `semantic-release-versioning` 的分支映射
|
||||||
|
- 验证:
|
||||||
|
- `jq . .releaserc.json` 通过
|
||||||
|
- `npx --yes -p semantic-release -p conventional-changelog-conventionalcommits@9.1.0 semantic-release --dry-run --no-ci`
|
||||||
|
成功加载 `commit-analyzer` 和 `release-notes-generator`;随后在 `git fetch --tags` 阶段因远端 tag 会 clobber
|
||||||
|
本地既有 tags 而终止,未暴露本轮配置解析错误
|
||||||
|
- `dotnet build GFramework.sln -c Release` 通过,`0 warning / 0 error`
|
||||||
|
- 下一步是提交本轮规则扩展;如后续需要完整 semantic-release 版本预览,先处理本地 tag 与远端 tag 的 clobber 冲突。
|
||||||
|
|
||||||
## 2026-05-01
|
## 2026-05-01
|
||||||
|
|
||||||
### 发布说明 PR 归属展示(SEMREL-RP-004)
|
### 发布说明 PR 归属展示(SEMREL-RP-004)
|
||||||
|
|||||||
@ -360,6 +360,8 @@ public TModel RegisterModel<TModel>(TModel model) where TModel : IModel
|
|||||||
- **style**:代码格式调整(不影响功能)
|
- **style**:代码格式调整(不影响功能)
|
||||||
- **refactor**:重构(不是新功能也不是修复)
|
- **refactor**:重构(不是新功能也不是修复)
|
||||||
- **perf**:性能优化
|
- **perf**:性能优化
|
||||||
|
- **deps**:依赖版本、依赖锁定或包维护变更
|
||||||
|
- **security**:安全修复、漏洞缓解或安全配置修正
|
||||||
- **test**:添加或修改测试
|
- **test**:添加或修改测试
|
||||||
- **chore**:构建过程或辅助工具的变动
|
- **chore**:构建过程或辅助工具的变动
|
||||||
- **ci**:CI 配置文件和脚本的变动
|
- **ci**:CI 配置文件和脚本的变动
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user