Get Workflow Run

Determine the latest workflow run for a given workflow file and commit SHA.

Example

---
jobs:
  test:
    # These permissions are needed to:
    # - Get the workflow run: https://github.com/beacon-biosignals/get-workflow-run#permissions
    permissions:
      actions: read
    runs-on: ubuntu-latest
    steps:
      - uses: beacon-biosignals/get-workflow-run@v1
        id: workflow
        with:
          workflow-file: ci.yaml
          commit: ${{ github.event.pull_request.head.sha || github.sha }}
      - name: Show run details
        run: |
          echo "${{ toJSON(steps.workflow.outputs) }}"

Inputs

Name	Description	Required	Example
workflow-file	The GitHub Actions workflow file name to target.	Yes	ci.yaml
commit-sha	The Git commit SHA used in the workflow run.	Yes	23202e68ee664c345e985910770b7b9b873acfac
status	Filter by the workflow run status. Possible status values can be anything allowed by this API call and any. Defaults to any.	No	any, completed, skipped
repository	The repository containing the workflow run.	No	${{ github.token }}
token	The GitHub token used to authenticate with the GitHub API. Need when attempting to access other repositories.	No	${{ github.token }}

Outputs

Name	Description	Example
workflow-id	The GitHub API ID of the targeted workflow.	96660010
run-id	The workflow run ID as used by the GitHub API.	11958836222
run-attempt	The workflow run attempt.	1

Permissions

The following job permissions are required to run this action:

permissions:
  actions: read