Skip to content

Commit

Permalink
Merge branch 'main' into update_terraform
Browse files Browse the repository at this point in the history
  • Loading branch information
rwaffen committed Jan 9, 2024
2 parents c0a7d0a + a1b57f7 commit c7f7bc5
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 6 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
.bundle/
vendor/
Gemfile.lock
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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<container.major>.<container.minor>.<container.patch>-<puppet.major>
```

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-<puppet.major>
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.
19 changes: 13 additions & 6 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,35 @@
# 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'
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:

```shell
git switch main
git pull -r
git tag v1.0.0
git tag vX.Y.Z
git push --tags
```

0 comments on commit c7f7bc5

Please sign in to comment.