> ## Documentation Index
> Fetch the complete documentation index at: https://docs.automate.ax/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Automate.ax automations are TypeScript programs.
> Use Bun for installation and command examples.
> Use Automate.ax for the product name and automate.ax for the package, CLI, and domain.
> Treat documented public APIs as current; do not invent transitional or deprecated names.

# GitHub

> Manage GitHub repositories, branches, pull requests, issues, releases, workflows, and checks, or react to GitHub App events.

## Exports

```ts theme={null}
import { github, githubAccount, getGitHubApi } from "automate.ax/github"
```

* `github` contains the packaged GitHub actions and triggers.
* `githubAccount("name")` selects a named GitHub connection.
* `getGitHubApi` creates the authenticated GitHub API helper for a custom account-backed action.

## Triggers

* [On GitHub check run event](/reference/integrations/github/triggers/on-check-run-event)
* [On GitHub check run created](/reference/integrations/github/triggers/on-check-run-created)
* [On GitHub check run rerequested](/reference/integrations/github/triggers/on-check-run-rerequested)
* [On GitHub check run requested action](/reference/integrations/github/triggers/on-check-run-requested-action)
* [On GitHub check run completed](/reference/integrations/github/triggers/on-check-run-completed)
* [On GitHub check run succeeded](/reference/integrations/github/triggers/on-check-run-succeeded)
* [On GitHub check run failed](/reference/integrations/github/triggers/on-check-run-failed)
* [On GitHub check run neutral](/reference/integrations/github/triggers/on-check-run-neutral)
* [On GitHub check run pending](/reference/integrations/github/triggers/on-check-run-pending)
* [On GitHub check run skipped](/reference/integrations/github/triggers/on-check-run-skipped)
* [On GitHub check run stale](/reference/integrations/github/triggers/on-check-run-stale)
* [On GitHub check run waiting](/reference/integrations/github/triggers/on-check-run-waiting)
* [On GitHub check run startup failed](/reference/integrations/github/triggers/on-check-run-startup-failed)
* [On GitHub check run cancelled](/reference/integrations/github/triggers/on-check-run-cancelled)
* [On GitHub check run timed out](/reference/integrations/github/triggers/on-check-run-timed-out)
* [On GitHub check run action required](/reference/integrations/github/triggers/on-check-run-action-required)
* [On GitHub check suite event](/reference/integrations/github/triggers/on-check-suite-event)
* [On GitHub check suite requested](/reference/integrations/github/triggers/on-check-suite-requested)
* [On GitHub check suite rerequested](/reference/integrations/github/triggers/on-check-suite-rerequested)
* [On GitHub check suite completed](/reference/integrations/github/triggers/on-check-suite-completed)
* [On GitHub check suite succeeded](/reference/integrations/github/triggers/on-check-suite-succeeded)
* [On GitHub check suite failed](/reference/integrations/github/triggers/on-check-suite-failed)
* [On GitHub check suite neutral](/reference/integrations/github/triggers/on-check-suite-neutral)
* [On GitHub check suite skipped](/reference/integrations/github/triggers/on-check-suite-skipped)
* [On GitHub check suite stale](/reference/integrations/github/triggers/on-check-suite-stale)
* [On GitHub check suite startup failed](/reference/integrations/github/triggers/on-check-suite-startup-failed)
* [On GitHub check suite cancelled](/reference/integrations/github/triggers/on-check-suite-cancelled)
* [On GitHub check suite timed out](/reference/integrations/github/triggers/on-check-suite-timed-out)
* [On GitHub check suite action required](/reference/integrations/github/triggers/on-check-suite-action-required)
* [On GitHub ref created](/reference/integrations/github/triggers/on-ref-created)
* [On GitHub branch created](/reference/integrations/github/triggers/on-branch-created)
* [On GitHub tag created](/reference/integrations/github/triggers/on-tag-created)
* [On GitHub ref deleted](/reference/integrations/github/triggers/on-ref-deleted)
* [On GitHub branch deleted](/reference/integrations/github/triggers/on-branch-deleted)
* [On GitHub tag deleted](/reference/integrations/github/triggers/on-tag-deleted)
* [On GitHub issue event](/reference/integrations/github/triggers/on-issue-event)
* [On GitHub issue assigned](/reference/integrations/github/triggers/on-issue-assigned)
* [On GitHub issue closed](/reference/integrations/github/triggers/on-issue-closed)
* [On GitHub issue deleted](/reference/integrations/github/triggers/on-issue-deleted)
* [On GitHub issue removed from milestone](/reference/integrations/github/triggers/on-issue-demilestoned)
* [On GitHub issue edited](/reference/integrations/github/triggers/on-issue-edited)
* [On GitHub issue field added](/reference/integrations/github/triggers/on-issue-field-added)
* [On GitHub issue field removed](/reference/integrations/github/triggers/on-issue-field-removed)
* [On GitHub issue labeled](/reference/integrations/github/triggers/on-issue-labeled)
* [On GitHub issue locked](/reference/integrations/github/triggers/on-issue-locked)
* [On GitHub issue added to milestone](/reference/integrations/github/triggers/on-issue-milestoned)
* [On GitHub issue opened](/reference/integrations/github/triggers/on-issue-opened)
* [On GitHub issue pinned](/reference/integrations/github/triggers/on-issue-pinned)
* [On GitHub issue reopened](/reference/integrations/github/triggers/on-issue-reopened)
* [On GitHub issue transferred](/reference/integrations/github/triggers/on-issue-transferred)
* [On GitHub issue typed](/reference/integrations/github/triggers/on-issue-typed)
* [On GitHub issue unassigned](/reference/integrations/github/triggers/on-issue-unassigned)
* [On GitHub issue unlabeled](/reference/integrations/github/triggers/on-issue-unlabeled)
* [On GitHub issue unlocked](/reference/integrations/github/triggers/on-issue-unlocked)
* [On GitHub issue unpinned](/reference/integrations/github/triggers/on-issue-unpinned)
* [On GitHub issue type removed](/reference/integrations/github/triggers/on-issue-untyped)
* [On GitHub pull request event](/reference/integrations/github/triggers/on-pull-request-event)
* [On GitHub pull request assigned](/reference/integrations/github/triggers/on-pull-request-assigned)
* [On GitHub pull request auto-merge disabled](/reference/integrations/github/triggers/on-pull-request-auto-merge-disabled)
* [On GitHub pull request auto-merge enabled](/reference/integrations/github/triggers/on-pull-request-auto-merge-enabled)
* [On GitHub pull request opened](/reference/integrations/github/triggers/on-pull-request-opened)
* [On GitHub pull request ready for review](/reference/integrations/github/triggers/on-pull-request-ready-for-review)
* [On GitHub pull request converted to draft](/reference/integrations/github/triggers/on-pull-request-converted-to-draft)
* [On GitHub pull request removed from milestone](/reference/integrations/github/triggers/on-pull-request-demilestoned)
* [On GitHub pull request left merge queue](/reference/integrations/github/triggers/on-pull-request-dequeued)
* [On GitHub pull request edited](/reference/integrations/github/triggers/on-pull-request-edited)
* [On GitHub pull request entered merge queue](/reference/integrations/github/triggers/on-pull-request-enqueued)
* [On GitHub pull request labeled](/reference/integrations/github/triggers/on-pull-request-labeled)
* [On GitHub pull request locked](/reference/integrations/github/triggers/on-pull-request-locked)
* [On GitHub pull request added to milestone](/reference/integrations/github/triggers/on-pull-request-milestoned)
* [On GitHub pull request reopened](/reference/integrations/github/triggers/on-pull-request-reopened)
* [On GitHub pull request review request removed](/reference/integrations/github/triggers/on-pull-request-review-request-removed)
* [On GitHub pull request review requested](/reference/integrations/github/triggers/on-pull-request-review-requested)
* [On GitHub pull request stacked](/reference/integrations/github/triggers/on-pull-request-stacked)
* [On GitHub pull request synchronized](/reference/integrations/github/triggers/on-pull-request-synchronized)
* [On GitHub pull request unassigned](/reference/integrations/github/triggers/on-pull-request-unassigned)
* [On GitHub pull request unlabeled](/reference/integrations/github/triggers/on-pull-request-unlabeled)
* [On GitHub pull request unlocked](/reference/integrations/github/triggers/on-pull-request-unlocked)
* [On GitHub pull request closed](/reference/integrations/github/triggers/on-pull-request-closed)
* [On GitHub pull request merged](/reference/integrations/github/triggers/on-pull-request-merged)
* [On GitHub pull request review event](/reference/integrations/github/triggers/on-pull-request-review-event)
* [On GitHub pull request review submitted](/reference/integrations/github/triggers/on-pull-request-review-submitted)
* [On GitHub pull request review approved](/reference/integrations/github/triggers/on-pull-request-review-approved)
* [On GitHub pull request review changes requested](/reference/integrations/github/triggers/on-pull-request-review-changes-requested)
* [On GitHub pull request review dismissed](/reference/integrations/github/triggers/on-pull-request-review-dismissed)
* [On GitHub pull request review edited](/reference/integrations/github/triggers/on-pull-request-review-edited)
* [On GitHub workflow run event](/reference/integrations/github/triggers/on-workflow-run-event)
* [On GitHub workflow run requested](/reference/integrations/github/triggers/on-workflow-run-requested)
* [On GitHub workflow run started](/reference/integrations/github/triggers/on-workflow-run-started)
* [On GitHub workflow run completed](/reference/integrations/github/triggers/on-workflow-run-completed)
* [On GitHub workflow run succeeded](/reference/integrations/github/triggers/on-workflow-run-succeeded)
* [On GitHub workflow run failed](/reference/integrations/github/triggers/on-workflow-run-failed)
* [On GitHub workflow run cancelled](/reference/integrations/github/triggers/on-workflow-run-cancelled)
* [On GitHub workflow run action required](/reference/integrations/github/triggers/on-workflow-run-action-required)
* [On GitHub workflow run neutral](/reference/integrations/github/triggers/on-workflow-run-neutral)
* [On GitHub workflow run skipped](/reference/integrations/github/triggers/on-workflow-run-skipped)
* [On GitHub workflow run stale](/reference/integrations/github/triggers/on-workflow-run-stale)
* [On GitHub workflow run startup failed](/reference/integrations/github/triggers/on-workflow-run-startup-failed)
* [On GitHub workflow run timed out](/reference/integrations/github/triggers/on-workflow-run-timed-out)
* [On GitHub push](/reference/integrations/github/triggers/on-push)
* [On GitHub release event](/reference/integrations/github/triggers/on-release-event)
* [On GitHub release created](/reference/integrations/github/triggers/on-release-created)
* [On GitHub release deleted](/reference/integrations/github/triggers/on-release-deleted)
* [On GitHub release edited](/reference/integrations/github/triggers/on-release-edited)
* [On GitHub release prereleased](/reference/integrations/github/triggers/on-release-prereleased)
* [On GitHub release published](/reference/integrations/github/triggers/on-release-published)
* [On GitHub release released](/reference/integrations/github/triggers/on-release-released)
* [On GitHub release unpublished](/reference/integrations/github/triggers/on-release-unpublished)
* [On GitHub issue comment event](/reference/integrations/github/triggers/on-issue-comment-event)
* [On GitHub issue comment created](/reference/integrations/github/triggers/on-issue-comment-created)
* [On GitHub issue comment edited](/reference/integrations/github/triggers/on-issue-comment-edited)
* [On GitHub issue comment deleted](/reference/integrations/github/triggers/on-issue-comment-deleted)
* [On GitHub issue comment pinned](/reference/integrations/github/triggers/on-issue-comment-pinned)
* [On GitHub issue comment unpinned](/reference/integrations/github/triggers/on-issue-comment-unpinned)
* [On GitHub pull request review comment event](/reference/integrations/github/triggers/on-pull-request-review-comment-event)
* [On GitHub pull request review comment created](/reference/integrations/github/triggers/on-pull-request-review-comment-created)
* [On GitHub pull request review comment edited](/reference/integrations/github/triggers/on-pull-request-review-comment-edited)
* [On GitHub pull request review comment deleted](/reference/integrations/github/triggers/on-pull-request-review-comment-deleted)
* [On GitHub workflow job event](/reference/integrations/github/triggers/on-workflow-job-event)
* [On GitHub workflow job queued](/reference/integrations/github/triggers/on-workflow-job-queued)
* [On GitHub workflow job started](/reference/integrations/github/triggers/on-workflow-job-started)
* [On GitHub workflow job waiting](/reference/integrations/github/triggers/on-workflow-job-waiting)
* [On GitHub workflow job completed](/reference/integrations/github/triggers/on-workflow-job-completed)
* [On GitHub workflow job succeeded](/reference/integrations/github/triggers/on-workflow-job-succeeded)
* [On GitHub workflow job failed](/reference/integrations/github/triggers/on-workflow-job-failed)
* [On GitHub workflow job cancelled](/reference/integrations/github/triggers/on-workflow-job-cancelled)
* [On GitHub workflow job timed out](/reference/integrations/github/triggers/on-workflow-job-timed-out)
* [On GitHub workflow job action required](/reference/integrations/github/triggers/on-workflow-job-action-required)
* [On GitHub workflow job neutral](/reference/integrations/github/triggers/on-workflow-job-neutral)
* [On GitHub workflow job skipped](/reference/integrations/github/triggers/on-workflow-job-skipped)
* [On GitHub workflow dispatch](/reference/integrations/github/triggers/on-workflow-dispatch)
* [On GitHub repository dispatch](/reference/integrations/github/triggers/on-repository-dispatch)
* [On GitHub commit comment event](/reference/integrations/github/triggers/on-commit-comment-event)
* [On GitHub commit comment created](/reference/integrations/github/triggers/on-commit-comment-created)
* [On GitHub issue dependencies event](/reference/integrations/github/triggers/on-issue-dependencies-event)
* [On GitHub issue dependency blocked by added](/reference/integrations/github/triggers/on-issue-dependency-blocked-by-added)
* [On GitHub issue dependency blocked by removed](/reference/integrations/github/triggers/on-issue-dependency-blocked-by-removed)
* [On GitHub issue dependency blocking added](/reference/integrations/github/triggers/on-issue-dependency-blocking-added)
* [On GitHub issue dependency blocking removed](/reference/integrations/github/triggers/on-issue-dependency-blocking-removed)
* [On GitHub sub issues event](/reference/integrations/github/triggers/on-sub-issues-event)
* [On GitHub parent issue added](/reference/integrations/github/triggers/on-parent-issue-added)
* [On GitHub parent issue removed](/reference/integrations/github/triggers/on-parent-issue-removed)
* [On GitHub sub issue added](/reference/integrations/github/triggers/on-sub-issue-added)
* [On GitHub sub issue removed](/reference/integrations/github/triggers/on-sub-issue-removed)
* [On GitHub pull request review thread event](/reference/integrations/github/triggers/on-pull-request-review-thread-event)
* [On GitHub pull request review thread resolved](/reference/integrations/github/triggers/on-pull-request-review-thread-resolved)
* [On GitHub pull request review thread unresolved](/reference/integrations/github/triggers/on-pull-request-review-thread-unresolved)
* [On GitHub deployment review event](/reference/integrations/github/triggers/on-deployment-review-event)
* [On GitHub deployment review approved](/reference/integrations/github/triggers/on-deployment-review-approved)
* [On GitHub deployment review rejected](/reference/integrations/github/triggers/on-deployment-review-rejected)
* [On GitHub deployment review requested](/reference/integrations/github/triggers/on-deployment-review-requested)
* [On GitHub deployment protection rule event](/reference/integrations/github/triggers/on-deployment-protection-rule-event)
* [On GitHub deployment protection rule requested](/reference/integrations/github/triggers/on-deployment-protection-rule-requested)
* [On GitHub merge group event](/reference/integrations/github/triggers/on-merge-group-event)
* [On GitHub merge group checks requested](/reference/integrations/github/triggers/on-merge-group-checks-requested)
* [On GitHub merge group destroyed](/reference/integrations/github/triggers/on-merge-group-destroyed)
* [On GitHub repository event](/reference/integrations/github/triggers/on-repository-event)
* [On GitHub repository archived](/reference/integrations/github/triggers/on-repository-archived)
* [On GitHub repository created](/reference/integrations/github/triggers/on-repository-created)
* [On GitHub repository deleted](/reference/integrations/github/triggers/on-repository-deleted)
* [On GitHub repository edited](/reference/integrations/github/triggers/on-repository-edited)
* [On GitHub repository privatized](/reference/integrations/github/triggers/on-repository-privatized)
* [On GitHub repository publicized](/reference/integrations/github/triggers/on-repository-publicized)
* [On GitHub repository renamed](/reference/integrations/github/triggers/on-repository-renamed)
* [On GitHub repository transferred](/reference/integrations/github/triggers/on-repository-transferred)
* [On GitHub repository unarchived](/reference/integrations/github/triggers/on-repository-unarchived)
* [On GitHub deployment created](/reference/integrations/github/triggers/on-deployment-created)
* [On GitHub deployment status event](/reference/integrations/github/triggers/on-deployment-status-event)
* [On GitHub deployment queued](/reference/integrations/github/triggers/on-deployment-queued)
* [On GitHub deployment started](/reference/integrations/github/triggers/on-deployment-started)
* [On GitHub deployment pending](/reference/integrations/github/triggers/on-deployment-pending)
* [On GitHub deployment succeeded](/reference/integrations/github/triggers/on-deployment-succeeded)
* [On GitHub deployment failed](/reference/integrations/github/triggers/on-deployment-failed)
* [On GitHub deployment errored](/reference/integrations/github/triggers/on-deployment-errored)
* [On GitHub status event](/reference/integrations/github/triggers/on-status-event)
* [On GitHub status pending](/reference/integrations/github/triggers/on-status-pending)
* [On GitHub status succeeded](/reference/integrations/github/triggers/on-status-succeeded)
* [On GitHub status failed](/reference/integrations/github/triggers/on-status-failed)
* [On GitHub status errored](/reference/integrations/github/triggers/on-status-errored)

## Actions

* [List GitHub repositories](/reference/integrations/github/actions/list-repositories)
* [Get GitHub repository](/reference/integrations/github/actions/get-repository)
* [Get GitHub repository content](/reference/integrations/github/actions/get-repository-content)
* [Create or update GitHub repository file](/reference/integrations/github/actions/create-or-update-repository-file)
* [Create or update GitHub workflow file](/reference/integrations/github/actions/create-or-update-workflow-file)
* [Delete GitHub repository file](/reference/integrations/github/actions/delete-repository-file)
* [Delete GitHub workflow file](/reference/integrations/github/actions/delete-workflow-file)
* [Dispatch GitHub repository event](/reference/integrations/github/actions/dispatch-repository-event)
* [List GitHub branches](/reference/integrations/github/actions/list-branches)
* [Get GitHub branch](/reference/integrations/github/actions/get-branch)
* [Create GitHub branch](/reference/integrations/github/actions/create-branch)
* [Delete GitHub branch](/reference/integrations/github/actions/delete-branch)
* [Get GitHub combined commit status](/reference/integrations/github/actions/get-combined-commit-status)
* [Create GitHub commit status](/reference/integrations/github/actions/create-commit-status)
* [Create GitHub check run](/reference/integrations/github/actions/create-check-run)
* [Update GitHub check run](/reference/integrations/github/actions/update-check-run)
* [List GitHub workflows](/reference/integrations/github/actions/list-workflows)
* [Get GitHub workflow](/reference/integrations/github/actions/get-workflow)
* [Dispatch GitHub workflow](/reference/integrations/github/actions/dispatch-workflow)
* [Enable GitHub workflow](/reference/integrations/github/actions/enable-workflow)
* [Disable GitHub workflow](/reference/integrations/github/actions/disable-workflow)
* [List GitHub workflow runs](/reference/integrations/github/actions/list-workflow-runs)
* [Get GitHub workflow run](/reference/integrations/github/actions/get-workflow-run)
* [List GitHub workflow run jobs](/reference/integrations/github/actions/list-workflow-run-jobs)
* [Cancel GitHub workflow run](/reference/integrations/github/actions/cancel-workflow-run)
* [Re-run GitHub workflow](/reference/integrations/github/actions/rerun-workflow)
* [Re-run failed GitHub workflow jobs](/reference/integrations/github/actions/rerun-failed-workflow-jobs)
* [Create GitHub issue comment](/reference/integrations/github/actions/create-issue-comment)
* [List GitHub issue comments](/reference/integrations/github/actions/list-issue-comments)
* [Get GitHub issue comment](/reference/integrations/github/actions/get-issue-comment)
* [Update GitHub issue comment](/reference/integrations/github/actions/update-issue-comment)
* [Delete GitHub issue comment](/reference/integrations/github/actions/delete-issue-comment)
* [Create GitHub issue](/reference/integrations/github/actions/create-issue)
* [Create GitHub pull request review](/reference/integrations/github/actions/create-pull-request-review)
* [List GitHub pull request reviews](/reference/integrations/github/actions/list-pull-request-reviews)
* [List GitHub pull request files](/reference/integrations/github/actions/list-pull-request-files)
* [Request GitHub pull request reviewers](/reference/integrations/github/actions/request-pull-request-reviewers)
* [Remove GitHub pull request reviewers](/reference/integrations/github/actions/remove-pull-request-reviewers)
* [Update GitHub pull request branch](/reference/integrations/github/actions/update-pull-request-branch)
* [List GitHub pull request review comments](/reference/integrations/github/actions/list-pull-request-review-comments)
* [Get GitHub pull request review comment](/reference/integrations/github/actions/get-pull-request-review-comment)
* [Create GitHub pull request review comment](/reference/integrations/github/actions/create-pull-request-review-comment)
* [Reply to GitHub pull request review comment](/reference/integrations/github/actions/reply-to-pull-request-review-comment)
* [Update GitHub pull request review comment](/reference/integrations/github/actions/update-pull-request-review-comment)
* [Delete GitHub pull request review comment](/reference/integrations/github/actions/delete-pull-request-review-comment)
* [Create GitHub pull request](/reference/integrations/github/actions/create-pull-request)
* [Get GitHub issue](/reference/integrations/github/actions/get-issue)
* [Get GitHub pull request](/reference/integrations/github/actions/get-pull-request)
* [List GitHub issues](/reference/integrations/github/actions/list-issues)
* [List GitHub pull requests](/reference/integrations/github/actions/list-pull-requests)
* [Merge GitHub pull request](/reference/integrations/github/actions/merge-pull-request)
* [Update GitHub issue](/reference/integrations/github/actions/update-issue)
* [Update GitHub pull request](/reference/integrations/github/actions/update-pull-request)
* [List GitHub releases](/reference/integrations/github/actions/list-releases)
* [Get GitHub release](/reference/integrations/github/actions/get-release)
* [Create GitHub release](/reference/integrations/github/actions/create-release)
* [Update GitHub release](/reference/integrations/github/actions/update-release)
* [Delete GitHub release](/reference/integrations/github/actions/delete-release)
* [List GitHub release assets](/reference/integrations/github/actions/list-release-assets)
* [Upload GitHub release asset](/reference/integrations/github/actions/upload-release-asset)
* [Update GitHub release asset](/reference/integrations/github/actions/update-release-asset)
* [Delete GitHub release asset](/reference/integrations/github/actions/delete-release-asset)
* [List GitHub deployments](/reference/integrations/github/actions/list-deployments)
* [Get GitHub deployment](/reference/integrations/github/actions/get-deployment)
* [Create GitHub deployment](/reference/integrations/github/actions/create-deployment)
* [Delete GitHub deployment](/reference/integrations/github/actions/delete-deployment)
* [List GitHub deployment statuses](/reference/integrations/github/actions/list-deployment-statuses)
* [Get GitHub deployment status](/reference/integrations/github/actions/get-deployment-status)
* [Create GitHub deployment status](/reference/integrations/github/actions/create-deployment-status)