Remove-GitHubWorkflowRun¶
SYNOPSIS¶
Delete a workflow run
SYNTAX¶
Remove-GitHubWorkflowRun [[-Owner] <String>] [[-Repo] <String>] [-RunID] <String>
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION¶
Delete a specific workflow run.
Anyone with write 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:write permission to use
this endpoint.
EXAMPLES¶
EXAMPLE 1¶
Remove-GitHubWorkflowRun -Owner 'octocat' -Repo 'Hello-World' -ID 123456789
Deletes the workflow run with the ID 123456789 from the 'Hello-World' repository owned by 'octocat'
PARAMETERS¶
-Owner¶
The account owner of the repository. The name is not case sensitive.
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¶
The name of the repository without the .git extension. The name is not case sensitive.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: (Get-GitHubContextSetting -Name Repo)
Accept pipeline input: False
Accept wildcard characters: False
-RunID¶
The unique identifier of the workflow run.
Type: String
Parameter Sets: (All)
Aliases: ID, run_id
Required: True
Position: 3
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-WhatIf¶
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm¶
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
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.