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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 10 additions & 0 deletions .github/workflows/release-create.yml
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,12 @@ jobs:
bump-helm-version: 'true'
bump-site-version: 'true'

- name: Patch changelog
uses: gradle/gradle-build-action@v2
with:
cache-disabled: true
arguments: :patchChangelog

# Updates the site/docs/try/releases.md file, takes the first four lines (the big heading),
# adds a heading with the version and a note referencing the release notes on GitHub,
# followed by the Git change log, finalized with the remainder of the
Expand All @@ -142,6 +148,10 @@ jobs:
See [Release information on GitHub](https://github.com/projectnessie/nessie/releases/tag/nessie-${RELEASE_VERSION}).

!

# Add section from CHANGELOG.md for the version to release
./gradlew --quiet --console=plain getChangelog --no-header --no-links >> /tmp/releases.md
echo "### Commits" >> /tmp/releases.md

git log --perl-regexp --author '^(?!.*renovate|.*nessie-release-workflow).*$'\
--format='format:* %s' ${LAST_TAG}..HEAD . |\
Expand Down
4 changes: 4 additions & 0 deletions .github/workflows/release-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,10 @@ jobs:
The attached [\`nessie-helm-${RELEASE_VERSION}.tgz\`](${Q_HELM_CHART_URL}) is a packaged Helm chart, which can be downloaded and installed via Helm.
There is also the [Nessie Helm chart repo](https://charts.projectnessie.org/), which can be added and used to install the Nessie Helm chart.

## Changelog

$(./gradlew --quiet --console=plain getChangelog --no-header --no-links)

## Full Changelog (minus renovate commits):

$(cat ${DIR}/release-log)
Expand Down
47 changes: 47 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Nessie Changelog
The Nessie changelog is used to give users and contributors more information than just the list of commits.
Entries are grouped in sections like _Highlights_ or _Upgrade notes_, the provided sections can be adjusted
as necessary. Empty sections will not end in the release notes.

## [Unreleased]

### Highlights

### Upgrade notes

### New Features

### Changes

### Deprecations

### Fixes

### Commits

## [0.65.0] Release (2023-06-14)
- Revert Gradle 8.2.1 (#7239)
- Add Nessie as a Source announcement blog from Dremio website (#7236)
- Add `--author` option to `content-generator` commands (#7232)
- Add repository configuration objects (#7233)
- Fix retrieval of default branch (#7227)
- Allow re-adds in same commit (#7225)
- Allow snapshot versions in dependencies (#7224)
- IDE: Cleanup Idea excludes (#7223)
- Spark-tests: disable UI (#7222)
- Compatibility tests: move to new storage model (#6910)
- Use testcontainers-bom (#7216)
- Reference keycloak-admin-client-jakarta (#7215)
- Post Quarkus 3: Remove no longer needed dependency exclusion (#7214)
- Bump to Quarkus 3.2.0.Final (#6146)
- CI: Add some missing `--scan` Gradle flags (#7210)
- Update main README after UI sources moved (#7207)
- Forbid relative hashes in commits, merges and transplants (#7193)
- Remove misplaced license header (#7203)
- More diff-tests (#7192)
- removed extra tab (#7189)
- Tests: Make `ITCassandraBackendFactory` less flaky (#7186)
- IntelliJ: Exclude some more directories from indexing (#7181)

[Unreleased]: https://github.com/projectnessie/nessie/commits
Copy link
Member

Choose a reason for hiding this comment

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

What's the purpose of this line? Should it perhaps be in the Unreleased > Commits section above?

Copy link
Member Author

Choose a reason for hiding this comment

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

Required (and maintained) by the changelog-pluigin.
BTW: That's a link-definition

[0.65.0]: https://github.com/projectnessie/nessie/compare/nessie-0.64.0...nessie-0.65.0
23 changes: 23 additions & 0 deletions build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,13 @@
* limitations under the License.
*/

import org.jetbrains.changelog.date

plugins {
eclipse
id("nessie-conventions-root")
alias(libs.plugins.nexus.publish.plugin)
alias(libs.plugins.jetbrains.changelog)
}

apply<ReleaseSupportPlugin>()
Expand Down Expand Up @@ -109,3 +112,23 @@ spotless {
target("nessie-iceberg/*.gradle.kts", "*.gradle.kts", "build-logic/*.gradle.kts")
}
}

changelog {
repositoryUrl.set("https://github.com/projectnessie/nessie")
title.set("Nessie Changelog")
versionPrefix.set("nessie-")
header.set(provider { "${version.get()} Release (${date()})" })
groups.set(
listOf(
"Highlights",
"Upgrade notes",
"Breaking changes",
"New Features",
"Changes",
"Deprecations",
"Fixes",
"Commits"
)
)
version.set(provider { project.version.toString() })
}
1 change: 1 addition & 0 deletions gradle/libs.versions.toml
Original file line number Diff line number Diff line change
Expand Up @@ -178,3 +178,4 @@ nexus-publish-plugin = { id = "io.github.gradle-nexus.publish-plugin", version =
protobuf = { id = "com.google.protobuf", version = "0.9.4" }
quarkus = { id = "io.quarkus", version.ref = "quarkus" }
smallrye-openapi = { id = "io.smallrye.openapi", version = "3.4.0" }
jetbrains-changelog = { id = "org.jetbrains.changelog", version = "2.1.2"}