Skip to content

docs: CHANGELOG back-fill, versioning policy, release notes from the CHANGELOG (#91) - #133

Merged
michaelstonis merged 1 commit into
mainfrom
docs/91-changelog-versioning
Oct 24, 2026
Merged

michaelstonis merged 1 commit into
mainfrom
docs/91-changelog-versioning

Conversation

@michaelstonis

Copy link
Copy Markdown
Contributor

Summary

Closes #91. The CHANGELOG becomes the source of release notes, and the versioning rules are written down.

Changes

  • CHANGELOG.md:
    • Dated sections for every published release, 0.1.3 to 0.1.10, with compare links.
    • Unreleased reorganised: KumikoUI.Uno recorded as Added, breaking changes listed first.
    • Note that 0.1.1, 0.1.2 and 0.1.5 were tagged but never published.
  • docs/VERSIONING.md:
    • One version for all four packages.
    • SemVer before and after 1.0, including which changes bump what.
    • What counts as public API.
    • Deprecation policy ([Obsolete] for at least one minor before removal in a major).
    • Support window tied to the .NET LTS.
  • Publish:
    • A stable tag fails unless CHANGELOG.md has a ## [X.Y.Z] - date section; prereleases fall back to Unreleased.
    • The section becomes the GitHub release body, replacing auto-generated PR titles. Releases are now also created for manual runs against a tag.
  • Packages: release notes link to the CHANGELOG.
  • CONTRIBUTING: the release steps start with cutting the CHANGELOG section.

Verification

  • eng/changelog-section.sh prints 0.1.10, 0.1.3 and Unreleased correctly, without the link definitions, and exits 1 for a missing version.
  • Simulated publish step:
    • v0.1.10 uses its section.
    • v0.2.0 fails with "CHANGELOG.md needs a '## [0.2.0] - ' section".
    • v0.2.0-preview.1 uses Unreleased.
  • Packed nuspec contains the release-notes link.
  • The real publish path runs only on a tag (not exercised here). Copilot review is blocked by the quota.

🤖 Generated with Claude Code

…CHANGELOG

- CHANGELOG.md: dated sections for every published release (0.1.3–0.1.10)
  with compare links; Unreleased reorganised (KumikoUI.Uno recorded as Added,
  breaking changes first); note that 0.1.1/0.1.2/0.1.5 were never published.
- docs/VERSIONING.md: lockstep versions, SemVer before/after 1.0, what counts
  as public API, deprecation, and the support window per .NET LTS.
- eng/changelog-section.sh: prints one CHANGELOG section (fails if missing).
- publish.yml: a stable tag fails unless CHANGELOG.md has its dated section;
  prereleases fall back to Unreleased. The section is the GitHub release body
  (replacing auto-generated PR titles) and is created for manual runs too.
- Every package's release notes link to the CHANGELOG.
- CONTRIBUTING: release steps now start with cutting the CHANGELOG section.

Closes #91

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Copilot AI balanced review requested due to automatic review settings October 24, 2026 01:00

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota.

An organization owner can choose the repository organization as the billing source for reviews requested by members with a paid Copilot license. Learn about Copilot code review billing. Review the Copilot code review billing settings.

@michaelstonis
michaelstonis merged commit 15891ce into main Oct 24, 2026
5 checks passed
@michaelstonis
michaelstonis deleted the docs/91-changelog-versioning branch October 24, 2026 02:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

CHANGELOG (Keep a Changelog) and versioning/support policy

2 participants