Struct octocrab::workflows::WorkflowsHandler

pub struct WorkflowsHandler<'octo> { /* private fields */ }

Implementations

impl<'octo> WorkflowsHandler<'octo>

Handler for GitHub’s workflows API for actions.

Created with Octocrab::workflows.

pub fn list(&self) -> ListWorkflowsBuilder<'_, '_>

List workflow definitions in the repository.

let issue = octocrab.workflows("owner", "repo")
    .list()
    // Optional Parameters
    .per_page(100)
    .page(1u8)
    // Send the request
    .send()
    .await?;

pub async fn get(&self, run_id: RunId) -> Result<Run>

pub fn list_runs( &self, workflow_file_or_id: impl Into<String> ) -> ListRunsBuilder<'_, '_>

List runs in the specified workflow. workflow_file_or_id can be either file name or numeric expression.

let issue = octocrab.workflows("owner", "repo")
    .list_runs("ci.yml")
    // Optional Parameters
    .actor("octocat")
    .branch("master")
    .event("push")
    .status("success")
    .per_page(100)
    .page(1u8)
    // Send the request
    .send()
    .await?;

pub fn list_all_runs(&self) -> ListRunsBuilder<'_, '_>

List runs for the specified owner and repository.

let octocrab = octocrab::Octocrab::default();

let runs = octocrab.workflows("owner", "repo")
    .list_all_runs()
    // Optional Parameters
    .actor("octocat")
    .branch("master")
    .event("pull_request")
    .status("success")
    .per_page(100)
    .page(1u8)
    // Send the request
    .send()
    .await?;

pub fn list_jobs(&self, run_id: RunId) -> ListJobsBuilder<'_, '_>

List job results in the specified run.

use octocrab::params::workflows::Filter;

let issue = octocrab.workflows("owner", "repo")
    .list_jobs(1234u64.into())
    // Optional Parameters
    .per_page(100)
    .page(1u8)
    .filter(Filter::All)
    // Send the request
    .send()
    .await?;