Skip to content

Commit ccc977d

Browse files
authored
Sync man page metadata and release tagging guidance for v0.0.4 (#89)
## Summary - sync `man/smdu.1` header metadata to match `0.0.4` release prep - update `AGENTS.md` release workflow to require man-page sync on every release - add explicit guidance that release tags should be annotated and include a summary from `docs/releases/v<version>.md` ## Validation - `pnpm test` - `pnpm build` - `pnpm format:check`
2 parents 871286d + 32a7daf commit ccc977d

2 files changed

Lines changed: 4 additions & 3 deletions

File tree

AGENTS.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@
8282
- Create a dedicated release prep branch using `chore/release-v<version>` naming (for example, `chore/release-v0.0.4`).
8383
- Keep release metadata aligned:
8484
- update `package.json` `version`
85-
- ensure `man/smdu.1` version/date stays in sync with the release when applicable
85+
- ensure `man/smdu.1` version/date stays in sync with every release
8686
- add/update `docs/releases/v<version>.md`
8787
- keep `docs/readme.md` release links current
8888
- Use release-note structure consistent with existing files in `docs/releases/`:
@@ -94,7 +94,8 @@
9494
- Open a PR with:
9595
- a human-readable title (no Conventional Commit prefix)
9696
- release-note category label(s) (`docs`, `chore`, `fix`, `feat`, etc.) plus `release` scope label when relevant
97-
- After merge, publish via Git tag that matches the release workflow trigger (`v*`) in `.github/workflows/release.yml`.
97+
- After merge, publish via an **annotated** Git tag that matches the release workflow trigger (`v*`) in `.github/workflows/release.yml`.
98+
- When creating the release tag message, include a concise summary derived from `docs/releases/v<version>.md` so the tag history preserves release context.
9899
- Do not push release branches or tags unless explicitly requested by the user.
99100

100101
## Testing

man/smdu.1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH SMDU 1 "February 2026" "0.0.1" "User Commands"
1+
.TH SMDU 1 "March 2026" "0.0.4" "User Commands"
22
.SH NAME
33
smdu \- See My Disk Usage - A clone of ncdu
44
.SH SYNOPSIS

0 commit comments

Comments
 (0)