From 3130b2290397a1b1fc806a1561975d68c3c39703 Mon Sep 17 00:00:00 2001 From: Robert Waffen Date: Tue, 18 Jun 2024 11:17:08 +0200 Subject: [PATCH 1/3] update release notes Signed-off-by: Robert Waffen --- RELEASE.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index dd76d89..31b3a65 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -1,6 +1,8 @@ # How to make a release -Initiate a Release Pull Request (PR). Ensure that the release branch includes the version in its name, as this will be utilized as the 'future_version' for the GitHub changelog generator. +## On a fork + +Initiate a Release Pull Request (PR). Ensure that the release branch includes the version in its name, as this will be utilized as the `future_version` for the GitHub changelog generator. See Rakefile @@ -8,12 +10,13 @@ See Rakefile config.future_release = `git rev-parse --abbrev-ref HEAD`.strip.split('-', 2).last ``` -Create a Release PR: +Do the following: ```shell +export RELEASE_VERSION="X.Y.Z" git switch main git pull -r -git switch -c release-vX.Y.Z +git switch -c release-v$RELEASE_VERSION bundle config set --local path vendor/bundle bundle config set --local with 'release' @@ -21,15 +24,15 @@ bundle install CHANGELOG_GITHUB_TOKEN="token_MC_tokenface" bundle exec rake changelog -git commit -am 'Release vX.Y.Z' -git push origin release-vX.Y.Z +git commit -am "Release v${RELEASE_VERSION}" +git push origin release-v$RELEASE_VERSION ``` -After the merge do: +## After the merge, as a maintainer on upstream ```shell git switch main git pull -r -git tag vX.Y.Z +git tag v$RELEASE_VERSION -m "v$RELEASE_VERSION" git push --tags ``` From 6427715a4d6450373bc12d65b06d2ee03231c73d Mon Sep 17 00:00:00 2001 From: Robert Waffen Date: Tue, 18 Jun 2024 11:23:23 +0200 Subject: [PATCH 2/3] update readme on how we update our version Signed-off-by: Robert Waffen --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 6d4fcf3..a25893b 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,10 @@ main- `latest` should be self-explanatory. The `main` tags are built with every push to the main branch and can be regarded as development tags. +### Version updates + +PDC will update its minor version as long as the tools it encapsulates also only update their minor versions. If a major version of a tool is released, PDC will update its major version, too. Also if the base container is updated to a new major version, PDC will update its major version. Or if there are incompatible changes in the container build setup. + ## Changelog see [CHANGELOG.md](CHANGELOG.md) From ddfefcfa7b01b5c1debd4e551abf01a88eff1e23 Mon Sep 17 00:00:00 2001 From: Robert Waffen Date: Tue, 18 Jun 2024 11:31:16 +0200 Subject: [PATCH 3/3] improve wording Signed-off-by: Robert Waffen --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a25893b..eb8fcd1 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,7 @@ main- ### Version updates -PDC will update its minor version as long as the tools it encapsulates also only update their minor versions. If a major version of a tool is released, PDC will update its major version, too. Also if the base container is updated to a new major version, PDC will update its major version. Or if there are incompatible changes in the container build setup. +PDC will update its minor version to align with minor version updates of the tools it encapsulates. A major version update of any tool, the base container, or incompatible changes in the container build setup will trigger a major version update of PDC. ## Changelog