Object GitHub::Repository
A repository contains the content for a project.
Fields
assignableUsers(query: String, after: String, before: String, first: Int, last: Int): UserConnection!
A list of users that can be assigned to issues in this repository.
branchProtectionRules(after: String, before: String, first: Int, last: Int): BranchProtectionRuleConnection!
A list of branch protection rules for this repository.
codeOfConduct: CodeOfConduct
Returns the code of conduct for this repository
collaborators(affiliation: CollaboratorAffiliation, query: String, after: String, before: String, first: Int, last: Int): RepositoryCollaboratorConnection
A list of collaborators associated with the repository.
Args
affiliation: CollaboratorAffiliation
Collaborators affiliation level with a repository.
commitComments(after: String, before: String, first: Int, last: Int): CommitCommentConnection!
A list of commit comments associated with the repository.
createdAt: DateTime!
Identifies the date and time when the object was created.
databaseId: Int
Identifies the primary key from the database.
defaultBranchRef: Ref
The Ref associated with the repository's default branch.
deleteBranchOnMerge: Boolean!
Whether or not branches are automatically deleted when merged in this repository.
deployKeys(after: String, before: String, first: Int, last: Int): DeployKeyConnection!
A list of deploy keys that are on this repository.
deployments(environments: [String!], orderBy: DeploymentOrder = {field: CREATED_AT, direction: ASC}, after: String, before: String, first: Int, last: Int): DeploymentConnection!
Deployments associated with the repository
Args
environments: [String!]
Environments to list deployments for
orderBy: DeploymentOrder = {field: CREATED_AT, direction: ASC}
Ordering options for deployments returned from the connection.
description: String
The description of the repository.
descriptionHTML: HTML!
The description of the repository rendered to HTML.
diskUsage: Int
The number of kilobytes this repository occupies on disk.
forkCount: Int!
Returns how many forks there are of this repository in the whole network.
forks(privacy: RepositoryPrivacy, orderBy: RepositoryOrder, affiliations: [RepositoryAffiliation], ownerAffiliations: [RepositoryAffiliation] = [OWNER, COLLABORATOR], isLocked: Boolean, after: String, before: String, first: Int, last: Int): RepositoryConnection!
A list of direct forked repositories.
Args
privacy: RepositoryPrivacy
If non-null, filters repositories according to privacy
orderBy: RepositoryOrder
Ordering options for repositories returned from the connection
affiliations: [RepositoryAffiliation]
Array of viewer's affiliation options for repositories returned from the connection. For example, OWNER will include only repositories that the current viewer owns.
ownerAffiliations: [RepositoryAffiliation] = [OWNER, COLLABORATOR]
Array of owner's affiliation options for repositories returned from the connection. For example, OWNER will include only repositories that the organization or user being viewed owns.
fundingLinks: [FundingLink!]!
The funding links for this repository
hasIssuesEnabled: Boolean!
Indicates if the repository has issues feature enabled.
hasProjectsEnabled: Boolean!
Indicates if the repository has the Projects feature enabled.
hasWikiEnabled: Boolean!
Indicates if the repository has wiki feature enabled.
homepageUrl: URI
The repository's URL.
id: ID!
isArchived: Boolean!
Indicates if the repository is unmaintained.
isDisabled: Boolean!
Returns whether or not this repository disabled.
isEmpty: Boolean!
Returns whether or not this repository is empty.
isFork: Boolean!
Identifies if the repository is a fork.
isLocked: Boolean!
Indicates if the repository has been locked or not.
isMirror: Boolean!
Identifies if the repository is a mirror.
isPrivate: Boolean!
Identifies if the repository is private.
isTemplate: Boolean!
Identifies if the repository is a template that can be used to generate new repositories.
issue(number: Int!): Issue
Returns a single issue from the current repository by number.
issueOrPullRequest(number: Int!): IssueOrPullRequest
Returns a single issue-like object from the current repository by number.
issues(orderBy: IssueOrder, labels: [String!], states: [IssueState!], filterBy: IssueFilters, after: String, before: String, first: Int, last: Int): IssueConnection!
A list of issues that have been opened in the repository.
Args
orderBy: IssueOrder
Ordering options for issues returned from the connection.
states: [IssueState!]
A list of states to filter the issues by.
filterBy: IssueFilters
Filtering options for issues returned from the connection.
label(name: String!): Label
Returns a single label by name
labels(orderBy: LabelOrder = {field: CREATED_AT, direction: ASC}, after: String, before: String, first: Int, last: Int, query: String): LabelConnection
A list of labels associated with the repository.
Args
orderBy: LabelOrder = {field: CREATED_AT, direction: ASC}
Ordering options for labels returned from the connection.
languages(after: String, before: String, first: Int, last: Int, orderBy: LanguageOrder): LanguageConnection
A list containing a breakdown of the language composition of the repository.
Args
orderBy: LanguageOrder
Order for connection
licenseInfo: License
The license associated with the repository
lockReason: RepositoryLockReason
The reason the repository has been locked.
mentionableUsers(query: String, after: String, before: String, first: Int, last: Int): UserConnection!
A list of Users that can be mentioned in the context of the repository.
mergeCommitAllowed: Boolean!
Whether or not PRs are merged with a merge commit on this repository.
milestone(number: Int!): Milestone
Returns a single milestone from the current repository by number.
milestones(after: String, before: String, first: Int, last: Int, states: [MilestoneState!], orderBy: MilestoneOrder, query: String): MilestoneConnection
A list of milestones associated with the repository.
Args
states: [MilestoneState!]
Filter by the state of the milestones.
orderBy: MilestoneOrder
Ordering options for milestones.
mirrorUrl: URI
The repository's original mirror URL.
name: String!
The name of the repository.
nameWithOwner: String!
The repository's name with owner.
object(oid: GitObjectID, expression: String): GitObject
A Git object in the repository
Args
oid: GitObjectID
The Git object ID
expression: String
A Git revision expression suitable for rev-parse
openGraphImageUrl: URI!
The image used to represent this repository in Open Graph data.
owner: RepositoryOwner!
The User owner of the repository.
packages(after: String, before: String, first: Int, last: Int, names: [String], repositoryId: ID, packageType: PackageType, orderBy: PackageOrder = {field: CREATED_AT, direction: DESC}): PackageConnection!
A list of packages under the owner.
Args
repositoryId: ID
Find packages in a repository by ID.
packageType: PackageType
Filter registry package by type.
orderBy: PackageOrder = {field: CREATED_AT, direction: DESC}
Ordering of the returned packages.
parent: Repository
The repository parent, if this is a fork.
primaryLanguage: Language
The primary language of the repository's code.
project(number: Int!): Project
Find project by number.
projects(orderBy: ProjectOrder, search: String, states: [ProjectState!], after: String, before: String, first: Int, last: Int): ProjectConnection!
A list of projects under the owner.
Args
orderBy: ProjectOrder
Ordering options for projects returned from the connection
states: [ProjectState!]
A list of states to filter the projects by.
projectsResourcePath: URI!
The HTTP path listing the repository's projects
projectsUrl: URI!
The HTTP URL listing the repository's projects
pullRequest(number: Int!): PullRequest
Returns a single pull request from the current repository by number.
pullRequests(states: [PullRequestState!], labels: [String!], headRefName: String, baseRefName: String, orderBy: IssueOrder, after: String, before: String, first: Int, last: Int): PullRequestConnection!
A list of pull requests that have been opened in the repository.
Args
states: [PullRequestState!]
A list of states to filter the pull requests by.
headRefName: String
The head ref name to filter the pull requests by.
baseRefName: String
The base ref name to filter the pull requests by.
orderBy: IssueOrder
Ordering options for pull requests returned from the connection.
pushedAt: DateTime
Identifies when the repository was last pushed to.
rebaseMergeAllowed: Boolean!
Whether or not rebase-merging is enabled on this repository.
ref(qualifiedName: String!): Ref
Fetch a given ref from the repository
Args
qualifiedName: String!
The ref to retrieve. Fully qualified matches are checked in order (refs/heads/master) before falling back onto checks for short name matches (master).
refs(query: String, after: String, before: String, first: Int, last: Int, refPrefix: String!, direction: OrderDirection, orderBy: RefOrder): RefConnection
Fetch a list of refs from the repository
Args
direction: OrderDirection
DEPRECATED: use orderBy. The ordering direction.
release(tagName: String!): Release
Lookup a single release given various criteria.
releases(after: String, before: String, first: Int, last: Int, orderBy: ReleaseOrder): ReleaseConnection!
List of releases which are dependent on this repository.
Args
orderBy: ReleaseOrder
Order for connection
repositoryTopics(after: String, before: String, first: Int, last: Int): RepositoryTopicConnection!
A list of applied repository-topic associations for this repository.
resourcePath: URI!
The HTTP path for this repository
shortDescriptionHTML(limit: Int = 200): HTML!
A description of the repository, rendered to HTML without any links in it.
squashMergeAllowed: Boolean!
Whether or not squash-merging is enabled on this repository.
sshUrl: GitSSHRemote!
The SSH URL to clone this repository
stargazers(after: String, before: String, first: Int, last: Int, orderBy: StarOrder): StargazerConnection!
A list of users who have starred this starrable.
submodules(after: String, before: String, first: Int, last: Int): SubmoduleConnection!
Returns a list of all submodules in this repository parsed from the .gitmodules file as of the default branch's HEAD commit.
tempCloneToken: String
Temporary authentication token for cloning this repository.
templateRepository: Repository
The repository from which this repository was generated, if any.
updatedAt: DateTime!
Identifies the date and time when the object was last updated.
url: URI!
The HTTP URL for this repository
usesCustomOpenGraphImage: Boolean!
Whether this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar.
viewerCanAdminister: Boolean!
Indicates whether the viewer has admin permissions on this repository.
viewerCanCreateProjects: Boolean!
Can the current viewer create new projects on this owner.
viewerCanSubscribe: Boolean!
Check if the viewer is able to change their subscription status for the repository.
viewerCanUpdateTopics: Boolean!
Indicates whether the viewer can update the topics of this repository.
viewerDefaultCommitEmail: String
The last commit email for the viewer.
viewerDefaultMergeMethod: PullRequestMergeMethod!
The last used merge method by the viewer or the default for the repository.
viewerHasStarred: Boolean!
Returns a boolean indicating whether the viewing user has starred this starrable.
viewerPermission: RepositoryPermission
The users permission level on the repository. Will return null if authenticated as an GitHub App.
viewerPossibleCommitEmails: [String!]
A list of emails this viewer can commit with.
viewerSubscription: SubscriptionState
Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
vulnerabilityAlerts(after: String, before: String, first: Int, last: Int): RepositoryVulnerabilityAlertConnection
A list of vulnerability alerts that are on this repository.
watchers(after: String, before: String, first: Int, last: Int): UserConnection!
A list of users watching the repository.