Introduce CHANGELOG.md, include in release information
#7243
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The information about a specific Nessie release is pretty rudimentary, consists only of a list of commits. Interesting, important and relevant information, for example about upgrade notes, release highlights, potentially breaking changes, is missing in the release notes. This change introduces the `CHANGELOG.md` file. Relevant information is to be added to an appropriate section for `Unreleased`. The list of sections is not fixed and can be changed and extended, depending on the impact of an individual change/PR. The Nessie release workflows leverage Jetbrains' [_Gradle Changelog Plugin_](https://github.com/JetBrains/gradle-changelog-plugin) to promote `Unreleased` to a release in `CHANGELOG.md` and to extract the changelog for the current release, which is then added to `site/docs/try/releases.md` and the Github release notes. The changelog-plugin is "clever enough" to purge empty sections for a release. This is the command to extract information about the latest release ```bash ./gradlew --quiet --console=plain getChangelog --no-header --no-links ``` Using `./gradlew getChangelog --unreleased` shows information about the not-yet-released code.
dimas-b
approved these changes
Jul 18, 2023
| - Tests: Make `ITCassandraBackendFactory` less flaky (#7186) | ||
| - IntelliJ: Exclude some more directories from indexing (#7181) | ||
|
|
||
| [Unreleased]: https://github.com/projectnessie/nessie/commits |
There was a problem hiding this comment.
What's the purpose of this line? Should it perhaps be in the Unreleased > Commits section above?
There was a problem hiding this comment.
Required (and maintained) by the changelog-pluigin.
BTW: That's a link-definition
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The information about a specific Nessie release is pretty rudimentary, consists only of a list of commits. Interesting, important and relevant information, for example about upgrade notes, release highlights, potentially breaking changes, is missing in the release notes.
This change introduces the
CHANGELOG.mdfile. Relevant information is to be added to an appropriate section forUnreleased. The list of sections is not fixed and can be changed and extended, depending on the impact of an individual change/PR.The Nessie release workflows leverage Jetbrains' Gradle Changelog Plugin to promote
Unreleasedto a release inCHANGELOG.mdand to extract the changelog for the current release, which is then added tosite/docs/try/releases.mdand the Github release notes. The changelog-plugin is "clever enough" to purge empty sections for a release.This is the command to extract information about the latest release
Using
./gradlew getChangelog --unreleasedshows information about the not-yet-released code.