diff --git a/assets/images/help/copilot/code-review/coding-guidelines-comment@2x.png b/assets/images/help/copilot/code-review/coding-guidelines-comment@2x.png new file mode 100644 index 000000000000..dd14de83151a Binary files /dev/null and b/assets/images/help/copilot/code-review/coding-guidelines-comment@2x.png differ diff --git a/assets/images/help/copilot/code-review/feedback-controls@2x.png b/assets/images/help/copilot/code-review/feedback-controls@2x.png new file mode 100644 index 000000000000..e4a47287f4b2 Binary files /dev/null and b/assets/images/help/copilot/code-review/feedback-controls@2x.png differ diff --git a/assets/images/help/copilot/code-review/feedback-modal@2x.png b/assets/images/help/copilot/code-review/feedback-modal@2x.png new file mode 100644 index 000000000000..d12dfac1b536 Binary files /dev/null and b/assets/images/help/copilot/code-review/feedback-modal@2x.png differ diff --git a/assets/images/help/copilot/code-review/request-review-branch-rule@2x.png b/assets/images/help/copilot/code-review/request-review-branch-rule@2x.png new file mode 100644 index 000000000000..bf933f8a6bc6 Binary files /dev/null and b/assets/images/help/copilot/code-review/request-review-branch-rule@2x.png differ diff --git a/assets/images/help/copilot/code-review/request-review@2x.png b/assets/images/help/copilot/code-review/request-review@2x.png new file mode 100644 index 000000000000..f0fb7d035f0e Binary files /dev/null and b/assets/images/help/copilot/code-review/request-review@2x.png differ diff --git a/assets/images/help/copilot/code-review/review-comment@2x.png b/assets/images/help/copilot/code-review/review-comment@2x.png new file mode 100644 index 000000000000..808bc4c5bdcd Binary files /dev/null and b/assets/images/help/copilot/code-review/review-comment@2x.png differ diff --git a/assets/images/help/copilot/code-review/vscode-comment-feedback@2x.png b/assets/images/help/copilot/code-review/vscode-comment-feedback@2x.png new file mode 100644 index 000000000000..25941e1d7e72 Binary files /dev/null and b/assets/images/help/copilot/code-review/vscode-comment-feedback@2x.png differ diff --git a/assets/images/help/copilot/code-review/vscode-comment@2x.png b/assets/images/help/copilot/code-review/vscode-comment@2x.png new file mode 100644 index 000000000000..bd89fecd8126 Binary files /dev/null and b/assets/images/help/copilot/code-review/vscode-comment@2x.png differ diff --git a/assets/images/help/copilot/code-review/vscode-review-button@2x.png b/assets/images/help/copilot/code-review/vscode-review-button@2x.png new file mode 100644 index 000000000000..a097aed16a93 Binary files /dev/null and b/assets/images/help/copilot/code-review/vscode-review-button@2x.png differ diff --git a/assets/images/help/copilot/code-review/vscode-review-progress@2x.png b/assets/images/help/copilot/code-review/vscode-review-progress@2x.png new file mode 100644 index 000000000000..331c652761cd Binary files /dev/null and b/assets/images/help/copilot/code-review/vscode-review-progress@2x.png differ diff --git a/assets/images/help/copilot/custom-instructions-vscode.png b/assets/images/help/copilot/custom-instructions-vscode.png new file mode 100644 index 000000000000..8a938f83134d Binary files /dev/null and b/assets/images/help/copilot/custom-instructions-vscode.png differ diff --git a/assets/images/help/copilot/vsc-review-and-comment.png b/assets/images/help/copilot/vsc-review-and-comment.png new file mode 100644 index 000000000000..050d3a4f8654 Binary files /dev/null and b/assets/images/help/copilot/vsc-review-and-comment.png differ diff --git a/assets/images/help/copilot/windows-terminal-dropdown.png b/assets/images/help/copilot/windows-terminal-dropdown.png new file mode 100644 index 000000000000..3367811104f9 Binary files /dev/null and b/assets/images/help/copilot/windows-terminal-dropdown.png differ diff --git a/assets/images/help/copilot/windows-terminal-settings.png b/assets/images/help/copilot/windows-terminal-settings.png new file mode 100644 index 000000000000..5fdc970ced09 Binary files /dev/null and b/assets/images/help/copilot/windows-terminal-settings.png differ diff --git a/assets/images/help/copilot/workspace-all-comments.png b/assets/images/help/copilot/workspace-all-comments.png new file mode 100644 index 000000000000..7f76b6fce7c8 Binary files /dev/null and b/assets/images/help/copilot/workspace-all-comments.png differ diff --git a/assets/images/help/copilot/workspace-applied-dismissed.png b/assets/images/help/copilot/workspace-applied-dismissed.png new file mode 100644 index 000000000000..13d47c8ce233 Binary files /dev/null and b/assets/images/help/copilot/workspace-applied-dismissed.png differ diff --git a/assets/images/help/copilot/workspace-commit-changes.png b/assets/images/help/copilot/workspace-commit-changes.png new file mode 100644 index 000000000000..c37592af878f Binary files /dev/null and b/assets/images/help/copilot/workspace-commit-changes.png differ diff --git a/assets/images/help/copilot/workspace-configure-commands.png b/assets/images/help/copilot/workspace-configure-commands.png new file mode 100644 index 000000000000..498d4ca07c1f Binary files /dev/null and b/assets/images/help/copilot/workspace-configure-commands.png differ diff --git a/assets/images/help/copilot/workspace-copilot-review-suggestion.png b/assets/images/help/copilot/workspace-copilot-review-suggestion.png new file mode 100644 index 000000000000..6edaf118ddd4 Binary files /dev/null and b/assets/images/help/copilot/workspace-copilot-review-suggestion.png differ diff --git a/assets/images/help/copilot/workspace-files-in-pr.png b/assets/images/help/copilot/workspace-files-in-pr.png new file mode 100644 index 000000000000..a1cd5ef97ee9 Binary files /dev/null and b/assets/images/help/copilot/workspace-files-in-pr.png differ diff --git a/assets/images/help/copilot/workspace-next-comment.png b/assets/images/help/copilot/workspace-next-comment.png new file mode 100644 index 000000000000..1ad375929dee Binary files /dev/null and b/assets/images/help/copilot/workspace-next-comment.png differ diff --git a/assets/images/help/copilot/workspace-run-command.png b/assets/images/help/copilot/workspace-run-command.png new file mode 100644 index 000000000000..2b1ba9eb0177 Binary files /dev/null and b/assets/images/help/copilot/workspace-run-command.png differ diff --git a/assets/images/help/copilot/workspace-stop-command.png b/assets/images/help/copilot/workspace-stop-command.png new file mode 100644 index 000000000000..08a87417e675 Binary files /dev/null and b/assets/images/help/copilot/workspace-stop-command.png differ diff --git a/assets/images/help/desktop/mac-choose-settings.png b/assets/images/help/desktop/mac-choose-settings.png new file mode 100644 index 000000000000..49e9e83d254f Binary files /dev/null and b/assets/images/help/desktop/mac-choose-settings.png differ diff --git a/assets/images/help/desktop/sign-in-github.png b/assets/images/help/desktop/sign-in-github.png index b614ad6b3df1..6ff8ed0b891e 100644 Binary files a/assets/images/help/desktop/sign-in-github.png and b/assets/images/help/desktop/sign-in-github.png differ diff --git a/assets/images/help/desktop/windows-sign-in-github.png b/assets/images/help/desktop/windows-sign-in-github.png index 8435556e75e1..574b731cce33 100644 Binary files a/assets/images/help/desktop/windows-sign-in-github.png and b/assets/images/help/desktop/windows-sign-in-github.png differ diff --git a/assets/images/help/pull_requests/menu-on-pull-request-file.png b/assets/images/help/pull_requests/menu-on-pull-request-file.png new file mode 100644 index 000000000000..a9bce0fa5fbc Binary files /dev/null and b/assets/images/help/pull_requests/menu-on-pull-request-file.png differ diff --git a/assets/images/help/security/builder-sec-campaign.png b/assets/images/help/security/builder-sec-campaign.png new file mode 100644 index 000000000000..ec4224375283 Binary files /dev/null and b/assets/images/help/security/builder-sec-campaign.png differ diff --git a/assets/images/help/security/codeql-for-vs-code-set-ghe-uri.png b/assets/images/help/security/codeql-for-vs-code-set-ghe-uri.png new file mode 100644 index 000000000000..e436e9074bc2 Binary files /dev/null and b/assets/images/help/security/codeql-for-vs-code-set-ghe-uri.png differ diff --git a/assets/images/help/security/driver-sec-campaign-view.png b/assets/images/help/security/driver-sec-campaign-view.png new file mode 100644 index 000000000000..eb96cdeb2df4 Binary files /dev/null and b/assets/images/help/security/driver-sec-campaign-view.png differ diff --git a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md b/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md index b3c592f9d428..9b9b44bed21c 100644 --- a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md +++ b/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md @@ -127,9 +127,9 @@ Email notifications from {% data variables.product.prodname_dotcom %} contain he | Header | Information | | --- | --- | -| `From` address | This address will always be {% ifversion fpt or ghec %}`notifications@github.com`{% else %}'the no-reply email address configured by your site administrator'{% endif %}. | +| `From` address | This address will always be {% ifversion fpt %}`notifications@github.com`{% elsif ghec %}`notifications@github.com` or `notifications@SUBDOMAIN.ghe.com`{% else %}the no-reply email address configured by your site administrator{% endif %}. | | `To` field | This field connects directly to the thread. If you reply to the email, you'll add a new comment to the conversation. | -| `Cc` address | {% data variables.product.product_name %} will `Cc` you if you're subscribed to a conversation. The second `Cc` email address matches the notification reason. The suffix for these notification reasons is {% ifversion fpt or ghec %}`@noreply.github.com`{% else %}based on the no-reply email address configured by your site administrator{% endif %}. The possible notification reasons are: | +| `Cc` address | {% data variables.product.product_name %} will `Cc` you if you're subscribed to a conversation. The second `Cc` email address matches the notification reason. The suffix for these notification reasons is {% ifversion fpt %}`@noreply.github.com`{% elsif ghec %}`@noreply.github.com` or `@noreply.SUBDOMAIN.ghe.com`{% else %}based on the no-reply email address configured by your site administrator{% endif %}. The possible notification reasons are: | | `List-Id` field | This field identifies the name of the repository and its owner. The format of this address is always `OWNER/REPOSITORY `, e.g. `List-Id: grain-lang/grain `. | | `X-GitHub-Severity` field | {% data reusables.repositories.security-alerts-x-github-severity %} The possible severity levels are:For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." | diff --git a/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/index.md b/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/index.md index 3d07c7acf650..d9e714945fb5 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/index.md +++ b/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/index.md @@ -15,7 +15,7 @@ children: - /viewing-contributions-on-your-profile - /showing-an-overview-of-your-activity-on-your-profile - /showing-your-private-contributions-and-achievements-on-your-profile - - /sending-enterprise-contributions-to-your-githubcom-profile + - /sharing-contributions-from-github-enterprise-server - /why-are-my-contributions-not-showing-up-on-my-profile - /troubleshooting-commits-on-your-timeline shortTitle: Manage contribution settings diff --git a/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile.md b/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/sharing-contributions-from-github-enterprise-server.md similarity index 53% rename from content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile.md rename to content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/sharing-contributions-from-github-enterprise-server.md index 6970efdd44e7..d211c45ecf4f 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile.md +++ b/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/sharing-contributions-from-github-enterprise-server.md @@ -1,6 +1,6 @@ --- -title: Sending enterprise contributions to your GitHub.com profile -intro: 'You can highlight your work on {% data variables.product.prodname_enterprise %} by sending the contribution counts to your {% data variables.product.prodname_dotcom_the_website %} profile.' +title: Sharing contributions from GitHub Enterprise Server +intro: 'You can send contribution counts from {% data variables.product.prodname_ghe_server %} to your profile on {% data variables.product.prodname_dotcom_the_website %} or {% data variables.enterprise.data_residency_site %}.' redirect_from: - /articles/sending-your-github-enterprise-contributions-to-your-github-com-profile - /articles/sending-your-github-enterprise-server-contributions-to-your-github-com-profile @@ -8,6 +8,7 @@ redirect_from: - /github/setting-up-and-managing-your-github-profile/sending-your-github-enterprise-server-contributions-to-your-githubcom-profile - /github/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-your-github-enterprise-server-contributions-to-your-githubcom-profile - /account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile + - /account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile versions: fpt: '*' ghes: '*' @@ -17,9 +18,9 @@ topics: shortTitle: Send enterprise contributions --- -## About enterprise contributions on your {% data variables.product.prodname_dotcom_the_website %} profile +## About enterprise contributions -Your {% data variables.product.prodname_dotcom_the_website %} profile shows {% ifversion fpt or ghec %}{% data variables.product.prodname_enterprise %}{% else %}{% data variables.product.product_name %}{% endif %} contribution counts from the past 90 days. {% data reusables.github-connect.sync-frequency %} Contribution counts from {% ifversion fpt or ghec %}{% data variables.product.prodname_enterprise %}{% else %}{% data variables.product.product_name %}{% endif %} are considered private contributions. The commit details will only show the contribution counts and that these contributions were made in a {% data variables.product.prodname_enterprise %} environment outside of {% data variables.product.prodname_dotcom_the_website %}. +When you share contributions, your {% data variables.product.prodname_dotcom_the_website %} or {% data variables.enterprise.data_residency_site %} profile shows {% data variables.product.prodname_ghe_server %} contribution counts from the past 90 days. {% data reusables.github-connect.sync-frequency %} Contribution counts from {% data variables.product.prodname_ghe_server %} are considered private contributions. The commit details will only show the contribution counts and that these contributions were made on {% data variables.product.prodname_ghe_server %}. You can decide whether to show counts for private contributions on your profile. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile)." @@ -31,17 +32,17 @@ For more information about how contributions are calculated, see "[AUTOTITLE](/a {% endnote %} -## Sending your enterprise contributions to your {% data variables.product.prodname_dotcom_the_website %} profile +## Sending your enterprise contributions to your profile -Before you can connect your {% ifversion fpt or ghec %}{% data variables.product.prodname_enterprise %}{% else %}{% data variables.product.product_name %}{% endif %} profile to your {% data variables.product.prodname_dotcom_the_website %} profile, your enterprise owner must enable {% data variables.product.prodname_github_connect %} and enable contribution sharing between the environments. For more information, contact your enterprise owner. +Before you can connect your {% data variables.product.prodname_ghe_server %} profile to your {% data variables.product.prodname_dotcom_the_website %} or {% data variables.enterprise.data_residency_site %} profile, your enterprise owner must enable {% data variables.product.prodname_github_connect %} and enable contribution sharing between the environments. For more information, contact your enterprise owner. {% ifversion fpt or ghec %} -To send enterprise contributions from {% data variables.product.prodname_ghe_server %} to your {% data variables.product.prodname_dotcom_the_website %} profile, see "[AUTOTITLE](/enterprise-server@latest/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile)" in the {% data variables.product.prodname_ghe_server %} documentation. +To share contributions from {% data variables.product.prodname_ghe_server %}, view this article in the [{% data variables.product.prodname_ghe_server %} version of the site](/enterprise-server@latest/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile)." {% elsif ghes %} -1. Sign in to {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_dotcom_the_website %}. +1. Sign in to both your user account on {% data variables.product.product_name %} **and** your user account on {% data variables.product.prodname_ghe_cloud %} ({% data variables.product.prodname_dotcom_the_website %}{% ifversion ghecom-github-connect %} or {% data variables.enterprise.data_residency_site %}{% endif %}). 1. On {% data variables.product.prodname_ghe_server %}, in the upper-right corner of any page, click your profile photo, then click **Settings**. {% ifversion global-nav-update %} @@ -55,7 +56,7 @@ To send enterprise contributions from {% data variables.product.prodname_ghe_ser {% endif %} {% data reusables.github-connect.github-connect-tab-user-settings %} {% data reusables.github-connect.connect-dotcom-and-enterprise %} -1. Review the resources that {% data variables.product.prodname_ghe_server %} will access from your {% data variables.product.prodname_dotcom_the_website %} account, then click **Authorize**. +1. Review the resources that {% data variables.product.prodname_ghe_server %} will access from your {% data variables.product.prodname_dotcom_the_website %}{% ifversion ghecom-github-connect %} or {% data variables.enterprise.data_residency_site %}{% endif %} account, then click **Authorize**. {% data reusables.github-connect.send-contribution-counts-to-githubcom %} {% endif %} diff --git a/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile.md b/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile.md index eb9dbe1df9d6..a13744e10e5e 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile.md +++ b/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile.md @@ -16,13 +16,15 @@ shortTitle: Private contributions {% ifversion hide-individual-achievements %}an allowTitleToDifferFromFilename: true --- -If you publicize your private contributions, people without access to the private repositories you work in won't be able to see the details of your private contributions. Instead, they'll see the number of private contributions you made on any given day. Your public contributions will include detailed information. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/viewing-contributions-on-your-profile)." +{% ifversion ghec %} + +>[!NOTE] Achievements are not available on subdomains of {% data variables.enterprise.data_residency_site %}, such as `octocorp.ghe.com`. -{% note %} +{% endif %} -**Note:** On {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom_the_website %}{% elsif ghes %}{% data variables.product.product_name %}{% endif %}, public contributions on your profile are visible {% ifversion fpt or ghec %}to anyone in the world who can access {% data variables.product.prodname_dotcom_the_website %}{% elsif ghes %}only to other users of {% data variables.location.product_location%}{% endif %}. +If you publicize your private contributions, people without access to the private repositories you work in won't be able to see the details of your private contributions. Instead, they'll see the number of private contributions you made on any given day. Your public contributions will include detailed information. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/viewing-contributions-on-your-profile)." -{% endnote %} +>[!NOTE] On {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom_the_website %}{% elsif ghes %}{% data variables.product.product_name %}{% endif %}, public contributions on your profile are visible {% ifversion fpt or ghec %}to anyone in the world who can access {% data variables.product.prodname_dotcom_the_website %}{% elsif ghes %}only to other users of {% data variables.location.product_location%}{% endif %}. ## Changing the visibility of your private contributions diff --git a/content/actions/administering-github-actions/index.md b/content/actions/administering-github-actions/index.md index bfd9579642bc..f3c6a7bd98ba 100644 --- a/content/actions/administering-github-actions/index.md +++ b/content/actions/administering-github-actions/index.md @@ -8,7 +8,8 @@ versions: ghec: '*' children: - /usage-limits-billing-and-administration - - /viewing-github-actions-usage-metrics-for-your-organization + - /viewing-github-actions-metrics - /sharing-workflows-secrets-and-runners-with-your-organization + - /making-retired-namespaces-available-on-ghecom --- diff --git a/content/actions/administering-github-actions/making-retired-namespaces-available-on-ghecom.md b/content/actions/administering-github-actions/making-retired-namespaces-available-on-ghecom.md new file mode 100644 index 000000000000..a6c7058ab17f --- /dev/null +++ b/content/actions/administering-github-actions/making-retired-namespaces-available-on-ghecom.md @@ -0,0 +1,32 @@ +--- +title: 'Making retired namespaces available on GHE.com' +shortTitle: Retired namespaces on GHE.com +intro: 'Allow people to use namespaces that match actions you have used from {% data variables.product.prodname_dotcom_the_website %}.' +versions: + ghec: '*' +type: how_to +permissions: Enterprise owners +--- + +## About retirement of namespaces + +If you use {% data variables.enterprise.data_residency %}, members of your enterprise can create {% data variables.product.prodname_actions %} workflows that use actions directly from {% data variables.product.prodname_dotcom_the_website %} or [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace?type=actions). + +{% data variables.product.prodname_actions %} searches your enterprise on {% data variables.enterprise.data_residency_site %} for each action before falling back to {% data variables.product.prodname_dotcom_the_website %}. This ensures that custom versions of actions in your enterprise are used in preference to their counterparts on {% data variables.product.prodname_dotcom_the_website %}. + +To ensure workflows use their intended actions and to block the potential for abuse, once an action on {% data variables.product.prodname_dotcom_the_website %} is used for the first time, the namespace associated with that action is retired in your enterprise. This blocks users from creating an organization and repository in your enterprise that match the action's namespace on {% data variables.product.prodname_dotcom_the_website %}. + +## Making a retired namespace available + +After using an action from {% data variables.product.prodname_dotcom_the_website %}, if you want to create an action in your enterprise with the same name, you need to make the namespace for that organization and repository available. + +{% data reusables.enterprise-accounts.access-enterprise-emu %} +{% data reusables.enterprise-accounts.settings-tab %} +1. Under {% octicon "gear" aria-hidden="true" %} **Settings**, click **Retired namespaces**. +1. To the right of the namespace that you want use in your enterprise, click **Unretire**. +1. Go to the relevant organization and create a new repository. + +### Tips for ensuring you can create a new repository + +* When you unretire a namespace, always create the new repository with that name as soon as possible. If a workflow calls the associated action on {% data variables.product.prodname_dotcom_the_website %} before you create the local repository, the namespace will be retired again. +* For actions used in workflows that run frequently, you may find that a namespace is retired again before you have time to create the local repository. In this case, you can temporarily disable the relevant workflows until you have created the new repository. diff --git a/content/actions/administering-github-actions/usage-limits-billing-and-administration.md b/content/actions/administering-github-actions/usage-limits-billing-and-administration.md index 7c962dfb8ab1..375261917e39 100644 --- a/content/actions/administering-github-actions/usage-limits-billing-and-administration.md +++ b/content/actions/administering-github-actions/usage-limits-billing-and-administration.md @@ -93,7 +93,7 @@ In addition to the usage limits, you must ensure that you use {% data variables. ## {% data variables.product.prodname_actions %} usage metrics -Organization owners and users with the "View organization Actions usage metrics" permission can view {% data variables.product.prodname_actions %} usage metrics for their organization. These metrics can help you understand how and where your Actions minutes are being used. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/organizations/collaborating-with-groups-in-organizations/viewing-usage-metrics-for-github-actions)." +Organization owners and users with the "View organization Actions metrics" permission can view {% data variables.product.prodname_actions %} usage metrics for their organization. These metrics can help you understand how and where your Actions minutes are being used. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/organizations/collaborating-with-groups-in-organizations/viewing-usage-metrics-for-github-actions)." When you view usage metrics, it is important to remember that {% data reusables.actions.actions-usage-metrics-not-billing-metrics %} diff --git a/content/actions/administering-github-actions/viewing-github-actions-metrics.md b/content/actions/administering-github-actions/viewing-github-actions-metrics.md new file mode 100644 index 000000000000..9473e6fb74f3 --- /dev/null +++ b/content/actions/administering-github-actions/viewing-github-actions-metrics.md @@ -0,0 +1,47 @@ +--- +title: Viewing GitHub Actions metrics +shortTitle: GitHub Actions metrics +intro: 'You can view metrics to monitor where your organization or repositories use {% data variables.product.prodname_actions %} and how they are performing.' +permissions: Organization owners and users with the "View organization Actions metrics" permission can view organization-level metrics.

Users with the base repository role can view repository-level metrics. +versions: + feature: actions-metrics +redirect_from: + - /actions/monitoring-and-troubleshooting-workflows/viewing-github-actions-usage-metrics-for-your-organization + - /actions/administering-github-actions/viewing-github-actions-usage-metrics-for-your-organization + - /actions/administering-github-actions/viewing-github-actions-metrics-for-your-organization +--- + +{% data reusables.actions.about-actions-metrics %} + +{% data reusables.actions.enabling-actions-metrics %} + +## About {% data variables.product.prodname_actions %} usage metrics + +{% data reusables.actions.about-actions-usage-metrics %} + +## About {% data variables.product.prodname_actions %} performance metrics + +{% data reusables.actions.about-actions-performance-metrics %} + +## Understanding {% data variables.product.prodname_actions %} metrics aggregation + +{% data reusables.actions.about-actions-usage-metrics-aggregation %} + +## Viewing {% data variables.product.prodname_actions %} metrics for your organization + +{% data reusables.actions.actions-metrics-discrepancy-note %} + +{% data reusables.profile.access_org %} +{% data reusables.user-settings.access_org %} +{% data reusables.organizations.insights %} +{% data reusables.actions.viewing-actions-metrics %} + +## Viewing {% data variables.product.prodname_actions %} metrics for your repository + +> [!NOTE] Repository-level metrics for {% data variables.product.prodname_actions %} is in {% data variables.release-phases.public_preview %} and subject to change. + +{% data reusables.actions.actions-metrics-discrepancy-note %} + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.navigate-to-insights %} +{% data reusables.actions.viewing-actions-metrics %} diff --git a/content/actions/administering-github-actions/viewing-github-actions-usage-metrics-for-your-organization.md b/content/actions/administering-github-actions/viewing-github-actions-usage-metrics-for-your-organization.md deleted file mode 100644 index 547e755c36ba..000000000000 --- a/content/actions/administering-github-actions/viewing-github-actions-usage-metrics-for-your-organization.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Viewing GitHub Actions usage metrics for your organization -shortTitle: GitHub Actions usage metrics -intro: 'Organization owners and CI/CD administrators can view usage metrics for how and where their organization uses {% data variables.product.prodname_actions %}.' -permissions: Organization owners and users with the "View organization Actions usage metrics" permissions. -product: 'Your organization must be on a {% data variables.product.prodname_ghe_cloud %} plan.' -versions: - fpt: '*' - ghec: '*' -redirect_from: - - /actions/monitoring-and-troubleshooting-workflows/viewing-github-actions-usage-metrics-for-your-organization ---- - -If you are on a {% data variables.product.prodname_ghe_cloud %} plan, {% data reusables.actions.about-actions-usage-metrics %} - -For more information about how to use {% data variables.product.prodname_actions %} usage metrics, see "[AUTOTITLE](/enterprise-cloud@latest/organizations/collaborating-with-groups-in-organizations/viewing-usage-metrics-for-github-actions)" in the {% data variables.product.prodname_ghe_cloud %} documentation. diff --git a/content/actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/about-monitoring-workflows.md b/content/actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/about-monitoring-workflows.md index 9cec21768a5c..89d6654b108f 100644 --- a/content/actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/about-monitoring-workflows.md +++ b/content/actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/about-monitoring-workflows.md @@ -1,6 +1,6 @@ --- title: About monitoring workflows -intro: 'You can use the tools in {% data variables.product.prodname_actions %} to monitor your workflows.' +intro: 'You can use the tools in {% data variables.product.prodname_actions %} to monitor your workflows, metrics, and self-hosted runners.' versions: fpt: '*' ghes: '*' @@ -45,6 +45,13 @@ To identify how long a job took to run, you can view its execution time. For mor You can view the status of each job and step in a workflow. For more information, see "[AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history)." +{% ifversion actions-metrics %} + +## Monitoring {% data variables.product.prodname_actions %} metrics + +To analyze the efficiency and reliability of your workflows using metrics, see "[AUTOTITLE](/actions/administering-github-actions/viewing-github-actions-metrics)". +{% endif %} + ## Monitoring self-hosted runners If you use self-hosted runners, you can view their activity and diagnose common issues. diff --git a/content/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/about-troubleshooting-workflows.md b/content/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/about-troubleshooting-workflows.md index 0a784bc9c750..2220ca5fa87a 100644 --- a/content/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/about-troubleshooting-workflows.md +++ b/content/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/about-troubleshooting-workflows.md @@ -24,6 +24,15 @@ If the workflow logs do not provide enough detail to diagnose why a workflow, jo If you attempt to cancel a workflow and the cancellation doesn't succeed, make sure you aren't using the `always` expression. The `always` expression causes a workflow step to run even when the workflow is canceled, which results in a hanging cancellation. For more information, see "[AUTOTITLE](/actions/learn-github-actions/expressions#always)". +{% ifversion actions-metrics %} + +## Troubleshooting {% data variables.product.prodname_actions %} inefficiencies + +To analyze the inefficiencies and reliability of your workflows using metrics, see "[AUTOTITLE](/actions/administering-github-actions/viewing-github-actions-metrics)". +{% endif %} + +## Monitoring self-hosted runners + ## Troubleshooting self-hosted runners If you use self-hosted runners, you can view their activity and diagnose common issues. diff --git a/content/actions/security-for-github-actions/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md b/content/actions/security-for-github-actions/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md index 07e11574f9ba..5e948e5730bc 100644 --- a/content/actions/security-for-github-actions/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md +++ b/content/actions/security-for-github-actions/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md @@ -497,6 +497,23 @@ To enable and configure OIDC for another cloud provider, see the following guide * "[AUTOTITLE](/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-cloud-providers)" +{% ifversion ghec %} + +### Following these guides on {% data variables.enterprise.data_residency_site %} + +If you are part of an enterprise that uses {% data variables.enterprise.data_residency %} and you're setting up OIDC on {% data variables.enterprise.data_residency_site %}, you must **substitute certain values** in the linked articles. + +* Your provider's expected claim must substitute `githubusercontent.com` with `{% data variables.enterprise.data_residency_domain %}`, where SUBDOMAIN is your enterprise's subdomain on {% data variables.enterprise.data_residency_site %}. +* For any URLs that include a route with your enterprise's name or slug, you must substitute your enterprise's subdomain on {% data variables.enterprise.data_residency_site %}. + +For example, if your subdomain is `octocorp`, the following substitutions apply: + +* The URL for seeing all the claims supported by {% data variables.product.company_short %}'s OIDC provider would be `https://token.actions.octocorp.ghe.com/.well-known/openid-configuration`. +* The value of `iss` in your OIDC token would be `https://token.actions.octocorp.ghe.com`. +* The enterprise can receive tokens at `https://token.actions.octocorp.ghe.com/octocorp`, and the REST API endpoint for customizing the `issuer` value would be `/enterprises/octocorp/actions/oidc/customization/issuer`. + +{% endif %} + ## Debugging your OIDC claims You can use the [`github/actions-oidc-debugger`](https://github.com/github/actions-oidc-debugger) action to visualize the claims that would be sent, before integrating with a cloud provider. This action requests a JWT and prints the claims included within the JWT that were received from {% data variables.product.prodname_actions %}. diff --git a/content/actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services.md b/content/actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services.md index 89f563ca3da4..67b9380663bc 100644 --- a/content/actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services.md +++ b/content/actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services.md @@ -29,6 +29,8 @@ This guide explains how to configure AWS to trust {% data variables.product.prod {% data reusables.actions.oidc-security-notice %} +{% data reusables.actions.oidc-on-ghecom %} + {% ifversion ghes %} {% data reusables.actions.oidc-endpoints %} diff --git a/content/actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-azure.md b/content/actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-azure.md index 6cb1a1b8231e..c17355077ce7 100644 --- a/content/actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-azure.md +++ b/content/actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-azure.md @@ -27,6 +27,8 @@ This guide gives an overview of how to configure Azure to trust {% data variable {% data reusables.actions.oidc-security-notice %} +{% data reusables.actions.oidc-on-ghecom %} + {% ifversion ghes %} {% data reusables.actions.oidc-endpoints %} diff --git a/content/actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-cloud-providers.md b/content/actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-cloud-providers.md index cd2c49289528..4f34c460273f 100644 --- a/content/actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-cloud-providers.md +++ b/content/actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-cloud-providers.md @@ -27,6 +27,8 @@ To use OIDC, you will first need to configure your cloud provider to trust {% da {% data reusables.actions.oidc-security-notice %} +{% data reusables.actions.oidc-on-ghecom %} + ## Updating your {% data variables.product.prodname_actions %} workflow To update your workflows for OIDC, you will need to make two changes to your YAML: diff --git a/content/actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-google-cloud-platform.md b/content/actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-google-cloud-platform.md index 9494d7c64bb4..c8c024f983ad 100644 --- a/content/actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-google-cloud-platform.md +++ b/content/actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-google-cloud-platform.md @@ -12,7 +12,7 @@ topics: redirect_from: - /actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-google-cloud-platform --- - + {% data reusables.actions.enterprise-github-hosted-runners %} ## Overview @@ -27,6 +27,8 @@ This guide gives an overview of how to configure GCP to trust {% data variables. {% data reusables.actions.oidc-security-notice %} +{% data reusables.actions.oidc-on-ghecom %} + ## Adding a Google Cloud Workload Identity Provider To configure the OIDC identity provider in GCP, you will need to perform the following configuration. For instructions on making these changes, refer to [the GCP documentation](https://github.com/google-github-actions/auth). diff --git a/content/actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-hashicorp-vault.md b/content/actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-hashicorp-vault.md index d04d9ef644e3..27569033f54f 100644 --- a/content/actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-hashicorp-vault.md +++ b/content/actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-hashicorp-vault.md @@ -12,7 +12,7 @@ topics: redirect_from: - /actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-hashicorp-vault --- - + {% data reusables.actions.enterprise-github-hosted-runners %} ## Overview @@ -27,6 +27,8 @@ This guide gives an overview of how to configure HashiCorp Vault to trust {% dat {% data reusables.actions.oidc-security-notice %} +{% data reusables.actions.oidc-on-ghecom %} + ## Adding the identity provider to HashiCorp Vault To use OIDC with HashiCorp Vault, you will need to add a trust configuration for the {% data variables.product.prodname_dotcom %} OIDC provider. For more information, see the HashiCorp Vault [documentation](https://www.vaultproject.io/docs/auth/jwt). diff --git a/content/actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-jfrog.md b/content/actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-jfrog.md index 8504d41b99b3..031a5cbf6810 100644 --- a/content/actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-jfrog.md +++ b/content/actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-jfrog.md @@ -29,6 +29,8 @@ For an example {% data variables.product.prodname_actions %} workflow using the {% data reusables.actions.oidc-security-notice %} +{% data reusables.actions.oidc-on-ghecom %} + * To be secure, you need to set a Claims JSON in JFrog when configuring identity mappings. For more information, see "[AUTOTITLE](https://jfrog.com/help/r/jfrog-platform-administration-documentation/configure-identity-mappings)" and "[AUTOTITLE](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#customizing-the-token-claims)." For example, you can set `iss` to `https://token.actions.githubusercontent.com`, and the `repository` to something like "octo-org/octo-repo"`. This will ensure only Actions workflows from the specified repository will have access to your JFrog platform. The following is an example Claims JSON when configuring identity mappings. diff --git a/content/actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-pypi.md b/content/actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-pypi.md index 3f465f74efd0..17cc80c42ba6 100644 --- a/content/actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-pypi.md +++ b/content/actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-pypi.md @@ -25,6 +25,8 @@ This guide gives an overview of how to configure PyPI to trust {% data variables {% data reusables.actions.oidc-security-notice %} +{% data reusables.actions.oidc-on-ghecom %} + ## Adding the identity provider to PyPI To use OIDC with PyPI, add a trust configuration that links each project on PyPI to each repository and workflow combination that's allowed to publish for it. diff --git a/content/actions/security-for-github-actions/using-artifact-attestations/enforcing-artifact-attestations-with-a-kubernetes-admission-controller.md b/content/actions/security-for-github-actions/using-artifact-attestations/enforcing-artifact-attestations-with-a-kubernetes-admission-controller.md index 7bca4f67bd7e..c4002e43e636 100644 --- a/content/actions/security-for-github-actions/using-artifact-attestations/enforcing-artifact-attestations-with-a-kubernetes-admission-controller.md +++ b/content/actions/security-for-github-actions/using-artifact-attestations/enforcing-artifact-attestations-with-a-kubernetes-admission-controller.md @@ -111,7 +111,7 @@ Note that any image you intend to admit _must_ have a matching glob pattern in t {% ifversion ghec %} -If your GitHub Enterprise account has a subdomain on GHE.com, you must specify a value for the GitHub trust domain. This value is used to fetch the trusted materials associated with the data residency region that hosts your GitHub Enterprise account. This value can be found by logging into your enterprise account with the `gh` CLI tool and running the following command: +If your GitHub Enterprise account has a subdomain on {% data variables.enterprise.data_residency_site %}, you must specify a value for the GitHub trust domain. This value is used to fetch the trusted materials associated with the data residency region that hosts your GitHub Enterprise account. This value can be found by logging into your enterprise account with the `gh` CLI tool and running the following command: ```bash copy gh api meta --jq .domains.artifact_attestations.trust_domain diff --git a/content/actions/sharing-automations/creating-actions/about-custom-actions.md b/content/actions/sharing-automations/creating-actions/about-custom-actions.md index 9724823376cb..69504cfc70bd 100644 --- a/content/actions/sharing-automations/creating-actions/about-custom-actions.md +++ b/content/actions/sharing-automations/creating-actions/about-custom-actions.md @@ -17,7 +17,7 @@ topics: - Action development - Fundamentals --- - + {% data reusables.actions.enterprise-github-hosted-runners %} ## About custom actions @@ -76,14 +76,18 @@ Storing an action in its own repository makes it easier for the {% data variable {% ifversion fpt or ghec %}If you're building an action that you don't plan to make available to others, you {% else %} You{% endif %} can store the action's files in any location in your repository. If you plan to combine action, workflow, and application code in a single repository, we recommend storing actions in the `.github` directory. For example, `.github/actions/action-a` and `.github/actions/action-b`. -## Compatibility with {% data variables.product.prodname_ghe_server %} +## Ensuring compatibility with other platforms + +Many people access {% data variables.product.github %} at a domain other than {% data variables.product.prodname_dotcom_the_website %}, such as {% data variables.enterprise.data_residency_site %} or a custom domain for {% data variables.product.prodname_ghe_server %}. + +To ensure that your action is compatible with other platforms, do not use any hard-coded references to API URLs such as `https://api.github.com`. Instead, you can: -To ensure that your action is compatible with {% data variables.product.prodname_ghe_server %}, you should make sure that you do not use any hard-coded references to {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API URLs. You should instead use environment variables to refer to the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API: +* Use environment variables (see "[AUTOTITLE](/actions/learn-github-actions/variables#default-environment-variables)"): -* For the REST API, use the `GITHUB_API_URL` environment variable. -* For GraphQL, use the `GITHUB_GRAPHQL_URL` environment variable. + * For the REST API, use the `GITHUB_API_URL` environment variable. + * For GraphQL, use the `GITHUB_GRAPHQL_URL` environment variable. -For more information, see "[AUTOTITLE](/actions/learn-github-actions/variables#default-environment-variables)." +* Use a toolkit such as [`@actions/github`](https://github.com/actions/toolkit/tree/main/packages/github), which can automatically set the correct URLs. ## Using release management for actions diff --git a/content/actions/use-cases-and-examples/building-and-testing/building-and-testing-xamarin-applications.md b/content/actions/use-cases-and-examples/building-and-testing/building-and-testing-xamarin-applications.md index 4b93211e6646..be1952bc746e 100644 --- a/content/actions/use-cases-and-examples/building-and-testing/building-and-testing-xamarin-applications.md +++ b/content/actions/use-cases-and-examples/building-and-testing/building-and-testing-xamarin-applications.md @@ -18,7 +18,7 @@ topics: - iOS shortTitle: Build & test Xamarin apps --- - + {% data reusables.actions.enterprise-github-hosted-runners %} ## Introduction @@ -35,6 +35,12 @@ We recommend that you have a basic understanding of Xamarin, .NET Core SDK, YAML * "[Getting started with .NET](https://dotnet.microsoft.com/learn)" * "[Learn Xamarin](https://dotnet.microsoft.com/learn/xamarin)" +{% ifversion ghec %} + +To use the examples in the guide, you will need a repository on {% data variables.product.prodname_dotcom_the_website %}. {% data reusables.actions.macos-unavailable-ghecom %} + +{% endif %} + ## Building Xamarin.iOS apps The example below demonstrates how to change the default Xamarin SDK versions and build a Xamarin.iOS application. @@ -54,7 +60,7 @@ jobs: - name: Set default Xamarin SDK versions run: | $VM_ASSETS/select-xamarin-sdk-v2.sh --mono=6.12 --ios=14.10 - + - name: Set default Xcode 12.3 run: | XCODE_ROOT=/Applications/Xcode_12.3.0.app diff --git a/content/actions/writing-workflows/choosing-what-your-workflow-does/using-pre-written-building-blocks-in-your-workflow.md b/content/actions/writing-workflows/choosing-what-your-workflow-does/using-pre-written-building-blocks-in-your-workflow.md index fb94cd9663bf..ef9c9203dd3a 100644 --- a/content/actions/writing-workflows/choosing-what-your-workflow-does/using-pre-written-building-blocks-in-your-workflow.md +++ b/content/actions/writing-workflows/choosing-what-your-workflow-does/using-pre-written-building-blocks-in-your-workflow.md @@ -42,6 +42,8 @@ The actions you use in your workflow can be defined in: {% data reusables.actions.enterprise-marketplace-actions %} +{% data reusables.actions.actions-marketplace-ghecom %} + {% ifversion fpt or ghec %} ## Browsing Marketplace actions in the workflow editor @@ -99,6 +101,10 @@ jobs: uses: {% data reusables.actions.action-setup-node %} ``` +{% ifversion ghec or ghes %} +If {% ifversion ghec %}you're on {% data variables.enterprise.data_residency_site %}{% elsif ghes %}an enterprise owner has enabled access to actions on {% data variables.product.prodname_dotcom_the_website %}{% endif %}, you can use this syntax to reference actions either within your enterprise or on {% data variables.product.prodname_dotcom_the_website %}. {% data variables.product.prodname_actions %} will look for the action in your enterprise first, then fall back to {% data variables.product.prodname_dotcom_the_website %}. +{% endif %} + ### Referencing a container on Docker Hub If an action is defined in a published Docker container image on Docker Hub, you must reference the action with the `docker://{image}:{tag}` syntax in your workflow file. To protect your code and data, we strongly recommend you verify the integrity of the Docker container image from Docker Hub before using it in your workflow. diff --git a/content/admin/configuring-settings/configuring-github-connect/about-github-connect.md b/content/admin/configuring-settings/configuring-github-connect/about-github-connect.md index a674eca72851..cb8635f296d2 100644 --- a/content/admin/configuring-settings/configuring-github-connect/about-github-connect.md +++ b/content/admin/configuring-settings/configuring-github-connect/about-github-connect.md @@ -1,6 +1,6 @@ --- title: About GitHub Connect -intro: '{% data variables.product.prodname_github_connect %} enhances {% data variables.product.product_name %} by giving you access to additional features and workflows that rely on the power of {% data variables.product.prodname_dotcom_the_website %}.' +intro: '{% data variables.product.prodname_github_connect %} enhances {% data variables.product.product_name %} by giving you access to data and workflows from {% data variables.product.prodname_ghe_cloud %}.' versions: ghes: '*' type: overview @@ -11,40 +11,69 @@ redirect_from: - /admin/configuration/configuring-github-connect/about-github-connect --- -## About {% data variables.product.prodname_github_connect %} +{% data variables.product.prodname_github_connect %} allows {% data variables.location.product_location %} to connect to your enterprise on {% data variables.product.prodname_ghe_cloud %} in limited ways. -{% data variables.product.prodname_github_connect %} enhances {% data variables.product.product_name %} by allowing {% data variables.location.product_location %} to benefit from the power of {% data variables.product.prodname_dotcom_the_website %} in limited ways. After you enable {% data variables.product.prodname_github_connect %}, you can enable additional features and workflows that rely on {% data variables.product.prodname_dotcom_the_website %}, such as {% data variables.product.prodname_dependabot_alerts %} for security vulnerabilities that are tracked in the {% data variables.product.prodname_advisory_database %}. +After you enable {% data variables.product.prodname_github_connect %}, you can choose which features to enable. For example, you can: -{% data variables.product.prodname_github_connect %} does not open {% data variables.location.product_location %} to the public internet. None of your enterprise's private data is exposed to {% data variables.product.prodname_dotcom_the_website %} users. Instead, {% data variables.product.prodname_github_connect %} transmits only the limited data needed for the individual features you choose to enable. Unless you enable license sync, no personal data is transmitted by {% data variables.product.prodname_github_connect %}. For more information about what data is transmitted by {% data variables.product.prodname_github_connect %}, see "[Data transmission for {% data variables.product.prodname_github_connect %}](#data-transmission-for-github-connect)." +* Automatically sync license usage between environments +* Unify search results and user contribution data +* Enable features that rely on {% data variables.product.prodname_dotcom_the_website %}, such as {% data variables.product.prodname_dependabot_alerts %} for security vulnerabilities that are tracked in the {% data variables.product.prodname_advisory_database %} -Enabling {% data variables.product.prodname_github_connect %} will not allow {% data variables.product.prodname_dotcom_the_website %} users to make changes to {% data variables.product.product_name %}. +## About the connection -To enable {% data variables.product.prodname_github_connect %}, you configure a connection between {% data variables.location.product_location %} and enterprise account on {% data variables.product.prodname_dotcom_the_website %} that uses {% data variables.product.prodname_ghe_cloud %}. {% data reusables.github-connect.connection-port-protocol %} For more information, see "[AUTOTITLE](/admin/configuration/configuring-github-connect/managing-github-connect)." +To enable {% data variables.product.prodname_github_connect %}, you configure a connection between {% data variables.location.product_location %} and an enterprise account on **{% data variables.product.prodname_dotcom_the_website %}**{% ifversion ghecom-github-connect %} or **{% data variables.enterprise.data_residency_site %}**{% endif %}. {% data reusables.github-connect.connection-port-protocol %} -After enabling {% data variables.product.prodname_github_connect %}, you will be able to enable features such as {% ifversion ghes %}automatic user license sync and {% endif %}{% data variables.product.prodname_dependabot_alerts %}. For more information about all of the features available, see "[{% data variables.product.prodname_github_connect %} features](#github-connect-features)." +* {% data variables.product.prodname_github_connect %} does not open {% data variables.location.product_location %} to the public internet. +* None of your enterprise's private data is exposed to {% data variables.product.prodname_ghe_cloud %} users. +* {% data variables.product.prodname_github_connect %} transmits only the limited data needed for the features you enable. Unless you enable license sync, no personal data is transmitted. For more information, see "[Data transmission](#data-transmission)." +* Enabling {% data variables.product.prodname_github_connect %} will not allow {% data variables.product.prodname_ghe_cloud %} users to make changes to {% data variables.product.product_name %}. ## {% data variables.product.prodname_github_connect %} features -After you configure the connection between {% data variables.location.product_location %} and {% data variables.product.prodname_ghe_cloud %}, you can enable individual features of {% data variables.product.prodname_github_connect %} for your enterprise. +After you configure the connection between {% data variables.location.product_location %} and {% data variables.product.prodname_ghe_cloud %}, you can enable individual features of {% data variables.product.prodname_github_connect %}. + +{% ifversion ghecom-github-connect %} +If you're connecting to an enterprise on {% data variables.enterprise.data_residency_site %}, features that rely on data from {% data variables.product.prodname_dotcom_the_website %} are not available. + +* [Connections to {% data variables.product.prodname_dotcom_the_website %}](#connections-to-githubcom) +* [Connections to {% data variables.enterprise.data_residency_site %}](#connections-to-ghecom) + +### Connections to {% data variables.product.prodname_dotcom_the_website %} + +{% endif %} | Feature | Description | More information | | ----------- | ----------- | ----------- | -| Automatic user license sync | Manage license usage across your {% data variables.product.prodname_enterprise %} deployments by automatically syncing user licenses from {% data variables.location.product_location %} to {% data variables.product.prodname_ghe_cloud %}. | "[AUTOTITLE](/admin/configuration/configuring-github-connect/enabling-automatic-user-license-sync-for-your-enterprise)" | +{% data reusables.github-connect.license-sync %} | {% data variables.product.prodname_dependabot %} | Allow users to find and fix vulnerabilities in code dependencies. | "[AUTOTITLE](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)" | | {% data variables.product.prodname_dotcom_the_website %} actions | Allow users to use actions from {% data variables.product.prodname_dotcom_the_website %} in public workflow files. | "[AUTOTITLE](/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect)" | | {% ifversion server-statistics %} | | {% data variables.product.prodname_server_statistics %} | Analyze your own aggregate data from GitHub Enterprise Server, and help us improve GitHub products. | "[AUTOTITLE](/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise)" | | {% endif %} | -| Unified search | Allow users to include repositories on {% data variables.product.prodname_dotcom_the_website %} in their search results when searching from {% data variables.location.product_location %}. | "[AUTOTITLE](/admin/configuration/configuring-github-connect/enabling-unified-search-for-your-enterprise)" | -| Unified contributions | Allow users to include anonymized contribution counts for their work on {% data variables.location.product_location %} in their contribution graphs on {% data variables.product.prodname_dotcom_the_website %}. | "[AUTOTITLE](/admin/configuration/configuring-github-connect/enabling-unified-contributions-for-your-enterprise)" | +{% data reusables.github-connect.unified-search %} +{% data reusables.github-connect.unified-contributions %} + +{% ifversion ghecom-github-connect %} + +### Connections to {% data variables.enterprise.data_residency_site %} + +| Feature | Description | More information | +| ----------- | ----------- | ----------- | +| {% ifversion ghecom-license-sync %} | +{% data reusables.github-connect.license-sync %} +| {% endif %} | +{% data reusables.github-connect.unified-search %} +{% data reusables.github-connect.unified-contributions %} -## Data transmission for {% data variables.product.prodname_github_connect %} +{% endif %} + +## Data transmission When {% data variables.product.prodname_github_connect %} is enabled, a record on {% data variables.product.prodname_ghe_cloud %} stores information about the connection. If you enable individual features of {% data variables.product.prodname_github_connect %}, additional data is transmitted. {% note %} -**Note:** No repositories, issues, or pull requests are ever transmitted from {% data variables.product.product_name %} to {% data variables.product.prodname_dotcom_the_website %} by {% data variables.product.prodname_github_connect %}. +**Note:** No repositories, issues, or pull requests are ever transmitted from {% data variables.product.product_name %} to {% data variables.product.prodname_ghe_cloud %} by {% data variables.product.prodname_github_connect %}. {% endnote %} @@ -86,9 +115,20 @@ Additional data is transmitted if you enable individual features of {% data vari | {% ifversion server-statistics %} | | {% data variables.product.prodname_server_statistics %} | Aggregate metrics about your usage of {% data variables.product.prodname_ghe_server %}. For the complete list of metrics, see "[AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics#server-statistics-data-collected)." | From {% data variables.product.product_name %} to {% data variables.product.prodname_ghe_cloud %} | {% data variables.product.prodname_ghe_cloud %} | | {% endif %} | -| Unified search | Search terms, search results | From {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.product_name %}

From {% data variables.product.product_name %} to {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.product_name %} | -| Unified contributions | Contribution counts | From {% data variables.product.product_name %} to {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.prodname_dotcom_the_website %} | +| Unified search | Search terms, search results | From {% data variables.product.prodname_ghe_cloud %} to {% data variables.product.product_name %}

From {% data variables.product.product_name %} to {% data variables.product.prodname_ghe_cloud %} | {% data variables.product.product_name %} | +| Unified contributions | Contribution counts | From {% data variables.product.product_name %} to {% data variables.product.prodname_ghe_cloud %} | {% data variables.product.prodname_ghe_cloud %} | + +## Enabling {% data variables.product.prodname_github_connect %} + +{% ifversion ghecom-github-connect %} + +To enable {% data variables.product.prodname_github_connect %}, see the article for your {% data variables.product.prodname_ghe_cloud %} environment. + +* "[AUTOTITLE](/admin/configuring-settings/configuring-github-connect/enabling-github-connect-for-githubcom)" +* "[AUTOTITLE](/admin/configuring-settings/configuring-github-connect/enabling-github-connect-for-ghecom)" + +{% else %} -## Further reading +To enable {% data variables.product.prodname_github_connect %}, see "[AUTOTITLE](/admin/configuring-settings/configuring-github-connect/enabling-github-connect-for-githubcom)." -* "[AUTOTITLE](/graphql/guides/managing-enterprise-accounts)" in the GraphQL API documentation +{% endif %} diff --git a/content/admin/configuring-settings/configuring-github-connect/disabling-github-connect.md b/content/admin/configuring-settings/configuring-github-connect/disabling-github-connect.md new file mode 100644 index 000000000000..afa0e4f8b2e3 --- /dev/null +++ b/content/admin/configuring-settings/configuring-github-connect/disabling-github-connect.md @@ -0,0 +1,15 @@ +--- +title: Disabling GitHub Connect +shortTitle: Disable GitHub Connect +intro: 'You can disable {% data variables.product.prodname_github_connect %} to stop the connection from {% data variables.location.product_location %} to {% data variables.product.prodname_ghe_cloud %}.' +versions: + ghes: '*' +permissions: 'Enterprise owners' +--- + +When you disconnect from {% data variables.product.prodname_ghe_cloud %}, the {% data variables.product.prodname_github_connect %} {% data variables.product.prodname_github_app %} is deleted from your enterprise account and credentials stored on {% data variables.location.product_location %} are deleted. + +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.github-connect-tab %} +1. Under "{% data variables.product.prodname_github_connect %}", to the right of the enterprise account you'd like to disconnect, click **Disable {% data variables.product.prodname_github_connect %}**. +1. Read the information about disconnection, then click **Disable {% data variables.product.prodname_github_connect %}**. diff --git a/content/admin/configuring-settings/configuring-github-connect/enabling-automatic-user-license-sync-for-your-enterprise.md b/content/admin/configuring-settings/configuring-github-connect/enabling-automatic-user-license-sync-for-your-enterprise.md index 678d403d7cb9..b5a6db4e1175 100644 --- a/content/admin/configuring-settings/configuring-github-connect/enabling-automatic-user-license-sync-for-your-enterprise.md +++ b/content/admin/configuring-settings/configuring-github-connect/enabling-automatic-user-license-sync-for-your-enterprise.md @@ -22,9 +22,9 @@ shortTitle: Automatic user license sync {% data reusables.enterprise-licensing.unique-user-licensing-model %} -{% data reusables.enterprise-licensing.about-license-sync %} For more information, see "[AUTOTITLE](/admin/configuration/configuring-github-connect/about-github-connect#data-transmission-for-github-connect)." +{% data reusables.enterprise-licensing.about-license-sync %} For more information, see "[AUTOTITLE](/admin/configuration/configuring-github-connect/about-github-connect#data-transmission)." -If you enable automatic user license sync for your enterprise, {% data variables.product.prodname_github_connect %} will automatically synchronize license usage between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %} weekly.{% ifversion ghes %} You can also synchronize your license data at any time outside of the automatic weekly sync, by manually triggering a license sync job. For more information, see "[AUTOTITLE](/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud#triggering-a-license-sync-job)."{% endif %} +If you enable automatic user license sync for your enterprise, every week, {% data variables.product.prodname_github_connect %} will automatically synchronize license usage between {% data variables.product.prodname_ghe_server %} and your enterprise on {% data variables.product.prodname_dotcom_the_website %}{% ifversion ghecom-license-sync %} or {% data variables.enterprise.data_residency_site %}{% endif %}. You can also synchronize your license data at any time outside of the automatic weekly sync, by manually triggering a license sync job. For more information, see "[AUTOTITLE](/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud#triggering-a-license-sync-job)." If you use multiple {% data variables.product.prodname_ghe_server %} instances, you can enable automatic license sync between each of your instances and the same enterprise account on {% data variables.product.prodname_ghe_cloud %}. @@ -36,7 +36,7 @@ You can also manually upload {% data variables.product.prodname_ghe_server %} us ## Enabling license synchronization -Before enabling license synchronization on {% data variables.location.product_location %}, you must enable {% data variables.product.prodname_github_connect %}. For more information, see "[AUTOTITLE](/admin/configuration/configuring-github-connect/managing-github-connect)." +Before enabling license synchronization on {% data variables.location.product_location %}, you must enable {% data variables.product.prodname_github_connect %}. See {% ifversion ghecom-license-sync %}"[AUTOTITLE](/admin/configuring-settings/configuring-github-connect/enabling-github-connect-for-ghecom) or {% endif %}"[AUTOTITLE](/admin/configuring-settings/configuring-github-connect/enabling-github-connect-for-githubcom)." {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.github-connect-tab %} diff --git a/content/admin/configuring-settings/configuring-github-connect/enabling-github-connect-for-ghecom.md b/content/admin/configuring-settings/configuring-github-connect/enabling-github-connect-for-ghecom.md new file mode 100644 index 000000000000..48530404b30f --- /dev/null +++ b/content/admin/configuring-settings/configuring-github-connect/enabling-github-connect-for-ghecom.md @@ -0,0 +1,82 @@ +--- +title: Enabling GitHub Connect for GHE.com +shortTitle: Enable for GHE.com +intro: 'Enable {% data variables.product.prodname_github_connect %} to share data between {% data variables.enterprise.data_residency_site %} and {% data variables.location.product_location %}.' +versions: + feature: ghecom-github-connect +--- + +You can access additional features and workflows on {% data variables.location.product_location %} by enabling {% data variables.product.prodname_github_connect %}. See "[AUTOTITLE](/admin/configuration/configuring-github-connect/about-github-connect)." + +On {% data variables.enterprise.data_residency_site %}, {% data variables.product.prodname_github_connect %} features do not include any functionality that relies on resources on {% data variables.product.prodname_dotcom_the_website %}. + +## What happens when {% data variables.product.prodname_github_connect %} is enabled? + +{% data reusables.github-connect.what-happens-when-enabled %} + +## Prerequisites + +* **Administrative access:** You need administrative access to both an enterprise account on {% data variables.enterprise.data_residency_site %} and a {% data variables.product.prodname_ghe_server %} instance. +* **Version requirement:** Your {% data variables.product.prodname_ghe_server %} instance must run {% data variables.product.prodname_ghe_server %} 3.12 or later. +* **Proxy configuration**: If using a proxy server, allow connectivity to the following {% data variables.enterprise.data_residency_site %} hostnames (replace SUBDOMAIN with your enterprise's subdomain). + + * `{% data variables.enterprise.data_residency_domain %}` + * `{% data variables.enterprise.data_residency_api %}` + * `uploads.{% data variables.enterprise.data_residency_domain %}` + + See "[AUTOTITLE](/admin/configuration/configuring-network-settings/configuring-an-outbound-web-proxy-server)." + +## Step 1: Enable connection to {% data variables.enterprise.data_residency_site %} + +By default, {% data variables.product.prodname_github_connect %} connects {% data variables.product.prodname_ghe_server %} to {% data variables.product.prodname_dotcom_the_website %}. You must enable your instance to connect to your enterprise's subdomain of {% data variables.enterprise.data_residency_site %}. + +To enable the connection, someone with administrative SSH access to {% data variables.location.product_location_enterprise %} must complete the following tasks. + +{% data reusables.enterprise_installation.ssh-into-instance %} +1. To enable your instance to connect to {% data variables.enterprise.data_residency_site %} for {% data variables.product.prodname_github_connect %}, run the following command. Replace SUBDOMAIN with the subdomain for your enterprise on {% data variables.enterprise.data_residency_site %}, for example `octocorp`. + + ```shell copy + ghe-config app.github.github-connect-ghe-com-enabled true + ghe-config app.github.github-connect-ghe-com-subdomain "SUBDOMAIN" + ``` + +1. To apply the configuration, run the following command. + + >[!NOTE] During a configuration run, services on {% data variables.location.product_location_enterprise %} may restart, which can cause brief downtime for users. + + ```shell copy + ghe-config-apply + ``` + +After the run completes, you can configure {% data variables.product.prodname_github_connect %}. + +## Step 2: Enable {% data variables.product.prodname_github_connect %} + +To enable {% data variables.product.prodname_github_connect %}, you must be an enterprise owner on both {% data variables.product.product_name %} and {% data variables.product.prodname_ghe_cloud %}. + +People with a user account in both environments can connect the accounts from {% data variables.location.product_location_enterprise %}. + +1. Sign in to {% data variables.location.product_location %} and {% data variables.enterprise.data_residency_site %}. +{% data reusables.github-connect.enable-github-connect %} +1. Choose which individual features of {% data variables.product.prodname_github_connect %} you want to enable. See "[AUTOTITLE](/admin/configuring-settings/configuring-github-connect/about-github-connect#github-connect-features)." + +## Reenabling connections to {% data variables.product.prodname_dotcom_the_website %} + +If you need to reenable {% data variables.product.prodname_github_connect %} for {% data variables.product.prodname_dotcom_the_website %}, you must reconfigure your settings. + +{% data reusables.enterprise_installation.ssh-into-instance %} +1. Run the following command. + + ```shell copy + ghe-config app.github.github-connect-ghe-com-enabled false + ``` + +1. To apply the configuration, run the following command. + + >[!NOTE] During a configuration run, services on {% data variables.location.product_location_enterprise %} may restart, which can cause brief downtime for users. + + ```shell copy + ghe-config-apply + ``` + +1. Enable {% data variables.product.prodname_github_connect %} on {% data variables.product.prodname_dotcom_the_website %}. See "[AUTOTITLE](/admin/configuring-settings/configuring-github-connect/enabling-github-connect-for-githubcom)." diff --git a/content/admin/configuring-settings/configuring-github-connect/enabling-github-connect-for-githubcom.md b/content/admin/configuring-settings/configuring-github-connect/enabling-github-connect-for-githubcom.md new file mode 100644 index 000000000000..b42cbb036936 --- /dev/null +++ b/content/admin/configuring-settings/configuring-github-connect/enabling-github-connect-for-githubcom.md @@ -0,0 +1,47 @@ +--- +title: Enabling GitHub Connect for GitHub.com +shortTitle: Enable for GitHub.com +intro: 'Enable {% data variables.product.prodname_github_connect %} to access additional features and workflows from {% data variables.product.prodname_dotcom_the_website %} on {% data variables.location.product_location %}.' +redirect_from: + - /enterprise/admin/guides/developer-workflow/connecting-github-enterprise-to-github-com + - /enterprise/admin/guides/developer-workflow/connecting-github-enterprise-server-to-github-com + - /enterprise/admin/developer-workflow/connecting-github-enterprise-server-to-githubcom + - /enterprise/admin/installation/connecting-github-enterprise-server-to-github-enterprise-cloud + - /enterprise/admin/configuration/connecting-github-enterprise-server-to-github-enterprise-cloud + - /admin/configuration/connecting-github-enterprise-server-to-github-enterprise-cloud + - /admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud/connecting-github-enterprise-server-to-github-enterprise-cloud + - /admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud + - /admin/configuration/configuring-github-connect/managing-github-connect + - /admin/configuring-settings/configuring-github-connect/managing-github-connect +versions: + ghes: '*' +type: how_to +topics: + - Enterprise + - GitHub Connect + - Infrastructure + - Networking +--- + +You can access additional features and workflows on {% data variables.location.product_location %} by enabling {% data variables.product.prodname_github_connect %}. See "[AUTOTITLE](/admin/configuration/configuring-github-connect/about-github-connect)." + +## What happens when {% data variables.product.prodname_github_connect %} is enabled? + +{% data reusables.github-connect.what-happens-when-enabled %} + +## Prerequisites + +* You must have an enterprise account on {% data variables.product.prodname_dotcom_the_website %} that uses {% data variables.product.prodname_ghe_cloud %}. +* Your enterprise account on {% data variables.product.prodname_dotcom_the_website %} must be invoiced. Enterprise accounts on the free trial of {% data variables.product.prodname_ghe_cloud %} or that pay by credit card cannot be connected to {% data variables.location.product_location %}. +* If your enterprise account on {% data variables.product.prodname_dotcom_the_website %} uses IP allow lists, you must add the IP address or network for {% data variables.location.product_location %} to your IP allow list. See "[AUTOTITLE](/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise#managing-allowed-ip-addresses-for-organizations-in-your-enterprise)" in the {% data variables.product.prodname_ghe_cloud %} documentation. +* To configure a connection, your proxy configuration must allow connectivity to `github.com`, `api.github.com`, and `uploads.github.com`. For more information, see "[AUTOTITLE](/admin/configuration/configuring-network-settings/configuring-an-outbound-web-proxy-server)." +{%- ifversion ghecom-github-connect %} +* If you have previously enabled {% data variables.product.prodname_github_connect %} for an enterprise on {% data variables.enterprise.data_residency_site %}, you must change your configuration to allow connections to {% data variables.product.prodname_dotcom_the_website %}. See "[AUTOTITLE](/admin/configuring-settings/configuring-github-connect/enabling-github-connect-for-ghecom#reenabling-connections-to-githubcom)." +{%- endif %} + +## Enabling {% data variables.product.prodname_github_connect %} + +To enable {% data variables.product.prodname_github_connect %}, you must be an enterprise owner on both {% data variables.product.product_name %} and {% data variables.product.prodname_ghe_cloud %}. + +1. Sign in to {% data variables.location.product_location %} and {% data variables.product.prodname_dotcom_the_website %}. +{% data reusables.github-connect.enable-github-connect %} diff --git a/content/admin/configuring-settings/configuring-github-connect/enabling-unified-contributions-for-your-enterprise.md b/content/admin/configuring-settings/configuring-github-connect/enabling-unified-contributions-for-your-enterprise.md index 1b29c83d6b9b..63c26f59a6f4 100644 --- a/content/admin/configuring-settings/configuring-github-connect/enabling-unified-contributions-for-your-enterprise.md +++ b/content/admin/configuring-settings/configuring-github-connect/enabling-unified-contributions-for-your-enterprise.md @@ -1,7 +1,7 @@ --- title: Enabling unified contributions for your enterprise shortTitle: Unified contributions -intro: 'You can allow users to include anonymized contribution counts for their work on {% data variables.location.product_location %} in their contribution graphs on {% data variables.product.prodname_dotcom_the_website %}.' +intro: 'You can allow users to include anonymized contribution counts for their work on {% data variables.location.product_location %} in their contribution graphs on {% data variables.product.prodname_ghe_cloud %}.' redirect_from: - /enterprise/admin/guides/developer-workflow/enabling-unified-contributions-between-github-enterprise-and-github-com - /enterprise/admin/guides/developer-workflow/enabling-unified-contributions-between-github-enterprise-server-and-github-com @@ -12,7 +12,7 @@ redirect_from: - /admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud/enabling-unified-contributions-between-github-enterprise-server-and-githubcom - /admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-contributions-between-your-enterprise-account-and-githubcom - /admin/configuration/configuring-github-connect/enabling-unified-contributions-for-your-enterprise -permissions: 'Enterprise owners can enable unified contributions between {% data variables.location.product_location %} and {% data variables.product.prodname_dotcom_the_website %}.' +permissions: 'Enterprise owners' versions: ghes: '*' type: how_to @@ -23,31 +23,27 @@ topics: ## About unified contributions -As an enterprise owner, you can allow end users to send anonymized contribution counts for their work from {% data variables.location.product_location %} to their {% data variables.product.prodname_dotcom_the_website %} contribution graph. +As an enterprise owner, you can allow end users to send anonymized contribution counts for their work from {% data variables.location.product_location %} to their contribution graph on {% data variables.product.prodname_dotcom_the_website %}{% ifversion ghecom-github-connect %} or {% data variables.enterprise.data_residency_site %}{% endif %}. -After you enable {% data variables.enterprise.prodname_unified_contributions %}, before individual users can send contribution counts from {% data variables.location.product_location %} to {% data variables.product.prodname_dotcom_the_website %}, each user must also connect their user account on {% data variables.product.product_name %} with a personal account on {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile)." +After you enable {% data variables.enterprise.prodname_unified_contributions %}, before individual users can send contribution counts from {% data variables.location.product_location %} to {% data variables.product.prodname_ghe_cloud %}, each user must also connect their user account on {% data variables.product.product_name %} with an account on {% data variables.product.prodname_ghe_cloud %}. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile)." {% data reusables.github-connect.sync-frequency %} -If the enterprise owner disables the functionality or individual users opt out of the connection, the contribution counts from {% data variables.product.product_name %} will be deleted on {% data variables.product.prodname_dotcom_the_website %}. If the user reconnects their profiles after disabling them, the contribution counts for the past 90 days are restored. +If the enterprise owner disables the functionality or individual users opt out of the connection, the contribution counts from {% data variables.product.product_name %} will be deleted on {% data variables.product.prodname_ghe_cloud %}. If the user reconnects their profiles after disabling them, the contribution counts for the past 90 days are restored. {% data variables.product.product_name %} **only** sends the contribution count and source ({% data variables.product.product_name %}) for connected users. It does not send any information about the contribution or how it was made. ## Enabling unified contributions -Before enabling {% data variables.enterprise.prodname_unified_contributions %} on {% data variables.location.product_location %}, you must enable {% data variables.product.prodname_github_connect %}. For more information, see "[AUTOTITLE](/admin/configuration/configuring-github-connect/managing-github-connect)." +Before enabling {% data variables.enterprise.prodname_unified_contributions %} on {% data variables.location.product_location %}, you must enable {% data variables.product.prodname_github_connect %}. See {% ifversion ghecom-github-connect %}"[AUTOTITLE](/admin/configuring-settings/configuring-github-connect/enabling-github-connect-for-ghecom) or {% endif %}"[AUTOTITLE](/admin/configuring-settings/configuring-github-connect/enabling-github-connect-for-githubcom)." -{% ifversion ghes %} {% data reusables.github-connect.access-dotcom-and-enterprise %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.business %} -{% data reusables.enterprise-accounts.github-connect-tab %}{% else %} -1. Sign in to {% data variables.location.product_location %} and {% data variables.product.prodname_dotcom_the_website %}. -{% data reusables.enterprise-accounts.access-enterprise %}{% data reusables.enterprise-accounts.github-connect-tab %}{% endif %} -1. To the right of "Unified contributions", click **Enable**.{% ifversion ghes %} +{% data reusables.enterprise-accounts.github-connect-tab %} +1. To the right of "Unified contributions", click **Enable**. ![Screenshot of the "Unified contributions" option on the GitHub Connect page. The "Enable" button is highlighted with an orange outline.](/assets/images/enterprise/site-admin-settings/dotcom-ghe-connection-request-access.png) 1. [Sign in](https://enterprise.github.com/login) to the {% data variables.product.prodname_ghe_server %} site to receive further instructions. When you request access, we may redirect you to the {% data variables.product.prodname_ghe_server %} site to check your current terms of service. -{% endif %} diff --git a/content/admin/configuring-settings/configuring-github-connect/enabling-unified-search-for-your-enterprise.md b/content/admin/configuring-settings/configuring-github-connect/enabling-unified-search-for-your-enterprise.md index 172b55e4f0d6..0f33a0d2123a 100644 --- a/content/admin/configuring-settings/configuring-github-connect/enabling-unified-search-for-your-enterprise.md +++ b/content/admin/configuring-settings/configuring-github-connect/enabling-unified-search-for-your-enterprise.md @@ -1,7 +1,7 @@ --- title: Enabling unified search for your enterprise shortTitle: Unified search -intro: 'You can allow users to include repositories on {% data variables.product.prodname_dotcom_the_website %} in their search results when searching from {% data variables.location.product_location %}.' +intro: 'You can allow users to include repositories on {% data variables.product.prodname_ghe_cloud %} in their search results when searching from {% data variables.location.product_location %}.' redirect_from: - /enterprise/admin/guides/developer-workflow/enabling-unified-search-between-github-enterprise-and-github-com - /enterprise/admin/guides/developer-workflow/enabling-unified-search-between-github-enterprise-server-and-github-com @@ -12,7 +12,7 @@ redirect_from: - /admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud/enabling-unified-search-between-github-enterprise-server-and-githubcom - /admin/configuration/managing-connections-between-your-enterprise-accounts/enabling-unified-search-between-your-enterprise-account-and-githubcom - /admin/configuration/configuring-github-connect/enabling-unified-search-for-your-enterprise -permissions: 'Enterprise owners can enable unified search between {% data variables.product.product_name %} and {% data variables.product.prodname_dotcom_the_website %}.' +permissions: 'Enterprise owners' versions: ghes: '*' type: how_to @@ -24,27 +24,24 @@ topics: ## About {% data variables.enterprise.prodname_unified_search %} -When you enable unified search, users can view search results from content on {% data variables.product.prodname_dotcom_the_website %} when searching from {% data variables.location.product_location %}. +When you enable unified search, users can view search results from content on {% data variables.product.prodname_dotcom_the_website %}{% ifversion ghecom-github-connect %} or {% data variables.enterprise.data_residency_site %}{% endif %} when searching from {% data variables.location.product_location %}. You can choose to allow search results for public repositories on {% data variables.product.prodname_dotcom_the_website %}, and you can separately choose to allow search results for private repositories on {% data variables.product.prodname_ghe_cloud %}. If you enable unified search for private repositories, users can only search private repositories that they have access to and that are owned by the connected enterprise account. For more information, see "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/about-searching-on-github#searching-across-github-enterprise-and-githubcom-simultaneously)." -Users will never be able to search {% data variables.location.product_location %} from {% data variables.product.prodname_dotcom_the_website %}, even if they have access to both environments. +Users will never be able to search {% data variables.location.product_location %} from {% data variables.product.prodname_ghe_cloud %}, even if they have access to both environments. -After you enable unified search for {% data variables.location.product_location %}, before individual users can see search results from private repositories on {% data variables.product.prodname_dotcom_the_website %} in {% data variables.location.product_location %}, each user must also connect their user account on {% data variables.product.product_name %} with a user account on {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/enabling-githubcom-repository-search-from-your-private-enterprise-environment)." +After you enable unified search for {% data variables.location.product_location %}, before individual users can see search results from private repositories on {% data variables.product.prodname_ghe_cloud %} in {% data variables.location.product_location %}, each user must also connect their user account on {% data variables.product.product_name %} with a user account on {% data variables.product.prodname_ghe_cloud %}. For more information, see "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/enabling-githubcom-repository-search-from-your-private-enterprise-environment)." -Searching via the REST and GraphQL APIs does not include {% data variables.product.prodname_dotcom_the_website %} search results. Advanced search and searching for wikis in {% data variables.product.prodname_dotcom_the_website %} are not supported. +Searching via the REST and GraphQL APIs does not include {% data variables.product.prodname_ghe_cloud %} search results. Advanced search and searching for wikis in {% data variables.product.prodname_ghe_cloud %} are not supported. ## Enabling {% data variables.enterprise.prodname_unified_search %} -Before you can enable {% data variables.enterprise.prodname_unified_search %}, you must enable {% data variables.product.prodname_github_connect %}. For more information, see "[AUTOTITLE](/admin/configuration/configuring-github-connect/managing-github-connect)." +Before you can enable {% data variables.enterprise.prodname_unified_search %}, you must enable {% data variables.product.prodname_github_connect %}. See {% ifversion ghecom-github-connect %}"[AUTOTITLE](/admin/configuring-settings/configuring-github-connect/enabling-github-connect-for-ghecom) or {% endif %}"[AUTOTITLE](/admin/configuring-settings/configuring-github-connect/enabling-github-connect-for-githubcom)." -{% ifversion ghes %} {% data reusables.github-connect.access-dotcom-and-enterprise %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.business %} -{% data reusables.enterprise-accounts.github-connect-tab %}{% else %} -1. Sign into {% data variables.location.product_location %} and {% data variables.product.prodname_dotcom_the_website %}. -{% data reusables.enterprise-accounts.access-enterprise %}{% data reusables.enterprise-accounts.github-connect-tab %}{% endif %} +{% data reusables.enterprise-accounts.github-connect-tab %} 1. To the right of "Unified search", click **Enable**. ![Screenshot of the "Unified search" option on the GitHub Connect page. The "Enable" button is highlighted with an orange outline.](/assets/images/enterprise/site-admin-settings/github-dotcom-enable-search.png) diff --git a/content/admin/configuring-settings/configuring-github-connect/index.md b/content/admin/configuring-settings/configuring-github-connect/index.md index 3fc543b3d078..27d30af75905 100644 --- a/content/admin/configuring-settings/configuring-github-connect/index.md +++ b/content/admin/configuring-settings/configuring-github-connect/index.md @@ -18,12 +18,14 @@ topics: - Enterprise children: - /about-github-connect - - /managing-github-connect + - /enabling-github-connect-for-githubcom + - /enabling-github-connect-for-ghecom - /enabling-automatic-user-license-sync-for-your-enterprise - /enabling-dependabot-for-your-enterprise - /enabling-server-statistics-for-your-enterprise - /enabling-unified-search-for-your-enterprise - /enabling-unified-contributions-for-your-enterprise + - /disabling-github-connect shortTitle: GitHub Connect --- diff --git a/content/admin/configuring-settings/configuring-github-connect/managing-github-connect.md b/content/admin/configuring-settings/configuring-github-connect/managing-github-connect.md deleted file mode 100644 index 6aece42aebd8..000000000000 --- a/content/admin/configuring-settings/configuring-github-connect/managing-github-connect.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: Managing GitHub Connect -shortTitle: Manage GitHub Connect -intro: 'You can enable {% data variables.product.prodname_github_connect %} to access additional features and workflows for {% data variables.location.product_location %}.' -redirect_from: - - /enterprise/admin/guides/developer-workflow/connecting-github-enterprise-to-github-com - - /enterprise/admin/guides/developer-workflow/connecting-github-enterprise-server-to-github-com - - /enterprise/admin/developer-workflow/connecting-github-enterprise-server-to-githubcom - - /enterprise/admin/installation/connecting-github-enterprise-server-to-github-enterprise-cloud - - /enterprise/admin/configuration/connecting-github-enterprise-server-to-github-enterprise-cloud - - /admin/configuration/connecting-github-enterprise-server-to-github-enterprise-cloud - - /admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud/connecting-github-enterprise-server-to-github-enterprise-cloud - - /admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud - - /admin/configuration/configuring-github-connect/managing-github-connect -versions: - ghes: '*' -type: how_to -topics: - - Enterprise - - GitHub Connect - - Infrastructure - - Networking ---- - -## About {% data variables.product.prodname_github_connect %} - -You can access additional features and workflows on {% data variables.location.product_location %} by enabling {% data variables.product.prodname_github_connect %}. For more information, see "[AUTOTITLE](/admin/configuration/configuring-github-connect/about-github-connect)." - -When you enable {% data variables.product.prodname_github_connect %}, you configure a connection between {% data variables.location.product_location %} and an enterprise account on {% data variables.product.prodname_ghe_cloud %}. {% data reusables.github-connect.connection-port-protocol %} - -Enabling {% data variables.product.prodname_github_connect %} creates a {% data variables.product.prodname_github_app %} owned by the enterprise account on {% data variables.product.prodname_ghe_cloud %}. {% data variables.product.product_name %} uses the {% data variables.product.prodname_github_app %}'s credentials to make requests to {% data variables.product.prodname_ghe_cloud %}. - -{% ifversion ghes %} -{% data variables.product.prodname_ghe_server %} stores credentials from the {% data variables.product.prodname_github_app %}. The following credentials will be replicated to all nodes in a high availability or cluster environment, and stored in any backups, including snapshots created by {% data variables.product.prodname_enterprise_backup_utilities %}. -* An authentication token, which is valid for one hour -* A private key, which is used to generate a new authentication token -{% endif %} - -## Prerequisites - -To use {% data variables.product.prodname_github_connect %}, you must have an enterprise account on {% data variables.product.prodname_dotcom_the_website %} that uses {% data variables.product.prodname_ghe_cloud %}. You may already have {% data variables.product.prodname_ghe_cloud %} included in your plan. - -{% note %} - -**Note:** Your enterprise account on {% data variables.product.prodname_dotcom_the_website %} must be invoiced. Enterprise accounts on the free trial of {% data variables.product.prodname_ghe_cloud %} or that pay by credit card cannot be connected to {% data variables.location.product_location %}. - -{% endnote %} - -{% ifversion ghes %} -If your enterprise account on {% data variables.product.prodname_dotcom_the_website %} uses IP allow lists, you must add the IP address or network for {% data variables.location.product_location %} to your IP allow list on {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise#managing-allowed-ip-addresses-for-organizations-in-your-enterprise)" in the {% data variables.product.prodname_ghe_cloud %} documentation. - -To configure a connection, your proxy configuration must allow connectivity to `github.com`, `api.github.com`, and `uploads.github.com`. For more information, see "[AUTOTITLE](/admin/configuration/configuring-network-settings/configuring-an-outbound-web-proxy-server)." -{% endif %} - -## Enabling {% data variables.product.prodname_github_connect %} - -To enable {% data variables.product.prodname_github_connect %}, you must be an enterprise owner on both {% data variables.product.product_name %} and {% data variables.product.prodname_ghe_cloud %}. - -{% ifversion ghes %} -1. Sign in to {% data variables.location.product_location %} and {% data variables.product.prodname_dotcom_the_website %}. -{% data reusables.enterprise-accounts.access-enterprise %} -{% data reusables.enterprise-accounts.github-connect-tab %}{% else %} -1. Sign in to {% data variables.location.product_location %} and {% data variables.product.prodname_dotcom_the_website %}. -{% data reusables.enterprise-accounts.access-enterprise %}{% data reusables.enterprise-accounts.github-connect-tab %}{% endif %} -1. Under "{% data variables.product.prodname_github_connect %} is not enabled yet", click **Enable {% data variables.product.prodname_github_connect %}**. By clicking **Enable {% data variables.product.prodname_github_connect %}**, you agree to the "[AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-terms-for-additional-products-and-features#connect)." -1. To the right of the enterprise account you'd like to connect, click **Connect**. - -## Disabling {% data variables.product.prodname_github_connect %} - -Enterprise owners can disable {% data variables.product.prodname_github_connect %}. - -When you disconnect from {% data variables.product.prodname_ghe_cloud %}, the {% data variables.product.prodname_github_connect %} {% data variables.product.prodname_github_app %} is deleted from your enterprise account and credentials stored on {% data variables.location.product_location %} are deleted. - -{% data reusables.enterprise-accounts.access-enterprise %} -{% data reusables.enterprise-accounts.github-connect-tab %} -1. Under "{% data variables.product.prodname_github_connect %}", to the right of the enterprise account you'd like to disconnect, click **Disable {% data variables.product.prodname_github_connect %}**. -1. Read the information about disconnection, then click **Disable {% data variables.product.prodname_github_connect %}**. diff --git a/content/admin/configuring-settings/configuring-private-networking-for-hosted-compute-products/configuring-private-networking-for-github-hosted-runners-in-your-enterprise.md b/content/admin/configuring-settings/configuring-private-networking-for-hosted-compute-products/configuring-private-networking-for-github-hosted-runners-in-your-enterprise.md index 229b81e0ea5c..76a24fbd81c6 100644 --- a/content/admin/configuring-settings/configuring-private-networking-for-hosted-compute-products/configuring-private-networking-for-github-hosted-runners-in-your-enterprise.md +++ b/content/admin/configuring-settings/configuring-private-networking-for-hosted-compute-products/configuring-private-networking-for-github-hosted-runners-in-your-enterprise.md @@ -56,7 +56,9 @@ Variables } ``` -Alternatively, you can use the following curl command to find your `databaseId`. +#### Example for {% data variables.product.prodname_dotcom_the_website %} + +You can use the following curl command to find your `databaseId`. ```shell copy curl -H "Authorization: Bearer BEARER_TOKEN" -X POST \ @@ -68,6 +70,16 @@ curl -H "Authorization: Bearer BEARER_TOKEN" -X POST \ https://api.github.com/graphql ``` +#### Example for {% data variables.enterprise.data_residency_site %} + +You can use the following {% data variables.product.prodname_cli %} commands to retrieve the `databaseId`. Replace SUBDOMAIN with your enterprise's subdomain of {% data variables.enterprise.data_residency_site %}. + + ```shell copy + gh auth login -s 'read:enterprise' -h SUBDOMAIN.ghe.com + + gh api graphql --hostname SUBDOMAIN.ghe.com -f query='query($slug: String!) { enterprise (slug: $slug) { slug databaseId } }' -f slug='SUBDOMAIN' + ``` + {% data reusables.actions.azure-vnet-configure-azure-resources-script %} ## Creating a network configuration for your enterprise in {% data variables.product.company_short %} diff --git a/content/admin/data-residency/about-github-enterprise-cloud-with-data-residency.md b/content/admin/data-residency/about-github-enterprise-cloud-with-data-residency.md new file mode 100644 index 000000000000..46eebc6ad5cc --- /dev/null +++ b/content/admin/data-residency/about-github-enterprise-cloud-with-data-residency.md @@ -0,0 +1,104 @@ +--- +title: About GitHub Enterprise Cloud with data residency +intro: "With {% data variables.product.prodname_ghe_cloud %}, you can have more control over your data without needing to host your own platform." +shortTitle: What is data residency? +versions: + ghec: '*' +--- + +By default, {% data variables.product.company_short %} stores data for {% data variables.product.prodname_dotcom_the_website %} in the USA. {% data reusables.data-residency.when-you-adopt-data-residency %} To learn how {% data variables.product.company_short %} handles data storage, see "[AUTOTITLE](/admin/data-residency/about-storage-of-your-data-with-data-residency)." + +Access to this feature is currently managed by {% data variables.contact.contact_enterprise_sales %}. + +## What is {% data variables.product.product_name %}? + +{% data variables.product.github %} is a complete developer platform for building, scaling, and delivering secure software. In addition to these capabilities, {% data variables.product.product_name %} offers several key features designed to further optimize and secure your use of the platform: + +* Includes an **enterprise account**: a dedicated, shared space for your company to store code, collaborate, and access {% data variables.product.company_short %} features +* Centralizes billing, administration, governance, and audit of your company’s resources and activity +* Is accessible only to authorized users, isolated from the wider {% data variables.product.prodname_dotcom_the_website %} community +* Includes management of authentication and user lifecycles from an external identity management system: + + * **SCIM** for provisioning + * **SAML** or **OIDC** for authentication + +With {% data variables.enterprise.data_residency_short %}, {% data variables.enterprise.prodname_managed_users %} access your resources through a dedicated subdomain of {% data variables.enterprise.data_residency_site %}, and can only interact with resources that belong to your enterprise. + +## Why move data to the cloud? + +If you currently use a self-hosted service like {% data variables.product.prodname_ghe_server %}, {% data variables.enterprise.data_residency %} will help you to have more control over your data while benefiting from a cloud-based, managed product. + +* Your users will have access to the latest features from {% data variables.product.prodname_dotcom_the_website %}, such as {% data variables.product.prodname_copilot %}, without needing to wait for features to be available in {% data variables.product.prodname_ghe_server %} releases. +* You'll have a simplified administrative experience, and won't need to schedule downtime for maintenance or upgrades. + +## How does billing work? + +To adopt {% data variables.enterprise.data_residency %}, you'll sign up for the **{% data variables.product.prodname_enterprise %} plan**, which covers your enterprise on {% data variables.enterprise.data_residency_site %} and, if you need it, {% data variables.product.prodname_ghe_server %}. For pricing details, see our [Pricing](https://github.com/pricing) page. + +To pay for user licenses and services, you can: +* Add a credit card or PayPal account to your enterprise and bill directly through {% data variables.product.company_short %} +* Connect your enterprise to a Microsoft Azure subscription + +You will be on our latest billing platform, which allows you to estimate spending, create cost centers to manage expenses, and pay flexibly for the services you use. + +You can also sign up for usage-based billing for {% data variables.product.prodname_enterprise %} and {% data variables.product.prodname_GH_advanced_security %} licenses, meaning you won't need to purchase a pre-defined number of licenses in advance. + +## Developer experience + +The developer experience on {% data variables.enterprise.data_residency_site %} differs in some ways from {% data variables.product.prodname_dotcom_the_website %} and {% data variables.product.prodname_ghe_server %}. + +* [Identity and access](#identity-and-access) +* [Functionality for managed user accounts](#functionality-for-managed-user-accounts) +* [Repository visibility](#repository-visibility) +* [API access](#api-access) +* [Documentation](#documentation) + +### Identity and access + +Enterprises on {% data variables.enterprise.data_residency_site %} use **{% data variables.product.prodname_emus %}**. In an {% data variables.enterprise.prodname_emu_enterprise %}, your company manages the user accounts that people use to access your resources. These accounts can only access your enterprise's resources, and are isolated from the wider open source community on {% data variables.product.prodname_dotcom_the_website %}. + +People access your enterprise via the {% data variables.enterprise.data_residency_site %} URL that you choose during onboarding. To access your enterprise's resources, people must authenticate through the identity management system that your company uses. + +### Network access + +Network details such as IP ranges and SSH key fingerprints differ between {% data variables.enterprise.data_residency_site %} and {% data variables.product.prodname_dotcom_the_website %}. You must give client systems such as storage accounts or identity provider integrations access to your enterprise. See "[AUTOTITLE](/admin/data-residency/network-details-for-ghecom)." + +### Functionality for {% data variables.enterprise.prodname_managed_users %} + +Administrators and developers with access to your enterprise can take advantage of the full {% data variables.product.prodname_dotcom %} platform, with the exception of some features that are currently unavailable. + +Developers may have experience using a personal account on {% data variables.product.prodname_dotcom_the_website %}, or a user account on a {% data variables.product.prodname_ghe_server %} instance. The experience of using a {% data variables.enterprise.prodname_managed_user %} on {% data variables.enterprise.data_residency_site %} differs in some ways. See "[AUTOTITLE](/admin/identity-and-access-management/understanding-iam-for-enterprises/abilities-and-restrictions-of-managed-user-accounts)." + +### Repository visibility + +Public repositories are not available in an {% data variables.enterprise.prodname_emu_enterprise %}. To practice innersource, users can create internal repositories that are visible to all enterprise members. See "[AUTOTITLE](/repositories/creating-and-managing-repositories/about-repositories#about-internal-repositories)." + +### API access + +{% data reusables.data-residency.data-resident-enterprises-api-access %} For example, if your enterprise's subdomain is `octocorp`, users should send requests to `https://api.octocorp.ghe.com`. + +Users can simplify API requests by using the {% data variables.product.prodname_cli %}. However, if they also need to access resources on {% data variables.product.prodname_dotcom_the_website %} or {% data variables.product.prodname_ghe_server %}, they will need to authenticate to multiple accounts and specify a target platform for most requests. See "[AUTOTITLE](/github-cli/github-cli/using-multiple-accounts)." + +Rate limits apply for requests to the REST API. See "[AUTOTITLE](/rest/overview/rate-limits-for-the-rest-api)." + +### Documentation + +In general, the content on [{% data variables.product.prodname_docs %}](/enterprise-cloud@latest) reflects the user experience on {% data variables.enterprise.data_residency_site %}. Readers should use the "{% data variables.product.product_name %}" version of the site. See "[AUTOTITLE](/get-started/using-github-docs/about-versions-of-github-docs#about-versions-of-github-docs)." + +When reading the documentation, readers may need to substitute references to {% data variables.product.prodname_dotcom_the_website %} with your enterprise's dedicated URL on {% data variables.enterprise.data_residency_site %}. + +## Feature overview + +{% data reusables.data-residency.data-resident-enterprise-feature-availability %} See "[AUTOTITLE](/admin/data-residency/feature-overview-for-github-enterprise-cloud-with-data-residency)." + +## Getting started + +When you have worked with your account team in {% data variables.contact.contact_enterprise_sales %} to create a new enterprise account and choose a subdomain on {% data variables.enterprise.data_residency_site %}, you can get started with your new enterprise. + +You will: + +* Create accounts for your company's administrators and developers +* Add your billing details +* Optionally, migrate data from another platform + +To get started, see "[AUTOTITLE](/admin/data-residency/getting-started-with-data-residency-for-github-enterprise-cloud)." diff --git a/content/admin/data-residency/about-storage-of-your-data-with-data-residency.md b/content/admin/data-residency/about-storage-of-your-data-with-data-residency.md new file mode 100644 index 000000000000..d4c361f741fd --- /dev/null +++ b/content/admin/data-residency/about-storage-of-your-data-with-data-residency.md @@ -0,0 +1,46 @@ +--- +title: About storage of your data with data residency +shortTitle: How is data stored? +intro: "Learn how your data is stored when you use {% data variables.enterprise.data_residency %}." +versions: + ghec: '*' +--- + +{% data reusables.data-residency.when-you-adopt-data-residency %} + +Although your code and user data are stored within your chosen region, {% data variables.product.company_short %} may store certain types of data outside your region, and may need to transfer some data outside your region. + +If you are in doubt about any aspect of {% data variables.enterprise.data_residency_short %}, contact your account manager in {% data variables.contact.contact_enterprise_sales %}. + +## Data stored in your region + +{% data variables.product.company_short %} stores the following data for your enterprise within your chosen region. + +| Description of data | Examples | +| :- | :- | +| Customer content, including text, data, software, images, and other data available on the service | | +| Data or logs that identify your company | | +| Data or logs that identify a person | | + +## Data stored outside your region + +For the purposes outlined in our [Data Protection Agreement](https://github.com/customer-terms/github-data-protection-agreement), {% data variables.product.company_short %} may store the following data for your enterprise outside your chosen region. + +| Description of data | Examples | +| :- | :- | +| Telemetry or logs containing consistent identifiers tied to a person, that by themselves do not identify the person without additional information |