1
0
mirror of synced 2025-12-21 19:06:49 -05:00

GHEC version (#20947)

Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com>
Co-authored-by: Grace Park <gracepark@github.com>
Co-authored-by: Steve Guntrip <12534592+stevecat@users.noreply.github.com>
Co-authored-by: Robert Sese <sese@github.com>
Co-authored-by: Peter Bengtsson <peterbe@github.com>
Co-authored-by: Rachael Sewell <rachmari@github.com>
This commit is contained in:
Laura Coursen
2021-10-15 15:41:33 -05:00
committed by GitHub
parent be8cb7cb8c
commit 8f964ea2cb
1592 changed files with 4984 additions and 3494 deletions

View File

@@ -9,6 +9,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
---

View File

@@ -8,6 +8,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
children:

View File

@@ -9,6 +9,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
shortTitle: Resolve merge conflicts

View File

@@ -10,6 +10,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
shortTitle: Resolve merge conflicts in Git

View File

@@ -10,6 +10,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
---

View File

@@ -9,6 +9,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
children:

View File

@@ -10,6 +10,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
shortTitle: Collaborative development

View File

@@ -9,6 +9,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
- Issues

View File

@@ -10,6 +10,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
---

View File

@@ -6,6 +6,7 @@ versions:
fpt: '*'
ghes: '>=3.1'
ghae: '*'
ghec: '*'
topics:
- Pull requests
redirect_from:
@@ -17,7 +18,7 @@ shortTitle: Merge PR automatically
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.
Before you can use auto-merge with a pull request, auto-merge must be enabled for the repository. For more information, see "[Managing auto-merge for pull requests in your repository](/github/administering-a-repository/managing-auto-merge-for-pull-requests-in-your-repository)."{% ifversion fpt or ghae-next or ghes > 3.1 %}
Before you can use auto-merge with a pull request, auto-merge must be enabled for the repository. For more information, see "[Managing auto-merge for pull requests in your repository](/github/administering-a-repository/managing-auto-merge-for-pull-requests-in-your-repository)."{% ifversion fpt or ghae-next or ghes > 3.1 or ghec %}
After you enable auto-merge for a pull request, if someone who does not have write permissions to the repository pushes new changes to the head branch or switches the base branch of the pull request, auto-merge will be disabled. For example, if a maintainer enables auto-merge for a pull request from a fork, auto-merge will be disabled after a contributor pushes new changes to the pull request.{% endif %}

View File

@@ -9,6 +9,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
---

View File

@@ -8,6 +8,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
children:

View File

@@ -9,6 +9,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
---

View File

@@ -9,6 +9,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
---

View File

@@ -12,6 +12,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
children:

View File

@@ -10,6 +10,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
---
@@ -27,11 +28,11 @@ You must have write access to a repository to create a branch, open a pull reque
{% 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 %}
By default, {% data variables.product.product_name %} names the default branch {% ifversion fpt or ghes > 2.22 or ghae %}`main`{% else %}`master`{% endif %} in any new repository.
By default, {% data variables.product.product_name %} names the default branch {% ifversion fpt or ghes > 2.22 or ghae or ghec %}`main`{% else %}`master`{% endif %} in any new repository.
{% data reusables.branches.change-default-branch %}
{% ifversion fpt or ghes > 2.22 or ghae %}
{% ifversion fpt or ghes > 2.22 or ghae or ghec %}
{% data reusables.branches.set-default-branch %}

View File

@@ -9,6 +9,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
shortTitle: Compare branches

View File

@@ -10,6 +10,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
---
@@ -31,7 +32,7 @@ Once you've created a pull request, you can push commits from your topic branch
Other contributors can review your proposed changes, add review comments, contribute to the pull request discussion, and even add commits to the pull request.
{% ifversion fpt %}
{% ifversion fpt or ghec %}
You can see information about the branch's current deployment status and past deployment activity on the "Conversation" tab. For more information, see "[Viewing deployment activity for a repository](/repositories/viewing-activity-and-data-for-your-repository/viewing-deployment-activity-for-your-repository)."
{% endif %}
@@ -71,4 +72,4 @@ The compare and pull request pages use different methods to calculate the diff f
- "[Pull request](/articles/github-glossary/#pull-request)" in the {% data variables.product.prodname_dotcom %} glossary
- "[About branches](/articles/about-branches)"
- "[Commenting on a pull request](/articles/commenting-on-a-pull-request)"
- "[Closing a pull request](/articles/closing-a-pull-request)"
- "[Closing a pull request](/articles/closing-a-pull-request)"

View File

@@ -9,6 +9,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
shortTitle: Change the base branch

View File

@@ -1,6 +1,6 @@
---
title: Changing the stage of a pull request
intro: 'You can mark a draft pull request as ready for review{% ifversion fpt or ghae or ghes %} or convert a pull request to a draft{% endif %}.'
intro: 'You can mark a draft pull request as ready for review{% ifversion fpt or ghae or ghes or ghec %} or convert a pull request to a draft{% endif %}.'
permissions: People with write permissions to a repository and pull request authors can change the stage of a pull request.
product: '{% data reusables.gated-features.draft-prs %}'
redirect_from:
@@ -11,6 +11,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
shortTitle: Change the state
@@ -19,7 +20,7 @@ shortTitle: Change the state
{% data reusables.pull_requests.mark-ready-review %}
{% ifversion fpt or ghae or ghes %}
{% ifversion fpt or ghae or ghes or ghec %}
{% tip %}
**Tip**: You can also mark a pull request as ready for review using the {% data variables.product.prodname_cli %}. For more information, see "[`gh pr ready`](https://cli.github.com/manual/gh_pr_ready)" in the {% data variables.product.prodname_cli %} documentation.
@@ -32,7 +33,7 @@ shortTitle: Change the state
3. In the merge box, click **Ready for review**.
![Ready for review button](/assets/images/help/pull_requests/ready-for-review-button.png)
{% ifversion fpt or ghae or ghes %}
{% ifversion fpt or ghae or ghes or ghec %}
## Converting a pull request to a draft

View File

@@ -9,6 +9,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
shortTitle: Commit to PR branch from fork

View File

@@ -10,6 +10,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
shortTitle: Create a PR from a fork

View File

@@ -10,6 +10,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
---
@@ -152,7 +153,7 @@ gh pr create --web
{% enddesktop %}
{% ifversion fpt %}
{% ifversion fpt or ghec %}
{% codespaces %}

View File

@@ -10,6 +10,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
shortTitle: Create & delete branches

View File

@@ -8,6 +8,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
children:

View File

@@ -9,13 +9,14 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
shortTitle: Request a PR review
---
Owners and collaborators on a repository owned by a user account can assign pull request reviews. Organization members with triage permissions to a repository can assign a pull request review.
Owners or collaborators can assign a pull request review to any person that has been explicitly granted [read access](/articles/access-permissions-on-github) to a user-owned repository. Organization members can assign a pull request review to any person or team with read access to a repository. The requested reviewer or team will receive a notification that you asked them to review the pull request. {% ifversion fpt or ghae or ghes %}If you request a review from a team and code review assignment is enabled, specific members will be requested and the team will be removed as a reviewer. For more information, see "[Managing code review assignment for your team](/organizations/organizing-members-into-teams/managing-code-review-assignment-for-your-team)."{% endif %}
Owners or collaborators can assign a pull request review to any person that has been explicitly granted [read access](/articles/access-permissions-on-github) to a user-owned repository. Organization members can assign a pull request review to any person or team with read access to a repository. The requested reviewer or team will receive a notification that you asked them to review the pull request. {% ifversion fpt or ghae or ghes or ghec %}If you request a review from a team and code review assignment is enabled, specific members will be requested and the team will be removed as a reviewer. For more information, see "[Managing code review assignment for your team](/organizations/organizing-members-into-teams/managing-code-review-assignment-for-your-team)."{% endif %}
{% note %}

View File

@@ -5,6 +5,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
---

View File

@@ -9,6 +9,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
shortTitle: About PR reviews
@@ -17,11 +18,11 @@ shortTitle: About PR reviews
After a pull request is opened, anyone with *read* access can review and comment on the changes it proposes. You can also suggest specific changes to lines of code, which the author can apply directly from the pull request. For more information, see "[Reviewing proposed changes in a pull request](/articles/reviewing-proposed-changes-in-a-pull-request)."
Repository owners and collaborators can request a pull request review from a specific person. Organization members can also request a pull request review from a team with read access to the repository. For more information, see "[Requesting a pull request review](/articles/requesting-a-pull-request-review)." {% ifversion fpt or ghae or ghes %}You can specify a subset of team members to be automatically assigned in the place of the whole team. For more information, see "[Managing code review assignment for your team](/organizations/organizing-members-into-teams/managing-code-review-assignment-for-your-team)."{% endif %}
Repository owners and collaborators can request a pull request review from a specific person. Organization members can also request a pull request review from a team with read access to the repository. For more information, see "[Requesting a pull request review](/articles/requesting-a-pull-request-review)." {% ifversion fpt or ghae or ghes or ghec %}You can specify a subset of team members to be automatically assigned in the place of the whole team. For more information, see "[Managing code review assignment for your team](/organizations/organizing-members-into-teams/managing-code-review-assignment-for-your-team)."{% endif %}
Reviews allow for discussion of proposed changes and help ensure that the changes meet the repository's contributing guidelines and other quality standards. You can define which individuals or teams own certain types or areas of code in a CODEOWNERS file. When a pull request modifies code that has a defined owner, that individual or team will automatically be requested as a reviewer. For more information, see "[About code owners](/articles/about-code-owners/)."
{% ifversion fpt %}You can schedule reminders for pull requests that need to be reviewed. For more information, see "[Managing scheduled reminders for pull requests](/github/setting-up-and-managing-organizations-and-teams/managing-scheduled-reminders-for-pull-requests)."{% endif %}
{% ifversion fpt or ghec %}You can schedule reminders for pull requests that need to be reviewed. For more information, see "[Managing scheduled reminders for pull requests](/github/setting-up-and-managing-organizations-and-teams/managing-scheduled-reminders-for-pull-requests)."{% endif %}
![Header of review requesting changes with line comments](/assets/images/help/pull_requests/review-header-with-line-comment.png)

View File

@@ -9,6 +9,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
shortTitle: Required reviews

View File

@@ -10,6 +10,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
shortTitle: Check out a PR locally
@@ -27,7 +28,7 @@ shortTitle: Check out a PR locally
{% webui %}
{% data reusables.repositories.sidebar-pr %}
2. In the list of pull requests, click the pull request you'd like to modify.{% ifversion fpt %}
2. In the list of pull requests, click the pull request you'd like to modify.{% ifversion fpt or ghec %}
3. To choose where you'd like to open the pull request, select the **Open with {% octicon "triangle-down" aria-label="The down triangle icon" %}** drop-down and click one of the tabs.
![Link to access command line pull request instructions](/assets/images/help/pull_requests/open-with-button.png){% else %}
3. In the merge box, click **command line instructions**. Follow the sequence of steps to bring down the proposed pull request.

View File

@@ -12,6 +12,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
shortTitle: Comment on a PR
@@ -60,5 +61,5 @@ Anyone watching the pull request or repository will receive a notification of yo
## Further reading
- "[Writing on GitHub](/github/writing-on-github)"
{% ifversion fpt %}- "[Reporting abuse or spam](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam)"
{% ifversion fpt or ghec %}- "[Reporting abuse or spam](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam)"
{% endif %}

View File

@@ -9,6 +9,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
shortTitle: Dismiss a PR review

View File

@@ -10,6 +10,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
shortTitle: Filter files

View File

@@ -9,6 +9,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
shortTitle: Methods & functions

View File

@@ -9,6 +9,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
shortTitle: Incorporate feedback

View File

@@ -9,6 +9,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
children:

View File

@@ -6,6 +6,7 @@ versions:
fpt: '*'
ghes: '>= 3.2'
ghae: "issue-4864"
ghec: '*'
type: how_to
topics:
- Pull requests

View File

@@ -9,6 +9,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
shortTitle: Review proposed changes
@@ -39,7 +40,7 @@ Before you submit your review, your line comments are _pending_ and only visible
![Cancel review button](/assets/images/help/pull_requests/cancel-review-button.png)
{% endwebui %}
{% ifversion fpt %}
{% ifversion fpt or ghec %}
{% codespaces %}
@@ -52,7 +53,7 @@ For more information on reviewing pull requests in {% data variables.product.pro
{% endcodespaces %}
{% endif %}
{% ifversion fpt or ghes > 3.1 %}
{% ifversion fpt or ghes > 3.1 or ghec %}
## Reviewing dependency changes
{% data reusables.dependency-review.beta %}

View File

@@ -9,6 +9,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
shortTitle: View a PR review

View File

@@ -9,6 +9,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
---
@@ -19,15 +20,15 @@ Forking a repository is similar to copying a repository, with two major differen
{% data reusables.repositories.you-can-fork %}
{% ifversion fpt %}
{% ifversion fpt or ghec %}
If you're a member of a {% data variables.product.prodname_emu_enterprise %}, there are further restrictions on the repositories you can fork. {% data reusables.enterprise-accounts.emu-forks %} For more information, see "[About {% data variables.product.prodname_emus %}](/github/setting-up-and-managing-your-enterprise/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)."
If you're a member of a {% data variables.product.prodname_emu_enterprise %}, there are further restrictions on the repositories you can fork. {% data reusables.enterprise-accounts.emu-forks %} For more information, see "[About {% data variables.product.prodname_emus %}](/enterprise-cloud@latest/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %}
{% endif %}
{% data reusables.repositories.desktop-fork %}
Deleting a fork will not delete the original upstream repository. You can make any changes you want to your fork—add collaborators, rename files, generate {% data variables.product.prodname_pages %}—with no effect on the original.{% ifversion fpt %} You cannot restore a deleted forked repository. For more information, see "[Restoring a deleted repository](/articles/restoring-a-deleted-repository)."{% endif %}
Deleting a fork will not delete the original upstream repository. You can make any changes you want to your fork—add collaborators, rename files, generate {% data variables.product.prodname_pages %}—with no effect on the original.{% ifversion fpt or ghec %} You cannot restore a deleted forked repository. For more information, see "[Restoring a deleted repository](/articles/restoring-a-deleted-repository)."{% endif %}
In open source projects, forks are often used to iterate on ideas or changes before they are offered back to the upstream repository. When you make changes in your user-owned fork and open a pull request that compares your work to the upstream repository, you can give anyone with push access to the upstream repository permission to push changes to your pull request branch. This speeds up collaboration by allowing repository maintainers the ability to make commits or run tests locally to your pull request branch from a user-owned fork before merging. You cannot give push permissions to a fork owned by an organization.
@@ -39,5 +40,5 @@ If you want to create a new repository from the contents of an existing reposito
- "[About collaborative development models](/articles/about-collaborative-development-models)"
- "[Creating a pull request from a fork](/articles/creating-a-pull-request-from-a-fork)"
- [Open Source Guides](https://opensource.guide/){% ifversion fpt %}
- [Open Source Guides](https://opensource.guide/){% ifversion fpt or ghec %}
- [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}){% endif %}

View File

@@ -10,6 +10,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
shortTitle: Allow changes to a branch

View File

@@ -9,6 +9,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
shortTitle: Configure a remote

View File

@@ -8,6 +8,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
children:

View File

@@ -9,6 +9,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
shortTitle: Merge an upstream repo

View File

@@ -9,11 +9,12 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
---
{% ifversion fpt or ghes > 3.1 or ghae-next %}
{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}
## Syncing a fork from the web UI

View File

@@ -10,6 +10,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
topics:
- Pull requests
shortTitle: Deleted or changes visibility
@@ -20,7 +21,7 @@ shortTitle: Deleted or changes visibility
When you delete a private repository, all of its private forks are also deleted.
{% ifversion fpt or ghes %}
{% ifversion fpt or ghes or ghec %}
## Deleting a public repository
@@ -32,7 +33,7 @@ When you delete a public repository, one of the existing public forks is chosen
{% data reusables.repositories.private_forks_inherit_permissions %}
{% ifversion fpt or ghes %}
{% ifversion fpt or ghes or ghec %}
## Changing a public repository to a private repository
@@ -58,7 +59,7 @@ If a private repository is made public and then deleted, its private forks will
{% endif %}
{% ifversion fpt or ghae or ghes %}
{% ifversion fpt or ghae or ghes or ghec %}
## Changing the visibility of an internal repository
@@ -82,4 +83,4 @@ If you change the visibility of an internal repository and then delete the repos
- "[About forks](/articles/about-forks)"
- "[Managing the forking policy for your repository](/github/administering-a-repository/managing-the-forking-policy-for-your-repository)"
- "[Managing the forking policy for your organization](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)"
- "{% ifversion fpt %}[Enforcing repository management policies in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-repository-management-policies-in-your-enterprise-account#enforcing-a-policy-on-forking-private-or-internal-repositories){% else %}[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-on-forking-private-or-internal-repositories){% endif %}"
- "[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-on-forking-private-or-internal-repositories)"

View File

@@ -9,6 +9,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
---
## About commits
@@ -16,7 +17,7 @@ versions:
You can add a co-author on any commits you collaborate on. For more information, see "[Creating a commit with multiple authors](/github/committing-changes-to-your-project/creating-a-commit-with-multiple-authors)."
{% ifversion fpt %}
{% ifversion fpt or ghec %}
You can also create a commit on behalf of an organization. For more information, see "[Creating a commit on behalf of an organization](/github/committing-changes-to-your-project/creating-a-commit-on-behalf-of-an-organization)."{% endif %}
Rebasing allows you to change a series of commits and can modify the order of the commits in your timeline. For more information, see "[About git rebase](/github/getting-started-with-github/about-git-rebase)."

View File

@@ -9,6 +9,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
---
## Rewriting the most recent commit message
@@ -24,7 +25,7 @@ If the commit only exists in your local repository and has not been pushed to {%
2. Type `git commit --amend` and press **Enter**.
3. In your text editor, edit the commit message, and save the commit.
- You can add a co-author by adding a trailer to the commit. For more information, see "[Creating a commit with multiple authors](/articles/creating-a-commit-with-multiple-authors)."
{% ifversion fpt %}
{% ifversion fpt or ghec %}
- You can create commits on behalf of your organization by adding a trailer to the commit. For more information, see "[Creating a commit on behalf of an organization](/articles/creating-a-commit-on-behalf-of-an-organization)"
{% endif %}

View File

@@ -6,6 +6,7 @@ redirect_from:
- /github/committing-changes-to-your-project/creating-a-commit-on-behalf-of-an-organization
versions:
fpt: '*'
ghec: '*'
shortTitle: On behalf of an organization
---
{% note %}

View File

@@ -8,13 +8,14 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
shortTitle: With multiple authors
---
## Required co-author information
Before you can add a co-author to a commit, you must know the appropriate email to use for each co-author. For the co-author's commit to count as a contribution, you must use the email associated with their {% data variables.product.product_name %} account.
Before you can add a co-author to a commit, you must know the appropriate email to use for each co-author. For the co-author's commit to count as a contribution, you must use the email associated with their account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}.
{% ifversion fpt %}
{% ifversion fpt or ghec %}
If a person chooses to keep their email address private, you should use their {% data variables.product.product_name %}-provided `no-reply` email to protect their privacy. Otherwise, the co-author's email will be available to the public in the commit message. If you want to keep your email private, you can choose to use a {% data variables.product.product_name %}-provided `no-reply` email for Git operations and ask other co-authors to list your `no-reply` email in commit trailers.

View File

@@ -7,6 +7,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
children:
- /about-commits
- /creating-a-commit-with-multiple-authors

View File

@@ -9,6 +9,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
children:
- /creating-and-editing-commits
- /viewing-and-comparing-commits

View File

@@ -8,6 +8,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
shortTitle: Commit missing in local clone
---
When you use `git show` to view a specific commit on the command line, you may get a fatal error.

View File

@@ -7,6 +7,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
children:
- /commit-exists-on-github-but-not-in-my-local-clone
- /why-are-my-commits-linked-to-the-wrong-user

View File

@@ -9,6 +9,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
shortTitle: Linked to wrong user
---
{% tip %}
@@ -19,7 +20,7 @@ shortTitle: Linked to wrong user
## Commits are linked to another user
If your commits are linked to another user, that means the email address in your local Git configuration settings is connected to that user's account on {% data variables.product.product_name %}. In this case, you can change the email in your local Git configuration settings{% ifversion ghae %} to the address associated with your account on {% data variables.product.product_name %} to link your future commits. Old commits will not be linked. For more information, see "[Setting your commit email address](/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address#setting-your-commit-email-address-in-git)."{% else %} and add the new email address to your {% data variables.product.product_name %} account to link future commits to your account.
If your commits are linked to another user, that means the email address in your local Git configuration settings is connected to that user's account on {% data variables.product.product_name %}. In this case, you can change the email in your local Git configuration settings{% ifversion ghae %} to the address associated with your account on {% data variables.product.product_name %} to link your future commits. Old commits will not be linked. For more information, see "[Setting your commit email address](/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address#setting-your-commit-email-address-in-git)."{% else %} and add the new email address to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} account to link future commits to your account.
1. To change the email address in your local Git configuration, follow the steps in "[Setting your commit email address](/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address#setting-your-commit-email-address-in-git)". If you work on multiple machines, you will need to change this setting on each one.
2. Add the email address from step 2 to your account settings by following the steps in "[Adding an email address to your GitHub account](/articles/adding-an-email-address-to-your-github-account)".{% endif %}

View File

@@ -8,6 +8,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
shortTitle: Branch & tag labels
---
If your commit is not on the default branch, an indicator will show the branches which contain the commit. If the commit is part of an unmerged pull request, it will show a link.

View File

@@ -9,6 +9,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
---
To compare different versions of your repository, append `/compare` to your repository's path.
@@ -28,10 +29,10 @@ Here's an example of a [comparison between two branches](https://github.com/octo
## Comparing tags
Comparing release tags will show you changes to your repository since the last release. {% ifversion fpt or ghae or ghes %}
Comparing release tags will show you changes to your repository since the last release. {% ifversion fpt or ghae or ghes or ghec %}
For more information, see "[Comparing releases](/github/administering-a-repository/comparing-releases)."{% endif %}
{% ifversion fpt or ghae or ghes %}To compare tags, you can select a tag name from the `compare` drop-down menu at the top of the page.{% else %} Instead of typing a branch name, type the name of your tag in the `compare` drop down menu.{% endif %}
{% ifversion fpt or ghae or ghes or ghec %}To compare tags, you can select a tag name from the `compare` drop-down menu at the top of the page.{% else %} Instead of typing a branch name, type the name of your tag in the `compare` drop down menu.{% endif %}
Here's an example of a [comparison between two tags](https://github.com/octocat/linguist/compare/v2.2.0...octocat:v2.3.3).

View File

@@ -8,6 +8,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
shortTitle: Commit views
---
On {% data variables.product.product_name %}, you can see the commit history of a repository by:

View File

@@ -7,6 +7,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
children:
- /commit-branch-and-tag-labels
- /comparing-commits

View File

@@ -6,6 +6,7 @@ redirect_from:
- /github/customizing-your-github-workflow/about-github-marketplace
versions:
fpt: '*'
ghec: '*'
---
You can discover, browse, and install free and paid tools, including {% data variables.product.prodname_github_apps %}, {% data variables.product.prodname_oauth_apps %}, and {% data variables.product.prodname_actions %}, in [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace).

View File

@@ -6,12 +6,13 @@ redirect_from:
- /github/customizing-your-github-workflow/about-integrations
versions:
fpt: '*'
ghec: '*'
---
You can install integrations in your personal account or organizations you own. You can also install {% data variables.product.prodname_github_apps %} from a third-party in a specific repository where you have admin permissions or which is owned by your organization.
## Differences between {% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_oauth_apps %}
Integrations can be {% data variables.product.prodname_github_apps %}, {% data variables.product.prodname_oauth_apps %}, or anything that utilizes {% data variables.product.product_name %} APIs or webhooks.
Integrations can be {% data variables.product.prodname_github_apps %}, {% data variables.product.prodname_oauth_apps %}, or anything that utilizes {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} APIs or webhooks.
{% data variables.product.prodname_github_apps %} offer granular permissions and request access to only what the app needs. {% data variables.product.prodname_github_apps %} also offer specific user-level permissions that each user must authorize individually when an app is installed or when the integrator changes the permissions requested by the app.

View File

@@ -7,6 +7,7 @@ redirect_from:
- /github/customizing-your-github-workflow/github-extensions-and-integrations
versions:
fpt: '*'
ghec: '*'
shortTitle: Extensions & integrations
---
## Editor tools
@@ -31,7 +32,7 @@ With the {% data variables.product.prodname_dotcom %} for Visual Studio Code ext
## Project management tools
You can integrate your {% data variables.product.product_name %} personal account or organization with third-party project management tools, such as Jira.
You can integrate your personal or organization account on {% data variables.product.product_location %} with third-party project management tools, such as Jira.
### Jira Cloud and {% data variables.product.product_name %}.com integration
@@ -39,7 +40,7 @@ You can integrate Jira Cloud with your personal or organization account to scan
## Team communication tools
You can integrate your {% data variables.product.product_name %} personal account or organization with third-party team communication tools, such as Slack or Microsoft Teams.
You can integrate your personal or organization account on {% data variables.product.product_location %} with third-party team communication tools, such as Slack or Microsoft Teams.
### Slack and {% data variables.product.product_name %} integration

View File

@@ -5,6 +5,7 @@ redirect_from:
- /articles/exploring-integrations
versions:
fpt: '*'
ghec: '*'
children:
- /about-integrations
- /about-github-marketplace

View File

@@ -4,6 +4,7 @@ redirect_from:
- /categories/customizing-your-github-workflow
versions:
fpt: '*'
ghec: '*'
children:
- /exploring-integrations
- /purchasing-and-installing-apps-in-github-marketplace

View File

@@ -5,6 +5,7 @@ redirect_from:
- /articles/purchasing-and-installing-apps-in-github-marketplace
versions:
fpt: '*'
ghec: '*'
children:
- /installing-an-app-in-your-personal-account
- /installing-an-app-in-your-organization

View File

@@ -6,6 +6,7 @@ redirect_from:
- /github/customizing-your-github-workflow/installing-an-app-in-your-organization
versions:
fpt: '*'
ghec: '*'
shortTitle: Install app organization
---
{% data reusables.marketplace.marketplace-apps-only %}

View File

@@ -6,6 +6,7 @@ redirect_from:
- /github/customizing-your-github-workflow/installing-an-app-in-your-personal-account
versions:
fpt: '*'
ghec: '*'
shortTitle: Install app user account
---
{% data reusables.marketplace.marketplace-apps-only %}

View File

@@ -10,6 +10,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
---
{% tip %}
@@ -25,6 +26,6 @@ Webhooks can be triggered whenever a variety of actions are performed on a repos
* A {% data variables.product.prodname_pages %} site is built
* A new member is added to a team
Using the {% data variables.product.product_name %} API, you can make these webhooks update an external issue tracker, trigger CI builds, update a backup mirror, or even deploy to your production server.
Using the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, you can make these webhooks update an external issue tracker, trigger CI builds, update a backup mirror, or even deploy to your production server.
To set up a new webhook, you'll need access to an external server and familiarity with the technical procedures involved. For help on building a webhook, including a full list of actions you can associate with, see "[Webhooks](/webhooks)."

View File

@@ -6,14 +6,15 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
shortTitle: Get started API
---
To automate common tasks, back up your data, or create integrations that extend {% data variables.product.product_name %}, you can use the {% data variables.product.product_name %} API.
To automate common tasks, back up your data, or create integrations that extend {% data variables.product.product_name %}, you can use the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API.
For more information about the API, see the [GitHub REST API](/rest) and [GitHub GraphQL API](/graphql). You can also stay current with API-related news by following the [{% data variables.product.prodname_dotcom %} Developer blog](https://developer.github.com/changes/).
For more information about the API, see the [GitHub REST API](/rest) and [GitHub GraphQL API]({% ifversion ghec %}/free-pro-team@latest/{% endif %}/graphql). You can also stay current with API-related news by following the [{% data variables.product.prodname_dotcom %} Developer blog](https://developer.github.com/changes/).
## Further reading
- "[Backing up a repository](/articles/backing-up-a-repository)"{% ifversion fpt %}
- "[Backing up a repository](/articles/backing-up-a-repository)"{% ifversion fpt or ghec %}
- "[About integrations](/articles/about-integrations)"{% endif %}

View File

@@ -9,6 +9,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
shortTitle: Automate with OAuth tokens
---
@@ -18,7 +19,7 @@ Create a personal access token on your application settings page. For more infor
{% tip %}
{% ifversion fpt %}
{% ifversion fpt or ghec %}
**Tips:**
- You must verify your email address before you can create a personal access token. For more information, see "[Verifying your email address](/articles/verifying-your-email-address)."
- {% data reusables.user_settings.review_oauth_tokens_tip %}
@@ -28,7 +29,7 @@ Create a personal access token on your application settings page. For more infor
{% endtip %}
{% ifversion fpt %}{% data reusables.user_settings.removes-personal-access-tokens %}{% endif %}
{% ifversion fpt or ghec %}{% data reusables.user_settings.removes-personal-access-tokens %}{% endif %}
## Step 2: Clone a repository

View File

@@ -8,6 +8,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
children:
- /getting-started-with-the-api
- /git-automation-with-oauth-tokens

View File

@@ -6,6 +6,7 @@ redirect_from:
- /github/importing-your-projects-to-github/about-github-importer
versions:
fpt: '*'
ghec: '*'
---
GitHub Importer is a tool that quickly imports source code repositories, including commits and revision history, to GitHub for you.

View File

@@ -9,6 +9,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
shortTitle: Add a project locally
---
@@ -26,7 +27,7 @@ shortTitle: Add a project locally
## Adding a project to {% data variables.product.product_name %} with {% data variables.product.prodname_cli %}
{% data variables.product.prodname_cli %} is an open source tool for using {% data variables.product.product_name %} from your computer's command line. {% data variables.product.prodname_cli %} can simplify the process of adding an existing project to {% data variables.product.product_name %} using the command line. To learn more about {% data variables.product.prodname_cli %}, see "[About {% data variables.product.prodname_cli %}](/github-cli/github-cli/about-github-cli)."
{% data variables.product.prodname_cli %} is an open source tool for using {% data variables.product.prodname_dotcom %} from your computer's command line. {% data variables.product.prodname_cli %} can simplify the process of adding an existing project to {% data variables.product.product_name %} using the command line. To learn more about {% data variables.product.prodname_cli %}, see "[About {% data variables.product.prodname_cli %}](/github-cli/github-cli/about-github-cli)."
1. In the command line, navigate to the root directory of your project.
1. Initialize the local directory as a Git repository.
@@ -76,7 +77,7 @@ shortTitle: Add a project locally
$ git commit -m "First commit"
# Commits the tracked changes and prepares them to be pushed to a remote repository. {% data reusables.git.reset-head-to-previous-commit-codeblock %}
```
7. At the top of your {% data variables.product.product_name %} repository's Quick Setup page, click {% octicon "clippy" aria-label="The copy to clipboard icon" %} to copy the remote repository URL.
7. At the top of your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}'s Quick Setup page, click {% octicon "clippy" aria-label="The copy to clipboard icon" %} to copy the remote repository URL.
![Copy remote repository URL field](/assets/images/help/repository/copy-remote-repository-url-quick-setup.png)
8. In Terminal, [add the URL for the remote repository](/github/getting-started-with-github/managing-remote-repositories) where your local repository will be pushed.
```shell
@@ -113,7 +114,7 @@ shortTitle: Add a project locally
$ git commit -m "First commit"
# Commits the tracked changes and prepares them to be pushed to a remote repository. {% data reusables.git.reset-head-to-previous-commit-codeblock %}
```
7. At the top of your {% data variables.product.product_name %} repository's Quick Setup page, click {% octicon "clippy" aria-label="The copy to clipboard icon" %} to copy the remote repository URL.
7. At the top of your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}'s Quick Setup page, click {% octicon "clippy" aria-label="The copy to clipboard icon" %} to copy the remote repository URL.
![Copy remote repository URL field](/assets/images/help/repository/copy-remote-repository-url-quick-setup.png)
8. In the Command prompt, [add the URL for the remote repository](/github/getting-started-with-github/managing-remote-repositories) where your local repository will be pushed.
```shell
@@ -150,7 +151,7 @@ shortTitle: Add a project locally
$ git commit -m "First commit"
# Commits the tracked changes and prepares them to be pushed to a remote repository. {% data reusables.git.reset-head-to-previous-commit-codeblock %}
```
7. At the top of your {% data variables.product.product_name %} repository's Quick Setup page, click {% octicon "clippy" aria-label="The copy to clipboard icon" %} to copy the remote repository URL.
7. At the top of your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}'s Quick Setup page, click {% octicon "clippy" aria-label="The copy to clipboard icon" %} to copy the remote repository URL.
![Copy remote repository URL field](/assets/images/help/repository/copy-remote-repository-url-quick-setup.png)
8. In Terminal, [add the URL for the remote repository](/github/getting-started-with-github/managing-remote-repositories) where your local repository will be pushed.
```shell

View File

@@ -8,6 +8,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
shortTitle: Import repo locally
---
Before you start, make sure you know:
@@ -22,7 +23,7 @@ For purposes of demonstration, we'll use:
- An external account named **extuser**
- An external Git host named `https://external-host.com`
- A {% data variables.product.product_name %} personal user account named **ghuser**
- A {% data variables.product.product_name %} repository named **repo.git**
- A repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} named **repo.git**
{% endtip %}
@@ -36,7 +37,7 @@ For purposes of demonstration, we'll use:
```shell
$ cd <em>repo.git</em>
$ git push --mirror https://{% data variables.command_line.codeblock %}/<em>ghuser</em>/<em>repo.git</em>
# Pushes the mirror to the new {% data variables.product.product_name %} repository
# Pushes the mirror to the new repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}
```
4. Remove the temporary local repository.
```shell

View File

@@ -7,6 +7,7 @@ redirect_from:
- /github/importing-your-projects-to-github/importing-a-repository-with-github-importer
versions:
fpt: '*'
ghec: '*'
shortTitle: Use GitHub Importer
---
{% tip %}

View File

@@ -11,6 +11,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
children:
- /about-github-importer
- /importing-a-repository-with-github-importer

View File

@@ -9,9 +9,10 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
shortTitle: Code migration tools
---
{% ifversion fpt %}
{% ifversion fpt or ghec %}
We recommend using [GitHub Importer](/articles/about-github-importer) to import projects from Subversion, Mercurial, Team Foundation Version Control (TFVC), or another Git repository. You can also use these external tools to convert your project to Git.
@@ -45,7 +46,7 @@ For more information about moving from TFVC (a centralized version control syste
{% endtip %}
{% ifversion fpt %}
{% ifversion fpt or ghec %}
## Further reading

View File

@@ -6,6 +6,7 @@ redirect_from:
- /github/importing-your-projects-to-github/updating-commit-author-attribution-with-github-importer
versions:
fpt: '*'
ghec: '*'
shortTitle: Update author GitHub Importer
---
GitHub Importer looks for GitHub users whose email addresses match the authors of the commits in the repository you're importing. You can then connect a commit to its author using their email address or the author's GitHub username.

View File

@@ -10,6 +10,7 @@ versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
children:
- /importing-source-code-to-github
- /working-with-subversion-on-github

View File

@@ -6,6 +6,7 @@ redirect_from:
versions:
fpt: '*'
ghes: '*'
ghec: '*'
children:
- /what-are-the-differences-between-subversion-and-git
- /support-for-subversion-clients

View File

@@ -7,6 +7,7 @@ redirect_from:
versions:
fpt: '*'
ghes: '*'
ghec: '*'
shortTitle: Properties supported by GitHub
---
## Executable files (svn:executable)

View File

@@ -7,6 +7,7 @@ redirect_from:
versions:
fpt: '*'
ghes: '*'
ghec: '*'
shortTitle: Support for Subversion clients
---
GitHub supports Subversion clients via the HTTPS protocol. We use a Subversion bridge to communicate svn commands to GitHub.

View File

@@ -8,6 +8,7 @@ redirect_from:
versions:
fpt: '*'
ghes: '*'
ghec: '*'
shortTitle: Subversion & Git differences
---
## Directory structure
@@ -48,7 +49,7 @@ A *subproject* is a project that's developed and managed somewhere outside of yo
In SVN, a subproject is called an *SVN external*. In Git, it's called a *Git submodule*. Although conceptually similar, Git submodules are not kept up-to-date automatically; you must explicitly ask for a new version to be brought into your project.
For more information, see [Git Tools Submodules](https://git-scm.com/book/en/Git-Tools-Submodules)" in the Git documentation.
For more information, see "[Git Tools Submodules](https://git-scm.com/book/en/Git-Tools-Submodules)" in the Git documentation.
## Preserving history

View File

@@ -7,11 +7,11 @@ redirect_from:
intro: 'Documentation, guides, and help topics for software developers, designers, and project managers. Covers using Git, pull requests, issues, wikis, gists, and everything you need to make the most of GitHub for development.'
versions:
fpt: '*'
ghec: '*'
ghes: '*'
ghae: '*'
children:
- /copilot
- /setting-up-and-managing-your-enterprise
- /writing-on-github
- /committing-changes-to-your-project
- /collaborating-with-pull-requests
@@ -24,4 +24,5 @@ children:
- /understanding-how-github-uses-and-protects-your-data
- /site-policy
- /site-policy-deprecated
- /setting-up-and-managing-your-enterprise
---

View File

@@ -0,0 +1,25 @@
---
title: Setting up and managing your enterprise
shortTitle: Enterprise management
redirect_from:
- /github/setting-up-and-managing-your-enterprise-account
- /categories/setting-up-and-managing-your-enterprise-account
versions:
fpt: '*'
ghec: '*'
ghes: '*'
ghae: '*'
topics:
- Enterprise
- Policies
---
## This documentation has moved
{% ifversion fpt or ghec %}
Enterprise owners on {% data variables.product.prodname_dotcom_the_website %} can now find documentation about enterprise management in the new {% data variables.product.prodname_ghe_cloud %} version of "[Enterprise administrators]({% ifversion fpt or ghec %}/enterprise-cloud@latest{% endif %}/admin#all-docs)."
For more information about the {% data variables.product.prodname_ghe_cloud %} version of GitHub Docs, see [{% data variables.product.prodname_blog %}](https://github.blog/changelog/2021-10-15-ghec-version-docs/).
{% else %}
Enterprise owners on {% data variables.product.product_name %} can now find documentation about enterprise management in "[Enterprise administrators](/admin#all-docs)."
{% endif %}

View File

@@ -1,39 +0,0 @@
---
title: About identity and access management for your enterprise account
intro: 'You can centrally manage access to your enterprise''s resources, organization membership, and team membership using your identity provider (IdP).'
product: '{% data reusables.gated-features.enterprise-accounts %}'
versions:
fpt: '*'
topics:
- Enterprise
redirect_from:
- /github/setting-up-and-managing-your-enterprise/about-identity-and-access-management-for-your-enterprise-account
shortTitle: IAM for your enterprise
---
## About identity and access management for your enterprise account
{% data reusables.saml.dotcom-saml-explanation %} {% data reusables.saml.about-saml-enterprise-accounts %} For more information, see "[Enforcing SAML single sign-on for organizations in your enterprise account](/github/setting-up-and-managing-your-enterprise/configuring-identity-and-access-management-for-your-enterprise-account/enforcing-saml-single-sign-on-for-organizations-in-your-enterprise-account)."
After you enable SAML SSO, depending on the IdP you use, you may be able to enable additional identity and access management features. {% data reusables.scim.enterprise-account-scim %}
If you use Azure AD as your IDP, you can use team synchronization to manage team membership within each organization. {% data reusables.identity-and-permissions.about-team-sync %} For more information, see "[Managing team synchronization for organizations in your enterprise account](/github/setting-up-and-managing-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise-account)."
{% data reusables.saml.switching-from-org-to-enterprise %} For more information, see "[Switching your SAML configuration from an organization to an enterprise account](/github/setting-up-and-managing-your-enterprise/configuring-identity-and-access-management-for-your-enterprise-account/switching-your-saml-configuration-from-an-organization-to-an-enterprise-account)."
## About {% data variables.product.prodname_emus %}
{% data reusables.enterprise-accounts.emu-short-summary %}
Configuring {% data variables.product.prodname_emus %} for SAML single-sign on and user provisioning involves following a different process than you would for an enterprise that isn't using {% data variables.product.prodname_managed_users %}. If your enterprise uses {% data variables.product.prodname_emus %}, see "[Configuring SAML single sign-on for Enterprise Managed Users](/github/setting-up-and-managing-your-enterprise/managing-your-enterprise-users-with-your-identity-provider/configuring-saml-single-sign-on-for-enterprise-managed-users)."
## Supported IdPs
We test and officially support the following IdPs. For SAML SSO, we offer limited support for all identity providers that implement the SAML 2.0 standard. For more information, see the [SAML Wiki](https://wiki.oasis-open.org/security) on the OASIS website.
IdP | SAML | Team synchronization |
--- | :--: | :-------: |
Active Directory Federation Services (AD FS) | {% octicon "check-circle-fill" aria-label= "The check icon" %} | |
Azure Active Directory (Azure AD) | {% octicon "check-circle-fill" aria-label="The check icon" %} | {% octicon "check-circle-fill" aria-label="The check icon" %} |
OneLogin | {% octicon "check-circle-fill" aria-label="The check icon" %} | |
PingOne | {% octicon "check-circle-fill" aria-label="The check icon" %} | |
Shibboleth | {% octicon "check-circle-fill" aria-label="The check icon" %} | |

View File

@@ -1,78 +0,0 @@
---
title: Configuring SAML single sign-on for your enterprise account using Okta
intro: 'You can use Security Assertion Markup Language (SAML) single sign-on (SSO) with Okta to automatically manage access to your enterprise account on {% data variables.product.product_name %}.'
product: '{% data reusables.gated-features.enterprise-accounts %}'
redirect_from:
- /github/setting-up-and-managing-your-enterprise/configuring-single-sign-on-for-your-enterprise-account-using-okta
- /github/setting-up-and-managing-your-enterprise-account/configuring-saml-single-sign-on-for-your-enterprise-account-using-okta
- /github/setting-up-and-managing-your-enterprise/configuring-saml-single-sign-on-for-your-enterprise-account-using-okta
- /github/setting-up-and-managing-your-enterprise/configuring-identity-and-access-management-for-your-enterprise-account/configuring-saml-single-sign-on-for-your-enterprise-account-using-okta
versions:
fpt: '*'
topics:
- Enterprise
shortTitle: Configure SAML with Okta
---
{% data reusables.enterprise-accounts.user-provisioning-release-stage %}
{% data reusables.enterprise-accounts.emu-saml-note %}
## About SAML with Okta
You can control access to your enterprise account in {% data variables.product.product_name %} and other web applications from one central interface by configuring the enterprise account to use SAML SSO with Okta, an Identity Provider (IdP).
SAML SSO controls and secures access to enterprise account resources like organizations, repositories, issues, and pull requests. For more information, see "[Enforcing SAML single sign-on for organizations in your enterprise account](/github/setting-up-and-managing-your-enterprise/configuring-identity-and-access-management-for-your-enterprise-account/enforcing-saml-single-sign-on-for-organizations-in-your-enterprise-account)."
{% data reusables.saml.switching-from-org-to-enterprise %} For more information, see "[Switching your SAML configuration from an organization to an enterprise account](/github/setting-up-and-managing-your-enterprise/configuring-identity-and-access-management-for-your-enterprise-account/switching-your-saml-configuration-from-an-organization-to-an-enterprise-account)."
## Prerequisites
{% data reusables.saml.use-classic-ui %}
## Adding the {% data variables.product.prodname_ghe_cloud %} application in Okta
{% data reusables.saml.okta-admin-button %}
{% data reusables.saml.okta-dashboard-click-applications %}
{% data reusables.saml.add-okta-application %}
{% data reusables.saml.search-ghec-okta %}
1. Click "{% data variables.product.prodname_ghe_cloud %} - Enterprise Accounts".
1. Click **Add**.
1. Optionally, to the right of "Application label", type a descriptive name for the application.
![Application label field](/assets/images/help/saml/okta-application-label.png)
1. To the right of "{% data variables.product.prodname_dotcom %} Enterprises", type the name of your enterprise account. For example, if your enterprise account's URL is `https://github.com/enterprises/octo-corp`, type `octo-corp`.
![GitHub Enterprises field](/assets/images/help/saml/okta-github-enterprises.png)
1. Click **Done**.
## Enabling and testing SAML SSO
{% data reusables.saml.okta-admin-button %}
{% data reusables.saml.okta-dashboard-click-applications %}
{% data reusables.saml.click-enterprise-account-application %}
{% data reusables.saml.assign-yourself-to-okta %}
{% data reusables.saml.okta-sign-on-tab %}
1. To the right of Settings, click **Edit**.
1. Under "Configured SAML Attributes", to the right of "groups", use the drop-down menu and select **Matches regex**.
1. To the right of the drop-down menu, type `.*.*`.
1. Click **Save**.
{% data reusables.saml.okta-view-setup-instructions %}
1. Enable SAML for your enterprise account using the information in the setup instructions. For more information, see "[Enforcing SAML single sign-on for organizations in your enterprise account](/github/setting-up-and-managing-your-enterprise/configuring-identity-and-access-management-for-your-enterprise-account/enforcing-saml-single-sign-on-for-organizations-in-your-enterprise-account)."
## Creating groups in Okta
1. In Okta, create a group to match each organization owned by your enterprise account. The name of each group must match the account name of the organization (not the organization's display name). For example, if the URL of the organization is `https://github.com/octo-org`, name the group `octo-org`.
1. Assign the application you created for your enterprise account to each group. {% data variables.product.prodname_dotcom %} will receive all `groups` data for each user.
1. Add users to groups based on the organizations you'd like users to belong to.
## Enabling SAML user provisioning
{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.security-tab %}
1. Under "SAML User Provisioning", select **Enable SAML user provisioning**.
![Checkbox to enable user provisioning with SAML](/assets/images/help/business-accounts/user-provisioning.png)
1. Click **Save**.
1. Optionally, enable SAML user deprovisioning.
- Select **Enable SAML user deprovisioning**, then click **Save**.
![Checkbox to enable user deprovisioning with SAML](/assets/images/help/business-accounts/saml-deprovisioning.png)
- Read the warning, then click **Enable SAML deprovisioning**.
![Enable SAML deprovisioning button](/assets/images/help/business-accounts/saml-deprovisioning-confirm.png)

View File

@@ -1,58 +0,0 @@
---
title: Enforcing SAML single sign-on for organizations in your enterprise account
intro: 'You can control and secure access to resources like repositories, issues, and pull requests by enforcing SAML single sign-on (SSO) and centralized authentication through an IdP across all organizations owned by an enterprise account.'
product: '{% data reusables.gated-features.enterprise-accounts %}'
permissions: Enterprise owners can enforce SAML single sign-on for organizations in an enterprise account.
versions:
fpt: '*'
topics:
- Enterprise
redirect_from:
- /github/setting-up-and-managing-your-enterprise/configuring-identity-and-access-management-for-your-enterprise-account/enabling-saml-single-sign-on-for-organizations-in-your-enterprise-account
- /github/setting-up-and-managing-your-enterprise/enabling-saml-single-sign-on-for-organizations-in-your-enterprise-account
shortTitle: Enforce SAML
---
{% data reusables.enterprise-accounts.emu-saml-note %}
## About SAML single sign-on for enterprise accounts
{% data reusables.saml.dotcom-saml-explanation %} For more information, see "[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)."
{% data reusables.saml.about-saml-enterprise-accounts %}
{% data reusables.saml.about-saml-access-enterprise-account %} For more information, see "[Viewing and managing a user's SAML access to your enterprise account](/github/setting-up-and-managing-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise-account)."
{% data reusables.saml.saml-supported-idps %}
{% data reusables.scim.enterprise-account-scim %}
## Enforcing SAML single-sign on for organizations in your enterprise account
{% note %}
**Notes:**
- When you enable SAML SSO for your enterprise, the enterprise configuration will override any existing organization-level SAML configurations. {% data reusables.saml.switching-from-org-to-enterprise %} For more information, see "[Switching your SAML configuration from an organization to an enterprise account](/github/setting-up-and-managing-your-enterprise/configuring-identity-and-access-management-for-your-enterprise-account/switching-your-saml-configuration-from-an-organization-to-an-enterprise-account)."
- When you enforce SAML SSO for an organization, {% data variables.product.company_short %} removes any members of the organization that have not authenticated successfully with your SAML IdP. When you require SAML SSO for your enterprise, {% data variables.product.company_short %} does not remove members of the enterprise that have not authenticated successfully with your SAML IdP. The next time a member accesses the enterprise's resources, the member must authenticate with your SAML IdP.
{% endnote %}
For more detailed information about how to enable SAML using Okta, see "[Configuring SAML single sign-on for your enterprise account using Okta](/github/setting-up-and-managing-your-enterprise/configuring-saml-single-sign-on-for-your-enterprise-account-using-okta)."
{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.security-tab %}
4. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %}
5. Under "SAML single sign-on", select **Require SAML authentication**.
![Checkbox for enabling SAML SSO](/assets/images/help/business-accounts/enable-saml-auth-enterprise.png)
6. In the **Sign on URL** field, type the HTTPS endpoint of your IdP for single sign-on requests. This value is available in your IdP configuration.
![Field for the URL that members will be forwarded to when signing in](/assets/images/help/saml/saml_sign_on_url_business.png)
7. Optionally, in the **Issuer** field, type your SAML issuer URL to verify the authenticity of sent messages.
![Field for the SAML issuer's name](/assets/images/help/saml/saml_issuer.png)
8. Under **Public Certificate**, paste a certificate to verify SAML responses.
![Field for the public certificate from your identity provider](/assets/images/help/saml/saml_public_certificate.png)
9. To verify the integrity of the requests from your SAML issuer, click {% octicon "pencil" aria-label="The edit icon" %}. Then in the "Signature Method" and "Digest Method" drop-downs, choose the hashing algorithm used by your SAML issuer.
![Drop-downs for the Signature Method and Digest method hashing algorithms used by your SAML issuer](/assets/images/help/saml/saml_hashing_method.png)
10. Before enabling SAML SSO for your enterprise, click **Test SAML configuration** to ensure that the information you've entered is correct. ![Button to test SAML configuration before enforcing](/assets/images/help/saml/saml_test.png)
11. Click **Save**.

View File

@@ -1,17 +0,0 @@
---
title: Configuring identity and access management for your enterprise account
intro: You can manage SAML single sign-on and team synchronization for your enterprise.
product: '{% data reusables.gated-features.enterprise-accounts %}'
versions:
fpt: '*'
topics:
- Enterprise
children:
- /about-identity-and-access-management-for-your-enterprise-account
- /enforcing-saml-single-sign-on-for-organizations-in-your-enterprise-account
- /configuring-saml-single-sign-on-for-your-enterprise-account-using-okta
- /managing-team-synchronization-for-organizations-in-your-enterprise-account
- /switching-your-saml-configuration-from-an-organization-to-an-enterprise-account
shortTitle: Configure IAM
---

View File

@@ -1,52 +0,0 @@
---
title: Managing team synchronization for organizations in your enterprise account
intro: 'You can enable team synchronization between an identity provider (IdP) and {% data variables.product.product_name %} to allow organizations owned by your enterprise account to manage team membership through IdP groups.'
product: '{% data reusables.gated-features.enterprise-accounts %}'
permissions: Enterprise owners can manage team synchronization for an enterprise account.
versions:
fpt: '*'
topics:
- Enterprise
redirect_from:
- /github/setting-up-and-managing-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise-account
shortTitle: Manage team synchronization
---
{% data reusables.enterprise-accounts.emu-scim-note %}
## About team synchronization for enterprise accounts
If you use Azure AD as your IdP, you can enable team synchronization for your enterprise account to allow organization owners and team maintainers to synchronize teams in the organizations owned by your enterprise accounts with IdP groups.
{% data reusables.identity-and-permissions.about-team-sync %}
{% data reusables.identity-and-permissions.sync-team-with-idp-group %}
{% data reusables.identity-and-permissions.team-sync-disable %}
You can also configure and manage team synchronization for an individual organization. For more information, see "[Managing team synchronization for your organization](/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization)."
{% data reusables.identity-and-permissions.team-sync-usage-limits %}
## Prerequisites
You or your Azure AD administrator must be a Global administrator or a Privileged Role administrator in Azure AD.
You must enforce SAML single sign-on for organizations in your enterprise account with your supported IdP. For more information, see "[Enforcing SAML single sign-on for organizations in your enterprise account](/github/setting-up-and-managing-your-enterprise/configuring-identity-and-access-management-for-your-enterprise-account/enforcing-saml-single-sign-on-for-organizations-in-your-enterprise-account)."
You must authenticate to your enterprise account using SAML SSO and the supported IdP. For more information, see "[Authenticating with SAML single sign-on](/articles/authenticating-with-saml-single-sign-on)."
## Managing team synchronization for Azure AD
{% data reusables.identity-and-permissions.team-sync-azure-permissions %}
{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.security-tab %}
{% data reusables.identity-and-permissions.team-sync-confirm-saml %}
{% data reusables.identity-and-permissions.enable-team-sync-azure %}
{% data reusables.identity-and-permissions.team-sync-confirm %}
7. Review the details for the IdP tenant you want to connect to your enterprise account, then click **Approve**.
![Pending request to enable team synchronization to a specific IdP tenant with option to approve or cancel request](/assets/images/help/teams/approve-team-synchronization.png)
8. To disable team synchronization, click **Disable team synchronization**.
![Disable team synchronization](/assets/images/help/teams/disable-team-synchronization.png)

View File

@@ -1,41 +0,0 @@
---
title: Switching your SAML configuration from an organization to an enterprise account
intro: 'Learn special considerations and best practices for replacing an organization-level SAML configuration with an enterprise-level SAML configuration.'
product: '{% data reusables.gated-features.enterprise-accounts %}'
permissions: Enterprise owners can configure SAML single sign-on for an enterprise account.
versions:
fpt: '*'
topics:
- Enterprise
shortTitle: Switching from organization
---
{% data reusables.enterprise-accounts.emu-saml-note %}
## About SAML single sign-on for enterprise accounts
{% data reusables.saml.dotcom-saml-explanation %} {% data reusables.saml.about-saml-enterprise-accounts %}
{% data reusables.saml.switching-from-org-to-enterprise %}
When you configure SAML SSO at the organization level, each organization must be configured with a unique SSO tenant in your IdP, which means that your members will be associated with a unique SAML identity record for each organization they have successfully authenticated with. If you configure SAML SSO for your enterprise account instead, each enterprise member will have one SAML identity that is used for all organizations owned by the enterprise account.
After you configure SAML SSO for your enterprise account, the new configuration will override any existing SAML SSO configurations for organizations owned by the enterprise account.
Enterprise members will not be notified when an enterprise owner enables SAML for the enterprise account. If SAML SSO was previously enforced at the organization level, members should not see a major difference when navigating directly to organization resources. The members will continue to be prompted to authenticate via SAML. If members navigate to organization resources via their IdP dashboard, they will need to click the new tile for the enterprise-level app, instead of the old tile for the organization-level app. The members will then be able to choose the organization to navigate to.
Any personal access tokens (PATs), SSH keys, {% data variables.product.prodname_oauth_apps %}, and {% data variables.product.prodname_github_apps %} that were previously authorized for the organization will continue to be authorized for the organization. However, members will need to authorize any PATs, SSH keys, {% data variables.product.prodname_oauth_apps %}, and {% data variables.product.prodname_github_apps %} that were never authorized for use with SAML SSO for the organization.
SCIM provisioning is not currently supported when SAML SSO is configured for an enterprise account. If you are currently using SCIM for an organization owned by your enterprise account, you will lose this functionality when switching to an enterprise-level configuration.
You are not required to remove any organization-level SAML configurations before configuring SAML SSO for your enterprise account, but you may want to consider doing so. If SAML is ever disabled for the enterprise account in the future, any remaining organization-level SAML configurations will take effect. Removing the organization-level configurations can prevent unexpected issues in the future.
## Switching your SAML configuration from an organization to an enterprise account
1. Enforce SAML SSO for your enterprise account, making sure all organization members are assigned or given access to the IdP app being used for the enterprise account. For more information, see "[Enforcing SAML single sign-on for organizations in your enterprise account](/github/setting-up-and-managing-your-enterprise/configuring-identity-and-access-management-for-your-enterprise-account/enforcing-saml-single-sign-on-for-organizations-in-your-enterprise-account)."
1. Optionally, remove any existing SAML configuration for organizations owned by the enterprise account. To help you decide whether to remove the configurations, see "[About SAML single sign-on for enterprise accounts](#about-saml-single-sign-on-for-enterprise-accounts)."
1. If you kept any organization-level SAML configurations in place, to prevent confusion, consider hiding the tile for the organization-level apps in your IdP.
1. Advise your enterprise members about the change.
- Members will no longer be able to access their organizations by clicking the SAML app for the organization in the IdP dashboard. They will need to use the new app configured for the enterprise account.
- Members will need to authorize any PATs or SSH keys that were not previously authorized for use with SAML SSO for their organization. For more information, see "[Authorizing a personal access token for use with SAML single sign-on](/github/authenticating-to-github/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)" and "[Authorizing an SSH key for use with SAML single sign-on](/github/authenticating-to-github/authenticating-with-saml-single-sign-on/authorizing-an-ssh-key-for-use-with-saml-single-sign-on)."
- Members may need to reauthorize {% data variables.product.prodname_oauth_apps %} that were previously authorized for the organization. For more information, see "[About authentication with SAML single sign-on](/github/authenticating-to-github/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on#about-oauth-apps-and-saml-sso)."

View File

@@ -1,22 +0,0 @@
---
title: Setting up and managing your enterprise
shortTitle: Your enterprise
product: '{% data reusables.gated-features.enterprise-accounts %}'
redirect_from:
- /github/setting-up-and-managing-your-enterprise-account
- /categories/setting-up-and-managing-your-enterprise-account
versions:
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- Enterprise
children:
- /managing-your-enterprise-account
- /managing-users-in-your-enterprise
- /managing-your-enterprise-users-with-your-identity-provider
- /managing-organizations-in-your-enterprise-account
- /configuring-identity-and-access-management-for-your-enterprise-account
- /setting-policies-for-organizations-in-your-enterprise-account
---

View File

@@ -1,50 +0,0 @@
---
title: Adding organizations to your enterprise account
intro: You can create new organizations or invite existing organizations to manage within your enterprise account.
product: '{% data reusables.gated-features.enterprise-accounts %}'
redirect_from:
- /articles/adding-organizations-to-your-enterprise-account
- /github/setting-up-and-managing-your-enterprise-account/adding-organizations-to-your-enterprise-account
- /github/setting-up-and-managing-your-enterprise/adding-organizations-to-your-enterprise-account
versions:
fpt: '*'
topics:
- Enterprise
shortTitle: Add organizations
---
Enterprise owners can create new organizations within an enterprise account's settings or invite existing organizations to join an enterprise account.
To add an organization to your enterprise account, you must create the organization from within the enterprise account settings.
## Creating an organization in your enterprise account
New organizations you create within your enterprise account settings are included in your enterprise account's {% data variables.product.prodname_ghe_cloud %} subscription. For more information on collaborating in organizations, see "[Setting up and managing organizations and teams](/categories/setting-up-and-managing-organizations-and-teams)."
Enterprise owners who create an organization owned by the enterprise account automatically become organization owners. For more information about organization owners, see "[Permission levels for an organization](/articles/permission-levels-for-an-organization)."
{% data reusables.enterprise-accounts.access-enterprise %}
2. On the **Organizations** tab, above the list of organizations, click **New organization**.
![New organization button](/assets/images/help/business-accounts/enterprise-account-add-org.png)
3. Under "Organization name", type a name for your organization.
![Field to type a new organization name](/assets/images/help/business-accounts/new-organization-name-field.png)
4. Click **Create organization**.
5. Under "Invite owners", type the username of a person you'd like to invite to become an organization owner, then click **Invite**.
![Organization owner search field and Invite button](/assets/images/help/business-accounts/invite-org-owner.png)
6. Click **Finish**.
## Inviting an organization to join your enterprise account
Enterprise owners can invite existing organizations to join their enterprise account. If the organization you want to invite is already owned by another enterprise, you will not be able to issue an invitation until the previous enterprise gives up ownership of the organization.
{% data reusables.enterprise-accounts.access-enterprise %}
2. On the **Organizations** tab, above the list of organizations, click **Invite organization**.
![Invite organization](/assets/images/help/business-accounts/enterprise-account-invite-organization.png)
3. Under "Organization name", start typing the name of the organization you want to invite and select it when it appears in the drop-down list.
![Search for organization](/assets/images/help/business-accounts/enterprise-account-search-for-organization.png)
4. Click **Invite organization**.
5. The organization owners will receive an email inviting them to join the organization. At least one owner needs to accept the invitation before the process can continue. You can cancel or resend the invitation at any time before an owner approves it.
![Cancel or resend](/assets/images/help/business-accounts/enterprise-account-invitation-sent.png)
6. Once an organization owner has approved the invitation, you can view its status in the list of pending invitations.
![Pending invitation](/assets/images/help/business-accounts/enterprise-account-pending.png)
7. Click **Approve** to complete the transfer, or **Cancel** to cancel it.
![Approve invitation](/assets/images/help/business-accounts/enterprise-account-transfer-approve.png)

View File

@@ -1,31 +0,0 @@
---
title: Configuring webhooks for organization events in your enterprise account
intro: Enterprise owners can configure webhooks for events in organizations owned by an enterprise account.
product: '{% data reusables.gated-features.enterprise-accounts %}'
redirect_from:
- /articles/configuring-webhooks-for-organization-events-in-your-business-account/
- /articles/configuring-webhooks-for-organization-events-in-your-enterprise-account
- /github/setting-up-and-managing-your-enterprise-account/configuring-webhooks-for-organization-events-in-your-enterprise-account
- /github/setting-up-and-managing-your-enterprise/configuring-webhooks-for-organization-events-in-your-enterprise-account
versions:
fpt: '*'
topics:
- Enterprise
shortTitle: Configure webhooks
---
You can configure webhooks to receive events from organizations owned by your enterprise account. For more information about webhooks, see "[Webhooks](/webhooks/)."
{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.hooks-tab %}
4. Next to "Webhooks", click **Add webhook**.
![Add webhook button in the Webhooks sidebar](/assets/images/help/business-accounts/add-webhook-button.png)
5. Type a payload URL, then optionally customize the configuration. For more information, see "[Creating webhooks](/webhooks/creating/#creating-webhooks)."
![Fields for payload URL and other customization options](/assets/images/help/business-accounts/webhook-payload-url-and-customization-options.png)
6. Under "Which events would you like to trigger this webhook?", select **Let me select individual events**.
![Selecting individual events](/assets/images/help/business-accounts/webhook-let-me-select-individual-events.png)
7. Select one or more enterprise account events for your webhook to receive. For more information, see "[Event types and payloads](/webhooks/event-payloads/)."
![Selecting individual events](/assets/images/help/business-accounts/webhook-selected-events.png)
8. To receive the selected events for triggered webhooks, select **Active**.
![Selecting individual events](/assets/images/help/business-accounts/webhook-active.png)
9. Click **Add webhook**.

View File

@@ -1,19 +0,0 @@
---
title: Managing organizations in your enterprise account
product: '{% data reusables.gated-features.enterprise-accounts %}'
redirect_from:
- /articles/managing-organizations-in-your-enterprise-account
- /github/setting-up-and-managing-your-enterprise-account/managing-organizations-in-your-enterprise-account
versions:
fpt: '*'
topics:
- Enterprise
children:
- /adding-organizations-to-your-enterprise-account
- /managing-unowned-organizations-in-your-enterprise-account
- /viewing-the-audit-logs-for-organizations-in-your-enterprise-account
- /streaming-the-audit-logs-for-organizations-in-your-enterprise-account
- /configuring-webhooks-for-organization-events-in-your-enterprise-account
shortTitle: Manage organizations
---

View File

@@ -1,21 +0,0 @@
---
title: Managing unowned organizations in your enterprise account
intro: You can become an owner of an organization in your enterprise account that currently has no owners.
product: '{% data reusables.gated-features.enterprise-accounts %}'
permissions: Enterprise owners can manage unowned organizations in an enterprise account.
redirect_from:
- /github/setting-up-and-managing-your-enterprise-account/managing-unowned-organizations-in-your-enterprise-account
- /github/setting-up-and-managing-your-enterprise/managing-unowned-organizations-in-your-enterprise-account
versions:
fpt: '*'
topics:
- Enterprise
shortTitle: Manage unowned organizations
---
{% data reusables.enterprise-accounts.access-enterprise %}
2. To the right of the search field, click **X unowned**.
![Button to view unowned organizations](/assets/images/help/business-accounts/unowned-organizations-button.png)
3. To the right of the organization you want to assume ownership of, click **Become an owner**.
![Become an owner button](/assets/images/help/business-accounts/become-an-owner-button.png)
4. Read the warning, then click **Become an owner**.
![Become an owner button](/assets/images/help/business-accounts/become-an-owner-confirmation.png)

View File

@@ -1,121 +0,0 @@
---
title: Streaming the audit logs for organizations in your enterprise account
intro: Enterprise owners can stream audit and Git events data from {% data variables.product.prodname_dotcom %} to an external data management system.
product: '{% data reusables.gated-features.enterprise-accounts %}'
miniTocMaxHeadingLevel: 3
versions:
fpt: '*'
topics:
- Enterprise
shortTitle: Stream organization audit logs
---
{% note %}
**Note:** Audit log streaming is currently in beta for {% data variables.product.prodname_ghe_cloud %} and subject to change.
{% endnote %}
## About exporting audit data
You can extract audit log and Git events data from {% data variables.product.prodname_dotcom %} in multiple ways:
* Go to the Audit log page in {% data variables.product.prodname_dotcom %} and click **Export**. <br/>
For more information, see "[Viewing the audit logs for organizations in your enterprise account](/github/setting-up-and-managing-your-enterprise/managing-organizations-in-your-enterprise-account/viewing-the-audit-logs-for-organizations-in-your-enterprise-account)" and "[Exporting the audit log](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization#exporting-the-audit-log)."
* Use the API to poll for new audit log events. <br/>
For more information, see "[Using the audit log API](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization#using-the-audit-log-api)."
* Set up {% data variables.product.product_name %} to stream audit data as events are logged.
## About audit log streaming
To help protect your intellectual property and maintain compliance for your organization, you can use streaming to keep copies of your audit log data and monitor:
{% data reusables.audit_log.audited-data-list %}
The benefits of streaming audit data include:
* **Data exploration**. You can examine streamed events using your preferred tool for querying large quantities of data. The stream contains both audit events and Git events across the entire enterprise account.
* **Data continuity**. You can pause the stream for up to seven days without losing any audit data.
* **Data retention**. You can keep your exported audit logs and Git data as long as you need to.
Enterprise owners can set up, pause, or delete a stream at any time. The stream exports the audit data for all of the organizations in your enterprise.
## Setting up audit log streaming
{% data variables.product.prodname_dotcom %} supports streaming of audit data to either Splunk or Azure Event Hubs.
### Setting up streaming to Splunk
To stream audit logs to Splunk's HTTP Event Collector (HEC) endpoint you must make sure that the endpoint is configured to accept HTTPS connections. For more information, see the Splunk documentation article "[Set up and use HTTP Event Collector in Splunk Web](https://docs.splunk.com/Documentation/Splunk/latest/Data/UsetheHTTPEventCollector)."
{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.audit-log-tab %}
1. Click the **Log streaming** tab.
1. Click **Configure stream** and select **Splunk**.
![Choose Splunk from the drop-down menu](/assets/images/help/enterprises/audit-stream-choice-splunk.png)
1. On the configuration page, enter:
* The domain on which the application you want to stream to is hosted.
If you are using Splunk Cloud, `Domain` should be `http-inputs-<host>`, where `host` is the domain you use in Splunk Cloud. For example: `http-inputs-mycompany.splunkcloud.com`.
* The port on which the application accepts data.<br>
If you are using Splunk Cloud, `Port` should be `443` if you haven't changed the port configuration. If you are using the free trial version of Splunk Cloud, `Port` should be `8088`.
* A token that {% data variables.product.prodname_dotcom %} can use to authenticate to the third-party application.
![Enter stream settings](/assets/images/help/enterprises/audit-stream-add-splunk.png)
2. Leave the **Enable SSL verification** check box selected.
Audit logs are always streamed as encrypted data, however, with this option selected, {% data variables.product.prodname_dotcom %} verifies the SSL certificate of your Splunk instance when delivering events. SSL verification helps ensure that events are delivered to your URL endpoint securely. You can clear the selection of this option, but we recommend you leave SSL verification enabled.
3. Click **Check endpoint** to verify that {% data variables.product.prodname_dotcom %} can connect to the Splunk endpoint.
![Check the endpoint](/assets/images/help/enterprises/audit-stream-check-splunk.png)
4. After you have successfully verified the endpoint, click **Save**.
### Setting up streaming to Azure Event Hubs
Before setting up a stream in {% data variables.product.prodname_dotcom %}, you must first have an event hub namespace in Microsoft Azure. Next, you must create an event hub instance within the namespace. You'll need the details of this event hub instance when you set up the stream. For details, see the Microsoft documentation, "[Quickstart: Create an event hub using Azure portal](https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-create)."
You need two pieces of information about your event hub: its instance name and the connection string.
**On Microsoft Azure portal**:
1. In the left menu select **Entities**. Then select **Event Hubs**. The names of your event hubs are listed.
![A list of event hubs](/assets/images/help/enterprises/azure-event-hubs-list.png)
1. Make a note of the name of the event hub you want to stream to.
1. Click the required event hub. Then, in the left menu, select **Shared Access Policies**.
1. Select a shared access policy in the list of policies, or create a new policy.
![A list of shared access policies](/assets/images/help/enterprises/azure-shared-access-policies.png)
1. Click the button to the right of the **Connection string-primary key** field to copy the connection string.
![The event hub connection string](/assets/images/help/enterprises/azure-connection-string.png)
**On {% data variables.product.prodname_dotcom %}**:
{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.audit-log-tab %}
1. Click the **Log streaming** tab.
1. Click **Configure stream** and select **Azure Event Hubs**.
![Choose Splunk from the drop-down menu](/assets/images/help/enterprises/audit-stream-choice-azure.png)
1. On the configuration page, enter:
* The name of the Azure Event Hubs instance.
* The connection string.
![Enter stream settings](/assets/images/help/enterprises/audit-stream-add-azure.png)
2. Click **Check endpoint** to verify that {% data variables.product.prodname_dotcom %} can connect to the Azure endpoint.
![Check the endpoint](/assets/images/help/enterprises/audit-stream-check-azure.png)
3. After you have successfully verified the endpoint, click **Save**.
## Pausing audit log streaming
Pausing the stream allows you to perform maintenance on the receiving application without losing audit data. Audit logs are stored for up to seven days on {% data variables.product.product_location %} and are then exported when you unpause the stream.
1. Display the "Log streaming" tab, as described above.
1. Click **Pause stream**.
![Pause the stream](/assets/images/help/enterprises/audit-stream-pause.png)
1. A confirmation message is displayed. Click **Pause stream** to confirm.
When the application is ready to receive audit logs again, click **Resume stream** to restart streaming audit logs.
## Deleting the audit log stream
1. Display the "Log streaming" tab, as described above.
1. Click **Delete stream**.
![Delete the stream](/assets/images/help/enterprises/audit-stream-delete.png)
2. A confirmation message is displayed. Click **Delete stream** to confirm.

View File

@@ -1,29 +0,0 @@
---
title: Viewing the audit logs for organizations in your enterprise account
intro: Enterprise owners can view aggregated actions from all of the organizations owned by an enterprise account in its audit log.
product: '{% data reusables.gated-features.enterprise-accounts %}'
redirect_from:
- /articles/viewing-the-audit-logs-for-organizations-in-your-business-account/
- /articles/viewing-the-audit-logs-for-organizations-in-your-enterprise-account
- /github/setting-up-and-managing-your-enterprise-account/viewing-the-audit-logs-for-organizations-in-your-enterprise-account
- /github/setting-up-and-managing-your-enterprise/viewing-the-audit-logs-for-organizations-in-your-enterprise-account
versions:
fpt: '*'
topics:
- Enterprise
shortTitle: View organization audit logs
---
Each audit log entry shows applicable information about an event, such as:
- The organization an action was performed in
- The user who performed the action
- Which repository an action was performed in
- The action that was performed
- Which country the action took place in
- The date and time the action occurred
You can search the audit log for specific events and export audit log data. For more information on searching the audit log and on specific organization events, see "[Reviewing the audit log for your organization](/articles/reviewing-the-audit-log-for-your-organization)."
{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.audit-log-tab %}

View File

@@ -1,23 +0,0 @@
---
title: Managing users in your enterprise
product: '{% data reusables.gated-features.enterprise-accounts %}'
redirect_from:
- /github/setting-up-and-managing-your-enterprise/managing-users-in-your-enterprise-account
- /github/setting-up-and-managing-your-enterprise-account/managing-users-in-your-enterprise-account
- /articles/managing-users-in-your-enterprise-account
- /articles/managing-users-in-your-enterprise
versions:
fpt: '*'
ghes: '*'
ghae: '*'
topics:
- Enterprise
children:
- /roles-in-an-enterprise
- /inviting-people-to-manage-your-enterprise
- /managing-support-entitlements-for-your-enterprise
- /viewing-people-in-your-enterprise
- /viewing-and-managing-a-users-saml-access-to-your-enterprise
shortTitle: Manage users
---

View File

@@ -1,78 +0,0 @@
---
title: Inviting people to manage your enterprise
intro: 'You can {% ifversion fpt %}invite people to become enterprise owners or billing managers for{% elsif ghes %}add enterprise owners to{% endif %} your enterprise account. You can also remove enterprise owners {% ifversion fpt %}or billing managers {% endif %}who no longer need access to the enterprise account.'
product: '{% data reusables.gated-features.enterprise-accounts %}'
permissions: 'Enterprise owners can {% ifversion fpt %}invite other people to become{% elsif ghes %}add{% endif %} additional enterprise administrators.'
redirect_from:
- /github/setting-up-and-managing-your-enterprise-account/inviting-people-to-manage-your-enterprise-account
- /articles/inviting-people-to-collaborate-in-your-business-account/
- /articles/inviting-people-to-manage-your-enterprise-account
- /github/setting-up-and-managing-your-enterprise/inviting-people-to-manage-your-enterprise
versions:
fpt: '*'
ghes: '*'
topics:
- Administrator
- Enterprise
- User account
shortTitle: Invite people to manage
---
## About users who can manage your enterprise account
{% data reusables.enterprise-accounts.enterprise-administrators %} For more information, see "[Roles in an enterprise](/github/setting-up-and-managing-your-enterprise/roles-in-an-enterprise)."
{% ifversion ghes %}
If you want to manage owners and billing managers for an enterprise account on {% data variables.product.prodname_dotcom_the_website %}, see "[Inviting people to manage your enterprise](/free-pro-team@latest/github/setting-up-and-managing-your-enterprise/managing-users-in-your-enterprise/inviting-people-to-manage-your-enterprise)" in the {% data variables.product.prodname_dotcom_the_website %} documentation.
{% endif %}
{% ifversion fpt %}
If your enterprise uses {% data variables.product.prodname_emus %}, enterprise owners can only be added or removed through your identity provider. For more information, see "[About {% data variables.product.prodname_emus %}](/github/setting-up-and-managing-your-enterprise/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)."
{% endif %}
{% tip %}
**Tip:** For more information on managing users within an organization owned by your enterprise account, see "[Managing membership in your organization](/articles/managing-membership-in-your-organization)" and "[Managing people's access to your organization with roles](/articles/managing-peoples-access-to-your-organization-with-roles)."
{% endtip %}
## {% ifversion fpt %}Inviting{% elsif ghes %}Adding{% endif %} an enterprise administrator to your enterprise account
{% ifversion fpt %}After you invite someone to join the enterprise account, they must accept the emailed invitation before they can access the enterprise account.{% endif %}
{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.people-tab %}
1. In the left sidebar, click **Administrators**.
![Administrators tab in the left sidebar](/assets/images/help/business-accounts/administrators-tab.png)
1. Above the list of administrators, click {% ifversion fpt %}**Invite admin**{% elsif ghes %}**Add owner**{% endif %}.
{% ifversion fpt %}
!["Invite admin" button above the list of enterprise owners](/assets/images/help/business-accounts/invite-admin-button.png)
{% elsif ghes %}
!["Add owner" button above the list of enterprise owners](/assets/images/help/business-accounts/add-owner-button.png)
{% endif %}
1. Type the username, full name, or email address of the person you want to invite to become an enterprise administrator, then select the appropriate person from the results.
![Modal box with field to type a person's username, full name, or email address, and Invite button](/assets/images/help/business-accounts/invite-admins-modal-button.png){% ifversion fpt %}
1. Select **Owner** or **Billing Manager**.
![Modal box with role choices](/assets/images/help/business-accounts/invite-admins-roles.png)
1. Click **Send Invitation**.
![Send invitation button](/assets/images/help/business-accounts/invite-admins-send-invitation.png){% endif %}{% ifversion ghes %}
1. Click **Add**.
!["Add" button](/assets/images/help/business-accounts/add-administrator-add-button.png){% endif %}
## Removing an enterprise administrator from your enterprise account
Only enterprise owners can remove other enterprise administrators from the enterprise account.
{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.people-tab %}
1. Next to the username of the person you'd like to remove, click {% octicon "gear" aria-label="The Settings gear" %}, then click **Remove owner**{% ifversion fpt %} or **Remove billing manager**{% endif %}.
{% ifversion fpt %}
![Settings gear with menu option to remove an enterprise administrator](/assets/images/help/business-accounts/remove-admin.png)
{% elsif ghes %}
![Settings gear with menu option to remove an enterprise administrator](/assets/images/help/business-accounts/ghes-remove-owner.png)
{% endif %}
1. Read the confirmation, then click **Remove owner**{% ifversion fpt %} or **Remove billing manager**{% endif %}.

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