Skip to content

Commit

Permalink
tip: Add tip for the VSTeam module for Azure DevOps
Browse files Browse the repository at this point in the history
  • Loading branch information
deadlydog committed Dec 27, 2024
1 parent 74203ca commit 44a69db
Show file tree
Hide file tree
Showing 2 changed files with 64 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
$tip = [tiPS.PowerShellTip]::new()
$tip.CreatedDate = [DateTime]::Parse('2024-12-26')
$tip.Title = 'Automate Azure DevOps tasks with VSTeam'
$tip.TipText = @'
Many organizations use Azure DevOps as their application lifecycle management (ALM) tool. VSTeam is a PowerShell module that provides cmdlets for many Azure DevOps tasks, which can be easier than calling the Azure DevOps APIs directly. It's a great way to simplify and automate many Azure DevOps tasks, such as retrieving and updating work items, teams, git repos, pull requests, release definitions, and more.
'@
$tip.Example = @'
# List all commits in the demo project for a specific repository.
Get-VSTeamGitCommit -ProjectName demo -RepositoryId 118C262F-0D4C-4B76-BD9B-7DD8CA12F196
# List of all agent pools.
Get-VSTeamPool
# Gets work items with IDs 47 and 48.
Get-VSTeamWorkItem -Id 47,48
# Updates the title of work item 1.
Update-VSTeamWorkItem -WorkItemId 1 -Title "Updated Work Item Title"
'@
$tip.Urls = @(
'https://methodsandpractices.github.io/vsteam-docs/'
'https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/'
'https://github.com/MethodsAndPractices/vsteam-docs'
)
$tip.Category = [tiPS.TipCategory]::Module # Community, Editor, Module, NativeCmdlet, Performance, Security, Syntax, Terminal, or Other.
$tip.Author = 'Daniel Schroeder (deadlydog)' # Optional. Get credit for your tip. e.g. 'Daniel Schroeder (deadlydog)'.
#$tip.ExpiryDate = [DateTime]::Parse('2024-10-30') # Optional. If the tip is not relevant after a certain date, set the expiration date. e.g. Announcing a conference or event.

# Category meanings:
# Community: Social events and community resources. e.g. PowerShell Summit, podcasts, etc.
# Editor: Editor tips and extensions. e.g. VSCode, ISE, etc.
# Module: Modules and module tips. e.g. PSScriptAnalyzer, Pester, etc.
# NativeCmdlet: Native cmdlet tips. e.g. Get-Process, Get-ChildItem, Get-Content, etc.
# Performance: Tips to improve runtime performance. e.g. foreach vs ForEach-Object, ForEach-Object -Parallel, etc.
# Security: Security tips. e.g. ExecutionPolicy, Constrained Language Mode, passwords, etc.
# Syntax: Syntax tips. e.g. splatting, pipeline, etc.
# Terminal: Terminal shortcuts and tips. e.g. PSReadLine, Windows Terminal, ConEmu, etc.
# Other: Tips that don't fit into any of the other categories.
26 changes: 26 additions & 0 deletions src/tiPS/PowerShellTips.json
Original file line number Diff line number Diff line change
Expand Up @@ -828,5 +828,31 @@
"Category": 6,
"ExpiryDate": "9999-12-31T23:59:59.9999999",
"Author": "Daniel Schroeder (deadlydog)"
},
{
"CreatedDate": "2024-12-26T00:00:00",
"Title": "Attend the PowerShell + DevOps Global Summit",
"TipText": "The PowerShell + DevOps Global Summit happens every year somewhere in the United States, usually in April. The conference is a great place to learn about PowerShell and DevOps, and to meet and network with other people in the PowerShell community, including Microsoft MVPs and the Microsoft PowerShell team. Discuss the latest trends, best practices, and tips and tricks with other PowerShell enthusiasts!\r\n\r\nWant to speak at the conference? The call for speakers is typically open during October and November, where you can submit your session ideas for consideration. Speakers often receive a free ticket to the conference and sometimes additional reimbursement. It's a great opportunity to share your knowledge with the community.\r\n\r\nCheck the website for the latest information on the conference dates, location, sessions, and registration details.",
"Example": "Start-Process https://www.powershellsummit.org",
"Urls": [
"https://www.powershellsummit.org"
],
"Category": 0,
"ExpiryDate": "9999-12-31T23:59:59.9999999",
"Author": "Daniel Schroeder (deadlydog)"
},
{
"CreatedDate": "2024-12-26T00:00:00",
"Title": "Automate Azure DevOps tasks with VSTeam",
"TipText": "Many organizations use Azure DevOps as their application lifecycle management (ALM) tool. VSTeam is a PowerShell module that provides cmdlets for many Azure DevOps tasks, which can be easier than calling the Azure DevOps APIs directly. It's a great way to simplify and automate many Azure DevOps tasks, such as retrieving and updating work items, teams, git repos, pull requests, release definitions, and more.",
"Example": "# List all commits in the demo project for a specific repository.\r\nGet-VSTeamGitCommit -ProjectName demo -RepositoryId 118C262F-0D4C-4B76-BD9B-7DD8CA12F196\r\n\r\n# List of all agent pools.\r\nGet-VSTeamPool\r\n\r\n# Gets work items with IDs 47 and 48.\r\nGet-VSTeamWorkItem -Id 47,48\r\n\r\n# Updates the title of work item 1.\r\nUpdate-VSTeamWorkItem -WorkItemId 1 -Title \"Updated Work Item Title\"",
"Urls": [
"https://methodsandpractices.github.io/vsteam-docs/",
"https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/",
"https://github.com/MethodsAndPractices/vsteam-docs"
],
"Category": 2,
"ExpiryDate": "9999-12-31T23:59:59.9999999",
"Author": "Daniel Schroeder (deadlydog)"
}
]

0 comments on commit 44a69db

Please sign in to comment.