text stringlengths 12 91.7k | metadata dict |
|---|---|
Most often, connection problems occur because a firewall, proxy server, corporate network, or other network is configured in a way that blocks .
Allowing 's IP addresses
Make sure your network is configured to allow 's IP addresses. For more information, see AUTOTITLE.
Using a company or organization's network
If you... | {
"source": "github-docs/get-started/using-github/troubleshooting-connectivity-problems.md",
"title": "Troubleshooting connectivity problems"
} |
About versions of
offers different plans for storing and collaborating on code. The plan you use determines which features are available to you. For more information, see AUTOTITLE.
This website, , provides documentation for all of 's plans. If the content you're reading applies to more than one plan, you can choose ... | {
"source": "github-docs/get-started/using-github-docs/about-versions-of-github-docs.md",
"title": "About versions of GitHub Docs"
} |
<!-- markdownlint-disable search-replace --
provides several ways to access documentation content programmatically. You can retrieve individual articles as Markdown, list all available pages, search across the documentation, or point AI agents to the llms.txt file for content discovery.
Article endpoint
The Article e... | {
"source": "github-docs/get-started/using-github-docs/github-docs-api.md",
"title": "GitHub Docs API"
} |
About hover cards
When you're reading an article on and find a link to another article, you can open a hover card to get more information about the article. The hover card provides basic information about the article, so you can determine whether it will be useful to you without leaving the article you're reading.
If ... | {
"source": "github-docs/get-started/using-github-docs/using-hover-cards-on-github-docs.md",
"title": "Using hover cards on GitHub Docs"
} |
About gists
Gists provide a simple way to share code snippets with others. Every gist is a Git repository, which means that it can be forked and cloned. If you are signed in to when you create a gist, the gist will be associated with your account and you will see it in your list of gists when you navigate to your .
Gi... | {
"source": "github-docs/get-started/writing-on-github/editing-and-sharing-content-with-gists/creating-gists.md",
"title": "Creating gists"
} |
Forking gists
Each gist indicates which forks have activity, making it easy to find interesting changes from others.
Cloning gists
If you want to make local changes to a gist and push them up to the web, you can clone a gist and make commits the same as you would with any Git repository. For more information, see AUTO... | {
"source": "github-docs/get-started/writing-on-github/editing-and-sharing-content-with-gists/forking-and-cloning-gists.md",
"title": "Forking and cloning gists"
} |
Disabling comments
You can hide existing comments and prevent new comments from being added to a gist by disabling comments for the gist. You can re-enable comments at any time. This will make existing comments visible.
1. Navigate to and select the gist you want to moderate.
1. In the top right corner, select Edit.
... | {
"source": "github-docs/get-started/writing-on-github/editing-and-sharing-content-with-gists/moderating-gist-comments.md",
"title": "Moderating gist comments"
} |
Starring a gist
You can star a gist to add it to the "Starred" page. Starring makes it easy to find a gist again later.
1. Navigate to and select the gist you want to star.
1. To star the gist, click Star in the top-right corner of the page.
!Screenshot of the gist bar with the "Star" option highlighted with a dar... | {
"source": "github-docs/get-started/writing-on-github/editing-and-sharing-content-with-gists/saving-gists-with-stars.md",
"title": "Saving gists with stars"
} |
We've added some custom functionality to create Flavored Markdown, used to format prose and code across our site.
You can also interact with other users in pull requests and issues using features like @-mentions, issue and PR references, and emoji. For more information, see AUTOTITLE.
Text formatting toolbar
Every co... | {
"source": "github-docs/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github.md",
"title": "About writing and formatting on GitHub"
} |
Headings
To create a heading, add one to six <kbd</kbd symbols before your heading text. The number of <kbd</kbd you use will determine the hierarchy level and typeface size of the heading.
# A first-level heading
## A second-level heading
### A third-level heading
When you use two or more headings, GitHub automaticall... | {
"source": "github-docs/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md",
"title": "Basic writing and formatting syntax"
} |
Text that is not a quote
> Text that is a quote
Quoted text is indented with a vertical line on the left and displayed using gray type.
[!NOTE]
When viewing a conversation, you can automatically quote text in a comment by highlighting the text, then typing <kbdR</kbd. You can quote an entire comment by clicking , the... | {
"source": "github-docs/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md",
"title": "Basic writing and formatting syntax"
} |
This example
Will span two lines
However, if you are writing in an .md file, the example above would render on one line without a line break. To create a line break in an .md file, you will need to include one of the following:
Include two spaces at the end of the first line.
<pre
This example
Will s... | {
"source": "github-docs/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md",
"title": "Basic writing and formatting syntax"
} |
Will have a blank line separating both lines
Images
You can display an image by adding <kbd!</kbd and wrapping the alt text in [ ]. Alt text is a short text equivalent of the information in the image. Then, wrap the link for the image in parentheses ().
!Screenshot of a comment on a GitHub issue showing an image, adde... | {
"source": "github-docs/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md",
"title": "Basic writing and formatting syntax"
} |
Introduction
You can use Markdown syntax, along with some additional HTML tags, to format your writing on , in places like repository READMEs and comments on pull requests and issues. In this guide, you'll learn some advanced formatting features by creating or editing a README for your profile.
If you're new to Markd... | {
"source": "github-docs/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github.md",
"title": "Quickstart for writing on GitHub"
} |
About tasklists
[!IMPORTANT]
Tasklist blocks are . You can read more about this on the Blog.
You can use sub-issues as the replacement for tasklist blocks. Sub-issues provide a dedicated section within each issue, making it easier to track related work without relying on Markdown. For more information about sub-is... | {
"source": "github-docs/get-started/writing-on-github/working-with-advanced-formatting/about-tasklists.md",
"title": "About tasklists"
} |
[!NOTE]
For public repositories, uploaded files can be accessed without authentication. In the case of private and internal repositories, only people with access to the repository can view the uploaded files.
To attach a file to an issue or pull request conversation, drag and drop it into the comment box.
Alternativel... | {
"source": "github-docs/get-started/writing-on-github/working-with-advanced-formatting/attaching-files.md",
"title": "Attaching files"
} |
URLs
automatically creates links from standard URLs.
Visit https://github.com
For more information on creating links, see AUTOTITLE.
Issues and pull requests
Within conversations on , references to issues and pull requests are automatically converted to shortened links.
[!NOTE]
Autolinked references are not created... | {
"source": "github-docs/get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls.md",
"title": "Autolinked references and URLs"
} |
Linking to code
This type of permanent link will render as a code snippet only in the repository it originated in. In other repositories, the permalink code snippet will render as a URL. This does not work in Markdown files, only in comments.
[!TIP]
To create a permalink for an entire file, see AUTOTITLE.
1. Locate t... | {
"source": "github-docs/get-started/writing-on-github/working-with-advanced-formatting/creating-a-permanent-link-to-a-code-snippet.md",
"title": "Creating a permanent link to a code snippet"
} |
Fenced code blocks
You can create fenced code blocks by placing triple backticks <code\\\</code before and after the code block. We recommend placing a blank line before and after code blocks to make the raw formatting easier to read.
function test() {
console.log("notice the blank line before this function?");
}
[!... | {
"source": "github-docs/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks.md",
"title": "Creating and highlighting code blocks"
} |
About creating diagrams
You can create diagrams in Markdown using four different syntaxes: mermaid, geoJSON, topoJSON, and ASCII STL. Diagram rendering is available in , , pull requests, wikis, and Markdown files.
Creating Mermaid diagrams
Mermaid is a Markdown-inspired tool that renders text into diagrams. For exampl... | {
"source": "github-docs/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams.md",
"title": "Creating diagrams"
} |
Creating a collapsed section
You can temporarily obscure sections of your Markdown by creating a collapsed section that the reader can choose to expand. For example, when you want to include technical details in an issue comment that may not be relevant or interesting to every reader, you can put those details in a col... | {
"source": "github-docs/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections.md",
"title": "Organizing information with collapsed sections"
} |
Creating a table
You can create tables with pipes and hyphens -. Hyphens are used to create each column's header, while pipes separate each column. You must include a blank line before your table in order for it to correctly render.
| First Header | Second Header |
| ------------- | ------------- |
| Content Cell | ... | {
"source": "github-docs/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-tables.md",
"title": "Organizing information with tables"
} |
Linking a pull request to an issue
To link a pull request to an issue to show that a fix is in progress and to automatically close the issue when someone merges the pull request, type one of the following keywords followed by a reference to the issue. For example, Closes 10 or Fixes octo-org/octo-repo100.
<!-- markdown... | {
"source": "github-docs/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests.md",
"title": "Using keywords in issues and pull requests"
} |
About writing mathematical expressions
To enable clear communication of mathematical expressions, supports LaTeX formatted math within Markdown. For more information, see LaTeX/Mathematics in Wikibooks.
's math rendering capability uses MathJax; an open source, JavaScript-based display engine. MathJax supports a wide ... | {
"source": "github-docs/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions.md",
"title": "Writing mathematical expressions"
} |
Saved replies allow you to create a reusable response to issues and pull requests. Save time by creating a saved reply for the responses you use most frequently.
Once you've added a saved reply, it can be used in issues, pull requests, and discussions. Saved replies are tied to your personal account. Once they're creat... | {
"source": "github-docs/get-started/writing-on-github/working-with-saved-replies/about-saved-replies.md",
"title": "About saved replies"
} |
1. Under "Add a saved reply", add a title for your saved reply.
1. In the "Write" field, add the content you'd like to use for the saved reply. For information on using Markdown, see AUTOTITLE.
1. To review your reply, click Preview.
1. Click Add saved reply.
Further reading
AUTOTITLE
AUTOTITLE
AUTOTITLE | {
"source": "github-docs/get-started/writing-on-github/working-with-saved-replies/creating-a-saved-reply.md",
"title": "Creating a saved reply"
} |
1. Under "Saved replies", next to the saved reply you want to delete, click . | {
"source": "github-docs/get-started/writing-on-github/working-with-saved-replies/deleting-a-saved-reply.md",
"title": "Deleting a saved reply"
} |
1. Under "Saved replies," next to the saved reply you want to edit, click .
1. Under "Edit saved reply," edit the title or content of the saved reply.
1. Click Update saved reply.
Further reading
AUTOTITLE
AUTOTITLE
AUTOTITLE | {
"source": "github-docs/get-started/writing-on-github/working-with-saved-replies/editing-a-saved-reply.md",
"title": "Editing a saved reply"
} |
1. Click the desired issue or pull request.
1. To add a saved reply, above the comment field, select .
!Screenshot of a comment box. On the toolbar, a reply button with a left-facing curved arrow is outlined in dark orange.
1. From the list, select the saved reply you'd like to add to your comment. Optionally, edit... | {
"source": "github-docs/get-started/writing-on-github/working-with-saved-replies/using-saved-replies.md",
"title": "Using saved replies"
} |
About
For more information about what you can do with , see the manual.
What's the difference between and Git on the command line?
The Git command line interface (git) allows you to work with a local or remote Git repository. The remote repository may be hosted on or it may be hosted by another service.
(gh) is s... | {
"source": "github-docs/github-cli/github-cli/about-github-cli.md",
"title": "About GitHub CLI"
} |
About extensions
For more information about how to use extensions, see AUTOTITLE.
You need a repository for each extension that you create. The repository name must start with gh-. The rest of the repository name is the name of the extension. The repository must have an executable file at its root with the same name... | {
"source": "github-docs/github-cli/github-cli/creating-github-cli-extensions.md",
"title": "Creating GitHub CLI extensions"
} |
To view all top-level commands, enter gh without arguments.
gh
To list all of the subcommands that you can use with a command, use the top-level command without arguments.
gh COMMAND
For example, to view the environment variables that you can set to affect certain aspects of , use the environment command.
gh environm... | {
"source": "github-docs/github-cli/github-cli/github-cli-reference.md",
"title": "GitHub CLI reference"
} |
Why collects telemetry
As agentic adoption of grows, visibility into how features are used in practice helps improve the product. Telemetry data helps us prioritize development work and evaluate whether features meet real user needs.
For example, when a new subcommand is shipped, telemetry reveals whether anyone is ... | {
"source": "github-docs/github-cli/github-cli/github-cli-telemetry.md",
"title": "GitHub CLI telemetry"
} |
About
Prerequisites
Some useful commands
[!NOTE]
When you use some commands for the first time - for example, gh codespace SUBCOMMAND - you'll be prompted to add extra scopes to your authentication token. Follow the onscreen instructions.
Viewing your status
Enter gh status to see details of your current work on ... | {
"source": "github-docs/github-cli/github-cli/quickstart.md",
"title": "GitHub CLI quickstart"
} |
About extensions
[!NOTE]
Extensions outside of and are not certified by and are governed by separate terms of service, privacy policy, and support documentation. To mitigate risk when using third-party extensions, audit the source code of the extension before installing or updating the extension.
For more inform... | {
"source": "github-docs/github-cli/github-cli/using-github-cli-extensions.md",
"title": "Using GitHub CLI extensions"
} |
If you have accounts on multiple platforms, such as a personal account on and a on , you can authenticate with gh auth login for each account.
You'll need to authenticate to run any commands in a given environment. For example, even if you're running a command that only requires read access to a public repository on... | {
"source": "github-docs/github-cli/github-cli/using-multiple-accounts.md",
"title": "Using the GitHub CLI across GitHub platforms"
} |
As of July 30, 2026, has been fully . The playground, model catalog, inference API, and bring your own key (BYOK) are no longer available to any customer.
was a separate service from and is unrelated to services.
Where to go next
For new and existing projects that need AI model access, Azure AI Foundry offers a b... | {
"source": "github-docs/github-models/index.md",
"title": "GitHub Models"
} |
GraphQL
The /content/graphql directory is where the GitHub GraphQL API docs live!
The /content/graphql/guides and /content/graphql/overview directories contain articles that are human-editable.
The /content/graphql/reference directory contains an article for each GraphQL data type used in the GitHub GraphQL API. This... | {
"source": "github-docs/graphql/README.md",
"title": ""
} |
Authenticating with GraphQL
You can authenticate to the GraphQL API using a , , or .
Authenticating with a
To authenticate with a , follow the steps in AUTOTITLE. The data that you are requesting will dictate which scopes or permissions you will need.
For example, select the "issues:read" permission to read all of th... | {
"source": "github-docs/graphql/guides/forming-calls-with-graphql.md",
"title": "Forming calls with GraphQL"
} |
GraphQL terminology
The GitHub GraphQL API represents an architectural and conceptual shift from the GitHub REST API. You will likely encounter some new terminology in the GraphQL API reference docs.
Schema
A schema defines a GraphQL API's type system. It describes the complete set of possible data (objects, fields, r... | {
"source": "github-docs/graphql/guides/introduction-to-graphql.md",
"title": "Introduction to GraphQL"
} |
About managing enterprise accounts with GraphQL
To help you monitor and make changes in your organizations and maintain compliance, you can use the Enterprise Accounts API and the Audit Log API, which are only available as GraphQL APIs.
The enterprise account endpoints work for both GitHub Enterprise Cloud and for GitH... | {
"source": "github-docs/graphql/guides/managing-enterprise-accounts.md",
"title": "Managing enterprise accounts"
} |
Differences in API logic
provides two APIs: a REST API and a GraphQL API. For more information about 's APIs, see AUTOTITLE.
Migrating from REST to GraphQL represents a significant shift in API logic. The differences between REST as a style and GraphQL as a specification make it difficult—and often undesirable&m... | {
"source": "github-docs/graphql/guides/migrating-from-rest-to-graphql.md",
"title": "Migrating from REST to GraphQL"
} |
Background
The GraphQL API currently supports two types of global node ID formats. The legacy format will be and replaced with a new format. This guide shows you how to migrate to the new format, if necessary.
By migrating to the new format, you ensure that the response times of your requests remain consistent and sm... | {
"source": "github-docs/graphql/guides/migrating-graphql-global-node-ids.md",
"title": "Migrating GraphQL global node IDs"
} |
You can access most objects in GitHub (users, issues, pull requests, etc.) using either the REST API or the GraphQL API. You can find the global node ID of many objects from within the REST API and use these IDs in your GraphQL operations. For more information, see Preview GraphQL API Node IDs in REST API resources.
[... | {
"source": "github-docs/graphql/guides/using-global-node-ids.md",
"title": "Using global node IDs"
} |
[!WARNING]
The GraphQL Explorer was removed from the documentation on November 11, 2025. See our changelog announcement.
Using GraphQL client IDEs
There are many open-source GraphQL client IDEs you can use to access 's GraphQL API.
See AUTOTITLE for extensive information on HTTP methods, authentication, and GraphQL c... | {
"source": "github-docs/graphql/guides/using-graphql-clients.md",
"title": "Using GraphQL Clients"
} |
About pagination
's GraphQL API limits the number of items that you can fetch in a single request in order to protect against excessive or abusive requests to GitHub's servers. When you use the GraphQL API, you must supply a first or last argument on any connection. The value of these arguments must be between 1 and 10... | {
"source": "github-docs/graphql/guides/using-pagination-in-the-graphql-api.md",
"title": "Using pagination in the GraphQL API"
} |
The GraphQL API allows you to get, create, edit, and delete discussion posts. For more information about , see AUTOTITLE.
This API is available for authenticated users, , and GitHub Apps. Access tokens require the repo scope for private repositories and the publicrepo scope for public repositories. For more informatio... | {
"source": "github-docs/graphql/guides/using-the-graphql-api-for-discussions.md",
"title": "Using the GraphQL API for Discussions"
} |
Overview
Here are some quick links to get you up and running with the GraphQL API:
Authentication
Root endpoint
Schema introspection
Rate limits
Migrating from REST
For more information about 's APIs, see AUTOTITLE.
About GraphQL
The GraphQL data query language is:
A specification. The spec determines the validi... | {
"source": "github-docs/graphql/overview/about-the-graphql-api.md",
"title": "About the GraphQL API"
} |
About breaking changes
Breaking changes are any changes that might require action from our integrators. We divide these changes into two categories:
Breaking: Changes that will break existing queries to the GraphQL API. For example, removing a field would be a breaking change.
Dangerous: Changes that won't break exis... | {
"source": "github-docs/graphql/overview/breaking-changes.md",
"title": "Breaking changes"
} |
Breaking changes include changes that will break existing queries or could affect the runtime behavior of clients. For a list of breaking changes and when they will occur, see our breaking changes log.
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/graphql/overview/changelog/index.md",
"title": "Changelog"
} |
You can perform introspection against the GraphQL API directly.
Alternatively, you can download the latest version of the public schema here:
schema.docs.graphql
schema.docs.graphql
schema.docs-enterprise.graphql () | {
"source": "github-docs/graphql/overview/public-schema.md",
"title": "Public schema"
} |
Primary rate limit
Rate limits are disabled by default for . Contact your site administrator to confirm the rate limits for your instance.
If you are a site administrator, you can set rate limits for your instance. For more information, see AUTOTITLE.
If you are developing an app for users or organizations outside of y... | {
"source": "github-docs/graphql/overview/rate-limits-and-query-limits-for-the-graphql-api.md",
"title": "Rate limits and query limits for the GraphQL API"
} |
Header name Description
----------------------
x-ratelimit-limit The maximum number of points that you can use per hour
x-ratelimit-remaining The number of points remaining in the current rate limit window
x-ratelimit-used The number of points you have used in the current rate limit window
x-ratelimit-reset The ti... | {
"source": "github-docs/graphql/overview/rate-limits-and-query-limits-for-the-graphql-api.md",
"title": "Rate limits and query limits for the GraphQL API"
} |
Field Description
----------------------
limit The maximum number of points that you can use per hour
remaining The number of points remaining in the current rate limit window
used The number of points you have used in the current rate limit window
resetAt The time at which the current rate limit window resets, in... | {
"source": "github-docs/graphql/overview/rate-limits-and-query-limits-for-the-graphql-api.md",
"title": "Rate limits and query limits for the GraphQL API"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/graphql/reference/actions.md",
"title": "Actions"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/graphql/reference/activity.md",
"title": "Activity"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/graphql/reference/apps.md",
"title": "GitHub Apps"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/graphql/reference/branches.md",
"title": "Branches"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/graphql/reference/checks.md",
"title": "Checks"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/graphql/reference/commits.md",
"title": "Commits"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/graphql/reference/copilot.md",
"title": "Copilot"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/graphql/reference/dependabot.md",
"title": "Dependabot"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/graphql/reference/dependency-graph.md",
"title": "Dependency graph"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/graphql/reference/deploy-keys.md",
"title": "Deploy keys"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/graphql/reference/deployments.md",
"title": "Deployments"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/graphql/reference/discussions.md",
"title": "Discussions"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/graphql/reference/enterprise-admin.md",
"title": "Enterprise administration"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/graphql/reference/gists.md",
"title": "Gists"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/graphql/reference/git.md",
"title": "Git"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/graphql/reference/index.md",
"title": "Reference"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/graphql/reference/issues.md",
"title": "Issues"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/graphql/reference/licenses.md",
"title": "Licenses"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/graphql/reference/meta.md",
"title": "Meta"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/graphql/reference/migrations.md",
"title": "Migrations"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/graphql/reference/orgs.md",
"title": "Organizations"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/graphql/reference/other.md",
"title": "Other"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/graphql/reference/packages.md",
"title": "Packages"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/graphql/reference/projects-classic.md",
"title": "Projects (classic)"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/graphql/reference/projects.md",
"title": "Projects"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/graphql/reference/pulls.md",
"title": "Pull requests"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/graphql/reference/reactions.md",
"title": "Reactions"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/graphql/reference/releases.md",
"title": "Releases"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/graphql/reference/repos.md",
"title": "Repositories"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/graphql/reference/search.md",
"title": "Search"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/graphql/reference/security-advisories.md",
"title": "Security advisories"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/graphql/reference/sponsors.md",
"title": "Sponsors"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/graphql/reference/teams.md",
"title": "Teams"
} |
<!-- Content after this section is automatically generated -- | {
"source": "github-docs/graphql/reference/users.md",
"title": "Users"
} |
Integrations are tools that extend 's functionality. Integrations can do things on like open issues, comment on pull requests, and manage projects. They can also do things outside of based on events that happen on . For example, an integration can post on Slack when an issue is opened on .
Many integrations are , wo... | {
"source": "github-docs/integrations/concepts/about-building-integrations.md",
"title": "About building integrations"
} |
Integrations are tools that extend functionality by allowing you to connect your account with other applications and services, enabling you to streamline your workflow and enhance collaboration.
With integrations, you can automate tasks, receive notifications, and access features directly from your favorite tools. I... | {
"source": "github-docs/integrations/concepts/about-integrations.md",
"title": "About GitHub integrations"
} |
Editor tools
You can connect to repositories within third-party editor tools such as .
for
With the for extension, you can work in repositories without leaving . For more information, see the official extension site or documentation.
for
With the for extension, you can review and manage pull requests in .... | {
"source": "github-docs/integrations/concepts/featured-github-integrations.md",
"title": "Featured GitHub integrations"
} |
Building an application that integrates with ? Register for our Developer Program! The possibilities are endless, and you enjoy the kudos. Register now.
Scratch an itch
Build your own tools that seamlessly integrate with APIs. For more information, see AUTOTITLE.
Have an integration that works with GitHub?
Awesome! ... | {
"source": "github-docs/integrations/concepts/github-developer-program.md",
"title": "GitHub Developer Program"
} |
You can customize your notifications by subscribing to activity that is relevant to your Slack channel, and unsubscribing from activity that is less helpful to your project.
Notifications enabled by default
The following notifications are enabled by default, but you can disable any of them using the /github unsubscrib... | {
"source": "github-docs/integrations/how-tos/slack/customize-notifications.md",
"title": "Customizing notifications for GitHub in Slack"
} |
EventDescription
------------------
reviewsPull request reviews.
workflowsActions workflow runs.
branchesCreated or deleted branches.
commentsNew comments on issues and pull requests.
commitsAll commits to any branch.
discussionsDiscussions created or answered.
+label:"your label"Issues, pull-requests and comments base... | {
"source": "github-docs/integrations/how-tos/slack/customize-notifications.md",
"title": "Customizing notifications for GitHub in Slack"
} |
Example configurationDescription
------------------
/github subscribe owner/repo commitsReceive commit notifications for the default branch.
/github subscribe owner/repo commits:mainOnly receive commit notifications for the main branch.
/github subscribe owner/repo commits:feature/Receive commit notifications for all b... | {
"source": "github-docs/integrations/how-tos/slack/customize-notifications.md",
"title": "Customizing notifications for GitHub in Slack"
} |
Branches
Creating label filters
To create a label filter, use the following command format:
/github subscribe [owner/repo] +label:"your label"
This creates a required-label filter with the value your label. Incoming events that support filters are discarded unless they have that label.
Updating label filters
You can ... | {
"source": "github-docs/integrations/how-tos/slack/customize-notifications.md",
"title": "Customizing notifications for GitHub in Slack"
} |
FilterDescription
------------------
nameFilter by the name of the workflow.
actorFilter by the user who triggered the workflow.
branchFilter by the branch the workflow is running on. In cases where the pullrequest event is included, the branch will be the target branch the pull request is created for.
eventFilter by t... | {
"source": "github-docs/integrations/how-tos/slack/customize-notifications.md",
"title": "Customizing notifications for GitHub in Slack"
} |
About the integration for Slack
The integration for Slack gives you and your teams full visibility into your projects directly in Slack channels. You can generate ideas, triage issues and collaborate with other teams to move projects forward, all without leaving Slack.
With the integration for Slack, you can:
Get ... | {
"source": "github-docs/integrations/how-tos/slack/integrate-github-with-slack.md",
"title": "Integrating GitHub with Slack"
} |
The integration for Slack allows you to connect your account to the app in Slack. Once connected, you can use slash commands to interact with , receive notifications about repository activity, and collaborate with your team directly within Slack.
Connecting your account to the app in Slack
[!NOTE] Before you can ... | {
"source": "github-docs/integrations/how-tos/slack/use-github-in-slack.md",
"title": "Using GitHub in Slack"
} |
CommandDescription
------------------
/github helpDisplays a list of essential commands and their descriptions.
/github subscribe owner/repoSubscribes the channel to notifications for the specified repository.
/github unsubscribe owner/repoUnsubscribes the channel from notifications for the specified repository.
/githu... | {
"source": "github-docs/integrations/how-tos/slack/use-github-in-slack.md",
"title": "Using GitHub in Slack"
} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.