Ncrement-Help.xml
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: New-NcrementManifest --> <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"> <command:details> <command:name>New-NcrementManifest</command:name> <command:verb>New</command:verb> <command:noun>NcrementManifest</command:noun> <maml:description> <maml:para>Creates a new [Manifest] object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet creates a new [Manifest] object.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-NcrementManifest</maml:name> <!-- Parameter: Authors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Authors</maml:name> <maml:description> <maml:para>The manifest authors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Company --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Company</maml:name> <maml:description> <maml:para>The manifest company.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Copyright --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Copyright</maml:name> <maml:description> <maml:para>The manifest copyright.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The manifest description.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Icon --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Icon</maml:name> <maml:description> <maml:para>The manifest icon uri.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The manifest ID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: License --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>License</maml:name> <maml:description> <maml:para>The manifest license.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Title"> <maml:name>Name</maml:name> <maml:description> <maml:para>The manifest name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReleaseNotes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReleaseNotes</maml:name> <maml:description> <maml:para>The manifest release notes.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Repository --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Repository</maml:name> <maml:description> <maml:para>The manifest repository uri.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>The manifest tags.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Version --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="v,ver"> <maml:name>Version</maml:name> <maml:description> <maml:para>The manifest version.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VersionFormat --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VersionFormat</maml:name> <maml:description> <maml:para>The manifest version format.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Website --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Website</maml:name> <maml:description> <maml:para>The manifest project url.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The manifest ID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Title"> <maml:name>Name</maml:name> <maml:description> <maml:para>The manifest name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Title"> <maml:name>Title</maml:name> <maml:description> <maml:para>The manifest name.</maml:para> <maml:para>This is an alias of the Name parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Version --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="v,ver"> <maml:name>Version</maml:name> <maml:description> <maml:para>The manifest version.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="v,ver"> <maml:name>v</maml:name> <maml:description> <maml:para>The manifest version.</maml:para> <maml:para>This is an alias of the Version parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="v,ver"> <maml:name>ver</maml:name> <maml:description> <maml:para>The manifest version.</maml:para> <maml:para>This is an alias of the Version parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VersionFormat --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VersionFormat</maml:name> <maml:description> <maml:para>The manifest version format.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The manifest description.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>The manifest tags.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Website --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Website</maml:name> <maml:description> <maml:para>The manifest project url.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Icon --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Icon</maml:name> <maml:description> <maml:para>The manifest icon uri.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Repository --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Repository</maml:name> <maml:description> <maml:para>The manifest repository uri.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReleaseNotes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReleaseNotes</maml:name> <maml:description> <maml:para>The manifest release notes.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Company --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Company</maml:name> <maml:description> <maml:para>The manifest company.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Authors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Authors</maml:name> <maml:description> <maml:para>The manifest authors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: License --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>License</maml:name> <maml:description> <maml:para>The manifest license.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Copyright --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Copyright</maml:name> <maml:description> <maml:para>The manifest copyright.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Manifest --> <command:returnValue> <dev:type> <maml:name>Acklann.Ncrement.Manifest</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>New-NcrementManifest | ConvertTo-Json | Out-File "C:\app\manifest.json";</dev:code> <dev:remarks> <maml:para>This example, creates a new [Manifest] and saves to a file.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Update-NcrementProjectFile --> <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"> <command:details> <command:name>Update-NcrementProjectFile</command:name> <command:verb>Update</command:verb> <command:noun>NcrementProjectFile</command:noun> <maml:description> <maml:para>Updates a project file version number.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet will modify a project file with the information in the specified [Manifest] object. If the project file passed is not known it will be ignored.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Update-NcrementProjectFile</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1" aliases="Manifest"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The file-path or instance of a [Manifest] object.</maml:para> </maml:description> <command:parameterValue required="true">PSObject</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectFile --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named" aliases="Path,FullName"> <maml:name>ProjectFile</maml:name> <maml:description> <maml:para>The project file. If the file type is unknown it will be ignored.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Authors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Authors</maml:name> <maml:description> <maml:para>The manifest authors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Commit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Commit</maml:name> <maml:description> <maml:para>When present, any files modified by this cmdlet will be committed to source control.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: CommitAll --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CommitAll</maml:name> <maml:description> <maml:para>When present, all files will be committed to source control.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Company --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Company</maml:name> <maml:description> <maml:para>The manifest company.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Copyright --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Copyright</maml:name> <maml:description> <maml:para>The manifest copyright.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The manifest description.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Icon --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Icon</maml:name> <maml:description> <maml:para>The manifest icon uri.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The manifest ID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: License --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>License</maml:name> <maml:description> <maml:para>The manifest license.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Major --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Major</maml:name> <maml:description> <maml:para>When present, the major version number will be incremented.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Message --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="m,msg"> <maml:name>Message</maml:name> <maml:description> <maml:para>The commit message.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Minor --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Minor</maml:name> <maml:description> <maml:para>When present, the minor version number will be incremented.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Title"> <maml:name>Name</maml:name> <maml:description> <maml:para>The manifest name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Patch --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Patch</maml:name> <maml:description> <maml:para>When present, the patch version number will be incremented.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ReleaseNotes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReleaseNotes</maml:name> <maml:description> <maml:para>The manifest release notes.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Repository --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Repository</maml:name> <maml:description> <maml:para>The manifest repository uri.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>The manifest tags.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Version --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="v,ver"> <maml:name>Version</maml:name> <maml:description> <maml:para>The manifest version.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VersionFormat --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VersionFormat</maml:name> <maml:description> <maml:para>The manifest version format.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Website --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Website</maml:name> <maml:description> <maml:para>The manifest project url.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1" aliases="Manifest"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The file-path or instance of a [Manifest] object.</maml:para> </maml:description> <command:parameterValue required="true">PSObject</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="1" aliases="Manifest"> <maml:name>Manifest</maml:name> <maml:description> <maml:para>The file-path or instance of a [Manifest] object.</maml:para> <maml:para>This is an alias of the InputObject parameter.</maml:para> </maml:description> <command:parameterValue required="true">PSObject</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectFile --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named" aliases="Path,FullName"> <maml:name>ProjectFile</maml:name> <maml:description> <maml:para>The project file. If the file type is unknown it will be ignored.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named" aliases="Path,FullName"> <maml:name>Path</maml:name> <maml:description> <maml:para>The project file. If the file type is unknown it will be ignored.</maml:para> <maml:para>This is an alias of the ProjectFile parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named" aliases="Path,FullName"> <maml:name>FullName</maml:name> <maml:description> <maml:para>The project file. If the file type is unknown it will be ignored.</maml:para> <maml:para>This is an alias of the ProjectFile parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Message --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="m,msg"> <maml:name>Message</maml:name> <maml:description> <maml:para>The commit message.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="m,msg"> <maml:name>m</maml:name> <maml:description> <maml:para>The commit message.</maml:para> <maml:para>This is an alias of the Message parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="m,msg"> <maml:name>msg</maml:name> <maml:description> <maml:para>The commit message.</maml:para> <maml:para>This is an alias of the Message parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Major --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Major</maml:name> <maml:description> <maml:para>When present, the major version number will be incremented.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Minor --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Minor</maml:name> <maml:description> <maml:para>When present, the minor version number will be incremented.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Patch --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Patch</maml:name> <maml:description> <maml:para>When present, the patch version number will be incremented.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Commit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Commit</maml:name> <maml:description> <maml:para>When present, any files modified by this cmdlet will be committed to source control.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: CommitAll --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CommitAll</maml:name> <maml:description> <maml:para>When present, all files will be committed to source control.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The manifest ID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Title"> <maml:name>Name</maml:name> <maml:description> <maml:para>The manifest name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Title"> <maml:name>Title</maml:name> <maml:description> <maml:para>The manifest name.</maml:para> <maml:para>This is an alias of the Name parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Version --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="v,ver"> <maml:name>Version</maml:name> <maml:description> <maml:para>The manifest version.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="v,ver"> <maml:name>v</maml:name> <maml:description> <maml:para>The manifest version.</maml:para> <maml:para>This is an alias of the Version parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="v,ver"> <maml:name>ver</maml:name> <maml:description> <maml:para>The manifest version.</maml:para> <maml:para>This is an alias of the Version parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VersionFormat --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VersionFormat</maml:name> <maml:description> <maml:para>The manifest version format.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The manifest description.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>The manifest tags.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Website --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Website</maml:name> <maml:description> <maml:para>The manifest project url.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Icon --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Icon</maml:name> <maml:description> <maml:para>The manifest icon uri.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Repository --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Repository</maml:name> <maml:description> <maml:para>The manifest repository uri.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReleaseNotes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReleaseNotes</maml:name> <maml:description> <maml:para>The manifest release notes.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Company --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Company</maml:name> <maml:description> <maml:para>The manifest company.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Authors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Authors</maml:name> <maml:description> <maml:para>The manifest authors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: License --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>License</maml:name> <maml:description> <maml:para>The manifest license.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Copyright --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Copyright</maml:name> <maml:description> <maml:para>The manifest copyright.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The project file. If the file type is unknown it will be ignored.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-ChildItem -Filter "*.csproj" | Update-NcrementProjectFile $manifest -Commit;</dev:code> <dev:remarks> <maml:para>This example will update the project file version number then commit the changes to source control.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Select-NcrementVersionNumber --> <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"> <command:details> <command:name>Select-NcrementVersionNumber</command:name> <command:verb>Select</command:verb> <command:noun>NcrementVersionNumber</command:noun> <maml:description> <maml:para>Select the version number from a manifest.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Select-NcrementVersionNumber</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The file-path or instance of a [Manifest] object.</maml:para> </maml:description> <command:parameterValue required="true">PSObject</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Format --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Format</maml:name> <maml:description> <maml:para>The format string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The file-path or instance of a [Manifest] object.</maml:para> </maml:description> <command:parameterValue required="true">PSObject</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Format --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Format</maml:name> <maml:description> <maml:para>The format string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The file-path or instance of a [Manifest] object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Step-NcrementVersionNumber --> <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"> <command:details> <command:name>Step-NcrementVersionNumber</command:name> <command:verb>Step</command:verb> <command:noun>NcrementVersionNumber</command:noun> <maml:description> <maml:para>Increment a [Manifest] object version number.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet incrments a [Manifest] object's version number.</maml:para> <maml:para>This example increments version number then saves it back to disk.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Step-NcrementVersionNumber</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The file-path or instance of a [Manifest] object.</maml:para> </maml:description> <command:parameterValue required="true">PSObject</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Major --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Major</maml:name> <maml:description> <maml:para>When present, the major version number will be incremented.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Minor --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Minor</maml:name> <maml:description> <maml:para>When present, the minor version number will be incremented.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Patch --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Patch</maml:name> <maml:description> <maml:para>When present, the patch version number will be incremented.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The file-path or instance of a [Manifest] object.</maml:para> </maml:description> <command:parameterValue required="true">PSObject</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Major --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Major</maml:name> <maml:description> <maml:para>When present, the major version number will be incremented.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Minor --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Minor</maml:name> <maml:description> <maml:para>When present, the minor version number will be incremented.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Patch --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Patch</maml:name> <maml:description> <maml:para>When present, the patch version number will be incremented.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The file-path or instance of a [Manifest] object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>"C:\app\maifest.json" | Step-NcrementVersionNumber -Minor | ConvertTo-Json | Out-File "C:\app\manifest.json";</dev:code> <dev:remarks> <maml:para>This example increments version number then saves it back to disk.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> </helpItems> |