GitVersioning-help.xml
|
<?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="1" 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="2" 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="1" 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="2" 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> |