Skip to content

Added CHANGELOG Entries for the 0.4.0 Release#787

Open
InsertCreativityHere wants to merge 3 commits into
icerpc:mainfrom
InsertCreativityHere:add-0.4-changelog-entries
Open

Added CHANGELOG Entries for the 0.4.0 Release#787
InsertCreativityHere wants to merge 3 commits into
icerpc:mainfrom
InsertCreativityHere:add-0.4-changelog-entries

Conversation

@InsertCreativityHere

@InsertCreativityHere InsertCreativityHere commented Jun 1, 2026

Copy link
Copy Markdown
Member

This PR adds CHANGELOG entries covering everything we did between 0.3.3 and 0.4.0.
And adds a link/date for the 0.4.0 release tomorrow.

Comment thread slicec/CHANGELOG.md
## [0.4.0] - TBD
## [0.4.0] - 2026-6-2

This is a major release which changes the model of `slicec` from being a pure library, to a binary executable ([705]).

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Technically, slicec is both a binary and a library now (which I mention in the README).
But the fact a slicec library exists isn't interesting to users.
This is just a quirk of how projects are structured in Rust, and I don't want to emphasize it much.

The library is logically just an 'implementation detail' of the binary.

Comment thread slicec/CHANGELOG.md
[662]: https://github.com/icerpc/slicec/pull/662
[659]: https://github.com/icerpc/slicec/pull/659

[0.4.0]: https://github.com/icerpc/slicec/releases/tag/v0.4.0

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

This tag doesn't exist yet, but will tomorrow morning.

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.

Pull request overview

Adds CHANGELOG entries describing changes between 0.3.3 and the upcoming 0.4.0 release, including the new release date, summary text, sectioned bullet list of changes, and the corresponding PR/version reference links.

Changes:

  • Replaces the TBD placeholder with a 2026-6-2 release date and adds an introductory paragraph describing the library-to-binary transition.
  • Adds Enhancements / Breaking / Changed bullet sections summarizing the work between 0.3.3 and 0.4.0.
  • Adds PR reference link definitions (705–778) and the [0.4.0] release tag link.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread slicec/CHANGELOG.md Outdated
Comment thread slicec/CHANGELOG.md
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@bernardnormier

Copy link
Copy Markdown
Member

I think we should delete this file and put all this information under "What's Changed" in the GitHub release notes. See for example:
https://github.com/icerpc/icerpc-csharp/releases

@InsertCreativityHere

Copy link
Copy Markdown
Member Author

I think we should delete this file and put all this information under "What's Changed" in the GitHub release notes

Yeah, we do the same for this repo too: https://github.com/icerpc/slicec/releases

So, why do I also have all this information duplicated in a CHANGELOG file? :)

I'm not saying every single crate does this, but most of them do.

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.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@externl

externl commented Jun 2, 2026

Copy link
Copy Markdown
Member

What do other multi crate rust repos do wrt tagging and changelogs?

@bernardnormier

Copy link
Copy Markdown
Member

We should do something similar to Tokio, but without these CHANGELOG files:

  • release/tag = slicec-version, slice-rust-version (similar to tokio-1.47.5)
  • release title = Slicec vX.Y.Z, Slice Rust vX.Y.Z
    with change description ("What's Changed") in these GitHub release notes. No CHANGELOG.

Comment thread slicec/CHANGELOG.md

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I wonder if we should drop our changelog and just do these in GitHub releases.

@InsertCreativityHere

InsertCreativityHere commented Jun 2, 2026

Copy link
Copy Markdown
Member Author

What do other multi crate rust repos do wrt tagging and changelogs?

So, most of the multi-crate repos I've looked at do a single release, for the entire repo (not per crate).
Their releases and tags are the standard format.

The exceptions to this are tokio and tonic which do a single release per crate.
Their releases are just like Bernard described.
And their tags look like: tonic-types-v0.14.6, tonic-v0.14.6, tonic-prost-v0.14.6

There's also rust-crypto which also has separate tags for each of their crates.
But they don't use GitHub releases at all, so not as interesting on that front.

@externl externl left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

We should markdown lint this file.

@bernardnormier bernardnormier left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

We should remove this file. No CHANGELOG.

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.

4 participants