@@ -51,7 +51,7 @@ your license file and add it as a secret.
5151Then, define the build step as follows:
5252
5353``` yaml
54- - uses : webbertakken/unity-builder@v0.11
54+ - uses : webbertakken/unity-builder@<version>
5555 env :
5656 UNITY_LICENSE : ${{ secrets.UNITY_LICENSE }}
5757 with :
@@ -73,7 +73,7 @@ Instead, three variables will need to be set.
7373Define the build step as follows :
7474
7575` ` ` yaml
76- - uses: webbertakken/unity-builder@v0.11
76+ - uses: webbertakken/unity-builder@<version>
7777 env:
7878 UNITY_EMAIL: ${{ secrets.UNITY_EMAIL }}
7979 UNITY_PASSWORD: ${{ secrets.UNITY_PASSWORD }}
@@ -177,7 +177,7 @@ jobs:
177177 restore-keys: |
178178 Library-${{ matrix.projectPath }}-
179179 Library-
180- - uses: webbertakken/unity-builder@v0.11
180+ - uses: webbertakken/unity-builder@<version>
181181 with:
182182 projectPath: ${{ matrix.projectPath }}
183183 unityVersion: ${{ matrix.unityVersion }}
@@ -255,74 +255,46 @@ _**default:** Built-in script that will run a build out of the box._
255255
256256# ### versioning
257257
258- The versioning strategy to use.
259-
260- Strategies only work when no custom buildMethod is specified.
261-
262- _**required:** `false`_
263- _**default:** `Auto`_
264-
265- # ### _These are the available strategies:_
266-
267- # #### None
268-
269- No version will be set by Builder.
270-
271- ` ` ` yaml
272- - uses: webbertakken/unity-builder@<version>
273- with:
274- versioning: None
275- ` ` `
276-
277- Note that the version set in the project will be used instead.
278-
279- # #### Semantic (default)
280-
281- Builder automatically generates a version based on [semantic versioning](https://semver.org/) out of the box.
282-
283- The version works as follows : ` <major>.<minor>.<patch>` for example `0.1.2`.
284- The latest tag dictates `<major>.<minor>` and the number of commits since that tag is used in `<patch>`.
258+ Configure a specific versioning strategy
285259
286260` ` ` yaml
287261- uses: webbertakken/unity-builder@<version>
288262 with:
289263 versioning: Semantic
290264` ` `
291265
292- This strategy works well for the following reasons :
266+ Find the available strategies below :
293267
294- - All builds have their unique version
295- - No version related commits are created
296- - No knowledge of git or versioning is required
297- - Developer keeps control over `major` and `minor` versions using tags.
298- - Zero configuration; It works out of the box
268+ # #### Semantic
299269
300- # #### Tag
270+ Versioning out of the box! **(recommended)**
301271
302- Uses the tag that points at `HEAD` as the version.
272+ > Compatible with **all platforms**.
273+ > Does **not** modify your repository.
274+ > Requires **zero configuration**.
303275
304- ` ` ` yaml
305- - uses: webbertakken/unity-builder@<version>
306- with:
307- versioning: Tag
308- ` ` `
276+ How it works :
309277
310- This strategy works well when using a pipeline that specifically runs for tags.
278+ > Generates a version based on [semantic versioning](https://semver.org/).
279+ > Follows `<major>.<minor>.<patch>` for example `0.17.2`.
280+ > The latest tag dictates `<major>.<minor>` (defaults to 0.0 for no tag).
281+ > The number of commits (since the last tag, if any) is used for `<patch>`.
311282
312- The tag must be a version tag .
283+ No configuration required .
313284
314285# #### Custom
315286
316- Allows specifying a custom version in the `version` field.
287+ Allows specifying a custom version in the `version` field. **(advanced users)**
317288
318- ` ` ` yaml
319- - uses: webbertakken/unity-builder@<version>
320- with:
321- versioning: Custom
322- version: <some_version>
323- ` ` `
289+ > This strategy is useful when your project or pipeline has some kind of orchestration
290+ > that determines the versions.
291+
292+ # #### None
293+
294+ No version will be set by Builder. **(not recommended)**
324295
325- If there is a use case missing from Builder, feel free to create a feature request.
296+ > Not recommended unless you generate a new version in a pre-commit hook. Manually
297+ > setting versions is error-prone.
326298
327299# ### allowDirtyBuild
328300
0 commit comments