Skip to content

Commit beb1229

Browse files
committed
docs(release): version docs before content edits
1 parent e9083c5 commit beb1229

1 file changed

Lines changed: 8 additions & 7 deletions

File tree

‎.roo/commands/release.md‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -130,18 +130,19 @@ mode: code
130130
131131
**Documentation and version synchronization**
132132
133-
- Always assess and create or update `docs/update-notes/v[version].md`, register that exact version newest-first in both `docs/update-notes/index.md` and `sidebars.ts`, and use the stable publication date, Zoo Code branding, and the docs project's existing linking conventions.
134-
- Document only the current release; do not backfill missing historical releases.
135-
- If the current release's `major.minor` group is absent, insert a new newest-first `### Version major.minor` section in `docs/update-notes/index.md` and a matching newest-first sidebar category immediately after `update-notes/index`.
136-
- If the `major.minor` group exists, add the exact patch release newest-first within that group in both files.
137-
- Build a per-PR documentation impact matrix from every shipped PR. Cover every user-visible change in the release note, and update all relevant canonical evergreen provider, feature, tool, and getting-started pages. Record a rationale for each implementation-only exclusion and, when no evergreen page changes are needed, record that no-change rationale.
138-
- Synchronize the docs repository's sole package version in `package.json` using exactly:
133+
- While the selected docs branch is still clean and before modifying any documentation files, synchronize the docs repository's sole package version in `package.json` using exactly:
139134
140135
```bash
141136
pnpm version "$VERSION" --no-git-tag-version --allow-same-version
142137
```
143138
144-
Confirm this creates no tag and no incidental `pnpm-lock.yaml` change.
139+
Verify that `package.json` equals the stable extension version, that no tag was created, and that `pnpm-lock.yaml` did not change solely from the version bump. Do not downgrade a newer docs version.
140+
141+
- Always assess and create or update `docs/update-notes/v[version].md`, register that exact version newest-first in both `docs/update-notes/index.md` and `sidebars.ts`, and use the stable publication date, Zoo Code branding, and the docs project's existing linking conventions.
142+
- Document only the current release; do not backfill missing historical releases.
143+
- If the current release's `major.minor` group is absent, insert a new newest-first `### Version major.minor` section in `docs/update-notes/index.md` and a matching newest-first sidebar category immediately after `update-notes/index`.
144+
- If the `major.minor` group exists, add the exact patch release newest-first within that group in both files.
145+
- Build a per-PR documentation impact matrix from every shipped PR. Cover every user-visible change in the release note, and update all relevant canonical evergreen provider, feature, tool, and getting-started pages. Record a rationale for each implementation-only exclusion and, when no evergreen page changes are needed, record that no-change rationale.
145146
146147
**Validation and PR creation**
147148

0 commit comments

Comments
 (0)