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.

Sign up for GitHub

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

Jump to bottom

Update to module template files #2

Merged
merged 1 commit into from
Aug 30, 2024
Merged

Update to module template files #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion Rakefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
config.exclude_labels = %w[duplicate question invalid wontfix wont-fix skip-changelog modulesync github_actions]
config.user = 'voxpupuli'
config.project = 'container-test'
# get branch name from git and strip off any prefixes (e.g. 'release-')
Expand Down