Skip to content

docs: tighten changelog and release-note guidance - #319

Merged
pinodeca merged 2 commits into
mainfrom
docs/shorten-v0.2.5-release-notes
Jul 30, 2026
Merged

docs: tighten changelog and release-note guidance#319
pinodeca merged 2 commits into
mainfrom
docs/shorten-v0.2.5-release-notes

Conversation

@pinodeca

@pinodeca pinodeca commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

Summary

  • shorten the shipped v0.2.5 changelog to user-facing behavior
  • remove an expected multipart substitution detail and a bug introduced and fixed within the same cycle
  • require an editorial quality pass for changelog entries before release
  • make GitHub Release notes a separate, briefer and punchier summary rather than a changelog copy
  • retain concise migration, security, and operational warnings plus contributor credits

The published v0.2.5, v0.2.4, and v0.2.3 GitHub Release pages have been updated separately using this approach. The v0.2.4 and v0.2.3 changelog sections are unchanged.

Validation

  • git diff --check -- CHANGELOG.md prompts/pg_durable-release.md
  • live Release pages verified as published with acknowledgements, New Contributors, Full Changelog links, and upgrade guidance
  • editorial release bodies: v0.2.5 ~148 words; v0.2.4 ~202 words; v0.2.3 ~148 words

@pinodeca pinodeca changed the title docs: shorten v0.2.5 release notes docs: tighten changelog and release-note guidance Jul 30, 2026
@pinodeca
pinodeca merged commit 708b209 into main Jul 30, 2026
5 checks passed
@pinodeca
pinodeca deleted the docs/shorten-v0.2.5-release-notes branch July 30, 2026 20:36
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