GitVersioning-help.xml
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 |
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-MajorVersionTag</command:name> <command:verb>Add</command:verb> <command:noun>MajorVersionTag</command:noun> <maml:description> <maml:para>Adds a new major version tag to the current git repository.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Finds the most recent git tag in the current repository that has the form `v0.0.0`, increments the major version number according to semantic versioning rules (https://semver.org/), and adds a new annotated git tag with the updated version number.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-MajorVersionTag</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Message</maml:name> <maml:Description> <maml:para>The message to associate with the new tag.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CurrentBranchOnly</maml:name> <maml:Description> <maml:para>By default, all branches are searched for the most recent version tag which is then used as the basis for the next version. However, `-CurrentBranchOnly` restricts this search to the the lineage of the current branch. The default is preferable if you want versions to span the entire repository; `CurrentBranchOnly` is preferrable if you want versions restricted to particular branches. For example... Let's say you have a repository with a commit tagged `v6.0.0` in one branch and another tagged `v5.2.3` in a different branch. Now let's say you need to make a change to the `v5.X.X` branch that shouldn't be considered part of `v6.0.0`. In that scenario, you should use `Add-PatchVersion -CurrentBranchOnly -Message 'Fixed the thing'` to create a new tag `v5.2.4`. If you didn't specify `-CurrentBranchOnly` -- regardless of which branch you're currently on -- the next version generated by `Add-PatchVersion` would be `v6.0.1` because it would determine that across all branches `v6.0.0` is the most recent version and would use it as the basis for the next version.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Message</maml:name> <maml:Description> <maml:para>The message to associate with the new tag.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CurrentBranchOnly</maml:name> <maml:Description> <maml:para>By default, all branches are searched for the most recent version tag which is then used as the basis for the next version. However, `-CurrentBranchOnly` restricts this search to the the lineage of the current branch. The default is preferable if you want versions to span the entire repository; `CurrentBranchOnly` is preferrable if you want versions restricted to particular branches. For example... Let's say you have a repository with a commit tagged `v6.0.0` in one branch and another tagged `v5.2.3` in a different branch. Now let's say you need to make a change to the `v5.X.X` branch that shouldn't be considered part of `v6.0.0`. In that scenario, you should use `Add-PatchVersion -CurrentBranchOnly -Message 'Fixed the thing'` to create a new tag `v5.2.4`. If you didn't specify `-CurrentBranchOnly` -- regardless of which branch you're currently on -- the next version generated by `Add-PatchVersion` would be `v6.0.1` because it would determine that across all branches `v6.0.0` is the most recent version and would use it as the basis for the next version.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Add-MajorVersionTag -m "Breaking changes ahoy!"</dev:code> <dev:remarks> <maml:para>Increments the major version and appends a new git tag to the HEAD commit.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-MajorVersionTag</maml:linkText> <maml:uri>https://github.com/refactorsaurusrex/whats-new/wiki/Add-MajorVersionTag</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-MinorVersionTag</command:name> <command:verb>Add</command:verb> <command:noun>MinorVersionTag</command:noun> <maml:description> <maml:para>Adds a new minor version tag to the current git repository.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Finds the most recent git tag in the current repository that has the form `v0.0.0`, increments the minor version number according to semantic versioning rules (https://semver.org/), and adds a new annotated git tag with the updated version number.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-MinorVersionTag</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Message</maml:name> <maml:Description> <maml:para>The message to associate with the new tag.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CurrentBranchOnly</maml:name> <maml:Description> <maml:para>By default, all branches are searched for the most recent version tag which is then used as the basis for the next version. However, `-CurrentBranchOnly` restricts this search to the the lineage of the current branch. The default is preferable if you want versions to span the entire repository; `CurrentBranchOnly` is preferrable if you want versions restricted to particular branches. For example... Let's say you have a repository with a commit tagged `v6.0.0` in one branch and another tagged `v5.2.3` in a different branch. Now let's say you need to make a change to the `v5.X.X` branch that shouldn't be considered part of `v6.0.0`. In that scenario, you should use `Add-PatchVersion -CurrentBranchOnly -Message 'Fixed the thing'` to create a new tag `v5.2.4`. If you didn't specify `-CurrentBranchOnly` -- regardless of which branch you're currently on -- the next version generated by `Add-PatchVersion` would be `v6.0.1` because it would determine that across all branches `v6.0.0` is the most recent version and would use it as the basis for the next version.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Message</maml:name> <maml:Description> <maml:para>The message to associate with the new tag.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CurrentBranchOnly</maml:name> <maml:Description> <maml:para>By default, all branches are searched for the most recent version tag which is then used as the basis for the next version. However, `-CurrentBranchOnly` restricts this search to the the lineage of the current branch. The default is preferable if you want versions to span the entire repository; `CurrentBranchOnly` is preferrable if you want versions restricted to particular branches. For example... Let's say you have a repository with a commit tagged `v6.0.0` in one branch and another tagged `v5.2.3` in a different branch. Now let's say you need to make a change to the `v5.X.X` branch that shouldn't be considered part of `v6.0.0`. In that scenario, you should use `Add-PatchVersion -CurrentBranchOnly -Message 'Fixed the thing'` to create a new tag `v5.2.4`. If you didn't specify `-CurrentBranchOnly` -- regardless of which branch you're currently on -- the next version generated by `Add-PatchVersion` would be `v6.0.1` because it would determine that across all branches `v6.0.0` is the most recent version and would use it as the basis for the next version.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Add-MinorVersionTag -m "New features ahoy!"</dev:code> <dev:remarks> <maml:para>Increments the minor version and appends a new git tag to the HEAD commit.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/refactorsaurusrex/whats-new/wiki/Cmdlet-and-Function-Overview#add-minorversiontag</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-MinorVersionTag</maml:linkText> <maml:uri>https://github.com/refactorsaurusrex/whats-new/wiki/Add-MinorVersionTag</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-PatchVersionTag</command:name> <command:verb>Add</command:verb> <command:noun>PatchVersionTag</command:noun> <maml:description> <maml:para>Adds a new patch version tag to the current git repository.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Finds the most recent git tag in the current repository that has the form `v0.0.0`, increments the patch version number according to semantic versioning rules (https://semver.org/), and adds a new annotated git tag with the updated version number.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PatchVersionTag</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Message</maml:name> <maml:Description> <maml:para>The message to associate with the new tag.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CurrentBranchOnly</maml:name> <maml:Description> <maml:para>By default, all branches are searched for the most recent version tag which is then used as the basis for the next version. However, `-CurrentBranchOnly` restricts this search to the the lineage of the current branch. The default is preferable if you want versions to span the entire repository; `CurrentBranchOnly` is preferrable if you want versions restricted to particular branches. For example... Let's say you have a repository with a commit tagged `v6.0.0` in one branch and another tagged `v5.2.3` in a different branch. Now let's say you need to make a change to the `v5.X.X` branch that shouldn't be considered part of `v6.0.0`. In that scenario, you should use `Add-PatchVersion -CurrentBranchOnly -Message 'Fixed the thing'` to create a new tag `v5.2.4`. If you didn't specify `-CurrentBranchOnly` -- regardless of which branch you're currently on -- the next version generated by `Add-PatchVersion` would be `v6.0.1` because it would determine that across all branches `v6.0.0` is the most recent version and would use it as the basis for the next version.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Message</maml:name> <maml:Description> <maml:para>The message to associate with the new tag.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CurrentBranchOnly</maml:name> <maml:Description> <maml:para>By default, all branches are searched for the most recent version tag which is then used as the basis for the next version. However, `-CurrentBranchOnly` restricts this search to the the lineage of the current branch. The default is preferable if you want versions to span the entire repository; `CurrentBranchOnly` is preferrable if you want versions restricted to particular branches. For example... Let's say you have a repository with a commit tagged `v6.0.0` in one branch and another tagged `v5.2.3` in a different branch. Now let's say you need to make a change to the `v5.X.X` branch that shouldn't be considered part of `v6.0.0`. In that scenario, you should use `Add-PatchVersion -CurrentBranchOnly -Message 'Fixed the thing'` to create a new tag `v5.2.4`. If you didn't specify `-CurrentBranchOnly` -- regardless of which branch you're currently on -- the next version generated by `Add-PatchVersion` would be `v6.0.1` because it would determine that across all branches `v6.0.0` is the most recent version and would use it as the basis for the next version.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Add-PatchVersionTag -m "Bug fixes ahoy!"</dev:code> <dev:remarks> <maml:para>Increments the patch version and appends a new git tag to the HEAD commit.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-PatchVersionTag</maml:linkText> <maml:uri>https://github.com/refactorsaurusrex/whats-new/wiki/Add-PatchVersionTag</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-VersionTag</command:name> <command:verb>New</command:verb> <command:noun>VersionTag</command:noun> <maml:description> <maml:para>Adds a new semantic version tag to the current git repository.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Add a new annotated git tag with the specified version number and message to the HEAD commit.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-VersionTag</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Tag</maml:name> <maml:Description> <maml:para>The new semantic version tag to apply. Must be in the format `v0.0.0`</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Message</maml:name> <maml:Description> <maml:para>The message to associate with the new tag.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Tag</maml:name> <maml:Description> <maml:para>The new semantic version tag to apply. Must be in the format `v0.0.0`</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Message</maml:name> <maml:Description> <maml:para>The message to associate with the new tag.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-VersionTag -t v1.0.0 -m "New library ahoy!"</dev:code> <dev:remarks> <maml:para>Creates a new annotated git tag named `v1.0.0` and applies it to the HEAD commit.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>New-VersionTag</maml:linkText> <maml:uri>https://github.com/refactorsaurusrex/whats-new/wiki/New-VersionTag</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |