Skip to content

Commit 1f8bdaf

Browse files
committed
feat: Updated the naming convention and update .gitignore
1 parent e54dba5 commit 1f8bdaf

File tree

3 files changed

+19
-9
lines changed

3 files changed

+19
-9
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
# Don't check in the Output dir
22
Output/
33
site/
4+
.vs

AzureDevOpsPowerShell/Public/Api/Pipelines/Runs/Get-PipelineRun.ps1 renamed to AzureDevOpsPowerShell/Public/Api/Pipelines/Runs/Get-AzDoPipelineRun.ps1

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,25 @@
1-
function Get-PipelineRun {
1+
function Get-AzDoPipelineRun {
22
<#
33
.SYNOPSIS
44
Retrieves pipeline run information from Azure DevOps for a specified pipeline within a project.
5+
56
.DESCRIPTION
6-
The `Get-PipelineRun` function fetches details about one or more pipeline runs from an Azure DevOps project.
7+
The `Get-AzDoPipelineRun` function fetches details about one or more pipeline runs from an Azure DevOps project.
78
It requires the collection URI, project name, and pipeline ID. Optionally, specific run IDs can be provided
89
to filter the results. The function uses the `Invoke-AzDoRestMethod` cmdlet to make the REST API call to
910
Azure DevOps and returns the run details.
11+
1012
.EXAMPLE
1113
$getPipelineRunSplat = @{
1214
CollectionUri = "https://dev.azure.com/YourOrg"
1315
ProjectName = "YourProject"
1416
PipelineId = 123
1517
}
1618
17-
Get-PipelineRun @getPipelineRunSplat
19+
Get-AzDoPipelineRun @getPipelineRunSplat
20+
1821
Retrieves all runs for the specified pipeline in the given project.
22+
1923
.EXAMPLE
2024
$getPipelineRunSplat = @{
2125
CollectionUri = "https://dev.azure.com/YourOrg"
@@ -24,11 +28,13 @@ function Get-PipelineRun {
2428
RunId = 456
2529
}
2630
27-
Get-PipelineRun @getPipelineRunSplat
31+
Get-AzDoPipelineRun @getPipelineRunSplat
2832
2933
Retrieves the details of the specified run (with ID 456) for the given pipeline.
34+
3035
.OUTPUTS
3136
System.Management.Automation.PSCustomObject
37+
3238
#>
3339
[CmdletBinding(SupportsShouldProcess)]
3440
param (

AzureDevOpsPowerShell/Public/Api/Pipelines/Runs/New-PipelineRun.ps1 renamed to AzureDevOpsPowerShell/Public/Api/Pipelines/Runs/New-AzDoPipelineRun.ps1

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
1-
function New-PipelineRun {
1+
function New-AzDoPipelineRun {
22
<#
33
.SYNOPSIS
44
Initiates a new run of an Azure DevOps pipeline.
5+
56
.DESCRIPTION
6-
The New-PipelineRun function starts a new run for a specified Azure DevOps pipeline.
7+
The New-AzDoPipelineRun function starts a new run for a specified Azure DevOps pipeline.
78
It supports various parameters to customize the pipeline run, including the collection URI, project name, pipeline ID, branch, parameters, preview run flag, and stages to skip.
89
This function leverages the Azure DevOps REST API to trigger the pipeline run.
10+
911
.EXAMPLE
1012
$newPipelineRunSplat = @{
1113
CollectionUri = "https://dev.azure.com/organization"
@@ -14,8 +16,9 @@ function New-PipelineRun {
1416
StagesToSkip = @("Stage1", "Stage2")
1517
}
1618
17-
New-PipelineRun @newPipelineRunSplat
19+
New-AzDoPipelineRun @newPipelineRunSplat
1820
This command initiates a new run of the pipeline with ID 123 in the "SampleProject" project.
21+
1922
.EXAMPLE
2023
$newPipelineRunSplat = @{
2124
CollectionUri = "https://dev.azure.com/organization"
@@ -25,13 +28,13 @@ function New-PipelineRun {
2528
Parameters = @{param1 = "value1"; param2 = "value2"}
2629
}
2730
28-
New-PipelineRun @newPipelineRunSplat
31+
New-AzDoPipelineRun @newPipelineRunSplat
2932
This command initiates a new run of the pipeline with ID 123 in the "SampleProject" project, targeting the "dev" branch.
33+
3034
.OUTPUTS
3135
System.Management.Automation.PSCustomObject
3236
3337
Returns the response from the Azure DevOps REST API, which includes details of the pipeline run.
34-
.NOTES
3538
#>
3639
[CmdletBinding(SupportsShouldProcess)]
3740
param (

0 commit comments

Comments
 (0)