Get-GitHubWorkflow¶
SYNOPSIS¶
Lists the workflows in a repository.
SYNTAX¶
Get-GitHubWorkflow [[-Owner] <String>] [[-Repo] <String>] [[-PerPage] <Int32>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION¶
Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
EXAMPLES¶
EXAMPLE 1¶
Get-GitHubWorkflow -Owner 'octocat' -Repo 'hello-world'
Gets all workflows in the 'octocat/hello-world' repository.
EXAMPLE 2¶
Get-GitHubWorkflow -Owner 'octocat' -Repo 'hello-world' -Name 'hello-world.yml'
Gets the 'hello-world.yml' workflow in the 'octocat/hello-world' repository.
PARAMETERS¶
-Owner¶
{{ Fill Owner Description }}
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: (Get-GitHubContextSetting -Name Owner)
Accept pipeline input: False
Accept wildcard characters: False
-Repo¶
{{ Fill Repo Description }}
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: (Get-GitHubContextSetting -Name Repo)
Accept pipeline input: False
Accept wildcard characters: False
-PerPage¶
The number of results per page (max 100).
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: 30
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction¶
{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
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.