Get-GitHubWorkflowRun

SYNOPSIS

List workflow runs for a repository or a workflow

SYNTAX

__AllParameterSets (Default)

Get-GitHubWorkflowRun -Owner <String> -Repo <String> [-Actor <String>] [-Branch <String>] [-Event <String>]
 [-Status <String>] [-Created <DateTime>] [-ExcludePullRequests] [-CheckSuiteID <Int32>] [-HeadSHA <String>]
 [-PerPage <Int32>] [-Context <Object>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

ByID

Get-GitHubWorkflowRun -Owner <String> -Repo <String> -ID <String> [-Actor <String>] [-Branch <String>]
 [-Event <String>] [-Status <String>] [-Created <DateTime>] [-ExcludePullRequests] [-CheckSuiteID <Int32>]
 [-HeadSHA <String>] [-PerPage <Int32>] [-Context <Object>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

ByName

Get-GitHubWorkflowRun -Owner <String> -Repo <String> -Name <String> [-Actor <String>] [-Branch <String>]
 [-Event <String>] [-Status <String>] [-Created <DateTime>] [-ExcludePullRequests] [-CheckSuiteID <Int32>]
 [-HeadSHA <String>] [-PerPage <Int32>] [-Context <Object>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION

Lists all workflow runs for a repository or a workflow. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters. Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository. This endpoint will return up to 1,000 results for each search when using the following parameters: actor, branch, check_suite_id, created, event, head_sha, status.

EXAMPLES

EXAMPLE 1

Get-GitHubWorkflowRun -Owner 'owner' -Repo 'repo'

Lists all workflow runs for a repository.

EXAMPLE 2

Get-GitHubWorkflowRun -Owner 'owner' -Repo 'repo' -Actor 'octocat' -Branch 'main' -Event 'push' -Status 'success'

Lists all workflow runs for a repository with the specified actor, branch, event, and status.

EXAMPLE 3

Get-GitHubWorkflowRun -Owner 'octocat' -Repo 'Hello-World' -ID '42'

Gets all workflow runs for the workflow with the ID 42 in the repository Hello-World owned by octocat.

EXAMPLE 4

Get-GitHubWorkflowRun -Owner 'octocat' -Repo 'Hello-World' -Name 'nightly.yml' -Actor 'octocat' -Branch 'main' -Event 'push' -Status 'success'

Gets all workflow runs for the workflow with the name nightly.yml in the repository Hello-World owned by octocat that were triggered by the user octocat on the branch main and have the status success.

PARAMETERS

-Owner

The account owner of the repository. The name is not case sensitive.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Repo

The name of the repository. The name is not case sensitive.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ID

The ID of the workflow. You can also pass the workflow filename as a string.

Type: String
Parameter Sets: ByID
Aliases: workflow_id, WorkflowID

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

The name of the workflow.

Type: String
Parameter Sets: ByName
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Actor

Returns someone's workflow runs. Use the login for the user who created the push associated with the check suite or workflow run.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Branch

Returns workflow runs associated with a branch. Use the name of the branch of the push.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Event

Returns workflow run triggered by the event you specify. For example, push, pull_request or issue. For more information, see "Events that trigger workflows."

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Status

Returns workflow runs with the check run status or conclusion that you specify. For example, a conclusion can be success or a status can be in_progress. Only GitHub Actions can set a status of waiting, pending, or requested. Can be one of: completed, action_required, cancelled, failure, neutral, skipped, stale, success, timed_out, in_progress, queued, requested, waiting, pending.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Created

Returns workflow runs created within the given date-time range. For more information on the syntax, see "Understanding the search syntax."

Type: DateTime
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ExcludePullRequests

If true pull requests are omitted from the response (empty array).

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-CheckSuiteID

Returns workflow runs with the check_suite_id that you specify.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-HeadSHA

Only returns workflow runs that are associated with the specified head_sha.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
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: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Context

The context to run the command in. Used to get the details for the API call. Can be either a string or a GitHubContext object.

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: (Get-GitHubContext)
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.

INPUTS

OUTPUTS

NOTES

List workflow runs for a workflow List workflow runs for a repository

RELATED LINKS