Add active workspace commands

loanDepot · Oct 3, 2018 · 25b0ce8 · 25b0ce8
1 parent 90bc957
commit 25b0ce8
Show file tree

Hide file tree

Showing 15 changed files with 562 additions and 13 deletions.
diff --git a/Docs/en-US/Get-TFVCActiveWorkspace.md b/Docs/en-US/Get-TFVCActiveWorkspace.md
@@ -0,0 +1,72 @@
+---
+external help file: TFVC-help.xml
+Module Name: TFVC
+online version:
+schema: 2.0.0
+---
+
+# Get-TFVCActiveWorkspace
+
+## SYNOPSIS
+Gets the currently active workspace
+
+## SYNTAX
+
+```
+Get-TFVCActiveWorkspace [-WhatIf] [-Confirm] [<CommonParameters>]
+```
+
+## DESCRIPTION
+{{Fill in the Description}}
+
+## EXAMPLES
+
+### EXAMPLE 1
+```
+Get-TFVCActiveWorkspace
+```
+
+## PARAMETERS
+
+### -Confirm
+Prompts you for confirmation before running the cmdlet.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: cf
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -WhatIf
+Shows what would happen if the cmdlet runs. The cmdlet is not run.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: wi
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### CommonParameters
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
+
+## INPUTS
+
+## OUTPUTS
+
+## NOTES
+This is used to provide a default value for cmdlets that need a workspace.
+This is why it throws an error if it is used before a workspace is set.
+
+## RELATED LINKS
diff --git a/Docs/en-US/Get-TFVCLatest.md b/Docs/en-US/Get-TFVCLatest.md
@@ -77,8 +77,7 @@ Accept wildcard characters: False
 ```
 
 ### CommonParameters
-This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
-For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
 
 ## INPUTS
 

diff --git a/Docs/en-US/Get-TFVCMergeCandidate.md b/Docs/en-US/Get-TFVCMergeCandidate.md
@@ -0,0 +1,86 @@
+---
+external help file: TFVC-help.xml
+Module Name: TFVC
+online version:
+schema: 2.0.0
+---
+
+# Get-TFVCMergeCandidate
+
+## SYNOPSIS
+Compares 2 branches and get the changeset that are different between them
+
+## SYNTAX
+
+```
+Get-TFVCMergeCandidate [-Workspace] <Workspace> [-SourceBranch] <String> [-TargetBranch] <String>
+ [<CommonParameters>]
+```
+
+## DESCRIPTION
+{{Fill in the Description}}
+
+## EXAMPLES
+
+### EXAMPLE 1
+```
+Get-TFVCMergeCandidate -SourceBranch $SourceBranch -TargetBranch $TargetBbranch -Workspace $Workspace
+```
+
+## PARAMETERS
+
+### -SourceBranch
+Source banch with the chagnes that need to be merged
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: 2
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
+### -TargetBranch
+Target branch to merge the changes into
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: 3
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
+### -Workspace
+the workspace
+
+```yaml
+Type: Workspace
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: 1
+Default value: None
+Accept pipeline input: True (ByValue)
+Accept wildcard characters: False
+```
+
+### CommonParameters
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
+
+## INPUTS
+
+## OUTPUTS
+
+## NOTES
+
+## RELATED LINKS
diff --git a/Docs/en-US/Get-TFVCWorkspace.md b/Docs/en-US/Get-TFVCWorkspace.md
@@ -13,12 +13,13 @@ schema: 2.0.0
 
 ### Default (Default)
 ```
-Get-TFVCWorkspace [[-Name] <String>] [[-Owner] <String>] [-TFVCSession <TFVCSession>] [<CommonParameters>]
+Get-TFVCWorkspace [[-Name] <String>] [[-Owner] <String>] [-TFVCSession <TFVCSession>] [-SetActiveWorkspace]
+ [<CommonParameters>]
 ```
 
 ### LocalPath
 ```
-Get-TFVCWorkspace [-Path] <String> [-TFVCSession <TFVCSession>] [<CommonParameters>]
+Get-TFVCWorkspace [-Path] <String> [-TFVCSession <TFVCSession>] [-SetActiveWorkspace] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -78,6 +79,21 @@ Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
+### -SetActiveWorkspace
+Sets the resulting workspace as the active workspace
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -TFVCSession
 {{Fill TFVCSession Description}}
 

diff --git a/Docs/en-US/New-TFVCWorkspace.md b/Docs/en-US/New-TFVCWorkspace.md
@@ -12,7 +12,8 @@ schema: 2.0.0
 ## SYNTAX
 
 ```
-New-TFVCWorkspace [[-Name] <String>] [-TFVCSession <TFVCSession>] [-WhatIf] [-Confirm] [<CommonParameters>]
+New-TFVCWorkspace [[-Name] <String>] [-TFVCSession <TFVCSession>] [-SetActiveWorkspace] [-WhatIf] [-Confirm]
+ [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -42,6 +43,21 @@ Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
+### -SetActiveWorkspace
+{{Fill SetActiveWorkspace Description}}
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -TFVCSession
 Active TFVC Session
 

diff --git a/Docs/en-US/Remove-TFVCActiveWorkspace.md b/Docs/en-US/Remove-TFVCActiveWorkspace.md
@@ -0,0 +1,71 @@
+---
+external help file: TFVC-help.xml
+Module Name: TFVC
+online version:
+schema: 2.0.0
+---
+
+# Remove-TFVCActiveWorkspace
+
+## SYNOPSIS
+Makes the current active workspace nolonger active.
+
+## SYNTAX
+
+```
+Remove-TFVCActiveWorkspace [-WhatIf] [-Confirm] [<CommonParameters>]
+```
+
+## DESCRIPTION
+{{Fill in the Description}}
+
+## EXAMPLES
+
+### EXAMPLE 1
+```
+Remove-TFVCActiveWorkspace
+```
+
+## PARAMETERS
+
+### -Confirm
+Prompts you for confirmation before running the cmdlet.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: cf
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -WhatIf
+Shows what would happen if the cmdlet runs.
+The cmdlet is not run.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: wi
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### CommonParameters
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
+
+## INPUTS
+
+## OUTPUTS
+
+## NOTES
+
+## RELATED LINKS