Class GitHubActionsApi

Implements GitHub Actions operations.

Inheritance

object

GitHubActionsApi

Namespace: Neon.Deployment

Assembly: Neon.Deployment.dll

Syntax

public class GitHubActionsApi

Methods

DeleteRuns(string, string, TimeSpan)

Deletes workflow runs from a GitHub repo.

note

Only completed runs will be deleted.

Declaration

public int DeleteRuns(string repo, string workflowName = null, TimeSpan maxAge = default)

Parameters

Type	Name	Description
string	repo	Identifies the target repository.
string	workflowName	Optionally specifies the workflow whose runs are to be deleted otherwise runs from all workflows in the repo will be deleted.
TimeSpan	maxAge	Optionally specifies the age at which workflow runs are to be deleted. This defaults to deleting all runs.

Returns

Type	Description
int	The number of runs deleted.

DeleteRunsAsync(string, string, TimeSpan)

Deletes workflow runs from a GitHub repo.

note

Only completed runs will be deleted.

Declaration

public Task<int> DeleteRunsAsync(string repo, string workflowName = null, TimeSpan maxAge = default)

Parameters

Type	Name	Description
string	repo	Identifies the target repository.
string	workflowName	Optionally specifies the workflow whose runs are to be deleted otherwise runs from all workflows in the repo will be deleted.
TimeSpan	maxAge	Optionally specifies the maximum age for retained workflow runs. This defaults to Zero which deletes all runs.

Returns

Type	Description
Task<int>	The number of runs deleted.