Skip to content

Commit

Permalink
Added work item tag cmdlets to Get, Remove and Update, also fixed typ…
Browse files Browse the repository at this point in the history
…os and casing (#418)

* ✏️ fixed casing and minor typos
* Added work item tag cmdlets
* Corrected changelog links from 'DarqueWarrior' to 'MethodsAndPractices' org

Co-authored-by: Sander <[email protected]>
Co-authored-by: Sebastian Schütze <[email protected]>
  • Loading branch information
3 people authored Jan 11, 2022
1 parent 544f2b2 commit f2772aa
Show file tree
Hide file tree
Showing 25 changed files with 602 additions and 128 deletions.
73 changes: 73 additions & 0 deletions .docs/Get-VSTeamWorkItemTag.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
<!-- #include "./common/header.md" -->

# Get-VSTeamWorkItemTag

## SYNOPSIS

<!-- #include "./synopsis/Get-VSTeamWorkItemTag.md" -->

## SYNTAX

## DESCRIPTION

Returns a list of work item tags in a project.

A single tag can be returned by providing the tag name or id.

## EXAMPLES

### Example 1

```powershell
Get-VSTeamWorkItemTag
```

This will return a list of all the work item tags within the current project

### Example 2

```powershell
Get-VSTeamWorkItemTag -TagId my-tag
```

This will return a specific work item tag

### Example 3

```powershell
Get-VSTeamWorkItemTag -TagName my-tag
```

This will return a specific work item tag

## PARAMETERS

<!-- #include "./params/projectName.md" -->

### NameOrTagId

Name or ID of the tag to return

```yaml
Type: String
Required: True
Position: named
Aliases: TagName, TagId
Parameter Sets: ByIdentifier
```
## INPUTS
## OUTPUTS
## NOTES
<!-- #include "./common/prerequisites.md" -->
## RELATED LINKS
<!-- #include "./common/related.md" -->
[Update-VSTeamWorkItemTag](Update-VSTeamWorkItemTag.md)
[Remove-VSTeamWorkItemTag](Remove-VSTeamWorkItemTag.md)
55 changes: 55 additions & 0 deletions .docs/Remove-VSTeamWorkItemTag.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
<!-- #include "./common/header.md" -->

# Remove-VSTeamWorkItemTag

## SYNOPSIS

<!-- #include "./synopsis/Get-VSTeamWorkItemTag.md" -->

## SYNTAX

## DESCRIPTION

Removes a work item tag.

## EXAMPLES

### Example 1

```powershell
Remove-VSTeamWorkItemTag -TagName
```

This will remove a specific work item tag within the current project

## PARAMETERS

<!-- #include "./params/projectName.md" -->

### NameOrTagId

Name or ID of the tag to return

```yaml
Type: String
Required: True
Position: named
Aliases: TagName, TagId
Parameter Sets: ByIdentifier
```
## INPUTS
## OUTPUTS
## NOTES
<!-- #include "./common/prerequisites.md" -->
## RELATED LINKS
<!-- #include "./common/related.md" -->
[Get-VSTeamWorkItemTag](Get-VSTeamWorkItemTag.md)
[Remove-VSTeamWorkItemTag](Remove-VSTeamWorkItemTag.md)
55 changes: 55 additions & 0 deletions .docs/Update-VSTeamWorkItemTag.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
<!-- #include "./common/header.md" -->

# Update-VSTeamWorkItemTag

## SYNOPSIS

<!-- #include "./synopsis/Get-VSTeamWorkItemTag.md" -->

## SYNTAX

## DESCRIPTION

Updates a work item tag.

## EXAMPLES

### Example 1

```powershell
Update-VSTeamWorkItemTag -TagName
```

This will update a specific work item tag within the current project

## PARAMETERS

<!-- #include "./params/projectName.md" -->

### NameOrTagId

Name or ID of the tag to return

```yaml
Type: String
Required: True
Position: named
Aliases: TagName, TagId
Parameter Sets: ByIdentifier
```
## INPUTS
## OUTPUTS
## NOTES
<!-- #include "./common/prerequisites.md" -->
## RELATED LINKS
<!-- #include "./common/related.md" -->
[Get-VSTeamWorkItemTag](Get-VSTeamWorkItemTag.md)
[Remove-VSTeamWorkItemTag](Remove-VSTeamWorkItemTag.md)
2 changes: 1 addition & 1 deletion .docs/common/prerequisites.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Prerequisites:

Set the account and version that all calls will use with Set-VSTeamAccount. If you do not set the version it default to 3.0, TFS2017. Using the default could limit API functionality.
Set the account and version that all calls will use with Set-VSTeamAccount. If you do not set the version it will default to 3.0, TFS2017. Using the default could limit API functionality.

You can check what version of the API that will be called with Get-VSTeamAPIVersion, or Get-VSTeamInfo.

Expand Down
2 changes: 1 addition & 1 deletion .docs/params/version.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Specifies the version to use. The acceptable values for this parameter are:
- VSTS
- AzD

If you are on AzD it will default to Azd otherwise it will default to TFS2017.
If you are on AzD it will default to AzD otherwise it will default to TFS2017.

```yaml
Type: String
Expand Down
1 change: 1 addition & 0 deletions .docs/synopsis/Get-VSTeamWorkItemTag.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Gets a work item tag
1 change: 1 addition & 0 deletions .docs/synopsis/Remove-VSTeamWorkItemTag.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Removes a work item tag
1 change: 1 addition & 0 deletions .docs/synopsis/Update-VSTeamWorkItemTag.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Updates a work item tag
Loading

0 comments on commit f2772aa

Please sign in to comment.