Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce CHANGELOG.md, include in release information #7243

Merged
merged 1 commit into from
Jul 18, 2023

Commits on Jul 17, 2023

  1. Introduce CHANGELOG.md, include in release information

    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.
    snazy committed Jul 17, 2023
    Configuration menu
    Copy the full SHA
    360aaa1 View commit details
    Browse the repository at this point in the history