jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-23 11:54:18 -05:00
Code Issues Projects Releases Wiki Activity

updating content files

Browse Source
This commit is contained in:
Grace Park
2021-06-14 12:06:52 -07:00
parent 850ab9ccb4
commit 6f7e4f50dc
1154 changed files with 6299 additions and 6267 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
content/github/administering-a-repository/configuring-pull-request-merges/about-merge-methods-on-github.md
View File

@@ -18,7 +18,7 @@ topics:
{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
The default merge method creates a merge commit. You can prevent anyone from pushing merge commits to a protected branch by enforcing a linear commit history. For more information, see "[About protected branches](/github/administering-a-repository/about-protected-branches#require-linear-history)."{% endif %}
### Squashing your merge commits
## Squashing your merge commits
{% data reusables.pull_requests.squash_and_merge_summary %}
@@ -29,7 +29,7 @@ Before enabling squashing commits, consider these disadvantages:
For more information, see "[Configuring commit squashing for pull requests](/articles/configuring-commit-squashing-for-pull-requests)."
### Rebasing and merging your commits
## Rebasing and merging your commits
{% data reusables.pull_requests.rebase_and_merge_summary %}

2
content/github/administering-a-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests.md
View File

@@ -22,7 +22,7 @@ topics:
4. Under "Merge button", select **Allow squash merging**. This allows contributors to merge a pull request by squashing all commits into a single commit. If you select another merge method besides **Allow squash merging**, collaborators will be able to choose the type of merge commit when merging a pull request. {% data reusables.repositories.squash-and-rebase-linear-commit-hisitory %}
![Pull request squashed commits](/assets/images/help/repository/pr-merge-squash.png)
### Further reading
## Further reading
- "[About pull request merges](/articles/about-pull-request-merges)"
- "[Merging a pull request](/articles/merging-a-pull-request)"

4
content/github/administering-a-repository/configuring-pull-request-merges/managing-auto-merge-for-pull-requests-in-your-repository.md
View File

@@ -12,11 +12,11 @@ topics:
redirect_from:
- /github/administering-a-repository/managing-auto-merge-for-pull-requests-in-your-repository
---
### About auto-merge
## About auto-merge
If you allow auto-merge for pull requests in your repository, people with write permissions can configure individual pull requests in the repository to merge automatically when all merge requirements are met. {% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@next" or currentVersion ver_gt "enterprise-server@3.1" %}If someone who does not have write permissions pushes changes to a pull request that has auto-merge enabled, auto-merge will be disabled for that pull request. {% endif %}For more information, see "[Automatically merging a pull request](/github/collaborating-with-issues-and-pull-requests/automatically-merging-a-pull-request)."
### Managing auto-merge
## Managing auto-merge
{% data reusables.pull_requests.auto-merge-requires-branch-protection %}

2
content/github/administering-a-repository/configuring-pull-request-merges/managing-the-automatic-deletion-of-branches.md
View File

@@ -18,6 +18,6 @@ Anyone with admin permissions to a repository can enable or disable the automati
3. Under "Merge button", select or unselect **Automatically delete head branches**.
![Checkbox to enable or disable automatic deletion of branches](/assets/images/help/repository/automatically-delete-branches.png)
### Further reading
## Further reading
- "[Merging a pull request](/articles/merging-a-pull-request)"
- "[Creating and deleting branches within your repository](/articles/creating-and-deleting-branches-within-your-repository)"

22
content/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md
View File

@@ -23,7 +23,7 @@ versions:
topics:
- Repositories
---
### About branch protection rules
## About branch protection rules
You can enforce certain workflows or requirements before a collaborator can push changes to a branch in your repository, including merging a pull request into the branch, by creating a branch protection rule.
@@ -35,7 +35,7 @@ By default, the restrictions of a branch protection rule don't apply to people w
{% data reusables.pull_requests.you-can-auto-merge %}
### About branch protection settings
## 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)
@@ -51,7 +51,7 @@ For each branch protection rule, you can choose to enable or disable the followi
For more information on how to set up branch protection, see "[Managing a branch protection rule](/github/administering-a-repository/managing-a-branch-protection-rule)."
#### Require pull request reviews before merging
### Require pull request reviews before merging
{% data reusables.pull_requests.required-reviews-for-prs-summary %}
@@ -74,7 +74,7 @@ Optionally, you can restrict the ability to dismiss pull request reviews to spec
Optionally, you can choose to require reviews from code owners. If you do, any pull request that affects code with a code owner must be approved by that code owner before the pull request can be merged into the protected branch.
#### Require status checks before merging
### Require status checks before merging
Required status checks ensure that all required CI tests are passing before collaborators can make changes to a protected branch. Required status checks can be checks or statuses. For more information, see "[About status checks](/github/collaborating-with-issues-and-pull-requests/about-status-checks)."
@@ -99,12 +99,12 @@ You can set up required status checks to either be "loose" or "strict." The type
For troubleshooting information, see "[Troubleshooting required status checks](/github/administering-a-repository/troubleshooting-required-status-checks)."
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@issue-4382" %}
#### Require conversation resolution before merging
### Require conversation resolution before merging
Requires all comments on the pull request to be resolved before it can be merged to a protected branch. This ensures that all comments are addressed or acknowledged before merge.
{% endif %}
#### Require signed commits
### Require signed commits
When you enable required commit signing on a branch, contributors {% if currentVersion == "free-pro-team@latest" %}and bots{% endif %} can only push commits that have been signed and verified to the branch. For more information, see "[About commit signature verification](/articles/about-commit-signature-verification)."
@@ -126,17 +126,17 @@ You can always push local commits to the branch if the commits are signed and ve
{% if currentVersion == "free-pro-team@latest" %} For more information about merge methods, see "[About merge methods on {% data variables.product.prodname_dotcom %}](/github/administering-a-repository/about-merge-methods-on-github)."{% endif %}
#### Require linear history
### Require linear history
Enforcing a linear commit history prevents collaborators from pushing merge commits to the branch. This means that any pull requests merged into the protected branch must use a squash merge or a rebase merge. A strictly linear commit history can help teams reverse changes more easily. For more information about merge methods, see "[About pull request merges](/github/collaborating-with-issues-and-pull-requests/about-pull-request-merges)."
Before you can require a linear commit history, your repository must allow squash merging or rebase merging. For more information, see "[Configuring pull request merges](/github/administering-a-repository/configuring-pull-request-merges)."
#### Include administrators
### Include administrators
By default, protected branch rules do not apply to people with admin permissions to a repository. You can enable this setting to include administrators in your protected branch rules.
#### Restrict who can push to matching branches
### Restrict who can push to matching branches
{% if currentVersion == "free-pro-team@latest" %}
You can enable branch restrictions if your repository is owned by an organization using {% data variables.product.prodname_team %} or {% data variables.product.prodname_ghe_cloud %}.
@@ -146,7 +146,7 @@ When you enable branch restrictions, only users, teams, or apps that have been g
You can only give push access to a protected branch to users, teams, or installed {% data variables.product.prodname_github_apps %} with write access to a repository. People and apps with admin permissions to a repository are always able to push to a protected branch.
#### Allow force pushes
### Allow force pushes
By default, {% data variables.product.product_name %} blocks force pushes on all protected branches. When you enable force pushes to a protected branch, anyone with at least write permissions to the repository can force push to the branch, including those with admin permissions.
@@ -156,6 +156,6 @@ Enabling force pushes will not override any other branch protection rules. For e
If a site administrator has blocked force pushes to the default branch only, you can still enable force pushes for any other protected branch.{% endif %}
#### Allow deletions
### Allow deletions
By default, you cannot delete a protected branch. When you enable deletion of a protected branch, anyone with at least write permissions to the repository can delete the branch.

8
content/github/administering-a-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md
View File

@@ -25,7 +25,7 @@ permissions: People with admin permissions to a repository can manage branch pro
topics:
- Repositories
---
### About branch protection rules
## About branch protection rules
{% data reusables.repositories.branch-rules-example %}
@@ -39,7 +39,7 @@ To create an exception to an existing branch rule, you can create a new branch p
For more information about each of each of the available branch protection settings, see "[About protected branches](/github/administering-a-repository/about-protected-branches)."
### Creating a branch protection rule
## Creating a branch protection rule
When you create a branch rule, the branch you specify doesn't have to exist yet in the repository.
@@ -86,7 +86,7 @@ When you create a branch rule, the branch you specify doesn't have to exist yet
![Allow branch deletions option](/assets/images/help/repository/allow-branch-deletions.png)
1. Click **Create**.
### Editing a branch protection rule
## Editing a branch protection rule
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-settings %}
@@ -97,7 +97,7 @@ When you create a branch rule, the branch you specify doesn't have to exist yet
1. Click **Save changes**.
![Save changes button](/assets/images/help/repository/save-branch-protection-rule.png)
### Deleting a branch protection rule
## Deleting a branch protection rule
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-settings %}

2
content/github/administering-a-repository/finding-information-in-a-repository/filtering-issues-and-pull-requests-by-assignees.md
View File

@@ -26,7 +26,7 @@ To clear your filter selection, click **Clear current search query, filters, and
{% endtip %}
### Further reading
## Further reading
- "[Filtering issues and pull requests](/articles/filtering-issues-and-pull-requests)"
- "[Sorting issues and pull requests](/articles/sorting-issues-and-pull-requests)"

2
content/github/administering-a-repository/finding-information-in-a-repository/filtering-issues-and-pull-requests-by-labels.md
View File

@@ -26,7 +26,7 @@ topics:
{% endtip %}
### Further reading
## Further reading
- "[Filtering issues and pull requests](/articles/filtering-issues-and-pull-requests)"
- "[Sorting issues and pull requests](/articles/sorting-issues-and-pull-requests)"

2
content/github/administering-a-repository/finding-information-in-a-repository/filtering-issues-and-pull-requests.md
View File

@@ -27,7 +27,7 @@ You can filter issues and pull requests to find:
3. Click **Filters** to choose the type of filter you're interested in.
![Using the Filters drop-down](/assets/images/help/issues/issues_filter_dropdown.png)
### Further reading
## Further reading
- "[Filtering issues and pull requests by assignees](/articles/filtering-issues-and-pull-requests-by-assignees)"
- "[Filtering issues and pull requests by milestones](/articles/filtering-issues-and-pull-requests-by-milestone)"

2
content/github/administering-a-repository/finding-information-in-a-repository/filtering-pull-requests-by-review-status.md
View File

@@ -27,7 +27,7 @@ You can filter a repository's list of pull requests to find:
4. Choose a filter to find all of the pull requests with that filter's status.
![List of filters in the Reviews drop-down menu](/assets/images/help/pull_requests/pr-review-filters.png)
### Further reading
## Further reading
- "[About pull request reviews](/articles/about-pull-request-reviews)"
- "[Using search to filter issues and pull requests](/articles/using-search-to-filter-issues-and-pull-requests)"

2
content/github/administering-a-repository/finding-information-in-a-repository/sharing-filters.md
View File

@@ -20,7 +20,7 @@ For example, if you filter on issues assigned to Hubot, and sort on the oldest o
/issues?q=state:open+type:issue+assignee:hubot+sort:created-asc
```
### Further reading
## Further reading
* "[Filtering issues and pull requests](/articles/filtering-issues-and-pull-requests)"
* "[Sorting issues and pull requests](/articles/sorting-issues-and-pull-requests)"

2
content/github/administering-a-repository/finding-information-in-a-repository/sorting-issues-and-pull-requests.md
View File

@@ -29,7 +29,7 @@ You can sort any filtered view by:
To clear your sort selection, click **Sort** > **Newest**.
### Further reading
## Further reading
* "[Filtering issues and pull requests](/articles/filtering-issues-and-pull-requests)"
* "[Using search to filter issues and pull requests](/articles/using-search-to-filter-issues-and-pull-requests)"

2
content/github/administering-a-repository/finding-information-in-a-repository/using-search-to-filter-issues-and-pull-requests.md
View File

@@ -47,7 +47,7 @@ For pull requests, you can also use search to:
- Filter pull requests by the team requested for review: `state:open type:pr team-review-requested:github/atom`{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}
- Filter for pull requests that are linked to an issue that the pull request may close: `linked:issue`{% endif %}
### Further reading
## Further reading
- "[Searching issues](/articles/searching-issues)"
- "[Filtering issues and pull requests](/articles/filtering-issues-and-pull-requests)"

6
content/github/administering-a-repository/managing-branches-in-your-repository/changing-the-default-branch.md
View File

@@ -13,7 +13,7 @@ redirect_from:
topics:
- Repositories
---
### About changing the default branch
## About changing the default branch
You can choose the default branch for a repository. The default branch is the base branch for pull requests and code commits. For more information about the default branch, see "[About branches](/github/collaborating-with-issues-and-pull-requests/about-branches#about-the-default-branch)."
@@ -37,11 +37,11 @@ You can also rename the default branch. For more information, see "[Renaming a b
{% endif %}
### Prerequisites
## Prerequisites
To change the default branch, your repository must have more than one branch. For more information, see "[Creating and deleting branches within your repository](/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository#creating-a-branch)."
### Changing the default branch
## Changing the default branch
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}

6
content/github/administering-a-repository/managing-branches-in-your-repository/deleting-and-restoring-branches-in-a-pull-request.md
View File

@@ -14,7 +14,7 @@ versions:
topics:
- Repositories
---
### Deleting a branch used for a pull request
## Deleting a branch used for a pull request
You can delete a branch that is associated with a pull request if the pull request has been merged or closed and there are no other open pull requests referencing the branch. For information on closing branches that are not associated with pull requests, see "[Creating and deleting branches within your repository](/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository#deleting-a-branch)."
@@ -27,7 +27,7 @@ You can delete a branch that is associated with a pull request if the pull reque
This button isn't displayed if there's currently an open pull request for this branch.
### Restoring a deleted branch
## Restoring a deleted branch
You can restore the head branch of a closed pull request.
@@ -38,7 +38,7 @@ You can restore the head branch of a closed pull request.
5. Near the bottom of the pull request, click **Restore branch**.
![Restore deleted branch button](/assets/images/help/branches/branches-restore-deleted.png)
### Further reading
## Further reading
- "[Creating and deleting branches within your repository](/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository)"
- "[Managing the automatic deletion of branches](/github/administering-a-repository/managing-the-automatic-deletion-of-branches)"

6
content/github/administering-a-repository/managing-branches-in-your-repository/renaming-a-branch.md
View File

@@ -10,7 +10,7 @@ topics:
redirect_from:
- /github/administering-a-repository/renaming-a-branch
---
### About renaming branches
## About renaming branches
You can rename a branch in a repository on {% data variables.product.product_location %}. For more information about branches, see "[About branches](/github/collaborating-with-issues-and-pull-requests/about-branches)."
@@ -20,7 +20,7 @@ Although file URLs are automatically redirected, raw file URLs are not redirecte
{% data variables.product.prodname_actions %} workflows do not follow renames, so if your repository publishes an action, anyone using that action with `@{old-branch-name}` will break. You should consider adding a new branch with the original content plus an additional commit reporting that the branch name is deprecated and suggesting that users migrate to the new branch name.
### Renaming a branch
## Renaming a branch
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.navigate-to-branches %}
@@ -31,7 +31,7 @@ Although file URLs are automatically redirected, raw file URLs are not redirecte
1. Review the information about local environments, then click **Rename branch**.
![Local environment information and "Rename branch" button](/assets/images/help/branch/branch-rename-rename.png)
### Updating a local clone after a branch name changes
## Updating a local clone after a branch name changes
After you rename a branch in a repository on {% data variables.product.product_name %}, any collaborator with a local clone of the repository will need to update the clone.

2
content/github/administering-a-repository/managing-branches-in-your-repository/viewing-branches-in-your-repository.md
View File

@@ -23,7 +23,7 @@ topics:
![The branches page for the Atom repository](/assets/images/help/branches/branches-overview-atom.png)
### Further reading
## Further reading
- "[Creating and deleting branches within your repository](/articles/creating-and-deleting-branches-within-your-repository)"
- "[Deleting unused branches](/articles/deleting-unused-branches)"

4
content/github/administering-a-repository/managing-repository-settings/about-email-notifications-for-pushes-to-your-repository.md
View File

@@ -29,7 +29,7 @@ Each email notification for a push to a repository lists the new commits and lin
You can filter email notifications you receive for pushes to a repository. For more information, see {% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.20" %}"[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#filtering-email-notifications){% else %}"[About notification emails](/github/receiving-notifications-about-activity-on-github/about-email-notifications)." You can also turn off email notifications for pushes. For more information, see "[Choosing the delivery method for your notifications](/enterprise/{{ currentVersion }}/user/github/receiving-notifications-about-activity-on-github/choosing-the-delivery-method-for-your-notifications){% endif %}."
### Enabling email notifications for pushes to your repository
## Enabling email notifications for pushes to your repository
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-settings %}
@@ -41,7 +41,7 @@ You can filter email notifications you receive for pushes to a repository. For m
7. Click **Setup notifications**.
![Setup notifications button](/assets/images/help/settings/setup_notifications_settings.png)
### Further reading
## Further reading
{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
- "[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications)"
{% else %}

4
content/github/administering-a-repository/managing-repository-settings/classifying-your-repository-with-topics.md
View File

@@ -12,7 +12,7 @@ versions:
topics:
- Repositories
---
### About topics
## About topics
With topics, you can explore repositories in a particular subject area, find projects to contribute to, and discover new solutions to a specific problem. Topics appear on the main page of a repository. You can click a topic name to {% if currentVersion == "free-pro-team@latest" %}see related topics and a list of other repositories classified with that topic{% else %}search for other repositories with that topic{% endif %}.
@@ -28,7 +28,7 @@ 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 "[Searching for repositories](/articles/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 "[Searching topics](/articles/searching-topics)."
### Adding topics to your repository
## Adding topics to your repository
{% data reusables.repositories.navigate-to-repo %}{% if currentVersion ver_lt "enterprise-server@2.22" %}
2. Under your repository description, click **Add topics**.

2
content/github/administering-a-repository/managing-repository-settings/customizing-how-changed-files-appear-on-github.md
View File

@@ -22,6 +22,6 @@ Use a *.gitattributes* file to mark files that match a given "pattern" with the
search/index.json linguist-generated=true
```
### Further reading
## Further reading
- "[Generated code](https://github.com/github/linguist/#generated-code)" in the Linguist documentation
- "[Creating new files](/articles/creating-new-files/)"

16
content/github/administering-a-repository/managing-repository-settings/disabling-or-limiting-github-actions-for-a-repository.md
View File

@@ -13,7 +13,7 @@ redirect_from:
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
### About {% data variables.product.prodname_actions %} permissions for your repository
## About {% data variables.product.prodname_actions %} permissions for your repository
{% data reusables.github-actions.disabling-github-actions %} For more information about {% data variables.product.prodname_actions %}, see "[About {% data variables.product.prodname_actions %}](/actions/getting-started-with-github-actions/about-github-actions)."
@@ -23,7 +23,7 @@ Alternatively, you can enable {% data variables.product.prodname_actions %} in y
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.23" %}
### Managing {% data variables.product.prodname_actions %} permissions for your repository
## Managing {% data variables.product.prodname_actions %} permissions for your repository
{% note %}
@@ -41,7 +41,7 @@ Alternatively, you can enable {% data variables.product.prodname_actions %} in y
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
### Managing {% data variables.product.prodname_actions %} permissions for your repository
## Managing {% data variables.product.prodname_actions %} permissions for your repository
You can disable all workflows for a repository or set a policy that configures which actions can be used in a repository.
@@ -62,7 +62,7 @@ You can disable all workflows for a repository or set a policy that configures w
![Set actions policy for this organization](/assets/images/help/repository/actions-policy.png)
1. Click **Save**.
### Allowing specific actions to run
## Allowing specific actions to run
{% data reusables.actions.allow-specific-actions-intro %}
@@ -75,11 +75,11 @@ You can disable all workflows for a repository or set a policy that configures w
{% endif %}
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
### Enabling workflows for private repository forks
## Enabling workflows for private repository forks
{% data reusables.github-actions.private-repository-forks-overview %}
#### Configuring the private fork policy for a repository
### Configuring the private fork policy for a repository
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-settings %}
@@ -88,7 +88,7 @@ You can disable all workflows for a repository or set a policy that configures w
{% endif %}
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %}
### Setting the permissions of the `GITHUB_TOKEN` for your repository
## Setting the permissions of the `GITHUB_TOKEN` for your repository
{% data reusables.github-actions.workflow-permissions-intro %}
@@ -96,7 +96,7 @@ The default permissions can also be configured in the organization settings. If
{% data reusables.github-actions.workflow-permissions-modifying %}
#### Configuring the default `GITHUB_TOKEN` permissions
### Configuring the default `GITHUB_TOKEN` permissions
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-settings %}

6
content/github/administering-a-repository/managing-repository-settings/displaying-a-sponsor-button-in-your-repository.md
View File

@@ -10,7 +10,7 @@ versions:
topics:
- Repositories
---
### About FUNDING files
## About FUNDING files
You can configure your sponsor button by editing a _FUNDING.yml_ file in your repository's `.github` folder, on the default branch. You can configure the button to include sponsored developers in {% data variables.product.prodname_sponsors %}, external funding platforms, or a custom funding URL. For more information about {% data variables.product.prodname_sponsors %}, see "[About GitHub Sponsors](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)."
@@ -62,7 +62,7 @@ Funding links provide a way for open source projects to receive direct financial
{% endnote %}
### Displaying a sponsor button in your repository
## Displaying a sponsor button in your repository
Anyone with admin permissions can enable a sponsor button in a repository.
@@ -78,6 +78,6 @@ Anyone with admin permissions can enable a sponsor button in a repository.
{% data reusables.files.choose_commit_branch %}
{% data reusables.files.propose_new_file %}
### Further reading
## Further reading
- "[About {% data variables.product.prodname_sponsors %} for open source contributors](/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 %}

4
content/github/administering-a-repository/managing-repository-settings/enabling-or-disabling-github-discussions-for-a-repository.md
View File

@@ -12,12 +12,12 @@ redirect_from:
---
{% data reusables.discussions.beta %}
### Enabling or disabling discussions for your repository
## Enabling or disabling discussions for your repository
{% data reusables.discussions.enabling-or-disabling-github-discussions-for-your-repository %}
1. To disable discussions, under "Features", unselect **Discussions**.
### Further reading
## Further reading
- "[About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions)"
- "[Managing discussions for your community](/discussions/managing-discussions-for-your-community)"

4
content/github/administering-a-repository/managing-repository-settings/managing-git-lfs-objects-in-archives-of-your-repository.md
View File

@@ -12,7 +12,7 @@ topics:
redirect_from:
- /github/administering-a-repository/managing-git-lfs-objects-in-archives-of-your-repository
---
### About {% data variables.large_files.product_name_short %} objects in archives
## About {% data variables.large_files.product_name_short %} objects in archives
{% data variables.product.product_name %} creates source code archives of your repository in the form of ZIP files and tarballs. People can download these archives on the main page of your repository or as release assets. By default, {% data variables.large_files.product_name_short %} objects are not included in these archives, only the pointer files to these objects. To improve the usability of archives for your repository, you can choose to include the {% data variables.large_files.product_name_short %} objects instead.
@@ -20,7 +20,7 @@ redirect_from:
If you choose to include {% data variables.large_files.product_name_short %} objects in archives of your repository, every download of those archives will count towards bandwidth usage for your account. Each account receives {% data variables.large_files.initial_bandwidth_quota %} per month of bandwidth for free, and you can pay for additional usage. For more information, see "[About storage and bandwidth usage](/github/managing-large-files/about-storage-and-bandwidth-usage)" and "[Managing billing for {% data variables.large_files.product_name_long %}](/billing/managing-billing-for-git-large-file-storage)."
{% endif %}
### Managing {% data variables.large_files.product_name_short %} objects in archives
## Managing {% data variables.large_files.product_name_short %} objects in archives
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-settings %}

10
content/github/administering-a-repository/managing-repository-settings/managing-security-and-analysis-settings-for-your-repository.md
View File

@@ -22,7 +22,7 @@ topics:
- Repositories
---
{% if currentVersion == "free-pro-team@latest" %}
### Enabling or disabling security and analysis features for public repositories
## Enabling or disabling security and analysis features for public repositories
You can manage a subset of security and analysis features for public repositories. Other features are permanently enabled, including dependency graph and secret scanning.
@@ -33,7 +33,7 @@ You can manage a subset of security and analysis features for public repositorie
!["Enable" or "Disable" button for "Configure security and analysis" features in a public repository](/assets/images/help/repository/security-and-analysis-disable-or-enable-dotcom-public.png)
{% endif %}
### Enabling or disabling security and analysis features{% if currentVersion == "free-pro-team@latest" %} for private repositories{% endif %}
## Enabling or disabling security and analysis features{% if currentVersion == "free-pro-team@latest" %} for private repositories{% endif %}
You can manage the security and analysis features for your {% if currentVersion == "free-pro-team@latest" %}private or internal {% endif %}repository.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} If your organization belongs to an enterprise with a license for {% data variables.product.prodname_GH_advanced_security %} then extra options are available. {% data reusables.advanced-security.more-info-ghas %}{% endif %}
@@ -60,7 +60,7 @@ You can manage the security and analysis features for your {% if currentVersion
![Enable or disable {% data variables.product.prodname_GH_advanced_security %} or {% data variables.product.prodname_secret_scanning %} for your repository](/assets/images/enterprise/github-ae/repository/enable-ghas-secret-scanning-ghae.png)
{% endif %}
### Granting access to security alerts
## Granting access to security alerts
After you enable {% if currentVersion != "github-ae@latest" %}{% data variables.product.prodname_dependabot %} or {% endif %}{% data variables.product.prodname_secret_scanning %} alerts for a repository in an organization, organization owners and repository administrators can view the alerts by default. You can give additional teams and people access to the alerts for a repository.
@@ -92,7 +92,7 @@ Organization owners and repository administrators can only grant access to view
!["Save changes" button for changes to security alert settings](/assets/images/enterprise/github-ae/repository/security-and-analysis-security-alerts-save-changes-ghae.png)
{% endif %}
### Removing access to security alerts
## Removing access to security alerts
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-settings %}
@@ -108,7 +108,7 @@ Organization owners and repository administrators can only grant access to view
!["x" button to remove someone's access to security alerts for your repository](/assets/images/enterprise/github-ae/repository/security-and-analysis-security-alerts-username-x-ghae.png)
{% endif %}
### Further reading
## Further reading
- "[Securing your repository](/code-security/getting-started/securing-your-repository)"
- "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)"

12
content/github/administering-a-repository/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository.md
View File

@@ -10,7 +10,7 @@ versions:
topics:
- Repositories
---
### About managing access to your repository
## About managing access to your repository
For each repository that you administer on {% data variables.product.prodname_dotcom %}, you can see an overview of every team or person with access to the repository. From the overview, you can also invite new teams or people, change each team or person's permissions, or remove access to the repository.
@@ -20,7 +20,7 @@ For more information about repository permission levels, see "[Permission levels
![Access management overview](/assets/images/help/repository/manage-access-overview.png)
### Filtering the list of teams and people
## Filtering the list of teams and people
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-settings %}
@@ -28,7 +28,7 @@ For more information about repository permission levels, see "[Permission levels
4. Under "Manage access", in the search field, start typing the name of the team or person you'd like to find.
![Search field for filtering list of teams or people with access](/assets/images/help/repository/manage-access-filter.png)
### Changing permissions for a team or person
## Changing permissions for a team or person
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-settings %}
@@ -36,7 +36,7 @@ For more information about repository permission levels, see "[Permission levels
4. Under "Manage access", find the team or person whose permissions you'd like to change, then use the **Role** drop-down to select new permissions.
![Using the "Role" drop-down to select new permissions for a team or person](/assets/images/help/repository/manage-access-role-drop-down.png)
### Inviting a team or person
## Inviting a team or person
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-settings %}
@@ -47,7 +47,7 @@ For more information about repository permission levels, see "[Permission levels
6. Under "Choose a role", select the permissions to grant to the team or person, then click **Add NAME to REPOSITORY**.
![Selecting permissions for the team or person](/assets/images/help/repository/manage-access-invite-choose-role-add.png)
### Removing access for a team or person
## Removing access for a team or person
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-settings %}
@@ -55,7 +55,7 @@ For more information about repository permission levels, see "[Permission levels
4. Under "Manage access", find the team or person whose access you'd like to remove, then click {% octicon "trash" aria-label="The trash icon" %}.
![trash icon for removing access](/assets/images/help/repository/manage-access-remove.png)
### Further reading
## Further reading
- "[Setting repository visibility](/github/administering-a-repository/setting-repository-visibility)"
- "[Setting base permissions for an organization](/organizations/managing-access-to-your-organizations-repositories/setting-base-permissions-for-an-organization)"

2
content/github/administering-a-repository/managing-repository-settings/managing-the-forking-policy-for-your-repository.md
View File

@@ -22,7 +22,7 @@ An organization owner must allow forks of private{% if currentVersion == "free-p
3. Under "Features", select **Allow forking**.
![Checkbox to allow or disallow forking of a private repository](/assets/images/help/repository/allow-forking-specific-org-repo.png)
### Further reading
## Further reading
- "[About forks](/articles/about-forks)"
- "[Repository permission levels for an organization](/articles/repository-permission-levels-for-an-organization)"

8
content/github/administering-a-repository/managing-repository-settings/restoring-a-deleted-repository.md
View File

@@ -11,7 +11,7 @@ topics:
---
Anyone can restore deleted repositories that were owned by their own user account. Organization owners can restore deleted repositories that were owned by the organization.
### About repository restoration
## About repository restoration
A deleted repository can be restored within 90 days, unless the repository was part of a fork network that is not currently empty. A fork network consists of a parent repository, the repository's forks, and forks of the repository's forks. If your repository was part of a fork network, it cannot be restored unless every other repository in the network is deleted or has been detached from the network. For more information about forks, see "[About forks](/articles/about-forks)."
@@ -21,7 +21,7 @@ It can take up to an hour after a repository is deleted before that repository i
Restoring a repository will not restore release attachments or team permissions. Issues that are restored will not be labeled.
### Restoring a deleted repository that was owned by a user account
## Restoring a deleted repository that was owned by a user account
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.repo-tab %}
@@ -29,7 +29,7 @@ Restoring a repository will not restore release attachments or team permissions.
{% data reusables.user_settings.restore-repo %}
{% data reusables.user_settings.restore-confirmation %}
### Restoring a deleted repository that was owned by an organization
## Restoring a deleted repository that was owned by an organization
{% data reusables.profile.access_org %}
@@ -38,6 +38,6 @@ Restoring a repository will not restore release attachments or team permissions.
{% data reusables.user_settings.restore-repo %}
{% data reusables.user_settings.restore-confirmation %}
### Further reading
## Further reading
- "[Deleting a repository](/articles/deleting-a-repository)"

18
content/github/administering-a-repository/managing-repository-settings/setting-repository-visibility.md
View File

@@ -14,7 +14,7 @@ versions:
topics:
- Repositories
---
### About repository visibility changes
## About repository visibility changes
Organization owners can restrict the ability to change repository visibility to organization owners only. For more information, see "[Restricting repository visibility changes in your organization](/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization)."
@@ -34,7 +34,7 @@ We recommend reviewing the following caveats before you change the visibility of
{% endif %}
#### Making a repository private
### Making a repository private
{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
* {% data variables.product.product_name %} will detach public forks of the public repository and put them into a new network. Public forks are not made private.{% endif %}
* If you change a repository's visibility from internal to private, {% data variables.product.prodname_dotcom %} will remove forks that belong to any user without access to the newly private repository. {% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}The visibility of any forks will also change to private.{% elsif currentVersion == "github-ae@latest" %}If the internal repository has any forks, the visibility of the forks is already private.{% endif %} For more information, see "[What happens to forks when a repository is deleted or changes visibility?](/articles/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility)"{% if currentVersion == "free-pro-team@latest" %}
@@ -46,7 +46,7 @@ We recommend reviewing the following caveats before you change the visibility of
{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
#### Making a repository internal
### Making a repository internal
{% note %}
@@ -60,7 +60,7 @@ We recommend reviewing the following caveats before you change the visibility of
{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
#### Making a repository public
### Making a repository public
* {% data variables.product.product_name %} will detach private forks and turn them into a standalone private repository. For more information, see "[What happens to forks when a repository is deleted or changes visibility?](/articles/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility#changing-a-private-repository-to-a-public-repository)"{% if currentVersion == "free-pro-team@latest" %}
* If you're converting your private repository to a public repository as part of a move toward creating an open source project, see the [Open Source Guides](http://opensource.guide) for helpful tips and guidelines. You can also take a free course on managing an open source project with [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}). Once your repository is public, you can also view your repository's community profile to see whether your project meets best practices for supporting contributors. For more information, see "[Viewing your community profile](/articles/viewing-your-community-profile)."
@@ -72,7 +72,7 @@ For information about improving repository security, see "[Securing your reposit
{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
### Changing a repository's visibility
## Changing a repository's visibility
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-settings %}
@@ -91,7 +91,7 @@ For information about improving repository security, see "[Securing your reposit
{% if currentVersion ver_lt "enterprise-server@2.22" %}
### Making a repository private
## Making a repository private
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-settings %}
@@ -102,7 +102,7 @@ For information about improving repository security, see "[Securing your reposit
5. Type the name of the repository that you want to make private, for example `accountname/reponame`.
6. Click **I understand, make this repository private**.
### Making a repository public
## Making a repository public
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-settings %}
@@ -114,7 +114,7 @@ For information about improving repository security, see "[Securing your reposit
6. Click **I understand, make this repository public**.
{% if currentVersion ver_gt "enterprise-server@2.19" %}
### Making a repository internal
## Making a repository internal
{% data reusables.organizations.internal-repos-enterprise %}
@@ -130,5 +130,5 @@ For information about improving repository security, see "[Securing your reposit
{% endif %}
### Further reading
## Further reading
- "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility)"

10
content/github/administering-a-repository/managing-repository-settings/transferring-a-repository.md
View File

@@ -20,7 +20,7 @@ versions:
topics:
- Repositories
---
### About repository transfers
## About repository transfers
When you transfer a repository to a new owner, they can immediately administer the repository's contents, issues, pull requests, releases, project boards, and settings.
@@ -33,7 +33,7 @@ Prerequisites for repository transfers: {% if currentVersion == "free-pro-team@l
{% if currentVersion == "free-pro-team@latest" %}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 %}{% endif %}
#### What's transferred with a repository?
### What's transferred with a repository?
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:
@@ -50,13 +50,13 @@ When you transfer a repository, its issues, pull requests, wiki, stars, and watc
For more information, see "[Managing remote repositories](/github/getting-started-with-github/managing-remote-repositories)."
#### Repository transfers and organizations
### Repository transfers and organizations
To transfer repositories to an organization, you must have repository creation permissions in the receiving organization. If organization owners have disabled repository creation by organization members, only organization owners can transfer repositories out of or into the organization.
Once a repository is transferred to an organization, the organization's default repository permission settings and default membership privileges will apply to the transferred repository.
### Transferring a repository owned by your user account
## Transferring a repository owned by your user account
You can transfer your repository to any user account that accepts your repository transfer. When a repository is transferred between two user accounts, the original repository owner and collaborators are automatically added as collaborators to the new repository.
@@ -66,7 +66,7 @@ You can transfer your repository to any user account that accepts your repositor
{% data reusables.repositories.sidebar-settings %}
{% data reusables.repositories.transfer-repository-steps %}
### Transferring a repository owned by your organization
## Transferring a repository owned by your organization
If you have owner permissions in an organization or admin permissions to one of its repositories, you can transfer a repository owned by your organization to your user account or to another organization.

4
content/github/administering-a-repository/managing-repository-settings/viewing-deployment-activity-for-your-repository.md
View File

@@ -21,7 +21,7 @@ People with read access to a repository can see an overview of all current deplo
You can also see deployment information on the "Conversation" tab of a pull request.
### Viewing the deployments dashboard
## Viewing the deployments dashboard
{% data reusables.repositories.navigate-to-repo %}
2. {% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.21" %}To the right of the list of files, click **Environments**.
@@ -29,5 +29,5 @@ You can also see deployment information on the "Conversation" tab of a pull requ
![Environments on top of repository page](/assets/images/help/repository/environments-top.png){% endif %}
### Further reading
## Further reading
- "[About pull requests](/articles/about-pull-requests)"

4
content/github/administering-a-repository/releasing-projects-on-github/about-releases.md
View File

@@ -15,7 +15,7 @@ versions:
topics:
- Repositories
---
### About releases
## About releases
![An overview of releases](/assets/images/help/releases/releases-overview.png)
@@ -40,7 +40,7 @@ You can view the **Dependents** tab of the dependency graph to see which reposit
You can also use the Releases API to gather information, such as the number of times people download a release asset. For more information, see "[Releases](/rest/reference/repos#releases)."
{% if currentVersion == "free-pro-team@latest" %}
### Storage and bandwidth quotas
## Storage and bandwidth quotas
Each file included in a release must be under {% data variables.large_files.max_file_size %}. There is no limit on the total size of a release, nor bandwidth usage.

4
content/github/administering-a-repository/releasing-projects-on-github/automation-for-release-forms-with-query-parameters.md
View File

@@ -17,7 +17,7 @@ You must have the proper permissions for any action to use the equivalent query
If you create an invalid URL using query parameters, or if you don’t have the proper permissions, the URL will return a 404 error page.
### Supported query parameters
## Supported query parameters
Query parameter | Example
--- | ---
@@ -27,6 +27,6 @@ Query parameter | Example
`body` | `https://github.com/octo-org/octo-repo/releases/new?body=Adds+widgets+support` creates a release with the description "Adds widget support" in the release body.
`prerelease` | `https://github.com/octo-org/octo-repo/releases/new?prerelease=1` creates a release that will be identified as non-production ready.
### Further reading
## Further reading
- "[About automation for issues and pull requests with query parameters](/articles/about-automation-for-issues-and-pull-requests-with-query-parameters)"

8
content/github/administering-a-repository/releasing-projects-on-github/managing-releases-in-a-repository.md
View File

@@ -19,7 +19,7 @@ topics:
---
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}
### About release management
## About release management
{% if currentVersion == "free-pro-team@latest" %}
You can also publish an action from a specific release in {% data variables.product.prodname_marketplace %}. For more information, see "<a href="/actions/creating-actions/publishing-actions-in-github-marketplace" class="dotcom-only">Publishing an action in the {% data variables.product.prodname_marketplace %}</a>."
@@ -36,7 +36,7 @@ You can choose whether {% data variables.large_files.product_name_long %} ({% da
{% endtip %}
{% endif %}
### Creating a release
## Creating a release
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.releases %}
@@ -61,7 +61,7 @@ You can choose whether {% data variables.large_files.product_name_long %} ({% da
You can also automatically create a release from the command line or in a script. For more information, see "[Releases](/rest/reference/repos/#create-a-release)."
### Editing a release
## Editing a release
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.releases %}
@@ -70,7 +70,7 @@ You can also automatically create a release from the command line or in a script
4. Edit the details for the release in the form, then click **Update release**.
![Update a release](/assets/images/help/releases/update-release.png)
### Deleting a release
## Deleting a release
You must remove all binary files attached to a release before you can delete a release.

6
content/github/administering-a-repository/releasing-projects-on-github/viewing-your-repositorys-releases-and-tags.md
View File

@@ -21,19 +21,19 @@ topics:
{% endtip %}
{% endif %}
### Viewing releases
## Viewing releases
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.releases %}
2. At the top of the Releases page, click **Releases**.
### Viewing tags
## Viewing tags
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.releases %}
2. At the top of the Releases page, click **Tags**.
![Tags page](/assets/images/help/releases/tags-list.png)
### Further reading
## Further reading
- "[Signing tags](/articles/signing-tags)"

6
content/github/authenticating-to-github/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on.md
View File

@@ -11,7 +11,7 @@ versions:
topics:
- SSO
---
### About authentication with SAML SSO
## About authentication with SAML SSO
{% if currentVersion == "github-ae@latest" %}
@@ -41,7 +41,7 @@ If you don't have a personal access token or an SSH key, you can create a person
To use a new or existing personal access token or SSH key with an organization that uses or enforces SAML SSO, you will need to authorize the token or authorize the SSH key for use with a SAML SSO organization. For more information, see "[Authorizing a personal access token for use with SAML single sign-on](/articles/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)" or "[Authorizing an SSH key for use with SAML single sign-on](/articles/authorizing-an-ssh-key-for-use-with-saml-single-sign-on)."
### About {% data variables.product.prodname_oauth_apps %} and SAML SSO
## About {% data variables.product.prodname_oauth_apps %} and SAML SSO
You must have an active SAML session each time you authorize an {% data variables.product.prodname_oauth_app %} to access an organization that uses or enforces SAML SSO.
@@ -49,7 +49,7 @@ After an enterprise or organization owner enables or enforces SAML SSO for an or
{% endif %}
### Further reading
## Further reading
{% if currentVersion == "free-pro-team@latest" %}- "[About identity and access management with SAML single sign-on](/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)"{% endif %}
{% if currentVersion == "github-ae@latest" %}- "[About identity and access management for your enterprise](/admin/authentication/about-identity-and-access-management-for-your-enterprise)"{% endif %}

2
content/github/authenticating-to-github/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on.md
View File

@@ -21,7 +21,7 @@ You can authorize an existing personal access token, or [create a new personal a
4. Click **Authorize**.
![Token authorize button](/assets/images/help/settings/token-authorize-button.png)
### Further reading
## Further reading
- "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)"
- "[About authentication with SAML single sign-on](/articles/about-authentication-with-saml-single-sign-on)"

2
content/github/authenticating-to-github/authenticating-with-saml-single-sign-on/authorizing-an-ssh-key-for-use-with-saml-single-sign-on.md
View File

@@ -26,7 +26,7 @@ You can authorize an existing SSH key, or create a new SSH key and then authoriz
5. Click **Authorize**.
![Token authorize button](/assets/images/help/settings/ssh-sso-authorize.png)
### Further reading
## Further reading
- "[Checking for existing SSH keys](/articles/checking-for-existing-ssh-keys)"
- "[About authentication with SAML single sign-on](/articles/about-authentication-with-saml-single-sign-on)"

2
content/github/authenticating-to-github/authenticating-with-saml-single-sign-on/viewing-and-managing-your-active-saml-sessions.md
View File

@@ -24,6 +24,6 @@ topics:
{% endnote %}
### Further reading
## Further reading
- "[About authentication with SAML SSO](/github/authenticating-to-github/about-authentication-with-saml-single-sign-on)"

2
content/github/authenticating-to-github/connecting-to-github-with-ssh/about-ssh.md
View File

@@ -25,7 +25,7 @@ If you haven't used your SSH key for a year, then {% data variables.product.prod
If you're a member of an organization that provides SSH certificates, you can use your certificate to access that organization's repositories without adding the certificate to your {% data variables.product.product_name %} account. For more information, see "[About SSH certificate authorities](/articles/about-ssh-certificate-authorities)."
### Further reading
## Further reading
- "[Checking for existing SSH keys](/articles/checking-for-existing-ssh-keys)"
- "[Testing your SSH connection](/articles/testing-your-ssh-connection)"

2
content/github/authenticating-to-github/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md
View File

@@ -123,7 +123,7 @@ After adding a new SSH key to your {% data variables.product.product_name %} acc
{% endlinux %}
{% if currentVersion == "free-pro-team@latest" %}
### Further reading
## Further reading
- "[Authorizing an SSH key for use with SAML single sign-on](/articles/authorizing-an-ssh-key-for-use-with-saml-single-sign-on)"
{% endif %}

10
content/github/authenticating-to-github/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md
View File

@@ -13,7 +13,7 @@ versions:
topics:
- SSH
---
### About SSH key generation
## About SSH key generation
If you don't already have an SSH key, you must generate a new SSH key to use for authentication. If you're unsure whether you already have an SSH key, you can check for existing keys. For more information, see "[Checking for existing SSH keys](/github/authenticating-to-github/checking-for-existing-ssh-keys)."
@@ -24,7 +24,7 @@ If you want to use a hardware security key to authenticate to {% data variables.
{% endif %}
If you don't want to reenter your passphrase every time you use your SSH key, you can add your key to the SSH agent, which manages your SSH keys and remembers your passphrase.
### Generating a new SSH key
## Generating a new SSH key
{% data reusables.command_line.open_the_multi_os_terminal %}
2. Paste the text below, substituting in your {% data variables.product.product_name %} email address.
@@ -75,7 +75,7 @@ If you don't want to reenter your passphrase every time you use your SSH key, yo
> Enter same passphrase again: <em>[Type passphrase again]</em>
```
### Adding your SSH key to the ssh-agent
## Adding your SSH key to the ssh-agent
Before adding a new SSH key to the ssh-agent to manage your keys, you should have checked for existing SSH keys and generated a new SSH key. <span class="platform-mac">When adding your SSH key to the agent, use the default macOS `ssh-add` command, and not an application installed by [macports](https://www.macports.org/), [homebrew](http://brew.sh/), or some other external source.</span>
@@ -178,7 +178,7 @@ Before adding a new SSH key to the ssh-agent to manage your keys, you should hav
{% endlinux %}
{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@next" or currentVersion ver_gt "enterprise-server@3.1" %}
### Generating a new SSH key for a hardware security key
## Generating a new SSH key for a hardware security key
If you are using macOS or Linux, you may need to update your SSH client or install a new SSH client prior to generating a new SSH key. For more information, see "[Error: Unknown key type](/github/authenticating-to-github/error-unknown-key-type)."
@@ -232,7 +232,7 @@ If you are using macOS or Linux, you may need to update your SSH client or insta
{% endif %}
### Further reading
## Further reading
- "[About SSH](/articles/about-ssh)"
- "[Working with SSH key passphrases](/articles/working-with-ssh-key-passphrases)"

8
content/github/authenticating-to-github/connecting-to-github-with-ssh/working-with-ssh-key-passphrases.md
View File

@@ -15,7 +15,7 @@ topics:
---
With SSH keys, if someone gains access to your computer, they also gain access to every system that uses that key. To add an extra layer of security, you can add a passphrase to your SSH key. You can use `ssh-agent` to securely save your passphrase so you don't have to reenter it.
### Adding or changing a passphrase
## Adding or changing a passphrase
You can change the passphrase for an existing private key without regenerating the keypair by typing the following command:
@@ -32,7 +32,7 @@ If your key already has a passphrase, you will be prompted to enter it before yo
{% windows %}
### Auto-launching `ssh-agent` on Git for Windows
## Auto-launching `ssh-agent` on Git for Windows
You can run `ssh-agent` automatically when you open bash or Git shell. Copy the following lines and paste them into your `~/.profile` or `~/.bashrc` file in Git shell:
@@ -87,7 +87,7 @@ The `ssh-agent` process will continue to run until you log out, shut down your c
{% mac %}
### Saving your passphrase in the keychain
## Saving your passphrase in the keychain
On Mac OS X Leopard through OS X El Capitan, these default private key files are handled automatically:
@@ -100,6 +100,6 @@ Otherwise, you can store your passphrase in the keychain when you add your key t
{% endmac %}
### Further reading
## Further reading
- "[About SSH](/articles/about-ssh)"

12
content/github/authenticating-to-github/keeping-your-account-and-data-secure/about-anonymized-urls.md
View File

@@ -18,7 +18,7 @@ Videos also get anonymized URLs with the same format as image URLs, but are not
Anyone who receives your anonymized URL, directly or indirectly, may view your image or video. To keep sensitive media files private, restrict them to a private network or a server that requires authentication instead of using Camo.
### Troubleshooting issues with Camo
## Troubleshooting issues with Camo
In rare circumstances, images that are processed through Camo might not appear on {% data variables.product.prodname_dotcom %}. Here are some steps you can take to determine where the problem lies.
@@ -32,7 +32,7 @@ Windows users will either need to use the Git Powershell (which is installed alo
{% endwindows %}
#### An image is not showing up
### An image is not showing up
If an image is showing up in your browser but not on {% data variables.product.prodname_dotcom %}, you can try requesting it locally.
@@ -55,7 +55,7 @@ If your content type is not supported by Camo, you can try several actions:
* If you're using an external service for hosting images, contact support for that service.
* Make a pull request to Camo to add your content type to the list.
#### An image that changed recently is not updating
### An image that changed recently is not updating
If you changed an image recently and it's showing up in your browser but not {% data variables.product.prodname_dotcom %}, you can try resetting the cache of the image.
@@ -76,7 +76,7 @@ Check the value of `Cache-Control`. In this example, there's no `Cache-Control`.
If `Cache-Control` *is* set to `no-cache`, contact {% data variables.contact.contact_support %} or search the {% data variables.contact.community_support_forum %}.
#### Removing an image from Camo's cache
### Removing an image from Camo's cache
Purging the cache forces every {% data variables.product.prodname_dotcom %} user to re-request the image, so you should use it very sparingly and only in the event that the above steps did not work.
@@ -87,12 +87,12 @@ Purging the cache forces every {% data variables.product.prodname_dotcom %} user
> {"status": "ok", "id": "216-8675309-1008701"}
```
#### Viewing images on private networks
### Viewing images on private networks
If an image is being served from a private network or from a server that requires authentication, it can't be viewed by {% data variables.product.prodname_dotcom %}. In fact, it can't be viewed by any user without asking them to log into the server.
To fix this, please move the image to a service that is publicly available.
### Further reading
## Further reading
- "[Proxying user images](https://github.com/blog/1766-proxying-user-images)" on {% data variables.product.prodname_blog %}

12
content/github/authenticating-to-github/keeping-your-account-and-data-secure/about-authentication-to-github.md
View File

@@ -11,7 +11,7 @@ topics:
redirect_from:
- /github/authenticating-to-github/about-authentication-to-github
---
### About authentication to {% data variables.product.prodname_dotcom %}
## About authentication to {% data variables.product.prodname_dotcom %}
To keep your account secure, you must authenticate before you can access{% if currentVersion != "github-ae@latest" %} certain{% endif %} resources on {% data variables.product.product_name %}. When you authenticate to {% data variables.product.product_name %}, you supply or confirm credentials that are unique to you to prove that you are exactly who you declare to be.
@@ -21,7 +21,7 @@ You can access your resources in {% data variables.product.product_name %} in a
- Personal access token
- SSH key
### Authenticating in your browser
## Authenticating in your browser
You can authenticate to {% data variables.product.product_name %} in your browser {% if currentVersion == "github-ae@latest" %}using your IdP. For more information, see "[About authentication with SAML single sign-on](/github/authenticating-to-github/about-authentication-with-saml-single-sign-on)."{% else %}in different ways.
@@ -32,11 +32,11 @@ You can authenticate to {% data variables.product.product_name %} in your browse
- In addition to authentication with a mobile application or a text message, you can optionally add a secondary method of authentication with a security key using WebAuthn. For more information, see "[Configuring two-factor authentication using a security key](/github/authenticating-to-github/configuring-two-factor-authentication#configuring-two-factor-authentication-using-a-security-key)."
{% endif %}
### Authenticating with {% data variables.product.prodname_desktop %}
## Authenticating with {% data variables.product.prodname_desktop %}
You can authenticate with {% data variables.product.prodname_desktop %} using your browser. For more information, see "[Authenticating to {% data variables.product.prodname_dotcom %}](/desktop/getting-started-with-github-desktop/authenticating-to-github)."
### Authenticating with the API
## Authenticating with the API
You can authenticate with the API in different ways.
@@ -47,7 +47,7 @@ You can authenticate with the API in different ways.
- **GitHub Apps**
- For GitHub Apps in production, you should authenticate on behalf of the app installation. For more information, see "[Authenticating with {% data variables.product.prodname_github_apps %}](/apps/building-github-apps/authenticating-with-github-apps/)."
### Authenticating with the command line
## Authenticating with the command line
You can access repositories on {% data variables.product.product_name %} from the command line in two ways, HTTPS and SSH, and both have a different way of authenticating. The method of authenticating is determined based on whether you choose an HTTPS or SSH remote URL when you clone the repository. For more information about which way to access, see "[About remote repositories](/github/getting-started-with-github/about-remote-repositories)."
@@ -59,7 +59,7 @@ You can access repositories on {% data variables.product.product_name %} from th
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %}
### {% data variables.product.company_short %}'s token formats
## {% data variables.product.company_short %}'s token formats
{% data variables.product.company_short %} issues tokens that begin with a prefix to indicate the token's type.

2
content/github/authenticating-to-github/keeping-your-account-and-data-secure/about-githubs-ip-addresses.md
View File

@@ -23,6 +23,6 @@ We make changes to our IP addresses from time to time, and will keep this API up
For applications to function, you must allow TCP ports 22, 80, 443, and 9418 via our IP ranges for `github.com`.
### Further reading
## Further reading
- "[Troubleshooting connectivity problems](/articles/troubleshooting-connectivity-problems)"

12
content/github/authenticating-to-github/keeping-your-account-and-data-secure/authorizing-oauth-apps.md
View File

@@ -24,7 +24,7 @@ When an {% data variables.product.prodname_oauth_app %} wants to identify you by
{% endif %}
### {% data variables.product.prodname_oauth_app %} access
## {% data variables.product.prodname_oauth_app %} access
{% data variables.product.prodname_oauth_app %}s can have *read* or *write* access to your {% data variables.product.product_name %} data.
@@ -37,7 +37,7 @@ When an {% data variables.product.prodname_oauth_app %} wants to identify you by
{% endtip %}
#### About OAuth scopes
### About OAuth scopes
*Scopes* are named groups of permissions that an {% data variables.product.prodname_oauth_app %} can request to access both public and non-public data.
@@ -51,7 +51,7 @@ When you want to use an {% data variables.product.prodname_oauth_app %} that int
{% data reusables.apps.oauth-token-limit %}
#### Types of requested data
### Types of requested data
{% data variables.product.prodname_oauth_app %}s can request several types of data.
@@ -67,13 +67,13 @@ When you want to use an {% data variables.product.prodname_oauth_app %} that int
| Repositories | Repository information includes the names of contributors, the branches you've created, and the actual files within your repository. Apps can request access for either public or private repositories on a user-wide level. |
| Repository delete | Apps can request to delete repositories that you administer, but they won't have access to your code. |
### Requesting updated permissions
## Requesting updated permissions
When {% data variables.product.prodname_oauth_app %}s request new access permissions, they will notify you of the differences between their current permissions and the new permissions.
{% if currentVersion == "free-pro-team@latest" %}
### {% data variables.product.prodname_oauth_app %}s and organizations
## {% data variables.product.prodname_oauth_app %}s and organizations
When you authorize an {% data variables.product.prodname_oauth_app %} for your personal user account, you'll also see how the authorization will affect each organization you're a member of.
@@ -83,7 +83,7 @@ When you authorize an {% data variables.product.prodname_oauth_app %} for your p
If you belong to any organizations that enforce SAML single sign-on, you must have an active SAML session for each organization each time you authorize an {% data variables.product.prodname_oauth_app %}.
### Further reading
## Further reading
- "[About {% data variables.product.prodname_oauth_app %} access restrictions](/articles/about-oauth-app-access-restrictions)"
- "[{% data variables.product.prodname_marketplace %} support](/articles/github-marketplace-support)"

10
content/github/authenticating-to-github/keeping-your-account-and-data-secure/connecting-with-third-party-applications.md
View File

@@ -14,7 +14,7 @@ topics:
---
When a third-party application wants to identify you by your {% data variables.product.product_name %} login, you'll see a page with the developer contact information and a list of the specific data that's being requested.
### Contacting the application developer
## Contacting the application developer
Because an application is developed by a third-party who isn't {% data variables.product.product_name %}, we don't know exactly how an application uses the data it's requesting access to. You can use the developer information at the top of the page to contact the application admin if you have questions or concerns about their application.
@@ -24,14 +24,14 @@ If the developer has chosen to supply it, the right-hand side of the page provid
![OAuth application information and website](/assets/images/help/platform/oauth_app_info.png)
### Types of application access and data
## Types of application access and data
Applications can have *read* or *write* access to your {% data variables.product.product_name %} data.
- **Read access** only allows an application to *look at* your data.
- **Write access** allows an application to *change* your data.
#### About OAuth scopes
### About OAuth scopes
*Scopes* are named groups of permissions that an application can request to access both public and non-public data.
@@ -43,7 +43,7 @@ When you want to use a third-party application that integrates with {% data vari
{% endtip %}
#### Types of requested data
### Types of requested data
There are several types of data that applications can request.
@@ -67,7 +67,7 @@ There are several types of data that applications can request.
| Repositories | Repository information includes the names of contributors, the branches you've created, and the actual files within your repository. Applications can request access for either {% if currentVersion != "github-ae@latest" %}public{% else %}internal{% endif %} or private repositories on a user-wide level. |
| Repository delete | Applications can request to delete repositories that you administer, but they won't have access to your code. |
### Requesting updated permissions
## Requesting updated permissions
Applications can request new access privileges. When asking for updated permissions, the application will notify you of the differences.

6
content/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token.md
View File

@@ -21,7 +21,7 @@ Personal access tokens (PATs) are an alternative to using passwords for authenti
{% if currentVersion == "free-pro-team@latest" %}{% data reusables.user_settings.removes-personal-access-tokens %}{% endif %}
### Creating a token
## Creating a token
{% if currentVersion == "free-pro-team@latest" %}1. [Verify your email address](/github/getting-started-with-github/verifying-your-email-address), if it hasn't been verified yet.{% endif %}
{% data reusables.user_settings.access_settings %}
@@ -55,7 +55,7 @@ Personal access tokens (PATs) are an alternative to using passwords for authenti
{% if currentVersion == "free-pro-team@latest" %}9. To use your token to authenticate to an organization that uses SAML SSO, [authorize the token for use with a SAML single-sign-on organization](/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on).{% endif %}
### Using a token on the command line
## Using a token on the command line
{% data reusables.command_line.providing-token-as-password %}
@@ -65,6 +65,6 @@ If you are not prompted for your username and password, your credentials may be
Instead of manually entering your PAT for every HTTPS Git operation, you can cache your PAT with a Git client. Git will temporarily store your credentials in memory until an expiry interval has passed. You can also store the token in a plain text file that Git can read before every request. For more information, see "[Caching your {% data variables.product.prodname_dotcom %} credentials in Git](/github/getting-started-with-github/caching-your-github-credentials-in-git)."
### Further reading
## Further reading
- "[About authentication to GitHub](/github/authenticating-to-github/about-authentication-to-github)"

2
content/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-strong-password.md
View File

@@ -28,7 +28,7 @@ You can only use your password to log on to {% data variables.product.product_na
{% if currentVersion == "free-pro-team@latest" %}{% data reusables.user_settings.password-authentication-deprecation %}{% endif %}
### Further reading
## Further reading
- "[Caching your {% data variables.product.product_name %} credentials in Git](/github/getting-started-with-github/caching-your-github-credentials-in-git/)"
- "[Keeping your account and data secure](/articles/keeping-your-account-and-data-secure/)"

10
content/github/authenticating-to-github/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md
View File

@@ -27,9 +27,9 @@ This article tells you how to make commits with sensitive data unreachable from
{% endwarning %}
### Purging a file from your repository's history
## Purging a file from your repository's history
#### Using the BFG
### Using the BFG
The [BFG Repo-Cleaner](https://rtyley.github.io/bfg-repo-cleaner/) is a tool that's built and maintained by the open source community. It provides a faster, simpler alternative to `git filter-branch` for removing unwanted data. For example, to remove your file with sensitive data and leave your latest commit untouched, run:
@@ -51,7 +51,7 @@ $ git push --force
See the [BFG Repo-Cleaner](https://rtyley.github.io/bfg-repo-cleaner/)'s documentation for full usage and download instructions.
#### Using filter-branch
### Using filter-branch
{% warning %}
@@ -144,7 +144,7 @@ To illustrate how `git filter-branch` works, we'll show you how to remove your f
{% endnote %}
### Avoiding accidental commits in the future
## Avoiding accidental commits in the future
There are a few simple tricks to avoid committing things you don't want committed:
@@ -153,7 +153,7 @@ There are a few simple tricks to avoid committing things you don't want committe
- Use `git add --interactive` to individually review and stage changes within each file.
- Use `git diff --cached` to review the changes that you have staged for commit. This is the exact diff that `git commit` will produce as long as you don't use the `-a` flag.
### Further reading
## Further reading
- [`git filter-branch` man page](https://git-scm.com/docs/git-filter-branch)
- [Pro Git: Git Tools - Rewriting History](https://git-scm.com/book/en/Git-Tools-Rewriting-History)

2
content/github/authenticating-to-github/keeping-your-account-and-data-secure/reviewing-your-authorized-applications-oauth.md
View File

@@ -17,7 +17,7 @@ topics:
{% data reusables.user_settings.access_authorized_oauth_apps %}
{% data reusables.user_settings.review-oauth-apps %}
### Further reading
## Further reading
{% if currentVersion == "free-pro-team@latest" %}
- "[About integrations](/articles/about-integrations)"{% endif %}
- "[Reviewing your authorized integrations](/articles/reviewing-your-authorized-integrations)"

6
content/github/authenticating-to-github/keeping-your-account-and-data-secure/reviewing-your-authorized-integrations.md
View File

@@ -12,14 +12,14 @@ topics:
- Identity
- Access management
---
### Reviewing your authorized {% data variables.product.prodname_oauth_app %}s
## Reviewing your authorized {% data variables.product.prodname_oauth_app %}s
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.access_applications %}
{% data reusables.user_settings.access_authorized_oauth_apps %}
{% data reusables.user_settings.review-oauth-apps %}
### Reviewing your authorized {% data variables.product.prodname_github_app %}s
## Reviewing your authorized {% data variables.product.prodname_github_app %}s
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.access_applications %}
@@ -28,7 +28,7 @@ topics:
3. Review the {% data variables.product.prodname_github_app %}s that have access to your account. For those that you don't recognize or that are out of date, click **Revoke**. To revoke all {% data variables.product.prodname_github_app %}s, click **Revoke all**.
![List of authorized {% data variables.product.prodname_github_app %}](/assets/images/help/settings/revoke-github-app.png)
### Further reading
## Further reading
{% if currentVersion == "free-pro-team@latest" %}
- "[About integrations](/articles/about-integrations)"{% endif %}
- "[Reviewing your authorized applications (OAuth)](/articles/reviewing-your-authorized-applications-oauth)"

48
content/github/authenticating-to-github/keeping-your-account-and-data-secure/reviewing-your-security-log.md
View File

@@ -1,7 +1,7 @@
---
title: Reviewing your security log
intro: You can review the security log for your user account to better understand actions you've performed and actions others have performed that involve you.
miniTocMaxHeadingLevel: 4
miniTocMaxHeadingLevel: 3
redirect_from:
- /articles/reviewing-your-security-log
- /github/authenticating-to-github/reviewing-your-security-log
@@ -13,7 +13,7 @@ topics:
- Identity
- Access management
---
### Accessing your security log
## Accessing your security log
The security log lists all actions performed within the last 90 days{% if currentVersion ver_lt "enterprise-server@2.20" %}, up to 50{% endif %}.
@@ -30,13 +30,13 @@ The security log lists all actions performed within the last 90 days{% if curren
{% endif %}
{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
### Searching your security log
## Searching your security log
{% data reusables.audit_log.audit-log-search %}
#### Search based on the action performed
### Search based on the action performed
{% else %}
### Understanding events in your security log
## Understanding events in your security log
{% endif %}
The events listed in your security log are triggered by your actions. Actions are grouped into the following categories:
@@ -61,20 +61,20 @@ The events listed in your security log are triggered by your actions. Actions ar
{% if currentVersion == "free-pro-team@latest" %}
### Exporting your security log
## Exporting your security log
{% data reusables.audit_log.export-log %}
{% data reusables.audit_log.exported-log-keys-and-values %}
{% endif %}
### Security log actions
## Security log actions
An overview of some of the most common actions that are recorded as events in the security log.
{% if currentVersion == "free-pro-team@latest" %}
#### `account_recovery_token` category actions
### `account_recovery_token` category actions
| Action | Description
|------------------|-------------------
@@ -82,14 +82,14 @@ An overview of some of the most common actions that are recorded as events in th
| `recover` | Triggered when you successfully [redeem an account recovery token](/articles/recovering-your-account-if-you-lose-your-2fa-credentials).
| `recover_error` | Triggered when a token is used but {% data variables.product.prodname_dotcom %} is not able to validate it.
#### `billing` category actions
### `billing` category actions
| Action | Description
|------------------|-------------------
| `change_billing_type` | Triggered when you [change how you pay](/articles/adding-or-editing-a-payment-method) for {% data variables.product.prodname_dotcom %}.
| `change_email` | Triggered when you [change your email address](/articles/changing-your-primary-email-address).
#### `codespaces` category actions
### `codespaces` category actions
| Action | Description
|------------------|-------------------
@@ -99,13 +99,13 @@ An overview of some of the most common actions that are recorded as events in th
| `manage_access_and_security` | Triggered when you update [the repositories a codespace has access to](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces).
| `trusted_repositories_access_update` | Triggered when you change your user account's [access and security setting for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces).
#### `marketplace_agreement_signature` category actions
### `marketplace_agreement_signature` category actions
| Action | Description
|------------------|-------------------
| `create` | Triggered when you sign the {% data variables.product.prodname_marketplace %} Developer Agreement.
#### `marketplace_listing` category actions
### `marketplace_listing` category actions
| Action | Description
|------------------|-------------------
@@ -117,7 +117,7 @@ An overview of some of the most common actions that are recorded as events in th
{% endif %}
#### `oauth_access` category actions
### `oauth_access` category actions
| Action | Description
|------------------|-------------------
@@ -126,7 +126,7 @@ An overview of some of the most common actions that are recorded as events in th
{% if currentVersion == "free-pro-team@latest" %}
#### `payment_method` category actions
### `payment_method` category actions
| Action | Description
|------------------|-------------------
@@ -136,13 +136,13 @@ An overview of some of the most common actions that are recorded as events in th
{% endif %}
#### `profile_picture` category actions
### `profile_picture` category actions
| Action | Description
|------------------|-------------------
| `update` | Triggered when you [set or update your profile picture](/articles/setting-your-profile-picture/).
#### `project` category actions
### `project` category actions
| Action | Description
|--------------------|---------------------
@@ -155,14 +155,14 @@ An overview of some of the most common actions that are recorded as events in th
| `unlink` | Triggered when a repository is unlinked from a project board.
| `update_user_permission` | Triggered when an outside collaborator is added to or removed from a project board or has their permission level changed.
#### `public_key` category actions
### `public_key` category actions
| Action | Description
|------------------|-------------------
| `create` | Triggered when you [add a new public SSH key to your {% data variables.product.product_name %} account](/articles/adding-a-new-ssh-key-to-your-github-account).
| `delete` | Triggered when you [remove a public SSH key to your {% data variables.product.product_name %} account](/articles/reviewing-your-ssh-keys).
#### `repo` category actions
### `repo` category actions
| Action | Description
|------------------|-------------------
@@ -186,7 +186,7 @@ An overview of some of the most common actions that are recorded as events in th
| `unarchived` | Triggered when a repository owner unarchives a repository.
{% if currentVersion == "free-pro-team@latest" %}
#### `sponsors` category actions
### `sponsors` category actions
| Action | Description
|------------------|-------------------
@@ -210,7 +210,7 @@ An overview of some of the most common actions that are recorded as events in th
{% endif %}
{% if currentVersion == "free-pro-team@latest" %}
#### `successor_invitation` category actions
### `successor_invitation` category actions
| Action | Description
|------------------|-------------------
@@ -223,7 +223,7 @@ An overview of some of the most common actions that are recorded as events in th
{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
#### `team` category actions
### `team` category actions
| Action | Description
|------------------|-------------------
@@ -237,7 +237,7 @@ An overview of some of the most common actions that are recorded as events in th
{% endif %}
{% if currentVersion != "github-ae@latest" %}
#### `two_factor_authentication` category actions
### `two_factor_authentication` category actions
| Action | Description
|------------------|-------------------
@@ -245,7 +245,7 @@ An overview of some of the most common actions that are recorded as events in th
| `disabled` | Triggered when two-factor authentication is disabled.
{% endif %}
#### `user` category actions
### `user` category actions
| Action | Description
|--------------------|---------------------
@@ -265,7 +265,7 @@ An overview of some of the most common actions that are recorded as events in th
| `show_private_contributions_count` | Triggered when you [publicize private contributions on your profile](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile).{% if currentVersion != "github-ae@latest" %}
| `two_factor_requested` | Triggered when {% data variables.product.product_name %} asks you for [your two-factor authentication code](/articles/accessing-github-using-two-factor-authentication).{% endif %}
#### `user_status` category actions
### `user_status` category actions
| Action | Description
|--------------------|---------------------

2
content/github/authenticating-to-github/keeping-your-account-and-data-secure/sudo-mode.md
View File

@@ -15,6 +15,6 @@ After you've performed a sudo-protected action, you'll only be asked to re-authe
![Sudo Mode Dialog](/assets/images/help/settings/sudo_mode_popup.png)
### Further reading
## Further reading
- [Unix `sudo` command](http://en.wikipedia.org/wiki/Sudo)

12
content/github/authenticating-to-github/keeping-your-account-and-data-secure/updating-your-github-access-credentials.md
View File

@@ -15,7 +15,7 @@ topics:
- Access management
---
{% if currentVersion != "github-ae@latest" %}
### Requesting a new password
## Requesting a new password
1. To request a new password, visit {% if currentVersion == "free-pro-team@latest" %}https://{% data variables.product.product_url %}/password_reset{% else %}`https://{% data variables.product.product_url %}/password_reset`{% endif %}.
2. Enter the email address associated with your personal {% data variables.product.product_name %} account, then click **Send password reset email.** The email will be sent to the backup email address if you have one configured.
@@ -33,7 +33,7 @@ To avoid losing your password in the future, we suggest using a secure password
{% endtip %}
### Changing an existing password
## Changing an existing password
{% data reusables.repositories.blocked-passwords %}
@@ -49,20 +49,20 @@ For greater security, enable two-factor authentication in addition to changing y
{% endtip %}
{% endif %}
### Updating your access tokens
## Updating your access tokens
See "[Reviewing your authorized integrations](/articles/reviewing-your-authorized-integrations)" for instructions on reviewing and deleting access tokens. To generate new access tokens, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)."
### Updating your SSH keys
## Updating your SSH keys
See "[Reviewing your SSH keys](/articles/reviewing-your-ssh-keys)" for instructions on reviewing and deleting SSH keys. To generate and add new SSH keys, see "[Generating an SSH key](/articles/generating-an-ssh-key)."
### Resetting API tokens
## Resetting API tokens
If you have any applications registered with {% data variables.product.product_name %}, you'll want to reset their OAuth tokens. For more information, see the "[Reset an authorization](/rest/reference/apps#reset-an-authorization)" endpoint.
{% if currentVersion != "github-ae@latest" %}
### Preventing unauthorized access
## Preventing unauthorized access
For more tips on securing your account and preventing unauthorized access, see "[Preventing unauthorized access](/articles/preventing-unauthorized-access)."
{% endif %}

14
content/github/authenticating-to-github/managing-commit-signature-verification/about-commit-signature-verification.md
View File

@@ -14,7 +14,7 @@ topics:
- Identity
- Access management
---
### About commit signature verification
## About commit signature verification
You can sign commits and tags locally, to give other people confidence about the origin of a change you have made. If a commit or tag has a GPG or S/MIME signature that is cryptographically verifiable, GitHub marks the commit or tag {% if currentVersion == "free-pro-team@latest" %}"Verified" or "Partially verified."{% else %}"Verified."{% endif %}
@@ -25,7 +25,7 @@ Commits and tags have the following verification statuses, depending on whether
{% data reusables.identity-and-permissions.vigilant-mode-beta-note %}
#### Default statuses
### Default statuses
| Status | Description |
| -------------- | ----------- |
@@ -33,7 +33,7 @@ Commits and tags have the following verification statuses, depending on whether
| **Unverified** | The commit is signed but the signature could not be verified.
| No verification status | The commit is not signed.
#### Statuses with vigilant mode enabled
### Statuses with vigilant mode enabled
{% data reusables.identity-and-permissions.vigilant-mode-verification-statuses %}
@@ -49,7 +49,7 @@ Repository administrators can enforce required commit signing on a branch to blo
{% data variables.product.product_name %} will automatically use GPG to sign commits you make using the {% data variables.product.product_name %} web interface, except for when you squash and merge a pull request that you are not the author of. Commits signed by {% data variables.product.product_name %} will have a verified status on {% data variables.product.product_name %}. You can verify the signature locally using the public key available at https://github.com/web-flow.gpg. The full fingerprint of the key is `5DE3 E050 9C47 EA3C F04A 42D3 4AEE 18F8 3AFD EB23`. You can optionally choose to have {% data variables.product.product_name %} sign commits you make in {% data variables.product.prodname_codespaces %}. For more information about enabling GPG verification for your codespaces, see "[Managing GPG verification for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces)."
{% endif %}
### GPG commit signature verification
## GPG commit signature verification
You can use GPG to sign commits with a GPG key that you generate yourself.
@@ -64,7 +64,7 @@ To sign commits using GPG and have those commits verified on {% data variables.p
5. [Sign commits](/articles/signing-commits)
6. [Sign tags](/articles/signing-tags)
### S/MIME commit signature verification
## S/MIME commit signature verification
You can use S/MIME to sign commits with an X.509 key issued by your organization.
@@ -81,14 +81,14 @@ To sign commits using S/MIME and have those commits verified on {% data variable
You don't need to upload your public key to {% data variables.product.product_name %}.
{% if currentVersion == "free-pro-team@latest" %}
### Signature verification for bots
## Signature verification for bots
Organizations and {% data variables.product.prodname_github_app %}s that require commit signing can use bots to sign commits. If a commit or tag has a bot signature that is cryptographically verifiable, {% data variables.product.product_name %} marks the commit or tag as verified.
Signature verification for bots will only work if the request is verified and authenticated as the {% data variables.product.prodname_github_app %} or bot and contains no custom author information, custom committer information, and no custom signature information, such as Commits API.
{% endif %}
### Further reading
## Further reading
- "[Signing commits](/articles/signing-commits)"
- "[Signing tags](/articles/signing-tags)"

4
content/github/authenticating-to-github/managing-commit-signature-verification/adding-a-new-gpg-key-to-your-github-account.md
View File

@@ -20,7 +20,7 @@ Before adding a new GPG key to your {% data variables.product.product_name %} ac
When verifying a signature, we extract the signature and attempt to parse its key-id. We match the key-id with keys uploaded to {% data variables.product.product_name %}. Until you upload your GPG key to {% data variables.product.product_name %}, we cannot verify your signatures.
### Adding a GPG key
## Adding a GPG key
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.ssh %}
@@ -32,7 +32,7 @@ When verifying a signature, we extract the signature and attempt to parse its ke
![The Add key button](/assets/images/help/settings/gpg-add-key.png)
6. To confirm the action, enter your {% data variables.product.product_name %} password.
### Further reading
## Further reading
* "[Checking for existing GPG keys](/articles/checking-for-existing-gpg-keys)"
* "[Generating a new GPG key](/articles/generating-a-new-gpg-key)"

2
content/github/authenticating-to-github/managing-commit-signature-verification/associating-an-email-with-your-gpg-key.md
View File

@@ -49,7 +49,7 @@ If you're using a GPG key that matches your committer identity and your verified
```
11. Upload the GPG key by [adding it to your GitHub account](/articles/adding-a-new-gpg-key-to-your-github-account).
### Further reading
## Further reading
- "[Checking for existing GPG keys](/articles/checking-for-existing-gpg-keys)"
- "[Generating a new GPG key](/articles/generating-a-new-gpg-key)"

2
content/github/authenticating-to-github/managing-commit-signature-verification/checking-for-existing-gpg-keys.md
View File

@@ -26,7 +26,7 @@ topics:
* If there are no GPG key pairs or you don't want to use any that are available for signing commits and tags, then [generate a new GPG key](/articles/generating-a-new-gpg-key).
* If there's an existing GPG key pair and you want to use it to sign commits and tags, then [add your GPG key to your GitHub account](/articles/adding-a-new-gpg-key-to-your-github-account).
### Further reading
## Further reading
* "[Generating a new GPG key](/articles/generating-a-new-gpg-key)"
* "[Adding a new GPG key to your GitHub account](/articles/adding-a-new-gpg-key-to-your-github-account)"

4
content/github/authenticating-to-github/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits.md
View File

@@ -12,7 +12,7 @@ redirect_from:
---
{% data reusables.identity-and-permissions.vigilant-mode-beta-note %}
### About vigilant mode
## About vigilant mode
When you work locally on your computer, Git allows you to set the author of your changes and the identity of the committer. This, potentially, makes it difficult for other people to be confident that commits and tags you create were actually created by you. To help solve this problem you can sign your commits and tags. For more information, see "[Signing commits](/github/authenticating-to-github/signing-commits)" and "[Signing tags](/github/authenticating-to-github/signing-tags)." {% data variables.product.prodname_dotcom %} marks signed commits and tags with a verification status.
@@ -28,7 +28,7 @@ You should only enable vigilant mode if you sign all of your commits and tags. A
{% data reusables.identity-and-permissions.verification-status-check %}
### Enabling vigilant mode
## Enabling vigilant mode
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.ssh %}

4
content/github/authenticating-to-github/managing-commit-signature-verification/generating-a-new-gpg-key.md
View File

@@ -14,7 +14,7 @@ topics:
---
{% data reusables.gpg.supported-gpg-key-algorithms %}
### Generating a GPG key
## Generating a GPG key
{% note %}
@@ -56,7 +56,7 @@ topics:
11. Copy your GPG key, beginning with `-----BEGIN PGP PUBLIC KEY BLOCK-----` and ending with `-----END PGP PUBLIC KEY BLOCK-----`.
12. [Add the GPG key to your GitHub account](/articles/adding-a-new-gpg-key-to-your-github-account).
### Further reading
## Further reading
* "[Checking for existing GPG keys](/articles/checking-for-existing-gpg-keys)"
* "[Adding a new GPG key to your GitHub account](/articles/adding-a-new-gpg-key-to-your-github-account)"

2
content/github/authenticating-to-github/managing-commit-signature-verification/signing-commits.md
View File

@@ -48,7 +48,7 @@ If you have multiple keys or are attempting to sign commits or tags with a key t
5. To view more detailed information about the verified signature, click Verified.
![Signed commit](/assets/images/help/commits/gpg-signed-commit-verified-without-details.png)
### Further reading
## Further reading
* "[Checking for existing GPG keys](/articles/checking-for-existing-gpg-keys)"
* "[Generating a new GPG key](/articles/generating-a-new-gpg-key)"

2
content/github/authenticating-to-github/managing-commit-signature-verification/signing-tags.md
View File

@@ -26,7 +26,7 @@ topics:
# Verifies the signed tag
```
### Further reading
## Further reading
- "[Viewing your repository's tags](/articles/viewing-your-repositorys-tags)"
- "[Checking for existing GPG keys](/articles/checking-for-existing-gpg-keys)"

8
content/github/authenticating-to-github/managing-commit-signature-verification/telling-git-about-your-signing-key.md
View File

@@ -15,7 +15,7 @@ topics:
---
{% mac %}
### Telling Git about your GPG key
## Telling Git about your GPG key
If you're using a GPG key that matches your committer identity and your verified email address associated with your {% data variables.product.product_name %} account, then you can begin signing commits and signing tags.
@@ -48,7 +48,7 @@ If you have multiple GPG keys, you need to tell Git which one to use.
{% windows %}
### Telling Git about your GPG key
## Telling Git about your GPG key
If you're using a GPG key that matches your committer identity and your verified email address associated with your {% data variables.product.product_name %} account, then you can begin signing commits and signing tags.
@@ -77,7 +77,7 @@ If you have multiple GPG keys, you need to tell Git which one to use.
{% endnote %}
### Telling Git about your GPG key
## Telling Git about your GPG key
If you're using a GPG key that matches your committer identity and your verified email address associated with your {% data variables.product.product_name %} account, then you can begin signing commits and signing tags.
@@ -106,7 +106,7 @@ If you have multiple GPG keys, you need to tell Git which one to use.
{% endlinux %}
### Further reading
## Further reading
- "[Checking for existing GPG keys](/articles/checking-for-existing-gpg-keys)"
- "[Generating a new GPG key](/articles/generating-a-new-gpg-key)"

4
content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication.md
View File

@@ -20,7 +20,7 @@ We **strongly** urge you to enable 2FA for the safety of your account, not only
For more information, see "[Accessing {% data variables.product.prodname_dotcom %} using two-factor authentication](/articles/accessing-github-using-two-factor-authentication)."
### Two-factor authentication recovery codes
## Two-factor authentication recovery codes
{% data reusables.two_fa.about-recovery-codes %} For more information, see "[Recovering your account if you lose your 2FA credentials](/articles/recovering-your-account-if-you-lose-your-2fa-credentials)."
@@ -34,7 +34,7 @@ For more information, see "[Accessing {% data variables.product.prodname_dotcom
{% endif %}
### Requiring two-factor authentication in your organization
## Requiring two-factor authentication in your organization
Organization owners can require that organization members{% if currentVersion == "free-pro-team@latest" %}, billing managers,{% endif %} and outside collaborators use two-factor authentication to secure their personal accounts. For more information, see "[Requiring two-factor authentication in your organization](/articles/requiring-two-factor-authentication-in-your-organization)."

18
content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication.md
View File

@@ -15,13 +15,13 @@ topics:
---
With two-factor authentication enabled, you'll need to provide an authentication code when accessing {% data variables.product.product_name %} through your browser. If you access {% data variables.product.product_name %} using other methods, such as the API or the command line, you'll need to use an alternative form of authentication. For more information, see "[About authentication to {% data variables.product.prodname_dotcom %}](/github/authenticating-to-github/about-authentication-to-github)."
### Providing a 2FA code when signing in to the website
## Providing a 2FA code when signing in to the website
After you sign in to {% data variables.product.product_name %} using your password, you'll be prompted to provide an authentication code from {% if currentVersion == "free-pro-team@latest" %}a text message or{% endif %} your TOTP app.
{% data variables.product.product_name %} will only ask you to provide your 2FA authentication code again if you've logged out, are using a new device, or your session expires.
#### Generating a code through a TOTP application
### Generating a code through a TOTP application
If you chose to set up two-factor authentication using a TOTP application on your smartphone, you can generate an authentication code for {% data variables.product.product_name %} at any time. In most cases, just launching the application will generate a new code. You should refer to your application's documentation for specific instructions.
@@ -29,17 +29,17 @@ If you delete the mobile application after configuring two-factor authentication
{% if currentVersion == "free-pro-team@latest" %}
#### Receiving a text message
### Receiving a text message
If you set up two-factor authentication via text messages, {% data variables.product.product_name %} will send you a text message with your authentication code.
{% endif %}
### Using two-factor authentication with the command line
## Using two-factor authentication with the command line
After you've enabled 2FA, you must use a personal access token or SSH key instead of your password when accessing {% data variables.product.product_name %} on the command line.
#### Authenticating on the command line using HTTPS
### Authenticating on the command line using HTTPS
After you've enabled 2FA, you must create a personal access token to use as a password when authenticating to {% data variables.product.product_name %} on the command line using HTTPS URLs.
@@ -47,21 +47,21 @@ When prompted for a username and password on the command line, use your {% data
For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)."
#### Authenticating on the command line using SSH
### Authenticating on the command line using SSH
Enabling 2FA doesn't change how you authenticate to {% data variables.product.product_name %} on the command line using SSH URLs. For more information about setting up and using an SSH key, see "[Connecting to {% data variables.product.prodname_dotcom %} with SSH](/articles/connecting-to-github-with-ssh/)."
### Using two-factor authentication to access a repository using Subversion
## Using two-factor authentication to access a repository using Subversion
When you access a repository via Subversion, you must provide a personal access token instead of entering your password. For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)."
### Troubleshooting
## Troubleshooting
If you lose access to your two-factor authentication credentials, you can use your recovery codes or another recovery method (if you've set one up) to regain access to your account. For more information, see "[Recovering your account if you lose your 2FA credentials](/articles/recovering-your-account-if-you-lose-your-2fa-credentials)."
If your authentication fails several times, you may wish to synchronize your phone's clock with your mobile provider. Often, this involves checking the "Set automatically" option on your phone's clock, rather than providing your own time zone.
### Further reading
## Further reading
- "[About two-factor authentication](/articles/about-two-factor-authentication)"
- "[Configuring two-factor authentication](/articles/configuring-two-factor-authentication)"

2
content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/changing-two-factor-authentication-delivery-methods-for-your-mobile-device.md
View File

@@ -26,7 +26,7 @@ topics:
- To set up two-factor authentication using a TOTP mobile app, click **Set up using an app**.
- To set up two-factor authentication using text message (SMS), click **Set up using SMS**.
### Further reading
## Further reading
- "[About two-factor authentication](/articles/about-two-factor-authentication)"
- "[Configuring two-factor authentication recovery methods](/articles/configuring-two-factor-authentication-recovery-methods)"

16
content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication-recovery-methods.md
View File

@@ -17,7 +17,7 @@ topics:
---
In addition to securely storing your two-factor authentication recovery codes, we strongly recommend configuring one or more additional recovery methods.
### Downloading your two-factor authentication recovery codes
## Downloading your two-factor authentication recovery codes
{% data reusables.two_fa.about-recovery-codes %} You can also download your recovery codes at any point after enabling two-factor authentication.
@@ -37,7 +37,7 @@ If you generate new recovery codes or disable and re-enable 2FA, the recovery co
- To copy your recovery codes for storage in a password manager, click **Copy**.
![List of recovery codes with option to download, print, or copy the codes](/assets/images/help/2fa/download-print-or-copy-recovery-codes-before-continuing.png)
### Generating a new set of recovery codes
## Generating a new set of recovery codes
Once you use a recovery code to regain access to your account, it cannot be reused. If you've used all 16 recovery codes, you can generate another list of codes. Generating a new set of recovery codes will invalidate any codes you previously generated.
@@ -47,13 +47,13 @@ Once you use a recovery code to regain access to your account, it cannot be reus
3. To create another batch of recovery codes, click **Generate new recovery codes**.
![Generate new recovery codes button](/assets/images/help/2fa/generate-new-recovery-codes.png)
### Configuring a security key as an additional two-factor authentication method
## Configuring a security key as an additional two-factor authentication method
You can set up a security key as a secondary two-factor authentication method, and use the security key to regain access to your account. For more information, see "[Configuring two-factor authentication](/articles/configuring-two-factor-authentication#configuring-two-factor-authentication-using-a-security-key)."
{% if currentVersion == "free-pro-team@latest" %}
### Setting a fallback authentication number
## Setting a fallback authentication number
You can provide a second number for a fallback device. If you lose access to both your primary device and your recovery codes, a backup SMS number can get you back in to your account.
@@ -78,11 +78,11 @@ You can use a fallback number regardless of whether you've configured authentica
After setup, the backup device will receive a confirmation SMS.
### Adding a fallback authentication method with Recover Accounts Elsewhere
## Adding a fallback authentication method with Recover Accounts Elsewhere
You can generate an extra authentication credential for your account and store it with a partner recovery provider.
#### About Recover Accounts Elsewhere
### About Recover Accounts Elsewhere
With Recover Accounts Elsewhere, you can add an extra security factor to your {% data variables.product.product_name %} account in case you lose access to your two-factor authentication method or recovery codes.
@@ -94,7 +94,7 @@ After you retrieve your token, {% data variables.contact.contact_support %} may
When you generate or retrieve an account recovery token, an event is added to your account's audit log. For more information, see "[Reviewing your security log](/articles/reviewing-your-security-log)."
#### Generating and storing an account recovery token
### Generating and storing an account recovery token
You can generate an account recovery token and store it with a partner recovery provider.
@@ -108,7 +108,7 @@ You can generate an account recovery token and store it with a partner recovery
{% endif %}
### Further reading
## Further reading
- "[About two-factor authentication](/articles/about-two-factor-authentication)"
- "[Configuring two-factor authentication](/articles/configuring-two-factor-authentication)"

8
content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication.md
View File

@@ -25,7 +25,7 @@ We strongly recommend using a time-based one-time password (TOTP) application to
{% endwarning %}
### Configuring two-factor authentication using a TOTP mobile app
## Configuring two-factor authentication using a TOTP mobile app
A time-based one-time password (TOTP) application automatically generates an authentication code that changes after a certain period of time. We recommend using cloud-based TOTP apps such as:
- [1Password](https://support.1password.com/one-time-passwords/)
@@ -56,7 +56,7 @@ A time-based one-time password (TOTP) application automatically generates an aut
{% if currentVersion == "free-pro-team@latest" %}
### Configuring two-factor authentication using text messages
## Configuring two-factor authentication using text messages
If you're unable to authenticate using a TOTP mobile app, you can authenticate using SMS messages. You can also provide a second number for a fallback device. If you lose access to both your primary device and your recovery codes, a backup SMS number can get you back in to your account.
@@ -81,7 +81,7 @@ Before using this method, be sure that you can receive text messages. Carrier ra
{% endif %}
### Configuring two-factor authentication using a security key
## Configuring two-factor authentication using a security key
{% data reusables.two_fa.after-2fa-add-security-key %}
@@ -105,7 +105,7 @@ Authentication with a security key is *secondary* to authentication with a TOTP
![Download recovery codes button](/assets/images/help/2fa/2fa-recover-during-setup.png)
{% data reusables.two_fa.test_2fa_immediately %}
### Further reading
## Further reading
- "[About two-factor authentication](/articles/about-two-factor-authentication)"
- "[Configuring two-factor authentication recovery methods](/articles/configuring-two-factor-authentication-recovery-methods)"

4
content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/countries-where-sms-authentication-is-supported.md
View File

@@ -11,7 +11,7 @@ topics:
---
If we don't support two-factor authentication via text message for your country of residence, you can set up authentication via a TOTP mobile application. For more information, see "[Configuring two-factor authentication](/articles/configuring-two-factor-authentication)."
### Supported countries for SMS authentication
## Supported countries for SMS authentication
If your country is not on this list, then we aren't currently able to reliably deliver text messages to your country. We update this list periodically.
@@ -131,6 +131,6 @@ If your country is not on this list, then we aren't currently able to reliably d
<li>Venezuela</li>
</ul>
### Further reading
## Further reading
- "[About two-factor authentication](/articles/about-two-factor-authentication)"

2
content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/disabling-two-factor-authentication-for-your-personal-account.md
View File

@@ -29,7 +29,7 @@ To remove yourself from your organization:
3. Click **Disable**.
![Disable two-factor authentication button](/assets/images/help/2fa/disable-two-factor-authentication.png)
### Further reading
## Further reading
- "[About two-factor authentication](/articles/about-two-factor-authentication)"
- "[Configuring two-factor authentication](/articles/configuring-two-factor-authentication)"

12
content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials.md
View File

@@ -22,7 +22,7 @@ topics:
{% endif %}
### Using a two-factor authentication recovery code
## Using a two-factor authentication recovery code
Use one of your recovery codes to automatically regain entry into your account. You may have saved your recovery codes to a password manager or your computer's downloads folder. The default filename for recovery codes is `github-recovery-codes.txt`. For more information about recovery codes, see "[Configuring two-factor authentication recovery methods](/articles/configuring-two-factor-authentication-recovery-methods#downloading-your-two-factor-authentication-recovery-codes)."
@@ -35,17 +35,17 @@ Use one of your recovery codes to automatically regain entry into your account.
![Field to type a recovery code and Verify button](/assets/images/help/2fa/2fa-type-verify-recovery-code.png)
{% if currentVersion == "free-pro-team@latest" %}
### Authenticating with a fallback number
## Authenticating with a fallback number
If you lose access to your primary TOTP app or phone number, you can provide a two-factor authentication code sent to your fallback number to automatically regain access to your account.
{% endif %}
### Authenticating with a security key
## Authenticating with a security key
If you configured two-factor authentication using a security key, you can use your security key as a secondary authentication method to automatically regain access to your account. For more information, see "[Configuring two-factor authentication](/articles/configuring-two-factor-authentication#configuring-two-factor-authentication-using-a-security-key)."
{% if currentVersion == "free-pro-team@latest" %}
### Authenticating with a verified device, SSH token, or personal access token
## Authenticating with a verified device, SSH token, or personal access token
If you know your {% data variables.product.product_name %} password but don't have the two-factor authentication credentials or your two-factor authentication recovery codes, you can have a one-time password sent to your verified email address to begin the verification process and regain access to your account.
@@ -74,7 +74,7 @@ You can use your two-factor authentication credentials or two-factor authenticat
![Alternative verification buttons](/assets/images/help/2fa/alt-verifications.png)
8. A member of {% data variables.contact.github_support %} will review your request and email you within 3-5 business days. If your request is approved, you'll receive a link to complete your account recovery process. If your request is denied, the email will include a way to contact support with any additional questions.
### Authenticating with an account recovery token
## Authenticating with an account recovery token
If you lose access to the two-factor authentication methods for your {% data variables.product.product_name %} account, you can retrieve your account recovery token from a partner recovery provider and ask {% data variables.product.prodname_dotcom %} Support to review it.
@@ -98,7 +98,7 @@ If you're unable to regain access to your account, generate a one-time password
4. Contact {% data variables.contact.contact_support %} to let them know that your account recovery token is ready for review.
{% endif %}
### Further reading
## Further reading
- "[About two-factor authentication](/articles/about-two-factor-authentication)"
- "[Configuring two-factor authentication](/articles/configuring-two-factor-authentication)"

6
content/github/authenticating-to-github/troubleshooting-commit-signature-verification/checking-your-commit-and-tag-signature-verification-status.md
View File

@@ -13,7 +13,7 @@ topics:
- Identity
- Access management
---
### Checking your commit signature verification status
## Checking your commit signature verification status
1. On {% data variables.product.product_name %}, navigate to your pull request.
{% data reusables.repositories.review-pr-commits %}
@@ -22,7 +22,7 @@ topics:
4. To view more detailed information about the commit signature, click **Verified**{% if currentVersion == "free-pro-team@latest" %}, **Partially verified**,{% endif %} or **Unverified**.
![Verified signed commit](/assets/images/help/commits/gpg-signed-commit_verified_details.png)
### Checking your tag signature verification status
## Checking your tag signature verification status
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.releases %}
@@ -33,7 +33,7 @@ topics:
4. To view more detailed information about the tag signature, click **Verified**{% if currentVersion == "free-pro-team@latest" %}, **Partially verified**,{% endif %} or **Unverified**.
![Verified signed tag](/assets/images/help/commits/gpg-signed-tag-verified-details.png)
### Further reading
## Further reading
- "[About commit signature verification](/articles/about-commit-signature-verification)"
- "[Signing commits](/articles/signing-commits)"

2
content/github/authenticating-to-github/troubleshooting-commit-signature-verification/updating-an-expired-gpg-key.md
View File

@@ -16,6 +16,6 @@ If your key is expired, you must [update the expiration](https://www.gnupg.org/g
If your key is invalid and you don't use another valid key in your key set, but instead generate a new GPG key with a new set of credentials, then your commits made with the revoked or expired key will continue to show as unverified. Also, your new credentials will not be able to resign or verify your old commits and tags.
### Further reading
## Further reading
- "[About commit signature verification](/articles/about-commit-signature-verification)"

2
content/github/authenticating-to-github/troubleshooting-commit-signature-verification/using-a-verified-email-address-in-your-gpg-key.md
View File

@@ -19,6 +19,6 @@ Commits and tags may contain several email addresses. For commits, there is the
If you need to change your committer or tagger email address, see "[Setting your commit email address](/articles/setting-your-commit-email-address/)."
### Further reading
## Further reading
- "[About commit signature verification](/articles/about-commit-signature-verification)"

2
content/github/authenticating-to-github/troubleshooting-ssh/error-agent-admitted-failure-to-sign.md
View File

@@ -24,7 +24,7 @@ $ ssh -vT git@{% data variables.command_line.codeblock %}
For more details, see <a href="https://bugs.launchpad.net/ubuntu/+source/gnome-keyring/+bug/201786" data-proofer-ignore>this issue report</a>.
### Resolution
## Resolution
You should be able to fix this error by loading your keys into your SSH agent with `ssh-add`:

10
content/github/authenticating-to-github/troubleshooting-ssh/error-bad-file-number.md
View File

@@ -22,9 +22,9 @@ $ ssh -vT git@{% data variables.command_line.codeblock %}
> ssh: connect to host {% data variables.command_line.codeblock %} port 22: Bad file number
```
### Solving the issue
## Solving the issue
#### Use HTTPS
### Use HTTPS
Often, the simplest solution is to simply avoid SSH entirely. Most firewalls and proxies allow HTTPS traffic without issue. To take advantage of this, change [the remote URL](/github/getting-started-with-github/about-remote-repositories) you're using:
@@ -37,13 +37,13 @@ $ git clone https://{% data variables.command_line.codeblock %}/<em>username</em
> Unpacking objects: 100% (84/84), done.
```
#### Test from a different network
### Test from a different network
If you can connect the computer to another network that doesn't have a firewall, you can try testing your SSH connection to {% data variables.product.product_name %}. If everything works as it should, contact your network administrator for help on changing the firewall settings to allow your SSH connection to {% data variables.product.product_name %} to succeed.
{% if currentVersion == "free-pro-team@latest" %}
#### Using SSH over the HTTPS port
### Using SSH over the HTTPS port
If using HTTPS is not an option, and your firewall admin refuses to allow SSH connections, you can try using [SSH over the HTTPS port](/articles/using-ssh-over-the-https-port) instead.
@@ -51,7 +51,7 @@ If using HTTPS is not an option, and your firewall admin refuses to allow SSH co
{% if currentVersion == "free-pro-team@latest" %}
### Further reading
## Further reading
- "[Troubleshooting connectivity problems](/articles/troubleshooting-connectivity-problems)"

6
content/github/authenticating-to-github/troubleshooting-ssh/error-key-already-in-use.md
View File

@@ -11,7 +11,7 @@ versions:
topics:
- SSH
---
### Finding where the key has been used
## Finding where the key has been used
To determine where the key has already been used, open a terminal and type the `ssh` command. Use the `-i` flag to provide the path to the key you want to check:
@@ -24,12 +24,12 @@ $ ssh -T -ai <em>~/.ssh/id_rsa</em> git@{% data variables.command_line.codeblock
The *username* in the response is the {% data variables.product.product_name %} account that the key is currently attached to. If the response looks something like "username/repo", the key has been attached to a repository as a [*deploy key*](/guides/managing-deploy-keys#deploy-keys).
### Fixing the issue
## Fixing the issue
To resolve the issue, first remove the key from the other account or repository and then [add it to your account](/articles/adding-a-new-ssh-key-to-your-github-account).
If you don't have permissions to transfer the key, and can't contact a user who does, remove the keypair and [generate a brand new one](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent).
### Deploy keys
## Deploy keys
Once a key has been attached to one repository as a deploy key, it cannot be used on another repository. If you're running into this error while setting up deploy keys, see "[Managing deploy keys](/guides/managing-deploy-keys)."

12
content/github/authenticating-to-github/troubleshooting-ssh/error-permission-denied-publickey.md
View File

@@ -11,11 +11,11 @@ versions:
topics:
- SSH
---
### Should the `sudo` command be used with Git?
## Should the `sudo` command be used with Git?
You should not be using the `sudo` command with Git. If you have a *very good reason* you must use `sudo`, then ensure you are using it with every command (it's probably just better to use `su` to get a shell as root at that point). If you [generate SSH keys](/articles/generating-an-ssh-key) without `sudo` and then try to use a command like `sudo git push`, you won't be using the same keys that you generated.
### Check that you are connecting to the correct server
## Check that you are connecting to the correct server
Typing is hard, we all know it. Pay attention to what you type; you won't be able to connect to "githib.com" or "guthub.com". In some cases, a corporate network may cause issues resolving the DNS record as well.
@@ -32,7 +32,7 @@ $ ssh -vT git@{% data variables.command_line.codeblock %}
The connection should be made on port 22{% if currentVersion == "free-pro-team@latest" %}, unless you're overriding settings to use [SSH over HTTPS](/articles/using-ssh-over-the-https-port){% endif %}.
### Always use the "git" user
## Always use the "git" user
All connections, including those for remote URLs, must be made as the "git" user. If you try to connect with your {% data variables.product.product_name %} username, it will fail:
@@ -49,7 +49,7 @@ $ ssh -T git@{% data variables.command_line.codeblock %}
> Hi <em>username</em>! You've successfully authenticated...
```
### Make sure you have a key that is being used
## Make sure you have a key that is being used
{% mac %}
@@ -145,7 +145,7 @@ The `ssh-add` command *should* print out a long string of numbers and letters. I
{% endtip %}
#### Getting more details
### Getting more details
You can also check that the key is being used by trying to connect to `git@{% data variables.command_line.backticks %}`:
@@ -177,7 +177,7 @@ $ ssh -vT git@{% data variables.command_line.codeblock %}
> debug1: Offering RSA public key: /Users/<em>you</em>/.ssh/id_rsa
```
### Verify the public key is attached to your account
## Verify the public key is attached to your account
You must provide your public key to {% data variables.product.product_name %} to establish a secure connection.

4
content/github/authenticating-to-github/troubleshooting-ssh/error-ssh-add-illegal-option----k.md
View File

@@ -14,7 +14,7 @@ topics:
---
The `-K` option is in Apple's standard version of `ssh-add`, which stores the passphrase in your keychain for you when you add an ssh key to the ssh-agent. If you have installed a different version of `ssh-add`, it may lack support for `-K`.
### Solving the issue
## Solving the issue
To add your SSH private key to the ssh-agent, you can specify the path to the Apple version of `ssh-add`:
@@ -28,7 +28,7 @@ To add your SSH private key to the ssh-agent, you can specify the path to the Ap
{% endnote %}
### Further reading
## Further reading
- "[Generating a new SSH key and adding it to the ssh-agent](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)"
- [Linux man page for SSH-ADD](http://man7.org/linux/man-pages/man1/ssh-add.1.html)

6
content/github/authenticating-to-github/troubleshooting-ssh/error-unknown-key-type.md
View File

@@ -10,15 +10,15 @@ topics:
redirect_from:
- /github/authenticating-to-github/error-unknown-key-type
---
### About the `unknown key type` error
## About the `unknown key type` error
When you generate a new SSH key, you may receive an `unknown key type` error if your SSH client does not support the key type that you specify.{% mac %}To solve this issue on macOS, you can update your SSH client or install a new SSH client.
### Prerequisites
## Prerequisites
You must have Homebrew installed. For more information, see the [installation guide](https://docs.brew.sh/Installation) in the Homebrew documentation.
### Solving the issue
## Solving the issue
{% warning %}

2
content/github/authenticating-to-github/troubleshooting-ssh/error-were-doing-an-ssh-key-audit.md
View File

@@ -22,6 +22,6 @@ to approve this key so we know it's safe.
Fingerprint: ab:08:46:83:ff:f6:c4:f8:a9:4e:68:6b:94:17:f2:46
fatal: could not read from remote repository
```
### Solving the issue
## Solving the issue
To fix this, you need to [review your SSH keys](/articles/reviewing-your-ssh-keys) and either reject or approve the unverified key. Clicking the URL link in the error message brings you to the SSH Settings page, where the unverified SSH key is highlighted in the SSH key list.

2
content/github/authenticating-to-github/troubleshooting-ssh/using-ssh-over-the-https-port.md
View File

@@ -25,7 +25,7 @@ $ ssh -T -p 443 git@ssh.github.com
If that worked, great! If not, you may need to [follow our troubleshooting guide](/articles/error-permission-denied-publickey).
### Enabling SSH connections over HTTPS
## Enabling SSH connections over HTTPS
If you are able to SSH into `git@ssh.{% data variables.command_line.backticks %}` over port 443, you can override your SSH settings to force any connection to {% data variables.product.product_location %} to run though that server and port.

4
content/github/collaborating-with-pull-requests/addressing-merge-conflicts/about-merge-conflicts.md
View File

@@ -18,7 +18,7 @@ You must resolve all merge conflicts before you can merge a pull request on {% d
![merge conflict error message](/assets/images/help/pull_requests/merge_conflict_error_on_github.png)
### Resolving merge conflicts
## Resolving merge conflicts
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:
@@ -33,7 +33,7 @@ $ git merge <em>BRANCH-NAME</em>
> Automatic merge failed; fix conflicts and then commit the result
```
### Further reading
## Further reading
- "[About pull request merges](/articles/about-pull-request-merges/)"
- "[About pull requests](/articles/about-pull-requests/)"

2
content/github/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github.md
View File

@@ -62,6 +62,6 @@ If a site administrator disables the merge conflict editor for pull requests bet
{% endif %}
1. To merge your pull request, click **Merge pull request**. For more information about other pull request merge options, see "[Merging a pull request](/articles/merging-a-pull-request/)."
### Further reading
## Further reading
- "[About pull request merges](/articles/about-pull-request-merges)"

6
content/github/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md
View File

@@ -21,7 +21,7 @@ Merge conflicts occur when competing changes are made to the same line of a file
{% endtip %}
### Competing line change merge conflicts
## Competing line change merge conflicts
To resolve a merge conflict caused by competing line changes, you must choose which changes to incorporate from the different branches in a new commit.
@@ -73,7 +73,7 @@ For example, if you and another person both edited the file _styleguide.md_ on t
You can now merge the branches on the command line or [push your changes to your remote repository](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/) on {% data variables.product.product_name %} and [merge your changes](/articles/merging-a-pull-request/) in a pull request.
### Removed file merge conflicts
## Removed file merge conflicts
To resolve a merge conflict caused by competing changes to a file, where a person deletes a file in one branch and another person edits the same file, you must choose whether to delete or keep the removed file in a new commit.
@@ -122,7 +122,7 @@ For example, if you edited a file, such as *README.md*, and another person remov
You can now merge the branches on the command line or [push your changes to your remote repository](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/) on {% data variables.product.product_name %} and [merge your changes](/articles/merging-a-pull-request/) in a pull request.
### Further reading
## Further reading
- "[About merge conflicts](/articles/about-merge-conflicts)"
- "[Checking out pull requests locally](/articles/checking-out-pull-requests-locally/)"

6
content/github/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks.md
View File

@@ -23,7 +23,7 @@ You can see the overall state of the last commit to a branch on your repository'
{% data reusables.pull_requests.required-checks-must-pass-to-merge %}
### Types of status checks on {% data variables.product.product_name %}
## Types of status checks on {% data variables.product.product_name %}
There are two types of status checks on {% data variables.product.product_name %}:
@@ -34,7 +34,7 @@ _Checks_ are different from _statuses_ in that they provide line annotations, mo
Organization owners and users with push access to a repository can create checks and statuses with {% data variables.product.product_name %}'s API. For more information, see "[Checks](/rest/reference/checks)" and "[Statuses](/rest/reference/repos#statuses)."
### Checks
## Checks
When _checks_ are set up in a repository, pull requests have a **Checks** tab where you can view detailed build output from status checks and rerun failed checks.
@@ -48,7 +48,7 @@ You can navigate between the checks summaries for various commits in a pull requ
![Check summaries for different commits in a drop-down menu](/assets/images/help/pull_requests/checks-summary-for-various-commits.png)
#### Skipping and requesting checks for individual commits
### Skipping and requesting checks for individual commits
When a repository is set to automatically request checks for pushes, you can choose to skip checks for an individual commit you push. When a repository is _not_ set to automatically request checks for pushes, you can request checks for an individual commit you push. For more information on these settings, see "[Check Suites](/rest/reference/checks#update-repository-preferences-for-check-suites)."

6
content/github/collaborating-with-pull-requests/getting-started/about-collaborative-development-models.md
View File

@@ -13,7 +13,7 @@ versions:
topics:
- Pull requests
---
### Fork and pull model
## Fork and pull model
In the fork and pull model, anyone can fork an existing repository and push changes to their personal fork. You do not need permission to the source repository to push to a user-owned fork. The changes can be pulled into the source repository by the project maintainer. When you open a pull request proposing changes from your user-owned fork to a branch in the source (upstream) repository, you can allow anyone with push access to the upstream repository to make changes to your pull request. This model is popular with open source projects as it reduces the amount of friction for new contributors and allows people to work independently without upfront coordination.
@@ -23,11 +23,11 @@ In the fork and pull model, anyone can fork an existing repository and push chan
{% endtip %}
### Shared repository model
## Shared repository model
In the shared repository model, collaborators are granted push access to a single shared repository and topic branches are created when changes need to be made. Pull requests are useful in this model as they initiate code review and general discussion about a set of changes before the changes are merged into the main development branch. This model is more prevalent with small teams and organizations collaborating on private projects.
### Further reading
## Further reading
- "[About pull requests](/articles/about-pull-requests)"
- "[Creating a pull request from a fork](/articles/creating-a-pull-request-from-a-fork)"

10
content/github/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges.md
View File

@@ -15,11 +15,11 @@ topics:
---
{% data reusables.pull_requests.default_merge_option %}
### Squash and merge your pull request commits
## Squash and merge your pull request commits
{% data reusables.pull_requests.squash_and_merge_summary %}
#### Merge message for a squash merge
### Merge message for a squash merge
When you squash and merge, {% data variables.product.prodname_dotcom %} generates a commit message which you can change if you want to. The message default depends on whether the pull request contains multiple commits or just one.
@@ -28,7 +28,7 @@ Number of commits | Summary | Description |
One commit | The title of the commit message for the single commit, followed by the pull request number | The body text of the commit message for the single commit
More than one commit | The pull request title, followed by the pull request number | A list of the commit messages for all of the squashed commits, in date order
#### Squashing and merging a long-running branch
### Squashing and merging a long-running branch
If you plan to continue work on the [head branch](/github/getting-started-with-github/github-glossary#head-branch) of a pull request after the pull request is merged, we recommend you don't squash and merge the pull request.
@@ -36,7 +36,7 @@ When you create a pull request, {% data variables.product.prodname_dotcom %} ide
Because this commit is only on the base branch and not the head branch, the common ancestor of the two branches remains unchanged. If you continue to work on the head branch, then create a new pull request between the two branches, the pull request will include all of the commits since the common ancestor, including commits that you squashed and merged in the previous pull request. If there are no conflicts, you can safely merge these commits. However, this workflow makes merge conflicts more likely. If you continue to squash and merge pull requests for a long-running head branch, you will have to resolve the same conflicts repeatedly.
### Rebase and merge your pull request commits
## Rebase and merge your pull request commits
{% data reusables.pull_requests.rebase_and_merge_summary %}
@@ -52,7 +52,7 @@ If you still want to rebase the commits but can't rebase and merge automatically
Anyone with write permissions in the repository, can then [merge the changes](/articles/merging-a-pull-request/) using the rebase and merge button on {% data variables.product.product_location %}.
### Further reading
## Further reading
- "[About pull requests](/articles/about-pull-requests/)"
- "[Addressing merge conflicts](/articles/addressing-merge-conflicts)"

6
content/github/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request.md
View File

@@ -12,7 +12,7 @@ redirect_from:
- /github/collaborating-with-issues-and-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request
- /github/collaborating-with-issues-and-pull-requests/automatically-merging-a-pull-request
---
### About auto-merge
## About auto-merge
If you enable auto-merge for a pull request, the pull request will merge automatically when all required reviews are met and status checks have passed. Auto-merge prevents you from waiting around for requirements to be met, so you can move on to other tasks.
@@ -22,7 +22,7 @@ After you enable auto-merge for a pull request, if someone who does not have wri
You can provide feedback about auto-merge by [contacting us](https://support.github.com/contact/feedback?category=prs-and-code-review&subject=Pull%20request%20auto-merge%20feedback).
### Enabling auto-merge
## Enabling auto-merge
{% data reusables.pull_requests.auto-merge-requires-branch-protection %}
@@ -40,7 +40,7 @@ People with write permissions to a repository can enable auto-merge for a pull r
1. Click **Confirm auto-merge**.
![Button to confirm auto-merge](/assets/images/help/pull_requests/confirm-auto-merge-button.png)
### Disabling auto-merge
## Disabling auto-merge
People with write permissions to a repository and pull request authors can disable auto-merge for a pull request.

6
content/github/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request.md
View File

@@ -12,7 +12,7 @@ versions:
topics:
- Pull requests
---
### About pull request merges
## About pull request merges
In a pull request, you propose that changes you've made on a head branch should be merged into a base branch. By default, any pull request can be merged at any time, unless the head branch is in conflict with the base branch. However, there may be restrictions on when you can merge a pull request into a specific branch. For example, you may only be able to merge a pull request into the default branch if required status checks are passing. For more information, see "[About protected branches](/github/administering-a-repository/about-protected-branches)."
@@ -34,7 +34,7 @@ If you decide you don't want the changes in a topic branch to be merged to the u
{% endtip %}
{% endif %}
### Merging a pull request on {% data variables.product.prodname_dotcom %}
## Merging a pull request on {% data variables.product.prodname_dotcom %}
{% data reusables.repositories.sidebar-pr %}
2. In the "Pull Requests" list, click the pull request you'd like to merge.
@@ -82,7 +82,7 @@ Pull requests are merged using [the `--no-ff` option](https://git-scm.com/docs/g
{% data reusables.pull_requests.close-issues-using-keywords %}
### Further reading
## Further reading
- "[Reverting a pull request](/articles/reverting-a-pull-request)"
- "[Syncing your branch](/desktop/guides/contributing-to-projects/syncing-your-branch/)" using {% data variables.product.prodname_desktop %}

4
content/github/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/reverting-a-pull-request.md
View File

@@ -12,11 +12,11 @@ versions:
topics:
- Pull requests
---
### About reverting a pull request
## About reverting a pull request
Reverting a pull request on {% data variables.product.product_name %} creates a new pull request that contains one revert of the merge commit from the original merged pull request.
### Reverting a pull request
## Reverting a pull request
{% note %}

10
content/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches.md
View File

@@ -13,7 +13,7 @@ versions:
topics:
- Pull requests
---
### About branches
## About branches
Branches allow you to develop features, fix bugs, or safely experiment with new ideas in a contained area of your repository.
@@ -23,7 +23,7 @@ You can also use a branch to publish a {% data variables.product.prodname_pages
You must have write access to a repository to create a branch, open a pull request, or delete and restore branches in a pull request. For more information, see "[Access permissions on {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github/access-permissions-on-github)."
### About the default branch
## About the default branch
{% data reusables.branches.new-repo-default-branch %} The default branch is the branch that {% data variables.product.prodname_dotcom %} displays when anyone visits your repository. The default branch is also the initial branch that Git checks out locally when someone clones the repository. {% data reusables.branches.default-branch-automatically-base-branch %}
@@ -37,7 +37,7 @@ By default, {% data variables.product.product_name %} names the default branch {
{% endif %}
### Working with branches
## Working with branches
Once you're satisfied with your work, you can open a pull request to merge the changes in the current branch (the *head* branch) into another branch (the *base* branch). For more information, see "[About pull requests](/articles/about-pull-requests)."
@@ -58,7 +58,7 @@ In the next diagram, someone has merged the pull request for `feature1` into the
Now when you merge the `feature2` pull request, it'll be merged into the `master` branch.
{% endif %}
### Working with protected branches
## Working with protected branches
Repository administrators can enable protections on a branch. If you're working on a branch that's protected, you won't be able to delete or force push to the branch. Repository administrators can additionally enable several other protected branch settings to enforce various workflows before a branch can be merged.
@@ -79,7 +79,7 @@ When a branch is protected:
- 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 "[About commit signature verification](/articles/about-commit-signature-verification)" and "[About protected branches](/github/administering-a-repository/about-protected-branches#require-signed-commits)."{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
- 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 "[Resolving a merge conflict on {% data variables.product.prodname_dotcom %}](/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-on-github)."{% endif %}
### Further reading
## Further reading
- "[About pull requests](/articles/about-pull-requests)"
- "[Branch](/articles/github-glossary/#branch)" in the {% data variables.product.prodname_dotcom %} glossary

8
content/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests.md
View File

@@ -25,7 +25,7 @@ You can view proposed changes in a pull request in the Files changed tab.
Rather than viewing the commits themselves, you can view the proposed changes as they'll appear in the files once the pull request is merged. The files appear in alphabetical order within the Files changed tab. Additions to the files appear in green and are prefaced by a `+` sign while content that has been removed appears in red and is prefaced by a `-` sign.
### Diff view options
## Diff view options
{% tip %}
@@ -47,7 +47,7 @@ To simplify reviewing changes in a large pull request, you can filter the diff t
![File filter drop-down menu](/assets/images/help/pull_requests/file-filter-menu.png)
### Three-dot and two-dot Git diff comparisons
## Three-dot and two-dot Git diff comparisons
By default, pull requests on {% data variables.product.prodname_dotcom %} show a three-dot diff, or a comparison between the most recent version of the topic branch and the commit where the topic branch was last synced with the base branch.
@@ -61,11 +61,11 @@ If you want to simulate a two-dot diff in a pull request and see a comparison be
For more information about Git commands to compare changes, see "[Git diff options](https://git-scm.com/docs/git-diff#git-diff-emgitdiffemltoptionsgtltcommitgtltcommitgt--ltpathgt82308203)" from the _Pro Git_ book site.
### Reasons diffs will not display
## Reasons diffs will not display
- You've exceeded the total limit of files or certain file types. For more information, see "[Limits for viewing content and diffs in a repository](/articles/limits-for-viewing-content-and-diffs-in-a-repository/#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 "[Customizing how changed files appear on GitHub](/articles/customizing-how-changed-files-appear-on-github)."
### Further reading
## Further reading
- "[About pull requests](/articles/about-pull-requests)"
- "[About forks](/articles/about-forks)"

8
content/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md
View File

@@ -13,7 +13,7 @@ versions:
topics:
- Pull requests
---
### About pull requests
## About pull requests
{% note %}
@@ -49,7 +49,7 @@ After you're happy with the proposed changes, you can merge the pull request. If
You can visit your dashboard to quickly find links to recently updated pull requests you're working on or subscribed to. For more information, see "[About your personal dashboard](/articles/about-your-personal-dashboard)."
### Draft pull requests
## Draft pull requests
{% data reusables.gated-features.draft-prs %}
@@ -57,14 +57,14 @@ When you create a pull request, you can choose to create a pull request that is
{% data reusables.pull_requests.mark-ready-review %} You can convert a pull request to a draft at any time. For more information, see "[Changing the stage of a pull request](/articles/changing-the-stage-of-a-pull-request)."
### Differences between commits on compare and pull request pages
## Differences between commits on compare and pull request pages
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.
### Further reading
## Further reading
- "[Pull request](/articles/github-glossary/#pull-request)" in the {% data variables.product.prodname_dotcom %} glossary
- "[About branches](/articles/about-branches)"

2
content/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-base-branch-of-a-pull-request.md
View File

@@ -30,7 +30,7 @@ topics:
{% endtip %}
### Further reading
## Further reading
- "[Creating a pull request](/articles/creating-a-pull-request)"
- "[About pull requests](/articles/about-pull-requests)"

6
content/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request.md
View File

@@ -14,7 +14,7 @@ versions:
topics:
- Pull requests
---
### Marking a pull request as ready for review
## Marking a pull request as ready for review
{% data reusables.pull_requests.mark-ready-review %}
@@ -33,7 +33,7 @@ topics:
{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
### Converting a pull request to a draft
## Converting a pull request to a draft
You can convert a pull request to a draft at any time. For example, if you accidentally opened a pull request instead of a draft, or if you've received feedback on your pull request that needs to be addressed, you can convert the pull request to a draft to indicate further changes are needed. No one can merge the pull request until you mark the pull request as ready for review again. People who are already subscribed to notifications for the pull request will not be unsubscribed when you convert the pull request to a draft.
@@ -46,6 +46,6 @@ You can convert a pull request to a draft at any time. For example, if you accid
{% endif %}
### Further reading
## Further reading
- "[About pull requests](/github/collaborating-with-issues-and-pull-requests/about-pull-requests)"

2
content/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork.md
View File

@@ -87,6 +87,6 @@ Only the user who created the pull request can give you permission to push commi
Your new commits will be reflected on the original pull request on {% data variables.product.product_location %}.
### Further Reading
## Further Reading
- "[About forks](/articles/about-forks)"

2
content/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork.md
View File

@@ -33,7 +33,7 @@ You can also give the upstream repository's maintainers permission to push commi
{% data reusables.repositories.asking-for-review %}
### Further reading
## Further reading
- "[Working with forks](/articles/working-with-forks)"
- "[Allowing changes to a pull request branch created from a fork](/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork)"

Some files were not shown because too many files have changed in this diff Show More