Skip to main content

GitHub

Read GitHub repositories, issues, releases and users, and open issues.

Get repository​

Reads a repository: description, stars, forks and open issues.

Inputs

NameTypeRequiredDetails
ConnectionTextNoThe GitHub connection from the Integrations page that this action uses. Maximum length: 64 characters.
OwnerTextYesThe user or organization that owns the repository, for example octocat. Maximum length: 39 characters.
RepositoryTextYesThe name of the repository, for example hello-world. Maximum length: 100 characters.

Outputs

NameTypeDetails
FoundYes/NoWhether the repository exists and the token can see it. When not, everything else is empty.
Full nameTextowner/name of the repository. May be empty.
DescriptionTextThe description. May be empty.
LinkURLThe repository on GitHub. May be empty.
StarsWhole numberHow many stars it has. May be empty.
ForksWhole numberHow many forks it has. May be empty.
Open issuesWhole numberOpen issues and pull requests together. May be empty.
LanguageTextThe main programming language. May be empty.
Default branchTextThe default branch, for example main. May be empty.
ArchivedYes/NoWhether the repository is archived. May be empty.
Last pushDate and timeWhen code was last pushed. May be empty.

Get issues​

Lists issues of a repository, newest first. Pull requests are in the list too; they have a pull request link.

Inputs

NameTypeRequiredDetails
ConnectionTextNoThe GitHub connection from the Integrations page that this action uses. Maximum length: 64 characters.
OwnerTextYesThe user or organization that owns the repository, for example octocat. Maximum length: 39 characters.
RepositoryTextYesThe name of the repository, for example hello-world. Maximum length: 100 characters.
StateTextNoopen, closed or all. Empty: open. Maximum length: 6 characters. Default: open.
How manyWhole numberNoHow many to get, 1 to 100. Empty: 10. Value: 1 to 100. Default: 10.
PageWhole numberNoWhich page of the list, starting at 1. Empty: 1. Minimum: 1. Default: 1.

Outputs

NameTypeDetails
IssuesList of GitHub issueThe issues, newest first.

Get releases​

Lists releases of a repository, newest first.

Inputs

NameTypeRequiredDetails
ConnectionTextNoThe GitHub connection from the Integrations page that this action uses. Maximum length: 64 characters.
OwnerTextYesThe user or organization that owns the repository, for example octocat. Maximum length: 39 characters.
RepositoryTextYesThe name of the repository, for example hello-world. Maximum length: 100 characters.
How manyWhole numberNoHow many to get, 1 to 100. Empty: 10. Value: 1 to 100. Default: 10.
PageWhole numberNoWhich page of the list, starting at 1. Empty: 1. Minimum: 1. Default: 1.

Outputs

NameTypeDetails
ReleasesList of GitHub releaseThe releases, newest first.

Get latest release​

Reads the newest published release that is not a pre-release or draft.

Inputs

NameTypeRequiredDetails
ConnectionTextNoThe GitHub connection from the Integrations page that this action uses. Maximum length: 64 characters.
OwnerTextYesThe user or organization that owns the repository, for example octocat. Maximum length: 39 characters.
RepositoryTextYesThe name of the repository, for example hello-world. Maximum length: 100 characters.

Outputs

NameTypeDetails
FoundYes/NoWhether there is such a release. When not, the release is empty.
ReleaseGitHub releaseThe release. May be empty.

Open issue​

Opens a new issue in a repository. The token needs write access to Issues.

Inputs

NameTypeRequiredDetails
ConnectionTextNoThe GitHub connection from the Integrations page that this action uses. Maximum length: 64 characters.
OwnerTextYesThe user or organization that owns the repository, for example octocat. Maximum length: 39 characters.
RepositoryTextYesThe name of the repository, for example hello-world. Maximum length: 100 characters.
TitleTextYesThe title of the issue. Maximum length: 256 characters.
TextTextNoThe text of the issue, as Markdown. Maximum length: 60000 characters.

Outputs

NameTypeDetails
NumberWhole numberThe number of the new issue.
LinkURLThe new issue on GitHub.

Get GitHub user​

Reads a GitHub user or organization by its username.

Inputs

NameTypeRequiredDetails
ConnectionTextNoThe GitHub connection from the Integrations page that this action uses. Maximum length: 64 characters.
UsernameTextYesThe GitHub username, for example octocat. Maximum length: 39 characters.

Outputs

NameTypeDetails
FoundYes/NoWhether the user exists. When not, everything else is empty.
UsernameTextThe username. May be empty.
NameTextThe display name, when set. May be empty.
BioTextThe profile text, when set. May be empty.
TypeTextUser or Organization. May be empty.
AvatarURLThe profile picture. May be empty.
LinkURLThe profile on GitHub. May be empty.
Public repositoriesWhole numberHow many public repositories they have. May be empty.
FollowersWhole numberHow many followers they have. May be empty.
Created atDate and timeWhen the account was created. May be empty.
Need more help?
Can't find what you're looking for? Our team is happy to help.