Added CHANGELOG Entries for the 0.4.0 Release#787
Conversation
| ## [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]). |
There was a problem hiding this comment.
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.
| [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 |
There was a problem hiding this comment.
This tag doesn't exist yet, but will tomorrow morning.
There was a problem hiding this comment.
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
TBDplaceholder with a2026-6-2release 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.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
|
I think we should delete this file and put all this information under "What's Changed" in the GitHub release notes. See for example: |
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
I'm not saying every single crate does this, but most of them do. |
|
What do other multi crate rust repos do wrt tagging and changelogs? |
|
We should do something similar to Tokio, but without these CHANGELOG files:
|
There was a problem hiding this comment.
I wonder if we should drop our changelog and just do these in GitHub releases.
So, most of the multi-crate repos I've looked at do a single release, for the entire repo (not per crate). The exceptions to this are There's also |
externl
left a comment
There was a problem hiding this comment.
We should markdown lint this file.
bernardnormier
left a comment
There was a problem hiding this comment.
We should remove this file. No CHANGELOG.
This PR adds CHANGELOG entries covering everything we did between
0.3.3and0.4.0.And adds a link/date for the
0.4.0release tomorrow.