Tecman.TFS.Tools.psm1-help.xml
|
<?xml version = "1.0" encoding = "utf-8" ?>
<helpItems schema="maml"> <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>Upgrade-AdditionInBranch</command:name> <maml:description> <maml:para>Creates a set of files (additions, replacements and conflicts) by creating a delta between the selected.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Upgrade</command:verb> <command:noun>AdditionInBranch</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>First a Delta is created between the selected addition version and its base version. This gets the Delta of the addition files which have been added to the base version. This Delta is then used to apply (merge) the changes to the TargetBranch from TFS. The results are written out to the ResultPath folder. All files to be deployed are listed in the root of the folder as ".txt" files. Any conflicts encountered are displayed in the Conflict folder as ".conflict" files. This gives you information as to where and why the files conflicted. It is recommended practice to always check this folder. If there have been any conflicts, then the original files which caused the conflict will be listed under the Target folder as ".txt" files. This will allow you to perform a manual comparison between the new version and the old version. The Output folder contains a single ".txt" file with all of the updates from the merge.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Upgrade-AdditionInBranch</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>AdditionPath</maml:name> <maml:description> <maml:para>Filepath to the folder containing the NAV Objects with the Addition that you want to apply. If the AdditionPath is left blank a selection window is shown allowing you to choose an addition from TFS.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="none"> <maml:name>BespokeObjects</maml:name> <maml:description> <maml:para>Changes how the Delta will respond if it encounters an addition object with the same Id that is already present in the AdditionPath. It has 2 options: -- Replace: Objects are always replaced with the NewVersion. -- Compare: Objects are compared. If the update to the object results in a conflict, then this will create a conflict file. If no option is supplied then the default behaviour is Replace.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Compare</command:parameterValue> </command:parameterValueGroup> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="3" aliases="none"> <maml:name>NewVersion</maml:name> <maml:description> <maml:para>The changeset of the AdditionPath that you want to be installed into the TargetBranch. This will be used to perform a comparison against the base version of the AdditionPath. It will also be used in conjunction with OldVersion to find a Delta of the latest changes for the AdditionPath. It therefore must be a later chageset of the AdditionPath than OldVersion. If no NewVersion is supplied then the latest version will be found from TFS.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="4" aliases="none"> <maml:name>OldVersion</maml:name> <maml:description> <maml:para>The addition version that is currently present in the TargetBranch. A changeset from TFS of the chosen AdditionPath. It is used in conjunction with NewVersion to find the latest changes for the AdditionPath. If no OldVersion is supplied it will be automatically determined.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="5" aliases="none"> <maml:name>ResultPath</maml:name> <maml:description> <maml:para>Filepath to which all resultant files and folders will be written. If no ResultPath is supplied then the results will be written to a folder called Result on the Current User's Desktop.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="6" aliases="none"> <maml:name>TargetBranch</maml:name> <maml:description> <maml:para>Filepath to the folder containing the NAV Objects that you want to apply (merge) the updates to. If the TargetBranch is left blank a selection window is shown allowing you to choose a target from TFS.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="7" aliases="none"> <maml:name>Uninstall</maml:name> <maml:description> <maml:para>A switch which allows for the NewVersion to be uninstalled. If the switch is true then the NewVersion will be removed from the TargetBranch. The default value is false meaning additions will be installed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Switch</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="8" aliases="none"> <maml:name>VersionPrefix</maml:name> <maml:description> <maml:para>The prefix which is used by the AdditionPath, for example DD, MA. Applies the version list from the Delta to the Result. When no VersionPrefix is supplied the function will attempt to automatically determine it from the chageset comments. If the TFS changeset comments do not contain the VersionPrefix then it cannot be automatically determined and an error will be thrown. If this is the case then you must supply a VersionPrefix.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>AdditionPath</maml:name> <maml:description> <maml:para>Filepath to the folder containing the NAV Objects with the addition that you want to apply. If the AdditionPath is left blank a selection window is shown allowing you to choose an addition from TFS.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="none"> <maml:name>BespokeObjects</maml:name> <maml:description> <maml:para>Changes how the Delta will respond if it encounters an addition object with the same Id that is already present in the AdditionPath. It has 2 options: -- Replace: Objects are always replaced with the NewVersion. -- Compare: Objects are compared. If the update to the object results in a conflict, then this will create a conflict file. If no option is supplied then the default behaviour is Replace.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Compare</command:parameterValue> </command:parameterValueGroup> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="3" aliases="none"> <maml:name>NewVersion</maml:name> <maml:description> <maml:para>The changeset of the AdditionPath that you want to be installed into the TargetBranch. This will be used to perform a comparison against the base version of the AdditionPath. It will also be used in conjunction with OldVersion to find a Delta of the latest changes for the AdditionPath. It therefore must be a later chageset of the AdditionPath than OldVersion.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="4" aliases="none"> <maml:name>OldVersion</maml:name> <maml:description> <maml:para>The addition version that is currently present in the TargetBranch. A changeset from TFS of the chosen AdditionPath. It is used in conjunction with NewVersion to find the latest changes for the AdditionPath. If no OldVersion is supplied it will be automatically determined.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Int</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="5" aliases="none"> <maml:name>ResultPath</maml:name> <maml:description> <maml:para>Filepath to which all resutant files and folders will be written. If no ResultPath is supplied then the results will be written to a folder called Result on the Current User's Desktop.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="6" aliases="none"> <maml:name>TargetBranch</maml:name> <maml:description> <maml:para>Filepath to the folder containing the NAV Objects that you want to apply (merge) the updates to. If the TargetBranch is left blank a selection window is shown allowing you to choose a target from TFS.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="7" aliases="none"> <maml:name>Uninstall</maml:name> <maml:description> <maml:para>A switch which allows for the NewVersion to be uninstalled. If the switch is true then the NewVersion will be removed from the TargetBranch. The default value is false meaning additions will be installed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Switch</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="8" aliases="none"> <maml:name>VersionPrefix</maml:name> <maml:description> <maml:para>The prefix which is used by the AdditionPath, for example DD, MA. Applies the version list from the Delta to the Result. When no VersionPrefix is supplied the function will attempt to automatically determine it from the chageset comments. If the TFS changeset comments do not contain the VersionPrefix then it cannot be automatically determined and an error will be thrown. If this is the case then you must supply a VersionPrefix.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name/> <maml:uri/> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description/> </command:inputType> </command:inputTypes> <command:returnValues /> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1: Run with no Parameters -------------------------- </maml:title> <maml:introduction/> <dev:code> Upgrade-AdditionInBranch </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>This example will prompt for an AdditionPath and for a TargetBranch from TFS and will attempt to find the VersionPrefix from the changeset comment. It will output the results to a folder called Result on the User's Desktop. When no VersionPrefix is supplied the function will attempt to automatically determine it from the chageset comments. If the TFS changeset comments do not contain the VersionPrefix then it cannot be automatically determined and an error will be thrown. If this is the case then you must supply a VersionPrefix, for example DD, MA etc.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 2: Run With VersionPrefix -------------------------- </maml:title> <maml:introduction/> <dev:code> Upgrade-AdditionInBranch -VersionPrefix "IPE" </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>This example will prompt for an AdditionPath and for a TargetBranch from TFS and use the VersionPrefix supplied to update the objects accordingly. It will output the results to a folder called Result on the User's Desktop. The supplied VersionPrefix will be used as the VersionPrefix for the AdditionPath.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 3: Run With BespokeObjects Compare -------------------------- </maml:title> <maml:introduction/> <dev:code> Upgrade-AdditionInBranch -BespokeObjects "Compare" </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>This example will prompt for an AdditionPath and for a TargetBranch from TFS. The BespokeObjects Compare will be set. It will output the results to a folder called Result on the User's Desktop. The Compare option will mean that if an addition object is already in the target branch with the same Id as the new object then the 2 will be compared. In this case, any changes which result in conflicts will be made into conflict files.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>To get more information on setting up PowerShell ISE to use Tecman.TFS.Tools and how to use the Upgrade-AdditionInBranch cmdlet see the document on Tecman's NAV Development SharePoint:</maml:linkText> <maml:uri>https://tecman578.sharepoint.com/sites/NAVDevelopment/_layouts/15/WopiFrame2.aspx?action=edit&sourcedoc={1BB23EDF-56FB-43E1-B895-EEFCB5C3EAA0}</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> </helpItems> |