text stringlengths 12 91.7k | metadata dict |
|---|---|
An organization owner must allow forks of private and internal repositories on the organization level before you can allow or disallow forks for a specific repository. For more information, see AUTOTITLE.
You can help prevent sensitive information from being exposed by disabling the ability to fork repositories in your... | {
"source": "github-docs/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository.md",
"title": "Managing the forking policy for your repository"
} |
About the push policy
[!NOTE]
The push policy is currently in and subject to change.
By default, there is no limit to the number of branches and tags that can be updated in a single push.
You can limit the number of branches and tags that can be updated in a single push to block potentially destructive pushes. This ... | {
"source": "github-docs/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-push-policy-for-your-repository.md",
"title": "Managing the push policy for your repository"
} |
About repository visibility changes
[!NOTE]
If you can't change a repository's visibility, the organization owner may have restricted the ability to change repository visibility to organization owners only. For more information, see AUTOTITLE.
Members of an can only set the visibility of repositories owned by their ... | {
"source": "github-docs/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md",
"title": "Setting repository visibility"
} |
Inviting a collaborator to a personal repository
You can send an invitation to collaborate in your repository directly to someone on , or to the person's email address..
1. Ask for the username of the person you're inviting as a collaborator. If they don't have a username yet, they can sign up for . For more informatio... | {
"source": "github-docs/repositories/managing-your-repositorys-settings-and-features/repository-access-and-collaboration/inviting-collaborators-to-a-personal-repository.md",
"title": "Inviting collaborators to a personal repository"
} |
Inviting a successor
The person you invite to be your successor must have a account.
1. Under "Successor settings", to invite a successor, begin typing a username, full name, or email address, then click their name when it appears.
!Screenshot of the "Successor settings" section. The string "octocat" is entered in ... | {
"source": "github-docs/repositories/managing-your-repositorys-settings-and-features/repository-access-and-collaboration/maintaining-ownership-continuity-of-your-personal-accounts-repositories.md",
"title": "Maintaining ownership continuity of your personal account's repositories"
} |
[!TIP]
If you require more granular access to a repository owned by your personal account, consider transferring the repository to an organization. For more information, see AUTOTITLE.
Owner access for a repository owned by a personal account
Repositories owned by personal accounts have a single owner who has full co... | {
"source": "github-docs/repositories/managing-your-repositorys-settings-and-features/repository-access-and-collaboration/permission-levels-for-a-personal-account-repository.md",
"title": "Permission levels for a personal account repository"
} |
Removing collaborator permissions from a person contributing to a repository
1. To the right of the collaborator you want to remove, click Remove.
Next steps
For reference information, see AUTOTITLE. | {
"source": "github-docs/repositories/managing-your-repositorys-settings-and-features/repository-access-and-collaboration/removing-a-collaborator-from-a-personal-repository.md",
"title": "Removing a collaborator from a personal repository"
} |
1. click Repositories.
1. Next to the repository you want to leave, click Leave.
1. Read the warning carefully, then click I understand, leave this repository.
Next steps
For reference information, see AUTOTITLE. | {
"source": "github-docs/repositories/managing-your-repositorys-settings-and-features/repository-access-and-collaboration/removing-yourself-from-a-collaborators-repository.md",
"title": "Removing yourself from a collaborator's repository"
} |
About releases
Releases are deployable software iterations you can package and make available for a wider audience to download and use.
Releases are based on Git tags, which mark a specific point in your repository's history. A tag date may be different than a release date since they can be created at different times. ... | {
"source": "github-docs/repositories/releasing-projects-on-github/about-releases.md",
"title": "About releases"
} |
About automatically generated release notes
Automatically generated release notes provide an automated alternative to manually writing release notes for your releases. With automatically generated release notes, you can quickly generate an overview of the contents of a release. Automatically generated release notes in... | {
"source": "github-docs/repositories/releasing-projects-on-github/automatically-generated-release-notes.md",
"title": "Automatically generated release notes"
} |
A configuration for a repository that labels semver releases
# .github/release.yml
changelog:
exclude:
labels:
- ignore-for-release
authors:
- octocat
categories:
- title: Breaking Changes 🛠
labels:
- Semver-Major
- breaking-change
- title: Exciting New Features 🎉... | {
"source": "github-docs/repositories/releasing-projects-on-github/automatically-generated-release-notes.md",
"title": "Automatically generated release notes"
} |
Query parameters are optional parts of a URL you can customize to share a specific web page view, such as search filter results, an issue template, or the release form page on . To create your own query parameters, you must match the key and value pair.
You must have the proper permissions for any action to use the equ... | {
"source": "github-docs/repositories/releasing-projects-on-github/automation-for-release-forms-with-query-parameters.md",
"title": "Automation for release forms with query parameters"
} |
1. Next to the release you want to use as your base, select the Compare dropdown menu, then click the tag you want to compare.
!Screenshot of a release in the releases list. A dropdown menu, labeled "Compare, is highlighted with an orange outline. | {
"source": "github-docs/repositories/releasing-projects-on-github/comparing-releases.md",
"title": "Comparing releases"
} |
Linking to the latest release
You can share a link to the latest release for a repository by adding releases/latest to the end of a repository's URL. For example, the URL for the latest release of octo-org/octo-repo is https:///octo-org/octo-repo/releases/latest.
To link directly to a download of your latest release as... | {
"source": "github-docs/repositories/releasing-projects-on-github/linking-to-releases.md",
"title": "Linking to releases"
} |
About release management
You can create new releases with release notes, @mentions of contributors, and links to binary files, as well as edit or delete existing releases. You can also create, modify, and delete releases by using the Releases API. For more information, see AUTOTITLE in the REST API documentation.
You c... | {
"source": "github-docs/repositories/releasing-projects-on-github/managing-releases-in-a-repository.md",
"title": "Managing releases in a repository"
} |
Searching for releases in a repository
You can search a repository's releases.
1. At the top of the page, in the "Find a release" field, type your query and press Enter.
Search syntax for searching releases in a repository
You can provide text in your search query which will be matched against the title, body, and tag... | {
"source": "github-docs/repositories/releasing-projects-on-github/searching-a-repositorys-releases.md",
"title": "Searching a repository's releases"
} |
[!TIP]
You can also view a release using the . For more information, see gh release view in the documentation.
Viewing releases
1. At the top of the Releases page, click Releases.
Viewing tags
1. At the top of the page, click Tags.
Further reading
AUTOTITLE | {
"source": "github-docs/repositories/releasing-projects-on-github/viewing-your-repositorys-releases-and-tags.md",
"title": "Viewing your repository's releases and tags"
} |
A repository's graphs give you information on traffic, projects that depend on the repository, contributors and commits to the repository, and a repository's forks and network. If you maintain a repository, you can use this data to get a better understanding of who's using your repository and why they're using it.
Som... | {
"source": "github-docs/repositories/viewing-activity-and-data-for-your-repository/about-repository-graphs.md",
"title": "About repository graphs"
} |
Visualizing commits in a repository
You can see all commits made to a repository in the past year (excluding merge commits) in the Commit graph.
The top graph shows commits for the entire year by week. The bottom graph shows the average number of commits by day of the week for the selected week.
Accessing the commits ... | {
"source": "github-docs/repositories/viewing-activity-and-data-for-your-repository/analyzing-changes-to-a-repositorys-content.md",
"title": "Analyzing changes to a repository's content"
} |
Viewing a repository's network
The network graph displays the branch history of the entire repository network, including fork branches. This graph is a timeline of the most recent commits, and shows up to 100 of the most recently pushed-to branches. The first row references the date and the first column references the ... | {
"source": "github-docs/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories.md",
"title": "Understanding connections between repositories"
} |
About Pulse
You can view an overview of a repository's activity through Pulse. Pulse includes a list of open and merged pull requests, open and closed issues, and a graph showing the commit activity for the top 15 users who committed to the default branch of the project in the selected time period.
Commit co-authors ar... | {
"source": "github-docs/repositories/viewing-activity-and-data-for-your-repository/using-pulse-to-view-a-summary-of-repository-activity.md",
"title": "Using Pulse to view a summary of repository activity"
} |
About the activity view
The activity view lets you see a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and authenticated users.
You can filter the view to show activity for a particular branch, a particular user, or for a... | {
"source": "github-docs/repositories/viewing-activity-and-data-for-your-repository/using-the-activity-view-to-see-changes-to-a-repository.md",
"title": "Using the activity view to see changes to a repository"
} |
About contributors
You can view the top 100 contributors to a repository, including commit co-authors, in the contributors graph. Merge commits and empty commits aren't counted as contributions for this graph.
To access the list of community contributors, visit https://github.com/REPO-OWNER/REPO-NAME/graphs/contributor... | {
"source": "github-docs/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors.md",
"title": "Viewing a project's contributors"
} |
[!NOTE]
The deployments dashboard is currently in and subject to change.
People with read access to a repository can see an overview of all current deployments and a log of past deployment activity, if the repository's deployment workflow is integrated with through the Deployments API or an app from . For more infor... | {
"source": "github-docs/repositories/viewing-activity-and-data-for-your-repository/viewing-deployment-activity-for-your-repository.md",
"title": "Viewing deployment activity for your repository"
} |
You can navigate to referring sites, excluding search engines and itself, from the links the specific paths were referred from. The popular content links to the specific content that generated traffic.
Referring sites and popular content are ordered by views and unique visitors. Full clones and visitor information upd... | {
"source": "github-docs/repositories/viewing-activity-and-data-for-your-repository/viewing-traffic-to-a-repository.md",
"title": "Viewing traffic to a repository"
} |
Adding a file to a repository on
Files that you add to a repository via a browser are limited to per file. You can add larger files, up to each, via the command line. For more information, see Adding a file to a repository using the command line. To add files larger than , you must use . For more information, see AU... | {
"source": "github-docs/repositories/working-with-files/managing-files/adding-a-file-to-a-repository.md",
"title": "Adding a file to a repository"
} |
When creating a file on , consider the following:
If you try to create a new file in a repository that you don’t have access to, we will fork the project to your personal account and help you send a pull request to the original repository after you commit your change.
File names created via the web interface can only... | {
"source": "github-docs/repositories/working-with-files/managing-files/creating-new-files.md",
"title": "Creating new files"
} |
Use a .gitattributes file to mark files that match a given "pattern" with the specified attributes. A .gitattributes file uses the same rules for matching as .gitignore files. For more information, see PATTERN FORMAT in the Git documentation.
1. Unless the .gitattributes file already exists, create a .gitattributes fil... | {
"source": "github-docs/repositories/working-with-files/managing-files/customizing-how-changed-files-appear-on-github.md",
"title": "Customizing how changed files appear on GitHub"
} |
About file and directory deletion
You can delete an individual file in your repository or an entire directory, including all the files in the directory.
If you try to delete a file or directory in a repository that you don’t have write permissions to, we'll fork the project to your personal account and help you send a ... | {
"source": "github-docs/repositories/working-with-files/managing-files/deleting-files-in-a-repository.md",
"title": "Deleting files in a repository"
} |
Editing files in your repository
[!TIP]
[!NOTE]
's file editor uses CodeMirror.
1. In your repository, browse to the file you want to edit.
1. In the text box, make any changes you need to the file.
Editing files in another user's repository
When you edit a file in another user's repository, we'll automatically for... | {
"source": "github-docs/repositories/working-with-files/managing-files/editing-files.md",
"title": "Editing files"
} |
In addition to changing the file location, you can also update the contents of your file, or give it a new name in the same commit.
Moving a file to a new location on
[!TIP]
If you try to move a file in a repository that you don’t have access to, we'll fork the project to your personal account and help you send a ... | {
"source": "github-docs/repositories/working-with-files/managing-files/moving-a-file-to-a-new-location.md",
"title": "Moving a file to a new location"
} |
Renaming a file on
Renaming a file also gives you the opportunity to move the file to a new location.
[!TIP]
If you try to rename a file in a repository that you don’t have access to, we will fork the project to your personal account and help you send a pull request to the original repository after you commit your ... | {
"source": "github-docs/repositories/working-with-files/managing-files/renaming-a-file.md",
"title": "Renaming a file"
} |
About
handles large files by storing references to the file in the repository, but not the actual file itself. To work around Git's architecture, creates a pointer file which acts as a reference to the actual file (which is stored somewhere else). manages this pointer file in your repository. When you clone the rep... | {
"source": "github-docs/repositories/working-with-files/managing-large-files/about-git-large-file-storage.md",
"title": "About Git Large File Storage"
} |
About size limits on
tries to provide abundant storage for all Git repositories, although there are hard limits for file and repository sizes sizes and recommendations for repository sizes. To ensure performance and reliability for our users, we actively monitor signals of overall repository health. Repository health... | {
"source": "github-docs/repositories/working-with-files/managing-large-files/about-large-files-on-github.md",
"title": "About large files on GitHub"
} |
If collaborators on your repository don't have installed, they won't have access to the original large file. If they attempt to clone your repository, they will only fetch the pointer files, and won't have access to any of the actual data.
[!TIP]
To help users without enabled, we recommend you set guidelines for re... | {
"source": "github-docs/repositories/working-with-files/managing-large-files/collaboration-with-git-large-file-storage.md",
"title": "Collaboration with Git Large File Storage"
} |
If there are existing files in your repository that you'd like to use with , you need to first remove them from the repository and then add them to locally. For more information, see AUTOTITLE.
[!NOTE]
Before trying to push a large file to , make sure that you've enabled on your enterprise. For more information, se... | {
"source": "github-docs/repositories/working-with-files/managing-large-files/configuring-git-large-file-storage.md",
"title": "Configuring Git Large File Storage"
} |
1. Navigate to git-lfs.com and click Download. Alternatively, you can install using a package manager:
To use Homebrew, run brew install git-lfs.
To use MacPorts, run port install git-lfs.
If you install with Homebrew or MacPorts, skip to step six.
1. On your computer, locate and unzip the downloaded file.... | {
"source": "github-docs/repositories/working-with-files/managing-large-files/installing-git-large-file-storage.md",
"title": "Installing Git Large File Storage"
} |
After installing and configuring tracking, you can move files from Git's regular tracking to . For more information, see AUTOTITLE and AUTOTITLE.
[!TIP]
If you get an error that "this exceeds 's file size limit of " when you try to push files to Git, you can use git lfs migrate instead of filter-repo, to move the l... | {
"source": "github-docs/repositories/working-with-files/managing-large-files/moving-a-file-in-your-repository-to-git-large-file-storage.md",
"title": "Moving a file in your repository to Git Large File Storage"
} |
Removing a single file
1. Remove the file from the repository's Git history using the filter-repo command. For detailed information on using these, see AUTOTITLE.
1. Navigate to your .gitattributes file.
[!NOTE]
Your .gitattributes file is generally saved within your local repository. In some cases, you may hav... | {
"source": "github-docs/repositories/working-with-files/managing-large-files/removing-files-from-git-large-file-storage.md",
"title": "Removing files from Git Large File Storage"
} |
The integrity check ensures that all referenced files in a push have been uploaded properly. If the check detects referenced files that have not been uploaded, you will receive an error message and your push will be blocked.
To resolve the error message, you must reinstall your local client to ensure that the refere... | {
"source": "github-docs/repositories/working-with-files/managing-large-files/resolving-git-large-file-storage-upload-failures.md",
"title": "Resolving Git Large File Storage upload failures"
} |
Introduction
is home to millions of open-source software projects, that you can copy, customize, and use for your own purposes.
There are different ways to get a copy of a repository's files on . You can:
Download a snapshot of a repository's files as a zip file to your own (local) computer.
Clone a repository to yo... | {
"source": "github-docs/repositories/working-with-files/using-files/downloading-files-from-github.md",
"title": "Downloading files from GitHub"
} |
Overview of source code archives
You can download a snapshot of any branch, tag, or specific commit from . These snapshots are generated by the git archive command in one of two formats: tarball or zipball. Snapshots don't contain the entire repository history. If you want the entire history, you can clone the reposito... | {
"source": "github-docs/repositories/working-with-files/using-files/downloading-source-code-archives.md",
"title": "Downloading source code archives"
} |
[!TIP]
Press "?" on any page in to see all available keyboard shortcuts.
File views show the latest version on a branch
When viewing a file on , you usually see the version at the current head of a branch. For example:
https://github.com/github/codeql/blob/main/README.md
refers to GitHub's codeql repository, and sh... | {
"source": "github-docs/repositories/working-with-files/using-files/getting-permanent-links-to-files.md",
"title": "Getting permanent links to files"
} |
<!-- If you make changes to this feature, check whether any of the changes affect languages listed in /get-started/learning-about-github/github-language-support. If so, please update the article accordingly. --
About navigating code on
Code navigation helps you to read, navigate, and understand code by showing and li... | {
"source": "github-docs/repositories/working-with-files/using-files/navigating-code-on-github.md",
"title": "Navigating code on GitHub"
} |
provides tools to view raw content, trace changes to specific lines, and explore how a file’s content has evolved over time. These insights reveal how code was developed, its current purpose, and its structure, helping you contribute effectively.
Viewing or copying the raw file content
With the raw view, you can view ... | {
"source": "github-docs/repositories/working-with-files/using-files/viewing-and-understanding-files.md",
"title": "Viewing and understanding files"
} |
Rendering and diffing images
can display several common image formats, including PNG, JPG, GIF, PSD, and SVG. In addition to simply displaying them, there are several ways to compare differences between versions of those image formats.
[!NOTE]
does not support comparing the differences between PSD files.
If you ... | {
"source": "github-docs/repositories/working-with-files/using-files/working-with-non-code-files.md",
"title": "Working with non-code files"
} |
Commit comments can only
be added to files within the source view, on a line-by-line basis.
Linking to headers
As with other rendered prose documents,
hovering over a header in your document creates a link icon. You can link readers
of your rendered prose diff to specific sections.
Viewing complex diffs
Some pull req... | {
"source": "github-docs/repositories/working-with-files/using-files/working-with-non-code-files.md",
"title": "Working with non-code files"
} |
REST
The /content/rest directory is where the GitHub REST API docs live!
The /content/rest/about-the-rest-api, /content/rest/guides and /content/rest/using-the-rest-api directories contain regular articles. These are human-editable.
The remaining directories contain an article for each group of endpoints in the Git... | {
"source": "github-docs/rest/README.md",
"title": ""
} |
About OpenAPI
OpenAPI is a specification for describing REST API interfaces. It describes the API without requiring access to the source code or additional documentation. The specification is both human and machine readable. For more information, see the OpenAPI specification documentation.
About 's OpenAPI descriptio... | {
"source": "github-docs/rest/about-the-rest-api/about-the-openapi-description-for-the-rest-api.md",
"title": "About the OpenAPI description for the REST API"
} |
You can use 's API to build scripts and applications that automate processes, integrate with , and extend . For example, you could use the API to triage issues, build an analytics dashboard, or manage releases.
Each REST API endpoint is documented individually, and the endpoints are categorized by the resource that the... | {
"source": "github-docs/rest/about-the-rest-api/about-the-rest-api.md",
"title": "About the REST API"
} |
About API versioning
About versioning and REST API versioning
versions are decoupled from REST API versions. You can upgrade your version but keep the same REST API version, as long as the API version is included in the version. Similarly, you can upgrade your REST API version without updating your version, as lo... | {
"source": "github-docs/rest/about-the-rest-api/api-versions.md",
"title": "API Versions"
} |
About breaking changes in the REST API
For more information about API versions, see AUTOTITLE.
Upgrading to a new API version
Before upgrading to a new REST API version, you should read the section on this page that corresponds to the new API version to understand what breaking changes are included and to learn more a... | {
"source": "github-docs/rest/about-the-rest-api/breaking-changes.md",
"title": "Breaking changes"
} |
About 's APIs
provides two APIs: a REST API and a GraphQL API. You can interact with both APIs using , curl, the official Octokit libraries, and third party libraries. Occasionally, a feature may be supported on one API but not the other.
You should use the API that best aligns with your needs and that you are most co... | {
"source": "github-docs/rest/about-the-rest-api/comparing-githubs-rest-api-and-graphql-api.md",
"title": "Comparing GitHub's REST API and GraphQL API"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/about-the-rest-api/index.md",
"title": "About the REST API"
} |
About artifacts in
You can use the REST API to download, delete, and retrieve information about workflow artifacts in . For more information, see AUTOTITLE.
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/actions/artifacts.md",
"title": "REST API endpoints for GitHub Actions artifacts"
} |
About the cache in
You can use the REST API to query and manage the cache for repositories in . You can also install a extension to manage your caches from the command line. For more information, see AUTOTITLE.
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/actions/cache.md",
"title": "REST API endpoints for GitHub Actions cache"
} |
About concurrency groups in
You can use the REST API to read the state of concurrency groups, which ensure that only a single job or workflow using the same group will run at a time while additional runs are pending or canceled depending on configuration. For more information, see AUTOTITLE.
<!-- Content after this s... | {
"source": "github-docs/rest/actions/concurrency-groups.md",
"title": "REST API endpoints for Actions concurrency groups"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/actions/hosted-runners.md",
"title": "GitHub-hosted runners"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/actions/index.md",
"title": "REST API endpoints for GitHub Actions"
} |
About OIDC
You can use the REST API to query and manage a customization template for an OpenID Connect (OIDC) subject claim. For more information, see AUTOTITLE.
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/actions/oidc.md",
"title": "REST API endpoints for GitHub Actions OIDC"
} |
About permissions for
You can use the REST API to set permissions for the enterprises, organizations and repositories that are allowed to run , and the actions and reusable workflows that are allowed to run. For more information, see AUTOTITLE, AUTOTITLE, and AUTOTITLE.
<!-- Content after this section is automatically... | {
"source": "github-docs/rest/actions/permissions.md",
"title": "REST API endpoints for GitHub Actions permissions"
} |
About secrets in
You can use the REST API to create, update, delete, and retrieve information about secrets that can be used in workflows in . For more information, see AUTOTITLE.
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/actions/secrets.md",
"title": "REST API endpoints for GitHub Actions Secrets"
} |
About self-hosted runner groups in
You can use the REST API to manage groups of self-hosted runners in . For more information, see AUTOTITLE.
must have the administration permission for repositories or the organizationselfhostedrunners permission for organizations. Authenticated users must have admin access to repos... | {
"source": "github-docs/rest/actions/self-hosted-runner-groups.md",
"title": "REST API endpoints for self-hosted runner groups"
} |
About self-hosted runners in
You can use the REST API to register, view, and delete self-hosted runners in . For more information, see AUTOTITLE.
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/actions/self-hosted-runners.md",
"title": "REST API endpoints for self-hosted runners"
} |
About variables in
You can use the REST API to create, update, delete, and retrieve information about variables that can be used in workflows in . For more information, see AUTOTITLE in the documentation.
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/actions/variables.md",
"title": "REST API endpoints for GitHub Actions variables"
} |
About workflow jobs in
You can use the REST API to view logs and workflow jobs in . For more information, see AUTOTITLE.
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/actions/workflow-jobs.md",
"title": "REST API endpoints for workflow jobs"
} |
About workflow runs in
You can use the REST API to view, re-run, cancel, and view logs for workflow runs in . For more information, see AUTOTITLE.
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/actions/workflow-runs.md",
"title": "REST API endpoints for workflow runs"
} |
About workflows in
You can use the REST API to view workflows for a repository in . For more information, see AUTOTITLE in the documentation.
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/actions/workflows.md",
"title": "REST API endpoints for workflows"
} |
About events
events power the various activity streams on the site.
You can use the REST API to return different types of events triggered by activity on . For more information about the specific events that you can receive, see AUTOTITLE. Endpoints for repository issues are also available. For more information, see ... | {
"source": "github-docs/rest/activity/events.md",
"title": "REST API endpoints for events"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/activity/feeds.md",
"title": "REST API endpoints for feeds"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/activity/index.md",
"title": "REST API endpoints for activity"
} |
About notifications
You can use the REST API to manage notifications. For more information about notifications, see AUTOTITLE.
All calls to these endpoints require the notifications or repo scopes. You will need the repo scope to access issues and commits from their respective endpoints.
Notifications are returned as... | {
"source": "github-docs/rest/activity/notifications.md",
"title": "REST API endpoints for notifications"
} |
Reason Name Description
------------------------
approvalrequested You were requested to review and approve a deployment. For more information, see AUTOTITLE.
assign You were assigned to the issue.
author You created the thread.
ciactivity A workflow run that you triggered was completed.
comment You commented on... | {
"source": "github-docs/rest/activity/notifications.md",
"title": "REST API endpoints for notifications"
} |
About starring
You can use the REST API to star (bookmark) a repository. Stars are shown next to repositories to show an approximate level of interest. Stars have no effect on notifications or the activity feed. For more information, see AUTOTITLE.
Starring versus watching
In August 2012, we [changed the way watching
... | {
"source": "github-docs/rest/activity/starring.md",
"title": "REST API endpoints for starring"
} |
About watching
You can use the REST API to subscribe to notifications for activity in a repository. To bookmark a repository instead, see AUTOTITLE.
Watching versus starring
In August 2012, we [changed the way watching
works](https://github.com/blog/1204-notifications-stars) on . Some API
client applications may still... | {
"source": "github-docs/rest/activity/watching.md",
"title": "REST API endpoints for watching"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/agent-tasks/agent-tasks.md",
"title": "REST API endpoints for agent tasks"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/agents/secrets.md",
"title": "REST API endpoints for agent secrets"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/agents/variables.md",
"title": "REST API endpoints for variables"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/announcement-banners/enterprises.md",
"title": "REST API endpoints for enterprise announcement banners"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/announcement-banners/index.md",
"title": "REST API endpoints for announcement banners"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/announcement-banners/organizations.md",
"title": "REST API endpoints for organization announcement banners"
} |
About
This page lists endpoints that you can access while authenticated as a . For more information, see AUTOTITLE.
See AUTOTITLE for a list of endpoints that require authentication as a installation.
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/apps/apps.md",
"title": "REST API endpoints for {% data variables.product.prodname_github_apps %}"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/apps/index.md",
"title": "REST API endpoints for apps"
} |
About installations
A installation refers to the installation of the app on an enterprise, organization or user account. For information on how to authenticate as an installation and limit access to specific repositories, see AUTOTITLE.
To list all installations for an organization, see AUTOTITLE.
<!-- Content after... | {
"source": "github-docs/rest/apps/installations.md",
"title": "REST API endpoints for {% data variables.product.prodname_github_app %} installations"
} |
About
For more information about , see AUTOTITLE.
These endpoints allow you to see which customers are using a pricing plan, see a customer's purchases, and see if an account has an active subscription.
Testing with stubbed endpoints
You can test your with stubbed data. Stubbed data is hard-coded, fake data that wil... | {
"source": "github-docs/rest/apps/marketplace.md",
"title": "REST API endpoints for {% data variables.product.prodname_marketplace %}"
} |
About and OAuth authorizations of
You can use these endpoints to manage the OAuth tokens that or use to access people's accounts on .
Tokens for have the prefix gho, while OAuth tokens for , used for authenticating on behalf of the user, have the prefix ghu. You can use the following endpoints for both types of OA... | {
"source": "github-docs/rest/apps/oauth-applications.md",
"title": "REST API endpoints for OAuth authorizations"
} |
About webhooks for
A 's webhook allows your server to receive HTTP POST payloads whenever certain events happen for a . For more information, see AUTOTITLE and AUTOTITLE.
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/apps/webhooks.md",
"title": "REST API endpoints for {% data variables.product.prodname_github_app %} webhooks"
} |
About authentication
Many REST API endpoints require authentication or return additional information if you are authenticated. Additionally, you can make more requests per hour when you are authenticated.
To authenticate your request, you will need to provide an authentication token with the required scopes or permissi... | {
"source": "github-docs/rest/authentication/authenticating-to-the-rest-api.md",
"title": "Authenticating to the REST API"
} |
<!-- The content of this page is rendered as a NextJS page component. -- | {
"source": "github-docs/rest/authentication/endpoints-available-for-fine-grained-personal-access-tokens.md",
"title": "Endpoints available for fine-grained personal access tokens"
} |
<!-- The content of this page is rendered as a NextJS page component. -- | {
"source": "github-docs/rest/authentication/endpoints-available-for-github-app-installation-access-tokens.md",
"title": "Endpoints available for GitHub App installation access tokens"
} |
<!-- The content of this page is rendered as a NextJS page component. -- | {
"source": "github-docs/rest/authentication/endpoints-available-for-github-app-user-access-tokens.md",
"title": "Endpoints available for GitHub App user access tokens"
} |
Choose an appropriate authentication method
You should choose an authentication method that is appropriate for the task you want to accomplish.
To use the API for personal use, you can create a .
To use the API on behalf of an organization or another user, you should create a .
To use the API in a workflow, you sho... | {
"source": "github-docs/rest/authentication/keeping-your-api-credentials-secure.md",
"title": "Keeping your API credentials secure"
} |
About permissions required for
When you create a , you grant it a set of permissions. Permissions define what resources the token can access via the API. For more information, see AUTOTITLE.
<!-- The content of this page is rendered as a NextJS page component. -- | {
"source": "github-docs/rest/authentication/permissions-required-for-fine-grained-personal-access-tokens.md",
"title": "Permissions required for fine-grained personal access tokens"
} |
About permissions
are created with a set of permissions. Permissions define what resources the can access via the API. For more information, see AUTOTITLE.
<!-- The content of this page is rendered as a NextJS page component. -- | {
"source": "github-docs/rest/authentication/permissions-required-for-github-apps.md",
"title": "Permissions required for GitHub Apps"
} |
About billing
You can get billing information for an enterprise. For more information, see AUTOTITLE.
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/billing/billing.md",
"title": "REST API endpoints for billing"
} |
[!IMPORTANT]
The request body schema below is missing a required field. When budgetscope is user, you must also include a user field set to the username the budget applies to. If you omit this field, the API returns HTTP 400: Missing required fields: budgetentityname. For user-scoped budgets, budgetentityname can be ... | {
"source": "github-docs/rest/billing/budgets.md",
"title": "Budgets"
} |
Required roles
The following roles can access cost center API endpoints:
Enterprise owners
Billing managers
Organization owners
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/billing/cost-centers.md",
"title": "Cost centers"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/billing/index.md",
"title": "REST API endpoints for billing"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/rest/billing/usage-reports.md",
"title": "Usage reports"
} |
The endpoints on this page return usage that is billed to the account associated with the endpoint. For help deciding which level of usage to report on, see AUTOTITLE.
User endpoints return usage that is billed directly to an individual user’s personal account. These endpoints are only applicable if the user has purc... | {
"source": "github-docs/rest/billing/usage.md",
"title": "Billing usage"
} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.