# GitHub

Open and update issues and pull requests, review and merge, commit files, create branches and releases, run Actions workflows, and read repositories, organizations and users on GitHub.

## Connect GitHub

1. In the sidebar, open **Connections** and press **Add connection**.
2. Type `github` and choose **GitHub**.
3. Choose **Sign in with GitHub**.
4. Press **Sign in with GitHub** at the bottom of the sheet, then choose your account in GitHub’s window and allow access.

Or choose **Paste your personal access token**, paste it, and press **Test and save**. It stays until someone deletes it.

Sign in with GitHub, or paste a personal access token: fine-grained (github.com/settings/personal-access-tokens/new; pick the repositories and give Contents, Issues, Pull requests, Actions and Webhooks the access the steps need) or classic (scopes repo and workflow; admin:repo_hook for repository webhooks). For GitHub Enterprise Server, enter its address and a token from it.

**What if it says “Sign-in isn’t set up here yet”?**

Signing in with GitHub needs a GitHub app on this installation, and it has none yet. Until it is set up, **Paste your personal access token** works without it.

**On Cloud:** The sheet says “It’s set up once for everyone who uses this service, not by an organization.”

**Self-hosted:** An admin of the installation sees **Set up GitHub sign-in** instead, and sets it up once for everyone. Everyone else sees who to ask.

1. Create an app in GitHub’s developer settings ([GitHub’s guide](https://github.com/settings/personal-access-tokens/new)).
2. In GoRunner, copy the **Redirect address to add in GitHub’s developer settings**, and add it to the app.
3. Paste the **Client ID** and **Client secret**, then press **Save and sign in**.

[Set up a sign-in app](https://docs.gorunner.io/self-host/oauth-apps#other-providers)

**Can I use my own GitHub app?**

Yes. In the sheet, open **Use your own GitHub app** and paste its **Client ID** and **Client secret**. Add the redirect address it shows to your app first. The connection then signs in through your app instead of the installation’s.

[Connections](https://docs.gorunner.io/build/connections) says how to sign in again, rename or delete it. In a product that embeds GoRunner, **Add connection** can be missing: then [your provider makes connections](https://docs.gorunner.io/embed/customer-connections) for you.

## Start a workflow

Add a trigger and choose **GitHub**. The trigger uses the same connection as the steps.

### On GitHub Event

Starts when GitHub sends one of the picked events for the repository. Publishing the workflow adds a webhook to the repository (with a signing secret kept encrypted) and unpublishing removes it, so the connection needs to manage the repository's webhooks: admin:repo_hook (classic token, or the GitHub sign-in) or Webhooks: write (fine-grained token, GitHub App). Every delivery's signature is checked and an unsigned or wrongly signed one is refused; GitHub's ping on creation starts nothing, and a redelivery of the same event starts no second run.

- **Owner · Optional**: The user or organization the repository belongs to. Leave empty when the repository is picked or written as owner/name.
- **Repository · Required**: The repository to watch: pick it, or write owner/name or its link.
- **Events · Required**: Which events start the workflow. Any event subscribes to everything the repository sends. Options: Any event to Security and analysis settings (54 options).
- **Skip TLS Check · Optional**: Let GitHub deliver without checking this installation's TLS certificate (only for a self-signed test installation). Off by default.

A later step can use its data, such as `{{trigger.action}}`, `{{trigger.commits}}`, `{{trigger.github}}` and 5 more. See [Use data from earlier steps](https://docs.gorunner.io/build/use-data-from-earlier-steps).

## Do things in GitHub

Add a **GitHub** step, choose a **Resource**, then an **Operation**. Choose a row to see its fields.

- [Issue](https://docs.gorunner.io/apps/github#fields-f-issue): Create · Get · Edit · Create Comment · Get Comments · Add Labels · Remove Label · Lock · Unlock
- [Pull Request](https://docs.gorunner.io/apps/github#fields-f-pullrequest): Create · Get · Update · Close · Reopen · Merge · Create Comment · Edit Comment · Get Diff · Get Patch · Get Changed Files · Request Reviewers
- [Review](https://docs.gorunner.io/apps/github#fields-f-review): Create · Get · Get Many · Update
- [Repository](https://docs.gorunner.io/apps/github#fields-f-repository): Get · Get Issues · Get Pull Requests · Get License · Get Community Profile · Get Popular Paths · Get Top Referrers
- [File](https://docs.gorunner.io/apps/github#fields-f-file): Create · Edit · Get · List · Delete
- [Branch](https://docs.gorunner.io/apps/github#fields-f-branch): Create · Get Many
- [Release](https://docs.gorunner.io/apps/github#fields-f-release): Create · Get · Get Many · Update · Delete
- [Workflow](https://docs.gorunner.io/apps/github#fields-f-workflow): Dispatch · Dispatch and Wait for Completion · Get · List · Get Runs · Enable · Disable · Get Usage
- [Organization](https://docs.gorunner.io/apps/github#fields-f-organization): Get Repositories · Get Members
- [User](https://docs.gorunner.io/apps/github#fields-f-user): Get Repositories · Get Issues · Invite

Later steps read a step’s output by its name: see [Use data from earlier steps](https://docs.gorunner.io/build/use-data-from-earlier-steps).

## Limits

- A reply from GitHub can be up to 16 MB (a file download can have its own limit). A larger one fails the step; it is never cut short.
- When GitHub says to slow down (429), the step waits as long as it asks, if the step’s time allows. Otherwise it fails and says when to try again.

Not in your list? See [When an app isn’t here](https://docs.gorunner.io/apps/when-an-app-isnt-here#q-not-in-list).

## For developers

In the API, which calls apps pieces, GitHub is `pieceId: "github"` with `actionId: "github"`, set by `resource` and an `operation_…` field, such as `operation_branch`. Its trigger is `githubtrigger` / `github_event`. [Get an app](https://docs.gorunner.io/api/apps/get-app) returns every field.

It can change something outside the run (`writes_external`). See [How versions and side effects work](https://docs.gorunner.io/apps#q-versions).

### GitHub › Issue

### Create

- **Owner · Optional**: The user or organization: the one the repository belongs to (leave empty when the repository is picked from the list or written as owner/name), or the organization or user to read. Shows when **Operation** isn’t **Get Issues** or **Invite**.
- **Repository · Required**: The repository: pick it, or write its name, owner/name or link.
- **Title · Required**: The issue's title.
- **Body · Optional**: The issue's description, in Markdown. Empty leaves it when editing.
- **Labels · Optional**: Label names, such as bug, needs-triage. Editing replaces the issue's labels; Add Labels keeps the ones it has.
- **Assignees · Optional**: GitHub usernames to assign (at most 10). Editing replaces the assignees.
- **Milestone Number · Optional**: The milestone's number. Empty leaves it.
- **Issue Type · Optional**: The organization's issue type, such as Bug. Empty leaves it.

### Get and Unlock

- **Owner · Optional**: The user or organization: the one the repository belongs to (leave empty when the repository is picked from the list or written as owner/name), or the organization or user to read. Shows when **Operation** isn’t **Get Issues** or **Invite**.
- **Repository · Required**: The repository: pick it, or write its name, owner/name or link.
- **Issue Number · Required**: The issue's number (42, #42) or its link.

### Edit

- **Owner · Optional**: The user or organization: the one the repository belongs to (leave empty when the repository is picked from the list or written as owner/name), or the organization or user to read. Shows when **Operation** isn’t **Get Issues** or **Invite**.
- **Repository · Required**: The repository: pick it, or write its name, owner/name or link.
- **Issue Number · Required**: The issue's number (42, #42) or its link.
- **Title · Optional**: A new title. Empty leaves it.
- **Body · Optional**: The issue's description, in Markdown. Empty leaves it when editing.
- **Labels · Optional**: Label names, such as bug, needs-triage. Editing replaces the issue's labels; Add Labels keeps the ones it has.
- **Assignees · Optional**: GitHub usernames to assign (at most 10). Editing replaces the assignees.
- **Milestone Number · Optional**: The milestone's number. Empty leaves it.
- **Issue Type · Optional**: The organization's issue type, such as Bug. Empty leaves it.
- **State · Optional**: Open or close the issue. Options: Leave as it is, Open, Closed. Default: Leave as it is.
- **Reason · Optional**: Why it is closed or reopened (used when the state changes). Options: Not given, Completed, Not planned, Duplicate, Reopened. Default: Not given.

### Create Comment

- **Owner · Optional**: The user or organization: the one the repository belongs to (leave empty when the repository is picked from the list or written as owner/name), or the organization or user to read. Shows when **Operation** isn’t **Get Issues** or **Invite**.
- **Repository · Required**: The repository: pick it, or write its name, owner/name or link.
- **Issue Number · Required**: The issue's number (42, #42) or its link.
- **Comment · Required**: The comment, in Markdown.

### Get Comments

- **Owner · Optional**: The user or organization: the one the repository belongs to (leave empty when the repository is picked from the list or written as owner/name), or the organization or user to read. Shows when **Operation** isn’t **Get Issues** or **Invite**.
- **Repository · Required**: The repository: pick it, or write its name, owner/name or link.
- **Issue Number · Required**: The issue's number (42, #42) or its link.
- **Return All · Optional**: Read every comment, page by page (at most 1000; past that the step fails rather than stop early). Off by default.
- **Limit · Optional**: How many comments to return (1–1000). Default: 50. Shows when **Return All** is off.

### Add Labels

- **Owner · Optional**: The user or organization: the one the repository belongs to (leave empty when the repository is picked from the list or written as owner/name), or the organization or user to read. Shows when **Operation** isn’t **Get Issues** or **Invite**.
- **Repository · Required**: The repository: pick it, or write its name, owner/name or link.
- **Issue Number · Required**: The issue's number (42, #42) or its link.
- **Labels · Optional**: Label names, such as bug, needs-triage. Editing replaces the issue's labels; Add Labels keeps the ones it has.

### Remove Label

- **Owner · Optional**: The user or organization: the one the repository belongs to (leave empty when the repository is picked from the list or written as owner/name), or the organization or user to read. Shows when **Operation** isn’t **Get Issues** or **Invite**.
- **Repository · Required**: The repository: pick it, or write its name, owner/name or link.
- **Issue Number · Required**: The issue's number (42, #42) or its link.
- **Label · Required**: The label's name.

### Lock

- **Owner · Optional**: The user or organization: the one the repository belongs to (leave empty when the repository is picked from the list or written as owner/name), or the organization or user to read. Shows when **Operation** isn’t **Get Issues** or **Invite**.
- **Repository · Required**: The repository: pick it, or write its name, owner/name or link.
- **Issue Number · Required**: The issue's number (42, #42) or its link.
- **Reason · Optional**: Why the conversation is locked. Options: Not given, Off-topic, Too heated, Resolved, Spam. Default: Not given.

### GitHub › Pull Request

### Create

- **Owner · Optional**: The user or organization: the one the repository belongs to (leave empty when the repository is picked from the list or written as owner/name), or the organization or user to read. Shows when **Operation** isn’t **Get Issues** or **Invite**.
- **Repository · Required**: The repository: pick it, or write its name, owner/name or link.
- **Title · Required**: The pull request's title.
- **Head Branch · Required**: The branch with the changes; from a fork, owner:branch.
- **Base Branch · Required**: The branch the changes go into, such as main.
- **Description · Optional**: In Markdown. Empty leaves it when updating.
- **Draft · Optional**: Open it as a draft. Off by default.
- **Maintainers Can Edit · Optional**: Let the base repository's maintainers push to the head branch (for a pull request from a fork). On by default.

### Get, Close, Reopen, Get Diff and Get Patch

- **Owner · Optional**: The user or organization: the one the repository belongs to (leave empty when the repository is picked from the list or written as owner/name), or the organization or user to read. Shows when **Operation** isn’t **Get Issues** or **Invite**.
- **Repository · Required**: The repository: pick it, or write its name, owner/name or link.
- **Pull Request Number · Required**: The pull request's number (17, #17) or its link.

### Update

- **Owner · Optional**: The user or organization: the one the repository belongs to (leave empty when the repository is picked from the list or written as owner/name), or the organization or user to read. Shows when **Operation** isn’t **Get Issues** or **Invite**.
- **Repository · Required**: The repository: pick it, or write its name, owner/name or link.
- **Pull Request Number · Required**: The pull request's number (17, #17) or its link.
- **Title · Optional**: A new title. Empty leaves it.
- **Base Branch · Optional**: Another branch of this repository to merge into. Empty leaves it.
- **Description · Optional**: In Markdown. Empty leaves it when updating.

### Merge

- **Owner · Optional**: The user or organization: the one the repository belongs to (leave empty when the repository is picked from the list or written as owner/name), or the organization or user to read. Shows when **Operation** isn’t **Get Issues** or **Invite**.
- **Repository · Required**: The repository: pick it, or write its name, owner/name or link.
- **Pull Request Number · Required**: The pull request's number (17, #17) or its link.
- **Merge Method · Optional**: How the changes land on the base branch. Options: Merge commit, Squash and merge, Rebase and merge. Default: Merge commit.
- **Commit Title · Optional**: The merge commit's title. Empty uses GitHub's.
- **Commit Message · Optional**: Added to the merge commit's message.
- **Head Commit · Optional**: Merge only if the head branch is still at this commit SHA.

### Create Comment

- **Owner · Optional**: The user or organization: the one the repository belongs to (leave empty when the repository is picked from the list or written as owner/name), or the organization or user to read. Shows when **Operation** isn’t **Get Issues** or **Invite**.
- **Repository · Required**: The repository: pick it, or write its name, owner/name or link.
- **Pull Request Number · Required**: The pull request's number (17, #17) or its link.
- **Comment · Required**: The comment, in Markdown.

### Edit Comment

- **Owner · Optional**: The user or organization: the one the repository belongs to (leave empty when the repository is picked from the list or written as owner/name), or the organization or user to read. Shows when **Operation** isn’t **Get Issues** or **Invite**.
- **Repository · Required**: The repository: pick it, or write its name, owner/name or link.
- **Comment ID · Required**: The id of the conversation comment (an issue or pull request comment) or its link (…#issuecomment-123).
- **Comment · Required**: The comment, in Markdown.

### Get Changed Files

- **Owner · Optional**: The user or organization: the one the repository belongs to (leave empty when the repository is picked from the list or written as owner/name), or the organization or user to read. Shows when **Operation** isn’t **Get Issues** or **Invite**.
- **Repository · Required**: The repository: pick it, or write its name, owner/name or link.
- **Pull Request Number · Required**: The pull request's number (17, #17) or its link.
- **Return All · Optional**: Read every file, page by page (at most 3000; past that the step fails rather than stop early). Off by default.
- **Limit · Optional**: How many files to return (1–3000). Default: 100. Shows when **Return All** is off.

### Request Reviewers

- **Owner · Optional**: The user or organization: the one the repository belongs to (leave empty when the repository is picked from the list or written as owner/name), or the organization or user to read. Shows when **Operation** isn’t **Get Issues** or **Invite**.
- **Repository · Required**: The repository: pick it, or write its name, owner/name or link.
- **Pull Request Number · Required**: The pull request's number (17, #17) or its link.
- **Reviewers · Optional**: GitHub usernames to ask for a review.
- **Team Reviewers · Optional**: Team slugs of the organization to ask for a review.

### GitHub › Review

### Create

- **Owner · Optional**: The user or organization: the one the repository belongs to (leave empty when the repository is picked from the list or written as owner/name), or the organization or user to read. Shows when **Operation** isn’t **Get Issues** or **Invite**.
- **Repository · Required**: The repository: pick it, or write its name, owner/name or link.
- **Pull Request Number · Required**: The pull request's number (17, #17) or its link.
- **Event · Optional**: Approve, ask for changes, comment, or leave the review pending (only you see it until it is submitted). Options: Approve, Request changes, Comment, Pending. Default: Comment.
- **Body · Optional**: The review's text, in Markdown. Required to request changes or comment.
- **Commit · Optional**: The commit SHA to review. Empty reviews the latest commit.
- **Line Comments · Optional**: Comments on lines of the diff, such as [{"path": "src/app.go", "line": 12, "body": "Check for nil here."}].

### Get

- **Owner · Optional**: The user or organization: the one the repository belongs to (leave empty when the repository is picked from the list or written as owner/name), or the organization or user to read. Shows when **Operation** isn’t **Get Issues** or **Invite**.
- **Repository · Required**: The repository: pick it, or write its name, owner/name or link.
- **Pull Request Number · Required**: The pull request's number (17, #17) or its link.
- **Review ID · Required**: The review's id.

### Get Many

- **Owner · Optional**: The user or organization: the one the repository belongs to (leave empty when the repository is picked from the list or written as owner/name), or the organization or user to read. Shows when **Operation** isn’t **Get Issues** or **Invite**.
- **Repository · Required**: The repository: pick it, or write its name, owner/name or link.
- **Pull Request Number · Required**: The pull request's number (17, #17) or its link.
- **Return All · Optional**: Read every review, page by page (at most 1000; past that the step fails rather than stop early). Off by default.
- **Limit · Optional**: How many reviews to return (1–1000). Default: 50. Shows when **Return All** is off.

### Update

- **Owner · Optional**: The user or organization: the one the repository belongs to (leave empty when the repository is picked from the list or written as owner/name), or the organization or user to read. Shows when **Operation** isn’t **Get Issues** or **Invite**.
- **Repository · Required**: The repository: pick it, or write its name, owner/name or link.
- **Pull Request Number · Required**: The pull request's number (17, #17) or its link.
- **Review ID · Required**: The review's id.
- **Body · Required**: The review's new text.

### GitHub › Repository

### Get, Get License, Get Community Profile, Get Popular Paths and Get Top Referrers

- **Owner · Optional**: The user or organization: the one the repository belongs to (leave empty when the repository is picked from the list or written as owner/name), or the organization or user to read. Shows when **Operation** isn’t **Get Issues** or **Invite**.
- **Repository · Required**: The repository: pick it, or write its name, owner/name or link.

### Get Issues

- **Owner · Optional**: The user or organization: the one the repository belongs to (leave empty when the repository is picked from the list or written as owner/name), or the organization or user to read. Shows when **Operation** isn’t **Get Issues** or **Invite**.
- **Repository · Required**: The repository: pick it, or write its name, owner/name or link.
- **State · Optional**: Open, closed, or both. Options: Open, Closed, All. Default: Open.
- **Labels · Optional**: Only issues with all of these labels.
- **Assignee · Optional**: Only issues assigned to this username; none for unassigned, * for any.
- **Creator · Optional**: Only issues opened by this username.
- **Mentioned · Optional**: Only issues that mention this username.
- **Updated Since · Optional**: Only issues updated at or after this time (ISO 8601, such as 2026-11-01T00:00:00Z).
- **Include Pull Requests · Optional**: GitHub lists pull requests among a repository's issues; off leaves them out. Off by default.
- **Sort By · Optional**: Options: Created, Updated, Comments. Default: Created.
- **Direction · Optional**: Options: Newest or most first, Oldest or least first. Default: Newest or most first.
- **Return All · Optional**: Read every item, page by page (at most 1000; past that the step fails rather than stop early). Off by default.
- **Limit · Optional**: How many items to return (1–1000). Default: 50. Shows when **Return All** is off.

### Get Pull Requests

- **Owner · Optional**: The user or organization: the one the repository belongs to (leave empty when the repository is picked from the list or written as owner/name), or the organization or user to read. Shows when **Operation** isn’t **Get Issues** or **Invite**.
- **Repository · Required**: The repository: pick it, or write its name, owner/name or link.
- **State · Optional**: Open, closed, or both. Options: Open, Closed, All. Default: Open.
- **Head Branch · Optional**: Only pull requests from this branch, as owner:branch.
- **Base Branch · Optional**: Only pull requests into this branch.
- **Sort By · Optional**: Options: Created, Updated, Comments, Open longest. Default: Created.
- **Direction · Optional**: Options: Newest or most first, Oldest or least first. Default: Newest or most first.
- **Return All · Optional**: Read every item, page by page (at most 1000; past that the step fails rather than stop early). Off by default.
- **Limit · Optional**: How many items to return (1–1000). Default: 50. Shows when **Return All** is off.

### GitHub › File

### Create and Edit

- **Owner · Optional**: The user or organization: the one the repository belongs to (leave empty when the repository is picked from the list or written as owner/name), or the organization or user to read. Shows when **Operation** isn’t **Get Issues** or **Invite**.
- **Repository · Required**: The repository: pick it, or write its name, owner/name or link.
- **File Path · Required**: The file's path in the repository, such as docs/notes.md.
- **From a File · Optional**: Commit a file from an upload or an earlier step instead of text. Off by default.
- **File · Optional**: Upload a file, or switch to an expression to use one from an earlier step (such as {{steps.download.result}}). At most 50 MB. Shows when **From a File** is on.
- **File Content · Optional**: The file's text. Shows when **From a File** is off.
- **Commit Message · Required**: The commit's message.
- **Branch · Optional**: The branch to commit to. Empty uses the repository's default branch.
- **Author Name · Optional**: Commit as this author (with Author Email). Empty commits as the connection's user.
- **Author Email · Optional**: The author's email address.

### Get

- **Owner · Optional**: The user or organization: the one the repository belongs to (leave empty when the repository is picked from the list or written as owner/name), or the organization or user to read. Shows when **Operation** isn’t **Get Issues** or **Invite**.
- **Repository · Required**: The repository: pick it, or write its name, owner/name or link.
- **File Path · Required**: The file's path in the repository, such as docs/notes.md.
- **Reference · Optional**: A branch, tag or commit SHA to read from. Empty reads the default branch.
- **Output as File · Optional**: Return the content as a file (for images, archives and other binary files) instead of text. Off by default.

### List

- **Owner · Optional**: The user or organization: the one the repository belongs to (leave empty when the repository is picked from the list or written as owner/name), or the organization or user to read. Shows when **Operation** isn’t **Get Issues** or **Invite**.
- **Repository · Required**: The repository: pick it, or write its name, owner/name or link.
- **Folder Path · Optional**: The folder to list, such as docs. Empty lists the top of the repository.
- **Reference · Optional**: A branch, tag or commit SHA to read from. Empty reads the default branch.

### Delete

- **Owner · Optional**: The user or organization: the one the repository belongs to (leave empty when the repository is picked from the list or written as owner/name), or the organization or user to read. Shows when **Operation** isn’t **Get Issues** or **Invite**.
- **Repository · Required**: The repository: pick it, or write its name, owner/name or link.
- **File Path · Required**: The file's path in the repository, such as docs/notes.md.
- **Commit Message · Required**: The commit's message.
- **Branch · Optional**: The branch to commit to. Empty uses the repository's default branch.
- **Author Name · Optional**: Commit as this author (with Author Email). Empty commits as the connection's user.
- **Author Email · Optional**: The author's email address.

### GitHub › Branch

### Create

- **Owner · Optional**: The user or organization: the one the repository belongs to (leave empty when the repository is picked from the list or written as owner/name), or the organization or user to read. Shows when **Operation** isn’t **Get Issues** or **Invite**.
- **Repository · Required**: The repository: pick it, or write its name, owner/name or link.
- **Branch Name · Required**: The new branch's name, such as fix/login-timeout.
- **From · Optional**: The branch, tag or commit SHA it starts at. Empty starts at the default branch.

### Get Many

- **Owner · Optional**: The user or organization: the one the repository belongs to (leave empty when the repository is picked from the list or written as owner/name), or the organization or user to read. Shows when **Operation** isn’t **Get Issues** or **Invite**.
- **Repository · Required**: The repository: pick it, or write its name, owner/name or link.
- **Protected Only · Optional**: List only protected branches. Off by default.
- **Return All · Optional**: Read every branch, page by page (at most 1000; past that the step fails rather than stop early). Off by default.
- **Limit · Optional**: How many branchs to return (1–1000). Default: 50. Shows when **Return All** is off.

### GitHub › Release

### Create

- **Owner · Optional**: The user or organization: the one the repository belongs to (leave empty when the repository is picked from the list or written as owner/name), or the organization or user to read. Shows when **Operation** isn’t **Get Issues** or **Invite**.
- **Repository · Required**: The repository: pick it, or write its name, owner/name or link.
- **Tag · Required**: The release's tag, such as v1.4.0. GitHub creates the tag when it does not exist yet.
- **Name · Optional**: The release's title. Empty uses the tag.
- **Notes · Optional**: What changed, in Markdown.
- **Target · Optional**: The branch or commit SHA a new tag is made from. Empty uses the default branch.
- **Draft · Optional**: Save it as a draft (not published). Off by default.
- **Pre-release · Optional**: Mark it as a pre-release. Off by default.
- **Generate Notes · Optional**: Let GitHub write the notes from the merged pull requests (added after Notes). Off by default.
- **Latest Release · Optional**: Whether it becomes the repository's latest release. Options: Yes, No, By date and version. Default: Yes.

### Get and Delete

- **Owner · Optional**: The user or organization: the one the repository belongs to (leave empty when the repository is picked from the list or written as owner/name), or the organization or user to read. Shows when **Operation** isn’t **Get Issues** or **Invite**.
- **Repository · Required**: The repository: pick it, or write its name, owner/name or link.
- **Release · Required**: The release's id, its tag (v1.4.0), or latest.

### Get Many

- **Owner · Optional**: The user or organization: the one the repository belongs to (leave empty when the repository is picked from the list or written as owner/name), or the organization or user to read. Shows when **Operation** isn’t **Get Issues** or **Invite**.
- **Repository · Required**: The repository: pick it, or write its name, owner/name or link.
- **Return All · Optional**: Read every release, page by page (at most 1000; past that the step fails rather than stop early). Off by default.
- **Limit · Optional**: How many releases to return (1–1000). Default: 50. Shows when **Return All** is off.

### Update

- **Owner · Optional**: The user or organization: the one the repository belongs to (leave empty when the repository is picked from the list or written as owner/name), or the organization or user to read. Shows when **Operation** isn’t **Get Issues** or **Invite**.
- **Repository · Required**: The repository: pick it, or write its name, owner/name or link.
- **Release · Required**: The release's id, its tag (v1.4.0), or latest.
- **Tag · Optional**: A new tag. Empty leaves it.
- **Name · Optional**: The release's title. Empty uses the tag.
- **Notes · Optional**: What changed, in Markdown.
- **Target · Optional**: The branch or commit SHA a new tag is made from. Empty uses the default branch.
- **Draft · Optional**: Save it as a draft (not published). Off by default.
- **Pre-release · Optional**: Mark it as a pre-release. Off by default.
- **Latest Release · Optional**: Whether it becomes the repository's latest release. Options: Yes, No, By date and version. Default: Yes.

### GitHub › Workflow

### Dispatch

- **Owner · Optional**: The user or organization: the one the repository belongs to (leave empty when the repository is picked from the list or written as owner/name), or the organization or user to read. Shows when **Operation** isn’t **Get Issues** or **Invite**.
- **Repository · Required**: The repository: pick it, or write its name, owner/name or link.
- **Workflow · Required**: The workflow: pick it, or write its file name (ci.yml) or id.
- **Branch or Tag · Required**: The branch or tag to run the workflow on, such as main.
- **Inputs · Optional**: The workflow's workflow_dispatch inputs by name, such as {"environment": "staging"} (at most 25).

### Dispatch and Wait for Completion

- **Owner · Optional**: The user or organization: the one the repository belongs to (leave empty when the repository is picked from the list or written as owner/name), or the organization or user to read. Shows when **Operation** isn’t **Get Issues** or **Invite**.
- **Repository · Required**: The repository: pick it, or write its name, owner/name or link.
- **Workflow · Required**: The workflow: pick it, or write its file name (ci.yml) or id.
- **Branch or Tag · Required**: The branch or tag to run the workflow on, such as main.
- **Inputs · Optional**: The workflow's workflow_dispatch inputs by name, such as {"environment": "staging"} (at most 25).
- **Resume URL Input · Optional**: The workflow_dispatch input that receives the address to call when the job is done. The GitHub workflow must declare this input and finish with a step that POSTs to it (such as curl -X POST "${{ inputs.resumeUrl }}" -d '{"status":"success"}'); what it posts becomes this step's resumeData. Default: resumeUrl.
- **Give Up After (minutes) · Optional**: Continue without an answer after this long. Empty or 0 waits until the workflow calls back.

### Get, Enable, Disable and Get Usage

- **Owner · Optional**: The user or organization: the one the repository belongs to (leave empty when the repository is picked from the list or written as owner/name), or the organization or user to read. Shows when **Operation** isn’t **Get Issues** or **Invite**.
- **Repository · Required**: The repository: pick it, or write its name, owner/name or link.
- **Workflow · Required**: The workflow: pick it, or write its file name (ci.yml) or id.

### List

- **Owner · Optional**: The user or organization: the one the repository belongs to (leave empty when the repository is picked from the list or written as owner/name), or the organization or user to read. Shows when **Operation** isn’t **Get Issues** or **Invite**.
- **Repository · Required**: The repository: pick it, or write its name, owner/name or link.

### Get Runs

- **Owner · Optional**: The user or organization: the one the repository belongs to (leave empty when the repository is picked from the list or written as owner/name), or the organization or user to read. Shows when **Operation** isn’t **Get Issues** or **Invite**.
- **Repository · Required**: The repository: pick it, or write its name, owner/name or link.
- **Workflow · Required**: The workflow: pick it, or write its file name (ci.yml) or id.
- **Status · Optional**: Only runs with this status or conclusion. Options: Any, Queued, In progress, Completed, Succeeded, Failed, Cancelled, Skipped, Timed out, Action required. Default: Any.
- **Branch · Optional**: Only runs on this branch.
- **Event · Optional**: Only runs started by this event, such as push, pull_request, workflow_dispatch.
- **Return All · Optional**: Read every run, page by page (at most 1000; past that the step fails rather than stop early). Off by default.
- **Limit · Optional**: How many runs to return (1–1000). Default: 20. Shows when **Return All** is off.

### GitHub › Organization

### Get Repositories

- **Owner · Optional**: The user or organization: the one the repository belongs to (leave empty when the repository is picked from the list or written as owner/name), or the organization or user to read. Shows when **Operation** isn’t **Get Issues** or **Invite**.
- **Type · Optional**: Which repositories. Options: All, Public, Private, Forks, Not forks, Where I am a member. Default: All.
- **Return All · Optional**: Read every item, page by page (at most 1000; past that the step fails rather than stop early). Off by default.
- **Limit · Optional**: How many items to return (1–1000). Default: 50. Shows when **Return All** is off.

### Get Members

- **Owner · Optional**: The user or organization: the one the repository belongs to (leave empty when the repository is picked from the list or written as owner/name), or the organization or user to read. Shows when **Operation** isn’t **Get Issues** or **Invite**.
- **Role · Optional**: Which members. Options: All, Owners, Members. Default: All.
- **Return All · Optional**: Read every item, page by page (at most 1000; past that the step fails rather than stop early). Off by default.
- **Limit · Optional**: How many items to return (1–1000). Default: 50. Shows when **Return All** is off.

### GitHub › User

### Get Repositories

- **Owner · Optional**: The user or organization: the one the repository belongs to (leave empty when the repository is picked from the list or written as owner/name), or the organization or user to read.
- **Type · Optional**: Which repositories. Options: Owned, Where a collaborator, All. Default: Owned.
- **Return All · Optional**: Read every item, page by page (at most 1000; past that the step fails rather than stop early). Off by default.
- **Limit · Optional**: How many items to return (1–1000). Default: 50. Shows when **Return All** is off.

### Get Issues

- **Filter · Optional**: Which of your issues. Options: Assigned to me, Opened by me, Mentioning me, Subscribed, In my repositories, All I can see. Default: Assigned to me.
- **State · Optional**: Options: Open, Closed, All. Default: Open.
- **Labels · Optional**: Only issues with all of these labels.
- **Sort By · Optional**: Options: Created, Updated, Comments. Default: Created.
- **Updated Since · Optional**: Only issues updated at or after this time (ISO 8601).
- **Return All · Optional**: Read every item, page by page (at most 1000; past that the step fails rather than stop early). Off by default.
- **Limit · Optional**: How many items to return (1–1000). Default: 50. Shows when **Return All** is off.

### Invite

- **Organization · Required**: The organization to invite to (you must be one of its owners).
- **Email · Required**: The address to send the invitation to.
- **Role · Optional**: Options: Member, Owner, Billing manager. Default: Member.

Source: https://docs.gorunner.io/apps/github
