Skip to main content
Module

x/kd_clients/mod.ts>WorkflowClient

Various HTTP clients for miscellaneous use.
KinsonDigital/kd_clients
Very Popular
Go to Latest
class WorkflowClient
extends GitHubClient
import { WorkflowClient } from "https://deno.land/x/kd_clients@v1.0.0-preview.9/mod.ts";

Provides a client for interacting with workflow runs.

Constructors

new
WorkflowClient(
ownerName: string,
repoName: string,
token?: string,
)

Initializes a new instance of the WorkflowClient class.

Properties

private
readonly
AnyBranch: AnyBranch

Methods

deleteWorkflow(workflowRun: WorkflowRunModel): Promise<void>

Deletes the given workflowRun in a repository with a name that matches the WorkflowClient.repoName.

executeWorkflow(
branchName: string,
workflowFileName: string,
inputs?: [string, string][],
): Promise<void>

Executes a workflow that matches the given workflowFileName on a branch that matches the given branchName for a repository that matches the WorkflowClient.repoName.

getAllWorkflowRuns(): Promise<WorkflowRunModel[]>

Gets a list of all the workflow runs for a repository with a name that matches the WorkflowClient.repoName.

getAllWorkflowRunsByTitle(title: string): Promise<WorkflowRunModel[]>

Gets all workflow with the given title for a repository with a name that matches the WorkflowClient.repoName.

getCompletedWorkflowRuns(event: WorkflowEvent): Promise<WorkflowRunModel[]>

Gets all completed workflow runs that match the given event, for a repository with a name that matches the WorkflowClient.repoName.

getCompletedWorkflowRunsByBranch(branch: string, event: WorkflowEvent): Promise<WorkflowRunModel[]>

Gets all completed workflow runs for the given branch, with the given event, for a repository with a name that matches the WorkflowClient.repoName.

getFailedWorkflowRuns(event: WorkflowEvent): Promise<WorkflowRunModel[]>

Gets all failed workflow runs that match the given event, for a repository with a name that matches the WorkflowClient.repoName.

getFailedWorkflowRunsByBranch(branch: string, event: WorkflowEvent): Promise<WorkflowRunModel[]>

Gets all failed workflow runs for the given branch, with the given event, for a repository with a name that matches the WorkflowClient.repoName. that matches the given trigger event.

getPullRequestWorkflowRuns(): Promise<WorkflowRunModel[]>

Gets all of the workflow runs for pull requests for a repository with a name that matches the WorkflowClient.repoName.

getWorkflowRunByTitle(title: string): Promise<WorkflowRunModel>

Gets the first workflow with the given title for a repository with a name that matches the WorkflowClient.repoName.

getWorkflowRuns(
branch: string | null | AnyBranch,
event: WorkflowEvent,
status: WorkflowRunStatus,
page?,
qtyPerPage?,
): Promise<[WorkflowRunModel[], Response]>

Gets all workflow runs for the given branch, with the given event and status, for a repository with a name that matches the WorkflowClient.repoName.

getWorkflowRunsBetweenDates(startDate: Date, endDate: Date): Promise<WorkflowRunModel[]>

Gets all workflow runs between the given startDate and endDate for a repository with a name that matches the WorkflowClient.repoName.

getWorkflowRunsForPR(prNumber: number): Promise<WorkflowRunModel[]>

Gets all workflow runs for a pull request with a number that matches the given prNumber, for a repository with a name that matches the WorkflowClient.repoName.