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

Update readme/release notes #56

Merged
merged 3 commits into from
Jun 18, 2024
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,10 @@ main-<puppet.major>

`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 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

see [CHANGELOG.md](CHANGELOG.md)
Expand Down
17 changes: 10 additions & 7 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,38 @@
# 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

```ruby
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'
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
```