List workflow runs
The List Workflow Runs tool provides an efficient way to retrieve and manage workflow runs for specific GitHub workflows within repositories. It allows users to filter and paginate workflow runs based on various parameters such as branch, event type, status, and actor, streamlining continuous integration and delivery processes.
Features
- Supports filtering workflow runs by actor (user who initiated the run) to track specific user activities.
- Enables retrieval of workflow runs filtered by branch name to monitor workflows across different development branches.
- Allows filtering by event types like push, pull request, release, and more to focus on relevant workflow executions.
- Supports pagination with customizable page number and results per page for handling large datasets efficiently.
- Provides filtering by workflow run status (queued, in progress, completed, etc.) to easily identify runs based on their execution state.
Benefits
- Enhances workflow monitoring and debugging by providing detailed and filtered access to workflow run data.
- Improves CI/CD pipeline transparency by enabling precise filtering based on events, actors, and branches.
- Saves time for developers and DevOps teams through quick access to relevant workflow run information.
- Facilitates efficient reporting and auditing of workflow executions for compliance and analysis.
- Supports scalable data retrieval with pagination controls to handle repositories with extensive workflow histories.
Description
List workflow runs for a specific workflow
Parameters
9 parameters
| Name | Type | Description |
|---|---|---|
| actor | string | Returns someone's workflow runs. Use the login for the user who created the workflow run. |
| branch | string | Returns workflow runs associated with a branch. Use the name of the branch. |
| event | enum | Returns workflow runs for a specific event type |
| ownerrequired | string | Repository owner |
| page | number | Page number for pagination (min 1) |
| perPage | number | Results per page for pagination (min 1, max 100) |
| reporequired | string | Repository name |
| status | enum | Returns workflow runs with the check run status |
| workflow_idrequired | string | The workflow ID or workflow file name |