text stringlengths 12 91.7k | metadata dict |
|---|---|
About teams
You can use teams to manage access for people in an organization, and for sending notifications. Organization owners and team maintainers can give teams admin, read, or write access to organization repositories. Organization members can send a notification to an entire team by mentioning the team's name. Te... | {
"source": "github-docs/organizations/organizing-members-into-teams/about-teams.md",
"title": "About organization teams"
} |
Adding organization members to a team
1. Above the list of team members, click Add a member.
Mapping teams to LDAP groups (for instances using LDAP Sync for user authentication)
You can create a team with LDAP Sync enabled. See AUTOTITLE.
A team that's synced to an LDAP group is indicated with a special LDAP badge. Th... | {
"source": "github-docs/organizations/organizing-members-into-teams/adding-organization-members-to-a-team.md",
"title": "Adding organization members to a team"
} |
About team maintainers
People with the team maintainer role can manage team membership and settings.
Change the team's name and description
Change the team's visibility
Request to add a child team
Request to add or change a parent team
Set the team profile picture
Add organization members to the team
Remove orga... | {
"source": "github-docs/organizations/organizing-members-into-teams/assigning-the-team-maintainer-role-to-a-team-member.md",
"title": "Assigning the team maintainer role to a team member"
} |
[!TIP]
If a team has child or parent teams, you cannot make it a secret team.
1. Select the team or teams whose visibility you'd like to change.
!Screenshot of the first two teams in the list of teams. To the left of each team, a checkbox is checked and outlined in dark orange.
1. Above the list of teams, use the d... | {
"source": "github-docs/organizations/organizing-members-into-teams/changing-team-visibility.md",
"title": "Changing team visibility"
} |
Team maintainers and organization owners can enable or disable notifications for specific teams. When notifications are enabled, members of the team will receive notifications when the team is mentioned in an issue, pull request, or comment.
Disabling team notifications won't unsubscribe people that are already subscri... | {
"source": "github-docs/organizations/organizing-members-into-teams/configuring-team-notifications.md",
"title": "Configuring team notifications"
} |
Creating a team
1. Optionally, if your organization or enterprise account uses team synchronization or your enterprise uses , connect an identity provider group to your team.
If your enterprise uses , use the "Identity Provider Groups" drop-down menu, and select a single identity provider group to connect to the n... | {
"source": "github-docs/organizations/organizing-members-into-teams/creating-a-team.md",
"title": "Creating an organization team"
} |
[!TIP]
Only organization owners can delete parent teams. For more information, see AUTOTITLE.
1. Select the team or teams you'd like to delete.
!Screenshot of the first two teams in the list of teams. To the left of each team, a checkbox is checked and outlined in dark orange.
1. Above the list of teams, select the... | {
"source": "github-docs/organizations/organizing-members-into-teams/deleting-a-team.md",
"title": "Deleting a team"
} |
About code review settings
To reduce noise for your team and clarify individual responsibility for pull request reviews, you can configure code review settings.
Team notifications
Auto assignment
About team notifications
When you choose to only notify requested team members, you disable sending notifications to the ... | {
"source": "github-docs/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team.md",
"title": "Managing code review settings for your team"
} |
About scheduled reminders for teams
Team maintainers and organization owners can set scheduled reminders for any pull requests that a team has been requested to review. Before you can create a scheduled reminder for your team, an organization owner must authorize your Slack workspace. For more information, see AUTOTITL... | {
"source": "github-docs/organizations/organizing-members-into-teams/managing-scheduled-reminders-for-your-team.md",
"title": "Managing scheduled reminders for your team"
} |
Organization owners can change the parent of any team. Team maintainers can change a team's parent if they are maintainers in both the child team and the parent team. Team maintainers without maintainer permissions in the child team can request to add a parent or child team. For more information, see AUTOTITLE and AUTO... | {
"source": "github-docs/organizations/organizing-members-into-teams/moving-a-team-in-your-organizations-hierarchy.md",
"title": "Moving a team in your organization's hierarchy"
} |
Removing a member from a team revokes their access to all repositories and related resources granted through the team. This includes:
Removal from assignee fields in issues, pull requests, and project cards.
Loss of access to repository-specific tools such as , , and Wikis.
Inability to contribute to any repositorie... | {
"source": "github-docs/organizations/organizing-members-into-teams/removing-organization-members-from-a-team.md",
"title": "Removing organization members from a team"
} |
1. In the "Team name" field, type a new name for the team.
1. Optionally, in the "Description" field, type a new description of the team.
1. Click Update. | {
"source": "github-docs/organizations/organizing-members-into-teams/renaming-a-team.md",
"title": "Renaming a team"
} |
When you request to add a team as a child, a request is sent to the maintainers of the child team. Once a maintainer of the child team approves your request, the child team is nested under the parent team in your organization's hierarchy.
If you're an organization owner or you have team maintainer permissions in both t... | {
"source": "github-docs/organizations/organizing-members-into-teams/requesting-to-add-a-child-team.md",
"title": "Requesting to add a child team"
} |
When you request to add or change your team's parent, a request is sent to the maintainers of the parent team. When a maintainer of the new parent team approves your request, your team is nested as a child team under the parent team in your organization's hierarchy.
If you're an organization owner or you have team main... | {
"source": "github-docs/organizations/organizing-members-into-teams/requesting-to-add-or-change-a-parent-team.md",
"title": "Requesting to add or change a parent team"
} |
Unless you set a profile picture for a team, the team profile picture will match the organization's profile picture.
1. Under "Profile picture", click Upload new picture, then select your desired profile picture.
1. Click and drag to crop the image as needed, then click Set new team avatar. | {
"source": "github-docs/organizations/organizing-members-into-teams/setting-your-teams-profile-picture.md",
"title": "Setting your team's profile picture"
} |
About team synchronization
For more information, see AUTOTITLE and AUTOTITLE.
You can connect up to five IdP groups to a team. You can assign an IdP group to multiple teams.
Team synchronization does not support IdP groups with more than 5000 members.
Once a team is connected to an IdP group, your IdP administrator... | {
"source": "github-docs/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group.md",
"title": "Synchronizing a team with an identity provider group"
} |
The permissions for packages can be scoped either to a user or an organization or to a repository.
Granular permissions for user/organization-scoped packages
Packages with granular permissions are scoped to a personal account or organization. You can change the access control and visibility of the package separately f... | {
"source": "github-docs/packages/learn-github-packages/about-permissions-for-github-packages.md",
"title": "About permissions for GitHub Packages"
} |
A package can inherit its visibility and access permissions from a repository, or, for registries that support granular permissions, you can set the visibility and permissions of the package separately from a repository.
For the list of registries that support granular permissions, and for more information about permis... | {
"source": "github-docs/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md",
"title": "Configuring a package's access control and visibility"
} |
When you publish a package that is scoped to a personal account or an organization, the package is not linked to a repository by default. If you connect a package to a repository, the package's landing page will show information and links from the repository, such as the README. You can also choose to have the package ... | {
"source": "github-docs/packages/learn-github-packages/connecting-a-repository-to-a-package.md",
"title": "Connecting a repository to a package"
} |
Package deletion and restoration support on
On if you have the required access, you can delete:
An entire private package
An entire public package, if there's not more than 5000 downloads of any version of the package
A specific version of a private package
A specific version of a public package, if the package v... | {
"source": "github-docs/packages/learn-github-packages/deleting-and-restoring-a-package.md",
"title": "Deleting and restoring a package"
} |
About package installation
You can search on to find packages in that you can install in your own project. For more information, see AUTOTITLE.
After you find a package, you can read the package's description and installation and usage instructions on the package page.
Installing a package
You can install a package ... | {
"source": "github-docs/packages/learn-github-packages/installing-a-package.md",
"title": "Installing a package"
} |
About
is a platform for hosting and managing packages, including containers and other dependencies. combines your source code and packages in one place to provide integrated permissions management and billing, so you can centralize your software development on .
You can integrate with 's APIs, , and webhooks to cre... | {
"source": "github-docs/packages/learn-github-packages/introduction-to-github-packages.md",
"title": "Introduction to GitHub Packages"
} |
About published packages
You can help people understand and use your package by providing a description and other details like installation and usage instructions on the package page. provides metadata for each version, such as the publication date, download activity, and recent versions. For an example package page, ... | {
"source": "github-docs/packages/learn-github-packages/publishing-a-package.md",
"title": "Publishing a package"
} |
About package views
Your ability to view a package depends on several factors. By default, you can view all packages you have published.
Repository-scoped packages inherit their permissions and visibility from the repository in which the package is published. Some registries only support repository-scoped packages. For... | {
"source": "github-docs/packages/learn-github-packages/viewing-packages.md",
"title": "Viewing packages"
} |
You can find example workflows in AUTOTITLE or in any of these guides:
Publishing Node.js packages
Publishing Docker images
Publishing Java packages with Maven
Publishing Java packages with Gradle | {
"source": "github-docs/packages/managing-github-packages-using-github-actions-workflows/example-workflows-for-publishing-a-package.md",
"title": "Example workflows for publishing a package"
} |
About with
For more information, see AUTOTITLE.
You can extend the CI and CD capabilities of your repository by publishing or installing packages as part of your workflow.
Authenticating to package registries with granular permissions
Some registries support granular permissions. This means you can choose to allo... | {
"source": "github-docs/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md",
"title": "Publishing and installing a package with GitHub Actions"
} |
Introduction
In this guide, you'll create a workflow to test your code and then publish it to .
If you use a , you cannot publish a package to a repository owned by your account. To follow this guide, use a personal account on instead.
Publishing your package
1. Create a new repository on , adding the .gitignore for... | {
"source": "github-docs/packages/quickstart.md",
"title": "Quickstart for GitHub Packages"
} |
About the
For more information, see AUTOTITLE.
About migration from the Docker registry
If you've stored Docker images in the Docker registry, an enterprise owner will gradually migrate the images to the . No action is required on your part.
[!NOTE]
For more information about finding the version of that you use... | {
"source": "github-docs/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry.md",
"title": "Migrating to the Container registry from the Docker registry"
} |
[!NOTE] The Apache Maven registry is not available for .
Authenticating to
Authenticating with a
You can authenticate to with Apache Maven by editing your ~/.m2/settings.xml file to include your . Create a new ~/.m2/settings.xml file if one doesn't exist.
In the servers tag, add a child server tag with an id, repl... | {
"source": "github-docs/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry.md",
"title": "Working with the Apache Maven registry"
} |
About the
To use the on , your site administrator must first configure for your instance and enable subdomain isolation. For more information, see AUTOTITLE and AUTOTITLE.
URL for the
If you access at , you will publish packages to . Examples in this article use this URL.
If you access at another domain, such as... | {
"source": "github-docs/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md",
"title": "Working with the Container registry"
} |
Key Description
------------------
org.opencontainers.image.source The URL of the repository associated with the package. For more information, see AUTOTITLE.
org.opencontainers.image.description A text-only description limited to 512 characters. This description will appear on the package page, below the name of ... | {
"source": "github-docs/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md",
"title": "Working with the Container registry"
} |
<!-- Main versioning block. Short page for dotcom --
's Docker registry (which used the namespace docker.pkg.github.com) has been replaced by the (which uses the namespace https://ghcr.io). The offers benefits such as granular permissions and storage optimizations for Docker images.
Docker images previously stored in... | {
"source": "github-docs/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md",
"title": "Working with the Docker registry"
} |
[!NOTE] The Gradle registry is not available for .
Authenticating to
For more information about using GITHUBTOKEN with Gradle, see AUTOTITLE.
Authenticating with a
You can authenticate to with Gradle using either Gradle Groovy or Kotlin DSL by editing your build.gradle file (Gradle Groovy) or build.gradle.kts fil... | {
"source": "github-docs/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry.md",
"title": "Working with the Gradle registry"
} |
URL for the
If you access at , you will publish packages to https://npm.pkg.github.com. Examples in this article use this URL.
If you access at another domain, such as octocorp.ghe.com, replace "https://npm.pkg.github.com" with https://npm.SUBDOMAIN.ghe.com, where SUBDOMAIN is your enterprise's unique subdomain.
Li... | {
"source": "github-docs/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md",
"title": "Working with the npm registry"
} |
URL for the NuGet registry
If you access at , you will publish packages to https://nuget.pkg.github.com. Examples in this article use this URL.
If you access at another domain, such as octocorp.ghe.com, replace "https://nuget.pkg.github.com" with https://nuget.SUBDOMAIN.ghe.com, where SUBDOMAIN is your enterprise's u... | {
"source": "github-docs/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md",
"title": "Working with the NuGet registry"
} |
URL for the RubyGems registry
If you access at , you will publish packages to https://rubygems.pkg.github.com. Examples in this article use this URL.
If you access at another domain, such as octocorp.ghe.com, replace "https://rubygems.pkg.github.com" with https://rubygems.SUBDOMAIN.ghe.com, where SUBDOMAIN is your en... | {
"source": "github-docs/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md",
"title": "Working with the RubyGems registry"
} |
Supported custom domains
works with two types of domains: subdomains and apex domains. For a list of unsupported custom domains, see AUTOTITLE.
Supported custom domain type Example
------
www subdomain www.example.com
Custom subdomain blog.example.com
Apex domain example.com
You can set up either or... | {
"source": "github-docs/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages.md",
"title": "About custom domains and GitHub Pages"
} |
People with admin permissions for a repository can configure a custom domain for a site.
About custom domain configuration
Make sure you add your custom domain to your site before configuring your custom domain with your DNS provider. Configuring your custom domain with your DNS provider without adding your custom d... | {
"source": "github-docs/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md",
"title": "Managing a custom domain for your GitHub Pages site"
} |
CNAME errors
If you are publishing from a custom workflow, any CNAME file is ignored and is not required.
If you are publishing from a branch, custom domains are stored in a CNAME file in the root of your publishing source. You can add or update this file through your repository settings or manually. For more informat... | {
"source": "github-docs/pages/configuring-a-custom-domain-for-your-github-pages-site/troubleshooting-custom-domains-and-github-pages.md",
"title": "Troubleshooting custom domains and GitHub Pages"
} |
About domain verification for GitHub Pages
When you verify a custom domain for your personal account, only repositories owned by your personal account may be used to publish a site to the verified custom domain or the domain's immediate subdomains. Similarly, when you verify a custom domain for your organization, only... | {
"source": "github-docs/pages/configuring-a-custom-domain-for-your-github-pages-site/verifying-your-custom-domain-for-github-pages.md",
"title": "Verifying your custom domain for GitHub Pages"
} |
About access control for sites
With access control for , you can restrict access to your project site by publishing the site privately. A privately published site can only be accessed by people with read access to the repository the site is published from. You can use privately published sites to share your internal d... | {
"source": "github-docs/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site.md",
"title": "Changing the visibility of your GitHub Pages site"
} |
About publishing sources
Publishing from a branch
1. Make sure the branch you want to use as your publishing source already exists in your repository.
1. Under "Build and deployment", under "Source", select Deploy from a branch.
1. Under "Build and deployment", use the branch dropdown menu and select a publishing sour... | {
"source": "github-docs/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md",
"title": "Configuring a publishing source for your GitHub Pages site"
} |
1. In the file name field, type 404.html or 404.md.
1. If you named your file 404.md, add the following YAML front matter to the beginning of the file:
yaml
---
permalink: /404.html
---
1. Below the YAML front matter, if present, add the content you want to display on your 404 page.
Further reading
Front ... | {
"source": "github-docs/pages/getting-started-with-github-pages/creating-a-custom-404-page-for-your-github-pages-site.md",
"title": "Creating a custom 404 page for your GitHub Pages site"
} |
Creating a repository for your site
Creating your site
1. Decide which publishing source you want to use. See AUTOTITLE.
1. Create the entry file for your site. will look for an index.html, index.md, or README.md file as the entry file for your site.
If your publishing source is a branch and folder, the entry file... | {
"source": "github-docs/pages/getting-started-with-github-pages/creating-a-github-pages-site.md",
"title": "Creating a GitHub Pages site"
} |
Deleting your site
You can delete your site in two ways:
Delete the repository. For more information, see AUTOTITLE.
Change the source to the None branch. For more information, see Deleting your site by changing the source below.
If you want to remove the current deployment of your site but do not want to delete the ... | {
"source": "github-docs/pages/getting-started-with-github-pages/deleting-a-github-pages-site.md",
"title": "Deleting a GitHub Pages site"
} |
Usage limits
is not intended for or allowed to be used as a free web-hosting service to run your online business, e-commerce site, or any other website that is primarily directed at either facilitating commercial transactions or providing commercial software as a service (SaaS).
In addition, your use of is subject t... | {
"source": "github-docs/pages/getting-started-with-github-pages/github-pages-limits.md",
"title": "GitHub Pages limits"
} |
People with admin permissions for a repository can enforce HTTPS for a site.
About HTTPS and
All sites, including sites that are correctly configured with a custom domain, support HTTPS and HTTPS enforcement. For more information about custom domains, see AUTOTITLE and AUTOTITLE.
sites created after June 15, 2016,... | {
"source": "github-docs/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https.md",
"title": "Securing your GitHub Pages site with HTTPS"
} |
Troubleshooting 404 errors
In this guide you'll find common reasons you may be seeing a 404 error while building your site.
's Status page
DNS setup
Browser cache
index.html file
Directory contents
Custom domain
Repository
's Status page
If you see a 404 error while building a site, first check 's Status page... | {
"source": "github-docs/pages/getting-started-with-github-pages/troubleshooting-404-errors-for-github-pages-sites.md",
"title": "Troubleshooting 404 errors for GitHub Pages sites"
} |
When you unpublish your site, your current deployment is removed and the site will no longer be available. Any existing repository settings or content will not be affected.
Unpublishing a site does not permanently delete the site. For information on deleting a site, see AUTOTITLE.
1. Under , next to the Your site is li... | {
"source": "github-docs/pages/getting-started-with-github-pages/unpublishing-a-github-pages-site.md",
"title": "Unpublishing a GitHub Pages site"
} |
About custom workflows
Custom workflows allow sites to be built via the use of . You can still select the branch you would like to use via the workflow file, but you are able to do much more with the use of custom workflows. To start using custom workflows you must first enable them for your current repository. For mo... | {
"source": "github-docs/pages/getting-started-with-github-pages/using-custom-workflows-with-github-pages.md",
"title": "Using custom workflows with GitHub Pages"
} |
If the repository for your site contains submodules, their contents will automatically be pulled in when your site is built.
You can only use submodules that point to public repositories, because the server cannot access private repositories.
Use the https:// read-only URL for your submodules, including nested submod... | {
"source": "github-docs/pages/getting-started-with-github-pages/using-submodules-with-github-pages.md",
"title": "Using submodules with GitHub Pages"
} |
About
is a static site hosting service that takes HTML, CSS, and JavaScript files straight from a repository on , optionally runs the files through a build process, and publishes a website. You can see examples of sites in the examples collection.
Types of sites
There are two types of sites. Sites associated wit... | {
"source": "github-docs/pages/getting-started-with-github-pages/what-is-github-pages.md",
"title": "What is {% data variables.product.prodname_pages %}?"
} |
Introduction
In this guide, you'll create a user site at <username.github.io.
Creating your website
1. Enter username.github.io as the repository name. Replace username with your username. For example, if your username is octocat, the repository name should be octocat.github.io.
!Screenshot of settings in a repos... | {
"source": "github-docs/pages/quickstart.md",
"title": "Quickstart for GitHub Pages"
} |
About Jekyll
Jekyll is a static site generator with built-in support for and a simplified build process. Jekyll takes Markdown and HTML files and creates a complete static website based on your choice of layouts. Jekyll supports Markdown and Liquid, a templating language that loads dynamic content on your site. For mo... | {
"source": "github-docs/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md",
"title": "About GitHub Pages and Jekyll"
} |
About Jekyll build errors
If you are publishing from a branch, sometimes will not attempt to build your site after you push changes to your site's publishing source.
The person who pushed the changes hasn't verified their email address. For more information, see AUTOTITLE.
You're pushing with a deploy key. If you wa... | {
"source": "github-docs/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md",
"title": "About Jekyll build errors for GitHub Pages sites"
} |
People with write permissions for a repository can add a theme to a site using Jekyll.
Supported themes
Out of the box, the following themes are supported:
Architect
Cayman
Dinky
Hacker
Leap day
Merlot
Midnight
Minima
Minimal
Modernist
Slate
Tactile
Time machine
The jekyll-remote-theme Jekyll plugin is a... | {
"source": "github-docs/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll.md",
"title": "Adding a theme to your GitHub Pages site using Jekyll"
} |
People with write permissions for a repository can add content to a site using Jekyll.
About content in Jekyll sites
Before you can add content to a Jekyll site on , you must create a Jekyll site. For more information, see AUTOTITLE.
The main types of content for Jekyll sites are pages and posts. A page is for standa... | {
"source": "github-docs/pages/setting-up-a-github-pages-site-with-jekyll/adding-content-to-your-github-pages-site-using-jekyll.md",
"title": "Adding content to your GitHub Pages site using Jekyll"
} |
Prerequisites
Before you can use Jekyll to create a site, you must install Jekyll and Git. For more information, see Installation in the Jekyll documentation and AUTOTITLE.
Creating a repository for your site
Creating your site
1. If you don't already have a local copy of your repository, navigate to the location wh... | {
"source": "github-docs/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll.md",
"title": "Creating a GitHub Pages site with Jekyll"
} |
People with write permissions for a repository can set the Markdown processor for a site.
supports two Markdown processors: kramdown and 's own Markdown processor, which is used to render Flavored Markdown (GFM) throughout . For more information, see AUTOTITLE.
You can use Flavored Markdown with either processor.
1... | {
"source": "github-docs/pages/setting-up-a-github-pages-site-with-jekyll/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md",
"title": "Setting a Markdown processor for your GitHub Pages site using Jekyll"
} |
Anyone with read permissions for a repository can test a site locally.
Prerequisites
Before you can use Jekyll to test a site, you must:
Install Jekyll.
Create a Jekyll site. For more information, see AUTOTITLE.
Building your site locally
1. Run bundle install.
1. Run your Jekyll site locally.
shell
$ bundle... | {
"source": "github-docs/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll.md",
"title": "Testing your GitHub Pages site locally with Jekyll"
} |
Troubleshooting build errors
If Jekyll encounters an error building your site locally or on , you can use error messages to troubleshoot. For more information about error messages and how to view them, see AUTOTITLE.
If you received a generic error message, check for common issues.
You're using unsupported plugins. F... | {
"source": "github-docs/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md",
"title": "Troubleshooting Jekyll build errors for GitHub Pages sites"
} |
The final step for a pull request is to get finished work into the deployment branch. This usually means merging your changes into the release or main branch. Before that happens, you will need to confirm that the change meets the project's requirements.
Validating pre-deployment checks
Before you merge, you will conf... | {
"source": "github-docs/pull-requests/concepts/deploying-code.md",
"title": "Deploying code"
} |
Reviewing pull requests is one of the main ways people collaborate on . When you review a peer's work, you help catch issues early, share knowledge, and decide whether a change is ready to merge.
Commenting on changes
Anyone with read access can review and comment on proposed changes. As a reviewer, you can:
Leave ge... | {
"source": "github-docs/pull-requests/concepts/giving-reviews.md",
"title": "Giving reviews"
} |
When you create a pull request, you’re asking others to review your changes and provide feedback. Pull requests that are focused, clear, and easy to follow help reviewers give better feedback and make confident suggestions.
Making your changes easy to review
Clear context helps reviewers quickly understand what change... | {
"source": "github-docs/pull-requests/concepts/helping-others-review-your-changes.md",
"title": "Helping others review your changes"
} |
After you open a pull request, reviewers leave feedback that helps improve your code before it merges. Resolving that feedback means understanding each comment, making the changes it calls for, and ensuring you've addressed everything.
Understanding review feedback
Reviewers can leave general feedback, comment on spec... | {
"source": "github-docs/pull-requests/concepts/resolving-reviews.md",
"title": "Resolving reviews"
} |
When you contribute to a project, you need a safe place to write and refine code before it affects your main code base. Branches, forks, commits, and pull requests work together to give you that space, so you can experiment, check in work incrementally, and propose finished changes for review.
Isolating your work with... | {
"source": "github-docs/pull-requests/concepts/writing-code-for-a-project.md",
"title": "Writing code for a project"
} |
A fork is a copy of a repository that you own, connected to the original repository, called the upstream repository. A fork lets you make changes in your own space without affecting the upstream project, and propose those changes back with a pull request.
Why use a fork
A fork gives you an independent place to work wh... | {
"source": "github-docs/pull-requests/get-started/about-forks.md",
"title": "About forks"
} |
A pull request proposes merging code changes from one branch into another. As a collaborative feature, pull requests give you a place to discuss and review work before it becomes part of a project.
Why use pull requests
Pull requests turn a set of code changes into a conversation. Instead of merging work directly, you... | {
"source": "github-docs/pull-requests/get-started/about-pull-requests.md",
"title": "About pull requests"
} |
About stacked pull requests
Stacked pull requests are two or more pull requests in the same repository, where:
The first, or bottom, pull request targets the stack's trunk — usually your repository's default branch, such as main, though it can be any branch, such as a release branch.
Each subsequent pull request targ... | {
"source": "github-docs/pull-requests/get-started/about-stacked-prs.md",
"title": "About stacked pull requests"
} |
A pull request proposes changes on a branch separate from the main code base so others can review the changes before they are merged. This quickstart walks you through the simplest path to a pull request. You'll create a branch, make and commit changes, open a pull request, respond to feedback, and merge.
You can follo... | {
"source": "github-docs/pull-requests/get-started/pull-request-quickstart.md",
"title": "Quickstart for pull requests"
} |
Pull request reviews are how teams catch issues early and keep code quality high. This quickstart walks you through each of the main tools for a review:
Comment on code
Suggest specific edits
Submit your review and approve or request changes
Comment on the changes
Anyone with read access to a repository can review ... | {
"source": "github-docs/pull-requests/get-started/reviewing-pull-requests-quickstart.md",
"title": "Quickstart for reviewing pull requests"
} |
Prerequisites
(gh) 2.90.0 or later, and Git 2.20 or later.
Authenticate with gh auth login.
A repository you can push to.
Install the CLI extension
gh extension install github/gh-stack
[!TIP]
To use stacked pull requests with AI coding agents, like , install the gh-stack skill.
shell copy
gh skill install ... | {
"source": "github-docs/pull-requests/get-started/stacked-prs-quickstart.md",
"title": "Quickstart for stacked pull requests"
} |
Rewriting the most recent commit message
Changing a commit message creates a new commit ID. If the commit has already been pushed, you must force push the rewritten history.
Commit has not been pushed online
If the commit only exists in your local repository, amend the commit message locally.
1. On the command line, n... | {
"source": "github-docs/pull-requests/how-tos/commit-changes/changing-a-commit-message.md",
"title": "Changing a commit message"
} |
To commit to a pull request branch created from a fork, you need push access to the base repository, permission from the pull request creator, and a user-owned fork without branch restrictions that prevent your push. Only the pull request creator can allow edits to their fork. See AUTOTITLE.
1. On , navigate to the for... | {
"source": "github-docs/pull-requests/how-tos/commit-changes/committing-changes-to-a-pull-request-branch-created-from-a-fork.md",
"title": "Committing changes to a pull request branch created from a fork"
} |
To compare different versions of your repository, append /compare to your repository's path. The compare page uses base as the starting point and compare as the endpoint.
Comparing branches
Use the Compare view to compare branches or start a pull request.
1. Navigate to https:///OWNER/REPOSITORY/compare.
1. Use the ba... | {
"source": "github-docs/pull-requests/how-tos/commit-changes/comparing-commits.md",
"title": "Comparing commits"
} |
Creating a commit with multiple authors
Add one or more Co-authored-by trailers to a commit message to attribute a commit to multiple authors.
Required co-author information
Before adding a co-author, get the email address they want used in the trailer. For the commit to count as a contribution, use an email address a... | {
"source": "github-docs/pull-requests/how-tos/commit-changes/creating-a-commit-with-multiple-authors.md",
"title": "Creating a commit with multiple authors or on behalf of an organization"
} |
Creating a branch
Create a branch for a separate place to work on changes before opening a pull request.
[!NOTE]
You can only create a branch in a repository to which you have write access.
Creating a branch via the branches overview
1. Click New branch.
!Screenshot of the "Branches" page for a repository. A gree... | {
"source": "github-docs/pull-requests/how-tos/commit-changes/managing-branches-within-your-repository.md",
"title": "Managing branches within your repository"
} |
Commits are linked to the wrong user
links a commit to a user by matching the email address in the commit header to an email address on a account. If your commits are linked to the wrong user or no user, update your Git email settings and add the email address to your account.
[!NOTE]
If your commits are linked to ... | {
"source": "github-docs/pull-requests/how-tos/commit-changes/troubleshooting-commits.md",
"title": "Troubleshooting commits"
} |
[!WARNING]
When you change the base branch of your pull request, some commits may be removed from the timeline. Review comments may also become outdated because the line of code that the comment referenced may no longer be part of the changes in the pull request.
1. In the "Pull Requests" list, click the pull request ... | {
"source": "github-docs/pull-requests/how-tos/create-pull-requests/changing-the-base-branch-of-a-pull-request.md",
"title": "Changing the base branch of a pull request"
} |
Marking a pull request as ready for review
[!TIP]
You can also mark a pull request as ready for review using the . See gh pr ready in the documentation.
1. In the "Pull requests" list, click the pull request you want to mark as ready for review.
1. In the merge box, click Ready for review.
!Screenshot of the merg... | {
"source": "github-docs/pull-requests/how-tos/create-pull-requests/changing-the-stage-of-a-pull-request.md",
"title": "Changing the stage of a pull request"
} |
Before creating a pull request from a fork, fork the upstream repository and push your changes to a branch in your fork. See AUTOTITLE.
In a pull request from a fork, the base branch is where you want to merge your changes, and the compare branch is the branch in your fork that contains your changes. See AUTOTITLE.
1. ... | {
"source": "github-docs/pull-requests/how-tos/create-pull-requests/creating-a-pull-request-from-a-fork.md",
"title": "Creating a pull request from a fork"
} |
If you want to create a new branch for your pull request but don't have write permissions to the repository, you can fork the repository first. See AUTOTITLE and AUTOTITLE.
When you create your pull request, you can specify which branch you want to merge your changes into. Pull requests can only be opened between two d... | {
"source": "github-docs/pull-requests/how-tos/create-pull-requests/creating-a-pull-request.md",
"title": "Creating a pull request"
} |
Create stacked pull requests with the gh stack extension in or on the website.
[!NOTE]
Creating a stack with
1. Initialize a stack. This creates and checks out the first branch on top of your trunk branch.
shell copy
gh stack init auth-layer
1. Write code for the first layer, then stage and commit your chang... | {
"source": "github-docs/pull-requests/how-tos/create-pull-requests/creating-stacked-pull-requests.md",
"title": "Creating stacked pull requests"
} |
About keeping your pull request in sync
Before merging, update your pull request branch with changes from the base branch to catch conflicts or test failures early. You can update the branch from the pull request page when there are no merge conflicts and the branch is behind the base branch.
[!NOTE]
You may not be a... | {
"source": "github-docs/pull-requests/how-tos/create-pull-requests/keeping-your-pull-request-in-sync-with-the-base-branch.md",
"title": "Keeping your pull request in sync with the base branch"
} |
As you iterate on a stack, you often need to make changes in a lower layer, rebase to keep a linear history, or restructure its branches. The gh stack extension in handles these tasks with cascading operations that update every affected branch. See AUTOTITLE.
Making changes to a lower layer
When you are working on th... | {
"source": "github-docs/pull-requests/how-tos/create-pull-requests/managing-stacked-pull-requests.md",
"title": "Managing stacked pull requests"
} |
To request a review, you need write access to the repository. You can request a review from a person or team with read access to the repository, and they receive a notification. For complete details on permissions for requesting reviews, see AUTOTITLE.
Requesting reviews from collaborators and organization members
Su... | {
"source": "github-docs/pull-requests/how-tos/create-pull-requests/requesting-a-pull-request-review.md",
"title": "Requesting a pull request review"
} |
About auto-merge
Auto-merge merges a pull request automatically after all required reviews and status checks pass. Before you use auto-merge, it must be enabled for the repository. See AUTOTITLE.
Auto-merge is disabled if someone without write permissions pushes new changes to the head branch or switches the base branc... | {
"source": "github-docs/pull-requests/how-tos/merge-and-close-pull-requests/automatically-merging-a-pull-request.md",
"title": "Automatically merging a pull request"
} |
[!TIP]
If you opened a pull request with the wrong base branch, instead of closing it and opening a new one, you can change the base branch. See AUTOTITLE.
1. In the "Pull Requests" list, click the pull request you want to close.
1. At the bottom of the pull request, below the comment box, click Close pull request.
1.... | {
"source": "github-docs/pull-requests/how-tos/merge-and-close-pull-requests/closing-a-pull-request.md",
"title": "Closing a pull request"
} |
About merge queues
A merge queue helps merge pull requests into a busy protected branch after required checks pass. See AUTOTITLE.
Adding a pull request to a merge queue
[!NOTE]
You can use to add a pull request to a merge queue. For more information, click the "" tab at the top of this article.
1. In the "Pull Req... | {
"source": "github-docs/pull-requests/how-tos/merge-and-close-pull-requests/merging-a-pull-request-with-a-merge-queue.md",
"title": "Merging a pull request with a merge queue"
} |
About pull request merges
Merge a pull request when the proposed changes are ready and any repository requirements are satisfied. You can't merge a draft pull request.
Repository rules or branch protection may require reviews, status checks, or an up-to-date branch before merging. See AUTOTITLE.
If the base branch requ... | {
"source": "github-docs/pull-requests/how-tos/merge-and-close-pull-requests/merging-a-pull-request.md",
"title": "Merging a pull request"
} |
Stacked pull requests merge from the bottom (closest to the trunk) up.
You can merge any number of pull requests at once, as long as they form a contiguous group starting from the lowest unmerged pull request.
You cannot merge a mid-stack pull request in isolation, the pull requests below it will always merge with it... | {
"source": "github-docs/pull-requests/how-tos/merge-and-close-pull-requests/merging-stacked-pull-requests.md",
"title": "Merging stacked pull requests"
} |
Every pull request in a stack is evaluated as if it targets the base of the stack, such as main. This keeps quality consistent across every layer, but it also means a workflow can run many times for a single stack. This article explains how workflows run for a stack and how to reduce redundant CI usage.
How workflows ... | {
"source": "github-docs/pull-requests/how-tos/merge-and-close-pull-requests/optimizing-ci-for-stacked-pull-requests.md",
"title": "Optimizing CI for stacked pull requests"
} |
You can resolve simple competing line change conflicts on . For other conflicts, use the command line. See AUTOTITLE.
If is enabled for the repository, you can click Fix with in the merge box to have resolve conflicts automatically. See AUTOTITLE.
If a site administrator disables the merge conflict editor for pull r... | {
"source": "github-docs/pull-requests/how-tos/merge-and-close-pull-requests/resolving-a-merge-conflict-on-github.md",
"title": "Resolving a merge conflict on GitHub"
} |
Merge conflicts happen when competing changes are made to the same line of a file, or when one person edits a file and another person deletes the same file. See AUTOTITLE.
[!TIP]
You can use the conflict editor on to resolve competing line change merge conflicts between branches that are part of a pull request. See ... | {
"source": "github-docs/pull-requests/how-tos/merge-and-close-pull-requests/resolving-a-merge-conflict-using-the-command-line.md",
"title": "Resolving a merge conflict using the command line"
} |
About reverting a pull request
Reverting a merged pull request creates a new pull request that reverts the original merge commit. You must have write permissions in the repository.
Reverting a pull request
[!NOTE]
You may need to revert individual commits if reverting the pull request causes merge conflicts or if th... | {
"source": "github-docs/pull-requests/how-tos/merge-and-close-pull-requests/reverting-a-pull-request.md",
"title": "Reverting a pull request"
} |
Use these checks when a required status check blocks merging or pushing to a protected branch. See AUTOTITLE.
A required status check must have completed successfully in the chosen repository during the past seven days.
If a check and a commit status have the same name, both must pass when that name is required. See ... | {
"source": "github-docs/pull-requests/how-tos/merge-and-close-pull-requests/troubleshooting-required-status-checks.md",
"title": "Troubleshooting required status checks"
} |
This article covers common issues you may encounter when working with stacked pull requests and how to resolve them.
A rebase reports a conflict
When a cascading rebase encounters a conflict, gh stack rebase stops and lists the conflicted files.
To resolve the conflict and continue:
1. Open each conflicted file and re... | {
"source": "github-docs/pull-requests/how-tos/merge-and-close-pull-requests/troubleshooting-stacked-pull-requests.md",
"title": "Troubleshooting stacked pull requests"
} |
You can comment on a pull request, approve the changes, or request improvements before approving. See AUTOTITLE.
[!TIP]
If a pull request you approved has changed significantly, you can dismiss your review. The pull request will need a new review before it can be merged. See AUTOTITLE.
1. Review the changes in the pu... | {
"source": "github-docs/pull-requests/how-tos/review-pull-requests/approving-a-pull-request-with-required-reviews.md",
"title": "Approving a pull request with required reviews"
} |
[!NOTE]
Pull request authors can give upstream repository maintainers, or people with push access to the upstream repository, permission to make commits to their pull request's compare branch in a user-owned fork. See AUTOTITLE.
Modifying an active pull request locally
1. In the list of pull requests, click the pull ... | {
"source": "github-docs/pull-requests/how-tos/review-pull-requests/checking-out-pull-requests-locally.md",
"title": "Checking out pull requests locally"
} |
About pull request comments
You can comment on a pull request's Conversation tab to leave general comments, questions, or praise. You can also suggest changes that the pull request author can apply directly from your comment.
You can also comment on specific files or sections of a file in a pull request's Files changed... | {
"source": "github-docs/pull-requests/how-tos/review-pull-requests/commenting-on-a-pull-request.md",
"title": "Commenting on a pull request"
} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.