diff --git a/.gitignore b/.gitignore index 4541a7b..9f6db9a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ .bundle/ vendor/ +Gemfile.lock diff --git a/README.md b/README.md index c617a70..4435e6c 100644 --- a/README.md +++ b/README.md @@ -17,3 +17,34 @@ Rather than using bash directly, you have the option to mount the repository and Included fixed software versions, see: [build_versions.json](build_versions.json) For any given container tag you can lookup the specific versions here: `https://github.com/betadots/pdc/blob/$TAG/build_versions.json` + +## Version schema + +The version schema has the following layout: + +```text +v..- +``` + +Example usage: + +```shell +docker run -ti --rm ghcr.io:betadots/pdc:v1.0.1-8 bash +``` + +| Name | Description | +| --- | --- | +| container.major | Describes the major version of the base container (Ubunutu 22.04) or incompatible changes | +| container.minor | Describes new features or refactoring with backward compatibility | +| container.patch | Describes if minor changes or bugfixes have been implemented | +| puppet.major | Describes the contained major Puppet version (7 or 8) | + +### other tags + +```text +latest +latest- +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. diff --git a/RELEASE.md b/RELEASE.md index 1f43edd..dd76d89 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -1,12 +1,19 @@ # How to make a release -Create a Release PR. -The release branch has to have the version in the name, because this will be used as `future_version` of the github cnahgelog generator. +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: ```shell git switch main git pull -r -git switch -c release-v1.0.0 +git switch -c release-vX.Y.Z bundle config set --local path vendor/bundle bundle config set --local with 'release' @@ -14,8 +21,8 @@ bundle install CHANGELOG_GITHUB_TOKEN="token_MC_tokenface" bundle exec rake changelog -git commit -am 'Release v1.0.0' -git push origin release-v1.0.0 +git commit -am 'Release vX.Y.Z' +git push origin release-vX.Y.Z ``` After the merge do: @@ -23,6 +30,6 @@ After the merge do: ```shell git switch main git pull -r -git tag v1.0.0 +git tag vX.Y.Z git push --tags ```