Merge branch 'main' into 2fa-clarification
This commit is contained in:
Steve Guntrip
@@ -3,6 +3,7 @@ title: About merge methods on GitHub
|
||||
intro: 'You can allow contributors with push access to your repository to merge their pull requests on {% data variables.product.product_location %} with different merge options or enforce a specific merge method for all of your repository''s pull requests.'
|
||||
redirect_from:
|
||||
- /articles/about-merge-methods-on-github
|
||||
- /github/administering-a-repository/about-merge-methods-on-github
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -10,7 +11,6 @@ versions:
|
||||
topics:
|
||||
- Repositories
|
||||
---
|
||||
|
||||
{% data reusables.pull_requests.configure_pull_request_merges_intro %} You can enforce one type of merge method, such as commit squashing or rebasing, by only enabling the desired method for your repository.
|
||||
|
||||
{% data reusables.pull_requests.default_merge_option %}
|
||||
@@ -3,6 +3,7 @@ title: Configuring commit rebasing for pull requests
|
||||
intro: 'You can enforce, allow, or disable commit rebasing for all pull request merges on {% data variables.product.product_location %} in your repository.'
|
||||
redirect_from:
|
||||
- /articles/configuring-commit-rebasing-for-pull-requests
|
||||
- /github/administering-a-repository/configuring-commit-rebasing-for-pull-requests
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -10,7 +11,6 @@ versions:
|
||||
topics:
|
||||
- Repositories
|
||||
---
|
||||
|
||||
{% data reusables.pull_requests.configure_pull_request_merges_intro %}
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
@@ -3,6 +3,7 @@ title: Configuring commit squashing for pull requests
|
||||
intro: 'You can enforce, allow, or disable commit squashing for all pull request merges on {% data variables.product.product_location %} in your repository.'
|
||||
redirect_from:
|
||||
- /articles/configuring-commit-squashing-for-pull-requests
|
||||
- /github/administering-a-repository/configuring-commit-squashing-for-pull-requests
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -10,7 +11,6 @@ versions:
|
||||
topics:
|
||||
- Repositories
|
||||
---
|
||||
|
||||
{% data reusables.pull_requests.configure_pull_request_merges_intro %}
|
||||
|
||||
{% data reusables.pull_requests.default-commit-message-squash-merge %}
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Configuring pull request merges
|
||||
intro: 'You can configure pull request merges on {% data variables.product.product_location %} to match your workflow and preferences for managing Git history.'
|
||||
mapTopic: true
|
||||
redirect_from:
|
||||
- /articles/configuring-pull-request-merges
|
||||
versions:
|
||||
@@ -10,5 +9,11 @@ versions:
|
||||
github-ae: '*'
|
||||
topics:
|
||||
- Repositories
|
||||
children:
|
||||
- /about-merge-methods-on-github
|
||||
- /configuring-commit-squashing-for-pull-requests
|
||||
- /configuring-commit-rebasing-for-pull-requests
|
||||
- /managing-auto-merge-for-pull-requests-in-your-repository
|
||||
- /managing-the-automatic-deletion-of-branches
|
||||
---
|
||||
|
||||
@@ -9,8 +9,9 @@ versions:
|
||||
permissions: People with maintainer permissions can manage auto-merge for pull requests in a repository.
|
||||
topics:
|
||||
- Repositories
|
||||
redirect_from:
|
||||
- /github/administering-a-repository/managing-auto-merge-for-pull-requests-in-your-repository
|
||||
---
|
||||
|
||||
### 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)."
|
||||
@@ -3,6 +3,7 @@ title: Managing the automatic deletion of branches
|
||||
intro: You can have head branches automatically deleted after pull requests are merged in your repository.
|
||||
redirect_from:
|
||||
- /articles/managing-the-automatic-deletion-of-branches
|
||||
- /github/administering-a-repository/managing-the-automatic-deletion-of-branches
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -10,7 +11,6 @@ versions:
|
||||
topics:
|
||||
- Repositories
|
||||
---
|
||||
|
||||
Anyone with admin permissions to a repository can enable or disable the automatic deletion of branches.
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
@@ -15,6 +15,7 @@ redirect_from:
|
||||
- /github/administering-a-repository/about-required-commit-signing
|
||||
- /articles/about-required-reviews-for-pull-requests
|
||||
- /github/administering-a-repository/about-required-reviews-for-pull-requests
|
||||
- /github/administering-a-repository/about-protected-branches
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -22,7 +23,6 @@ versions:
|
||||
topics:
|
||||
- Repositories
|
||||
---
|
||||
|
||||
### 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.
|
||||
@@ -6,12 +6,15 @@ redirect_from:
|
||||
- /articles/defining-the-mergeability-of-pull-requests
|
||||
- /enterprise/admin/developer-workflow/establishing-pull-request-merge-conditions
|
||||
product: '{% data reusables.gated-features.protected-branches %}'
|
||||
mapTopic: true
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
topics:
|
||||
- Repositories
|
||||
children:
|
||||
- /about-protected-branches
|
||||
- /managing-a-branch-protection-rule
|
||||
- /troubleshooting-required-status-checks
|
||||
---
|
||||
|
||||
@@ -16,6 +16,7 @@ redirect_from:
|
||||
- /github/administering-a-repository/requiring-a-linear-commit-history
|
||||
- /github/administering-a-repository/enabling-force-pushes-to-a-protected-branch
|
||||
- /github/administering-a-repository/enabling-deletion-of-a-protected-branch
|
||||
- /github/administering-a-repository/managing-a-branch-protection-rule
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -24,7 +25,6 @@ permissions: People with admin permissions to a repository can manage branch pro
|
||||
topics:
|
||||
- Repositories
|
||||
---
|
||||
|
||||
### About branch protection rules
|
||||
|
||||
{% data reusables.repositories.branch-rules-example %}
|
||||
@@ -8,8 +8,9 @@ versions:
|
||||
github-ae: '*'
|
||||
topics:
|
||||
- Repositories
|
||||
redirect_from:
|
||||
- /github/administering-a-repository/troubleshooting-required-status-checks
|
||||
---
|
||||
|
||||
If you have a check and a status with the same name, and you select that name as a required status check, both the check and the status are required. For more information, see "[Checks](/rest/reference/checks)."
|
||||
|
||||
After you enable required status checks, your branch may need to be up-to-date with the base branch before merging. This ensures that your branch has been tested with the latest code from the base branch. If your branch is out of date, you'll need to merge the base branch into your branch. For more information, see "[About protected branches](/github/administering-a-repository/about-protected-branches#require-status-checks-before-merging)."
|
||||
@@ -8,51 +8,11 @@ versions:
|
||||
github-ae: '*'
|
||||
topics:
|
||||
- Repositories
|
||||
children:
|
||||
- /managing-repository-settings
|
||||
- /managing-branches-in-your-repository
|
||||
- /configuring-pull-request-merges
|
||||
- /defining-the-mergeability-of-pull-requests
|
||||
- /releasing-projects-on-github
|
||||
- /securing-your-repository
|
||||
---
|
||||
|
||||
|
||||
### Table of Contents
|
||||
|
||||
{% topic_link_in_list /managing-repository-settings %}
|
||||
{% link_in_list /setting-repository-visibility %}
|
||||
{% link_in_list /managing-teams-and-people-with-access-to-your-repository %}
|
||||
{% link_in_list /classifying-your-repository-with-topics %}
|
||||
{% link_in_list /customizing-how-changed-files-appear-on-github %}
|
||||
{% link_in_list /about-email-notifications-for-pushes-to-your-repository %}
|
||||
{% link_in_list /displaying-a-sponsor-button-in-your-repository %}
|
||||
{% link_in_list /customizing-your-repositorys-social-media-preview %}
|
||||
{% link_in_list /viewing-deployment-activity-for-your-repository %}
|
||||
{% link_in_list /managing-the-forking-policy-for-your-repository %}
|
||||
{% link_in_list /configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository %}
|
||||
{% link_in_list /disabling-or-limiting-github-actions-for-a-repository %}{% if currentVersion == "free-pro-team@latest" %}
|
||||
{% link_in_list /enabling-or-disabling-github-discussions-for-a-repository %}{% endif %}
|
||||
{% link_in_list /managing-git-lfs-objects-in-archives-of-your-repository %}
|
||||
{% link_in_list /managing-security-and-analysis-settings-for-your-repository %}
|
||||
{% link_in_list /enabling-anonymous-git-read-access-for-a-repository %}
|
||||
{% link_in_list /configuring-autolinks-to-reference-external-resources %}
|
||||
{% link_in_list /renaming-a-repository %}
|
||||
{% link_in_list /transferring-a-repository %}
|
||||
{% link_in_list /deleting-a-repository %}
|
||||
{% link_in_list /restoring-a-deleted-repository %}
|
||||
{% topic_link_in_list /managing-branches-in-your-repository %}
|
||||
{% link_in_list /viewing-branches-in-your-repository %}
|
||||
{% link_in_list /renaming-a-branch %}
|
||||
{% link_in_list /changing-the-default-branch %}
|
||||
{% link_in_list /deleting-and-restoring-branches-in-a-pull-request %}
|
||||
{% topic_link_in_list /configuring-pull-request-merges %}
|
||||
{% link_in_list /about-merge-methods-on-github %}
|
||||
{% link_in_list /configuring-commit-squashing-for-pull-requests %}
|
||||
{% link_in_list /configuring-commit-rebasing-for-pull-requests %}
|
||||
{% link_in_list /managing-auto-merge-for-pull-requests-in-your-repository %}
|
||||
{% link_in_list /managing-the-automatic-deletion-of-branches %}
|
||||
{% topic_link_in_list /defining-the-mergeability-of-pull-requests %}
|
||||
{% link_in_list /about-protected-branches %}
|
||||
{% link_in_list /managing-a-branch-protection-rule %}
|
||||
{% link_in_list /troubleshooting-required-status-checks %}
|
||||
{% topic_link_in_list /releasing-projects-on-github %}
|
||||
{% link_in_list /about-releases %}
|
||||
{% link_in_list /managing-releases-in-a-repository %}
|
||||
{% link_in_list /viewing-your-repositorys-releases-and-tags %}
|
||||
{% link_in_list /linking-to-releases %}
|
||||
{% link_in_list /comparing-releases %}
|
||||
{% link_in_list /automation-for-release-forms-with-query-parameters %}
|
||||
|
||||
@@ -9,10 +9,10 @@ versions:
|
||||
redirect_from:
|
||||
- /github/administering-a-repository/setting-the-default-branch
|
||||
- /articles/setting-the-default-branch
|
||||
- /github/administering-a-repository/changing-the-default-branch
|
||||
topics:
|
||||
- Repositories
|
||||
---
|
||||
|
||||
### 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)."
|
||||
@@ -6,6 +6,7 @@ redirect_from:
|
||||
- /articles/restoring-branches-in-a-pull-request/
|
||||
- /articles/deleting-unused-branches/
|
||||
- /articles/deleting-and-restoring-branches-in-a-pull-request
|
||||
- /github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -13,7 +14,6 @@ versions:
|
||||
topics:
|
||||
- Repositories
|
||||
---
|
||||
|
||||
### 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)."
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Managing branches in your repository
|
||||
intro: 'Whenever you propose a change in Git, you [create a new branch](/articles/creating-and-deleting-branches-within-your-repository/). Branch management is an important part of the Git workflow. After some time, your list of branches may grow, so it''s a good idea to delete merged or stale branches.'
|
||||
mapTopic: true
|
||||
redirect_from:
|
||||
- /articles/managing-branches-in-your-repository
|
||||
versions:
|
||||
@@ -10,5 +9,10 @@ versions:
|
||||
github-ae: '*'
|
||||
topics:
|
||||
- Repositories
|
||||
children:
|
||||
- /viewing-branches-in-your-repository
|
||||
- /renaming-a-branch
|
||||
- /changing-the-default-branch
|
||||
- /deleting-and-restoring-branches-in-a-pull-request
|
||||
---
|
||||
|
||||
@@ -7,8 +7,9 @@ versions:
|
||||
enterprise-server: '>=3.2'
|
||||
topics:
|
||||
- Repositories
|
||||
redirect_from:
|
||||
- /github/administering-a-repository/renaming-a-branch
|
||||
---
|
||||
|
||||
### 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)."
|
||||
@@ -3,6 +3,7 @@ title: Viewing branches in your repository
|
||||
intro: 'Branches are central to collaboration on {% data variables.product.product_name %}, and the best way to view them is the branches page.'
|
||||
redirect_from:
|
||||
- /articles/viewing-branches-in-your-repository
|
||||
- /github/administering-a-repository/viewing-branches-in-your-repository
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -1,14 +0,0 @@
|
||||
---
|
||||
title: Managing repository settings
|
||||
intro: 'Repository administrators and organization owners can change settings for a repository, like the name, ownership, and visibility, or delete the repository.'
|
||||
mapTopic: true
|
||||
redirect_from:
|
||||
- /articles/managing-repository-settings
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
topics:
|
||||
- Repositories
|
||||
---
|
||||
|
||||
@@ -7,6 +7,7 @@ redirect_from:
|
||||
- /articles/receiving-email-notifications-for-pushes-to-a-repository/
|
||||
- /articles/about-email-notifications-for-pushes-to-your-repository/
|
||||
- /github/receiving-notifications-about-activity-on-github/about-email-notifications-for-pushes-to-your-repository
|
||||
- /github/administering-a-repository/about-email-notifications-for-pushes-to-your-repository
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -14,7 +15,6 @@ versions:
|
||||
topics:
|
||||
- Repositories
|
||||
---
|
||||
|
||||
{% data reusables.notifications.outbound_email_tip %}
|
||||
|
||||
Each email notification for a push to a repository lists the new commits and links to a diff containing just those commits. In the email notification you'll see:
|
||||
@@ -4,6 +4,7 @@ intro: 'To help other people find and contribute to your project, you can add to
|
||||
redirect_from:
|
||||
- /articles/about-topics/
|
||||
- /articles/classifying-your-repository-with-topics
|
||||
- /github/administering-a-repository/classifying-your-repository-with-topics
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -11,7 +12,6 @@ versions:
|
||||
topics:
|
||||
- Repositories
|
||||
---
|
||||
|
||||
### 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 %}.
|
||||
@@ -4,6 +4,7 @@ intro: You can add autolinks to external resources like JIRA issues and Zendesk
|
||||
product: '{% data reusables.gated-features.autolinks %}'
|
||||
redirect_from:
|
||||
- /articles/configuring-autolinks-to-reference-external-resources
|
||||
- /github/administering-a-repository/configuring-autolinks-to-reference-external-resources
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -11,7 +12,6 @@ versions:
|
||||
topics:
|
||||
- Repositories
|
||||
---
|
||||
|
||||
Anyone with admin permissions to a repository can configure autolink references to link issues, pull requests,{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.21" %} commit messages, and release descriptions{% else %} and commit messages{% endif %} to external third-party services.
|
||||
|
||||
If you use Zendesk to track user-reported tickets, for example, you can reference a ticket number in the pull request you open to fix the issue.
|
||||
@@ -7,8 +7,9 @@ versions:
|
||||
github-ae: '*'
|
||||
topics:
|
||||
- Repositories
|
||||
redirect_from:
|
||||
- /github/administering-a-repository/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository
|
||||
---
|
||||
|
||||
{% data reusables.actions.about-artifact-log-retention %}
|
||||
|
||||
You can also define a custom retention period for a specific artifact created by a workflow. For more information, see "[Setting the retention period for an artifact](/actions/managing-workflow-runs/removing-workflow-artifacts#setting-the-retention-period-for-an-artifact)."
|
||||
@@ -3,6 +3,7 @@ title: Customizing how changed files appear on GitHub
|
||||
intro: 'To keep certain files from displaying in diffs by default, or counting toward the repository language, you can mark them with the `linguist-generated` attribute in a *.gitattributes* file.'
|
||||
redirect_from:
|
||||
- /articles/customizing-how-changed-files-appear-on-github
|
||||
- /github/administering-a-repository/customizing-how-changed-files-appear-on-github
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -3,6 +3,7 @@ title: Customizing your repository's social media preview
|
||||
intro: You can customize the image displayed on social media platforms when someone links to your repository.
|
||||
redirect_from:
|
||||
- /articles/customizing-your-repositorys-social-media-preview
|
||||
- /github/administering-a-repository/customizing-your-repositorys-social-media-preview
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -10,7 +11,6 @@ versions:
|
||||
topics:
|
||||
- Repositories
|
||||
---
|
||||
|
||||
Until you add an image, repository links expand to show basic information about the repository and the owner's avatar. Adding an image to your repository can help identify your project across various social platforms.
|
||||
|
||||
{% if currentVersion != "github-ae@latest" %}You can upload an image to a private repository, but your image can only be shared from a public repository.{% endif %}
|
||||
@@ -5,6 +5,7 @@ redirect_from:
|
||||
- /delete-a-repo/
|
||||
- /deleting-a-repo/
|
||||
- /articles/deleting-a-repository
|
||||
- /github/administering-a-repository/deleting-a-repository
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -12,7 +13,6 @@ versions:
|
||||
topics:
|
||||
- Repositories
|
||||
---
|
||||
|
||||
{% data reusables.organizations.owners-and-admins-can %} delete an organization repository. If **Allow members to delete or transfer repositories for this organization** has been disabled, only organization owners can delete organization repositories. {% data reusables.organizations.new-repo-permissions-more-info %}
|
||||
|
||||
{% if currentVersion != "github-ae@latest" %}Deleting a public repository will not delete any forks of the repository.{% endif %}
|
||||
@@ -7,8 +7,9 @@ versions:
|
||||
github-ae: '*'
|
||||
topics:
|
||||
- Repositories
|
||||
redirect_from:
|
||||
- /github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-beta %}
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
|
||||
@@ -4,12 +4,12 @@ intro: You can add a sponsor button in your repository to increase the visibilit
|
||||
redirect_from:
|
||||
- /github/building-a-strong-community/displaying-a-sponsor-button-in-your-repository
|
||||
- /articles/displaying-a-sponsor-button-in-your-repository
|
||||
- /github/administering-a-repository/displaying-a-sponsor-button-in-your-repository
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
topics:
|
||||
- Repositories
|
||||
---
|
||||
|
||||
### 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)."
|
||||
@@ -3,10 +3,10 @@ title: Enabling anonymous Git read access for a repository
|
||||
intro: 'As a repository administrator, you can enable or disable anonymous Git read access for public repositories that meet certain requirements.'
|
||||
redirect_from:
|
||||
- /articles/enabling-anonymous-git-read-access-for-a-repository
|
||||
- /github/administering-a-repository/enabling-anonymous-git-read-access-for-a-repository
|
||||
versions:
|
||||
enterprise-server: '*'
|
||||
---
|
||||
|
||||
Repository administrators can change the anonymous Git read access setting for a specific repository if:
|
||||
- A site administrator has enabled private mode and anonymous Git read access.
|
||||
- The repository is public on the enterprise and is not a fork.
|
||||
@@ -7,8 +7,9 @@ versions:
|
||||
free-pro-team: '*'
|
||||
topics:
|
||||
- Repositories
|
||||
redirect_from:
|
||||
- /github/administering-a-repository/enabling-or-disabling-github-discussions-for-a-repository
|
||||
---
|
||||
|
||||
{% data reusables.discussions.beta %}
|
||||
|
||||
### Enabling or disabling discussions for your repository
|
||||
@@ -0,0 +1,34 @@
|
||||
---
|
||||
title: Managing repository settings
|
||||
intro: 'Repository administrators and organization owners can change settings for a repository, like the name, ownership, and visibility, or delete the repository.'
|
||||
redirect_from:
|
||||
- /articles/managing-repository-settings
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
topics:
|
||||
- Repositories
|
||||
children:
|
||||
- /setting-repository-visibility
|
||||
- /managing-teams-and-people-with-access-to-your-repository
|
||||
- /classifying-your-repository-with-topics
|
||||
- /customizing-how-changed-files-appear-on-github
|
||||
- /about-email-notifications-for-pushes-to-your-repository
|
||||
- /displaying-a-sponsor-button-in-your-repository
|
||||
- /customizing-your-repositorys-social-media-preview
|
||||
- /viewing-deployment-activity-for-your-repository
|
||||
- /managing-the-forking-policy-for-your-repository
|
||||
- /configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository
|
||||
- /disabling-or-limiting-github-actions-for-a-repository
|
||||
- /enabling-or-disabling-github-discussions-for-a-repository
|
||||
- /managing-git-lfs-objects-in-archives-of-your-repository
|
||||
- /managing-security-and-analysis-settings-for-your-repository
|
||||
- /enabling-anonymous-git-read-access-for-a-repository
|
||||
- /configuring-autolinks-to-reference-external-resources
|
||||
- /renaming-a-repository
|
||||
- /transferring-a-repository
|
||||
- /deleting-a-repository
|
||||
- /restoring-a-deleted-repository
|
||||
---
|
||||
|
||||
@@ -9,8 +9,9 @@ versions:
|
||||
github-ae: '*'
|
||||
topics:
|
||||
- Repositories
|
||||
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
|
||||
|
||||
{% 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.
|
||||
@@ -7,6 +7,7 @@ redirect_from:
|
||||
- /articles/managing-alerts-for-vulnerable-dependencies-in-your-organizations-repositories/
|
||||
- /articles/managing-alerts-for-vulnerable-dependencies-in-your-organization
|
||||
- /github/managing-security-vulnerabilities/managing-alerts-for-vulnerable-dependencies-in-your-organization
|
||||
- /github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '>=3.0'
|
||||
@@ -14,7 +15,6 @@ versions:
|
||||
topics:
|
||||
- Repositories
|
||||
---
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
### Enabling or disabling security and analysis features for public repositories
|
||||
|
||||
@@ -4,12 +4,12 @@ intro: You can see everyone who has access to your repository and adjust permiss
|
||||
permissions: Repository administrators can manage teams and people with access to a repository.
|
||||
redirect_from:
|
||||
- /github/administering-a-repository/managing-people-and-teams-with-access-to-your-repository
|
||||
- /github/administering-a-repository/managing-teams-and-people-with-access-to-your-repository
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
topics:
|
||||
- Repositories
|
||||
---
|
||||
|
||||
### 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.
|
||||
@@ -4,6 +4,7 @@ intro: 'You can allow or prevent the forking of a specific private{% if currentV
|
||||
redirect_from:
|
||||
- /articles/allowing-people-to-fork-a-private-repository-owned-by-your-organization
|
||||
- /github/administering-a-repository/allowing-people-to-fork-a-private-repository-owned-by-your-organization
|
||||
- /github/administering-a-repository/managing-the-forking-policy-for-your-repository
|
||||
permissions: People with admin permissions for a repository can manage the forking policy for the repository.
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
@@ -12,7 +13,6 @@ versions:
|
||||
topics:
|
||||
- Repositories
|
||||
---
|
||||
|
||||
An organization owner must allow forks of private{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %} and internal{% endif %} repositories on the organization level before you can allow or disallow forks for a specific repository. For more information, see "[Managing the forking policy for your organization](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)."
|
||||
|
||||
{% data reusables.organizations.internal-repos-enterprise %}
|
||||
@@ -3,6 +3,7 @@ title: Renaming a repository
|
||||
intro: You can rename a repository if you're either an organization owner or have admin permissions for the repository.
|
||||
redirect_from:
|
||||
- /articles/renaming-a-repository
|
||||
- /github/administering-a-repository/renaming-a-repository
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -3,12 +3,12 @@ title: Restoring a deleted repository
|
||||
intro: You can restore some deleted repositories to recover their contents.
|
||||
redirect_from:
|
||||
- /articles/restoring-a-deleted-repository
|
||||
- /github/administering-a-repository/restoring-a-deleted-repository
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
topics:
|
||||
- Repositories
|
||||
---
|
||||
|
||||
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
|
||||
@@ -6,6 +6,7 @@ redirect_from:
|
||||
- /articles/making-a-public-repository-private/
|
||||
- /articles/converting-a-public-repo-to-a-private-repo/
|
||||
- /articles/setting-repository-visibility
|
||||
- /github/administering-a-repository/setting-repository-visibility
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -13,7 +14,6 @@ versions:
|
||||
topics:
|
||||
- Repositories
|
||||
---
|
||||
|
||||
### 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)."
|
||||
@@ -12,6 +12,7 @@ redirect_from:
|
||||
- /articles/transferring-a-repository-owned-by-your-personal-account/
|
||||
- /articles/transferring-a-repository-owned-by-your-organization/
|
||||
- /articles/transferring-a-repository
|
||||
- /github/administering-a-repository/transferring-a-repository
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -19,7 +20,6 @@ versions:
|
||||
topics:
|
||||
- Repositories
|
||||
---
|
||||
|
||||
### 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.
|
||||
@@ -3,6 +3,7 @@ title: Viewing deployment activity for your repository
|
||||
intro: You can view information about deployments for your entire repository or a specific pull request.
|
||||
redirect_from:
|
||||
- /articles/viewing-deployment-activity-for-your-repository
|
||||
- /github/administering-a-repository/viewing-deployment-activity-for-your-repository
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -10,7 +11,6 @@ versions:
|
||||
topics:
|
||||
- Repositories
|
||||
---
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** The deployments dashboard is currently in beta and subject to change.
|
||||
@@ -7,6 +7,7 @@ redirect_from:
|
||||
- /articles/about-releases
|
||||
- /articles/getting-the-download-count-for-your-releases
|
||||
- /github/administering-a-repository/getting-the-download-count-for-your-releases
|
||||
- /github/administering-a-repository/about-releases
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -14,7 +15,6 @@ versions:
|
||||
topics:
|
||||
- Repositories
|
||||
---
|
||||
|
||||
### About releases
|
||||
|
||||
|
||||
@@ -3,6 +3,7 @@ title: Automation for release forms with query parameters
|
||||
intro: 'To quickly create releases by auto-populating the new release form with customized information, you can add query parameters to the URL for the release form page.'
|
||||
redirect_from:
|
||||
- /articles/automation-for-release-forms-with-query-parameters
|
||||
- /github/administering-a-repository/automation-for-release-forms-with-query-parameters
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -10,7 +11,6 @@ versions:
|
||||
topics:
|
||||
- Repositories
|
||||
---
|
||||
|
||||
Query parameters are optional parts of a URL you can customize to share a specific web page view, such as search filter results, an issue template, or the release form page on {% data variables.product.prodname_dotcom %}. To create your own query parameters, you must match the key and value pair.
|
||||
|
||||
You must have the proper permissions for any action to use the equivalent query parameter. For example, you must have permission to create releases to pre-fill the releases form. For more information, see "[Managing releases in a repository](/github/administering-a-repository/managing-releases-in-a-repository)."
|
||||
@@ -8,8 +8,9 @@ versions:
|
||||
github-ae: '*'
|
||||
topics:
|
||||
- Repositories
|
||||
redirect_from:
|
||||
- /github/administering-a-repository/comparing-releases
|
||||
---
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.releases %}
|
||||
3. Next to the release you want to use as your base, click **Compare**.
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Releasing projects on GitHub
|
||||
intro: 'You can create a release to package software, release notes, and binary files for other people to download.'
|
||||
mapTopic: true
|
||||
redirect_from:
|
||||
- /categories/85/articles/
|
||||
- /categories/releases/
|
||||
@@ -11,5 +10,12 @@ versions:
|
||||
github-ae: '*'
|
||||
topics:
|
||||
- Repositories
|
||||
children:
|
||||
- /about-releases
|
||||
- /managing-releases-in-a-repository
|
||||
- /viewing-your-repositorys-releases-and-tags
|
||||
- /linking-to-releases
|
||||
- /comparing-releases
|
||||
- /automation-for-release-forms-with-query-parameters
|
||||
---
|
||||
|
||||
@@ -3,6 +3,7 @@ title: Linking to releases
|
||||
intro: You can share every release you create on GitHub with a unique URL.
|
||||
redirect_from:
|
||||
- /articles/linking-to-releases
|
||||
- /github/administering-a-repository/linking-to-releases
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -10,7 +11,6 @@ versions:
|
||||
topics:
|
||||
- Repositories
|
||||
---
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.releases %}
|
||||
3. Find the release you want to link to and click the version number.
|
||||
@@ -8,6 +8,7 @@ redirect_from:
|
||||
- /articles/managing-releases-in-a-repository
|
||||
- /github/administering-a-repository/creating-releases
|
||||
- /github/administering-a-repository/editing-and-deleting-releases
|
||||
- /github/administering-a-repository/managing-releases-in-a-repository
|
||||
permissions: 'Repository collaborators and people with write access to a repository can create, edit, and delete a release.'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
@@ -16,7 +17,6 @@ versions:
|
||||
topics:
|
||||
- Repositories
|
||||
---
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion ver_gt "github-ae@latest" %}
|
||||
|
||||
### About release management
|
||||
@@ -5,6 +5,7 @@ redirect_from:
|
||||
- /articles/working-with-tags/
|
||||
- /articles/viewing-your-repositorys-tags
|
||||
- /github/administering-a-repository/viewing-your-repositorys-tags
|
||||
- /github/administering-a-repository/viewing-your-repositorys-releases-and-tags
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -12,7 +13,6 @@ versions:
|
||||
topics:
|
||||
- Repositories
|
||||
---
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
|
||||
{% tip %}
|
||||
|
||||
@@ -4,13 +4,13 @@ intro: 'You can access {% if currentVersion == "github-ae@latest" %}{% data vari
|
||||
product: '{% data reusables.gated-features.saml-sso %}'
|
||||
redirect_from:
|
||||
- /articles/about-authentication-with-saml-single-sign-on
|
||||
- /github/authenticating-to-github/about-authentication-with-saml-single-sign-on
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
github-ae: '*'
|
||||
topics:
|
||||
- SSO
|
||||
---
|
||||
|
||||
### About authentication with SAML SSO
|
||||
|
||||
{% if currentVersion == "github-ae@latest" %}
|
||||
@@ -4,12 +4,12 @@ intro: 'To use a personal access token with an organization that uses SAML singl
|
||||
redirect_from:
|
||||
- /articles/authorizing-a-personal-access-token-for-use-with-a-saml-single-sign-on-organization/
|
||||
- /articles/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on
|
||||
- /github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
topics:
|
||||
- SSO
|
||||
---
|
||||
|
||||
You can authorize an existing personal access token, or [create a new personal access token](/github/authenticating-to-github/creating-a-personal-access-token) and then authorize it.
|
||||
|
||||
{% data reusables.user_settings.access_settings %}
|
||||
@@ -4,12 +4,12 @@ intro: 'To use an SSH key with an organization that uses SAML single sign-on (SS
|
||||
redirect_from:
|
||||
- /articles/authorizing-an-ssh-key-for-use-with-a-saml-single-sign-on-organization/
|
||||
- /articles/authorizing-an-ssh-key-for-use-with-saml-single-sign-on
|
||||
- /github/authenticating-to-github/authorizing-an-ssh-key-for-use-with-saml-single-sign-on
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
topics:
|
||||
- SSO
|
||||
---
|
||||
|
||||
You can authorize an existing SSH key, or create a new SSH key and then authorize it. For more information about creating a new SSH key, see "[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)."
|
||||
|
||||
{% note %}
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Authenticating with SAML single sign-on
|
||||
intro: 'You can authenticate to {% if currentVersion == "free-pro-team@latest" %}a {% data variables.product.product_name %} organization {% elsif currentVersion == "github-ae@latest" %}{% data variables.product.product_location %} {% endif %}with SAML single sign-on (SSO){% if currentVersion == "free-pro-team@latest" %} and view your active sessions{% endif %}.'
|
||||
mapTopic: true
|
||||
product: '{% data reusables.gated-features.saml-sso %}'
|
||||
redirect_from:
|
||||
- /articles/authenticating-to-a-github-organization-with-saml-single-sign-on/
|
||||
@@ -11,5 +10,10 @@ versions:
|
||||
github-ae: '*'
|
||||
topics:
|
||||
- SSO
|
||||
children:
|
||||
- /about-authentication-with-saml-single-sign-on
|
||||
- /authorizing-an-ssh-key-for-use-with-saml-single-sign-on
|
||||
- /authorizing-a-personal-access-token-for-use-with-saml-single-sign-on
|
||||
- /viewing-and-managing-your-active-saml-sessions
|
||||
---
|
||||
|
||||
@@ -3,12 +3,12 @@ title: Viewing and managing your active SAML sessions
|
||||
intro: You can view and revoke your active SAML sessions in your security settings.
|
||||
redirect_from:
|
||||
- /articles/viewing-and-managing-your-active-saml-sessions
|
||||
- /github/authenticating-to-github/viewing-and-managing-your-active-saml-sessions
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
topics:
|
||||
- SSO
|
||||
---
|
||||
|
||||
{% data reusables.user_settings.access_settings %}
|
||||
{% data reusables.user_settings.security %}
|
||||
3. Under "Sessions," you can see your active SAML sessions.
|
||||
@@ -3,6 +3,7 @@ title: About SSH
|
||||
intro: 'Using the SSH protocol, you can connect and authenticate to remote servers and services. With SSH keys, you can connect to {% data variables.product.product_name %} without supplying your username and personal access token at each visit.'
|
||||
redirect_from:
|
||||
- /articles/about-ssh
|
||||
- /github/authenticating-to-github/about-ssh
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -10,7 +11,6 @@ versions:
|
||||
topics:
|
||||
- SSH
|
||||
---
|
||||
|
||||
When you set up SSH, you will need to generate a new SSH key and add it to the ssh-agent. You must add the SSH key to your account on {% data variables.product.product_name %} before you use the key to authenticate. For more information, see "[Generating a new SSH key and adding it to the ssh-agent](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)" and "[Adding a new SSH key to your {% data variables.product.prodname_dotcom %} account](/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account)."
|
||||
|
||||
You can further secure your SSH key by using a hardware security key, which requires the physical hardware security key to be attached to your computer when the key pair is used to authenticate with SSH. You can also secure your SSH key by adding your key to the ssh-agent and using a passphrase. For more information, see "[Working with SSH key passphrases](/github/authenticating-to-github/working-with-ssh-key-passphrases)."
|
||||
@@ -3,6 +3,7 @@ title: Adding a new SSH key to your GitHub account
|
||||
intro: 'To configure your {% data variables.product.product_name %} account to use your new (or existing) SSH key, you''ll also need to add it to your {% data variables.product.product_name %} account.'
|
||||
redirect_from:
|
||||
- /articles/adding-a-new-ssh-key-to-your-github-account
|
||||
- /github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -10,7 +11,6 @@ versions:
|
||||
topics:
|
||||
- SSH
|
||||
---
|
||||
|
||||
Before adding a new SSH key to your {% data variables.product.product_name %} account, you should have:
|
||||
* [Checked for existing SSH keys](/articles/checking-for-existing-ssh-keys)
|
||||
* [Generated a new SSH key and added it to the ssh-agent](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)
|
||||
@@ -3,6 +3,7 @@ title: Checking for existing SSH keys
|
||||
intro: 'Before you generate an SSH key, you can check to see if you have any existing SSH keys.'
|
||||
redirect_from:
|
||||
- /articles/checking-for-existing-ssh-keys
|
||||
- /github/authenticating-to-github/checking-for-existing-ssh-keys
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -10,7 +11,6 @@ versions:
|
||||
topics:
|
||||
- SSH
|
||||
---
|
||||
|
||||
{% data reusables.ssh.dsa-support %}
|
||||
|
||||
{% data reusables.command_line.open_the_multi_os_terminal %}
|
||||
@@ -5,6 +5,7 @@ redirect_from:
|
||||
- /articles/adding-a-new-ssh-key-to-the-ssh-agent/
|
||||
- /articles/generating-a-new-ssh-key/
|
||||
- /articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent
|
||||
- /github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -12,7 +13,6 @@ versions:
|
||||
topics:
|
||||
- SSH
|
||||
---
|
||||
|
||||
### 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)."
|
||||
@@ -10,12 +10,18 @@ redirect_from:
|
||||
- /articles/generating-ssh-keys/
|
||||
- /articles/generating-an-ssh-key/
|
||||
- /articles/connecting-to-github-with-ssh
|
||||
mapTopic: true
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
topics:
|
||||
- SSH
|
||||
children:
|
||||
- /about-ssh
|
||||
- /checking-for-existing-ssh-keys
|
||||
- /generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent
|
||||
- /adding-a-new-ssh-key-to-your-github-account
|
||||
- /testing-your-ssh-connection
|
||||
- /working-with-ssh-key-passphrases
|
||||
---
|
||||
|
||||
@@ -3,6 +3,7 @@ title: Testing your SSH connection
|
||||
intro: 'After you''ve set up your SSH key and added it to your {% data variables.product.product_name %} account, you can test your connection.'
|
||||
redirect_from:
|
||||
- /articles/testing-your-ssh-connection
|
||||
- /github/authenticating-to-github/testing-your-ssh-connection
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -10,7 +11,6 @@ versions:
|
||||
topics:
|
||||
- SSH
|
||||
---
|
||||
|
||||
Before testing your SSH connection, you should have:
|
||||
- [Checked for existing SSH keys](/articles/checking-for-existing-ssh-keys)
|
||||
- [Generated a new SSH key](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)
|
||||
@@ -5,6 +5,7 @@ redirect_from:
|
||||
- /ssh-key-passphrases/
|
||||
- /working-with-key-passphrases/
|
||||
- /articles/working-with-ssh-key-passphrases
|
||||
- /github/authenticating-to-github/working-with-ssh-key-passphrases
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -12,7 +13,6 @@ versions:
|
||||
topics:
|
||||
- SSH
|
||||
---
|
||||
|
||||
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
|
||||
@@ -23,75 +23,13 @@ topics:
|
||||
- Access management
|
||||
- Usernames
|
||||
- Device verification
|
||||
children:
|
||||
- /keeping-your-account-and-data-secure
|
||||
- /securing-your-account-with-two-factor-authentication-2fa
|
||||
- /authenticating-with-saml-single-sign-on
|
||||
- /connecting-to-github-with-ssh
|
||||
- /troubleshooting-ssh
|
||||
- /managing-commit-signature-verification
|
||||
- /troubleshooting-commit-signature-verification
|
||||
---
|
||||
|
||||
|
||||
### Table of Contents
|
||||
|
||||
{% topic_link_in_list /keeping-your-account-and-data-secure %}
|
||||
{% link_in_list /about-authentication-to-github %}
|
||||
{% link_in_list /creating-a-strong-password %}
|
||||
{% link_in_list /updating-your-github-access-credentials %}
|
||||
{% link_in_list /creating-a-personal-access-token %}
|
||||
{% link_in_list /reviewing-your-ssh-keys %}
|
||||
{% link_in_list /reviewing-your-deploy-keys %}
|
||||
{% link_in_list /authorizing-oauth-apps %}
|
||||
{% link_in_list /reviewing-your-authorized-integrations %}
|
||||
{% link_in_list /connecting-with-third-party-applications %}
|
||||
{% link_in_list /reviewing-your-authorized-applications-oauth %}
|
||||
{% link_in_list /reviewing-your-security-log %}
|
||||
{% link_in_list /removing-sensitive-data-from-a-repository %}
|
||||
{% link_in_list /about-anonymized-urls %}
|
||||
{% link_in_list /about-githubs-ip-addresses %}
|
||||
{% link_in_list /githubs-ssh-key-fingerprints %}
|
||||
{% link_in_list /sudo-mode %}
|
||||
{% link_in_list /preventing-unauthorized-access %}
|
||||
{% topic_link_in_list /securing-your-account-with-two-factor-authentication-2fa %}
|
||||
{% link_in_list /about-two-factor-authentication %}
|
||||
{% link_in_list /configuring-two-factor-authentication %}
|
||||
{% link_in_list /configuring-two-factor-authentication-recovery-methods %}
|
||||
{% link_in_list /accessing-github-using-two-factor-authentication %}
|
||||
{% link_in_list /recovering-your-account-if-you-lose-your-2fa-credentials %}
|
||||
{% link_in_list /changing-two-factor-authentication-delivery-methods-for-your-mobile-device %}
|
||||
{% link_in_list /countries-where-sms-authentication-is-supported %}
|
||||
{% link_in_list /disabling-two-factor-authentication-for-your-personal-account %}
|
||||
{% topic_link_in_list /authenticating-with-saml-single-sign-on %}
|
||||
{% link_in_list /about-authentication-with-saml-single-sign-on %}
|
||||
{% link_in_list /authorizing-an-ssh-key-for-use-with-saml-single-sign-on %}
|
||||
{% link_in_list /authorizing-a-personal-access-token-for-use-with-saml-single-sign-on %}
|
||||
{% link_in_list /viewing-and-managing-your-active-saml-sessions %}
|
||||
{% topic_link_in_list /connecting-to-github-with-ssh %}
|
||||
{% link_in_list /about-ssh %}
|
||||
{% link_in_list /checking-for-existing-ssh-keys %}
|
||||
{% link_in_list /generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent %}
|
||||
{% link_in_list /adding-a-new-ssh-key-to-your-github-account %}
|
||||
{% link_in_list /testing-your-ssh-connection %}
|
||||
{% link_in_list /working-with-ssh-key-passphrases %}
|
||||
{% topic_link_in_list /troubleshooting-ssh %}
|
||||
{% link_in_list /using-ssh-over-the-https-port %}
|
||||
{% link_in_list /recovering-your-ssh-key-passphrase %}
|
||||
{% link_in_list /deleted-or-missing-ssh-keys %}
|
||||
{% link_in_list /error-permission-denied-publickey %}
|
||||
{% link_in_list /error-bad-file-number %}
|
||||
{% link_in_list /error-key-already-in-use %}
|
||||
{% link_in_list /error-permission-to-userrepo-denied-to-other-user %}
|
||||
{% link_in_list /error-permission-to-userrepo-denied-to-userother-repo %}
|
||||
{% link_in_list /error-agent-admitted-failure-to-sign %}
|
||||
{% link_in_list /error-ssh-add-illegal-option----k %}
|
||||
{% link_in_list /error-ssl-certificate-problem-verify-that-the-ca-cert-is-ok %}
|
||||
{% link_in_list /error-unknown-key-type %}
|
||||
{% link_in_list /error-were-doing-an-ssh-key-audit %}
|
||||
{% topic_link_in_list /managing-commit-signature-verification %}
|
||||
{% link_in_list /about-commit-signature-verification %}
|
||||
{% link_in_list /displaying-verification-statuses-for-all-of-your-commits %}
|
||||
{% link_in_list /checking-for-existing-gpg-keys %}
|
||||
{% link_in_list /generating-a-new-gpg-key %}
|
||||
{% link_in_list /adding-a-new-gpg-key-to-your-github-account %}
|
||||
{% link_in_list /telling-git-about-your-signing-key %}
|
||||
{% link_in_list /associating-an-email-with-your-gpg-key %}
|
||||
{% link_in_list /signing-commits %}
|
||||
{% link_in_list /signing-tags %}
|
||||
{% topic_link_in_list /troubleshooting-commit-signature-verification %}
|
||||
{% link_in_list /checking-your-commit-and-tag-signature-verification-status %}
|
||||
{% link_in_list /updating-an-expired-gpg-key %}
|
||||
{% link_in_list /using-a-verified-email-address-in-your-gpg-key %}
|
||||
|
||||
@@ -1,15 +0,0 @@
|
||||
---
|
||||
title: Keeping your account and data secure
|
||||
intro: 'To protect your personal information, you should keep both your {% data variables.product.product_name %} account and any associated data secure.'
|
||||
mapTopic: true
|
||||
redirect_from:
|
||||
- /articles/keeping-your-account-and-data-secure
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
topics:
|
||||
- Identity
|
||||
- Access management
|
||||
---
|
||||
|
||||
@@ -5,13 +5,13 @@ redirect_from:
|
||||
- /articles/why-do-my-images-have-strange-urls/
|
||||
- /articles/about-anonymized-image-urls
|
||||
- /authenticating-to-github/about-anonymized-image-urls
|
||||
- /github/authenticating-to-github/about-anonymized-urls
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
topics:
|
||||
- Identity
|
||||
- Access management
|
||||
---
|
||||
|
||||
To host your images, {% data variables.product.product_name %} uses the [open-source project Camo](https://github.com/atmos/camo). Camo generates an anonymous URL proxy for each file which hides your browser details and related information from other users. The URL starts `https://<subdomain>.githubusercontent.com/`, with different subdomains depending on how you uploaded the image.
|
||||
|
||||
Videos also get anonymized URLs with the same format as image URLs, but are not processed through Camo. This is because {% data variables.product.prodname_dotcom %} does not support externally hosted videos, so the anonymized URL is a link to the uploaded video hosted by {% data variables.product.prodname_dotcom %}.
|
||||
@@ -8,8 +8,9 @@ versions:
|
||||
topics:
|
||||
- Identity
|
||||
- Access management
|
||||
redirect_from:
|
||||
- /github/authenticating-to-github/about-authentication-to-github
|
||||
---
|
||||
|
||||
### 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.
|
||||
@@ -8,6 +8,7 @@ redirect_from:
|
||||
- /articles/github-s-ip-addresses/
|
||||
- /articles/about-github-s-ip-addresses
|
||||
- /articles/about-githubs-ip-addresses
|
||||
- /github/authenticating-to-github/about-githubs-ip-addresses
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
topics:
|
||||
@@ -3,6 +3,7 @@ title: Authorizing OAuth Apps
|
||||
intro: 'You can connect your {% data variables.product.product_name %} identity to third-party applications using OAuth. When authorizing an {% data variables.product.prodname_oauth_app %}, you should ensure you trust the application, review who it''s developed by, and review the kinds of information the application wants to access.'
|
||||
redirect_from:
|
||||
- /articles/authorizing-oauth-apps
|
||||
- /github/authenticating-to-github/authorizing-oauth-apps
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -11,7 +12,6 @@ topics:
|
||||
- Identity
|
||||
- Access management
|
||||
---
|
||||
|
||||
When an {% data variables.product.prodname_oauth_app %} wants to identify you by your {% data variables.product.product_name %} account, you'll see a page with the app's developer contact information and a list of the specific data that's being requested.
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
@@ -3,6 +3,7 @@ title: Connecting with third-party applications
|
||||
intro: 'You can connect your {% data variables.product.product_name %} identity to third-party applications using OAuth. When authorizing one of these applications, you should ensure you trust the application, review who it''s developed by, and review the kinds of information the application wants to access.'
|
||||
redirect_from:
|
||||
- /articles/connecting-with-third-party-applications
|
||||
- /github/authenticating-to-github/connecting-with-third-party-applications
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -11,7 +12,6 @@ topics:
|
||||
- Identity
|
||||
- Access management
|
||||
---
|
||||
|
||||
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
|
||||
@@ -6,6 +6,7 @@ redirect_from:
|
||||
- /articles/creating-an-access-token-for-command-line-use/
|
||||
- /articles/creating-a-personal-access-token-for-the-command-line
|
||||
- /github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line
|
||||
- /github/authenticating-to-github/creating-a-personal-access-token
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -14,7 +15,6 @@ topics:
|
||||
- Identity
|
||||
- Access management
|
||||
---
|
||||
|
||||
Personal access tokens (PATs) are an alternative to using passwords for authentication to {% data variables.product.product_name %} when using the [GitHub API](/rest/overview/other-authentication-methods#via-oauth-and-personal-access-tokens) or the [command line](#using-a-token-on-the-command-line).
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}If you want to use a PAT to access resources owned by an organization that uses SAML SSO, you must authorize the PAT. For more information, see "[About authentication with SAML single sign-on](/github/authenticating-to-github/about-authentication-with-saml-single-sign-on)" and "[Authorizing a personal access token for use with SAML single sign-on](/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)."{% endif %}
|
||||
@@ -4,6 +4,7 @@ intro: 'Secure your {% data variables.product.product_name %} account with a str
|
||||
redirect_from:
|
||||
- /articles/what-is-a-strong-password/
|
||||
- /articles/creating-a-strong-password
|
||||
- /github/authenticating-to-github/creating-a-strong-password
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -11,7 +12,6 @@ topics:
|
||||
- Identity
|
||||
- Access management
|
||||
---
|
||||
|
||||
You must choose or generate a password for your {% data variables.product.product_name %} account that is at least:
|
||||
- {% if enterpriseServerVersions contains currentVersion %}Seven{% else %}Eight{% endif %} characters long, if it includes a number and a lowercase letter, or
|
||||
- 15 characters long with any combination of characters
|
||||
@@ -5,13 +5,13 @@ redirect_from:
|
||||
- /articles/what-are-github-s-ssh-key-fingerprints/
|
||||
- /articles/github-s-ssh-key-fingerprints
|
||||
- /articles/githubs-ssh-key-fingerprints
|
||||
- /github/authenticating-to-github/githubs-ssh-key-fingerprints
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
topics:
|
||||
- Identity
|
||||
- Access management
|
||||
---
|
||||
|
||||
These are {% data variables.product.prodname_dotcom %}'s public key fingerprints:
|
||||
|
||||
- `SHA256:nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8` (RSA)
|
||||
@@ -0,0 +1,32 @@
|
||||
---
|
||||
title: Keeping your account and data secure
|
||||
intro: 'To protect your personal information, you should keep both your {% data variables.product.product_name %} account and any associated data secure.'
|
||||
redirect_from:
|
||||
- /articles/keeping-your-account-and-data-secure
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
github-ae: '*'
|
||||
topics:
|
||||
- Identity
|
||||
- Access management
|
||||
children:
|
||||
- /about-authentication-to-github
|
||||
- /creating-a-strong-password
|
||||
- /updating-your-github-access-credentials
|
||||
- /creating-a-personal-access-token
|
||||
- /reviewing-your-ssh-keys
|
||||
- /reviewing-your-deploy-keys
|
||||
- /authorizing-oauth-apps
|
||||
- /reviewing-your-authorized-integrations
|
||||
- /connecting-with-third-party-applications
|
||||
- /reviewing-your-authorized-applications-oauth
|
||||
- /reviewing-your-security-log
|
||||
- /removing-sensitive-data-from-a-repository
|
||||
- /about-anonymized-urls
|
||||
- /about-githubs-ip-addresses
|
||||
- /githubs-ssh-key-fingerprints
|
||||
- /sudo-mode
|
||||
- /preventing-unauthorized-access
|
||||
---
|
||||
|
||||
@@ -3,6 +3,7 @@ title: Preventing unauthorized access
|
||||
intro: 'You may be alerted to a security incident in the media, such as the discovery of the [Heartbleed bug](http://heartbleed.com/), or your computer could be stolen while you''re signed in to {% data variables.product.product_location %}. In such cases, changing your password prevents any unintended future access to your account and projects.'
|
||||
redirect_from:
|
||||
- /articles/preventing-unauthorized-access
|
||||
- /github/authenticating-to-github/preventing-unauthorized-access
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -10,7 +11,6 @@ topics:
|
||||
- Identity
|
||||
- Access management
|
||||
---
|
||||
|
||||
{% data variables.product.product_name %} requires a password to perform sensitive actions, such as adding new SSH keys, authorizing applications, or modifying team members.
|
||||
|
||||
After changing your password, you should perform these actions to make sure that your account is secure:
|
||||
@@ -6,6 +6,7 @@ redirect_from:
|
||||
- /removing-sensitive-data/
|
||||
- /articles/remove-sensitive-data/
|
||||
- /articles/removing-sensitive-data-from-a-repository
|
||||
- /github/authenticating-to-github/removing-sensitive-data-from-a-repository
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -14,7 +15,6 @@ topics:
|
||||
- Identity
|
||||
- Access management
|
||||
---
|
||||
|
||||
The `git filter-branch` command and the BFG Repo-Cleaner rewrite your repository's history, which changes the SHAs for existing commits that you alter and any dependent commits. Changed commit SHAs may affect open pull requests in your repository. We recommend merging or closing all open pull requests before removing files from your repository.
|
||||
|
||||
You can remove the file from the latest commit with `git rm`. For information on removing a file that was added with the latest commit, see "[Removing files from a repository's history](/articles/removing-files-from-a-repository-s-history)."
|
||||
@@ -3,6 +3,7 @@ title: Reviewing your authorized applications (OAuth)
|
||||
intro: 'You should review your authorized applications to verify that no new applications with expansive permissions are authorized, such as those that have access to your private repositories.'
|
||||
redirect_from:
|
||||
- /articles/reviewing-your-authorized-applications-oauth
|
||||
- /github/authenticating-to-github/reviewing-your-authorized-applications-oauth
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -11,7 +12,6 @@ topics:
|
||||
- Identity
|
||||
- Access management
|
||||
---
|
||||
|
||||
{% data reusables.user_settings.access_settings %}
|
||||
{% data reusables.user_settings.access_applications %}
|
||||
{% data reusables.user_settings.access_authorized_oauth_apps %}
|
||||
@@ -3,6 +3,7 @@ title: Reviewing your authorized integrations
|
||||
intro: You can review your authorized integrations to audit the access that each integration has to your account and data.
|
||||
redirect_from:
|
||||
- /articles/reviewing-your-authorized-integrations
|
||||
- /github/authenticating-to-github/reviewing-your-authorized-integrations
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -11,7 +12,6 @@ topics:
|
||||
- Identity
|
||||
- Access management
|
||||
---
|
||||
|
||||
### Reviewing your authorized {% data variables.product.prodname_oauth_app %}s
|
||||
|
||||
{% data reusables.user_settings.access_settings %}
|
||||
@@ -3,6 +3,7 @@ title: Reviewing your deploy keys
|
||||
intro: You should review deploy keys to ensure that there aren't any unauthorized (or possibly compromised) keys. You can also approve existing deploy keys that are valid.
|
||||
redirect_from:
|
||||
- /articles/reviewing-your-deploy-keys
|
||||
- /github/authenticating-to-github/reviewing-your-deploy-keys
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -11,7 +12,6 @@ topics:
|
||||
- Identity
|
||||
- Access management
|
||||
---
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
3. In the left sidebar, click **Deploy keys**.
|
||||
@@ -4,6 +4,7 @@ intro: You can review the security log for your user account to better understan
|
||||
miniTocMaxHeadingLevel: 4
|
||||
redirect_from:
|
||||
- /articles/reviewing-your-security-log
|
||||
- /github/authenticating-to-github/reviewing-your-security-log
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -12,7 +13,6 @@ topics:
|
||||
- Identity
|
||||
- Access management
|
||||
---
|
||||
|
||||
### 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 %}.
|
||||
@@ -5,6 +5,7 @@ redirect_from:
|
||||
- /articles/keeping-your-application-access-tokens-safe/
|
||||
- /articles/keeping-your-ssh-keys-and-application-access-tokens-safe/
|
||||
- /articles/reviewing-your-ssh-keys
|
||||
- /github/authenticating-to-github/reviewing-your-ssh-keys
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -13,7 +14,6 @@ topics:
|
||||
- Identity
|
||||
- Access management
|
||||
---
|
||||
|
||||
You can delete unauthorized (or possibly compromised) SSH keys to ensure that an attacker no longer has access to your repositories. You can also approve existing SSH keys that are valid.
|
||||
|
||||
{% mac %}
|
||||
@@ -3,6 +3,7 @@ title: Sudo mode
|
||||
intro: '{% data variables.product.product_name %} asks you for your password before you can modify your email address, authorize third-party applications, or add new public keys, or initiate other *sudo-protected* actions.'
|
||||
redirect_from:
|
||||
- /articles/sudo-mode
|
||||
- /github/authenticating-to-github/sudo-mode
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -10,7 +11,6 @@ topics:
|
||||
- Identity
|
||||
- Access management
|
||||
---
|
||||
|
||||
After you've performed a sudo-protected action, you'll only be asked to re-authenticate again after a few hours of inactivity. Every sudo-protected action resets this timer.
|
||||
|
||||
|
||||
@@ -5,6 +5,7 @@ redirect_from:
|
||||
- /articles/rolling-your-credentials/
|
||||
- /articles/how-can-i-reset-my-password/
|
||||
- /articles/updating-your-github-access-credentials
|
||||
- /github/authenticating-to-github/updating-your-github-access-credentials
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -13,7 +14,6 @@ topics:
|
||||
- Identity
|
||||
- Access management
|
||||
---
|
||||
|
||||
{% if currentVersion != "github-ae@latest" %}
|
||||
### Requesting a new password
|
||||
|
||||
@@ -5,6 +5,7 @@ redirect_from:
|
||||
- /articles/about-gpg-commit-and-tag-signatures/
|
||||
- /articles/about-gpg/
|
||||
- /articles/about-commit-signature-verification
|
||||
- /github/authenticating-to-github/about-commit-signature-verification
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -13,7 +14,6 @@ topics:
|
||||
- Identity
|
||||
- Access management
|
||||
---
|
||||
|
||||
### 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 %}
|
||||
@@ -3,6 +3,7 @@ title: Adding a new GPG key to your GitHub account
|
||||
intro: 'To configure your {% data variables.product.product_name %} account to use your new (or existing) GPG key, you''ll also need to add it to your {% data variables.product.product_name %} account.'
|
||||
redirect_from:
|
||||
- /articles/adding-a-new-gpg-key-to-your-github-account
|
||||
- /github/authenticating-to-github/adding-a-new-gpg-key-to-your-github-account
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -11,7 +12,6 @@ topics:
|
||||
- Identity
|
||||
- Access management
|
||||
---
|
||||
|
||||
Before adding a new GPG key to your {% data variables.product.product_name %} account, you should have:
|
||||
- [Checked for existing GPG keys](/articles/checking-for-existing-gpg-keys)
|
||||
- [Generated and copied a new GPG key](/articles/generating-a-new-gpg-key)
|
||||
@@ -3,6 +3,7 @@ title: Associating an email with your GPG key
|
||||
intro: 'Your GPG key must be associated with a {% data variables.product.product_name %} verified email that matches your committer identity.'
|
||||
redirect_from:
|
||||
- /articles/associating-an-email-with-your-gpg-key
|
||||
- /github/authenticating-to-github/associating-an-email-with-your-gpg-key
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -3,6 +3,7 @@ title: Checking for existing GPG keys
|
||||
intro: 'Before you generate a GPG key, you can check to see if you have any existing GPG keys.'
|
||||
redirect_from:
|
||||
- /articles/checking-for-existing-gpg-keys
|
||||
- /github/authenticating-to-github/checking-for-existing-gpg-keys
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -7,8 +7,9 @@ versions:
|
||||
topics:
|
||||
- Identity
|
||||
- Access management
|
||||
redirect_from:
|
||||
- /github/authenticating-to-github/displaying-verification-statuses-for-all-of-your-commits
|
||||
---
|
||||
|
||||
{% data reusables.identity-and-permissions.vigilant-mode-beta-note %}
|
||||
|
||||
### About vigilant mode
|
||||
@@ -3,6 +3,7 @@ title: Generating a new GPG key
|
||||
intro: 'If you don''t have an existing GPG key, you can generate a new GPG key to use for signing commits and tags.'
|
||||
redirect_from:
|
||||
- /articles/generating-a-new-gpg-key
|
||||
- /github/authenticating-to-github/generating-a-new-gpg-key
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -11,7 +12,6 @@ topics:
|
||||
- Identity
|
||||
- Access management
|
||||
---
|
||||
|
||||
{% data reusables.gpg.supported-gpg-key-algorithms %}
|
||||
|
||||
### Generating a GPG key
|
||||
@@ -5,7 +5,6 @@ redirect_from:
|
||||
- /articles/generating-a-gpg-key/
|
||||
- /articles/signing-commits-with-gpg/
|
||||
- /articles/managing-commit-signature-verification
|
||||
mapTopic: true
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -13,5 +12,15 @@ versions:
|
||||
topics:
|
||||
- Identity
|
||||
- Access management
|
||||
children:
|
||||
- /about-commit-signature-verification
|
||||
- /displaying-verification-statuses-for-all-of-your-commits
|
||||
- /checking-for-existing-gpg-keys
|
||||
- /generating-a-new-gpg-key
|
||||
- /adding-a-new-gpg-key-to-your-github-account
|
||||
- /telling-git-about-your-signing-key
|
||||
- /associating-an-email-with-your-gpg-key
|
||||
- /signing-commits
|
||||
- /signing-tags
|
||||
---
|
||||
|
||||
@@ -5,6 +5,7 @@ redirect_from:
|
||||
- /articles/signing-commits-and-tags-using-gpg/
|
||||
- /articles/signing-commits-using-gpg/
|
||||
- /articles/signing-commits
|
||||
- /github/authenticating-to-github/signing-commits
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -4,6 +4,7 @@ intro: You can sign tags locally using GPG or S/MIME.
|
||||
redirect_from:
|
||||
- /articles/signing-tags-using-gpg/
|
||||
- /articles/signing-tags
|
||||
- /github/authenticating-to-github/signing-tags
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -12,7 +13,6 @@ topics:
|
||||
- Identity
|
||||
- Access management
|
||||
---
|
||||
|
||||
{% data reusables.gpg.desktop-support-for-commit-signing %}
|
||||
|
||||
1. To sign a tag, add `-s` to your `git tag` command.
|
||||
@@ -4,6 +4,7 @@ intro: 'To sign commits locally, you need to inform Git that there''s a GPG or X
|
||||
redirect_from:
|
||||
- /articles/telling-git-about-your-gpg-key/
|
||||
- /articles/telling-git-about-your-signing-key
|
||||
- /github/authenticating-to-github/telling-git-about-your-signing-key
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -12,7 +13,6 @@ topics:
|
||||
- Identity
|
||||
- Access management
|
||||
---
|
||||
|
||||
{% mac %}
|
||||
|
||||
### Telling Git about your GPG key
|
||||
@@ -3,13 +3,13 @@ title: About two-factor authentication
|
||||
intro: '{% data reusables.two_fa.about-2fa %} With 2FA, you have to log in with your username and password and provide another form of authentication that only you know or have access to.'
|
||||
redirect_from:
|
||||
- /articles/about-two-factor-authentication
|
||||
- /github/authenticating-to-github/about-two-factor-authentication
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- 2fa
|
||||
---
|
||||
|
||||
For {% data variables.product.product_name %}, the second form of authentication is a code that's generated by an application on your mobile device{% if currentVersion == "free-pro-team@latest" %} or sent as a text message (SMS){% endif %}. After you enable 2FA, {% data variables.product.product_name %} generates an authentication code any time someone attempts to sign into your {% data variables.product.product_name %} account. The only way someone can sign into your account is if they know both your password and have access to the authentication code on your phone.
|
||||
|
||||
{% data reusables.two_fa.after-2fa-add-security-key %}
|
||||
@@ -6,13 +6,13 @@ redirect_from:
|
||||
- /articles/providing-your-2fa-authentication-code/
|
||||
- /articles/authenticating-to-github-using-fido-u2f-via-nfc/
|
||||
- /articles/accessing-github-using-two-factor-authentication
|
||||
- /github/authenticating-to-github/accessing-github-using-two-factor-authentication
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- 2fa
|
||||
---
|
||||
|
||||
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
|
||||
@@ -4,12 +4,12 @@ intro: You can switch between receiving authentication codes through a text mess
|
||||
redirect_from:
|
||||
- /articles/changing-two-factor-authentication-delivery-methods/
|
||||
- /articles/changing-two-factor-authentication-delivery-methods-for-your-mobile-device
|
||||
- /github/authenticating-to-github/changing-two-factor-authentication-delivery-methods-for-your-mobile-device
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
topics:
|
||||
- 2fa
|
||||
---
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** Changing your two-factor authentication method invalidates your current two-factor method setup. However, this doesn't affect your recovery codes or fallback SMS configuration. You can update your recovery codes or fallback SMS configuration on in your personal account's security settings page if desired.
|
||||
@@ -8,13 +8,13 @@ redirect_from:
|
||||
- /articles/adding-a-fallback-authentication-method-with-recover-accounts-elsewhere/
|
||||
- /articles/generating-and-storing-an-account-recovery-token/
|
||||
- /articles/configuring-two-factor-authentication-recovery-methods
|
||||
- /github/authenticating-to-github/configuring-two-factor-authentication-recovery-methods
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- 2fa
|
||||
---
|
||||
|
||||
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
|
||||
@@ -6,13 +6,13 @@ redirect_from:
|
||||
- /articles/configuring-two-factor-authentication-via-text-message/
|
||||
- /articles/configuring-two-factor-authentication-via-fido-u2f/
|
||||
- /articles/configuring-two-factor-authentication
|
||||
- /github/authenticating-to-github/configuring-two-factor-authentication
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- 2fa
|
||||
---
|
||||
|
||||
You can configure two-factor authentication using a mobile app{% if currentVersion == "free-pro-team@latest" %} or via text message{% endif %}. You can also add a security key.
|
||||
|
||||
We strongly recommend using a time-based one-time password (TOTP) application to configure 2FA.{% if currentVersion == "free-pro-team@latest" %} TOTP applications are more reliable than SMS, especially for locations outside the United States.{% endif %} TOTP apps support the secure backup of your authentication codes in the cloud and can be restored if you lose access to your device.
|
||||
@@ -31,6 +31,7 @@ A time-based one-time password (TOTP) application automatically generates an aut
|
||||
- [1Password](https://support.1password.com/one-time-passwords/)
|
||||
- [Authy](https://authy.com/guides/github/)
|
||||
- [LastPass Authenticator](https://lastpass.com/auth/)
|
||||
- [Microsoft Authenticator](https://www.microsoft.com/en-us/account/authenticator/)
|
||||
|
||||
{% tip %}
|
||||
|
||||
@@ -3,12 +3,12 @@ title: Countries where SMS authentication is supported
|
||||
intro: 'Because of delivery success rates, {% data variables.product.product_name %} only supports two-factor authentication via SMS for certain countries.'
|
||||
redirect_from:
|
||||
- /articles/countries-where-sms-authentication-is-supported
|
||||
- /github/authenticating-to-github/countries-where-sms-authentication-is-supported
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
topics:
|
||||
- 2fa
|
||||
---
|
||||
|
||||
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
|
||||
@@ -3,13 +3,13 @@ title: Disabling two-factor authentication for your personal account
|
||||
intro: 'If you disable two-factor authentication for your personal account, you may lose access to organizations you belong to.'
|
||||
redirect_from:
|
||||
- /articles/disabling-two-factor-authentication-for-your-personal-account
|
||||
- /github/authenticating-to-github/disabling-two-factor-authentication-for-your-personal-account
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- 2fa
|
||||
---
|
||||
|
||||
We strongly recommend using two-factor authentication to secure your account. If you need to disable 2FA, we recommend re-enabling it as soon as possible.
|
||||
|
||||
{% warning %}
|
||||
@@ -5,11 +5,19 @@ redirect_from:
|
||||
- /categories/84/articles/
|
||||
- /categories/two-factor-authentication-2fa/
|
||||
- /articles/securing-your-account-with-two-factor-authentication-2fa
|
||||
mapTopic: true
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- 2fa
|
||||
children:
|
||||
- /about-two-factor-authentication
|
||||
- /configuring-two-factor-authentication
|
||||
- /configuring-two-factor-authentication-recovery-methods
|
||||
- /accessing-github-using-two-factor-authentication
|
||||
- /recovering-your-account-if-you-lose-your-2fa-credentials
|
||||
- /changing-two-factor-authentication-delivery-methods-for-your-mobile-device
|
||||
- /countries-where-sms-authentication-is-supported
|
||||
- /disabling-two-factor-authentication-for-your-personal-account
|
||||
---
|
||||
|
||||
@@ -5,13 +5,13 @@ redirect_from:
|
||||
- /articles/recovering-your-account-if-you-lost-your-2fa-credentials/
|
||||
- /articles/authenticating-with-an-account-recovery-token/
|
||||
- /articles/recovering-your-account-if-you-lose-your-2fa-credentials
|
||||
- /github/authenticating-to-github/recovering-your-account-if-you-lose-your-2fa-credentials
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
topics:
|
||||
- 2fa
|
||||
---
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
|
||||
{% warning %}
|
||||
@@ -4,6 +4,7 @@ intro: 'You can check the verification status of your commit and tag signatures
|
||||
redirect_from:
|
||||
- /articles/checking-your-gpg-commit-and-tag-signature-verification-status/
|
||||
- /articles/checking-your-commit-and-tag-signature-verification-status
|
||||
- /github/authenticating-to-github/checking-your-commit-and-tag-signature-verification-status
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -12,7 +13,6 @@ topics:
|
||||
- Identity
|
||||
- Access management
|
||||
---
|
||||
|
||||
### Checking your commit signature verification status
|
||||
|
||||
1. On {% data variables.product.product_name %}, navigate to your pull request.
|
||||
@@ -4,7 +4,6 @@ intro: 'You may need to troubleshoot unexpected issues that arise when signing c
|
||||
redirect_from:
|
||||
- /articles/troubleshooting-gpg/
|
||||
- /articles/troubleshooting-commit-signature-verification
|
||||
mapTopic: true
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -12,5 +11,9 @@ versions:
|
||||
topics:
|
||||
- Identity
|
||||
- Access management
|
||||
children:
|
||||
- /checking-your-commit-and-tag-signature-verification-status
|
||||
- /updating-an-expired-gpg-key
|
||||
- /using-a-verified-email-address-in-your-gpg-key
|
||||
---
|
||||
|
||||
@@ -3,6 +3,7 @@ title: Updating an expired GPG key
|
||||
intro: 'When verifying a signature, {% data variables.product.product_name %} checks that the key is not revoked or expired. If your signing key is revoked or expired, {% data variables.product.product_name %} cannot verify your signatures. If your key is revoked, use the primary key or another key that is not revoked to sign your commits.'
|
||||
redirect_from:
|
||||
- /articles/updating-an-expired-gpg-key
|
||||
- /github/authenticating-to-github/updating-an-expired-gpg-key
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -11,7 +12,6 @@ topics:
|
||||
- Identity
|
||||
- Access management
|
||||
---
|
||||
|
||||
If your key is expired, you must [update the expiration](https://www.gnupg.org/gph/en/manual/c235.html#AEN328), export the new key, delete the expired key in your GitHub account, and [upload the new key to GitHub](/articles/adding-a-new-gpg-key-to-your-github-account/). Your previous commits and tags will show as verified, as long as the key meets all other verification requirements.
|
||||
|
||||
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.
|
||||
@@ -3,6 +3,7 @@ title: Using a verified email address in your GPG key
|
||||
intro: 'When verifying a signature, {% data variables.product.product_name %} checks that the committer or tagger email address matches an email address from the GPG key''s identities and is a verified email address on the user''s account. This ensures that the key belongs to you and that you created the commit or tag.'
|
||||
redirect_from:
|
||||
- /articles/using-a-verified-email-address-in-your-gpg-key
|
||||
- /github/authenticating-to-github/using-a-verified-email-address-in-your-gpg-key
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
enterprise-server: '*'
|
||||
@@ -11,7 +12,6 @@ topics:
|
||||
- Identity
|
||||
- Access management
|
||||
---
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
If you need to verify your GitHub email address, see "[Verifying your email address](/articles/verifying-your-email-address/)." {% endif %}If you need to update or add an email address to your GPG key, see "[Associating an email with your GPG key](/articles/associating-an-email-with-your-gpg-key)."
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user