From e6205b4b9eca8ba0c5e1de1dd7a0436102481c3e Mon Sep 17 00:00:00 2001 From: Robert Waffen Date: Fri, 30 Aug 2024 16:00:41 +0200 Subject: [PATCH 1/4] Update from voxpupuli modulesync_config --- .github/CODEOWNERS | 3 +++ .github/dependabot.yml | 3 +++ .github/labeler.yml | 3 +++ .github/release.yml | 3 +++ .github/workflows/labeler.yml | 3 +++ .github/workflows/release.yml | 3 +++ .gitignore | 3 +++ Gemfile | 3 +++ RELEASE.md | 49 +++++++++++++++++++++++++++++++++++ Rakefile | 5 +++- 10 files changed, 77 insertions(+), 1 deletion(-) create mode 100644 RELEASE.md diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 61d2843e7..53cf21364 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,2 +1,5 @@ +# Managed by modulesync - DO NOT EDIT +# https://voxpupuli.org/docs/updating-files-managed-with-modulesync/ + # No matter which file got changed, request a review from the main developers * @voxpupuli/tools-containerimages diff --git a/.github/dependabot.yml b/.github/dependabot.yml index c6b4cf887..49b971a28 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -1,4 +1,7 @@ --- +# Managed by modulesync - DO NOT EDIT +# https://voxpupuli.org/docs/updating-files-managed-with-modulesync/ + version: 2 updates: # raise PRs for gem updates diff --git a/.github/labeler.yml b/.github/labeler.yml index 870114542..fb8522d82 100644 --- a/.github/labeler.yml +++ b/.github/labeler.yml @@ -1,3 +1,6 @@ --- +# Managed by modulesync - DO NOT EDIT +# https://voxpupuli.org/docs/updating-files-managed-with-modulesync/ + skip-changelog: - head-branch: ['^release-*'] diff --git a/.github/release.yml b/.github/release.yml index cca537e5a..f5b5d7a99 100644 --- a/.github/release.yml +++ b/.github/release.yml @@ -1,4 +1,7 @@ --- +# Managed by modulesync - DO NOT EDIT +# https://voxpupuli.org/docs/updating-files-managed-with-modulesync/ + # https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes changelog: diff --git a/.github/workflows/labeler.yml b/.github/workflows/labeler.yml index 6bbf7dc1d..9ff683957 100644 --- a/.github/workflows/labeler.yml +++ b/.github/workflows/labeler.yml @@ -1,4 +1,7 @@ --- +# Managed by modulesync - DO NOT EDIT +# https://voxpupuli.org/docs/updating-files-managed-with-modulesync/ + name: Labeler 🏷️ on: diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index c51cd2398..48ee7fd2c 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,4 +1,7 @@ --- +# Managed by modulesync - DO NOT EDIT +# https://voxpupuli.org/docs/updating-files-managed-with-modulesync/ + name: Release 🚀 on: diff --git a/.gitignore b/.gitignore index b90dd44c7..8cf65be12 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,6 @@ +# Managed by modulesync - DO NOT EDIT +# https://voxpupuli.org/docs/updating-files-managed-with-modulesync/ + .bundle/ .vendor/ vendor/ diff --git a/Gemfile b/Gemfile index 02277f523..c5b7412dc 100644 --- a/Gemfile +++ b/Gemfile @@ -1,5 +1,8 @@ # frozen_string_literal: true +# Managed by modulesync - DO NOT EDIT +# https://voxpupuli.org/docs/updating-files-managed-with-modulesync/ + source ENV['GEM_SOURCE'] || 'https://rubygems.org' group :release do diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 000000000..8df9cac9e --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,49 @@ +# Release + +## On a fork + +Please follow these instructions carefully. +Ensure that you name the branch precisely as `release-vX.Y.Z` +since this nomenclature is crucial for obtaining the `future_version` in the changelog. +Your attention to this specific branch naming convention is essential for accurate version tracking in the changelog. + +```shell +export RELEASE_VERSION="X.Y.Z" +git switch main +git pull -r +git switch -c release-v$RELEASE_VERSION +bundle config set --local path vendor/bundle +bundle install +CHANGELOG_GITHUB_TOKEN="token_MC_tokenface" bundle exec rake changelog +git commit -am "Release v${RELEASE_VERSION}" +git push origin release-v$RELEASE_VERSION +``` + +Then open a PR, discuss and merge. + +## After the merge, as a maintainer on upstream + +```shell +git switch main +git pull -r +git tag v$RELEASE_VERSION +git push --tags +``` + +## Tags + +Each puppetserver and puppetdb is accompanied by a build_versions.json file +containing information about puppet releases and versions built when a tag is pushed or a change is made to the main branch. + +To enhance clarity and organization, we are transitioning from our previous tagging approach +and will now distinguish the container tag from the puppet version. +The new tags will follow the format vX.Y.Z. The CI build process operates within a matrix, +leveraging the data from the JSON file to construct the specified versions. +As a result, two Docker tags are currently generated: 7.13.0-vX.Y.Z corresponds to +the Puppet Release 7.13.0 build with container version X.Y.Z, while 8.10.0-vX.Y.Z aligns +with Release 8.10.0. These tags offer a more streamlined and informative representation of our build versions. + +The container tags like `7.13.0-main` and `8.10.0-main` are built automatically +whenever changes are merged into the Git main branch. +It's important to note that these tags are designated as development tags +and might be subject to breakage, so exercise caution when using them. diff --git a/Rakefile b/Rakefile index eeab7b57a..8604ce62f 100644 --- a/Rakefile +++ b/Rakefile @@ -1,5 +1,8 @@ # frozen_string_literal: true +# Managed by modulesync - DO NOT EDIT +# https://voxpupuli.org/docs/updating-files-managed-with-modulesync/ + begin require 'rubygems' require 'github_changelog_generator/task' @@ -8,7 +11,7 @@ rescue LoadError else GitHubChangelogGenerator::RakeTask.new :changelog do |config| config.header = "# Changelog\n\nAll notable changes to this project will be documented in this file." - config.exclude_labels = %w[duplicate question invalid wontfix wont-fix skip-changelog] + config.exclude_labels = %w[duplicate question invalid wontfix wont-fix skip-changelog modulesync github_actions] config.user = 'voxpupuli' config.project = 'container-puppetserver' # get branch name from git and strip off any prefixes (e.g. 'release-') From 172d1a91dbd3fd7fe92700a48dab32611d5cccda Mon Sep 17 00:00:00 2001 From: Robert Waffen Date: Fri, 30 Aug 2024 16:06:39 +0200 Subject: [PATCH 2/4] Update from voxpupuli modulesync_config --- Rakefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Rakefile b/Rakefile index 8604ce62f..9a78da1a8 100644 --- a/Rakefile +++ b/Rakefile @@ -11,7 +11,7 @@ rescue LoadError else GitHubChangelogGenerator::RakeTask.new :changelog do |config| config.header = "# Changelog\n\nAll notable changes to this project will be documented in this file." - config.exclude_labels = %w[duplicate question invalid wontfix wont-fix skip-changelog modulesync github_actions] + config.exclude_labels = %w[duplicate question invalid wontfix wont-fix skip-changelog modulesync github_actions] config.user = 'voxpupuli' config.project = 'container-puppetserver' # get branch name from git and strip off any prefixes (e.g. 'release-') From caa27a93d818d0353289ab77989bac19c8b61054 Mon Sep 17 00:00:00 2001 From: Robert Waffen Date: Fri, 30 Aug 2024 16:11:11 +0200 Subject: [PATCH 3/4] Update from voxpupuli modulesync_config --- RELEASE.md | 23 ++++------------------- 1 file changed, 4 insertions(+), 19 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index 8df9cac9e..41bf69904 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -12,8 +12,11 @@ export RELEASE_VERSION="X.Y.Z" git switch main git pull -r git switch -c release-v$RELEASE_VERSION + bundle config set --local path vendor/bundle +bundle config set --local with 'release' bundle install + CHANGELOG_GITHUB_TOKEN="token_MC_tokenface" bundle exec rake changelog git commit -am "Release v${RELEASE_VERSION}" git push origin release-v$RELEASE_VERSION @@ -26,24 +29,6 @@ Then open a PR, discuss and merge. ```shell git switch main git pull -r -git tag v$RELEASE_VERSION +git tag v$RELEASE_VERSION -m "v$RELEASE_VERSION" git push --tags ``` - -## Tags - -Each puppetserver and puppetdb is accompanied by a build_versions.json file -containing information about puppet releases and versions built when a tag is pushed or a change is made to the main branch. - -To enhance clarity and organization, we are transitioning from our previous tagging approach -and will now distinguish the container tag from the puppet version. -The new tags will follow the format vX.Y.Z. The CI build process operates within a matrix, -leveraging the data from the JSON file to construct the specified versions. -As a result, two Docker tags are currently generated: 7.13.0-vX.Y.Z corresponds to -the Puppet Release 7.13.0 build with container version X.Y.Z, while 8.10.0-vX.Y.Z aligns -with Release 8.10.0. These tags offer a more streamlined and informative representation of our build versions. - -The container tags like `7.13.0-main` and `8.10.0-main` are built automatically -whenever changes are merged into the Git main branch. -It's important to note that these tags are designated as development tags -and might be subject to breakage, so exercise caution when using them. From 4d9c45649fdc4cb6904be567d016a3e16fce8f37 Mon Sep 17 00:00:00 2001 From: Robert Waffen Date: Wed, 6 Nov 2024 18:11:11 +0100 Subject: [PATCH 4/4] Update from voxpupuli modulesync_config --- RELEASE.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index 41bf69904..2f3564fbc 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -10,7 +10,7 @@ Your attention to this specific branch naming convention is essential for accura ```shell export RELEASE_VERSION="X.Y.Z" git switch main -git pull -r +git pull --rebase git switch -c release-v$RELEASE_VERSION bundle config set --local path vendor/bundle @@ -18,8 +18,8 @@ bundle config set --local with 'release' bundle install CHANGELOG_GITHUB_TOKEN="token_MC_tokenface" bundle exec rake changelog -git commit -am "Release v${RELEASE_VERSION}" -git push origin release-v$RELEASE_VERSION +git commit --all --message "Release v${RELEASE_VERSION}" +git push --set-upstream origin HEAD ``` Then open a PR, discuss and merge. @@ -28,7 +28,7 @@ Then open a PR, discuss and merge. ```shell git switch main -git pull -r +git pull --rebase git tag v$RELEASE_VERSION -m "v$RELEASE_VERSION" git push --tags ```