From 400bd87b5a0b1f83fec6cdb39552742240bf4c75 Mon Sep 17 00:00:00 2001 From: CrazyMax <1951866+crazy-max@users.noreply.github.com> Date: Sat, 8 May 2021 00:01:13 +0200 Subject: [PATCH] Major version zero doc (#74) Co-authored-by: CrazyMax --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 64285ab..2c72a57 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,7 @@ ___ * [Notes](#notes) * [Latest tag](#latest-tag) * [Global expressions](#global-expressions) + * [Major version zero](#major-version-zero) * [Overwrite labels](#overwrite-labels) * [Keep up-to-date with GitHub Dependabot](#keep-up-to-date-with-github-dependabot) * [Contributing](#contributing) @@ -574,6 +575,25 @@ tags: | type=raw,value=mytag-{{branch}}-{{sha}} ``` +### Major version zero + +Major version zero (`0.y.z`) is for initial development and **may** change at any time. This means the public API +[**should not** be considered stable](https://semver.org/#spec-item-4). + +In this case, Docker tag `0` **should not** be generated if you're using [`type=semver`](#typesemver) with `{{major}}` +pattern. You can manage this behavior like this: + +```yaml +# refs/tags/v0.1.2 +tags: | + # output 0.1.2 + type=semver,pattern={{version}} + # output 0.1 + type=semver,pattern={{major}}.{{minor}} + # disabled if major zero + type=semver,pattern={{major}},enable=${{ !startsWith(github.ref, 'refs/tags/v0.') }} +``` + ### Overwrite labels If some of the [OCI Image Format Specification](https://github.com/opencontainers/image-spec/blob/master/annotations.md)