From 7014c6f70682381d8a3e130c1074fd0cf60a795f Mon Sep 17 00:00:00 2001 From: Robert Waffen Date: Fri, 30 Aug 2024 16:00:47 +0200 Subject: [PATCH 1/3] 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 | 41 ++++++++++++++++++++++------------- Rakefile | 3 +++ 10 files changed, 53 insertions(+), 15 deletions(-) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 61d2843..53cf213 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 c6b4cf8..49b971a 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 8701145..fb8522d 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 cca537e..f5b5d7a 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 6bbf7dc..9ff6839 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 c51cd23..48ee7fd 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 b90dd44..8cf65be 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 02277f5..c5b7412 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 index 31b3a65..8df9cac 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -1,38 +1,49 @@ -# How to make a release +# Release ## 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 - -```ruby - config.future_release = `git rev-parse --abbrev-ref HEAD`.strip.split('-', 2).last -``` - -Do the following: +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 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 ``` +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 -m "v$RELEASE_VERSION" +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 4387c73..fd86637 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' From 602ebd0bf84302ba209c70fe1f4df3d524cc711a Mon Sep 17 00:00:00 2001 From: Robert Waffen Date: Fri, 30 Aug 2024 16:06:45 +0200 Subject: [PATCH 2/3] Update from voxpupuli modulesync_config --- Rakefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Rakefile b/Rakefile index fd86637..11ecace 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 github_actions modulesync] + config.exclude_labels = %w[duplicate question invalid wontfix wont-fix skip-changelog modulesync github_actions] config.user = 'voxpupuli' config.project = 'container-voxbox' # get branch name from git and strip off any prefixes (e.g. 'release-') From 64fdbd4a2f516ad0c50964db08cd6975e67a50d8 Mon Sep 17 00:00:00 2001 From: Robert Waffen Date: Fri, 30 Aug 2024 16:11:17 +0200 Subject: [PATCH 3/3] Update from voxpupuli modulesync_config --- RELEASE.md | 23 ++++------------------- 1 file changed, 4 insertions(+), 19 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index 8df9cac..41bf699 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.