From 22c7d0e516b899716485c76c199cfb29223afaa8 Mon Sep 17 00:00:00 2001 From: Webber Date: Sun, 26 Apr 2020 21:00:24 +0200 Subject: [PATCH] =?UTF-8?q?Improve=20versioning=20readme=20=F0=9F=93=9C?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 26 +++++++++++++++++--------- 1 file changed, 17 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index a034a530..d7125915 100644 --- a/README.md +++ b/README.md @@ -274,6 +274,8 @@ No version will be set by Builder. versioning: None ``` +Note that the version set in the project will be used instead. + ##### Semantic (default) Builder automatically generates a version based on [semantic versioning](https://semver.org/) out of the box. @@ -295,6 +297,20 @@ This strategy works well for the following reasons: - Developer keeps control over `major` and `minor` versions using tags. - Zero configuration; It works out of the box +##### Tag + +Uses the tag that points at `HEAD` as the version. + +```yaml +- uses: webbertakken/unity-builder@ + with: + versioning: Tag +``` + +This strategy works well when using a pipeline that specifically runs for tags. + +The tag must be a version tag. + ##### Custom Allows specifying a custom version in the `version` field. @@ -306,15 +322,7 @@ Allows specifying a custom version in the `version` field. version: ``` -##### Custom - -Uses the tag that points at `HEAD` as the version. - -```yaml -- uses: webbertakken/unity-builder@ - with: - versioning: Tag -``` +If there is a use case missing from Builder, feel free to create a feature request. #### customParameters