Skip to content

docs: close gaps in the PR/release workflow writeup - #5

Merged
bytesnail merged 1 commit into
mainfrom
docs/workflow-release-clarifications
Oct 4, 2026
Merged

bytesnail merged 1 commit into
mainfrom
docs/workflow-release-clarifications

Conversation

@bytesnail

Copy link
Copy Markdown
Owner

对 AGENTS.md / CONTRIBUTING.md 的 PR 流程与发布流程描述做审计后的修补,4 处:

  1. (正确性隐患)tag 落点:明确 v* tag 必须打在 merged main HEAD 上——squash 合并时 release 分支的本地 commit 不在 main 历史里,而不可变 tag 打错无法移动。同时补全 git checkout main && git pull --ff-only。
  2. 审批要求:写明 required_approving_review_count: 0(solo 项目),绿了即可合,不用等 reviewer。
  3. PR 标题即 changelog 来源:squash 合并时落地 commit 的 subject = PR 标题,scripts/changelog.ts 据此生成草稿,AGENTS.md 与 CONTRIBUTING.md 同步强调。
  4. dependabot 操作坑:更新分支用 @dependabot rebase 评论;gh pr update-branch 对改了 workflow 的 PR 会因 OAuth 缺 workflow scope 失败(2026-10-04 实测)。

纯文档改动。

- Release: the v* tag must point at the merged main HEAD — with a squash
  merge the release branch's local commit is not in main's history, and
  immutable tags cannot be moved without ruleset surgery. Spell out
  'git checkout main && git pull --ff-only'.
- Conventions/CONTRIBUTING: no approvals are required to merge
  (required_approving_review_count: 0, solo project).
- Conventions/CONTRIBUTING: write PR titles as conventional-commit
  subjects — a squash merge makes the title the commit subject that
  scripts/changelog.ts reads.
- Conventions: refresh dependabot PR branches with '@dependabot rebase';
  'gh pr update-branch' fails on workflow-touching PRs without the OAuth
  workflow scope (bit us 2026-10-04).
@bytesnail
bytesnail merged commit b039192 into main Oct 4, 2026
15 checks passed
@bytesnail
bytesnail deleted the docs/workflow-release-clarifications branch October 4, 2026 19:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant