news-release-docs
Skill5 starsChanged 21 days agoMITView on GitHub
Create or refresh `docs/RELEASE_HISTORY.md` and `docs/NEWS.md` from the changelog, plus release-note input for `devel/make_release.py`. Use when preparing a release or synchronizing release docs. Does not edit the changelog or README.
In this repository47 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- agents-md-fixerSkill
- arch-docsSkill
- book-to-markdownSkill
- docset-updaterSkill
- humanizerSkill
- pdf-guideSkill
- readme-docsSkill
- screenshot-docsSkill
- see-also-docsSkill
- setup-install-usage-docsSkill
- bptools-writer-expertSkill
- color-accessibility-expertSkill
- css-creative-expertSkill
- game-design-expertSkill
- geometry-expertSkill
- glass-expertSkill
- hic-human-interact-expertSkill
- openscad-3d-printing-expertSkill
- podman-expertSkill
- postgresql-expertSkill
- pyside6-engineerSkill
- rust-code-expertSkill
- solid-js-expertSkill
- svg-creator-expertSkill
- typescript-engineerSkill
- ui-ux-engineerSkill
- vision-expertSkill
- wasm-rust-expertSkill
- webwork-writer-expertSkill
- delegate-manager-to-subagentsSkill
- gas-town-workflowSkill
- hang-checkSkill
- html-game-parallel-builderSkill
- parallel-planSkill
- stay-busySkill
- repo-rules-readerSkill
- blueprint-plan-drafterSkill
- ideonomy-plainSkill
- ideonomy-richSkill
- make-goalSkill
- modest-plan-drafterSkill
- audit-code-reviewerSkill
- old-python-code-reviewSkill
- prune-testsSkill
- unit-test-starterSkill
The file
We split this skill into the rules it gives an agent
11 rules. About 0 are common, 2 are distinctive, and 9 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈2
Distinctive · estimate
This author's own choices. Worth a look.
9
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 10
Read the verbose docs/CHANGELOG.md (and rotated archives) and author two differentiated release docs from it:
- Very specific: line 28
If docs/CHANGELOG.md carries explicit version headings, derive the version from the changelog.
- Very specific: line 30
When the changelog carries only date blocks (the repo's day-block format), read the repo-root VERSION file as the version source.
- Very specific: line 37
Use the heading shape ## v<version> - YYYY-MM-DD for every release block.
- Very specific: line 45
Read the active docs/CHANGELOG.md.
- Very specific: line 46
Read rotated archives docs/CHANGELOG-YYYY-MM*.md as needed to cover the release range.
- Distinctive: line 53
Follow the "Version source" steps above.
- Very specific: line 55
Write the docs/RELEASE_HISTORY.md block from references/release_history_template.md: Highlights, Notable fixes, Compatibility notes, …
- Very specific: line 71
Write a notes-file body to a scratch path under /tmp (for example /tmp/news_release_notes.md) for use as devel/make_release.py …
- Very specific: line 76
Follow docs/MARKDOWN_STYLE.md: ASCII only (escape UTF-8 symbols), sentence-case ATX headings, - bullets, relative links with path link text.
- Distinctive: line 82
Write a release doc only when the changelog has release-worthy content for the target version that fills at least one substantive …
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
News and release docs
Overview
Read the verbose docs/CHANGELOG.md (and rotated archives) and author two
differentiated release docs from it:
docs/RELEASE_HISTORY.md: the full, organized, reverse-chronological version log with notable fixes and compatibility detail.docs/NEWS.md: short curated highlights and announcements, not a full changelog.
Both are written in place. The skill also emits a notes-file body to a scratch
path under /tmp for use with devel/make_release.py --notes-file, and reports
that path. The two docs must stay distinct (full log vs curated highlights);
never produce identical content. Base every entry on changelog evidence and
never invent shipped work.
Version source
Determine the target version deterministically:
- If
docs/CHANGELOG.mdcarries explicit version headings, derive the version from the changelog. - When the changelog carries only date blocks (the repo's day-block format),
read the repo-root
VERSIONfile as the version source. - Cross-check
VERSIONagainstpyproject.toml[project] version. If they disagree, report the mismatch and stop; do not guess. See the versioning rules indocs/REPO_STYLE.md(CalVer0Y.0M.PATCH,VERSIONpluspyproject.tomlas the version source).
Use the heading shape ## v<version> - YYYY-MM-DD for every release block. This
matches devel/make_release.py _prepend_release_doc, which inserts a block of
exactly that shape above the first existing ## heading, so the skill output
and the release tool stay compatible.
Workflow
- Gather changelog evidence
- Read the active
docs/CHANGELOG.md. - Read rotated archives
docs/CHANGELOG-YYYY-MM*.mdas needed to cover the release range. See the changelog-rotation rules indocs/REPO_STYLE.md(two newest day blocks stay active; older blocks live in archives). - Collect the day-block subsections (Additions and New Features, Behavior or Interface Changes, Fixes and Maintenance, Removals and Deprecations, Decisions and Failures, Developer Tests and Notes) for the target version.
- Read the active
- Resolve the target version
- Follow the "Version source" steps above.
- Author two differentiated bodies
- Write the
docs/RELEASE_HISTORY.mdblock from references/release_history_template.md: Highlights, Notable fixes, Compatibility notes, Validation. Fuller detail, including secondary items. - Write the
docs/NEWS.mdblock from references/news_template.md: curated Highlights and, only when a real upgrade step exists, Upgrade notes. Terse, headline items only. - Omit any subsection that has no real content. Keep the two bodies clearly different in scope and length.
- Write the
- Prepend in place
- Prepend the
## v<version> - YYYY-MM-DDblock immediately above the first existing##heading in each doc, preserving all older content byte-for-byte. If a## v<version>heading already exists in a doc, report it and stop rather than duplicating.
- Prepend the
- Emit the notes-file body
- Write a notes-file body to a scratch path under
/tmp(for example/tmp/news_release_notes.md) for use asdevel/make_release.py --notes-file, and report that path. The notes-file stays out of the repo; never write a repo-tracked scratch file.
- Write a notes-file body to a scratch path under
- Apply style
- Follow
docs/MARKDOWN_STYLE.md: ASCII only (escape UTF-8 symbols), sentence-case ATX headings,-bullets, relative links with path link text.
- Follow
Content or no file
Write a release doc only when the changelog has release-worthy content for the target version that fills at least one substantive subsection beyond the title and version heading. When the changelog has no release-worthy content for the target version, report the gap in the run report and write no file. Never write a hollow or stub doc.
Output
- Updated
docs/RELEASE_HISTORY.mdanddocs/NEWS.md(each gaining one## v<version> - YYYY-MM-DDblock), when evidence supports them. - A
/tmpnotes-file body path fordevel/make_release.py --notes-file. - A short report: version resolved and its source, docs written or skipped, and any gaps (missing changelog content, version mismatch).
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

