Skip to content

docs: mark all changelogs unreleased, add changelog-format CI check - #3

Merged
kewde merged 2 commits into
masterfrom
docs/changelog-unreleased-fixes
Aug 20, 2026
Merged

docs: mark all changelogs unreleased, add changelog-format CI check#3
kewde merged 2 commits into
masterfrom
docs/changelog-unreleased-fixes

Conversation

@kewde

@kewde kewde commented Aug 20, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • None of these packages have ever actually had a GitHub Release/tag cut, so the existing [0.1.0] - 2025-05-24 entries in each packages/*/CHANGELOG.md were fictional (and their compare/release-tag links 404). Fold that content into [Unreleased] instead.
  • Add apps/knx-gui/CHANGELOG.md, which didn't exist yet, in the same [Unreleased] state.
  • Add a changelog CI job (.github/scripts/check_changelog_format.py) that validates every packages/*/CHANGELOG.md and apps/*/CHANGELOG.md: starts with # Changelog, first section is [Unreleased], and any released version header is [x.y.z] - YYYY-MM-DD.

Test plan

  • python3 .github/scripts/check_changelog_format.py passes locally against all 6 changelogs
  • Verified the checker actually catches malformed headers (missing date, missing Unreleased section) against a throwaway fixture
  • Confirm the new changelog CI job runs green

kewde added 2 commits August 20, 2026 17:53
None of these packages have ever actually shipped a GitHub Release or
tag, so the existing '[0.1.0] - 2025-05-24' entries (and their dead
release-tag links) were fictional; fold that content into
[Unreleased] instead. Add apps/knx-gui/CHANGELOG.md, which didn't
exist yet. Add a CI job that validates every packages/*/CHANGELOG.md
and apps/*/CHANGELOG.md starts with an [Unreleased] section and that
any released version header has a valid semver + date.
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