On GitHub push

onGitHubPush emits GitHub repository push deliveries for branches and tags.

automations/watch-github-pushes.automation.ts

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

export default automation("Watch GitHub pushes", () => {
  const event = onGitHubPush()
  event.transform(({ after, before, ref, repository }) => ({
    after,
    before,
    ref,
    repository: repository.full_name,
  }))
})

Optional static account defaults to the project’s GitHub App installation binding and cannot be a signal. Returns Signal<GitHubPushEvent> with ref, before, after, commits, pusher, repository, sender, installation, and created/deleted/forced flags. The installation needs Contents read permission and receives pushes only from accessible repositories. GitHub can omit individual commit details for unusually large pushes while retaining the range metadata.

⌘I

Get started

Concepts

Reference