Struct WorkflowsClient 

pub struct WorkflowsClient { /* private fields */ }

Domain client for GitHub Actions workflow and run operations.

Obtained via InstallationClient::workflows(). Cheap to clone (Arc-backed).

See docs/specs/interfaces/additional-operations.md

Implementations

impl WorkflowsClient

pub async fn list( &self, owner: &str, repo: &str, ) -> Result<Vec<Workflow>, ApiError>

List workflows in a repository.

Retrieves all GitHub Actions workflows for a repository.

Arguments

• owner - Repository owner
• repo - Repository name

Returns

Returns vector of workflows.

Errors

• ApiError::NotFound - Repository does not exist
• ApiError::AuthorizationFailed - Insufficient permissions

Example

let workflows = client.list("owner", "repo").await?;
for workflow in workflows {
    println!("Workflow: {} ({})", workflow.name, workflow.state);
}

pub async fn get( &self, owner: &str, repo: &str, workflow_id: u64, ) -> Result<Workflow, ApiError>

Get a specific workflow by ID.

Retrieves details about a single workflow.

Arguments

• owner - Repository owner
• repo - Repository name
• workflow_id - Workflow ID

Returns

Returns the Workflow with the specified ID.

Errors

• ApiError::NotFound - Workflow does not exist
• ApiError::AuthorizationFailed - Insufficient permissions

Example

let workflow = client.get("owner", "repo", 123456).await?;
println!("Workflow: {} at {}", workflow.name, workflow.path);

pub async fn trigger( &self, owner: &str, repo: &str, workflow_id: u64, request: TriggerWorkflowRequest, ) -> Result<(), ApiError>

Trigger a workflow run.

Manually triggers a workflow run using workflow_dispatch event.

Arguments

• owner - Repository owner
• repo - Repository name
• workflow_id - Workflow ID
• request - Trigger parameters (ref and optional inputs)

Returns

Returns Ok(()) on successful trigger.

Errors

• ApiError::NotFound - Workflow does not exist
• ApiError::InvalidRequest - Workflow not configured for manual dispatch
• ApiError::AuthorizationFailed - Insufficient permissions

Example

let request = TriggerWorkflowRequest {
    git_ref: "main".to_string(),
    inputs: None,
};
client.trigger("owner", "repo", 123456, request).await?;
println!("Workflow triggered");

pub async fn list_runs( &self, owner: &str, repo: &str, workflow_id: u64, ) -> Result<Vec<WorkflowRun>, ApiError>

List workflow runs for a workflow.

Retrieves workflow runs for a specific workflow.

Arguments

• owner - Repository owner
• repo - Repository name
• workflow_id - Workflow ID

Returns

Returns vector of workflow runs.

Errors

• ApiError::NotFound - Workflow does not exist
• ApiError::AuthorizationFailed - Insufficient permissions

Example

let runs = client.list_runs("owner", "repo", 123456).await?;
for run in runs {
    println!("Run #{}: {} ({})", run.run_number, run.status, run.conclusion.unwrap_or_default());
}

pub async fn get_run( &self, owner: &str, repo: &str, run_id: u64, ) -> Result<WorkflowRun, ApiError>

Get a specific workflow run by ID.

Retrieves details about a single workflow run.

Arguments

• owner - Repository owner
• repo - Repository name
• run_id - Workflow run ID

Returns

Returns the WorkflowRun with the specified ID.

Errors

• ApiError::NotFound - Workflow run does not exist
• ApiError::AuthorizationFailed - Insufficient permissions

Example

let run = client.get_run("owner", "repo", 987654).await?;
println!("Run #{}: {}", run.run_number, run.status);

pub async fn cancel_run( &self, owner: &str, repo: &str, run_id: u64, ) -> Result<(), ApiError>

Cancel a workflow run.

Cancels a workflow run that is in progress.

Arguments

• owner - Repository owner
• repo - Repository name
• run_id - Workflow run ID

Returns

Returns Ok(()) on successful cancellation.

Errors

• ApiError::NotFound - Workflow run does not exist
• ApiError::InvalidRequest - Workflow run cannot be cancelled
• ApiError::AuthorizationFailed - Insufficient permissions

Example

client.cancel_run("owner", "repo", 987654).await?;
println!("Workflow run cancelled");

pub async fn rerun_run( &self, owner: &str, repo: &str, run_id: u64, ) -> Result<(), ApiError>

Re-run a workflow run.

Re-runs a completed workflow run.

Arguments

• owner - Repository owner
• repo - Repository name
• run_id - Workflow run ID

Returns

Returns Ok(()) on successful re-run trigger.

Errors

• ApiError::NotFound - Workflow run does not exist
• ApiError::InvalidRequest - Workflow run cannot be re-run
• ApiError::AuthorizationFailed - Insufficient permissions

Example

client.rerun_run("owner", "repo", 987654).await?;
println!("Workflow run re-triggered");

Trait Implementations

impl Clone for WorkflowsClient

fn clone(&self) -> WorkflowsClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WorkflowsClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.