Skip to content

refactor: take release notes as a separate file - #33

Merged
MattSturgeon merged 2 commits into
mainfrom
separate-release-notes
Aug 29, 2026
Merged

refactor: take release notes as a separate file#33
MattSturgeon merged 2 commits into
mainfrom
separate-release-notes

Conversation

@MattSturgeon

Copy link
Copy Markdown
Member

This drops the changelog field from ReleaseMetadata and adds a new --release-notes option to PublishCliCommand.

Users should drop their usage of changelog in their JSON metadata and supply a separate release-notes.md file.

This should simplify Freecam's release pipeline by removing the need for the :generateReleaseMetadata Gradle task to have access to the changelog; instead we could now delegate to a tool like Knope.

This drops the `changelog` field from ReleaseMetadata and adds a new
`--release-notes` option to PublishCliCommand.

Users should drop their usage of `changelog` in their JSON metadata and
supply a separate `release-notes.md` file.
Breaking changes:
- schema: `changelog` field dropped from `ReleaseMetadata`
- cli: `--release-notes` option was added
@MattSturgeon
MattSturgeon enabled auto-merge August 29, 2026 18:21
@MattSturgeon
MattSturgeon merged commit ba0fe63 into main Aug 29, 2026
4 of 8 checks passed
@MattSturgeon
MattSturgeon deleted the separate-release-notes branch August 29, 2026 18:22
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