mirror of
https://github.com/game-ci/unity-builder.git
synced 2025-07-04 12:25:19 -04:00
Improve versioning readme 📜
This commit is contained in:
parent
f85e50e499
commit
22c7d0e516
26
README.md
26
README.md
@ -274,6 +274,8 @@ No version will be set by Builder.
|
|||||||
versioning: None
|
versioning: None
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Note that the version set in the project will be used instead.
|
||||||
|
|
||||||
##### Semantic (default)
|
##### Semantic (default)
|
||||||
|
|
||||||
Builder automatically generates a version based on [semantic versioning](https://semver.org/) out of the box.
|
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.
|
- Developer keeps control over `major` and `minor` versions using tags.
|
||||||
- Zero configuration; It works out of the box
|
- Zero configuration; It works out of the box
|
||||||
|
|
||||||
|
##### Tag
|
||||||
|
|
||||||
|
Uses the tag that points at `HEAD` as the version.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: webbertakken/unity-builder@<version>
|
||||||
|
with:
|
||||||
|
versioning: Tag
|
||||||
|
```
|
||||||
|
|
||||||
|
This strategy works well when using a pipeline that specifically runs for tags.
|
||||||
|
|
||||||
|
The tag must be a version tag.
|
||||||
|
|
||||||
##### Custom
|
##### Custom
|
||||||
|
|
||||||
Allows specifying a custom version in the `version` field.
|
Allows specifying a custom version in the `version` field.
|
||||||
@ -306,15 +322,7 @@ Allows specifying a custom version in the `version` field.
|
|||||||
version: <some_version>
|
version: <some_version>
|
||||||
```
|
```
|
||||||
|
|
||||||
##### Custom
|
If there is a use case missing from Builder, feel free to create a feature request.
|
||||||
|
|
||||||
Uses the tag that points at `HEAD` as the version.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
- uses: webbertakken/unity-builder@<version>
|
|
||||||
with:
|
|
||||||
versioning: Tag
|
|
||||||
```
|
|
||||||
|
|
||||||
#### customParameters
|
#### customParameters
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user