diff --git a/README.md b/README.md index 5c5e6c8a..a034a530 100644 --- a/README.md +++ b/README.md @@ -245,7 +245,7 @@ There are two conditions for a custom buildCommand: _**example:**_ ```yaml -- uses: webbertakken/unity-builder@master +- uses: webbertakken/unity-builder@ with: buildMethod: EditorNamespace.BuilderClassName.StaticBulidMethod ``` @@ -253,6 +253,69 @@ _**example:**_ _**required:** `false`_ _**default:** Built-in script that will run a build out of the box._ +#### versioning + +The versioning strategy to use. + +Strategies only work when no custom buildMethod is specified. + +_**required:** `false`_ +_**default:** `Auto`_ + +#### _These are the available strategies:_ + +##### None + +No version will be set by Builder. + +```yaml +- uses: webbertakken/unity-builder@ + with: + versioning: None +``` + +##### Semantic (default) + +Builder automatically generates a version based on [semantic versioning](https://semver.org/) out of the box. + +The version works as follows: `..` for example `0.1.2`. +The latest tag dictates `.` and the number of commits since that tag is used in ``. + +```yaml +- uses: webbertakken/unity-builder@ + with: + versioning: Semantic +``` + +This strategy works well for the following reasons: + +- All builds have their unique version +- No version related commits are created +- No knowledge of git or versioning is required +- Developer keeps control over `major` and `minor` versions using tags. +- Zero configuration; It works out of the box + +##### Custom + +Allows specifying a custom version in the `version` field. + +```yaml +- uses: webbertakken/unity-builder@ + with: + versioning: Custom + version: +``` + +##### Custom + +Uses the tag that points at `HEAD` as the version. + +```yaml +- uses: webbertakken/unity-builder@ + with: + versioning: Tag +``` + #### customParameters Custom parameters to configure the build. @@ -264,7 +327,7 @@ Parameters without a value will be considered booleans (with a value of true). _**example:**_ ```yaml -- uses: webbertakken/unity-builder@master +- uses: webbertakken/unity-builder@ with: customParameters: -profile SomeProfile -someBoolean -someValue exampleValue ```