Skip to content

docs(template): release notes template #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hkimw wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(template): release notes template #51

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 66 additions & 0 deletions docs/templates/release-notes-template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
orphan: true
---

# pccx vX.Y.Z - release notes

> **Release status.** Replace this paragraph with the release state:
> draft, prerelease, latest release, or archived release. Keep this page
> aligned with the GitHub Release body after publication.

- **Repo**: `pccxai/pccx`
- **Tag**: `vX.Y.Z`
- **Title**: `pccx vX.Y.Z - <short release subtitle>`
- **Pre-release**: yes/no
- **Release link**: <https://github.com/pccxai/pccx/releases/tag/vX.Y.Z>
- **Published**: YYYY-MM-DD

## Highlights

- <User-visible documentation, architecture, ISA, tooling, or release
process change.>
- <Second highlight.>
- <Third highlight.>

## Compatibility

- **Documentation site**: <Sphinx/Furo/MyST compatibility notes, if any.>
- **RTL reference**: <Referenced RTL repo, branch/tag, and commit SHA.>
- **ISA PDF**: <PDF artifact status and source commit, if applicable.>
- **Migration impact**: <None, or describe required user action.>

## Validation status

- `make strict`: <pass/fail/not run; include date or CI run if useful.>
- `make lint`: <pass/fail/not run.>
- `make linkcheck`: <pass/fail/not run; weekly cron is acceptable for
low-risk documentation-only releases.>
- GitHub Pages deploy: <pass/fail/not applicable.>
- GitHub Release artifacts: <published/not published/not applicable.>

## Known limitations

- <Current limitation, caveat, or measurement gap.>
- <Second limitation.>
- <Third limitation.>

## Not included in this release

- <Explicitly deferred work item.>
- <Second deferred item.>

## Next milestones

- `vX.Y+1.0`: <Planned theme or scope.>
- `vX.Y+2.0`: <Planned theme or scope.>

## Release checklist

- [ ] Update `CHANGELOG.md`.
- [ ] Add or refresh `docs/releases/vX.Y.Z.md` from this template.
- [ ] Confirm `CITATION.cff` is still accurate.
- [ ] If `main.tex` changed, run `bash tools/build_isa_pdf.sh` and
commit `_static/downloads/pccx-isa-v002.pdf`.
- [ ] Run `make strict`.
- [ ] Publish the GitHub Release and copy the final release body back
into `docs/releases/vX.Y.Z.md`.
Loading