зеркало из https://github.com/github/docs.git
Part 3: Third fourth content unordered lists from dash to asterisk (#51097)
This commit is contained in:
Grace Park
GitHub
Родитель
6acca22e47
Коммит
e3a169c100
|
|
@ -78,9 +78,9 @@ An apex domain is configured with an `A`, `ALIAS`, or `ANAME` record through you
|
|||
|
||||
There are a couple of reasons your site might be automatically disabled.
|
||||
|
||||
- If you downgrade from {% data variables.product.prodname_pro %} to {% data variables.product.prodname_free_user %}, any {% data variables.product.prodname_pages %} sites that are currently published from private repositories in your account will be unpublished. For more information, see "[AUTOTITLE](/billing/managing-the-plan-for-your-github-account/downgrading-your-accounts-plan)."
|
||||
- If you transfer a private repository to a personal account that is using {% data variables.product.prodname_free_user %}, the repository will lose access to the {% data variables.product.prodname_pages %} feature, and the currently published {% data variables.product.prodname_pages %} site will be unpublished. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/transferring-a-repository)."
|
||||
* If you downgrade from {% data variables.product.prodname_pro %} to {% data variables.product.prodname_free_user %}, any {% data variables.product.prodname_pages %} sites that are currently published from private repositories in your account will be unpublished. For more information, see "[AUTOTITLE](/billing/managing-the-plan-for-your-github-account/downgrading-your-accounts-plan)."
|
||||
* If you transfer a private repository to a personal account that is using {% data variables.product.prodname_free_user %}, the repository will lose access to the {% data variables.product.prodname_pages %} feature, and the currently published {% data variables.product.prodname_pages %} site will be unpublished. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/transferring-a-repository)."
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/pages/configuring-a-custom-domain-for-your-github-pages-site/troubleshooting-custom-domains-and-github-pages)"
|
||||
* "[AUTOTITLE](/pages/configuring-a-custom-domain-for-your-github-pages-site/troubleshooting-custom-domains-and-github-pages)"
|
||||
|
|
|
|||
|
|
@ -49,8 +49,8 @@ To set up an apex domain, such as `example.com`, you must configure a custom dom
|
|||
{% data reusables.pages.sidebar-pages %}
|
||||
1. Under "Custom domain", type your custom domain, then click **Save**. If you are publishing your site from a branch, this will create a commit that adds a `CNAME` file directly to the root of your source branch. If you are publishing your site with a custom {% data variables.product.prodname_actions %} workflow, no `CNAME` file is created, so you need to create one manually (containing only a line of text with your custom domain). For more information about your publishing source, see "[AUTOTITLE](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)."
|
||||
1. Navigate to your DNS provider and create either an `ALIAS`, `ANAME`, or `A` record. You can also create `AAAA` records for IPv6 support. If you're implementing IPv6 support, we highly recommend using an `A` record in addition to your `AAAA` record, due to slow adoption of IPv6 globally. {% data reusables.pages.contact-dns-provider %}
|
||||
- To create an `ALIAS` or `ANAME` record, point your apex domain to the default domain for your site. {% data reusables.pages.default-domain-information %}
|
||||
- To create `A` records, point your apex domain to the IP addresses for {% data variables.product.prodname_pages %}.
|
||||
* To create an `ALIAS` or `ANAME` record, point your apex domain to the default domain for your site. {% data reusables.pages.default-domain-information %}
|
||||
* To create `A` records, point your apex domain to the IP addresses for {% data variables.product.prodname_pages %}.
|
||||
|
||||
```shell
|
||||
185.199.108.153
|
||||
|
|
@ -59,7 +59,7 @@ To set up an apex domain, such as `example.com`, you must configure a custom dom
|
|||
185.199.111.153
|
||||
```
|
||||
|
||||
- To create `AAAA` records, point your apex domain to the IP addresses for {% data variables.product.prodname_pages %}.
|
||||
* To create `AAAA` records, point your apex domain to the IP addresses for {% data variables.product.prodname_pages %}.
|
||||
|
||||
```shell
|
||||
2606:50c0:8000::153
|
||||
|
|
@ -71,7 +71,7 @@ To set up an apex domain, such as `example.com`, you must configure a custom dom
|
|||
{% indented_data_reference reusables.pages.wildcard-dns-warning spaces=3 %}
|
||||
{% data reusables.command_line.open_the_multi_os_terminal %}
|
||||
1. To confirm that your DNS record configured correctly, use the `dig` command, replacing _EXAMPLE.COM_ with your apex domain. Confirm that the results match the IP addresses for {% data variables.product.prodname_pages %} above.
|
||||
- For `A` records:
|
||||
* For `A` records:
|
||||
|
||||
```shell
|
||||
$ dig EXAMPLE.COM +noall +answer -t A
|
||||
|
|
@ -81,7 +81,7 @@ To set up an apex domain, such as `example.com`, you must configure a custom dom
|
|||
> EXAMPLE.COM 3600 IN A 185.199.111.153
|
||||
```
|
||||
|
||||
- For `AAAA` records:
|
||||
* For `AAAA` records:
|
||||
|
||||
```shell
|
||||
$ dig EXAMPLE.COM +noall +answer -t AAAA
|
||||
|
|
@ -181,4 +181,4 @@ If you get an error about a custom domain being taken, you may need to remove th
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/pages/configuring-a-custom-domain-for-your-github-pages-site/troubleshooting-custom-domains-and-github-pages)"
|
||||
* "[AUTOTITLE](/pages/configuring-a-custom-domain-for-your-github-pages-site/troubleshooting-custom-domains-and-github-pages)"
|
||||
|
|
|
|||
|
|
@ -26,10 +26,10 @@ For your site to render at the correct domain, make sure your CNAME file still e
|
|||
|
||||
Then, make sure the CNAME file is formatted correctly.
|
||||
|
||||
- The CNAME filename must be all uppercase.
|
||||
- The CNAME file can contain only one domain. To point multiple domains to your site, you must set up a redirect through your DNS provider.
|
||||
- The CNAME file must contain the domain name only. For example, `www.example.com`, `blog.example.com`, or `example.com`.
|
||||
- The domain name must be unique across all {% data variables.product.prodname_pages %} sites. For example, if another repository's CNAME file contains `example.com`, you cannot use `example.com` in the CNAME file for your repository.
|
||||
* The CNAME filename must be all uppercase.
|
||||
* The CNAME file can contain only one domain. To point multiple domains to your site, you must set up a redirect through your DNS provider.
|
||||
* The CNAME file must contain the domain name only. For example, `www.example.com`, `blog.example.com`, or `example.com`.
|
||||
* The domain name must be unique across all {% data variables.product.prodname_pages %} sites. For example, if another repository's CNAME file contains `example.com`, you cannot use `example.com` in the CNAME file for your repository.
|
||||
|
||||
## DNS misconfiguration
|
||||
|
||||
|
|
@ -37,17 +37,17 @@ If you have trouble pointing the default domain for your site to your custom dom
|
|||
|
||||
You can also use one of the following methods to test whether your custom domain's DNS records are configured correctly:
|
||||
|
||||
- A CLI tool such as `dig`. For more information, see "[AUTOTITLE](/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site)".
|
||||
- An online DNS lookup tool.
|
||||
* A CLI tool such as `dig`. For more information, see "[AUTOTITLE](/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site)".
|
||||
* An online DNS lookup tool.
|
||||
|
||||
## Custom domain names that are unsupported
|
||||
|
||||
If your custom domain is unsupported, you may need to change your domain to a supported domain. You can also contact your DNS provider to see if they offer forwarding services for domain names.
|
||||
|
||||
Make sure your site does not:
|
||||
- Use more than one apex domain. For example, both `example.com` and `anotherexample.com`.
|
||||
- Use more than one `www` subdomain. For example, both `www.example.com` and `www.anotherexample.com`.
|
||||
- Use both an apex domain and custom subdomain. For example, both `example.com` and `docs.example.com`.
|
||||
* Use more than one apex domain. For example, both `example.com` and `anotherexample.com`.
|
||||
* Use more than one `www` subdomain. For example, both `www.example.com` and `www.anotherexample.com`.
|
||||
* Use both an apex domain and custom subdomain. For example, both `example.com` and `docs.example.com`.
|
||||
|
||||
The one exception is the `www` subdomain. If configured correctly, the `www` subdomain is automatically redirected to the apex domain. For more information, see "[AUTOTITLE](/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site#configuring-an-apex-domain)."
|
||||
|
||||
|
|
|
|||
|
|
@ -80,9 +80,9 @@ For more information, see "[AUTOTITLE](/pages/getting-started-with-github-pages/
|
|||
|
||||
If you're a {% data variables.enterprise.prodname_managed_user %}, your use of {% data variables.product.prodname_pages %} is limited.
|
||||
|
||||
- {% data variables.product.prodname_pages %} sites can only be published from repositories owned by organizations.
|
||||
- {% data variables.product.prodname_pages %} sites are always privately published, and you cannot change this visibility. For more information, see "[AUTOTITLE](/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site)."
|
||||
- You cannot create an organization site (a site published from a repository named `<organization>.github.io`)
|
||||
* {% data variables.product.prodname_pages %} sites can only be published from repositories owned by organizations.
|
||||
* {% data variables.product.prodname_pages %} sites are always privately published, and you cannot change this visibility. For more information, see "[AUTOTITLE](/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site)."
|
||||
* You cannot create an organization site (a site published from a repository named `<organization>.github.io`)
|
||||
|
||||
For more information about {% data variables.product.prodname_emus %}, see "[AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users)."
|
||||
{% endif %}
|
||||
|
|
@ -117,13 +117,13 @@ Using {% data variables.product.prodname_pages %} to create a copy of an existin
|
|||
|
||||
{% data variables.product.prodname_pages %} sites are subject to the following usage limits:
|
||||
|
||||
- {% data variables.product.prodname_pages %} source repositories have a recommended limit of 1 GB.{% ifversion fpt or ghec %} For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-large-files/about-large-files-on-github#file-and-repository-size-limitations)"{% endif %}
|
||||
- Published {% data variables.product.prodname_pages %} sites may be no larger than 1 GB.
|
||||
- {% data variables.product.prodname_pages %} deployments will timeout if they take longer than 10 minutes.
|
||||
* {% data variables.product.prodname_pages %} source repositories have a recommended limit of 1 GB.{% ifversion fpt or ghec %} For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-large-files/about-large-files-on-github#file-and-repository-size-limitations)"{% endif %}
|
||||
* Published {% data variables.product.prodname_pages %} sites may be no larger than 1 GB.
|
||||
* {% data variables.product.prodname_pages %} deployments will timeout if they take longer than 10 minutes.
|
||||
{% ifversion fpt or ghec %}
|
||||
- {% data variables.product.prodname_pages %} sites have a _soft_ bandwidth limit of 100 GB per month.
|
||||
- {% data variables.product.prodname_pages %} sites have a _soft_ limit of 10 builds per hour. This limit does not apply if you build and publish your site with a custom {% data variables.product.prodname_actions %} workflow.
|
||||
- In order to provide consistent quality of service for all {% data variables.product.prodname_pages %} sites, rate limits may apply. These rate limits are not intended to interfere with legitimate uses of {% data variables.product.prodname_pages %}. If your request triggers rate limiting, you will receive an appropriate response with an HTTP status code of `429`, along with an informative HTML body.
|
||||
* {% data variables.product.prodname_pages %} sites have a _soft_ bandwidth limit of 100 GB per month.
|
||||
* {% data variables.product.prodname_pages %} sites have a _soft_ limit of 10 builds per hour. This limit does not apply if you build and publish your site with a custom {% data variables.product.prodname_actions %} workflow.
|
||||
* In order to provide consistent quality of service for all {% data variables.product.prodname_pages %} sites, rate limits may apply. These rate limits are not intended to interfere with legitimate uses of {% data variables.product.prodname_pages %}. If your request triggers rate limiting, you will receive an appropriate response with an HTTP status code of `429`, along with an informative HTML body.
|
||||
|
||||
If your site exceeds these usage quotas, we may not be able to serve your site, or you may receive a polite email from {% data variables.contact.github_support %} suggesting strategies for reducing your site's impact on our servers, including putting a third-party content distribution network (CDN) in front of your site, making use of other {% data variables.product.prodname_dotcom %} features such as releases, or moving to a different hosting service that might better fit your needs.
|
||||
|
||||
|
|
@ -144,5 +144,5 @@ When a {% data variables.product.prodname_pages %} site is visited, the visitor'
|
|||
|
||||
## Further reading
|
||||
|
||||
- [{% data variables.product.prodname_pages %}](https://github.com/skills/github-pages) on {% data variables.product.prodname_learning %}
|
||||
- "[AUTOTITLE](/rest/repos#pages)"
|
||||
* [{% data variables.product.prodname_pages %}](https://github.com/skills/github-pages) on {% data variables.product.prodname_learning %}
|
||||
* "[AUTOTITLE](/rest/repos#pages)"
|
||||
|
|
|
|||
|
|
@ -25,8 +25,8 @@ Access control is available for project sites that are published from a private
|
|||
|
||||
Privately published sites are available at a different subdomain than publicly published sites. This ensures that your {% data variables.product.prodname_pages %} site is secure from the moment it's published:
|
||||
|
||||
- We automatically secure every subdomain of `*.pages.github.io` with a TLS certificate, and enforce HSTS to ensure that browsers always serve the page over HTTPS.
|
||||
- We use a unique subdomain for the privately published site to ensure that other repositories in your organization cannot publish content on the same origin as the site. This protects your site from "[cookie tossing](https://github.blog/2013-04-09-yummy-cookies-across-domains/)". This is also why we don't host {% data variables.product.prodname_pages %} sites on the `github.com` domain.
|
||||
* We automatically secure every subdomain of `*.pages.github.io` with a TLS certificate, and enforce HSTS to ensure that browsers always serve the page over HTTPS.
|
||||
* We use a unique subdomain for the privately published site to ensure that other repositories in your organization cannot publish content on the same origin as the site. This protects your site from "[cookie tossing](https://github.blog/2013-04-09-yummy-cookies-across-domains/)". This is also why we don't host {% data variables.product.prodname_pages %} sites on the `github.com` domain.
|
||||
|
||||
You can see your site's unique subdomain in the "Pages" tab of your repository settings. If you're using a static site generator configured to build the site with the repository name as a path, you may need to update the settings for the static site generator when changing the site to private. For more information, see "[AUTOTITLE](/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site#configuring-a-subdomain)" or the documentation for your static site generator.
|
||||
|
||||
|
|
|
|||
|
|
@ -35,4 +35,4 @@ shortTitle: Create custom 404 page
|
|||
|
||||
## Further reading
|
||||
|
||||
- [Front matter](https://jekyllrb.com/docs/frontmatter) in the Jekyll documentation
|
||||
* [Front matter](https://jekyllrb.com/docs/frontmatter) in the Jekyll documentation
|
||||
|
|
|
|||
|
|
@ -64,7 +64,7 @@ To customize your site even more, you can use Jekyll, a static site generator wi
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites)"
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository)"
|
||||
- "[AUTOTITLE](/repositories/working-with-files/managing-files/creating-new-files)"
|
||||
- "[AUTOTITLE](/pages/getting-started-with-github-pages/troubleshooting-404-errors-for-github-pages-sites)"
|
||||
* "[AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository)"
|
||||
* "[AUTOTITLE](/repositories/working-with-files/managing-files/creating-new-files)"
|
||||
* "[AUTOTITLE](/pages/getting-started-with-github-pages/troubleshooting-404-errors-for-github-pages-sites)"
|
||||
|
|
|
|||
|
|
@ -15,8 +15,8 @@ shortTitle: Delete a GitHub Pages site
|
|||
## Deleting your site
|
||||
|
||||
You can delete your site in two ways:
|
||||
- Delete the repository. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/deleting-a-repository)."
|
||||
- Change the source to the `None` branch. For more information, see [Deleting your site by changing the source](#deleting-your-site-by-changing-the-source) below.
|
||||
* Delete the repository. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/deleting-a-repository)."
|
||||
* Change the source to the `None` branch. For more information, see [Deleting your site by changing the source](#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 site, you can unpublish your site. For more information, see "[AUTOTITLE](/pages/getting-started-with-github-pages/unpublishing-a-github-pages-site)."
|
||||
|
||||
|
|
|
|||
|
|
@ -51,10 +51,10 @@ If you enable HTTPS for your {% data variables.product.prodname_pages %} site bu
|
|||
To remove your site's mixed content, make sure all your assets are served over HTTPS by changing `http://` to `https://` in your site's HTML.
|
||||
|
||||
Assets are commonly found in the following locations:
|
||||
- If your site uses Jekyll, your HTML files will probably be found in the __layouts_ folder.
|
||||
- CSS is usually found in the `<head>` section of your HTML file.
|
||||
- JavaScript is usually found in the `<head>` section or just before the closing `</body>` tag.
|
||||
- Images are often found in the `<body>` section.
|
||||
* If your site uses Jekyll, your HTML files will probably be found in the __layouts_ folder.
|
||||
* CSS is usually found in the `<head>` section of your HTML file.
|
||||
* JavaScript is usually found in the `<head>` section or just before the closing `</body>` tag.
|
||||
* Images are often found in the `<body>` section.
|
||||
|
||||
{% tip %}
|
||||
|
||||
|
|
|
|||
|
|
@ -15,13 +15,13 @@ shortTitle: Troubleshoot 404 errors
|
|||
|
||||
In this guide you'll find common reasons you may be seeing a 404 error while building your {% data variables.product.prodname_pages %} site.
|
||||
|
||||
- [{% data variables.product.prodname_dotcom %}'s Status page](#githubs-status-page){% ifversion fpt or ghec %}
|
||||
- [DNS setup](#dns-setup){% endif %}
|
||||
- [Browser cache](#browser-cache)
|
||||
- [`index.html` file](#indexhtml-file)
|
||||
- [Directory contents](#directory-contents){% ifversion fpt or ghec %}
|
||||
- [Custom domain](#custom-domain){% endif %}
|
||||
- [Repository](#repository)
|
||||
* [{% data variables.product.prodname_dotcom %}'s Status page](#githubs-status-page){% ifversion fpt or ghec %}
|
||||
* [DNS setup](#dns-setup){% endif %}
|
||||
* [Browser cache](#browser-cache)
|
||||
* [`index.html` file](#indexhtml-file)
|
||||
* [Directory contents](#directory-contents){% ifversion fpt or ghec %}
|
||||
* [Custom domain](#custom-domain){% endif %}
|
||||
* [Repository](#repository)
|
||||
|
||||
### {% data variables.product.prodname_dotcom %}'s Status page
|
||||
|
||||
|
|
@ -39,15 +39,15 @@ If your {% data variables.product.prodname_pages %} site is private and you see
|
|||
|
||||
{% data variables.product.prodname_pages %} will look for an `index.html` file as the entry file for your site.
|
||||
|
||||
- Make sure you have an `index.html` file in the repository for your site on {% data variables.product.product_name %}. For more information, see "[AUTOTITLE](/pages/getting-started-with-github-pages/creating-a-github-pages-site#creating-your-site)."
|
||||
- The entry file must be at the top level of your chosen publishing source. For example, if your publishing source is the `/docs` directory on the `main` branch, your entry file must be located in the `/docs` directory on a branch called `main`.
|
||||
* Make sure you have an `index.html` file in the repository for your site on {% data variables.product.product_name %}. For more information, see "[AUTOTITLE](/pages/getting-started-with-github-pages/creating-a-github-pages-site#creating-your-site)."
|
||||
* The entry file must be at the top level of your chosen publishing source. For example, if your publishing source is the `/docs` directory on the `main` branch, your entry file must be located in the `/docs` directory on a branch called `main`.
|
||||
|
||||
If your publishing source is a branch and directory, the entry file must be at the top level of the source directory on the source branch. For example, if your publishing source is the `/docs` directory on the `main` branch, your entry file must be located in the `/docs` directory on a branch called `main`.
|
||||
|
||||
If your publishing source is a {% data variables.product.prodname_actions %} workflow, the artifact that you deploy must include the entry file at the top level of the artifact. Instead of adding the entry file to your repository, you may choose to have your {% data variables.product.prodname_actions %} workflow generate your entry file when the workflow runs.
|
||||
|
||||
- The name of the `index.html` file is case sensitive. For example, `Index.html` will not work.
|
||||
- The name of the file should be `index.html`, not `index.HTML` or any other variation.
|
||||
* The name of the `index.html` file is case sensitive. For example, `Index.html` will not work.
|
||||
* The name of the file should be `index.html`, not `index.HTML` or any other variation.
|
||||
|
||||
### Directory contents
|
||||
|
||||
|
|
@ -59,15 +59,15 @@ Check that your directory contents are in the root directory.
|
|||
|
||||
If you're using a custom domain, make sure it's set up correctly. For more information, see "[AUTOTITLE](/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages)."
|
||||
|
||||
- The `CNAME` record should always point to `<USER>.github.io` or `<ORGANIZATION>.github.io`, excluding the repository name. {% data reusables.pages.contact-dns-provider %}
|
||||
- If you are able to access your landing page, but encounter broken links throughout, it is likely because you either didn't have a custom domain name before or are reverting back from having a custom domain name. In such cases, changing the routing path does not initiate a rebuild of the page. The recommended solution is to ensure that your site rebuilds automatically when adding or removing a custom domain name. This may involve configuring a commit author and modifying the custom domain name settings.{% endif %}
|
||||
* The `CNAME` record should always point to `<USER>.github.io` or `<ORGANIZATION>.github.io`, excluding the repository name. {% data reusables.pages.contact-dns-provider %}
|
||||
* If you are able to access your landing page, but encounter broken links throughout, it is likely because you either didn't have a custom domain name before or are reverting back from having a custom domain name. In such cases, changing the routing path does not initiate a rebuild of the page. The recommended solution is to ensure that your site rebuilds automatically when adding or removing a custom domain name. This may involve configuring a commit author and modifying the custom domain name settings.{% endif %}
|
||||
|
||||
### Repository
|
||||
|
||||
Check whether your repository meets the following requirements.
|
||||
|
||||
- The branch you are using to publish your site must be the `main` or default branch.
|
||||
- The repository must have a commit pushed to it by someone with admin permissions for the repository, such as the repository owner.
|
||||
- Switching the repository's visibility from public to private or vice versa will change the URL of your {% data variables.product.prodname_pages %} site, which will result in broken links until the site is rebuilt.
|
||||
* The branch you are using to publish your site must be the `main` or default branch.
|
||||
* The repository must have a commit pushed to it by someone with admin permissions for the repository, such as the repository owner.
|
||||
* Switching the repository's visibility from public to private or vice versa will change the URL of your {% data variables.product.prodname_pages %} site, which will result in broken links until the site is rebuilt.
|
||||
|
||||
If you are still receiving a 404 error, start a [{% data variables.product.prodname_github_community %} discussion](https://github.com/orgs/community/discussions/categories/pages) in the Pages category.
|
||||
|
|
|
|||
|
|
@ -43,10 +43,10 @@ To use the action in your current workflow place this snippet under `jobs`.
|
|||
|
||||
The `deploy-pages` action handles the necessary setup for deploying artifacts. To ensure proper functionality, the following requirements should be met:
|
||||
|
||||
- The job must have a minimum of `pages: write` and `id-token: write` permissions.
|
||||
- The `needs` parameter must be set to the `id` of the build step. Not setting this parameter may result in an independent deployment that continuously searches for an artifact that hasn't been created.
|
||||
- An `environment` must be established to enforce branch/deployment protection rules. The default environment is `github-pages`.
|
||||
- To specify the URL of the page as an output, utilize the `url:` field.
|
||||
* The job must have a minimum of `pages: write` and `id-token: write` permissions.
|
||||
* The `needs` parameter must be set to the `id` of the build step. Not setting this parameter may result in an independent deployment that continuously searches for an artifact that hasn't been created.
|
||||
* An `environment` must be established to enforce branch/deployment protection rules. The default environment is `github-pages`.
|
||||
* To specify the URL of the page as an output, utilize the `url:` field.
|
||||
|
||||
For more information, see the [`deploy-pages`](https://github.com/marketplace/actions/deploy-github-pages-site) action.
|
||||
|
||||
|
|
|
|||
|
|
@ -22,5 +22,5 @@ Use the `https://` read-only URL for your submodules, including nested submodule
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[Git Tools - Submodules](https://git-scm.com/book/en/Git-Tools-Submodules)" from the _Pro Git_ book
|
||||
- "[AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites)"
|
||||
* "[Git Tools - Submodules](https://git-scm.com/book/en/Git-Tools-Submodules)" from the _Pro Git_ book
|
||||
* "[AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites)"
|
||||
|
|
|
|||
|
|
@ -56,10 +56,10 @@ kramdown:
|
|||
```
|
||||
|
||||
By default, Jekyll doesn't build files or folders that:
|
||||
- Are located in a folder called `/node_modules` or `/vendor`
|
||||
- Start with `_`, `.`, or `#`
|
||||
- End with `~`
|
||||
- Are excluded by the `exclude` setting in your configuration file
|
||||
* Are located in a folder called `/node_modules` or `/vendor`
|
||||
* Start with `_`, `.`, or `#`
|
||||
* End with `~`
|
||||
* Are excluded by the `exclude` setting in your configuration file
|
||||
|
||||
If you want Jekyll to process any of these files, you can use the `include` setting in your configuration file.
|
||||
|
||||
|
|
@ -85,15 +85,15 @@ You can override any of your theme's defaults by editing the theme's files. For
|
|||
You can download or create Jekyll plugins to extend the functionality of Jekyll for your site. For example, the [jemoji](https://github.com/jekyll/jemoji) plugin lets you use {% data variables.product.prodname_dotcom %}-flavored emoji in any page on your site the same way you would on {% data variables.product.prodname_dotcom %}. For more information, see "[Plugins](https://jekyllrb.com/docs/plugins/)" in the Jekyll documentation.
|
||||
|
||||
{% data variables.product.prodname_pages %} uses plugins that are enabled by default and cannot be disabled:
|
||||
- [`jekyll-coffeescript`](https://github.com/jekyll/jekyll-coffeescript)
|
||||
- [`jekyll-default-layout`](https://github.com/benbalter/jekyll-default-layout)
|
||||
- [`jekyll-gist`](https://github.com/jekyll/jekyll-gist)
|
||||
- [`jekyll-github-metadata`](https://github.com/jekyll/github-metadata)
|
||||
- [`jekyll-optional-front-matter`](https://github.com/benbalter/jekyll-optional-front-matter)
|
||||
- [`jekyll-paginate`](https://github.com/jekyll/jekyll-paginate)
|
||||
- [`jekyll-readme-index`](https://github.com/benbalter/jekyll-readme-index)
|
||||
- [`jekyll-titles-from-headings`](https://github.com/benbalter/jekyll-titles-from-headings)
|
||||
- [`jekyll-relative-links`](https://github.com/benbalter/jekyll-relative-links)
|
||||
* [`jekyll-coffeescript`](https://github.com/jekyll/jekyll-coffeescript)
|
||||
* [`jekyll-default-layout`](https://github.com/benbalter/jekyll-default-layout)
|
||||
* [`jekyll-gist`](https://github.com/jekyll/jekyll-gist)
|
||||
* [`jekyll-github-metadata`](https://github.com/jekyll/github-metadata)
|
||||
* [`jekyll-optional-front-matter`](https://github.com/benbalter/jekyll-optional-front-matter)
|
||||
* [`jekyll-paginate`](https://github.com/jekyll/jekyll-paginate)
|
||||
* [`jekyll-readme-index`](https://github.com/benbalter/jekyll-readme-index)
|
||||
* [`jekyll-titles-from-headings`](https://github.com/benbalter/jekyll-titles-from-headings)
|
||||
* [`jekyll-relative-links`](https://github.com/benbalter/jekyll-relative-links)
|
||||
|
||||
You can enable additional plugins by adding the plugin's gem to the `plugins` setting in your `_config.yml` file. For more information, see "[Configuration](https://jekyllrb.com/docs/configuration/)" in the Jekyll documentation.
|
||||
|
||||
|
|
|
|||
|
|
@ -19,9 +19,9 @@ shortTitle: Jekyll build errors for Pages
|
|||
## About Jekyll build errors
|
||||
|
||||
If you are publishing from a branch, sometimes {% data variables.product.prodname_pages %} will not attempt to build your site after you push changes to your site's publishing source.{% ifversion fpt or ghec %}
|
||||
- The person who pushed the changes hasn't verified their email address. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/verifying-your-email-address)."{% endif %}
|
||||
- You're pushing with a deploy key. If you want to automate pushes to your site's repository, you can set up a machine user instead. For more information, see "[AUTOTITLE](/authentication/connecting-to-github-with-ssh/managing-deploy-keys#machine-users)."
|
||||
- You're using a CI service that isn't configured to build your publishing source. For example, Travis CI won't build the `gh-pages` branch unless you add the branch to a safe list. For more information, see "[Customizing the build](https://docs.travis-ci.com/user/customizing-the-build/#safelisting-or-blocklisting-branches)" on Travis CI, or your CI service's documentation.
|
||||
* The person who pushed the changes hasn't verified their email address. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/verifying-your-email-address)."{% endif %}
|
||||
* You're pushing with a deploy key. If you want to automate pushes to your site's repository, you can set up a machine user instead. For more information, see "[AUTOTITLE](/authentication/connecting-to-github-with-ssh/managing-deploy-keys#machine-users)."
|
||||
* You're using a CI service that isn't configured to build your publishing source. For example, Travis CI won't build the `gh-pages` branch unless you add the branch to a safe list. For more information, see "[Customizing the build](https://docs.travis-ci.com/user/customizing-the-build/#safelisting-or-blocklisting-branches)" on Travis CI, or your CI service's documentation.
|
||||
|
||||
{% note %}
|
||||
|
||||
|
|
@ -33,8 +33,8 @@ If you are publishing from a branch, sometimes {% data variables.product.prodnam
|
|||
If Jekyll does attempt to build your site and encounters an error, you will receive a build error message.
|
||||
{% else %}
|
||||
If Jekyll does attempt to build your site and encounters an error, you will receive a build error message. There are two main types of Jekyll build error messages.
|
||||
- A "Page build warning" message means your build completed successfully, but you may need to make changes to prevent future problems.
|
||||
- A "Page build failed" message means your build failed to complete. If Jekyll is able to detect a reason for the failure, you'll see a descriptive error message.
|
||||
* A "Page build warning" message means your build completed successfully, but you may need to make changes to prevent future problems.
|
||||
* A "Page build failed" message means your build failed to complete. If Jekyll is able to detect a reason for the failure, you'll see a descriptive error message.
|
||||
{% endif %}
|
||||
|
||||
For more information about troubleshooting build errors, see "[AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites)."
|
||||
|
|
|
|||
|
|
@ -28,8 +28,8 @@ People with write permissions for a repository can add a theme to a {% data vari
|
|||
1. Navigate to __config.yml_.
|
||||
{% data reusables.repositories.edit-file %}
|
||||
1. Add a new line to the file for the theme name.
|
||||
- To use a supported theme, type `theme: THEME-NAME`, replacing _THEME-NAME_ with the name of the theme as shown in the `_config.yml` of the theme's repository (most themes follow a `jekyll-theme-NAME` naming convention). For a list of supported themes, see "[Supported themes](https://pages.github.com/themes/)" on the {% data variables.product.prodname_pages %} site. For example, to select the Minimal theme, type `theme: jekyll-theme-minimal`.
|
||||
- To use any other Jekyll theme hosted on {% data variables.product.prodname_dotcom %}, type `remote_theme: THEME-NAME`, replacing THEME-NAME with the name of the theme as shown in the README of the theme's repository.
|
||||
* To use a supported theme, type `theme: THEME-NAME`, replacing _THEME-NAME_ with the name of the theme as shown in the `_config.yml` of the theme's repository (most themes follow a `jekyll-theme-NAME` naming convention). For a list of supported themes, see "[Supported themes](https://pages.github.com/themes/)" on the {% data variables.product.prodname_pages %} site. For example, to select the Minimal theme, type `theme: jekyll-theme-minimal`.
|
||||
* To use any other Jekyll theme hosted on {% data variables.product.prodname_dotcom %}, type `remote_theme: THEME-NAME`, replacing THEME-NAME with the name of the theme as shown in the README of the theme's repository.
|
||||
{% data reusables.files.write_commit_message %}
|
||||
{% data reusables.files.choose-commit-email %}
|
||||
{% data reusables.files.choose_commit_branch %}
|
||||
|
|
@ -72,4 +72,4 @@ People with write permissions for a repository can add a theme to a {% data vari
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/repositories/working-with-files/managing-files/creating-new-files)"
|
||||
* "[AUTOTITLE](/repositories/working-with-files/managing-files/creating-new-files)"
|
||||
|
|
|
|||
|
|
@ -33,5 +33,5 @@ You can use {% data variables.product.prodname_dotcom %} Flavored Markdown with
|
|||
|
||||
## Further reading
|
||||
|
||||
- [kramdown Documentation](https://kramdown.gettalong.org/documentation.html)
|
||||
- [{% data variables.product.prodname_dotcom %} Flavored Markdown Spec](https://github.github.com/gfm/)
|
||||
* [kramdown Documentation](https://kramdown.gettalong.org/documentation.html)
|
||||
* [{% data variables.product.prodname_dotcom %} Flavored Markdown Spec](https://github.github.com/gfm/)
|
||||
|
|
|
|||
|
|
@ -21,8 +21,8 @@ Anyone with read permissions for a repository can test a {% data variables.produ
|
|||
## Prerequisites
|
||||
|
||||
Before you can use Jekyll to test a site, you must:
|
||||
- Install [Jekyll](https://jekyllrb.com/docs/installation/).
|
||||
- Create a Jekyll site. For more information, see "[AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll)."
|
||||
* Install [Jekyll](https://jekyllrb.com/docs/installation/).
|
||||
* Create a Jekyll site. For more information, see "[AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll)."
|
||||
|
||||
{% data reusables.pages.recommend-bundler %}
|
||||
|
||||
|
|
@ -64,9 +64,9 @@ Jekyll is an active open source project that is updated frequently. If the `gith
|
|||
|
||||
{% data reusables.command_line.open_the_multi_os_terminal %}
|
||||
1. Update the `github-pages` gem.
|
||||
- If you installed Bundler, run `bundle update github-pages`.
|
||||
- If you don't have Bundler installed, run `gem update github-pages`.
|
||||
* If you installed Bundler, run `bundle update github-pages`.
|
||||
* If you don't have Bundler installed, run `gem update github-pages`.
|
||||
|
||||
## Further reading
|
||||
|
||||
- [{% data variables.product.prodname_pages %}](https://jekyllrb.com/docs/github-pages/) in the Jekyll documentation
|
||||
* [{% data variables.product.prodname_pages %}](https://jekyllrb.com/docs/github-pages/) in the Jekyll documentation
|
||||
|
|
|
|||
|
|
@ -40,10 +40,10 @@ shortTitle: Troubleshoot Jekyll errors
|
|||
If Jekyll encounters an error building your {% data variables.product.prodname_pages %} site locally or on {% data variables.product.product_name %}, you can use error messages to troubleshoot. For more information about error messages and how to view them, see "[AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites)."
|
||||
|
||||
If you received a generic error message, check for common issues.
|
||||
- You're using unsupported plugins. For more information, see "[AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll#plugins)."{% ifversion fpt or ghec %}
|
||||
- Your repository has exceeded our repository size limits. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-large-files/about-large-files-on-github)"{% endif %}
|
||||
- You changed the `source` setting in your `_config.yml` file. If you publish your site from a branch, {% data variables.product.prodname_pages %} overrides this setting during the build process.
|
||||
- A filename in your published files contains a colon (`:`) which is not supported.
|
||||
* You're using unsupported plugins. For more information, see "[AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll#plugins)."{% ifversion fpt or ghec %}
|
||||
* Your repository has exceeded our repository size limits. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-large-files/about-large-files-on-github)"{% endif %}
|
||||
* You changed the `source` setting in your `_config.yml` file. If you publish your site from a branch, {% data variables.product.prodname_pages %} overrides this setting during the build process.
|
||||
* A filename in your published files contains a colon (`:`) which is not supported.
|
||||
|
||||
If you received a specific error message, review the troubleshooting information for the error message below.
|
||||
|
||||
|
|
@ -136,9 +136,9 @@ Then, make sure the file in the error message uses valid Markdown syntax. For mo
|
|||
This error means that you have chosen the `docs` folder on a branch as your publishing source, but there is no `docs` folder in the root of your repository on that branch.
|
||||
|
||||
To troubleshoot, if your `docs` folder was accidentally moved, try moving the `docs` folder back to the root of your repository on the branch you chose for your publishing source. If the `docs` folder was accidentally deleted, you can either:
|
||||
- Use Git to revert or undo the deletion. For more information, see "[git-revert](https://git-scm.com/docs/git-revert.html)" in the Git documentation.
|
||||
- Create a new `docs` folder in the root of your repository on the branch you chose for your publishing source and add your site's source files to the folder. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-files/creating-new-files)."
|
||||
- Change your publishing source. For more information, see "[AUTOTITLE](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)."
|
||||
* Use Git to revert or undo the deletion. For more information, see "[git-revert](https://git-scm.com/docs/git-revert.html)" in the Git documentation.
|
||||
* Create a new `docs` folder in the root of your repository on the branch you chose for your publishing source and add your site's source files to the folder. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-files/creating-new-files)."
|
||||
* Change your publishing source. For more information, see "[AUTOTITLE](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)."
|
||||
|
||||
## Missing submodule
|
||||
|
||||
|
|
|
|||
|
|
@ -22,8 +22,8 @@ You must resolve all merge conflicts before you can merge a pull request on {% d
|
|||
|
||||
To resolve a merge conflict, you must manually edit the conflicted file to select the changes that you want to keep in the final merge. There are a couple of different ways to resolve a merge conflict:
|
||||
|
||||
- If your merge conflict is caused by competing line changes, such as when people make different changes to the same line of the same file on different branches in your Git repository, you can resolve it on {% data variables.product.product_name %} using the conflict editor. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github)."
|
||||
- For all other types of merge conflicts, you must resolve the merge conflict in a local clone of the repository and push the change to your branch on {% data variables.product.product_name %}. You can use the command line or a tool like [{% data variables.product.prodname_desktop %}](https://desktop.github.com/) to push the change. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line)."
|
||||
* If your merge conflict is caused by competing line changes, such as when people make different changes to the same line of the same file on different branches in your Git repository, you can resolve it on {% data variables.product.product_name %} using the conflict editor. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github)."
|
||||
* For all other types of merge conflicts, you must resolve the merge conflict in a local clone of the repository and push the change to your branch on {% data variables.product.product_name %}. You can use the command line or a tool like [{% data variables.product.prodname_desktop %}](https://desktop.github.com/) to push the change. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line)."
|
||||
|
||||
If you have a merge conflict on the command line, you cannot push your local changes to {% data variables.product.product_name %} until you resolve the merge conflict locally on your computer. If you try merging branches on the command line that have a merge conflict, you'll get an error message. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line)."
|
||||
|
||||
|
|
@ -36,7 +36,7 @@ $ git merge BRANCH-NAME
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)"
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)"
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line)"
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github)"
|
||||
|
|
|
|||
|
|
@ -63,4 +63,4 @@ If a site administrator disables the merge conflict editor for pull requests bet
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)"
|
||||
|
|
|
|||
|
|
@ -144,5 +144,5 @@ You can now merge the branches on the command line or [push your changes to your
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/about-merge-conflicts)"
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/about-merge-conflicts)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally)"
|
||||
|
|
|
|||
|
|
@ -30,8 +30,8 @@ You can see the overall state of the last commit to a branch on your repository'
|
|||
|
||||
There are two types of status checks on {% data variables.product.product_name %}:
|
||||
|
||||
- Checks
|
||||
- Commit statuses
|
||||
* Checks
|
||||
* Commit statuses
|
||||
|
||||
_Checks_ are different from _commit statuses_ in that they provide line annotations, more detailed messaging, and are only available for use with {% data variables.product.prodname_github_apps %}.
|
||||
|
||||
|
|
@ -67,7 +67,7 @@ You can also skip workflow runs triggered by the `push` and `pull_request` event
|
|||
|
||||
Alternatively, to skip or request _all_ checks for your commit, add one of the following trailer lines to the end of your commit message:
|
||||
|
||||
- To _skip checks_ for a commit, type your commit message and a short, meaningful description of your changes. After your commit description, before the closing quotation, add two empty lines followed by `skip-checks: true`:
|
||||
* To _skip checks_ for a commit, type your commit message and a short, meaningful description of your changes. After your commit description, before the closing quotation, add two empty lines followed by `skip-checks: true`:
|
||||
|
||||
```shell
|
||||
$ git commit -m "Update README
|
||||
|
|
@ -76,7 +76,7 @@ Alternatively, to skip or request _all_ checks for your commit, add one of the f
|
|||
skip-checks: true"
|
||||
```
|
||||
|
||||
- To _request_ checks for a commit, type your commit message and a short, meaningful description of your changes. After your commit description, before the closing quotation, add two empty lines followed by `request-checks: true`:
|
||||
* To _request_ checks for a commit, type your commit message and a short, meaningful description of your changes. After your commit description, before the closing quotation, add two empty lines followed by `request-checks: true`:
|
||||
|
||||
```shell
|
||||
$ git commit -m "Refactor usability tests
|
||||
|
|
|
|||
|
|
@ -31,6 +31,6 @@ In the shared repository model, collaborators are granted push access to a singl
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)"
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)"
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork)"
|
||||
|
|
|
|||
|
|
@ -26,9 +26,9 @@ Review, build, and test your own pull request before submitting it. This will al
|
|||
|
||||
Write clear titles and descriptions for your pull requests so that reviewers can quickly understand what the pull request does. In the pull request body, include:
|
||||
|
||||
- the purpose of the pull request
|
||||
- an overview of what changed
|
||||
- links to any additional context such as tracking issues or previous conversations
|
||||
* the purpose of the pull request
|
||||
* an overview of what changed
|
||||
* links to any additional context such as tracking issues or previous conversations
|
||||
|
||||
To help reviewers, share the type of feedback you need. For example, do you need a quick look or a deeper critique?
|
||||
|
||||
|
|
|
|||
|
|
@ -56,14 +56,14 @@ Because this commit is only on the base branch and not the head branch, the comm
|
|||
{% data reusables.pull_requests.rebase_and_merge_summary %}
|
||||
|
||||
You aren't able to automatically rebase and merge on {% data variables.location.product_location %} when:
|
||||
- The pull request has merge conflicts.
|
||||
- Rebasing the commits from the base branch into the head branch runs into conflicts.
|
||||
- Rebasing the commits is considered "unsafe," such as when a rebase is possible without merge conflicts but would produce a different result than a merge would.
|
||||
* The pull request has merge conflicts.
|
||||
* Rebasing the commits from the base branch into the head branch runs into conflicts.
|
||||
* Rebasing the commits is considered "unsafe," such as when a rebase is possible without merge conflicts but would produce a different result than a merge would.
|
||||
|
||||
If you still want to rebase the commits but can't rebase and merge automatically on {% data variables.location.product_location %} you must:
|
||||
- Rebase the topic branch (or head branch) onto the base branch locally on the command line
|
||||
- [Resolve any merge conflicts on the command line](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line).
|
||||
- Force-push the rebased commits to the pull request's topic branch (or remote head branch).
|
||||
* Rebase the topic branch (or head branch) onto the base branch locally on the command line
|
||||
* [Resolve any merge conflicts on the command line](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line).
|
||||
* Force-push the rebased commits to the pull request's topic branch (or remote head branch).
|
||||
|
||||
Anyone with write permissions in the repository, can then [merge the changes](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request) using the rebase and merge button on {% data variables.location.product_location %}.
|
||||
|
||||
|
|
@ -71,9 +71,9 @@ Anyone with write permissions in the repository, can then [merge the changes](/p
|
|||
|
||||
A pull request can be merged automatically if its head branch is directly or indirectly merged into the base branch externally. In other words, if the head branch's tip commit becomes reachable from the tip of the target branch. For example:
|
||||
|
||||
- Branch `main` is at commit **C**.
|
||||
- Branch `feature` has been branched off of `main` and is currently at commit **D**. This branch has a pull request targeting `main`.
|
||||
- Branch `feature_2` is branched off of `feature` and is now at commit **E**. This branch also has a pull request targeting `main`.
|
||||
* Branch `main` is at commit **C**.
|
||||
* Branch `feature` has been branched off of `main` and is currently at commit **D**. This branch has a pull request targeting `main`.
|
||||
* Branch `feature_2` is branched off of `feature` and is now at commit **E**. This branch also has a pull request targeting `main`.
|
||||
|
||||
If pull request **E** --> `main` is merged first, pull request **D** --> `main` will be marked as merged _automatically_ because all of the commits from `feature` are now reachable from `main`. Merging `feature_2` into `main` and pushing `main` to the server from the command line will mark _both_ pull requests as merged.
|
||||
|
||||
|
|
@ -85,5 +85,5 @@ Pull requests that are merged indirectly are marked as `merged` even if [branch
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)"
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts)"
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ product: '{% data reusables.gated-features.merge-queue %}'
|
|||
|
||||
1. Click **Merge when ready** to add the pull request to the merge queue. Alternatively, if you are an administrator, you can:
|
||||
|
||||
- Directly merge the pull request by checking **Merge without waiting for requirements to be met ({% ifversion bypass-branch-protections %}bypass branch protections{% else %}administrators only{% endif %})**, if allowed by branch protection settings, and follow the standard flow.
|
||||
* Directly merge the pull request by checking **Merge without waiting for requirements to be met ({% ifversion bypass-branch-protections %}bypass branch protections{% else %}administrators only{% endif %})**, if allowed by branch protection settings, and follow the standard flow.
|
||||
|
||||
|
||||
|
||||
|
|
@ -88,15 +88,15 @@ You can view the merge queue for a base branch in various places on {% data vari
|
|||
|
||||
{% endwebui %}
|
||||
|
||||
- On the **Branches** page for the repository. We recommend you use this route if you don't have or don't know about a pull request already in a queue, and if you want to see what's in that queue. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/viewing-branches-in-your-repository)."
|
||||
* On the **Branches** page for the repository. We recommend you use this route if you don't have or don't know about a pull request already in a queue, and if you want to see what's in that queue. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/viewing-branches-in-your-repository)."
|
||||
|
||||
|
||||
|
||||
- On the pull request page when merge queue is required for merging, scroll to the bottom of the timeline and click the **merge queue** link.
|
||||
* On the pull request page when merge queue is required for merging, scroll to the bottom of the timeline and click the **merge queue** link.
|
||||
|
||||
|
||||
|
||||
- The merge queue view shows the pull requests that are currently in the queue, with your pull requests clearly marked.
|
||||
* The merge queue view shows the pull requests that are currently in the queue, with your pull requests clearly marked.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -52,13 +52,13 @@ If you decide you don't want the changes in a topic branch to be merged to the u
|
|||
1. In the "Pull Requests" list, click the pull request you'd like to merge.
|
||||
1. Scroll down to the bottom of the pull request. Depending on the merge options enabled for your repository, you can:
|
||||
|
||||
- [Merge all of the commits into the base branch](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges) by clicking **Merge pull request**. If the **Merge pull request** option is not shown, click the merge dropdown menu and select **Create a merge commit**.
|
||||
* [Merge all of the commits into the base branch](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges) by clicking **Merge pull request**. If the **Merge pull request** option is not shown, click the merge dropdown menu and select **Create a merge commit**.
|
||||
|
||||
|
||||
|
||||
- [Squash the commits into one commit](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#squash-and-merge-your-pull-request-commits) by clicking the merge dropdown menu, selecting **Squash and merge** and then clicking **Squash and merge**.
|
||||
* [Squash the commits into one commit](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#squash-and-merge-your-pull-request-commits) by clicking the merge dropdown menu, selecting **Squash and merge** and then clicking **Squash and merge**.
|
||||
|
||||
- [Rebase the commits individually onto the base branch](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#rebase-and-merge-your-pull-request-commits) by clicking the merge dropdown menu, selecting **Rebase and merge** and then clicking **Rebase and merge**.
|
||||
* [Rebase the commits individually onto the base branch](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#rebase-and-merge-your-pull-request-commits) by clicking the merge dropdown menu, selecting **Rebase and merge** and then clicking **Rebase and merge**.
|
||||
|
||||
{% note %}
|
||||
|
||||
|
|
@ -102,7 +102,7 @@ gh pr merge 523 --squash --body "my squash commit" --delete-branch
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/reverting-a-pull-request)"
|
||||
- "[AUTOTITLE](/desktop/keeping-your-local-repository-in-sync-with-github/syncing-your-branch)" using {% data variables.product.prodname_desktop %}
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)"
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/reverting-a-pull-request)"
|
||||
* "[AUTOTITLE](/desktop/keeping-your-local-repository-in-sync-with-github/syncing-your-branch)" using {% data variables.product.prodname_desktop %}
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts)"
|
||||
|
|
|
|||
|
|
@ -23,8 +23,8 @@ Reverting a pull request on {% data variables.product.product_name %} creates a
|
|||
|
||||
**Note:** You may need to revert the individual commits in your pull request if either of the following is true.
|
||||
|
||||
- Reverting the pull request causes merge conflicts
|
||||
- The original pull request was not originally merged on {% data variables.product.product_name %}. For example, someone could have merged the pull request using a fast-forward merge on the command line.
|
||||
* Reverting the pull request causes merge conflicts
|
||||
* The original pull request was not originally merged on {% data variables.product.product_name %}. For example, someone could have merged the pull request using a fast-forward merge on the command line.
|
||||
|
||||
For more information about using Git to manually revert individual commits, see [Git revert](https://git-scm.com/docs/git-revert.html) in the Git documentation.
|
||||
|
||||
|
|
|
|||
|
|
@ -67,15 +67,15 @@ To see if your pull request can be merged, look in the merge box at the bottom o
|
|||
|
||||
When a branch is protected:
|
||||
|
||||
- You won't be able to delete or force push to the branch.
|
||||
- If required status checks are enabled on the branch, you won't be able to merge changes into the branch until all of the required CI tests pass. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)."
|
||||
- If required pull request reviews are enabled on the branch, you won't be able to merge changes into the branch until all requirements in the pull request review policy have been met. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)."
|
||||
- If required review from a code owner is enabled on a branch, and a pull request modifies code that has an owner, a code owner must approve the pull request before it can be merged. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)."
|
||||
- If required commit signing is enabled on a branch, you won't be able to push any commits to the branch that are not signed and verified. For more information, see "[AUTOTITLE](/authentication/managing-commit-signature-verification/about-commit-signature-verification)" and "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-signed-commits)."
|
||||
- If you use {% data variables.product.prodname_dotcom %}'s conflict editor to fix conflicts for a pull request that you created from a protected branch, {% data variables.product.prodname_dotcom %} helps you to create an alternative branch for the pull request, so that your resolution of the conflicts can be merged. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github)."
|
||||
* You won't be able to delete or force push to the branch.
|
||||
* If required status checks are enabled on the branch, you won't be able to merge changes into the branch until all of the required CI tests pass. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)."
|
||||
* If required pull request reviews are enabled on the branch, you won't be able to merge changes into the branch until all requirements in the pull request review policy have been met. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)."
|
||||
* If required review from a code owner is enabled on a branch, and a pull request modifies code that has an owner, a code owner must approve the pull request before it can be merged. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)."
|
||||
* If required commit signing is enabled on a branch, you won't be able to push any commits to the branch that are not signed and verified. For more information, see "[AUTOTITLE](/authentication/managing-commit-signature-verification/about-commit-signature-verification)" and "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-signed-commits)."
|
||||
* If you use {% data variables.product.prodname_dotcom %}'s conflict editor to fix conflicts for a pull request that you created from a protected branch, {% data variables.product.prodname_dotcom %} helps you to create an alternative branch for the pull request, so that your resolution of the conflicts can be merged. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github)."
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)"
|
||||
- "[AUTOTITLE](/get-started/learning-about-github/github-glossary#branch)" in the {% data variables.product.prodname_dotcom %} glossary
|
||||
- "[Branches in a Nutshell](https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell)" in the Git documentation
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)"
|
||||
* "[AUTOTITLE](/get-started/learning-about-github/github-glossary#branch)" in the {% data variables.product.prodname_dotcom %} glossary
|
||||
* "[Branches in a Nutshell](https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell)" in the Git documentation
|
||||
|
|
|
|||
|
|
@ -34,10 +34,10 @@ Rather than viewing the commits themselves, you can view the proposed changes as
|
|||
{% endtip %}
|
||||
|
||||
You have several options for viewing a diff:
|
||||
- The unified view shows updated and existing content together in a linear view.
|
||||
- The split view shows old content on one side and new content on the other side.
|
||||
- The rich diff view shows a preview of how the changes will look once the pull request is merged.
|
||||
- The source view shows the changes in source without the formatting of the rich diff view.
|
||||
* The unified view shows updated and existing content together in a linear view.
|
||||
* The split view shows old content on one side and new content on the other side.
|
||||
* The rich diff view shows a preview of how the changes will look once the pull request is merged.
|
||||
* The source view shows the changes in source without the formatting of the rich diff view.
|
||||
|
||||
You can also choose to ignore whitespace changes to get a more accurate view of the substantial changes in a pull request.
|
||||
|
||||
|
|
@ -49,8 +49,8 @@ To simplify reviewing changes in a large pull request, you can filter the diff t
|
|||
|
||||
## Reasons diffs will not display
|
||||
|
||||
- You've exceeded the total limit of files or certain file types. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/repository-limits#diff-limits)."
|
||||
- Your file matches a rule in the repository's _.gitattributes_ file to block that file from displaying by default. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-files/customizing-how-changed-files-appear-on-github)."
|
||||
* You've exceeded the total limit of files or certain file types. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/repository-limits#diff-limits)."
|
||||
* Your file matches a rule in the repository's _.gitattributes_ file to block that file from displaying by default. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-files/customizing-how-changed-files-appear-on-github)."
|
||||
|
||||
## Three-dot and two-dot Git diff comparisons
|
||||
|
||||
|
|
@ -88,5 +88,5 @@ To avoid getting confused, merge the base branch (for example, `main`) into your
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)"
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)"
|
||||
|
|
|
|||
|
|
@ -22,8 +22,8 @@ A pull request is a proposal to merge a set of changes from one branch into anot
|
|||
{% note %}
|
||||
|
||||
**Note:** When working with pull requests, keep the following in mind:
|
||||
- If you're working in the [shared repository model](/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models), we recommend that you use a topic branch for your pull request. While you can send pull requests from any branch or commit, with a topic branch you can push follow-up commits if you need to update your proposed changes.
|
||||
- Be very careful when force pushing commits to a pull request. Force pushing changes the repository history and can corrupt your pull request. If other collaborators branch the project before a force push, the force push may overwrite commits that collaborators based their work on.
|
||||
* If you're working in the [shared repository model](/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models), we recommend that you use a topic branch for your pull request. While you can send pull requests from any branch or commit, with a topic branch you can push follow-up commits if you need to update your proposed changes.
|
||||
* Be very careful when force pushing commits to a pull request. Force pushing changes the repository history and can corrupt your pull request. If other collaborators branch the project before a force push, the force push may overwrite commits that collaborators based their work on.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
|
|
@ -48,8 +48,8 @@ After you're happy with the proposed changes, you can merge the pull request. If
|
|||
{% tip %}
|
||||
|
||||
**Tips:**
|
||||
- To toggle between collapsing and expanding all outdated review comments in a pull request, hold down <span class="platform-mac"><kbd>Option</kbd></span><span class="platform-linux"><kbd>Alt</kbd></span><span class="platform-windows"><kbd>Alt</kbd></span> and click **Show outdated** or **Hide outdated**. For more shortcuts, see "[AUTOTITLE](/get-started/accessibility/keyboard-shortcuts)."
|
||||
- You can squash commits when merging a pull request to gain a more streamlined view of changes. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)."
|
||||
* To toggle between collapsing and expanding all outdated review comments in a pull request, hold down <span class="platform-mac"><kbd>Option</kbd></span><span class="platform-linux"><kbd>Alt</kbd></span><span class="platform-windows"><kbd>Alt</kbd></span> and click **Show outdated** or **Hide outdated**. For more shortcuts, see "[AUTOTITLE](/get-started/accessibility/keyboard-shortcuts)."
|
||||
* You can squash commits when merging a pull request to gain a more streamlined view of changes. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)."
|
||||
|
||||
{% endtip %}
|
||||
|
||||
|
|
@ -67,12 +67,12 @@ When you create a pull request, you can choose to create a pull request that is
|
|||
|
||||
The compare and pull request pages use different methods to calculate the diff for changed files:
|
||||
|
||||
- Compare pages show the diff between the tip of the head ref and the current common ancestor (that is, the merge base) of the head and base ref.
|
||||
- Pull request pages show the diff between the tip of the head ref and the common ancestor of the head and base ref at the time when the pull request was created. Consequently, the merge base used for the comparison might be different.
|
||||
* Compare pages show the diff between the tip of the head ref and the current common ancestor (that is, the merge base) of the head and base ref.
|
||||
* Pull request pages show the diff between the tip of the head ref and the common ancestor of the head and base ref at the time when the pull request was created. Consequently, the merge base used for the comparison might be different.
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/get-started/learning-about-github/github-glossary#pull-request)" in the {% data variables.product.prodname_dotcom %} glossary
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches)"
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)"
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/closing-a-pull-request)"
|
||||
* "[AUTOTITLE](/get-started/learning-about-github/github-glossary#pull-request)" in the {% data variables.product.prodname_dotcom %} glossary
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/closing-a-pull-request)"
|
||||
|
|
|
|||
|
|
@ -40,6 +40,6 @@ shortTitle: Change the base branch
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)"
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)"
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)"
|
||||
|
|
|
|||
|
|
@ -46,4 +46,4 @@ You can convert a pull request to a draft at any time. For example, if you accid
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)"
|
||||
|
|
|
|||
|
|
@ -15,10 +15,10 @@ topics:
|
|||
shortTitle: Commit to PR branch from fork
|
||||
---
|
||||
You can only make commits on pull request branches that:
|
||||
- are opened in a repository that you have push access to and that were created from a fork of that repository
|
||||
- are on a user-owned fork
|
||||
- have permission granted from the pull request creator
|
||||
- don't have [branch restrictions](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#restrict-who-can-push-to-matching-branches) that will prevent you from committing
|
||||
* are opened in a repository that you have push access to and that were created from a fork of that repository
|
||||
* are on a user-owned fork
|
||||
* have permission granted from the pull request creator
|
||||
* don't have [branch restrictions](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#restrict-who-can-push-to-matching-branches) that will prevent you from committing
|
||||
|
||||
Only the user who created the pull request can give you permission to push commits to the user-owned fork. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork)."
|
||||
|
||||
|
|
@ -101,4 +101,4 @@ Your new commits will be reflected on the original pull request on {% data varia
|
|||
|
||||
## Further Reading
|
||||
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)"
|
||||
|
|
|
|||
|
|
@ -18,9 +18,9 @@ shortTitle: Create a PR from a fork
|
|||
If your pull request compares your topic branch with a branch in the upstream repository as the base branch, then your topic branch is also called the "compare branch" of the pull request.
|
||||
|
||||
For example:
|
||||
- Your topic branch (also known as “feature branch”) is the branch where you’re making your changes in your forked repository (e.g. `my-topic-branch`).
|
||||
- The base branch is the branch in the upstream (central) repository that you want to merge your changes into (e.g. `main`).
|
||||
- The pull request compares the changes proposed by the topic branch (`my-topic-branch`) with the base branch (`main`), so `my-topic-branch` is known as the “compare branch”.
|
||||
* Your topic branch (also known as “feature branch”) is the branch where you’re making your changes in your forked repository (e.g. `my-topic-branch`).
|
||||
* The base branch is the branch in the upstream (central) repository that you want to merge your changes into (e.g. `main`).
|
||||
* The pull request compares the changes proposed by the topic branch (`my-topic-branch`) with the base branch (`main`), so `my-topic-branch` is known as the “compare branch”.
|
||||
|
||||
For more information about pull request branches, including examples, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request#changing-the-branch-range-and-destination-repository)."
|
||||
|
||||
|
|
@ -49,5 +49,5 @@ For more information about pull request branches, including examples, see "[AUTO
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks)"
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork)"
|
||||
|
|
|
|||
|
|
@ -39,8 +39,8 @@ When you change any of the information in the branch range, the Commit and Files
|
|||
{% tip %}
|
||||
|
||||
**Tips**:
|
||||
- Using the compare view, you can set up comparisons across any timeframe. For more information, see "[AUTOTITLE](/pull-requests/committing-changes-to-your-project/viewing-and-comparing-commits/comparing-commits)."
|
||||
- Project maintainers can add a pull request template for a repository. Templates include prompts for information in the body of a pull request. For more information, see "[AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates)."
|
||||
* Using the compare view, you can set up comparisons across any timeframe. For more information, see "[AUTOTITLE](/pull-requests/committing-changes-to-your-project/viewing-and-comparing-commits/comparing-commits)."
|
||||
* Project maintainers can add a pull request template for a repository. Templates include prompts for information in the body of a pull request. For more information, see "[AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates)."
|
||||
|
||||
{% endtip %}
|
||||
|
||||
|
|
@ -174,10 +174,10 @@ For more information on creating pull requests in {% data variables.product.prod
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)"
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/keeping-your-pull-request-in-sync-with-the-base-branch)"
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-base-branch-of-a-pull-request)"
|
||||
- "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board#adding-issues-and-pull-requests-to-a-project-board-from-the-sidebar)"
|
||||
- "[AUTOTITLE](/issues/tracking-your-work-with-issues/creating-an-issue)"
|
||||
- "[AUTOTITLE](/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users)"
|
||||
- "[AUTOTITLE](/get-started/writing-on-github)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/keeping-your-pull-request-in-sync-with-the-base-branch)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-base-branch-of-a-pull-request)"
|
||||
* "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board#adding-issues-and-pull-requests-to-a-project-board-from-the-sidebar)"
|
||||
* "[AUTOTITLE](/issues/tracking-your-work-with-issues/creating-an-issue)"
|
||||
* "[AUTOTITLE](/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users)"
|
||||
* "[AUTOTITLE](/get-started/writing-on-github)"
|
||||
|
|
|
|||
|
|
@ -34,8 +34,8 @@ You can create a branch in different ways on {% data variables.product.product_n
|
|||
|
||||
1. Under "Branch name", type a name for the branch.
|
||||
1. Under "Branch source", choose a source for your branch.
|
||||
- If your repository is a fork, select the repository dropdown menu and click your fork or the upstream repository.
|
||||
- Select the branch dropdown menu and click a branch.
|
||||
* If your repository is a fork, select the repository dropdown menu and click your fork or the upstream repository.
|
||||
* Select the branch dropdown menu and click a branch.
|
||||
1. Click **Create branch**.
|
||||
|
||||
### Creating a branch using the branch dropdown
|
||||
|
|
@ -91,6 +91,6 @@ For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-re
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches)"
|
||||
- "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/viewing-branches-in-your-repository)"
|
||||
- "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/deleting-and-restoring-branches-in-a-pull-request)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches)"
|
||||
* "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/viewing-branches-in-your-repository)"
|
||||
* "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/deleting-and-restoring-branches-in-a-pull-request)"
|
||||
|
|
|
|||
|
|
@ -17,9 +17,9 @@ Before merging your pull requests, other changes may get merged into the base br
|
|||
|
||||
You can update a pull request's head branch from the command line or the pull request page. The **Update branch** button is displayed when all of these are true:
|
||||
|
||||
- There are no merge conflicts between the pull request branch and the base branch.
|
||||
- The pull request branch is not up to date with the base branch.
|
||||
- The base branch requires branches to be up to date before merging or the setting to always suggest updating branches is enabled.
|
||||
* There are no merge conflicts between the pull request branch and the base branch.
|
||||
* The pull request branch is not up to date with the base branch.
|
||||
* The base branch requires branches to be up to date before merging or the setting to always suggest updating branches is enabled.
|
||||
|
||||
For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches)" and "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-suggestions-to-update-pull-request-branches)."
|
||||
|
||||
|
|
@ -32,16 +32,16 @@ From the pull request page you can update your pull request's branch using a tra
|
|||
{% data reusables.repositories.sidebar-pr %}
|
||||
1. In the "Pull requests" list, click the pull request you'd like to update.
|
||||
1. In the merge section near the bottom of the page, you can:
|
||||
- Click **Update branch** to perform a traditional merge.
|
||||
* Click **Update branch** to perform a traditional merge.
|
||||
|
||||
|
||||
|
||||
- Click the update branch drop down menu, click **Update with rebase**, and then click **Rebase branch** to update by rebasing on the base branch.
|
||||
* Click the update branch drop down menu, click **Update with rebase**, and then click **Rebase branch** to update by rebasing on the base branch.
|
||||
|
||||
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)"
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)"
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork)"
|
||||
|
|
|
|||
|
|
@ -46,4 +46,4 @@ You can request a review from either a suggested or specific person. Suggested r
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)"
|
||||
|
|
|
|||
|
|
@ -29,9 +29,9 @@ For an introduction to requesting and providing pull request reviews, see the [R
|
|||
{% ifversion fpt or ghec %}You can schedule reminders for pull requests that need to be reviewed. For more information, see "[AUTOTITLE](/organizations/organizing-members-into-teams/managing-scheduled-reminders-for-your-team)."{% endif %}
|
||||
|
||||
A review has three possible statuses:
|
||||
- **Comment**: Submit general feedback without explicitly approving the changes or requesting additional changes.
|
||||
- **Approve**: Submit feedback and approve merging the changes proposed in the pull request.
|
||||
- **Request changes**: Submit feedback that must be addressed before the pull request can be merged.
|
||||
* **Comment**: Submit general feedback without explicitly approving the changes or requesting additional changes.
|
||||
* **Approve**: Submit feedback and approve merging the changes proposed in the pull request.
|
||||
* **Request changes**: Submit feedback that must be addressed before the pull request can be merged.
|
||||
|
||||
{% data reusables.repositories.request-changes-tips %}
|
||||
|
||||
|
|
@ -59,6 +59,6 @@ You can view all of the reviews a pull request has received in the Conversation
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)"
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/viewing-a-pull-request-review)"
|
||||
- "[AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/viewing-a-pull-request-review)"
|
||||
* "[AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors)"
|
||||
|
|
|
|||
|
|
@ -39,5 +39,5 @@ You can comment on a pull request, approve the changes, or request improvements
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)"
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)"
|
||||
|
|
|
|||
|
|
@ -36,8 +36,8 @@ To reply to an existing line {% ifversion pull-request-comment-on-file %}or file
|
|||
{% tip %}
|
||||
|
||||
**Tips:**
|
||||
- Pull request comments support the same [formatting](/get-started/writing-on-github) as regular comments on {% data variables.product.product_name %}, such as @mentions, emoji, and references.
|
||||
- You can add reactions to comments in pull requests in the **Files changed** tab.
|
||||
* Pull request comments support the same [formatting](/get-started/writing-on-github) as regular comments on {% data variables.product.product_name %}, such as @mentions, emoji, and references.
|
||||
* You can add reactions to comments in pull requests in the **Files changed** tab.
|
||||
|
||||
{% endtip %}
|
||||
|
||||
|
|
@ -60,6 +60,6 @@ Anyone watching the pull request or repository will receive a notification of yo
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/get-started/writing-on-github)"
|
||||
* "[AUTOTITLE](/get-started/writing-on-github)"
|
||||
{% ifversion fpt or ghec %}- "[AUTOTITLE](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam)"
|
||||
{% endif %}
|
||||
|
|
|
|||
|
|
@ -33,6 +33,6 @@ This changes the status of the review to a review comment. When you dismiss a re
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)"
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)"
|
||||
- "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-pull-request-reviews-before-merging)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)"
|
||||
* "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-pull-request-reviews-before-merging)"
|
||||
|
|
|
|||
|
|
@ -59,5 +59,5 @@ You can filter files in a pull request by file extension type, such as `.html` o
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests)"
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/finding-changed-methods-and-functions-in-a-pull-request)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/finding-changed-methods-and-functions-in-a-pull-request)"
|
||||
|
|
|
|||
|
|
@ -17,11 +17,11 @@ shortTitle: Methods & functions
|
|||
Anyone with read access to a repository can see a summary list of the functions and methods changes in certain files of a pull request.
|
||||
|
||||
The summary list of methods and functions is created from these supported file types:
|
||||
- Go
|
||||
- JavaScript (includes TypeScript, Flow, and other types of JavaScript)
|
||||
- PHP
|
||||
- Python
|
||||
- Ruby
|
||||
* Go
|
||||
* JavaScript (includes TypeScript, Flow, and other types of JavaScript)
|
||||
* PHP
|
||||
* Python
|
||||
* Ruby
|
||||
|
||||
{% data reusables.repositories.sidebar-pr %}
|
||||
1. In the list of pull requests, click the pull request where you'd like to find the changed functions and methods.
|
||||
|
|
@ -42,5 +42,5 @@ The summary list of methods and functions is created from these supported file t
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests)"
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/filtering-files-in-a-pull-request)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/filtering-files-in-a-pull-request)"
|
||||
|
|
|
|||
|
|
@ -25,11 +25,11 @@ Each person who suggested a change included in the commit will be a co-author of
|
|||
{% data reusables.repositories.sidebar-pr %}
|
||||
1. In the list of pull requests, click the pull request you'd like to apply a suggested change to.
|
||||
1. Navigate to the first suggested change you'd like to apply.
|
||||
- To apply the change in its own commit, click **Commit suggestion**.
|
||||
* To apply the change in its own commit, click **Commit suggestion**.
|
||||
|
||||
|
||||
|
||||
- To add the suggestion to a batch of changes, click **Add suggestion to batch**. Continue to add the suggested changes you want to include in a single commit. When you've finished adding suggested changes, click **Commit suggestions**.
|
||||
* To add the suggestion to a batch of changes, click **Add suggestion to batch**. Continue to add the suggested changes you want to include in a single commit. When you've finished adding suggested changes, click **Commit suggestions**.
|
||||
|
||||
|
||||
|
||||
|
|
@ -46,8 +46,8 @@ If someone suggests changes to your pull request and the changes are out of the
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)"
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)"
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)"
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review)"
|
||||
- "[AUTOTITLE](/issues/tracking-your-work-with-issues/creating-an-issue)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review)"
|
||||
* "[AUTOTITLE](/issues/tracking-your-work-with-issues/creating-an-issue)"
|
||||
|
|
|
|||
|
|
@ -68,17 +68,17 @@ You can configure the {% data variables.dependency-review.action_name %} to bett
|
|||
|
||||
Other information includes:
|
||||
|
||||
- The version, or version range, of the new, updated, or deleted dependency.
|
||||
- For a specific version of a dependency:
|
||||
- The age of that release of the dependency.
|
||||
- The number of projects that are dependent on this software. This information is taken from the dependency graph. Checking the number of dependents can help you avoid accidentally adding the wrong dependency.
|
||||
- The license used by this dependency, if this information is available. This is useful if you want to avoid code with certain licenses being used in your project.
|
||||
* The version, or version range, of the new, updated, or deleted dependency.
|
||||
* For a specific version of a dependency:
|
||||
* The age of that release of the dependency.
|
||||
* The number of projects that are dependent on this software. This information is taken from the dependency graph. Checking the number of dependents can help you avoid accidentally adding the wrong dependency.
|
||||
* The license used by this dependency, if this information is available. This is useful if you want to avoid code with certain licenses being used in your project.
|
||||
|
||||
Where a dependency has a known vulnerability, the warning message includes:
|
||||
|
||||
- A brief description of the vulnerability.
|
||||
- A Common Vulnerabilities and Exposures (CVE) or {% data variables.product.prodname_security_advisories %} (GHSA) identification number. You can click this ID to find out more about the vulnerability.
|
||||
- The severity of the vulnerability.
|
||||
- The version of the dependency in which the vulnerability was fixed. If you are reviewing a pull request for someone, you might ask the contributor to update the dependency to the patched version, or a later release.
|
||||
* A brief description of the vulnerability.
|
||||
* A Common Vulnerabilities and Exposures (CVE) or {% data variables.product.prodname_security_advisories %} (GHSA) identification number. You can click this ID to find out more about the vulnerability.
|
||||
* The severity of the vulnerability.
|
||||
* The version of the dependency in which the vulnerability was fixed. If you are reviewing a pull request for someone, you might ask the contributor to update the dependency to the patched version, or a later release.
|
||||
|
||||
{% data reusables.repositories.return-to-source-diff %}
|
||||
|
|
|
|||
|
|
@ -109,14 +109,14 @@ After you've finished reviewing all the files you want in the pull request, subm
|
|||
{% data reusables.repositories.review-summary-comment %}
|
||||
1. Select the type of review you'd like to leave:
|
||||
|
||||
- Select **Comment** to leave general feedback without explicitly approving the changes or requesting additional changes.
|
||||
- Select **Approve** to submit your feedback and approve merging the changes proposed in the pull request.
|
||||
- Select **Request changes** to submit feedback that must be addressed before the pull request can be merged.
|
||||
* Select **Comment** to leave general feedback without explicitly approving the changes or requesting additional changes.
|
||||
* Select **Approve** to submit your feedback and approve merging the changes proposed in the pull request.
|
||||
* Select **Request changes** to submit feedback that must be addressed before the pull request can be merged.
|
||||
{% data reusables.repositories.submit-review %}
|
||||
|
||||
{% data reusables.repositories.request-changes-tips %}
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-pull-request-reviews-before-merging)"
|
||||
- "[AUTOTITLE](/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests)"
|
||||
* "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-pull-request-reviews-before-merging)"
|
||||
* "[AUTOTITLE](/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests)"
|
||||
|
|
|
|||
|
|
@ -26,6 +26,6 @@ When you view a full review, you'll see the same version of the pull request as
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)"
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)"
|
||||
- "[AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/triaging-code-scanning-alerts-in-pull-requests)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)"
|
||||
* "[AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/triaging-code-scanning-alerts-in-pull-requests)"
|
||||
|
|
|
|||
|
|
@ -46,14 +46,14 @@ If you want to create a new repository from the contents of an existing reposito
|
|||
|
||||
Forking a repository is similar to duplicating a repository, with the following differences.
|
||||
|
||||
- You can use a pull request to suggest changes from your fork to the upstream repository.
|
||||
- You can bring changes from the upstream repository to your fork by synchronizing your fork with the upstream repository.
|
||||
- Forks have their own members, branches, tags, labels, policies, issues, pull requests, discussions, actions, projects, and wikis.
|
||||
- Forks inherit the restrictions of their upstream repositories. For example, branch protection rules cannot be passed down if the upstream repository belongs to an organization on a {% data variables.product.prodname_free_team %} plan.
|
||||
* You can use a pull request to suggest changes from your fork to the upstream repository.
|
||||
* You can bring changes from the upstream repository to your fork by synchronizing your fork with the upstream repository.
|
||||
* Forks have their own members, branches, tags, labels, policies, issues, pull requests, discussions, actions, projects, and wikis.
|
||||
* Forks inherit the restrictions of their upstream repositories. For example, branch protection rules cannot be passed down if the upstream repository belongs to an organization on a {% data variables.product.prodname_free_team %} plan.
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models)"
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)"
|
||||
- [Open Source Guides](https://opensource.guide/){% ifversion fpt or ghec %}
|
||||
- [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}){% endif %}
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)"
|
||||
* [Open Source Guides](https://opensource.guide/){% ifversion fpt or ghec %}
|
||||
* [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}){% endif %}
|
||||
|
|
|
|||
|
|
@ -54,17 +54,17 @@ For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-me
|
|||
|
||||
If you work with forks, or if you're the owner of a repository or organization that allows forking, it's important to be aware of the following security considerations.
|
||||
|
||||
- Forks have their own permissions separate from the upstream repository.
|
||||
- The owners of a repository that has been forked have read permission to all forks in the repository's fork network.
|
||||
- Organization owners of a repository that has been forked have admin permission to forks created in personal user namespaces, including the ability to delete the fork and its branches.
|
||||
- Organization owners of a repository that has been forked have read permission to forks created in organizations, but do not have the ability to delete the fork or its branches.
|
||||
- Forks created in another organization will not be deleted when individual access is removed from the upstream repository.
|
||||
- Commits to any repository in a fork network can be accessed from any repository in the same fork network, including the upstream repository.
|
||||
* Forks have their own permissions separate from the upstream repository.
|
||||
* The owners of a repository that has been forked have read permission to all forks in the repository's fork network.
|
||||
* Organization owners of a repository that has been forked have admin permission to forks created in personal user namespaces, including the ability to delete the fork and its branches.
|
||||
* Organization owners of a repository that has been forked have read permission to forks created in organizations, but do not have the ability to delete the fork or its branches.
|
||||
* Forks created in another organization will not be deleted when individual access is removed from the upstream repository.
|
||||
* Commits to any repository in a fork network can be accessed from any repository in the same fork network, including the upstream repository.
|
||||
|
||||
### About forks within an organization
|
||||
|
||||
Forks within the same organization copy the collaborators and team settings of their upstream repositories. If a repository is owned by an organization:
|
||||
- That organization controls the permissions of its forks.
|
||||
- Any teams from the upstream permission structure that exist and are visible in the target organization or user namespace will have their permissions copied.
|
||||
- Admin permissions remain with the upstream owner, except when a user forks into a different organization.
|
||||
- If that repository is forked to a user namespace, the organization maintains admin permissions and any teams with access maintain access.
|
||||
* That organization controls the permissions of its forks.
|
||||
* Any teams from the upstream permission structure that exist and are visible in the target organization or user namespace will have their permissions copied.
|
||||
* Admin permissions remain with the upstream owner, except when a user forks into a different organization.
|
||||
* If that repository is forked to a user namespace, the organization maintains admin permissions and any teams with access maintain access.
|
||||
|
|
|
|||
|
|
@ -41,4 +41,4 @@ You can set commit permissions when you first create a pull request from a fork.
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork)"
|
||||
|
|
|
|||
|
|
@ -20,8 +20,8 @@ The new repository will no longer automatically sync with changes from the origi
|
|||
|
||||
**Notes:**
|
||||
|
||||
- The new repository will not retain any of its issues, pull requests, wikis, stars, watchers, comments, child forks, or other metadata that may currently be associated with your current fork.
|
||||
- All commit metadata will be preserved. Commits may become eligible to be counted as contributions, if they meet certain criteria. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile#your-local-git-commit-email-isnt-connected-to-your-account)."
|
||||
* The new repository will not retain any of its issues, pull requests, wikis, stars, watchers, comments, child forks, or other metadata that may currently be associated with your current fork.
|
||||
* All commit metadata will be preserved. Commits may become eligible to be counted as contributions, if they meet certain criteria. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile#your-local-git-commit-email-isnt-connected-to-your-account)."
|
||||
|
||||
{% endnote %}
|
||||
|
||||
|
|
|
|||
|
|
@ -28,9 +28,9 @@ topics:
|
|||
|
||||
For example, you can use forks to propose changes related to fixing a bug. Rather than logging an issue for a bug you have found, you can:
|
||||
|
||||
- Fork the repository.
|
||||
- Make the fix.
|
||||
- Submit a pull request to the project owner.
|
||||
* Fork the repository.
|
||||
* Make the fix.
|
||||
* Submit a pull request to the project owner.
|
||||
|
||||
### Use someone else's project as a starting point for your own idea.
|
||||
|
||||
|
|
@ -157,10 +157,10 @@ When you fork a project in order to propose changes to the upstream repository,
|
|||
{% data reusables.repositories.copy-clone-url %}
|
||||
{% data reusables.command_line.open_the_multi_os_terminal %}
|
||||
1. Change directories to the location of the fork you cloned.
|
||||
- To go to your home directory, type just `cd` with no other text.
|
||||
- To list the files and folders in your current directory, type `ls`.
|
||||
- To go into one of your listed directories, type `cd YOUR-LISTED-DIRECTORY`.
|
||||
- To go up one directory, type `cd ..`.
|
||||
* To go to your home directory, type just `cd` with no other text.
|
||||
* To list the files and folders in your current directory, type `ls`.
|
||||
* To go into one of your listed directories, type `cd YOUR-LISTED-DIRECTORY`.
|
||||
* To go up one directory, type `cd ..`.
|
||||
1. Type `git remote -v` and press **Enter**. You will see the current configured remote repository for your fork.
|
||||
|
||||
```shell
|
||||
|
|
@ -211,8 +211,8 @@ gh repo fork REPOSITORY --remote-name "main-remote-repo"
|
|||
|
||||
You can make any changes to a fork, including:
|
||||
|
||||
- **Creating branches:** [_Branches_](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository) allow you to build new features or test out ideas without putting your main project at risk.
|
||||
- **Opening pull requests:** If you want to contribute back to the upstream repository, you can send a request to the original author to pull your fork into their repository by submitting a [pull request](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).
|
||||
* **Creating branches:** [_Branches_](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository) allow you to build new features or test out ideas without putting your main project at risk.
|
||||
* **Opening pull requests:** If you want to contribute back to the upstream repository, you can send a request to the original author to pull your fork into their repository by submitting a [pull request](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).
|
||||
|
||||
## Find another repository to fork
|
||||
|
||||
|
|
@ -226,10 +226,10 @@ Fork a repository to start contributing to a project. {% data reusables.reposito
|
|||
|
||||
You have now forked a repository, practiced cloning your fork, and configured an upstream repository.
|
||||
|
||||
- For more information about cloning the fork and syncing the changes in a forked repository from your computer, see "[AUTOTITLE](/get-started/getting-started-with-git/set-up-git)."
|
||||
* For more information about cloning the fork and syncing the changes in a forked repository from your computer, see "[AUTOTITLE](/get-started/getting-started-with-git/set-up-git)."
|
||||
|
||||
- You can also create a new repository where you can put all your projects and share the code on {% data variables.product.prodname_dotcom %}. {% data reusables.getting-started.create-a-repository %}
|
||||
* You can also create a new repository where you can put all your projects and share the code on {% data variables.product.prodname_dotcom %}. {% data reusables.getting-started.create-a-repository %}
|
||||
|
||||
- {% data reusables.getting-started.being-social %}
|
||||
* {% data reusables.getting-started.being-social %}
|
||||
|
||||
- {% data reusables.support.connect-in-the-forum-bootcamp %}
|
||||
* {% data reusables.support.connect-in-the-forum-bootcamp %}
|
||||
|
|
|
|||
|
|
@ -65,8 +65,8 @@ If you change the visibility of an internal repository and then delete the repos
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility)"
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)"
|
||||
- "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository)"
|
||||
- "[AUTOTITLE](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)"
|
||||
- "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-on-forking-private-or-internal-repositories)"
|
||||
* "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)"
|
||||
* "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository)"
|
||||
* "[AUTOTITLE](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)"
|
||||
* "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-on-forking-private-or-internal-repositories)"
|
||||
|
|
|
|||
|
|
@ -67,4 +67,4 @@ You can use the file tree to navigate between files in a commit.
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project-in-github-desktop#about-commits)" on {% data variables.product.prodname_desktop %}
|
||||
* "[AUTOTITLE](/desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project-in-github-desktop#about-commits)" on {% data variables.product.prodname_desktop %}
|
||||
|
|
|
|||
|
|
@ -24,9 +24,9 @@ If the commit only exists in your local repository and has not been pushed to {%
|
|||
1. On the command line, navigate to the repository that contains the commit you want to amend.
|
||||
1. Type `git commit --amend` and press **Enter**.
|
||||
1. In your text editor, edit the commit message, and save the commit.
|
||||
- You can add a co-author by adding a trailer to the commit. For more information, see "[AUTOTITLE](/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors)."
|
||||
* You can add a co-author by adding a trailer to the commit. For more information, see "[AUTOTITLE](/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors)."
|
||||
{% ifversion fpt or ghec %}
|
||||
- You can create commits on behalf of your organization by adding a trailer to the commit. For more information, see "[AUTOTITLE](/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization)."
|
||||
* You can create commits on behalf of your organization by adding a trailer to the commit. For more information, see "[AUTOTITLE](/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization)."
|
||||
{% endif %}
|
||||
|
||||
The new commit and message will appear on {% data variables.location.product_location %} the next time you push.
|
||||
|
|
@ -126,4 +126,4 @@ If you have included sensitive information in a commit message, force pushing a
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/authentication/managing-commit-signature-verification/signing-commits)"
|
||||
* "[AUTOTITLE](/authentication/managing-commit-signature-verification/signing-commits)"
|
||||
|
|
|
|||
|
|
@ -13,12 +13,12 @@ shortTitle: On behalf of an organization
|
|||
|
||||
To create commits on behalf of an organization:
|
||||
|
||||
- You must be a member of the organization indicated in the trailer
|
||||
- You must sign the commit
|
||||
- Your commit email and the organization email must be in a domain verified by the organization
|
||||
- Your commit message must end with the commit trailer `on-behalf-of: @org <name@organization.com>`
|
||||
- `org` is the organization's login
|
||||
- `name@organization.com` is in the organization's domain
|
||||
* You must be a member of the organization indicated in the trailer
|
||||
* You must sign the commit
|
||||
* Your commit email and the organization email must be in a domain verified by the organization
|
||||
* Your commit message must end with the commit trailer `on-behalf-of: @org <name@organization.com>`
|
||||
* `org` is the organization's login
|
||||
* `name@organization.com` is in the organization's domain
|
||||
|
||||
Organizations can use the `name@organization.com` email as a public point of contact for open source efforts.
|
||||
|
||||
|
|
@ -62,7 +62,7 @@ The new commit, message, and badge will appear on {% data variables.location.pro
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/viewing-contributions-on-your-profile)"
|
||||
- "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile)"
|
||||
- "[AUTOTITLE](/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors)"
|
||||
- "[AUTOTITLE](/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message)"
|
||||
* "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/viewing-contributions-on-your-profile)"
|
||||
* "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile)"
|
||||
* "[AUTOTITLE](/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors)"
|
||||
* "[AUTOTITLE](/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message)"
|
||||
|
|
|
|||
|
|
@ -24,8 +24,8 @@ For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-manag
|
|||
{% tip %}
|
||||
|
||||
**Tip:** You can help a co-author find their preferred email address by sharing this information:
|
||||
- To find your {% data variables.product.product_name %}-provided `no-reply` email, navigate to your email settings page under "Keep my email address private."
|
||||
- To find the email you used to configure Git on your computer, run `git config user.email` on the command line.
|
||||
* To find your {% data variables.product.product_name %}-provided `no-reply` email, navigate to your email settings page under "Keep my email address private."
|
||||
* To find the email you used to configure Git on your computer, run `git config user.email` on the command line.
|
||||
|
||||
{% endtip %}
|
||||
|
||||
|
|
@ -82,8 +82,8 @@ The new commit and message will appear on {% data variables.location.product_loc
|
|||
## Further reading
|
||||
|
||||
{% ifversion ghes %}
|
||||
- "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/viewing-contributions-on-your-profile)"
|
||||
- "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile)"{% endif %}
|
||||
- "[AUTOTITLE](/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors)"
|
||||
- "[AUTOTITLE](/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message)"
|
||||
- "[AUTOTITLE](/desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project-in-github-desktop#4-write-a-commit-message-and-push-your-changes)" in the {% data variables.product.prodname_desktop %} documentation
|
||||
* "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/viewing-contributions-on-your-profile)"
|
||||
* "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile)"{% endif %}
|
||||
* "[AUTOTITLE](/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors)"
|
||||
* "[AUTOTITLE](/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message)"
|
||||
* "[AUTOTITLE](/desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project-in-github-desktop#4-write-a-commit-message-and-push-your-changes)" in the {% data variables.product.prodname_desktop %} documentation
|
||||
|
|
|
|||
|
|
@ -26,9 +26,9 @@ However, when you view the commit on {% data variables.location.product_location
|
|||
|
||||
There are several possible explanations:
|
||||
|
||||
- The local repository is out of date.
|
||||
- The branch that contains the commit was deleted, so the commit is no longer referenced.
|
||||
- Someone force pushed over the commit.
|
||||
* The local repository is out of date.
|
||||
* The branch that contains the commit was deleted, so the commit is no longer referenced.
|
||||
* Someone force pushed over the commit.
|
||||
|
||||
## The local repository is out of date
|
||||
|
||||
|
|
@ -87,5 +87,5 @@ Avoid force pushing to a repository unless absolutely necessary. This is especia
|
|||
|
||||
## Further reading
|
||||
|
||||
- ["Working with Remotes" from the _Pro Git_ book](https://git-scm.com/book/en/Git-Basics-Working-with-Remotes)
|
||||
- ["Data Recovery" from the _Pro Git_ book](https://git-scm.com/book/en/Git-Internals-Maintenance-and-Data-Recovery)
|
||||
* ["Working with Remotes" from the _Pro Git_ book](https://git-scm.com/book/en/Git-Basics-Working-with-Remotes)
|
||||
* ["Data Recovery" from the _Pro Git_ book](https://git-scm.com/book/en/Git-Internals-Maintenance-and-Data-Recovery)
|
||||
|
|
|
|||
|
|
@ -36,9 +36,9 @@ If your commits are not linked to any user, the commit author's name will not be
|
|||
{% data reusables.repositories.navigate-to-commit %}
|
||||
1. To read a message about why the commit is not linked, hover over the blue {% octicon "question" aria-label="Question mark" %} to the right of the username.
|
||||
|
||||
- **Unrecognized author (with email address)** If you see this message with an email address, the address you used to author the commit is not connected to your account on {% data variables.product.product_name %}. To link your commits, [add the email address to your GitHub email settings](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account). If the email address has a Gravatar associated with it, the Gravatar will be displayed next to the commit, rather than the default gray Octocat.
|
||||
- **Unrecognized author (no email address)** If you see this message without an email address, you used a generic email address that can't be connected to your account on {% data variables.product.product_name %}. You will need to [set your commit email address in Git](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address), then [add the new address to your GitHub email settings](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account) to link your future commits. Old commits will not be linked.
|
||||
- **Invalid email** The email address in your local Git configuration settings is either blank or not formatted as an email address. You will need to [set your commit email address in Git](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address), then [add the new address to your GitHub email settings](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account) to link your future commits. Old commits will not be linked.
|
||||
* **Unrecognized author (with email address)** If you see this message with an email address, the address you used to author the commit is not connected to your account on {% data variables.product.product_name %}. To link your commits, [add the email address to your GitHub email settings](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account). If the email address has a Gravatar associated with it, the Gravatar will be displayed next to the commit, rather than the default gray Octocat.
|
||||
* **Unrecognized author (no email address)** If you see this message without an email address, you used a generic email address that can't be connected to your account on {% data variables.product.product_name %}. You will need to [set your commit email address in Git](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address), then [add the new address to your GitHub email settings](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account) to link your future commits. Old commits will not be linked.
|
||||
* **Invalid email** The email address in your local Git configuration settings is either blank or not formatted as an email address. You will need to [set your commit email address in Git](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address), then [add the new address to your GitHub email settings](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account) to link your future commits. Old commits will not be linked.
|
||||
|
||||
{% warning %}
|
||||
|
||||
|
|
@ -48,4 +48,4 @@ If your local Git configuration contained a generic email address, or an email a
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/search-github/searching-on-github/searching-commits)"
|
||||
* "[AUTOTITLE](/search-github/searching-on-github/searching-commits)"
|
||||
|
|
|
|||
|
|
@ -71,4 +71,4 @@ You can compare a single commit in Git to the commit's predecessors using two ty
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-base-branch-of-a-pull-request)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-base-branch-of-a-pull-request)"
|
||||
|
|
|
|||
|
|
@ -13,8 +13,8 @@ shortTitle: Commit views
|
|||
---
|
||||
On {% data variables.product.product_name %}, you can see the commit history of a repository by:
|
||||
|
||||
- Navigating directly to [the commits page](https://github.com/mozilla/rust/commits/master) of a repository
|
||||
- Clicking on a file, then clicking **History**, to get to [the commit history for a specific file](https://github.com/mozilla/rust/commits/master/README.md)
|
||||
* Navigating directly to [the commits page](https://github.com/mozilla/rust/commits/master) of a repository
|
||||
* Clicking on a file, then clicking **History**, to get to [the commit history for a specific file](https://github.com/mozilla/rust/commits/master/README.md)
|
||||
|
||||
These two commit views may show _different_ information at times. The history for a single file may omit commits found on the repository's commit history.
|
||||
|
||||
|
|
@ -34,5 +34,5 @@ For more information on how Git considers commit history, see [the "History Simp
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/authentication/managing-commit-signature-verification/signing-commits)"
|
||||
- "[AUTOTITLE](/search-github/searching-on-github/searching-commits)"
|
||||
* "[AUTOTITLE](/authentication/managing-commit-signature-verification/signing-commits)"
|
||||
* "[AUTOTITLE](/search-github/searching-on-github/searching-commits)"
|
||||
|
|
|
|||
|
|
@ -16,8 +16,8 @@ shortTitle: Archive content & data
|
|||
|
||||
{% data variables.product.product_name %} intends to keep your public repositories available unless you remove them. In some cases, we may make public content unavailable, for example if:
|
||||
|
||||
- We receive a [DMCA Takedown Notice](/free-pro-team@latest/site-policy/content-removal-policies/dmca-takedown-policy) for content in a repository.
|
||||
- We determine that a repository's content violates our [Community Guidelines](/free-pro-team@latest/site-policy/github-terms/github-community-guidelines) or [Terms of Service](/free-pro-team@latest/site-policy/github-terms/github-terms-of-service).
|
||||
* We receive a [DMCA Takedown Notice](/free-pro-team@latest/site-policy/content-removal-policies/dmca-takedown-policy) for content in a repository.
|
||||
* We determine that a repository's content violates our [Community Guidelines](/free-pro-team@latest/site-policy/github-terms/github-community-guidelines) or [Terms of Service](/free-pro-team@latest/site-policy/github-terms/github-terms-of-service).
|
||||
|
||||
Academics and researchers can reference this information in data management plans.
|
||||
|
||||
|
|
|
|||
|
|
@ -19,9 +19,9 @@ To make your repositories easier to reference in academic literature, you can cr
|
|||
{% tip %}
|
||||
|
||||
**Tips:**
|
||||
- Zenodo can only access public repositories, so make sure the repository you want to archive is [public](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility).
|
||||
- If you want to archive a repository that belongs to an organization, the organization owner may need to [approve access](/organizations/managing-oauth-access-to-your-organizations-data/approving-oauth-apps-for-your-organization) for the Zenodo application.
|
||||
- Make sure to include a [license](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository) in your repository so readers know how they can reuse your work.
|
||||
* Zenodo can only access public repositories, so make sure the repository you want to archive is [public](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility).
|
||||
* If you want to archive a repository that belongs to an organization, the organization owner may need to [approve access](/organizations/managing-oauth-access-to-your-organizations-data/approving-oauth-apps-for-your-organization) for the Zenodo application.
|
||||
* Make sure to include a [license](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository) in your repository so readers know how they can reuse your work.
|
||||
|
||||
{% endtip %}
|
||||
|
||||
|
|
|
|||
|
|
@ -32,9 +32,9 @@ The default merge method creates a merge commit. You can prevent anyone from pus
|
|||
{% data reusables.pull_requests.squash_and_merge_summary %}
|
||||
|
||||
Before enabling squashing commits, consider these disadvantages:
|
||||
- You lose information about when specific changes were originally made and who authored the squashed commits.
|
||||
- If you continue working on the head branch of a pull request after squashing and merging, and then create a new pull request between the same branches, commits that you previously squashed and merged will be listed in the new pull request. You may also have conflicts that you have to repeatedly resolve in each successive pull request. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#squashing-and-merging-a-long-running-branch)."
|
||||
- Some Git commands that use the "SHA" or "hash" ID may be harder to use since the SHA ID for the original commits is lost. For example, using [`git rerere`](https://git-scm.com/docs/git-rerere) may not be as effective.
|
||||
* You lose information about when specific changes were originally made and who authored the squashed commits.
|
||||
* If you continue working on the head branch of a pull request after squashing and merging, and then create a new pull request between the same branches, commits that you previously squashed and merged will be listed in the new pull request. You may also have conflicts that you have to repeatedly resolve in each successive pull request. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#squashing-and-merging-a-long-running-branch)."
|
||||
* Some Git commands that use the "SHA" or "hash" ID may be harder to use since the SHA ID for the original commits is lost. For example, using [`git rerere`](https://git-scm.com/docs/git-rerere) may not be as effective.
|
||||
|
||||
For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests)."
|
||||
|
||||
|
|
@ -43,8 +43,8 @@ For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-me
|
|||
{% data reusables.pull_requests.rebase_and_merge_summary %}
|
||||
|
||||
Before enabling commit rebasing, consider these disadvantages:
|
||||
- Repository contributors may have to rebase on the command line, resolve any conflicts, and force push their changes to the pull request's topic branch (or remote head branch) before they can use the **rebase and merge** option on {% data variables.location.product_location %}. Force pushing must be done carefully so contributors don't overwrite work that others have based their work on. To learn more about when the **Rebase and merge** option is disabled on {% data variables.location.product_location %} and the workflow to re-enable it, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#rebase-and-merge-your-pull-request-commits)."
|
||||
- {% indented_data_reference reusables.pull_requests.rebase_and_merge_verification spaces=2 %}
|
||||
* Repository contributors may have to rebase on the command line, resolve any conflicts, and force push their changes to the pull request's topic branch (or remote head branch) before they can use the **rebase and merge** option on {% data variables.location.product_location %}. Force pushing must be done carefully so contributors don't overwrite work that others have based their work on. To learn more about when the **Rebase and merge** option is disabled on {% data variables.location.product_location %} and the workflow to re-enable it, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#rebase-and-merge-your-pull-request-commits)."
|
||||
* {% indented_data_reference reusables.pull_requests.rebase_and_merge_verification spaces=2 %}
|
||||
|
||||
{% indented_data_reference reusables.pull_requests.rebase_and_merge_verification_2 spaces=2 %}
|
||||
|
||||
|
|
|
|||
|
|
@ -24,5 +24,5 @@ If you select more than one merge method, collaborators can choose which type of
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)"
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)"
|
||||
|
|
|
|||
|
|
@ -31,5 +31,5 @@ If you select more than one merge method, collaborators can choose which type of
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)"
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)"
|
||||
|
|
|
|||
|
|
@ -25,9 +25,9 @@ For more information on merging a pull request using a merge queue, see "[AUTOTI
|
|||
|
||||
**Notes:**
|
||||
|
||||
- A merge queue cannot be enabled with branch protection rules that use wildcard characters (`*`) in the branch name pattern.
|
||||
- A merge queue will wait for required checks to be reported before it can proceed with merging. You must update your CI configuration to trigger and report on merge group events when requiring a merge queue.
|
||||
- Merge queue and pull requests checks are coupled and configured under branch protection rules or rulesets. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue#managing-a-merge-queue)."
|
||||
* A merge queue cannot be enabled with branch protection rules that use wildcard characters (`*`) in the branch name pattern.
|
||||
* A merge queue will wait for required checks to be reported before it can proceed with merging. You must update your CI configuration to trigger and report on merge group events when requiring a merge queue.
|
||||
* Merge queue and pull requests checks are coupled and configured under branch protection rules or rulesets. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue#managing-a-merge-queue)."
|
||||
|
||||
{% endnote %}
|
||||
|
||||
|
|
@ -61,9 +61,9 @@ Repository administrators can require a merge queue by enabling the branch prote
|
|||
|
||||
Once you have enabled the "Require merge queue" setting, you can also access the following settings:
|
||||
|
||||
- **Merge method**: Select which method to use when merging queued pull requests: merge, rebase, or squash.
|
||||
* **Merge method**: Select which method to use when merging queued pull requests: merge, rebase, or squash.
|
||||
|
||||
- **Build concurrency**: The maximum number of `merge_group` webhooks to dispatch (between `1` and `100`), throttling the total amount of concurrent CI builds. This affects the velocity of merges that a merge queue can complete.
|
||||
* **Build concurrency**: The maximum number of `merge_group` webhooks to dispatch (between `1` and `100`), throttling the total amount of concurrent CI builds. This affects the velocity of merges that a merge queue can complete.
|
||||
-
|
||||
**Only merge non-failing pull requests**: This setting determines how a merge queue forms groups of pull requests to be merged.
|
||||
|
||||
|
|
@ -72,7 +72,7 @@ Once you have enabled the "Require merge queue" setting, you can also access the
|
|||
| Yes | All pull requests must satisfy required checks to be merged. |
|
||||
| No | Pull requests that have failed required checks can be added to a group as long as the last pull request in the group has passed required checks. If the last pull request in the group has passed required checks, this means that the checks have passed for the combined set of changes in the merge group. Leaving this checkbox unselected can be useful if you have intermittent test failures, but don't want false negatives to hold up the queue. |
|
||||
|
||||
- **Status check timeout**: Choose how long the queue should wait for a response from CI before assuming that checks have failed.
|
||||
* **Status check timeout**: Choose how long the queue should wait for a response from CI before assuming that checks have failed.
|
||||
|
||||
-
|
||||
**Merge limits**: Select the minimum and maximum number of pull requests to merge into the base branch at the same time (between `1` and `100`), and a timeout after which the queue should stop waiting for more entries and merge with fewer than the minimum number.
|
||||
|
|
@ -145,5 +145,5 @@ The following scenario outlines what happens when a user jumps the queue.
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue)"
|
||||
- "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue)"
|
||||
* "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches)"
|
||||
|
|
|
|||
|
|
@ -21,5 +21,5 @@ Anyone with admin permissions to a repository can enable or disable the automati
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)"
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository)"
|
||||
|
|
|
|||
|
|
@ -40,5 +40,5 @@ You can restore the head branch of a closed pull request.
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository)"
|
||||
- "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-the-automatic-deletion-of-branches)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository)"
|
||||
* "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-the-automatic-deletion-of-branches)"
|
||||
|
|
|
|||
|
|
@ -16,16 +16,16 @@ shortTitle: View branches
|
|||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.navigate-to-branches %}
|
||||
1. Use the navigation at the top of the page to view specific lists of branches:
|
||||
- **Your branches**: In repositories that you have push access to, the **Yours** view shows all branches that you’ve pushed to, excluding the default branch, with the most recent branches first.
|
||||
- **Active branches**: The **Active** view shows all branches (excluding the default branch) that anyone has committed to within the last three months, ordered by the branches with the most recent commits first.
|
||||
- **Stale branches**: The **Stale** view shows all branches that no one has committed to in the last three months, ordered by the branches with the oldest commits first. Use this list to determine [which branches to delete](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository).
|
||||
- **All branches**: The **All** view shows the default branch, followed by all other branches ordered by the branches with the most recent commits first.
|
||||
* **Your branches**: In repositories that you have push access to, the **Yours** view shows all branches that you’ve pushed to, excluding the default branch, with the most recent branches first.
|
||||
* **Active branches**: The **Active** view shows all branches (excluding the default branch) that anyone has committed to within the last three months, ordered by the branches with the most recent commits first.
|
||||
* **Stale branches**: The **Stale** view shows all branches that no one has committed to in the last three months, ordered by the branches with the oldest commits first. Use this list to determine [which branches to delete](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository).
|
||||
* **All branches**: The **All** view shows the default branch, followed by all other branches ordered by the branches with the most recent commits first.
|
||||
|
||||
1. Optionally, use the search field on the top right. It provides a simple, case-insensitive, sub-string search on the branch name. It does not support any additional query syntax.
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository)"
|
||||
- "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/deleting-and-restoring-branches-in-a-pull-request)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository)"
|
||||
* "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/deleting-and-restoring-branches-in-a-pull-request)"
|
||||
{%- ifversion repository-activity-view %}
|
||||
- "[AUTOTITLE](/repositories/viewing-activity-and-data-for-your-repository/using-the-activity-view-to-see-changes-to-a-repository)."{% endif %}
|
||||
* "[AUTOTITLE](/repositories/viewing-activity-and-data-for-your-repository/using-the-activity-view-to-see-changes-to-a-repository)."{% endif %}
|
||||
|
|
|
|||
|
|
@ -51,24 +51,24 @@ By default, the restrictions of a branch protection rule don't apply to people w
|
|||
## About branch protection settings
|
||||
|
||||
For each branch protection rule, you can choose to enable or disable the following settings.
|
||||
- [Require pull request reviews before merging](#require-pull-request-reviews-before-merging)
|
||||
- [Require status checks before merging](#require-status-checks-before-merging)
|
||||
- [Require conversation resolution before merging](#require-conversation-resolution-before-merging)
|
||||
- [Require signed commits](#require-signed-commits)
|
||||
- [Require linear history](#require-linear-history)
|
||||
* [Require pull request reviews before merging](#require-pull-request-reviews-before-merging)
|
||||
* [Require status checks before merging](#require-status-checks-before-merging)
|
||||
* [Require conversation resolution before merging](#require-conversation-resolution-before-merging)
|
||||
* [Require signed commits](#require-signed-commits)
|
||||
* [Require linear history](#require-linear-history)
|
||||
{% ifversion merge-queue %}
|
||||
- [Require merge queue](#require-merge-queue)
|
||||
* [Require merge queue](#require-merge-queue)
|
||||
{% endif %}
|
||||
{%- ifversion required-deployments %}
|
||||
- [Require deployments to succeed before merging](#require-deployments-to-succeed-before-merging)
|
||||
* [Require deployments to succeed before merging](#require-deployments-to-succeed-before-merging)
|
||||
{%- endif %}
|
||||
{%- ifversion lock-branch %}
|
||||
- [Lock branch](#lock-branch)
|
||||
* [Lock branch](#lock-branch)
|
||||
{%- endif %}
|
||||
{% ifversion bypass-branch-protections %}- [Do not allow bypassing the above settings](#do-not-allow-bypassing-the-above-settings){% else %}- [Include administrators](#include-administrators){% endif %}
|
||||
- [Restrict who can push to matching branches](#restrict-who-can-push-to-matching-branches)
|
||||
- [Allow force pushes](#allow-force-pushes)
|
||||
- [Allow deletions](#allow-deletions)
|
||||
* [Restrict who can push to matching branches](#restrict-who-can-push-to-matching-branches)
|
||||
* [Allow force pushes](#allow-force-pushes)
|
||||
* [Allow deletions](#allow-deletions)
|
||||
|
||||
For more information on how to set up branch protection, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule)."
|
||||
|
||||
|
|
@ -138,8 +138,8 @@ When you enable required commit signing on a branch, contributors {% ifversion f
|
|||
{% ifversion fpt or ghec %}
|
||||
**Notes:**
|
||||
|
||||
- If you have enabled vigilant mode, which indicates that your commits will always be signed, any commits that {% data variables.product.prodname_dotcom %} identifies as "Partially verified" are permitted on branches that require signed commits. For more information about vigilant mode, see "[AUTOTITLE](/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits)."
|
||||
- If a collaborator pushes an unsigned commit to a branch that requires commit signatures, the collaborator will need to rebase the commit to include a verified signature, then force push the rewritten commit to the branch.
|
||||
* If you have enabled vigilant mode, which indicates that your commits will always be signed, any commits that {% data variables.product.prodname_dotcom %} identifies as "Partially verified" are permitted on branches that require signed commits. For more information about vigilant mode, see "[AUTOTITLE](/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits)."
|
||||
* If a collaborator pushes an unsigned commit to a branch that requires commit signatures, the collaborator will need to rebase the commit to include a verified signature, then force push the rewritten commit to the branch.
|
||||
|
||||
{% else %}
|
||||
**Note:** If a collaborator pushes an unsigned commit to a branch that requires commit signatures, the collaborator will need to rebase the commit to include a verified signature, then force push the rewritten commit to the branch.
|
||||
|
|
|
|||
|
|
@ -68,21 +68,21 @@ When you create a branch rule, the branch you specify doesn't have to exist yet
|
|||
{% ifversion pull-request-mergeability-security-changes %}
|
||||
{% indented_data_reference reusables.pull_requests.security-changes-mergeability spaces=3 %}
|
||||
{% endif %}
|
||||
- Under "Protect matching branches", select **Require a pull request before merging**.
|
||||
- Optionally, to require approvals before a pull request can be merged, select **Require approvals**.
|
||||
* Under "Protect matching branches", select **Require a pull request before merging**.
|
||||
* Optionally, to require approvals before a pull request can be merged, select **Require approvals**.
|
||||
|
||||
Select the **Required number of approvals before merging** dropdown menu, then click the number of approving reviews you would like to require on the branch.
|
||||
- Optionally, to dismiss a pull request approval review when a code-modifying commit is pushed to the branch, select **Dismiss stale pull request approvals when new commits are pushed**.
|
||||
- Optionally, to require review from a code owner when the pull request affects code that has a designated owner, select **Require review from Code Owners**. Note that if code has multiple owners, an approval from _any_ of the code owners will be sufficient to meet this requirement. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)."
|
||||
- Optionally, to allow specific actors to push code to the branch without creating pull requests when they're required, select **Allow specified actors to bypass required pull requests**. Then, search for and select the actors who should be allowed to skip creating a pull request.
|
||||
- Optionally, if the repository is part of an organization, select **Restrict who can dismiss pull request reviews**. Then, in the search field, search for and select the actors who are allowed to dismiss pull request reviews. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/dismissing-a-pull-request-review)."
|
||||
* Optionally, to dismiss a pull request approval review when a code-modifying commit is pushed to the branch, select **Dismiss stale pull request approvals when new commits are pushed**.
|
||||
* Optionally, to require review from a code owner when the pull request affects code that has a designated owner, select **Require review from Code Owners**. Note that if code has multiple owners, an approval from _any_ of the code owners will be sufficient to meet this requirement. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)."
|
||||
* Optionally, to allow specific actors to push code to the branch without creating pull requests when they're required, select **Allow specified actors to bypass required pull requests**. Then, search for and select the actors who should be allowed to skip creating a pull request.
|
||||
* Optionally, if the repository is part of an organization, select **Restrict who can dismiss pull request reviews**. Then, in the search field, search for and select the actors who are allowed to dismiss pull request reviews. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/dismissing-a-pull-request-review)."
|
||||
{% ifversion last-pusher-require-approval %}
|
||||
- Optionally, to require someone other than the last person to push to a branch to approve a pull request prior to merging, select **Require approval of the most recent reviewable push**. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#require-pull-request-reviews-before-merging)."
|
||||
* Optionally, to require someone other than the last person to push to a branch to approve a pull request prior to merging, select **Require approval of the most recent reviewable push**. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#require-pull-request-reviews-before-merging)."
|
||||
{% endif %}
|
||||
1. Optionally, enable required status checks. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)."
|
||||
- Select **Require status checks to pass before merging**.
|
||||
- Optionally, to ensure that pull requests are tested with the latest code on the protected branch, select **Require branches to be up to date before merging**.
|
||||
- In the search field, search for status checks, selecting the checks you want to require.
|
||||
* Select **Require status checks to pass before merging**.
|
||||
* Optionally, to ensure that pull requests are tested with the latest code on the protected branch, select **Require branches to be up to date before merging**.
|
||||
* In the search field, search for status checks, selecting the checks you want to require.
|
||||
1. Optionally, select **Require conversation resolution before merging**.
|
||||
1. Optionally, select **Require signed commits**.
|
||||
1. Optionally, select **Require linear history**.
|
||||
|
|
@ -94,21 +94,21 @@ When you create a branch rule, the branch you specify doesn't have to exist yet
|
|||
{%- endif %}
|
||||
{% ifversion lock-branch %}
|
||||
1. Optionally, make the branch read-only.
|
||||
- Select **Lock branch**.
|
||||
- Optionally, to allow fork syncing, select **Allow fork syncing**.
|
||||
* Select **Lock branch**.
|
||||
* Optionally, to allow fork syncing, select **Allow fork syncing**.
|
||||
{%- endif %}
|
||||
1. Optionally, select {% ifversion bypass-branch-protections %}**Do not allow bypassing the above settings**{% else %}**Apply the rules above to administrators**{% endif %}.
|
||||
1. Optionally,{% ifversion fpt or ghec %} in public repositories owned by a {% data variables.product.prodname_free_user %} organization and in all repositories owned by an organization using {% data variables.product.prodname_team %} or {% data variables.product.prodname_ghe_cloud %},{% endif %} enable branch restrictions.
|
||||
- Select **Restrict who can push to matching branches**.
|
||||
* Select **Restrict who can push to matching branches**.
|
||||
{%- ifversion restrict-pushes-create-branch %}
|
||||
- Optionally, to also restrict the creation of matching branches, select **Restrict pushes that create matching branches**.
|
||||
* Optionally, to also restrict the creation of matching branches, select **Restrict pushes that create matching branches**.
|
||||
{%- endif %}
|
||||
- In the search field, search for and select the people, teams, or apps who will have permission to push to the protected branch or create a matching branch.
|
||||
* In the search field, search for and select the people, teams, or apps who will have permission to push to the protected branch or create a matching branch.
|
||||
1. Optionally, under "Rules applied to everyone including administrators", select **Allow force pushes**.
|
||||
|
||||
Then, choose who can force push to the branch.
|
||||
- Select **Everyone** to allow everyone with at least write permissions to the repository to force push to the branch, including those with admin permissions.
|
||||
- Select **Specify who can force push** to allow only specific actors to force push to the branch. Then, search for and select those actors.
|
||||
* Select **Everyone** to allow everyone with at least write permissions to the repository to force push to the branch, including those with admin permissions.
|
||||
* Select **Specify who can force push** to allow only specific actors to force push to the branch. Then, search for and select those actors.
|
||||
|
||||
For more information about force pushes, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#allow-force-pushes)."
|
||||
1. Optionally, select **Allow deletions**.
|
||||
|
|
|
|||
|
|
@ -60,10 +60,10 @@ Rulesets work alongside any branch protection rules and tag protection rules in
|
|||
|
||||
Rulesets have the following advantages over branch and tag protection rules.
|
||||
|
||||
- Unlike protection rules, multiple rulesets can apply at the same time, so you can be confident that every rule targeting a branch or tag in your repository will be evaluated when someone interacts with that branch or tag. For more information, see "[About rule layering](#about-rule-layering)."
|
||||
- Rulesets have statuses, so you can easily manage which rulesets are active in a repository without needing to delete rulesets.
|
||||
- Anyone with read access to a repository can view the active rulesets for the repository. This means a developer can understand why they have hit a rule, or an auditor can check the security constraints for the repository, without requiring admin access to the repository.
|
||||
- You can create additional rules to control the metadata of commits entering a repository, such as the commit message and the author's email address. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets#metadata-restrictions){% ifversion ghec %}."{% else %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% endif %}
|
||||
* Unlike protection rules, multiple rulesets can apply at the same time, so you can be confident that every rule targeting a branch or tag in your repository will be evaluated when someone interacts with that branch or tag. For more information, see "[About rule layering](#about-rule-layering)."
|
||||
* Rulesets have statuses, so you can easily manage which rulesets are active in a repository without needing to delete rulesets.
|
||||
* Anyone with read access to a repository can view the active rulesets for the repository. This means a developer can understand why they have hit a rule, or an auditor can check the security constraints for the repository, without requiring admin access to the repository.
|
||||
* You can create additional rules to control the metadata of commits entering a repository, such as the commit message and the author's email address. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets#metadata-restrictions){% ifversion ghec %}."{% else %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% endif %}
|
||||
|
||||
## Using ruleset enforcement statuses
|
||||
|
||||
|
|
@ -75,8 +75,8 @@ A ruleset does not have a priority. Instead, if multiple rulesets target the sam
|
|||
|
||||
For example, consider the following situation for the `my-feature` branch of the `octo-org/octo-repo` repository.
|
||||
|
||||
- An administrator of the repository has set up a ruleset targeting the `my-feature` branch. This ruleset requires signed commits, and three reviews on pull requests before they can be merged.
|
||||
- An existing branch protection rule for the `my-feature` branch requires a linear commit history, and two reviews on pull requests before they can be merged.{% ifversion repo-rules-enterprise %}
|
||||
- An administrator of the `octo-org` organization has also set up a ruleset targeting the `my-feature` branch of the `octo-repo` repository. The ruleset blocks force pushes, and requires one review on pull requests before they can be merged.{% endif %}
|
||||
* An administrator of the repository has set up a ruleset targeting the `my-feature` branch. This ruleset requires signed commits, and three reviews on pull requests before they can be merged.
|
||||
* An existing branch protection rule for the `my-feature` branch requires a linear commit history, and two reviews on pull requests before they can be merged.{% ifversion repo-rules-enterprise %}
|
||||
* An administrator of the `octo-org` organization has also set up a ruleset targeting the `my-feature` branch of the `octo-repo` repository. The ruleset blocks force pushes, and requires one review on pull requests before they can be merged.{% endif %}
|
||||
|
||||
The rules from each source are aggregated, and all rules apply. Where multiple different versions of the same rule exist, the result is that the most restrictive version of the rule applies. Therefore, the `my-feature` branch requires signed commits and a linear commit history{% ifversion repo-rules-enterprise %}, force pushes are blocked{% endif %}, and pull requests targeting the branch will require three reviews before they can be merged.
|
||||
|
|
|
|||
|
|
@ -45,8 +45,8 @@ Before you can require a linear commit history, your repository must allow squas
|
|||
## Require merge queue
|
||||
|
||||
> [!NOTE]
|
||||
> - Configuring a merge queue via rulesets is in public beta and subject to change.
|
||||
> - This rule is not available for rulesets created at the organization level. For more information about creating rulesets at the repository level, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/creating-rulesets-for-a-repository)."
|
||||
> * Configuring a merge queue via rulesets is in public beta and subject to change.
|
||||
> * This rule is not available for rulesets created at the organization level. For more information about creating rulesets at the repository level, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/creating-rulesets-for-a-repository)."
|
||||
|
||||
You can require that merges must be performed with a merge queue at the repository level. For more information about merge queues, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue#about-merge-queues)."
|
||||
|
||||
|
|
@ -54,16 +54,16 @@ You can require that merges must be performed with a merge queue at the reposito
|
|||
|
||||
You can configure various settings for your merge queue rule.
|
||||
|
||||
- **Merge method**: Method to use when merging changes from pull requests.
|
||||
- **Build concurrency**: Limit the number of queued pull requests requesting checks and workflow runs at the same time.
|
||||
- This setting controls when merge queue dispatches the `merge_group.checks_requested` webhook event, which triggers {% data variables.product.prodname_actions %} workflows that are configured to run on `merge_group`. For more information, see "[AUTOTITLE](/webhooks/webhook-events-and-payloads#merge_group)."
|
||||
- For example, if there are 5 pull requests added to the queue and the build concurrency setting is 3, merge queue will dispatch the `checks_requested` event for the first 3 pull requeusts. When it receives a result for one of those pull requests, merge queue will dispatch the event for the 4th pull request, and so on.
|
||||
- **Minimum/maximum group size**: The number of pull requests that will be merged together in a group.
|
||||
- **Wait time to meet minimum group size (minutes)**: The time the merge queue will wait after the first pull request is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.
|
||||
- **Require all queue entries to pass required checks**:
|
||||
- When this setting is enabled, each item in the merge group must pass all required checks.
|
||||
- When this setting is disabled, only the commit at the head of the merge group, i.e. the commit containing changes from all of the pull requests in the group, must pass its required checks to merge.
|
||||
- **Status check timeout (minutes)**: Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed
|
||||
* **Merge method**: Method to use when merging changes from pull requests.
|
||||
* **Build concurrency**: Limit the number of queued pull requests requesting checks and workflow runs at the same time.
|
||||
* This setting controls when merge queue dispatches the `merge_group.checks_requested` webhook event, which triggers {% data variables.product.prodname_actions %} workflows that are configured to run on `merge_group`. For more information, see "[AUTOTITLE](/webhooks/webhook-events-and-payloads#merge_group)."
|
||||
* For example, if there are 5 pull requests added to the queue and the build concurrency setting is 3, merge queue will dispatch the `checks_requested` event for the first 3 pull requeusts. When it receives a result for one of those pull requests, merge queue will dispatch the event for the 4th pull request, and so on.
|
||||
* **Minimum/maximum group size**: The number of pull requests that will be merged together in a group.
|
||||
* **Wait time to meet minimum group size (minutes)**: The time the merge queue will wait after the first pull request is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.
|
||||
* **Require all queue entries to pass required checks**:
|
||||
* When this setting is enabled, each item in the merge group must pass all required checks.
|
||||
* When this setting is disabled, only the commit at the head of the merge group, i.e. the commit containing changes from all of the pull requests in the group, must pass its required checks to merge.
|
||||
* **Status check timeout (minutes)**: Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed
|
||||
|
||||
{% endif %}
|
||||
|
||||
|
|
@ -88,8 +88,8 @@ With both methods, we use the `verified_signature?` to confirm if a commit has a
|
|||
{% ifversion fpt or ghec %}
|
||||
|
||||
> [!NOTE]
|
||||
> - If you have enabled vigilant mode in your account settings, which indicates that your commits will always be signed, any commits that {% data variables.product.prodname_dotcom %} identifies as "Partially verified" are permitted on branches that require signed commits. For more information about vigilant mode, see "[AUTOTITLE](/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits)."
|
||||
> - If a collaborator pushes an unsigned commit to a branch that requires commit signatures, the collaborator will need to rebase the commit to include a verified signature, then force push the rewritten commit to the branch.
|
||||
> * If you have enabled vigilant mode in your account settings, which indicates that your commits will always be signed, any commits that {% data variables.product.prodname_dotcom %} identifies as "Partially verified" are permitted on branches that require signed commits. For more information about vigilant mode, see "[AUTOTITLE](/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits)."
|
||||
> * If a collaborator pushes an unsigned commit to a branch that requires commit signatures, the collaborator will need to rebase the commit to include a verified signature, then force push the rewritten commit to the branch.
|
||||
|
||||
{% else %}
|
||||
|
||||
|
|
|
|||
|
|
@ -50,9 +50,9 @@ Verify that your ruleset workflow does not target all branches in the repository
|
|||
### Supported directory
|
||||
|
||||
Verify that your workflow file exists in the `.github/workflows` directory. If you want to run a ruleset workflow on `pull_request` events in a repository that is not the source repository, you can take any of the following actions:
|
||||
- Add a conditional to the workflow file such as, `if: {{ github.repository != 'my-org/source-repo' }}`. For more information, see "[AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idif)."
|
||||
- Disable Actions completely in the source repository. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#managing-github-actions-permissions-for-your-repository).
|
||||
- Disable the individual workflow in the source repository. For more information, see "[AUTOTITLE](/actions/using-workflows/disabling-and-enabling-a-workflow).
|
||||
* Add a conditional to the workflow file such as, `if: {{ github.repository != 'my-org/source-repo' }}`. For more information, see "[AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idif)."
|
||||
* Disable Actions completely in the source repository. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#managing-github-actions-permissions-for-your-repository).
|
||||
* Disable the individual workflow in the source repository. For more information, see "[AUTOTITLE](/actions/using-workflows/disabling-and-enabling-a-workflow).
|
||||
|
||||
### Using the `merge_group` trigger
|
||||
|
||||
|
|
|
|||
|
|
@ -52,10 +52,10 @@ In either case, access to repositories is managed by permissions. For more infor
|
|||
## About collaboration
|
||||
|
||||
You can use repositories to manage your work and collaborate with others.
|
||||
- You can use issues to collect user feedback, report software bugs, and organize tasks you'd like to accomplish. For more information, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/about-issues)."{% ifversion fpt or ghec %}
|
||||
- {% data reusables.discussions.you-can-use-discussions %}{% endif %}
|
||||
- You can use pull requests to propose changes to a repository. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)."
|
||||
- You can use {% data variables.product.prodname_projects_v2 %} to organize and prioritize your issues and pull requests. For more information, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)."
|
||||
* You can use issues to collect user feedback, report software bugs, and organize tasks you'd like to accomplish. For more information, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/about-issues)."{% ifversion fpt or ghec %}
|
||||
* {% data reusables.discussions.you-can-use-discussions %}{% endif %}
|
||||
* You can use pull requests to propose changes to a repository. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)."
|
||||
* You can use {% data variables.product.prodname_projects_v2 %} to organize and prioritize your issues and pull requests. For more information, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)."
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
With {% data variables.product.prodname_free_team %} for personal accounts and organizations, you can work with unlimited collaborators on unlimited public repositories with a full feature set, or unlimited private repositories with a limited feature set. To get advanced tooling for private repositories, you can upgrade to {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, or {% data variables.product.prodname_ghe_cloud %}. {% data reusables.gated-features.more-info %}
|
||||
|
|
@ -70,14 +70,14 @@ You can restrict who has access to a repository by choosing a repository's visib
|
|||
When you create a repository, you can choose to make the repository public or private.{% ifversion ghec or ghes %} If you're creating the repository in an organization{% ifversion ghec %} that is owned by an enterprise account{% endif %}, you can also choose to make the repository internal.{% endif %}{% ifversion fpt %} Repositories in organizations that use {% data variables.product.prodname_ghe_cloud %} and are owned by an enterprise account can also be created with internal visibility. For more information, see [the {% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/repositories/creating-and-managing-repositories/about-repositories).{% endif %}
|
||||
|
||||
{%- ifversion fpt or ghec %}
|
||||
- {% ifversion ghec %}If your account is not a {% data variables.enterprise.prodname_managed_user %}, you can create public repositories. {% endif %}Public repositories are accessible to everyone on the internet.
|
||||
- Private repositories are only accessible to you, people you explicitly share access with, and, for organization repositories, certain organization members.
|
||||
* {% ifversion ghec %}If your account is not a {% data variables.enterprise.prodname_managed_user %}, you can create public repositories. {% endif %}Public repositories are accessible to everyone on the internet.
|
||||
* Private repositories are only accessible to you, people you explicitly share access with, and, for organization repositories, certain organization members.
|
||||
{%- elsif ghes %}
|
||||
- If {% data variables.location.product_location %} is not in private mode or behind a firewall, public repositories are accessible to everyone on the internet. Otherwise, public repositories are available to everyone using {% data variables.location.product_location %}, including outside collaborators.
|
||||
- Private repositories are only accessible to you, people you explicitly share access with, and, for organization repositories, certain organization members.
|
||||
* If {% data variables.location.product_location %} is not in private mode or behind a firewall, public repositories are accessible to everyone on the internet. Otherwise, public repositories are available to everyone using {% data variables.location.product_location %}, including outside collaborators.
|
||||
* Private repositories are only accessible to you, people you explicitly share access with, and, for organization repositories, certain organization members.
|
||||
{%- endif %}
|
||||
{%- ifversion ghec or ghes %}
|
||||
- Internal repositories are accessible to all enterprise members. For more information, see "[About internal repositories](#about-internal-repositories)."
|
||||
* Internal repositories are accessible to all enterprise members. For more information, see "[About internal repositories](#about-internal-repositories)."
|
||||
{%- endif %}
|
||||
|
||||
Organization owners always have access to every repository created in an organization. For more information, see "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization)."
|
||||
|
|
@ -118,7 +118,7 @@ By default, enterprise members can fork an internal repository into any organiza
|
|||
|
||||
Here are some helpful resources for taking your next steps with repositories.
|
||||
|
||||
- "[AUTOTITLE](/repositories/creating-and-managing-repositories/best-practices-for-repositories):" Learn how to use repositories most effectively.
|
||||
- "[AUTOTITLE](/repositories/creating-and-managing-repositories/creating-a-new-repository):" Create a new repository.
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository):" Learn how to create and delete branches within your repository.
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request):" Create a pull request to propose and collaborate on changes to a repository.
|
||||
* "[AUTOTITLE](/repositories/creating-and-managing-repositories/best-practices-for-repositories):" Learn how to use repositories most effectively.
|
||||
* "[AUTOTITLE](/repositories/creating-and-managing-repositories/creating-a-new-repository):" Create a new repository.
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository):" Learn how to create and delete branches within your repository.
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request):" Create a pull request to propose and collaborate on changes to a repository.
|
||||
|
|
|
|||
|
|
@ -102,13 +102,13 @@ When cloning a repository it's possible that you might encounter some errors.
|
|||
|
||||
If you're unable to clone a repository, check that:
|
||||
|
||||
- You can connect using HTTPS. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors)."
|
||||
- You have permission to access the repository you want to clone. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors)."
|
||||
- The default branch you want to clone still exists. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors#error-remote-head-refers-to-nonexistent-ref-unable-to-checkout)."
|
||||
* You can connect using HTTPS. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors)."
|
||||
* You have permission to access the repository you want to clone. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors)."
|
||||
* The default branch you want to clone still exists. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors#error-remote-head-refers-to-nonexistent-ref-unable-to-checkout)."
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/get-started/using-github/troubleshooting-connectivity-problems)"
|
||||
* "[AUTOTITLE](/get-started/using-github/troubleshooting-connectivity-problems)"
|
||||
{% endif %}
|
||||
|
|
|
|||
|
|
@ -43,9 +43,9 @@ topics:
|
|||
{% data reusables.repositories.repo-name %}
|
||||
{% data reusables.repositories.choose-repo-visibility %}
|
||||
1. If you're not using a template, there are a number of optional items you can pre-populate your repository with. If you're importing an existing repository to {% data variables.product.product_name %}, don't choose any of these options, as you may introduce a merge conflict. You can add or create new files using the user interface or choose to add new files using the command line later. For more information, see "[AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-an-external-git-repository-using-the-command-line)," "[AUTOTITLE](/repositories/working-with-files/managing-files/adding-a-file-to-a-repository#adding-a-file-to-a-repository-using-the-command-line)," and "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts)."
|
||||
- You can create a README, which is a document describing your project. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes)."
|
||||
- You can create a _.gitignore_ file, which is a set of ignore rules. For more information, see "[AUTOTITLE](/get-started/getting-started-with-git/ignoring-files)."{% ifversion fpt or ghec %}
|
||||
- You can choose to add a software license for your project. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)."{% endif %}
|
||||
* You can create a README, which is a document describing your project. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes)."
|
||||
* You can create a _.gitignore_ file, which is a set of ignore rules. For more information, see "[AUTOTITLE](/get-started/getting-started-with-git/ignoring-files)."{% ifversion fpt or ghec %}
|
||||
* You can choose to add a software license for your project. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)."{% endif %}
|
||||
{% data reusables.repositories.select-marketplace-apps %}
|
||||
{% data reusables.repositories.create-repo %}
|
||||
{% ifversion fpt or ghec %}
|
||||
|
|
@ -75,6 +75,6 @@ Query parameter | Example | Valid values
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories)"
|
||||
- [Open Source Guides](https://opensource.guide/){% ifversion fpt or ghec %}
|
||||
- [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}){% endif %}
|
||||
* "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories)"
|
||||
* [Open Source Guides](https://opensource.guide/){% ifversion fpt or ghec %}
|
||||
* [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}){% endif %}
|
||||
|
|
|
|||
|
|
@ -27,9 +27,9 @@ shortTitle: Create from a template
|
|||
You can choose to include the directory structure and files from only the default branch of the template repository or to include all branches. Branches created from a template have unrelated histories, which means you cannot create pull requests or merge between the branches.
|
||||
|
||||
Creating a repository from a template is similar to forking a repository, but there are important differences:
|
||||
- A new fork includes the entire commit history of the parent repository, while a repository created from a template starts with a single commit.
|
||||
- Commits to a fork don't appear in your contributions graph, while commits to a repository created from a template do appear in your contribution graph.
|
||||
- A fork can be a temporary way to contribute code to an existing project, while creating a repository from a template starts a new project quickly.
|
||||
* A new fork includes the entire commit history of the parent repository, while a repository created from a template starts with a single commit.
|
||||
* Commits to a fork don't appear in your contributions graph, while commits to a repository created from a template do appear in your contribution graph.
|
||||
* A fork can be a temporary way to contribute code to an existing project, while creating a repository from a template starts a new project quickly.
|
||||
|
||||
For more information about forks, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)."
|
||||
|
||||
|
|
|
|||
|
|
@ -22,8 +22,8 @@ Deleting a public repository will not delete any forks of the repository.
|
|||
|
||||
**Warnings**:
|
||||
|
||||
- Deleting a repository will **permanently** delete release attachments and team permissions. This action **cannot** be undone.
|
||||
- Deleting a private{% ifversion ghes or ghec %} or internal{% endif %} repository will delete all forks of the repository.
|
||||
* Deleting a repository will **permanently** delete release attachments and team permissions. This action **cannot** be undone.
|
||||
* Deleting a private{% ifversion ghes or ghec %} or internal{% endif %} repository will delete all forks of the repository.
|
||||
|
||||
{% endwarning %}
|
||||
|
||||
|
|
|
|||
|
|
@ -119,7 +119,7 @@ If you want to mirror a repository in another location, including getting update
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/desktop/making-changes-in-a-branch/pushing-changes-to-github-from-github-desktop#pushing-changes-to-github)"
|
||||
- "[AUTOTITLE](/desktop/configuring-and-customizing-github-desktop/about-git-large-file-storage-and-github-desktop)"
|
||||
* "[AUTOTITLE](/desktop/making-changes-in-a-branch/pushing-changes-to-github-from-github-desktop#pushing-changes-to-github)"
|
||||
* "[AUTOTITLE](/desktop/configuring-and-customizing-github-desktop/about-git-large-file-storage-and-github-desktop)"
|
||||
|
||||
{% endif %}
|
||||
|
|
|
|||
|
|
@ -118,12 +118,12 @@ You have now created a repository, including a _README_ file, and created your f
|
|||
|
||||
{% webui %}
|
||||
|
||||
- You can now clone a {% data variables.product.prodname_dotcom %} repository to create a local copy on your computer. From your local repository you can commit, and create a pull request to update the changes in the upstream repository. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/cloning-a-repository)" and "[AUTOTITLE](/get-started/getting-started-with-git/set-up-git)."
|
||||
* You can now clone a {% data variables.product.prodname_dotcom %} repository to create a local copy on your computer. From your local repository you can commit, and create a pull request to update the changes in the upstream repository. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/cloning-a-repository)" and "[AUTOTITLE](/get-started/getting-started-with-git/set-up-git)."
|
||||
|
||||
{% endwebui %}
|
||||
|
||||
- You can find interesting projects and repositories on {% data variables.product.prodname_dotcom %} and make changes to them by creating a fork of the repository. {% data reusables.getting-started.fork-a-repository %}
|
||||
* You can find interesting projects and repositories on {% data variables.product.prodname_dotcom %} and make changes to them by creating a fork of the repository. {% data reusables.getting-started.fork-a-repository %}
|
||||
|
||||
- {% data reusables.getting-started.being-social %}
|
||||
* {% data reusables.getting-started.being-social %}
|
||||
|
||||
- {% data reusables.support.connect-in-the-forum-bootcamp %}
|
||||
* {% data reusables.support.connect-in-the-forum-bootcamp %}
|
||||
|
|
|
|||
|
|
@ -14,10 +14,10 @@ topics:
|
|||
---
|
||||
When you rename a repository, all existing information, with the exception of project site URLs, is automatically redirected to the new name, including:
|
||||
|
||||
- Issues
|
||||
- Wikis
|
||||
- Stars
|
||||
- Followers
|
||||
* Issues
|
||||
* Wikis
|
||||
* Stars
|
||||
* Followers
|
||||
|
||||
For more information on project sites, see "[AUTOTITLE](/pages/getting-started-with-github-pages/about-github-pages#types-of-github-pages-sites)."
|
||||
|
||||
|
|
|
|||
|
|
@ -21,10 +21,10 @@ Most of the limits below affect both {% data variables.product.product_name %} a
|
|||
|
||||
Because diffs can become very large, we impose these limits on diffs for commits, pull requests, and compare views:
|
||||
|
||||
- In a pull request, no total diff may exceed _20,000 lines that you can load_ or _1 MB_ of raw diff data.
|
||||
- No single file's diff may exceed _20,000 lines that you can load_ or _500 KB_ of raw diff data. _Four hundred lines_ and _20 KB_ are automatically loaded for a single file.
|
||||
- The maximum number of files in a single diff is limited to _300_.
|
||||
- The maximum number of renderable files (such as images, PDFs, and GeoJSON files) in a single diff is limited to _25_.
|
||||
* In a pull request, no total diff may exceed _20,000 lines that you can load_ or _1 MB_ of raw diff data.
|
||||
* No single file's diff may exceed _20,000 lines that you can load_ or _500 KB_ of raw diff data. _Four hundred lines_ and _20 KB_ are automatically loaded for a single file.
|
||||
* The maximum number of files in a single diff is limited to _300_.
|
||||
* The maximum number of renderable files (such as images, PDFs, and GeoJSON files) in a single diff is limited to _25_.
|
||||
|
||||
Some portions of a limited diff may be displayed, but anything exceeding the limit is not shown.
|
||||
|
||||
|
|
|
|||
|
|
@ -56,6 +56,6 @@ Restoring a repository will not restore release attachments or team permissions.
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/repositories/creating-and-managing-repositories/deleting-a-repository)"
|
||||
* "[AUTOTITLE](/repositories/creating-and-managing-repositories/deleting-a-repository)"
|
||||
|
||||
{% endif %}
|
||||
|
|
|
|||
|
|
@ -26,13 +26,13 @@ topics:
|
|||
When you transfer a repository to a new owner, they can immediately administer the repository's contents, issues, pull requests, releases, {% data variables.product.prodname_projects_v1 %}, and settings. {% ifversion rename-and-transfer-repository %}You can also change the repository name while transferring a repository. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/renaming-a-repository)."{% endif %}
|
||||
|
||||
Prerequisites for repository transfers:
|
||||
- When you transfer a repository that you own to another personal account, the new owner will receive a confirmation email.{% ifversion fpt or ghec %} The confirmation email includes instructions for accepting the transfer. If the new owner doesn't accept the transfer within one day, the invitation will expire.{% endif %}
|
||||
- To transfer a repository that you own to an organization, you must have permission to create a repository in the target organization.
|
||||
- The target account must not have a repository with the same name, or a fork in the same network.
|
||||
- The original owner of the repository is added as a collaborator on the transferred repository. Other collaborators to the transferred repository remain intact.
|
||||
- Single repositories forked from a private upstream network cannot be transferred.
|
||||
* When you transfer a repository that you own to another personal account, the new owner will receive a confirmation email.{% ifversion fpt or ghec %} The confirmation email includes instructions for accepting the transfer. If the new owner doesn't accept the transfer within one day, the invitation will expire.{% endif %}
|
||||
* To transfer a repository that you own to an organization, you must have permission to create a repository in the target organization.
|
||||
* The target account must not have a repository with the same name, or a fork in the same network.
|
||||
* The original owner of the repository is added as a collaborator on the transferred repository. Other collaborators to the transferred repository remain intact.
|
||||
* Single repositories forked from a private upstream network cannot be transferred.
|
||||
{%- ifversion ghec %}
|
||||
- Internal repositories can only be transferred to an organization in the enterprise. You cannot transfer an internal repository from an organization owned by one enterprise account to an organization owned by a different enterprise account.
|
||||
* Internal repositories can only be transferred to an organization in the enterprise. You cannot transfer an internal repository from an organization owned by one enterprise account to an organization owned by a different enterprise account.
|
||||
{%- endif %}
|
||||
|
||||
{% ifversion fpt or ghec %}If you transfer a private repository to a {% data variables.product.prodname_free_user %} user or organization account, the repository will lose access to features like protected branches and {% data variables.product.prodname_pages %}. {% data reusables.gated-features.more-info %}
|
||||
|
|
@ -43,12 +43,12 @@ If the transferred repository contains an action listed on {% data variables.pro
|
|||
|
||||
When you transfer a repository, its issues, pull requests, wiki, stars, and watchers are also transferred. If the transferred repository contains webhooks, services, secrets, or deploy keys, they will remain associated after the transfer is complete. Git information about commits, including contributions, is preserved. In addition:
|
||||
|
||||
- If the transferred repository is a fork, then it remains associated with the upstream repository.
|
||||
- If the transferred repository has any forks, then those forks will remain associated with the repository after the transfer is complete.
|
||||
- If the transferred repository uses {% data variables.large_files.product_name_long %}, all {% data variables.large_files.product_name_short %} objects are automatically moved. This transfer occurs in the background, so if you have a large number of {% data variables.large_files.product_name_short %} objects or if the {% data variables.large_files.product_name_short %} objects themselves are large, it may take some time for the transfer to occur.{% ifversion fpt or ghec %} Before you transfer a repository that uses {% data variables.large_files.product_name_short %}, make sure the receiving account has enough data packs to store the {% data variables.large_files.product_name_short %} objects you'll be moving over. For more information on adding storage for personal accounts, see "[AUTOTITLE](/billing/managing-billing-for-git-large-file-storage/upgrading-git-large-file-storage)."{% endif %}
|
||||
- When a repository is transferred between two personal accounts, issue assignments are left intact. When you transfer a repository from a personal account to an organization, issues assigned to members in the organization remain intact, and all other issue assignees are cleared. Only owners in the organization are allowed to create new issue assignments. When you transfer a repository from an organization to a personal account, only issues assigned to the repository's owner are kept, and all other issue assignees are removed.
|
||||
- If the transferred repository contains a {% data variables.product.prodname_pages %} site, then links to the Git repository on the Web and through Git activity are redirected. However, we don't redirect {% data variables.product.prodname_pages %} associated with the repository.
|
||||
- All links to the previous repository location are automatically redirected to the new location. When you use `git clone`, `git fetch`, or `git push` on a transferred repository, these commands will redirect to the new repository location or URL. However, to avoid confusion, we strongly recommend updating any existing local clones to point to the new repository URL. You can do this by using `git remote` on the command line:
|
||||
* If the transferred repository is a fork, then it remains associated with the upstream repository.
|
||||
* If the transferred repository has any forks, then those forks will remain associated with the repository after the transfer is complete.
|
||||
* If the transferred repository uses {% data variables.large_files.product_name_long %}, all {% data variables.large_files.product_name_short %} objects are automatically moved. This transfer occurs in the background, so if you have a large number of {% data variables.large_files.product_name_short %} objects or if the {% data variables.large_files.product_name_short %} objects themselves are large, it may take some time for the transfer to occur.{% ifversion fpt or ghec %} Before you transfer a repository that uses {% data variables.large_files.product_name_short %}, make sure the receiving account has enough data packs to store the {% data variables.large_files.product_name_short %} objects you'll be moving over. For more information on adding storage for personal accounts, see "[AUTOTITLE](/billing/managing-billing-for-git-large-file-storage/upgrading-git-large-file-storage)."{% endif %}
|
||||
* When a repository is transferred between two personal accounts, issue assignments are left intact. When you transfer a repository from a personal account to an organization, issues assigned to members in the organization remain intact, and all other issue assignees are cleared. Only owners in the organization are allowed to create new issue assignments. When you transfer a repository from an organization to a personal account, only issues assigned to the repository's owner are kept, and all other issue assignees are removed.
|
||||
* If the transferred repository contains a {% data variables.product.prodname_pages %} site, then links to the Git repository on the Web and through Git activity are redirected. However, we don't redirect {% data variables.product.prodname_pages %} associated with the repository.
|
||||
* All links to the previous repository location are automatically redirected to the new location. When you use `git clone`, `git fetch`, or `git push` on a transferred repository, these commands will redirect to the new repository location or URL. However, to avoid confusion, we strongly recommend updating any existing local clones to point to the new repository URL. You can do this by using `git remote` on the command line:
|
||||
|
||||
```shell
|
||||
git remote set-url origin NEW_URL
|
||||
|
|
@ -59,9 +59,9 @@ When you transfer a repository, its issues, pull requests, wiki, stars, and watc
|
|||
**Warning**: If you create a new repository or fork at the previous repository location, the redirects to the transferred repository will be deactivated. They can be reactivated by renaming or deleting the new repository or fork.
|
||||
|
||||
{% endwarning %}
|
||||
- When you transfer a repository from an organization to a personal account, the repository's read-only collaborators will not be transferred. This is because collaborators can't have read-only access to repositories owned by a personal account. For more information about repository permission levels, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/permission-levels-for-a-personal-account-repository)" and "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization)."{% ifversion fpt or ghec %}
|
||||
- Sponsors who have access to the repository through a sponsorship tier may be affected. For more information, see "[AUTOTITLE](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers#adding-a-repository-to-a-sponsorship-tier)".{% endif %}
|
||||
- Packages associated with the repository {% ifversion packages-registries-v2 %}may be transferred, or may lose their link to the repository, depending on the registry they belong to{% else %}are transferred as part of the transfer process{% endif %}. For more information, see "[AUTOTITLE](/packages/learn-github-packages/about-permissions-for-github-packages#about-repository-transfers)."
|
||||
* When you transfer a repository from an organization to a personal account, the repository's read-only collaborators will not be transferred. This is because collaborators can't have read-only access to repositories owned by a personal account. For more information about repository permission levels, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/permission-levels-for-a-personal-account-repository)" and "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization)."{% ifversion fpt or ghec %}
|
||||
* Sponsors who have access to the repository through a sponsorship tier may be affected. For more information, see "[AUTOTITLE](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers#adding-a-repository-to-a-sponsorship-tier)".{% endif %}
|
||||
* Packages associated with the repository {% ifversion packages-registries-v2 %}may be transferred, or may lose their link to the repository, depending on the registry they belong to{% else %}are transferred as part of the transfer process{% endif %}. For more information, see "[AUTOTITLE](/packages/learn-github-packages/about-permissions-for-github-packages#about-repository-transfers)."
|
||||
|
||||
For more information, see "[AUTOTITLE](/get-started/getting-started-with-git/managing-remote-repositories)."
|
||||
|
||||
|
|
|
|||
|
|
@ -110,9 +110,9 @@ If you are trying to clone a private repository but do not have permission to vi
|
|||
|
||||
Make sure that you have access to the repository in one of these ways:
|
||||
|
||||
- The owner of the repository
|
||||
- A [collaborator](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository) on the repository
|
||||
- A [member of a team](/organizations/organizing-members-into-teams/adding-organization-members-to-a-team) that has access to the repository (if the repository belongs to an organization)
|
||||
* The owner of the repository
|
||||
* A [collaborator](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository) on the repository
|
||||
* A [member of a team](/organizations/organizing-members-into-teams/adding-organization-members-to-a-team) that has access to the repository (if the repository belongs to an organization)
|
||||
|
||||
### Check your SSH access
|
||||
|
||||
|
|
|
|||
|
|
@ -58,9 +58,9 @@ To reduce the size of your CODEOWNERS file, consider using wildcard patterns to
|
|||
{% warning %}
|
||||
|
||||
**Warning:** There are some syntax rules for gitignore files that _do not work_ in CODEOWNERS files:
|
||||
- Escaping a pattern starting with `#` using `\` so it is treated as a pattern and not a comment
|
||||
- Using `!` to negate a pattern
|
||||
- Using `[ ]` to define a character range
|
||||
* Escaping a pattern starting with `#` using `\` so it is treated as a pattern and not a comment
|
||||
* Using `!` to negate a pattern
|
||||
* Using `[ ]` to define a character range
|
||||
|
||||
{% endwarning %}
|
||||
|
||||
|
|
@ -174,8 +174,8 @@ To protect a repository fully against unauthorized changes, you also need to def
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/repositories/working-with-files/managing-files/creating-new-files)"
|
||||
- "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository)"
|
||||
- "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-an-individuals-access-to-an-organization-repository)"
|
||||
- "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-team-access-to-an-organization-repository)"
|
||||
- "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/viewing-a-pull-request-review)"
|
||||
* "[AUTOTITLE](/repositories/working-with-files/managing-files/creating-new-files)"
|
||||
* "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository)"
|
||||
* "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-an-individuals-access-to-an-organization-repository)"
|
||||
* "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-team-access-to-an-organization-repository)"
|
||||
* "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/viewing-a-pull-request-review)"
|
||||
|
|
|
|||
|
|
@ -21,11 +21,11 @@ topics:
|
|||
For more information about providing guidelines for your project, see {% ifversion fpt or ghec %}"[AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)" and {% endif %}"[AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions)."
|
||||
|
||||
A README is often the first item a visitor will see when visiting your repository. README files typically include information on:
|
||||
- What the project does
|
||||
- Why the project is useful
|
||||
- How users can get started with the project
|
||||
- Where users can get help with your project
|
||||
- Who maintains and contributes to the project
|
||||
* What the project does
|
||||
* Why the project is useful
|
||||
* How users can get started with the project
|
||||
* Where users can get help with your project
|
||||
* Who maintains and contributes to the project
|
||||
|
||||
If you put your README file in your repository's hidden `.github`, root, or `docs` directory, {% data variables.product.product_name %} will recognize and automatically surface your README to repository visitors.
|
||||
|
||||
|
|
@ -53,8 +53,8 @@ A README should contain only the necessary information for developers to get sta
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/repositories/working-with-files/managing-files/adding-a-file-to-a-repository)"
|
||||
- "[5 tips for making your {% data variables.product.company_short %} profile page accessible](https://github.blog/2023-10-26-5-tips-for-making-your-github-profile-page-accessible/)" in the {% data variables.product.company_short %} blog
|
||||
* "[AUTOTITLE](/repositories/working-with-files/managing-files/adding-a-file-to-a-repository)"
|
||||
* "[5 tips for making your {% data variables.product.company_short %} profile page accessible](https://github.blog/2023-10-26-5-tips-for-making-your-github-profile-page-accessible/)" in the {% data variables.product.company_short %} blog
|
||||
{%- ifversion fpt or ghec %}
|
||||
- "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/setting-up-your-repository/adding-a-codespaces-badge)"
|
||||
* "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/setting-up-your-repository/adding-a-codespaces-badge)"
|
||||
{%- endif %}
|
||||
|
|
|
|||
|
|
@ -32,9 +32,9 @@ Repository admins can add any topics they'd like to a repository. Helpful topics
|
|||
You can search for repositories that are associated with a particular topic. For more information, see "[AUTOTITLE](/search-github/searching-on-github/searching-for-repositories#search-by-topic)." You can also search for a list of topics on {% data variables.product.product_name %}. For more information, see "[AUTOTITLE](/search-github/searching-on-github/searching-topics)."
|
||||
|
||||
When creating a topic:
|
||||
- use lowercase letters, numbers, and hyphens.
|
||||
- use 50 characters or less.
|
||||
- add no more than 20 topics.
|
||||
* use lowercase letters, numbers, and hyphens.
|
||||
* use 50 characters or less.
|
||||
* add no more than 20 topics.
|
||||
|
||||
## Adding topics to your repository
|
||||
|
||||
|
|
|
|||
|
|
@ -28,8 +28,8 @@ Until you add an image, repository links expand to show basic information about
|
|||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
1. Under "Social preview", click **Edit**.
|
||||
- To add a new image, click **Upload an image...**.
|
||||
- To remove an image, click **Remove image**.
|
||||
* To add a new image, click **Upload an image...**.
|
||||
* To remove an image, click **Remove image**.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -82,5 +82,5 @@ Anyone with admin permissions can enable a sponsor button in a repository.
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors)"
|
||||
- "[FAQ with the {% data variables.product.prodname_sponsors %} team](https://github.blog/2019-06-12-faq-with-the-github-sponsors-team/)" on {% data variables.product.prodname_blog %}
|
||||
* "[AUTOTITLE](/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors)"
|
||||
* "[FAQ with the {% data variables.product.prodname_sponsors %} team](https://github.blog/2019-06-12-faq-with-the-github-sponsors-team/)" on {% data variables.product.prodname_blog %}
|
||||
|
|
|
|||
|
|
@ -100,5 +100,5 @@ The goal of GitHub's open source licensing efforts is to provide a starting poin
|
|||
|
||||
## Further reading
|
||||
|
||||
- The Open Source Guides' section "[The Legal Side of Open Source](https://opensource.guide/legal/)"{% ifversion fpt or ghec %}
|
||||
- [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}){% endif %}
|
||||
* The Open Source Guides' section "[The Legal Side of Open Source](https://opensource.guide/legal/)"{% ifversion fpt or ghec %}
|
||||
* [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}){% endif %}
|
||||
|
|
|
|||
|
|
@ -21,5 +21,5 @@ You can also use organization discussions to facilitate conversations that span
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/discussions/collaborating-with-your-community-using-discussions/about-discussions)"
|
||||
- "[AUTOTITLE](/discussions/managing-discussions-for-your-community)"
|
||||
* "[AUTOTITLE](/discussions/collaborating-with-your-community-using-discussions/about-discussions)"
|
||||
* "[AUTOTITLE](/discussions/managing-discussions-for-your-community)"
|
||||
|
|
|
|||
|
|
@ -131,9 +131,9 @@ You can use the steps below to configure whether {% ifversion internal-actions%}
|
|||
{% data reusables.repositories.settings-sidebar-actions-general %}
|
||||
1. Under **Access**, choose one of the access settings:
|
||||
|
||||
- **Not accessible** - Workflows in other repositories cannot access this repository.
|
||||
- **Accessible from repositories in the 'ORGANIZATION NAME' organization** - {% ifversion ghes or ghec %}Workflows in other repositories that are part of the 'ORGANIZATION NAME' organization can access the actions and reusable workflows in this repository. Access is allowed only from private or internal repositories.{% else %}Workflows in other repositories can use workflows in this repository if they are part of the same organization and their visibility is private or internal.{% endif %}
|
||||
- **Accessible from repositories in the 'ENTERPRISE NAME' enterprise** - {% ifversion ghes or ghec %}Workflows in other repositories that are part of the 'ENTERPRISE NAME' enterprise can access the actions and reusable workflows in this repository. Access is allowed only from private or internal repositories.{% else %}Workflows in other repositories can use workflows in this repository if they are part of the same enterprise and their visibility is private or internal.{% endif %}
|
||||
* **Not accessible** - Workflows in other repositories cannot access this repository.
|
||||
* **Accessible from repositories in the 'ORGANIZATION NAME' organization** - {% ifversion ghes or ghec %}Workflows in other repositories that are part of the 'ORGANIZATION NAME' organization can access the actions and reusable workflows in this repository. Access is allowed only from private or internal repositories.{% else %}Workflows in other repositories can use workflows in this repository if they are part of the same organization and their visibility is private or internal.{% endif %}
|
||||
* **Accessible from repositories in the 'ENTERPRISE NAME' enterprise** - {% ifversion ghes or ghec %}Workflows in other repositories that are part of the 'ENTERPRISE NAME' enterprise can access the actions and reusable workflows in this repository. Access is allowed only from private or internal repositories.{% else %}Workflows in other repositories can use workflows in this repository if they are part of the same enterprise and their visibility is private or internal.{% endif %}
|
||||
1. Click **Save** to apply the settings.
|
||||
{% endif %}
|
||||
|
||||
|
|
@ -154,8 +154,8 @@ You can use the steps below to configure whether actions and reusable workflows
|
|||
{% data reusables.repositories.settings-sidebar-actions-general %}
|
||||
1. Under **Access**, choose one of the access settings:
|
||||
|
||||
- **Not accessible** - Workflows in other repositories cannot access this repository.
|
||||
- **Accessible from repositories owned by 'USER NAME' user** - Workflows in other repositories that are owned by the same user can access the actions and reusable workflows in this repository. Access is allowed only from private repositories.
|
||||
* **Not accessible** - Workflows in other repositories cannot access this repository.
|
||||
* **Accessible from repositories owned by 'USER NAME' user** - Workflows in other repositories that are owned by the same user can access the actions and reusable workflows in this repository. Access is allowed only from private repositories.
|
||||
1. Click **Save** to apply the settings.
|
||||
|
||||
{% endif %}
|
||||
|
|
@ -169,8 +169,8 @@ You can use the steps below to configure whether actions and reusable workflows
|
|||
{% data reusables.repositories.settings-sidebar-actions-general %}
|
||||
1. Under **Access**, choose one of the access settings:
|
||||
|
||||
- **Not accessible** - Workflows in other repositories cannot access this repository.
|
||||
- **Accessible from repositories in the 'ORGANIZATION NAME' organization** - Workflows in other repositories that are part of the 'ORGANIZATION NAME' organization can access the actions and reusable workflows in this repository. Access is allowed only from private repositories.
|
||||
* **Not accessible** - Workflows in other repositories cannot access this repository.
|
||||
* **Accessible from repositories in the 'ORGANIZATION NAME' organization** - Workflows in other repositories that are part of the 'ORGANIZATION NAME' organization can access the actions and reusable workflows in this repository. Access is allowed only from private repositories.
|
||||
1. Click **Save** to apply the settings.
|
||||
|
||||
{% endif %}
|
||||
|
|
@ -181,9 +181,9 @@ You can use the steps below to configure whether actions and reusable workflows
|
|||
1. Under your repository name, click {% octicon "gear" aria-hidden="true" %} **Settings**.
|
||||
{% data reusables.repositories.settings-sidebar-actions-general %}
|
||||
1. Under **Access**, choose one of the access settings:
|
||||
- **Not accessible** - Workflows in other repositories cannot access this repository.
|
||||
- **Accessible from repositories in the 'ORGANIZATION NAME' organization** - Workflows in other repositories that are part of the 'ORGANIZATION NAME' organization can access the actions and reusable workflows in this repository. Access is allowed only from private repositories.
|
||||
- **Accessible from repositories in the 'ENTERPRISE NAME' enterprise** - Workflows in other repositories that are part of the 'ENTERPRISE NAME' enterprise can access the actions and reusable workflows in this repository. Access is allowed only from private repositories.
|
||||
* **Not accessible** - Workflows in other repositories cannot access this repository.
|
||||
* **Accessible from repositories in the 'ORGANIZATION NAME' organization** - Workflows in other repositories that are part of the 'ORGANIZATION NAME' organization can access the actions and reusable workflows in this repository. Access is allowed only from private repositories.
|
||||
* **Accessible from repositories in the 'ENTERPRISE NAME' enterprise** - Workflows in other repositories that are part of the 'ENTERPRISE NAME' enterprise can access the actions and reusable workflows in this repository. Access is allowed only from private repositories.
|
||||
1. Click **Save** to apply the settings.
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
|
|
|
|||
|
|
@ -93,5 +93,5 @@ Organization owners and repository administrators can only grant access to view
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/code-security/getting-started/securing-your-repository)"
|
||||
- "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization)"
|
||||
* "[AUTOTITLE](/code-security/getting-started/securing-your-repository)"
|
||||
* "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization)"
|
||||
|
|
|
|||
|
|
@ -21,13 +21,13 @@ shortTitle: Email notifications for pushes
|
|||
|
||||
Each email notification for a push to a repository lists the new commits and links to a diff containing just those commits. In the email notification you'll see:
|
||||
|
||||
- The name of the repository where the commit was made
|
||||
- The branch a commit was made in
|
||||
- The SHA1 of the commit, including a link to the diff in {% data variables.product.product_name %}
|
||||
- The author of the commit
|
||||
- The date when the commit was made
|
||||
- The files that were changed as part of the commit
|
||||
- The commit message
|
||||
* The name of the repository where the commit was made
|
||||
* The branch a commit was made in
|
||||
* The SHA1 of the commit, including a link to the diff in {% data variables.product.product_name %}
|
||||
* The author of the commit
|
||||
* The date when the commit was made
|
||||
* The files that were changed as part of the commit
|
||||
* The commit message
|
||||
|
||||
You can filter email notifications you receive for pushes to a repository. For more information, see "[AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#filtering-email-notifications)."
|
||||
|
||||
|
|
@ -42,4 +42,4 @@ You can filter email notifications you receive for pushes to a repository. For m
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications)"
|
||||
* "[AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications)"
|
||||
|
|
|
|||
|
|
@ -23,8 +23,8 @@ Anyone with admin permissions to a repository can configure autolink references
|
|||
Autolink references can now accept alphanumeric characters. When originally introduced, custom autolinks were limited to external resources that used numeric identifiers. Custom autolinks now work with alphanumeric and numeric identifiers.
|
||||
|
||||
You define custom autolinks by specifying a reference prefix and a target URL.
|
||||
- Reference prefixes cannot have overlapping names. For example, a repository cannot have two custom autolinks with prefixes such as `TICKET` and `TICK`, since both prefixes would match the string `TICKET123a`.
|
||||
- Target URLs include a `<num>` variable which represents the reference identifier of the linked resource.
|
||||
* Reference prefixes cannot have overlapping names. For example, a repository cannot have two custom autolinks with prefixes such as `TICKET` and `TICK`, since both prefixes would match the string `TICKET123a`.
|
||||
* Target URLs include a `<num>` variable which represents the reference identifier of the linked resource.
|
||||
{% endif %}
|
||||
|
||||
## Configuring autolinks to reference external resources
|
||||
|
|
@ -45,6 +45,6 @@ This procedure demonstrates how to configure autolinks to reference external res
|
|||
1. Review the preview and verify that the autolink and external reference are both correct, then click **Add autolink reference** to define the link.
|
||||
|
||||
For example, you might enter the following.
|
||||
- Reference prefix: `JIRA-`
|
||||
- Target URL: `https://jira.example.com/issue?query=<num>`
|
||||
- Preview: `JIRA-123` is converted to `https://jira.example.com/issue?query=123`
|
||||
* Reference prefix: `JIRA-`
|
||||
* Target URL: `https://jira.example.com/issue?query=<num>`
|
||||
* Preview: `JIRA-123` is converted to `https://jira.example.com/issue?query=123`
|
||||
|
|
|
|||
Некоторые файлы не были показаны из-за слишком большого количества измененных файлов Показать больше
Загрузка…
Ссылка в новой задаче