|
86 | 86 |
|
87 | 87 | ## Property Reference |
88 | 88 |
|
89 | | -`Branch` |
90 | | -: The full [git refspec](https://git-scm.com/book/en/v2/Git-Internals-The-Refspec) |
91 | | - of the code being built. The behavior of this package depends primarily on |
92 | | - the format of the refspec: |
93 | | - |
94 | | - `Branch=refs/heads/foo` |
95 | | - : - Recognized as a branch named `foo`. |
96 | | - - Sets the pre-release tag to `foo` followed by a build counter. |
97 | | - |
98 | | - `Branch=refs/heads/foo/bar` |
99 | | - : - Recognized as a branch named `foo/bar`. |
100 | | - - Sets the pre-release tag to `foo-bar` followed by a build counter. |
101 | | - |
102 | | - `Branch=refs/pull/42` |
103 | | - : - Recognized as pull request 42. |
104 | | - - Sets the pre-release tag to `pr.42` followed by a build counter. |
105 | | - |
106 | | - `Branch=refs/tag/release/1.2.3-foo.42` |
107 | | - : - Recognized as a pre-release tag named `release/1.2.3-foo.42`. |
108 | | - - Emits a build error if the `VersionPrefix` property does not match |
109 | | - the tag version, `1.2.3`. |
110 | | - - Sets the pre-release tag to `foo.42` followed by a build counter. |
111 | | - |
112 | | - `Branch=refs/tag/release/1.2.3` |
113 | | - : - Recognized as a release tag named `release/1.2.3`. |
114 | | - - Emits a build error if the `VersionPrefix` property does not match |
115 | | - the tag version, `1.2.3`. |
116 | | - - **Does not** set a pre-release tag or append a build counter. |
117 | | - |
118 | | - `Branch="something else entirely"` |
119 | | - : - Not recognized. |
120 | | - - Sets the pre-release tag to `something-else-entirely` followed by a |
121 | | - build counter. |
122 | | - |
123 | | - `Branch=""` (empty or not set) |
124 | | - : - Sets the pre-release tag to `local`, without a build counter. This |
125 | | - default is intended to ease local development. |
126 | | - |
127 | | -`Counter` |
128 | | -: An arbitrary number to distinguish the current build from other builds of |
129 | | - the same refspec. If not set, the build generates a date/time-based |
130 | | - counter of the form `yyyymmdd.ThhmmssZ` using the current UTC time. |
131 | | - |
132 | | -`StampOnBuild` |
133 | | -: TODO |
134 | | - |
135 | | -`SetAzurePipelinesBuildName` |
136 | | -: When `true`, the build outputs magic text that sets the name of an Azure |
137 | | - DevOps pipeline run. |
138 | | - |
139 | | -`SetGitHubActionsVersion` |
140 | | -: When `true`, the build outputs magic text that sets the version of a GitHub |
141 | | - Actions workflow run. |
142 | | - |
143 | | -`SetTeamCityBuildNumber` |
144 | | -: When `true`, the build outputs magic text that sets the name of a TeamCity |
145 | | - build. |
| 89 | +#### `Branch` |
| 90 | +The full [git refspec](https://git-scm.com/book/en/v2/Git-Internals-The-Refspec) |
| 91 | +of the code being built. The behavior of this package depends primarily on |
| 92 | +the format of the refspec: |
| 93 | + |
| 94 | +- `refs/heads/foo` |
| 95 | + - Recognized as a branch named `foo`. |
| 96 | + - Sets the pre-release tag to `foo` followed by a build counter. |
| 97 | +- `refs/heads/foo/bar` |
| 98 | + - Recognized as a branch named `foo/bar`. |
| 99 | + - Sets the pre-release tag to `foo-bar` followed by a build counter. |
| 100 | +- `refs/pull/42` |
| 101 | + - Recognized as pull request 42. |
| 102 | + - Sets the pre-release tag to `pr.42` followed by a build counter. |
| 103 | +- `refs/tag/release/1.2.3-foo.42` |
| 104 | + - Recognized as a pre-release tag named `release/1.2.3-foo.42`. |
| 105 | + - Emits a build error if the `VersionPrefix` property does not match |
| 106 | + the tag version, `1.2.3`. |
| 107 | + - Sets the pre-release tag to `foo.42` followed by a build counter. |
| 108 | +- `refs/tag/release/1.2.3` |
| 109 | + - Recognized as a release tag named `release/1.2.3`. |
| 110 | + - Emits a build error if the `VersionPrefix` property does not match |
| 111 | + the tag version, `1.2.3`. |
| 112 | + - **Does not** set a pre-release tag or append a build counter. |
| 113 | +- `something else entirely` |
| 114 | + - Not recognized. |
| 115 | + - Sets the pre-release tag to `something-else-entirely` followed by a |
| 116 | + build counter. |
| 117 | +- empty or not set |
| 118 | + - Sets the pre-release tag to `local`, without a build counter. This |
| 119 | + default is intended to ease local development. |
| 120 | + |
| 121 | +#### `Counter` |
| 122 | +An arbitrary number to distinguish the current build from other builds of |
| 123 | +the same refspec. If not set, the build generates a date/time-based |
| 124 | +counter of the form `yyyymmdd.ThhmmssZ` using the current UTC time. |
| 125 | + |
| 126 | +#### `StampOnBuild` |
| 127 | +TODO |
| 128 | + |
| 129 | +#### `SetAzurePipelinesBuildName` |
| 130 | +When `true`, the build outputs magic text that sets the name of an Azure |
| 131 | +DevOps pipeline run. |
| 132 | + |
| 133 | +#### `SetGitHubActionsVersion` |
| 134 | +When `true`, the build outputs magic text that sets the version of a GitHub |
| 135 | +Actions workflow run. |
| 136 | + |
| 137 | +#### `SetTeamCityBuildNumber` |
| 138 | +When `true`, the build outputs magic text that sets the name of a TeamCity |
| 139 | +build. |
0 commit comments