Magidoc

Repository
Object

A repository contains the content for a project.

Fields

#

allowUpdateBranch

Non-null

Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.

archivedAt

Identifies the date and time when the repository was archived.

assignableUsers

Non-null

A list of users that can be assigned to issues in this repository.

autoMergeAllowed

Non-null

Whether or not Auto-merge can be enabled on pull requests in this repository.

branchProtectionRules

Non-null

A list of branch protection rules for this repository.

codeOfConduct

Returns the code of conduct for this repository

codeowners

Information extracted from the repository's CODEOWNERS file.

collaborators

A list of collaborators associated with the repository.

commitComments

Non-null

A list of commit comments associated with the repository.

contactLinks

Returns a list of contact links associated to the repository

contributingGuidelines

Returns the contributing guidelines for this repository.

createdAt

Non-null

Identifies the date and time when the object was created.

databaseId

Identifies the primary key from the database.

defaultBranchRef

The Ref associated with the repository's default branch.

deleteBranchOnMerge

Non-null

Whether or not branches are automatically deleted when merged in this repository.

dependencyGraphManifests

A list of dependency manifests contained in the repository

deployKeys

Non-null

A list of deploy keys that are on this repository.

deployments

Non-null

Deployments associated with the repository

description

The description of the repository.

descriptionHTML

Non-null

The description of the repository rendered to HTML.

discussion

Returns a single discussion from the current repository by number.

discussionCategories

Non-null

A list of discussion categories that are available in the repository.

discussionCategory

A discussion category by slug.

discussions

Non-null

A list of discussions that have been opened in the repository.

diskUsage

The number of kilobytes this repository occupies on disk.

environment

Returns a single active environment from the current repository by name.

environments

Non-null

A list of environments that are in this repository.

forkCount

Non-null

Returns how many forks there are of this repository in the whole network.

forkingAllowed

Non-null

Whether this repository allows forks.

forks

Non-null

A list of direct forked repositories.

fundingLinks

Non-null

The funding links for this repository

hasDiscussionsEnabled

Non-null

Indicates if the repository has the Discussions feature enabled.

hasIssuesEnabled

Non-null

Indicates if the repository has issues feature enabled.

hasProjectsEnabled

Non-null

Indicates if the repository has the Projects feature enabled.

hasSponsorshipsEnabled

Non-null

Indicates if the repository displays a Sponsor button for financial contributions.

hasVulnerabilityAlertsEnabled

Non-null

Whether vulnerability alerts are enabled for the repository.

hasWikiEnabled

Non-null

Indicates if the repository has wiki feature enabled.

homepageUrl

The repository's URL.

id

ID !
Non-null

The Node ID of the Repository object

interactionAbility

The interaction ability settings for this repository.

isArchived

Non-null

Indicates if the repository is unmaintained.

isBlankIssuesEnabled

Non-null

Returns true if blank issue creation is allowed

isDisabled

Non-null

Returns whether or not this repository disabled.

isEmpty

Non-null

Returns whether or not this repository is empty.

isFork

Non-null

Identifies if the repository is a fork.

isInOrganization

Non-null

Indicates if a repository is either owned by an organization, or is a private fork of an organization repository.

isLocked

Non-null

Indicates if the repository has been locked or not.

isMirror

Non-null

Identifies if the repository is a mirror.

isPrivate

Non-null

Identifies if the repository is private or internal.

isSecurityPolicyEnabled

Returns true if this repository has a security policy

isTemplate

Non-null

Identifies if the repository is a template that can be used to generate new repositories.

isUserConfigurationRepository

Non-null

Is this repository a user configuration repository?

issue

Returns a single issue from the current repository by number.

issueOrPullRequest

Returns a single issue-like object from the current repository by number.

issueTemplates

Returns a list of issue templates associated to the repository

issues

Non-null

A list of issues that have been opened in the repository.

label

Returns a single label by name

labels

A list of labels associated with the repository.

languages

A list containing a breakdown of the language composition of the repository.

latestRelease

Get the latest release for the repository if one exists.

licenseInfo

The license associated with the repository

lockReason

The reason the repository has been locked.

mentionableUsers

Non-null

A list of Users that can be mentioned in the context of the repository.

mergeCommitAllowed

Non-null

Whether or not PRs are merged with a merge commit on this repository.

mergeCommitMessage

Non-null

How the default commit message will be generated when merging a pull request.

mergeCommitTitle

Non-null

How the default commit title will be generated when merging a pull request.

mergeQueue

The merge queue for a specified branch, otherwise the default branch if not provided.

milestone

Returns a single milestone from the current repository by number.

milestones

A list of milestones associated with the repository.

mirrorUrl

The repository's original mirror URL.

name

Non-null

The name of the repository.

nameWithOwner

Non-null

The repository's name with owner.

object

A Git object in the repository

openGraphImageUrl

Non-null

The image used to represent this repository in Open Graph data.

owner

Non-null

The User owner of the repository.

packages

Non-null

A list of packages under the owner.

parent

The repository parent, if this is a fork.

pinnedDiscussions

Non-null

A list of discussions that have been pinned in this repository.

pinnedEnvironments

A list of pinned environments for this repository.

pinnedIssues

A list of pinned issues for this repository.

planFeatures

Non-null

Returns information about the availability of certain features and limits based on the repository's billing plan.

primaryLanguage

The primary language of the repository's code.

project

Find project by number.

projectV2

Finds and returns the Project according to the provided Project number.

projects

Non-null

A list of projects under the owner.

projectsResourcePath

Non-null

The HTTP path listing the repository's projects

projectsUrl

Non-null

The HTTP URL listing the repository's projects

projectsV2

Non-null

List of projects linked to this repository.

pullRequest

Returns a single pull request from the current repository by number.

pullRequestTemplates

Returns a list of pull request templates associated to the repository

pullRequests

Non-null

A list of pull requests that have been opened in the repository.

pushedAt

Identifies the date and time when the repository was last pushed to.

rebaseMergeAllowed

Non-null

Whether or not rebase-merging is enabled on this repository.

recentProjects

Non-null

Recent projects that this user has modified in the context of the owner.

ref

Fetch a given ref from the repository

refs

Fetch a list of refs from the repository

release

Lookup a single release given various criteria.

releases

Non-null

List of releases which are dependent on this repository.

repositoryTopics

Non-null

A list of applied repository-topic associations for this repository.

resourcePath

Non-null

The HTTP path for this repository

ruleset

Returns a single ruleset from the current repository by ID.

rulesets

A list of rulesets for this repository.

securityPolicyUrl

The security policy URL.

shortDescriptionHTML

Non-null

A description of the repository, rendered to HTML without any links in it.

squashMergeAllowed

Non-null

Whether or not squash-merging is enabled on this repository.

squashMergeCommitMessage

Non-null

How the default commit message will be generated when squash merging a pull request.

squashMergeCommitTitle

Non-null

How the default commit title will be generated when squash merging a pull request.

squashPrTitleUsedAsDefault

Non-null

Whether a squash merge commit can use the pull request title as default.

sshUrl

Non-null

The SSH URL to clone this repository

stargazerCount

Non-null

Returns a count of how many stargazers there are on this object

stargazers

Non-null

A list of users who have starred this starrable.

submodules

Non-null

Returns a list of all submodules in this repository parsed from the .gitmodules file as of the default branch's HEAD commit.

tempCloneToken

Temporary authentication token for cloning this repository.

templateRepository

The repository from which this repository was generated, if any.

updatedAt

Non-null

Identifies the date and time when the object was last updated.

url

Non-null

The HTTP URL for this repository

usesCustomOpenGraphImage

Non-null

Whether this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar.

viewerCanAdminister

Non-null

Indicates whether the viewer has admin permissions on this repository.

viewerCanCreateProjects

Non-null

Can the current viewer create new projects on this owner.

viewerCanSubscribe

Non-null

Check if the viewer is able to change their subscription status for the repository.

viewerCanUpdateTopics

Non-null

Indicates whether the viewer can update the topics of this repository.

viewerDefaultCommitEmail

The last commit email for the viewer.

viewerDefaultMergeMethod

Non-null

The last used merge method by the viewer or the default for the repository.

viewerHasStarred

Non-null

Returns a boolean indicating whether the viewing user has starred this starrable.

viewerPermission

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

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

visibility

Non-null

Indicates the repository's visibility level.

vulnerabilityAlert

Returns a single vulnerability alert from the current repository by number.

vulnerabilityAlerts

A list of vulnerability alerts that are on this repository.

watchers

Non-null

A list of users watching the repository.

webCommitSignoffRequired

Non-null

Whether contributors are required to sign off on web-based commits in this repository.

Interfaces

#

Also implements Node , PackageOwner , ProjectOwner , ProjectV2Recent , RepositoryInfo , Starrable , Subscribable , UniformResourceLocatable .

Usages

#

References

#

  • Field repository from Blob