On GitHub workflow run started

onGitHubWorkflowRunStarted maps GitHub’s "in_progress" action to a semantic started event.

automations/watch-started-github-workflows.automation.ts

import { automation } from "automate.ax"
import { onGitHubWorkflowRunStarted } from "automate.ax/github"

export default automation("Watch started GitHub workflows", () => {
  const event = onGitHubWorkflowRunStarted()
  event.transform(({ workflow_run }) => ({
    branch: workflow_run.head_branch,
    runId: workflow_run.id,
  }))
})

Optional static account defaults to the project binding. Returns Signal<GitHubWorkflowRunStartedEvent> with action: "in_progress" and the complete typed workflow-run payload. The installation needs Actions read permission.

Get started

Concepts

Reference

On GitHub workflow run started