[Quote removal] Remove quotes from data/reusables/dependency-graph through data/reusables/files (#53676)
Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com>
This commit is contained in:
Roniece Ricardo
@@ -1 +1 @@
|
||||
If you have at least read access to the repository, you can export the dependency graph for the repository as an SPDX-compatible, Software Bill of Materials (SBOM), via the {% data variables.product.prodname_dotcom %} UI or {% data variables.product.company_short %} REST API. For more information, see "[AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/exporting-a-software-bill-of-materials-for-your-repository)."
|
||||
If you have at least read access to the repository, you can export the dependency graph for the repository as an SPDX-compatible, Software Bill of Materials (SBOM), via the {% data variables.product.prodname_dotcom %} UI or {% data variables.product.company_short %} REST API. For more information, see [AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/exporting-a-software-bill-of-materials-for-your-repository).
|
||||
|
||||
@@ -19,5 +19,5 @@
|
||||
|
||||
> [!NOTE]
|
||||
> * If you list your Python dependencies within a `setup.py` file, we may not be able to parse and list every dependency in your project.
|
||||
> * {% data variables.product.prodname_actions %} workflows must be located in the `.github/workflows/` directory of a repository to be recognized as manifests. Any actions or workflows referenced using the syntax `jobs[*].steps[*].uses` or `jobs.<job_id>.uses` will be parsed as dependencies. For more information, see "[AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions)."
|
||||
> * {% data reusables.dependabot.dependabot-alert-actions-semver %} For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)" and "[AUTOTITLE](/code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates)."
|
||||
> * {% data variables.product.prodname_actions %} workflows must be located in the `.github/workflows/` directory of a repository to be recognized as manifests. Any actions or workflows referenced using the syntax `jobs[*].steps[*].uses` or `jobs.<job_id>.uses` will be parsed as dependencies. For more information, see [AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions).
|
||||
> * {% data reusables.dependabot.dependabot-alert-actions-semver %} For more information, see [AUTOTITLE](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts) and [AUTOTITLE](/code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates).
|
||||
|
||||
@@ -1 +1 @@
|
||||
By default, the {% data variables.dependency-review.action_name %} check will fail if it discovers any vulnerable packages. A failed check blocks a pull request from being merged when the repository owner requires the dependency review check to pass. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-status-checks-before-merging)."
|
||||
By default, the {% data variables.dependency-review.action_name %} check will fail if it discovers any vulnerable packages. A failed check blocks a pull request from being merged when the repository owner requires the dependency review check to pass. For more information, see [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-status-checks-before-merging).
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
The {% data variables.dependency-review.action_name %} scans your pull requests for dependency changes and raises an error if any new dependencies have known vulnerabilities. The action is supported by an API endpoint that compares the dependencies between two revisions and reports any differences.
|
||||
|
||||
For more information about the action and the API endpoint, see the [`dependency-review-action`](https://github.com/actions/dependency-review-action) documentation, and "[AUTOTITLE](/rest/dependency-graph/dependency-review)."
|
||||
For more information about the action and the API endpoint, see the [`dependency-review-action`](https://github.com/actions/dependency-review-action) documentation, and [AUTOTITLE](/rest/dependency-graph/dependency-review).
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
{% ifversion ghes %}
|
||||
After you enable the dependency graph, users will have access to the dependency review feature. {% data reusables.dependency-review.short-summary %} For more information, see "[AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review)."
|
||||
After you enable the dependency graph, users will have access to the dependency review feature. {% data reusables.dependency-review.short-summary %} For more information, see [AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review).
|
||||
{% endif %}
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
{% ifversion repo-rules %}
|
||||
|
||||
Organization owners can roll out dependency review at scale by enforcing the use of the {% data variables.dependency-review.action_name %} across repositories in the organization. This involves the use of repository rulesets for which you'll set the {% data variables.dependency-review.action_name %} as a required workflow, which means that pull requests can only be merged once the workflow passes all the required checks. For more information, see "[AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/enforcing-dependency-review-across-an-organization)."
|
||||
Organization owners can roll out dependency review at scale by enforcing the use of the {% data variables.dependency-review.action_name %} across repositories in the organization. This involves the use of repository rulesets for which you'll set the {% data variables.dependency-review.action_name %} as a required workflow, which means that pull requests can only be merged once the workflow passes all the required checks. For more information, see [AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/enforcing-dependency-review-across-an-organization).
|
||||
|
||||
{% endif %}
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
You can use the REST API to submit dependencies for a project. This enables you to add dependencies, such as those resolved when software is compiled or built, to {% data variables.product.prodname_dotcom %}'s dependency graph feature, providing a more complete picture of all of your project's dependencies.
|
||||
|
||||
The dependency graph shows any dependencies you submit using the API in addition to any dependencies that are identified from manifest or lock files in the repository (for example, a `package-lock.json` file in a JavaScript project). For more information about viewing the dependency graph, see "[AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository#viewing-the-dependency-graph)."
|
||||
The dependency graph shows any dependencies you submit using the API in addition to any dependencies that are identified from manifest or lock files in the repository (for example, a `package-lock.json` file in a JavaScript project). For more information about viewing the dependency graph, see [AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository#viewing-the-dependency-graph).
|
||||
|
||||
Submitted dependencies will receive {% data variables.product.prodname_dependabot_alerts %} and {% data variables.product.prodname_dependabot_security_updates %} for any known vulnerabilities. You will only get {% data variables.product.prodname_dependabot_alerts %} for dependencies that are from one of the supported ecosystems for the {% data variables.product.prodname_advisory_database %}. For more information about these ecosystems, see "[AUTOTITLE](/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#github-reviewed-advisories)." For transitive dependencies submitted via the {% data variables.dependency-submission-api.name %}, {% data variables.product.prodname_dependabot %} will automatically open pull requests to update the parent dependency, if an update is available.
|
||||
Submitted dependencies will receive {% data variables.product.prodname_dependabot_alerts %} and {% data variables.product.prodname_dependabot_security_updates %} for any known vulnerabilities. You will only get {% data variables.product.prodname_dependabot_alerts %} for dependencies that are from one of the supported ecosystems for the {% data variables.product.prodname_advisory_database %}. For more information about these ecosystems, see [AUTOTITLE](/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#github-reviewed-advisories). For transitive dependencies submitted via the {% data variables.dependency-submission-api.name %}, {% data variables.product.prodname_dependabot %} will automatically open pull requests to update the parent dependency, if an update is available.
|
||||
|
||||
{% ifversion dependency-review-submission-api %}Submitted dependencies will be shown in dependency review, but are _not_ available in your organization's dependency insights.
|
||||
|
||||
|
||||
@@ -1,2 +1,2 @@
|
||||
Additionally, you can use the {% data variables.dependency-submission-api.name %} to submit dependencies from the package manager or ecosystem of your choice, even if the ecosystem is not supported by dependency graph for manifest or lock file analysis.
|
||||
{% ifversion dependency-graph-repository-view-update %}Dependencies submitted to a project using the {% data variables.dependency-submission-api.name %} will show which detector was used for their submission and when they were submitted.{% elsif ghes %} The dependency graph will display the submitted dependencies grouped by ecosystem, but separately from the dependencies parsed from manifest or lock files.{% else %}{% endif %} For more information on the {% data variables.dependency-submission-api.name %}, see "[AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/using-the-dependency-submission-api)."
|
||||
{% ifversion dependency-graph-repository-view-update %}Dependencies submitted to a project using the {% data variables.dependency-submission-api.name %} will show which detector was used for their submission and when they were submitted.{% elsif ghes %} The dependency graph will display the submitted dependencies grouped by ecosystem, but separately from the dependencies parsed from manifest or lock files.{% else %}{% endif %} For more information on the {% data variables.dependency-submission-api.name %}, see [AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/using-the-dependency-submission-api).
|
||||
|
||||
@@ -1 +1 @@
|
||||
{% data variables.product.prodname_desktop %} is a free, open source application that helps you to work with code hosted on {% data variables.product.prodname_dotcom %} or other Git hosting services. With {% data variables.product.prodname_desktop %}, you can perform Git commands, such as committing and pushing changes, in a graphical user interface, rather than using the command line. For more information, see "[AUTOTITLE](/desktop/installing-and-configuring-github-desktop/overview/about-github-desktop)."
|
||||
{% data variables.product.prodname_desktop %} is a free, open source application that helps you to work with code hosted on {% data variables.product.prodname_dotcom %} or other Git hosting services. With {% data variables.product.prodname_desktop %}, you can perform Git commands, such as committing and pushing changes, in a graphical user interface, rather than using the command line. For more information, see [AUTOTITLE](/desktop/installing-and-configuring-github-desktop/overview/about-github-desktop).
|
||||
|
||||
@@ -1 +1 @@
|
||||
When you have opened a pull request branch, you can view the contents of the branch in an editor, view the diff and commit history of the contributor's updates, and view and re-run checks. For more information, see "[Working with a pull request in {% data variables.product.prodname_desktop %}](#working-with-a-pull-request-in-github-desktop)."
|
||||
When you have opened a pull request branch, you can view the contents of the branch in an editor, view the diff and commit history of the contributor's updates, and view and re-run checks. For more information, see [Working with a pull request in {% data variables.product.prodname_desktop %}](#working-with-a-pull-request-in-github-desktop).
|
||||
|
||||
@@ -1 +1 @@
|
||||
you must already have an account on {% data variables.product.github %}.{% ifversion fpt or ghec %} For more information, see "[AUTOTITLE](/get-started/start-your-journey/creating-an-account-on-github)."{% endif %}{% ifversion ghec %} If you're part of an organization that uses {% data variables.product.prodname_emus %} and you do not have an account, contact your enterprise administrator.{% elsif ghes %} If you're a member of an organization that uses {% data variables.product.product_name %} and you do not have an account, contact your {% data variables.product.prodname_enterprise %} site administrator.{% endif %}
|
||||
you must already have an account on {% data variables.product.github %}.{% ifversion fpt or ghec %} For more information, see [AUTOTITLE](/get-started/start-your-journey/creating-an-account-on-github).{% endif %}{% ifversion ghec %} If you're part of an organization that uses {% data variables.product.prodname_emus %} and you do not have an account, contact your enterprise administrator.{% elsif ghes %} If you're a member of an organization that uses {% data variables.product.product_name %} and you do not have an account, contact your {% data variables.product.prodname_enterprise %} site administrator.{% endif %}
|
||||
|
||||
@@ -1 +1 @@
|
||||
Repository administrators can enable protections on a branch. If you're working on a branch that's protected, you won't be able to delete or force push to the branch. Repository administrators can enable other protected branch settings to enforce specific workflows before a branch can be merged. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches)."
|
||||
Repository administrators can enable protections on a branch. If you're working on a branch that's protected, you won't be able to delete or force push to the branch. Repository administrators can enable other protected branch settings to enforce specific workflows before a branch can be merged. For more information, see [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches).
|
||||
|
||||
@@ -1 +1 @@
|
||||
1. Resolve any merge conflicts in your preferred way, using a text editor, the command line, or another tool. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts)."
|
||||
1. Resolve any merge conflicts in your preferred way, using a text editor, the command line, or another tool. For more information, see [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts).
|
||||
|
||||
@@ -1 +1 @@
|
||||
By default, all activity types trigger workflows that run on this event. You can limit your workflow runs to specific activity types using the `types` keyword. For more information, see "[AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#onevent_nametypes)."
|
||||
By default, all activity types trigger workflows that run on this event. You can limit your workflow runs to specific activity types using the `types` keyword. For more information, see [AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#onevent_nametypes).
|
||||
|
||||
@@ -2,17 +2,17 @@
|
||||
|
||||
Workflows don't run in forked repositories by default. You must enable GitHub Actions in the **Actions** tab of the forked repository.
|
||||
|
||||
{% data reusables.actions.forked-secrets %} The `GITHUB_TOKEN` has read-only permissions in pull requests from forked repositories. For more information, see "[AUTOTITLE](/actions/security-guides/automatic-token-authentication)."
|
||||
{% data reusables.actions.forked-secrets %} The `GITHUB_TOKEN` has read-only permissions in pull requests from forked repositories. For more information, see [AUTOTITLE](/actions/security-guides/automatic-token-authentication).
|
||||
|
||||
#### Pull request events for forked repositories
|
||||
|
||||
For pull requests from a forked repository to the base repository, {% data variables.product.product_name %} sends the `pull_request`, `issue_comment`, `pull_request_review_comment`, `pull_request_review`, and `pull_request_target` events to the base repository. No pull request events occur on the forked repository.
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
When a first-time contributor submits a pull request to a public repository, a maintainer with write access may need to approve running workflows on the pull request. For more information, see "[AUTOTITLE](/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)."
|
||||
When a first-time contributor submits a pull request to a public repository, a maintainer with write access may need to approve running workflows on the pull request. For more information, see [AUTOTITLE](/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks).
|
||||
{% endif %}
|
||||
|
||||
For pull requests from a forked repository to a private repository, workflows only run when they are enabled, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#enabling-workflows-for-forks-of-private-repositories)."
|
||||
For pull requests from a forked repository to a private repository, workflows only run when they are enabled, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#enabling-workflows-for-forks-of-private-repositories).
|
||||
|
||||
> [!NOTE]
|
||||
> Workflows triggered by {% data variables.product.prodname_dependabot %} pull requests are treated as though they are from a forked repository, and are also subject to these restrictions.
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
1. Optionally, add the category to a section. A category can only belong to one section at a time. For information on how to create a section, see "[Creating a section](#creating-a-section)."
|
||||
1. Optionally, add the category to a section. A category can only belong to one section at a time. For information on how to create a section, see [Creating a section](#creating-a-section).
|
||||
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
You can mark a comment in the discussion as an answer to the discussion if a discussion is within a category that accepts answers. For more information, see "[AUTOTITLE](/discussions/collaborating-with-your-community-using-discussions/about-discussions#about-categories-and-formats-for-discussions)."
|
||||
You can mark a comment in the discussion as an answer to the discussion if a discussion is within a category that accepts answers. For more information, see [AUTOTITLE](/discussions/collaborating-with-your-community-using-discussions/about-discussions#about-categories-and-formats-for-discussions).
|
||||
|
||||
When you mark a question as an answer, {% data variables.product.product_name %} will highlight the comment and replies to the comment to help visitors quickly find the answer.
|
||||
|
||||
|
||||
@@ -1 +1 @@
|
||||
To organize discussions more granularly, you can apply labels. For example, you can use labels to indicate the status of a discussion to make triaging more efficient. Each repository has one shared set of labels for issues, pull requests, and discussions. For more information, see "[AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/managing-labels)."
|
||||
To organize discussions more granularly, you can apply labels. For example, you can use labels to indicate the status of a discussion to make triaging more efficient. Each repository has one shared set of labels for issues, pull requests, and discussions. For more information, see [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/managing-labels).
|
||||
|
||||
@@ -1 +1 @@
|
||||
You can use {% data variables.product.prodname_discussions %} to ask and answer questions, share information, make announcements, and conduct or participate in conversations about a project. For more information, see "[AUTOTITLE](/discussions/collaborating-with-your-community-using-discussions/about-discussions)."
|
||||
You can use {% data variables.product.prodname_discussions %} to ask and answer questions, share information, make announcements, and conduct or participate in conversations about a project. For more information, see [AUTOTITLE](/discussions/collaborating-with-your-community-using-discussions/about-discussions).
|
||||
|
||||
@@ -1 +1 @@
|
||||
You can read documentation that reflects the features available with {% data variables.product.prodname_ghe_cloud %}. For more information, see "[AUTOTITLE](/get-started/learning-about-github/about-versions-of-github-docs)."
|
||||
You can read documentation that reflects the features available with {% data variables.product.prodname_ghe_cloud %}. For more information, see [AUTOTITLE](/get-started/learning-about-github/about-versions-of-github-docs).
|
||||
|
||||
@@ -1 +1 @@
|
||||
You can read documentation that reflects the features available to you on {% data variables.product.product_name %}. For more information, see "[AUTOTITLE](/get-started/learning-about-github/about-versions-of-github-docs)."
|
||||
You can read documentation that reflects the features available to you on {% data variables.product.product_name %}. For more information, see [AUTOTITLE](/get-started/learning-about-github/about-versions-of-github-docs).
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
If your {% data variables.product.prodname_ghe_cloud %} account uses metered billing, you can pay for your licenses with a credit card, PayPal, or through an Azure subscription. For purchase orders, contact your account manager in {% data variables.contact.contact_enterprise_sales %}.
|
||||
|
||||
> [!IMPORTANT] If you currently pay for your {% data variables.product.prodname_enterprise %} licenses through a volume, subscription, or prepaid agreement, you will continue to be billed in this way until your agreement expires. At renewal, you have the option to switch to the metered billing model. See, "[AUTOTITLE](/billing/using-the-enhanced-billing-platform-for-enterprises/getting-started-with-the-enhanced-billing-platform)."
|
||||
> [!IMPORTANT] If you currently pay for your {% data variables.product.prodname_enterprise %} licenses through a volume, subscription, or prepaid agreement, you will continue to be billed in this way until your agreement expires. At renewal, you have the option to switch to the metered billing model. See, [AUTOTITLE](/billing/using-the-enhanced-billing-platform-for-enterprises/getting-started-with-the-enhanced-billing-platform).
|
||||
>
|
||||
> If you do not have an account manager and pay for {% data variables.product.prodname_enterprise %} via credit card or PayPal, the transition to usage-based billing will be prompted by the product in the future, but this is not currently supported.
|
||||
|
||||
|
||||
@@ -1 +1 @@
|
||||
To view all the subscriptions for your account on {% data variables.product.prodname_dotcom %}, see "[AUTOTITLE](/billing/managing-your-github-billing-settings/viewing-your-subscriptions-and-billing-date)."
|
||||
To view all the subscriptions for your account on {% data variables.product.prodname_dotcom %}, see [AUTOTITLE](/billing/managing-your-github-billing-settings/viewing-your-subscriptions-and-billing-date).
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
As a student or faculty member at an accredited educational institution, you can apply for {% data variables.product.prodname_global_campus %}. {% data variables.product.prodname_global_campus %} is a portal that allows the GitHub Education Community to access their education benefits—all in one place! The {% data variables.product.prodname_global_campus %} portal includes access to {% data variables.product.prodname_education_community_with_url %}, industry tools used by professional developers, events, [Campus TV](https://www.twitch.tv/githubeducation) content, {% data variables.product.prodname_classroom_with_url %}, [{% data variables.product.prodname_community_exchange %}](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/about-github-community-exchange), {% data variables.product.prodname_student_pack %}, and other exclusive features to help students and teachers shape the next generation of software development.
|
||||
|
||||
Before applying for an individual discount, check if your learning community is already partnered with us as a {% data variables.product.prodname_campus_program %} school. For more information, see "[AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-github-campus-program)."
|
||||
Before applying for an individual discount, check if your learning community is already partnered with us as a {% data variables.product.prodname_campus_program %} school. For more information, see [AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/about-github-campus-program).
|
||||
|
||||
@@ -2,6 +2,6 @@ To access {% data variables.product.prodname_community_exchange %}, visit your {
|
||||
|
||||
If you're a student or faculty member at an accredited educational institution, you can apply for {% data variables.product.prodname_education %} benefits, which includes access to {% data variables.product.prodname_community_exchange %} within {% data variables.product.prodname_global_campus %}.
|
||||
|
||||
* If you’re a student and you haven't joined {% data variables.product.prodname_education %} yet, apply using the [student application form]( https://education.github.com/discount_requests/student_application). For more information, see "[AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/about-github-global-campus-for-students)."
|
||||
* If you’re a student and you haven't joined {% data variables.product.prodname_education %} yet, apply using the [student application form]( https://education.github.com/discount_requests/student_application). For more information, see [AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/about-github-global-campus-for-students).
|
||||
|
||||
* If you’re an educator and you haven't joined {% data variables.product.prodname_education %} yet, apply using the [teacher application form]( https://education.github.com/discount_requests/teacher_application). For more information, see "[AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/apply-to-github-global-campus-as-a-teacher)."
|
||||
* If you’re an educator and you haven't joined {% data variables.product.prodname_education %} yet, apply using the [teacher application form]( https://education.github.com/discount_requests/teacher_application). For more information, see [AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/apply-to-github-global-campus-as-a-teacher).
|
||||
|
||||
@@ -1 +1 @@
|
||||
* Apply for free [{% data variables.product.prodname_team %}](/get-started/learning-about-github/githubs-plans), which allows unlimited users and private repositories. For more information, see "[AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-teachers/apply-to-github-education-as-a-teacher)."
|
||||
* Apply for free [{% data variables.product.prodname_team %}](/get-started/learning-about-github/githubs-plans), which allows unlimited users and private repositories. For more information, see [AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-teachers/apply-to-github-education-as-a-teacher).
|
||||
|
||||
@@ -1 +1 @@
|
||||
Verified students get free use of {% data variables.product.prodname_github_codespaces %}, up to 180 core hours per month, for their personal accounts. The monthly amount of storage and core hours of usage available to students is equivalent to the amount included with {% data variables.product.prodname_pro %} accounts. For more information, see "[AUTOTITLE](/billing/managing-billing-for-your-products/managing-billing-for-github-codespaces/about-billing-for-github-codespaces)."
|
||||
Verified students get free use of {% data variables.product.prodname_github_codespaces %}, up to 180 core hours per month, for their personal accounts. The monthly amount of storage and core hours of usage available to students is equivalent to the amount included with {% data variables.product.prodname_pro %} accounts. For more information, see [AUTOTITLE](/billing/managing-billing-for-your-products/managing-billing-for-github-codespaces/about-billing-for-github-codespaces).
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
* You'll need to access both your enterprise on {% data variables.product.github %} and your tenant on Entra ID.
|
||||
|
||||
* To configure the {% data variables.product.prodname_emu_idp_oidc_application %} application on Entra ID, you must sign into the Entra ID tenant as a user with the Global Administrator role.
|
||||
* To sign in as the setup user for your enterprise on {% data variables.product.github %}, you must use a recovery code for the enterprise. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/managing-recovery-codes-for-your-enterprise/downloading-your-enterprise-accounts-single-sign-on-recovery-codes)."
|
||||
* To sign in as the setup user for your enterprise on {% data variables.product.github %}, you must use a recovery code for the enterprise. For more information, see [AUTOTITLE](/admin/identity-and-access-management/managing-recovery-codes-for-your-enterprise/downloading-your-enterprise-accounts-single-sign-on-recovery-codes).
|
||||
|
||||
@@ -1 +1 @@
|
||||
Members cannot use the certificate to access forks of the organization's repositories, unless the enterprise has allowed SSH CAs to access user owned repositories. For more information, see "[AUTOTITLE](/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities)."
|
||||
Members cannot use the certificate to access forks of the organization's repositories, unless the enterprise has allowed SSH CAs to access user owned repositories. For more information, see [AUTOTITLE](/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities).
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
1. When prompted to continue to your identity provider, click **Use a recovery code** and sign in using one of your enterprise's recovery codes.
|
||||
|
||||
> [!NOTE]
|
||||
> You must use a recovery code for your enterprise, not your user account. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/managing-recovery-codes-for-your-enterprise/downloading-your-enterprise-accounts-single-sign-on-recovery-codes)."
|
||||
> You must use a recovery code for your enterprise, not your user account. For more information, see [AUTOTITLE](/admin/identity-and-access-management/managing-recovery-codes-for-your-enterprise/downloading-your-enterprise-accounts-single-sign-on-recovery-codes).
|
||||
|
||||
@@ -1 +1 @@
|
||||
If you don't see a "Permissions requested" prompt, and instead see a message indicating that you need admin approval, see "[Message: "Need admin approval"](#message-need-admin-approval)."
|
||||
If you don't see a "Permissions requested" prompt, and instead see a message indicating that you need admin approval, see [Message: "Need admin approval"](#message-need-admin-approval).
|
||||
|
||||
@@ -1 +1 @@
|
||||
1. To ensure you can still access your enterprise on {% data variables.product.github %} if your IdP is unavailable in the future, click **Download**, **Print**, or **Copy** to save your recovery codes. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/managing-recovery-codes-for-your-enterprise/downloading-your-enterprise-accounts-single-sign-on-recovery-codes)."
|
||||
1. To ensure you can still access your enterprise on {% data variables.product.github %} if your IdP is unavailable in the future, click **Download**, **Print**, or **Copy** to save your recovery codes. For more information, see [AUTOTITLE](/admin/identity-and-access-management/managing-recovery-codes-for-your-enterprise/downloading-your-enterprise-accounts-single-sign-on-recovery-codes).
|
||||
|
||||
@@ -8,5 +8,5 @@ Next, configure how your members will authenticate.
|
||||
|
||||
To get started, read the guide for your chosen authentication method.
|
||||
|
||||
* "[AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-oidc-for-enterprise-managed-users)"
|
||||
* "[AUTOTITLE](/admin/identity-and-access-management/managing-iam-with-enterprise-managed-users/configuring-saml-single-sign-on-for-enterprise-managed-users)"
|
||||
* [AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-oidc-for-enterprise-managed-users)
|
||||
* [AUTOTITLE](/admin/identity-and-access-management/managing-iam-with-enterprise-managed-users/configuring-saml-single-sign-on-for-enterprise-managed-users)
|
||||
|
||||
@@ -1 +1 @@
|
||||
After you configure authentication, you can configure SCIM provisioning, which is how your IdP will create {% data variables.enterprise.prodname_managed_users %} on {% data variables.product.github %}. See "[AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-scim-provisioning-for-enterprise-managed-users)."
|
||||
After you configure authentication, you can configure SCIM provisioning, which is how your IdP will create {% data variables.enterprise.prodname_managed_users %} on {% data variables.product.github %}. See [AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-scim-provisioning-for-enterprise-managed-users).
|
||||
|
||||
@@ -4,4 +4,4 @@ Next, create a {% data variables.product.pat_generic %} that you can use to conf
|
||||
* The token must have at least the **scim:enterprise** scope.
|
||||
* The token must have **no expiration**.
|
||||
|
||||
To learn how to create a {% data variables.product.pat_v1 %}, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)."
|
||||
To learn how to create a {% data variables.product.pat_v1 %}, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens).
|
||||
|
||||
@@ -1 +1 @@
|
||||
After authentication and provisioning are configured, you can start managing organization membership for your {% data variables.enterprise.prodname_managed_users %} by synchronizing IdP groups with teams. See "[AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/managing-team-memberships-with-identity-provider-groups)."
|
||||
After authentication and provisioning are configured, you can start managing organization membership for your {% data variables.enterprise.prodname_managed_users %} by synchronizing IdP groups with teams. See [AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/managing-team-memberships-with-identity-provider-groups).
|
||||
|
||||
@@ -1 +1 @@
|
||||
For more information, see "[AUTOTITLE](/get-started/learning-about-github/types-of-github-accounts#enterprise-managed-users)."
|
||||
For more information, see [AUTOTITLE](/get-started/learning-about-github/types-of-github-accounts#enterprise-managed-users).
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{% ifversion ghec %}
|
||||
|
||||
> [!NOTE]
|
||||
> If your enterprise uses {% data variables.product.prodname_emus %}, you must follow a different process to configure SAML single sign-on. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-saml-single-sign-on-for-enterprise-managed-users)."
|
||||
> If your enterprise uses {% data variables.product.prodname_emus %}, you must follow a different process to configure SAML single sign-on. For more information, see [AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-saml-single-sign-on-for-enterprise-managed-users).
|
||||
|
||||
{% endif %}
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{% ifversion ghec %}
|
||||
|
||||
> [!NOTE]
|
||||
> If your enterprise uses {% data variables.product.prodname_emus %}, you do not need to use team synchronization. Instead, you can manage team membership via the SCIM configuration you created while setting up your enterprise. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/managing-team-memberships-with-identity-provider-groups)."
|
||||
> If your enterprise uses {% data variables.product.prodname_emus %}, you do not need to use team synchronization. Instead, you can manage team membership via the SCIM configuration you created while setting up your enterprise. For more information, see [AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/managing-team-memberships-with-identity-provider-groups).
|
||||
|
||||
{% endif %}
|
||||
|
||||
@@ -1 +1 @@
|
||||
If you choose to use {% data variables.product.prodname_emus %}, you have increased control over your enterprise's members and resources. With {% data variables.product.prodname_emus %}, all members are provisioned and managed through your identity provider (IdP) instead of users creating their own accounts on {% data variables.product.product_name %}. Organization and team membership can be managed using groups on your IdP. {% data variables.enterprise.prodname_managed_users_caps %} are restricted to their enterprise and are unable to push code, collaborate, or interact with users, repositories, and organizations outside of their enterprise. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users){% ifversion not ghec %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %}
|
||||
If you choose to use {% data variables.product.prodname_emus %}, you have increased control over your enterprise's members and resources. With {% data variables.product.prodname_emus %}, all members are provisioned and managed through your identity provider (IdP) instead of users creating their own accounts on {% data variables.product.product_name %}. Organization and team membership can be managed using groups on your IdP. {% data variables.enterprise.prodname_managed_users_caps %} are restricted to their enterprise and are unable to push code, collaborate, or interact with users, repositories, and organizations outside of their enterprise. For more information, see [AUTOTITLE](/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users){% ifversion not ghec %} in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}.{% endif %}
|
||||
|
||||
@@ -1 +1 @@
|
||||
Enterprise account owners can invite existing organization accounts to join their enterprise. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/user-management/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise#inviting-an-organization-to-join-your-enterprise-account)."
|
||||
Enterprise account owners can invite existing organization accounts to join their enterprise. For more information, see [AUTOTITLE](/enterprise-cloud@latest/admin/user-management/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise#inviting-an-organization-to-join-your-enterprise-account).
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
1. Under **{% octicon "gear" aria-hidden="true" %} Settings**, click **{% ifversion ghec %}Licensing{% elsif ghes %}License{% endif %}**. {% ifversion enhanced-billing-platform %}
|
||||
|
||||
>[!NOTE] If you are on the enhanced billing platform, the licensing page has been relocated. See "[AUTOTITLE](/billing/using-the-enhanced-billing-platform-for-enterprises/gathering-insights-on-your-spending#viewing-license-usage)."{% endif %}
|
||||
>[!NOTE] If you are on the enhanced billing platform, the licensing page has been relocated. See [AUTOTITLE](/billing/using-the-enhanced-billing-platform-for-enterprises/gathering-insights-on-your-spending#viewing-license-usage).{% endif %}
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{% ifversion ghec %}
|
||||
|
||||
To open, view, and comment on support tickets associated with an enterprise account, you must have support entitlements for the enterprise. Enterprise owners and billing managers automatically have a support entitlement, and enterprise owners can add support entitlements to enterprise members. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/managing-support-entitlements-for-your-enterprise)."
|
||||
To open, view, and comment on support tickets associated with an enterprise account, you must have support entitlements for the enterprise. Enterprise owners and billing managers automatically have a support entitlement, and enterprise owners can add support entitlements to enterprise members. For more information, see [AUTOTITLE](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/managing-support-entitlements-for-your-enterprise).
|
||||
|
||||
> [!NOTE]
|
||||
> Any organization member can create tickets associated with an individual organization that is owned by an enterprise account. Support entitlements are only required to create tickets associated with the enterprise account itself.
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
{% ifversion ghec %}
|
||||
If your organization is owned by an enterprise account, enabling team synchronization for the enterprise account will override your organization-level team synchronization settings. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/using-saml-for-enterprise-iam/managing-team-synchronization-for-organizations-in-your-enterprise)."
|
||||
If your organization is owned by an enterprise account, enabling team synchronization for the enterprise account will override your organization-level team synchronization settings. For more information, see [AUTOTITLE](/admin/identity-and-access-management/using-saml-for-enterprise-iam/managing-team-synchronization-for-organizations-in-your-enterprise).
|
||||
{% endif %}
|
||||
|
||||
@@ -1 +1 @@
|
||||
To select an Azure subscription, you must have owner permissions to the subscription. If the default tenant does not have the right permissions, you may need to specify a different tenant ID. For more information, see "[Prerequisites](/billing/managing-the-plan-for-your-github-account/connecting-an-azure-subscription#prerequisites)" and [Microsoft identity platform and OAuth 2.0 authorization code flow](https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-auth-code-flow#request-an-authorization-code) in Microsoft Docs.
|
||||
To select an Azure subscription, you must have owner permissions to the subscription. If the default tenant does not have the right permissions, you may need to specify a different tenant ID. For more information, see [Prerequisites](/billing/managing-the-plan-for-your-github-account/connecting-an-azure-subscription#prerequisites) and [Microsoft identity platform and OAuth 2.0 authorization code flow](https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-auth-code-flow#request-an-authorization-code) in Microsoft Docs.
|
||||
|
||||
@@ -1 +1 @@
|
||||
For a person using multiple {% data variables.product.prodname_enterprise %} environments to only consume a single license, you must synchronize license usage between environments. Then, {% data variables.product.company_short %} will deduplicate users based on the email addresses associated with their user accounts. {% data variables.product.company_short %} deduplicates licenses for the {% data variables.product.prodname_enterprise %} plan itself, {% ifversion ghas-in-license-sync %}and{% ifversion ghec %} if you use {% data variables.product.prodname_ghe_server %} version 3.12 or later,{% endif %} for {% data variables.product.prodname_GH_advanced_security %}{% else %}but not for other {% data variables.product.company_short %} products{% endif %}. For more information, see "[AUTOTITLE](/billing/managing-your-license-for-github-enterprise/troubleshooting-license-usage-for-github-enterprise#about-the-calculation-of-consumed-licenses)."
|
||||
For a person using multiple {% data variables.product.prodname_enterprise %} environments to only consume a single license, you must synchronize license usage between environments. Then, {% data variables.product.company_short %} will deduplicate users based on the email addresses associated with their user accounts. {% data variables.product.company_short %} deduplicates licenses for the {% data variables.product.prodname_enterprise %} plan itself, {% ifversion ghas-in-license-sync %}and{% ifversion ghec %} if you use {% data variables.product.prodname_ghe_server %} version 3.12 or later,{% endif %} for {% data variables.product.prodname_GH_advanced_security %}{% else %}but not for other {% data variables.product.company_short %} products{% endif %}. For more information, see [AUTOTITLE](/billing/managing-your-license-for-github-enterprise/troubleshooting-license-usage-for-github-enterprise#about-the-calculation-of-consumed-licenses).
|
||||
|
||||
@@ -1 +1 @@
|
||||
> [!NOTE] To make troubleshooting easier, if you synchronize license usage and do not use {% data variables.product.prodname_emus %}, we highly recommend enabling verified domains for your enterprise account on {% data variables.product.prodname_ghe_cloud %}. See "[AUTOTITLE](/enterprise-cloud@latest/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise){% ifversion not ghec %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %}
|
||||
> [!NOTE] To make troubleshooting easier, if you synchronize license usage and do not use {% data variables.product.prodname_emus %}, we highly recommend enabling verified domains for your enterprise account on {% data variables.product.prodname_ghe_cloud %}. See [AUTOTITLE](/enterprise-cloud@latest/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise){% ifversion not ghec %} in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}.{% endif %}
|
||||
|
||||
@@ -1 +1 @@
|
||||
After you synchronize license usage, you can see a report of consumed licenses across all your environments in the enterprise settings on {% data variables.product.prodname_ghe_cloud %}. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/billing/managing-your-license-for-github-enterprise/viewing-license-usage-for-github-enterprise)."
|
||||
After you synchronize license usage, you can see a report of consumed licenses across all your environments in the enterprise settings on {% data variables.product.prodname_ghe_cloud %}. For more information, see [AUTOTITLE](/enterprise-cloud@latest/billing/managing-your-license-for-github-enterprise/viewing-license-usage-for-github-enterprise).
|
||||
|
||||
@@ -1 +1 @@
|
||||
When assigning users, you can use the "Roles" attribute in the application on your IdP to set a user's role in your enterprise on {% data variables.product.product_name %}. For more information about the roles available to assign, see "[AUTOTITLE](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise)."
|
||||
When assigning users, you can use the "Roles" attribute in the application on your IdP to set a user's role in your enterprise on {% data variables.product.product_name %}. For more information about the roles available to assign, see [AUTOTITLE](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise).
|
||||
|
||||
@@ -1 +1 @@
|
||||
When you began using {% data variables.product.product_name %}, you must have chosen to create an {% data variables.enterprise.prodname_emu_enterprise %}. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/understanding-iam-for-enterprises/identifying-the-best-authentication-method-for-your-enterprise)."
|
||||
When you began using {% data variables.product.product_name %}, you must have chosen to create an {% data variables.enterprise.prodname_emu_enterprise %}. For more information, see [AUTOTITLE](/admin/identity-and-access-management/understanding-iam-for-enterprises/identifying-the-best-authentication-method-for-your-enterprise).
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
{% ifversion repository-collaborators %}
|
||||
>[!NOTE] If your enterprise uses {% data variables.enterprise.prodname_managed_users %}, the outside collaborator role is called "repository collaborator." Generally, the documentation for outside collaborators also applies to repository collaborators. For the distinctions that apply, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#outside-collaborators-or-repository-collaborators)."
|
||||
>[!NOTE] If your enterprise uses {% data variables.enterprise.prodname_managed_users %}, the outside collaborator role is called "repository collaborator." Generally, the documentation for outside collaborators also applies to repository collaborators. For the distinctions that apply, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#outside-collaborators-or-repository-collaborators).
|
||||
{% endif %}
|
||||
|
||||
@@ -3,10 +3,10 @@ To remove the need for organization owners to complete migrations, {% data varia
|
||||
Granting the migrator role allows you to designate other teams or individuals to handle your migrations.
|
||||
|
||||
* You can only grant the migrator role for an organization on {% data variables.product.prodname_dotcom_the_website %} or {% data variables.enterprise.data_residency_site %}.
|
||||
* You can grant the migrator role to an individual user or a team. We strongly recommend that you assign the migrator role to a team. Then, you can further customize who can run a migration by adjusting team membership. See "[AUTOTITLE](/organizations/organizing-members-into-teams/adding-organization-members-to-a-team)" or "[AUTOTITLE](/organizations/organizing-members-into-teams/removing-organization-members-from-a-team)."
|
||||
* You can grant the migrator role to an individual user or a team. We strongly recommend that you assign the migrator role to a team. Then, you can further customize who can run a migration by adjusting team membership. See [AUTOTITLE](/organizations/organizing-members-into-teams/adding-organization-members-to-a-team) or [AUTOTITLE](/organizations/organizing-members-into-teams/removing-organization-members-from-a-team).
|
||||
* The migrator must use a {% data variables.product.pat_generic %} that meets all the requirements for running migrations.
|
||||
|
||||
> [!WARNING]
|
||||
> When you grant the migrator role in an organization to a user or team, you are granting them the ability to import or export any repository in that organization.
|
||||
|
||||
To grant the migrator role, see "[Granting the migrator role](#granting-the-migrator-role)."
|
||||
To grant the migrator role, see [Granting the migrator role](#granting-the-migrator-role).
|
||||
|
||||
@@ -9,7 +9,7 @@ After you set up an AWS S3 storage bucket or Azure Blob Storage storage account,
|
||||
1. Optionally, to import storage settings you configured for {% data variables.product.prodname_actions %}, select **Copy Storage settings from Actions**. For more information see, "[Enabling GitHub Actions with Azure Blob storage]({% ifversion not ghes %}/enterprise-server@latest{% endif %}/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-azure-blob-storage)" and "[Enabling GitHub Actions with Amazon S3 storage]({% ifversion not ghes %}/enterprise-server@latest{% endif %}/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-amazon-s3-storage)."
|
||||
|
||||
> [!NOTE]
|
||||
> After copying your storage settings, you may still need to update the configuration of your cloud storage account to work with {% data variables.product.prodname_importer_proper_name %}. In particular, you must ensure that {% data variables.product.prodname_dotcom %}'s IP addresses are allowlisted. For more information, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-between-github-products/managing-access-for-a-migration-between-github-products#configuring-ip-allow-lists-for-migrations)."
|
||||
> After copying your storage settings, you may still need to update the configuration of your cloud storage account to work with {% data variables.product.prodname_importer_proper_name %}. In particular, you must ensure that {% data variables.product.prodname_dotcom %}'s IP addresses are allowlisted. For more information, see [AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-between-github-products/managing-access-for-a-migration-between-github-products#configuring-ip-allow-lists-for-migrations).
|
||||
|
||||
1. If you do not import storage settings from {% data variables.product.prodname_actions %}, select either **Azure Blob Storage** or **Amazon S3** and fill in the required details.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
Branch protections apply a specified set of rules to a specific branch name or branch name pattern. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches)."
|
||||
Branch protections apply a specified set of rules to a specific branch name or branch name pattern. For more information, see [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches).
|
||||
|
||||
Branch protections will always be migrated, but certain rules will not be migrated. The following branch protection rules are not migrated.
|
||||
|
||||
|
||||
@@ -11,4 +11,4 @@ The way you check the status of your migration depends on how you ran the migrat
|
||||
* If you ran the migration using the {% data variables.product.prodname_cli %} with the optional `--queue-only` argument, the process will exit immediately after queueing the migration, and will not tell you if the migration succeeded or failed. You can check a migration's status using the `wait-for-migration` command, or by reviewing the migration log.
|
||||
* If you ran the migration using the GraphQL API, you can query the `state` and `failureReason` fields on the `RepositoryMigration` object.
|
||||
|
||||
If the migration failed, the migration log may contain additional information about the cause of the failure. For more information, see "[Reviewing the migration log](#reviewing-the-migration-log)."
|
||||
If the migration failed, the migration log may contain additional information about the cause of the failure. For more information, see [Reviewing the migration log](#reviewing-the-migration-log).
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
If the source or destination of your migration uses an IP allow list (either {% data variables.product.company_short %}'s IP allow list feature or your identity provider's (IdP) IP allow list restrictions, such as Azure CAP), you need to configure IP allow lists on {% data variables.product.prodname_dotcom %}. See "[AUTOTITLE](/enterprise-cloud@latest/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization)" and "[AUTOTITLE](/enterprise-cloud@latest/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise-with-an-ip-allow-list)."
|
||||
If the source or destination of your migration uses an IP allow list (either {% data variables.product.company_short %}'s IP allow list feature or your identity provider's (IdP) IP allow list restrictions, such as Azure CAP), you need to configure IP allow lists on {% data variables.product.prodname_dotcom %}. See [AUTOTITLE](/enterprise-cloud@latest/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization) and [AUTOTITLE](/enterprise-cloud@latest/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise-with-an-ip-allow-list).
|
||||
|
||||
* If you use {% data variables.product.company_short %}'s IP allow list feature, you must add the {% data variables.product.prodname_dotcom %} IP ranges below to the allow list for the source and/or destination organizations.
|
||||
* If you use your IdP's IP allow list to restrict access to your enterprise on {% data variables.product.prodname_dotcom %}, you should disable these restrictions in your enterprise account settings until after your migration is complete.
|
||||
|
||||
@@ -1,2 +1,2 @@
|
||||
1. Create and record a {% data variables.product.pat_v1 %} that will authenticate for the destination organization on {% data variables.product.prodname_ghe_cloud %}, making sure that the token meets all requirements. For more information, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-between-github-products/managing-access-for-a-migration-between-github-products#creating-a-personal-access-token-for-github-enterprise-importer)."
|
||||
1. Create and record a {% data variables.product.pat_v1 %} that will authenticate for the destination organization on {% data variables.product.prodname_ghe_cloud %}, making sure that the token meets all requirements. For more information, see [AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-between-github-products/managing-access-for-a-migration-between-github-products#creating-a-personal-access-token-for-github-enterprise-importer).
|
||||
1. Create and record a {% data variables.product.pat_generic %} that will authenticate for the source organization, making sure that this token also meets all of the same requirements.
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
1. Verify that you have a sufficient role for the task you want to complete. For more information, see "[Required roles](#required-roles)."
|
||||
1. Create a {% data variables.product.pat_v1 %}, making sure to grant all the scopes required for the task you want to complete. {% data reusables.user-settings.generic-classic-pat-only %} For more information, "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)" and "[Required scopes for {% data variables.product.pat_generic %}](#required-scopes-for-personal-access-tokens)."
|
||||
1. If SAML single sign-on is enforced for the organization(s) you need to access, authorize the {% data variables.product.pat_generic %} for SSO. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)."
|
||||
1. Verify that you have a sufficient role for the task you want to complete. For more information, see [Required roles](#required-roles).
|
||||
1. Create a {% data variables.product.pat_v1 %}, making sure to grant all the scopes required for the task you want to complete. {% data reusables.user-settings.generic-classic-pat-only %} For more information, [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) and [Required scopes for {% data variables.product.pat_generic %}](#required-scopes-for-personal-access-tokens).
|
||||
1. If SAML single sign-on is enforced for the organization(s) you need to access, authorize the {% data variables.product.pat_generic %} for SSO. For more information, see [AUTOTITLE](/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on).
|
||||
|
||||
@@ -5,14 +5,14 @@
|
||||
* {% data variables.product.prodname_dependabot %} secrets
|
||||
* Discussions at the repository level
|
||||
* Edit history of issue comments and pull request comments
|
||||
* Fork relationships between repositories (see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)")
|
||||
* Fork relationships between repositories (see [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks))
|
||||
* {% data variables.product.prodname_actions %} secrets, variables, environments, self-hosted runners, {% data variables.actions.hosted_runner %}s, or workflow run history
|
||||
* GitHub Apps and GitHub App installations
|
||||
* {% data variables.large_files.product_name_short %} objects and large binaries (repositories using {% data variables.large_files.product_name_short %} are still supported, see "[Limitations of {% data variables.product.prodname_importer_proper_name %}](#limitations-of-github-enterprise-importer)")
|
||||
* {% data variables.large_files.product_name_short %} objects and large binaries (repositories using {% data variables.large_files.product_name_short %} are still supported, see [Limitations of {% data variables.product.prodname_importer_proper_name %}](#limitations-of-github-enterprise-importer))
|
||||
* Packages in {% data variables.product.prodname_registry %}
|
||||
* Projects (classic) at the organization level
|
||||
* {% data variables.product.prodname_projects_v2 %} (the new projects experience)
|
||||
* References between pull requests and issues in different repositories (see "[AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls)")
|
||||
* References between pull requests and issues in different repositories (see [AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls))
|
||||
* Remediation states of {% data variables.product.prodname_secret_scanning %} results
|
||||
* Repositories owned by user accounts{% ifversion repository-properties %}
|
||||
* Repository properties{% endif %}
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
> [!NOTE] If the repository you are migrating has rulesets that the incoming repository doesn't match, the migration will be blocked. To bypass these rulesets and allow the migration, you can apply a ruleset bypass for all deploy keys in the target organization.
|
||||
>
|
||||
> Repository rulesets can be set at the organization level. If the incoming repository does not match any of these rulesets, you will need to use the deploy key bypass for each one. See "[AUTOTITLE](/organizations/managing-organization-settings/creating-rulesets-for-repositories-in-your-organization#granting-bypass-permissions-for-your-branch-or-tag-ruleset)."
|
||||
> Repository rulesets can be set at the organization level. If the incoming repository does not match any of these rulesets, you will need to use the deploy key bypass for each one. See [AUTOTITLE](/organizations/managing-organization-settings/creating-rulesets-for-repositories-in-your-organization#granting-bypass-permissions-for-your-branch-or-tag-ruleset).
|
||||
|
||||
@@ -1 +1 @@
|
||||
If you want the script to download the migration log for each migrated repository, add the `--download-migration-logs` flag. For more information about migration logs, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/accessing-your-migration-logs-for-github-enterprise-importer#downloading-all-migration-logs-for-an-organization)."
|
||||
If you want the script to download the migration log for each migrated repository, add the `--download-migration-logs` flag. For more information about migration logs, see [AUTOTITLE](/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/accessing-your-migration-logs-for-github-enterprise-importer#downloading-all-migration-logs-for-an-organization).
|
||||
|
||||
@@ -1,2 +1,2 @@
|
||||
* You must allow access to the egress IP ranges for {% data variables.enterprise.data_residency_site %}. See "[AUTOTITLE](/enterprise-cloud@latest/admin/data-residency/network-details-for-ghecom#ranges-for-egress-traffic)."
|
||||
* You must allow access to the egress IP ranges for {% data variables.enterprise.data_residency_site %}. See [AUTOTITLE](/enterprise-cloud@latest/admin/data-residency/network-details-for-ghecom#ranges-for-egress-traffic).
|
||||
* If you're using Azure Blob Storage, you may need to perform some additional configuration. Please contact {% data variables.contact.contact_support_page %}.
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
The scopes that are required for your {% data variables.product.prodname_dotcom %} {% data variables.product.pat_v1 %} depend on your role and the task you want to complete.
|
||||
|
||||
> [!NOTE]
|
||||
> {% data reusables.user-settings.generic-classic-pat-only %} This means that you cannot use {% data variables.product.prodname_importer_proper_name %} if your organization uses the "Restrict {% data variables.product.pat_v1_plural %} from accessing your organizations" policy. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-personal-access-tokens-in-your-enterprise#restricting-access-by-personal-access-tokens)."
|
||||
> {% data reusables.user-settings.generic-classic-pat-only %} This means that you cannot use {% data variables.product.prodname_importer_proper_name %} if your organization uses the "Restrict {% data variables.product.pat_v1_plural %} from accessing your organizations" policy. For more information, see [AUTOTITLE](/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-personal-access-tokens-in-your-enterprise#restricting-access-by-personal-access-tokens).
|
||||
|
||||
Task | Organization owner | Migrator
|
||||
---- | -------- | ----- |
|
||||
|
||||
@@ -1 +1 @@
|
||||
We strongly recommend that you perform a trial run of your migration and complete your production migration soon after. To learn more about trial runs, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-between-github-products/overview-of-a-migration-between-github-products#running-your-migrations)."
|
||||
We strongly recommend that you perform a trial run of your migration and complete your production migration soon after. To learn more about trial runs, see [AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-between-github-products/overview-of-a-migration-between-github-products#running-your-migrations).
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
You can use the `grantMigratorRole` GraphQL mutation to assign the migrator role and the `revokeMigratorRole` mutation to revoke the migrator role.
|
||||
|
||||
You must use a {% data variables.product.pat_generic %} (PAT) that meets all access requirements. For more information, see the "[Required scopes for {% data variables.product.pat_generic %}s](#required-scopes-for-personal-access-tokens)."
|
||||
You must use a {% data variables.product.pat_generic %} (PAT) that meets all access requirements. For more information, see the [Required scopes for {% data variables.product.pat_generic %}s](#required-scopes-for-personal-access-tokens).
|
||||
|
||||
#### `grantMigratorRole` mutation
|
||||
|
||||
|
||||
@@ -13,4 +13,4 @@ You can get an up-to-date list of IP ranges used by {% data variables.product.pr
|
||||
|
||||
The `github_enterprise_importer` key in the response contains a list of IP ranges used for migrations.
|
||||
|
||||
For more information, see "[AUTOTITLE](/rest/meta#get-github-meta-information)."
|
||||
For more information, see [AUTOTITLE](/rest/meta#get-github-meta-information).
|
||||
|
||||
@@ -1 +1 @@
|
||||
If this is your first migration, you'll need to install the {% data variables.product.prodname_gei_cli %}. For more information about the {% data variables.product.prodname_cli %}, see "[AUTOTITLE](/github-cli/github-cli/about-github-cli)."
|
||||
If this is your first migration, you'll need to install the {% data variables.product.prodname_gei_cli %}. For more information about the {% data variables.product.prodname_cli %}, see [AUTOTITLE](/github-cli/github-cli/about-github-cli).
|
||||
|
||||
@@ -4,14 +4,14 @@ There are limits to what {% data variables.product.prodname_importer_proper_name
|
||||
|
||||
* **2 GB size limit for a single Git commit:** No single commit in your Git repository can be larger than 2 GB. If any of your commits are larger than 2 GB, you will need to split the commit into smaller commits that are each 2 GB or smaller.
|
||||
* **255 byte limit for Git references:** No single [Git reference](https://git-scm.com/book/en/v2/Git-Internals-Git-References), commonly known as a "ref", can have a name larger than 255 bytes. Usually, this means that your references cannot be more than 255 characters long, but any non-[ASCII](https://en.wikipedia.org/wiki/ASCII) characters, such as emojis, may consume more than one byte. If any of your Git references are too large, we'll return a clear error message.
|
||||
* **100 MB file size limit:** No single file in your Git repository can be larger than 100 MB. Consider using {% data variables.large_files.product_name_short %} for storing large files. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-large-files)."
|
||||
* **100 MB file size limit:** No single file in your Git repository can be larger than 100 MB. Consider using {% data variables.large_files.product_name_short %} for storing large files. For more information, see [AUTOTITLE](/repositories/working-with-files/managing-large-files).
|
||||
|
||||
### Limitations of {% data variables.product.prodname_importer_proper_name %}
|
||||
|
||||
* **10 GB size limit for a Git repository:** This limit only applies to the source code. To check if the repository archive is over the limit, use the [git-sizer](https://github.com/github/git-sizer) tool and review the total blob size in the output. The git-sizer tool also helps to identify potential issues related to large files, blob size, commit size, and tree counts that could impact migrations.
|
||||
* **10 GB limit for metadata:** The {% data variables.product.prodname_importer_secondary_name %} cannot migrate repositories with more than 10 GB of metadata. Metadata includes issues, pull requests, releases, and attachments. In most cases, large metadata is caused by binary assets attached to releases. You can exclude releases from the migration with the `migrate-repo` command's `--skip-releases` flag, and then move your releases manually after the migration.
|
||||
* **{% data variables.large_files.product_name_short %} objects not migrated:** The {% data variables.product.prodname_importer_secondary_name %} can migrate repositories that use {% data variables.large_files.product_name_short %}, but the LFS objects themselves will not be migrated. They can be pushed to your migration destination as a follow-up task after the migration is complete. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/duplicating-a-repository#mirroring-a-repository-that-contains-git-large-file-storage-objects)."
|
||||
* **Follow-up tasks required:** When migrating between {% data variables.product.prodname_dotcom %} products, certain settings are not migrated and must be reconfigured in the new repository. For a list of follow-up tasks you'll need to complete after each migration, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-between-github-products/overview-of-a-migration-between-github-products#completing-follow-up-tasks)."
|
||||
* **{% data variables.large_files.product_name_short %} objects not migrated:** The {% data variables.product.prodname_importer_secondary_name %} can migrate repositories that use {% data variables.large_files.product_name_short %}, but the LFS objects themselves will not be migrated. They can be pushed to your migration destination as a follow-up task after the migration is complete. For more information, see [AUTOTITLE](/repositories/creating-and-managing-repositories/duplicating-a-repository#mirroring-a-repository-that-contains-git-large-file-storage-objects).
|
||||
* **Follow-up tasks required:** When migrating between {% data variables.product.prodname_dotcom %} products, certain settings are not migrated and must be reconfigured in the new repository. For a list of follow-up tasks you'll need to complete after each migration, see [AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-between-github-products/overview-of-a-migration-between-github-products#completing-follow-up-tasks).
|
||||
* **Delayed code search functionality:** Re-indexing the search index can take a few hours after a repository is migrated, and code searches may return unexpected results until re-indexing is complete.
|
||||
* **Rulesets configured for your organization can cause migrations to fail:** For example, if you configured a rule that requires email addresses for commit authors to end with `@monalisa.cat`, and the repository you're migrating contains commits that don't comply with this rule, your migration will fail. For more information about rulesets, see "[AUTOTITLE](/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets)."
|
||||
* **Mannequin content might not be searchable:** Mannequins are placeholder users to which imported content (such as issues, pull requests, comments, etc.) is associated. When you search for content associated with a mannequin, such as assigned issues, the issues may not be found. Once a mannequin is reclaimed, the content should be found via the new owner. For more information, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/reclaiming-mannequins-for-github-enterprise-importer)."
|
||||
* **Rulesets configured for your organization can cause migrations to fail:** For example, if you configured a rule that requires email addresses for commit authors to end with `@monalisa.cat`, and the repository you're migrating contains commits that don't comply with this rule, your migration will fail. For more information about rulesets, see [AUTOTITLE](/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets).
|
||||
* **Mannequin content might not be searchable:** Mannequins are placeholder users to which imported content (such as issues, pull requests, comments, etc.) is associated. When you search for content associated with a mannequin, such as assigned issues, the issues may not be found. Once a mannequin is reclaimed, the content should be found via the new owner. For more information, see [AUTOTITLE](/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/reclaiming-mannequins-for-github-enterprise-importer).
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
To make GraphQL queries, you'll need to write your own scripts or use an HTTP client like [Insomnia](https://insomnia.rest/).
|
||||
|
||||
To learn more about getting started with the {% data variables.product.prodname_dotcom %} GraphQL API, including how to authenticate, see "[AUTOTITLE](/graphql/guides/forming-calls-with-graphql)."
|
||||
To learn more about getting started with the {% data variables.product.prodname_dotcom %} GraphQL API, including how to authenticate, see [AUTOTITLE](/graphql/guides/forming-calls-with-graphql).
|
||||
|
||||
You will send all GraphQL queries to the **destination** of your migration. If you're migrating to {% data variables.enterprise.data_residency %}, make sure to send queries to the endpoint for your enterprise's subdomain of {% data variables.enterprise.data_residency_site %}.
|
||||
|
||||
@@ -1 +1 @@
|
||||
PATH-TO-KEY | If your Bitbucket Server instance runs on Linux, the path to your SSH private key, such as `~/.ssh/id_rsa`. For SSH key requirements, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-from-bitbucket-server-to-github-enterprise-cloud/managing-access-for-a-migration-from-bitbucket-server#required-permissions-for-bitbucket-server)".
|
||||
PATH-TO-KEY | If your Bitbucket Server instance runs on Linux, the path to your SSH private key, such as `~/.ssh/id_rsa`. For SSH key requirements, see [AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-from-bitbucket-server-to-github-enterprise-cloud/managing-access-for-a-migration-from-bitbucket-server#required-permissions-for-bitbucket-server).
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{% data reusables.enterprise-migration-tool.about-mannequins %}
|
||||
|
||||
{% data reusables.enterprise-migration-tool.how-to-reclaim %} For more information, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/reclaiming-mannequins-for-github-enterprise-importer)."
|
||||
{% data reusables.enterprise-migration-tool.how-to-reclaim %} For more information, see [AUTOTITLE](/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/reclaiming-mannequins-for-github-enterprise-importer).
|
||||
|
||||
> [!NOTE]
|
||||
> Only organization owners can reclaim mannequins. If you've been granted the migrator role, contact an organization owner to perform this step.
|
||||
@@ -8,4 +8,4 @@
|
||||
1. Decide if you want to reclaim mannequins.
|
||||
1. Plan when you'll complete reclaims.
|
||||
1. Reclaim mannequins.
|
||||
1. If any of the members do not already have appropriate access to the repository via team membership, give the members access to the repository. For more information, see "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-an-individuals-access-to-an-organization-repository)."
|
||||
1. If any of the members do not already have appropriate access to the repository via team membership, give the members access to the repository. For more information, see [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-an-individuals-access-to-an-organization-repository).
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
Review the migration log for each migrated repository. For more information, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/accessing-your-migration-logs-for-github-enterprise-importer)."
|
||||
Review the migration log for each migrated repository. For more information, see [AUTOTITLE](/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/accessing-your-migration-logs-for-github-enterprise-importer).
|
||||
|
||||
If the migration failed, the log may contain additional information about the cause of the failure.
|
||||
|
||||
If the migration succeeded, there may be warnings in the migration log representing specific pieces of data (for example pull requests, issues, or comments) which were not migrated or were migrated with caveats.
|
||||
|
||||
For more information on understanding migration warnings, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/troubleshooting-your-migration-with-github-enterprise-importer#understanding-migration-log-warnings)." After reviewing any migration warnings, you will need to make a decision about whether you can accept those warnings and move forward.
|
||||
For more information on understanding migration warnings, see [AUTOTITLE](/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/troubleshooting-your-migration-with-github-enterprise-importer#understanding-migration-log-warnings). After reviewing any migration warnings, you will need to make a decision about whether you can accept those warnings and move forward.
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
All repositories are migrated as private by default, and only the user that ran the migration and organization owners will have access to the repository. If you don't want the repository to be private, change the visibility.
|
||||
|
||||
* You can set a repository's visibility with the `--target-repo-visibility` CLI option or the `targetRepoVisibility` GraphQL property.
|
||||
* You can change a repository's visibility in the browser. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility)."
|
||||
* You can change a repository's visibility in the browser. For more information, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility).
|
||||
* Alternatively, you can use {% data variables.product.prodname_cli %} to change repository visibility from the command line. You can even add this command to the script that was generated to run your migrations. For more information, see [`gh repo edit`](https://cli.github.com/manual/gh_repo_edit) in the {% data variables.product.prodname_cli %} documentation.
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
When your migration is complete, we recommend reviewing your migration log. For more information, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/accessing-your-migration-logs-for-github-enterprise-importer)."
|
||||
When your migration is complete, we recommend reviewing your migration log. For more information, see [AUTOTITLE](/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/accessing-your-migration-logs-for-github-enterprise-importer).
|
||||
|
||||
We recommend that you review your migrated repositories for a soundness check.
|
||||
|
||||
@@ -1 +1 @@
|
||||
{% data variables.product.prodname_enterprise %} offers two deployment options. {% ifversion fpt or ghec %}In addition to {% data variables.product.prodname_ghe_cloud %}, you can use {% data variables.product.prodname_ghe_server %} to host development work for your enterprise in your data center or a supported cloud.{% elsif ghes %}In addition to {% data variables.product.product_name %}, you can use {% data variables.product.prodname_ghe_cloud %} to host development work for your enterprise on {% data variables.product.prodname_dotcom_the_website %}.{% endif %} For more information, see "[AUTOTITLE](/get-started/learning-about-github/githubs-plans#github-enterprise)."
|
||||
{% data variables.product.prodname_enterprise %} offers two deployment options. {% ifversion fpt or ghec %}In addition to {% data variables.product.prodname_ghe_cloud %}, you can use {% data variables.product.prodname_ghe_server %} to host development work for your enterprise in your data center or a supported cloud.{% elsif ghes %}In addition to {% data variables.product.product_name %}, you can use {% data variables.product.prodname_ghe_cloud %} to host development work for your enterprise on {% data variables.product.prodname_dotcom_the_website %}.{% endif %} For more information, see [AUTOTITLE](/get-started/learning-about-github/githubs-plans#github-enterprise).
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
Each {% data variables.product.product_name %} instance accepts SSH connections over two ports. Site administrators can access the administrative shell via SSH, then run command-line utilities, troubleshoot, and perform maintenance. Users can connect via SSH to access and write Git data in the instance's repositories. Users do not have shell access to your instance. For more information, see the following articles.
|
||||
|
||||
* "[AUTOTITLE](/admin/configuration/configuring-network-settings/network-ports)"
|
||||
* "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh)"
|
||||
* "[AUTOTITLE](/authentication/connecting-to-github-with-ssh/about-ssh)"
|
||||
* [AUTOTITLE](/admin/configuration/configuring-network-settings/network-ports)
|
||||
* [AUTOTITLE](/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh)
|
||||
* [AUTOTITLE](/authentication/connecting-to-github-with-ssh/about-ssh)
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
{% data reusables.enterprise.constantly-improving %} You are responsible for upgrades to your instance. For more information, see "[AUTOTITLE](/admin/overview/about-upgrades-to-new-releases)."
|
||||
{% data reusables.enterprise.constantly-improving %} You are responsible for upgrades to your instance. For more information, see [AUTOTITLE](/admin/overview/about-upgrades-to-new-releases).
|
||||
|
||||
To upgrade an instance, you must plan and communicate the upgrade, choose the appropriate package, back up your data, and then perform the upgrade.
|
||||
|
||||
@@ -1 +1 @@
|
||||
To learn how your enterprise can use {% data variables.product.product_name %} most effectively, see "[AUTOTITLE](/admin/overview/best-practices-for-enterprises)."
|
||||
To learn how your enterprise can use {% data variables.product.product_name %} most effectively, see [AUTOTITLE](/admin/overview/best-practices-for-enterprises).
|
||||
|
||||
@@ -4,6 +4,6 @@
|
||||
{%- ifversion ghes = 3.11 %} 3.11.8{%- endif %}
|
||||
{%- ifversion ghes = 3.10 %} 3.10.10{%- endif %}
|
||||
. For more information, see
|
||||
{%- ifversion ghes = 3.12 %} "[AUTOTITLE](/enterprise-server@3.12/admin/release-notes#3.12.2-security-fixes)."{%- endif %}
|
||||
{%- ifversion ghes = 3.11 %} "[AUTOTITLE](/enterprise-server@3.11/admin/release-notes#3.11.8-security-fixes)."{%- endif %}
|
||||
{%- ifversion ghes = 3.10 %} "[AUTOTITLE](/enterprise-server@3.10/admin/release-notes#3.10.10-security-fixes)."{%- endif %}
|
||||
{%- ifversion ghes = 3.12 %} [AUTOTITLE](/enterprise-server@3.12/admin/release-notes#3.12.2-security-fixes).{%- endif %}
|
||||
{%- ifversion ghes = 3.11 %} [AUTOTITLE](/enterprise-server@3.11/admin/release-notes#3.11.8-security-fixes).{%- endif %}
|
||||
{%- ifversion ghes = 3.10 %} [AUTOTITLE](/enterprise-server@3.10/admin/release-notes#3.10.10-security-fixes).{%- endif %}
|
||||
|
||||
@@ -1 +1 @@
|
||||
For more information about how you can try {% data variables.product.prodname_ghe_cloud %} for free, see "[Setting up a trial of {% data variables.product.prodname_ghe_cloud %}](/admin/overview/setting-up-a-trial-of-github-enterprise-cloud)."
|
||||
For more information about how you can try {% data variables.product.prodname_ghe_cloud %} for free, see [Setting up a trial of {% data variables.product.prodname_ghe_cloud %}](/admin/overview/setting-up-a-trial-of-github-enterprise-cloud).
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
{% ifversion repo-policy-rules %}
|
||||
We recommend creating a **repository policy** to govern the lifecycle of repositories in your enterprise, such as who can create or delete repositories. Repository policies give you flexibility over which users are affected and which organizations and repositories are targeted. See "[AUTOTITLE](/admin/managing-accounts-and-repositories/managing-repositories-in-your-enterprise/governing-how-people-use-repositories-in-your-enterprise)."
|
||||
We recommend creating a **repository policy** to govern the lifecycle of repositories in your enterprise, such as who can create or delete repositories. Repository policies give you flexibility over which users are affected and which organizations and repositories are targeted. See [AUTOTITLE](/admin/managing-accounts-and-repositories/managing-repositories-in-your-enterprise/governing-how-people-use-repositories-in-your-enterprise).
|
||||
{% endif %}
|
||||
|
||||
@@ -1 +1 @@
|
||||
You can create a repository policy to govern who can create repositories in your organization, how new repositories must be named, and which visibilities are available. Compared to "member privilege" policies, repository policies give you more flexibility over which users are affected and which repositories are targeted. See "[AUTOTITLE](/organizations/managing-organization-settings/governing-how-people-use-repositories-in-your-organization)."
|
||||
You can create a repository policy to govern who can create repositories in your organization, how new repositories must be named, and which visibilities are available. Compared to "member privilege" policies, repository policies give you more flexibility over which users are affected and which repositories are targeted. See [AUTOTITLE](/organizations/managing-organization-settings/governing-how-people-use-repositories-in-your-organization).
|
||||
|
||||
@@ -2,4 +2,4 @@ We recommend using repository policies alongside **custom repository properties*
|
||||
|
||||
For example, you can add a property to mark repositories that contain production data or other sensitive information, then prevent anyone from making those repositories public.
|
||||
|
||||
To create and set custom properties, see "[AUTOTITLE](/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)."
|
||||
To create and set custom properties, see [AUTOTITLE](/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization).
|
||||
|
||||
@@ -1,2 +1,2 @@
|
||||
> [!NOTE]
|
||||
> This policy only impacts repository administrators, specifically. Organization owners and security managers can always enable security features, regardless of how you set this policy. For more information, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)."
|
||||
> This policy only impacts repository administrators, specifically. Organization owners and security managers can always enable security features, regardless of how you set this policy. For more information, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization).
|
||||
|
||||
@@ -1 +1 @@
|
||||
> [!NOTE] Currently, {% data variables.product.prodname_ghe_cloud %} customers who use a single organization are being automatically upgraded to an enterprise account at no additional cost. For details, see "[AUTOTITLE](/admin/managing-your-enterprise-account/creating-an-enterprise-account#what-will-happen-after-i-upgrade-my-organization)."
|
||||
> [!NOTE] Currently, {% data variables.product.prodname_ghe_cloud %} customers who use a single organization are being automatically upgraded to an enterprise account at no additional cost. For details, see [AUTOTITLE](/admin/managing-your-enterprise-account/creating-an-enterprise-account#what-will-happen-after-i-upgrade-my-organization).
|
||||
|
||||
@@ -1 +1 @@
|
||||
{% data variables.product.company_short %} strongly recommends that you verify any new configuration for authentication in a staging environment. An incorrect configuration could result in downtime for {% data variables.location.product_location %}. For more information, see "[AUTOTITLE](/admin/installation/setting-up-a-github-enterprise-server-instance/setting-up-a-staging-instance)."
|
||||
{% data variables.product.company_short %} strongly recommends that you verify any new configuration for authentication in a staging environment. An incorrect configuration could result in downtime for {% data variables.location.product_location %}. For more information, see [AUTOTITLE](/admin/installation/setting-up-a-github-enterprise-server-instance/setting-up-a-staging-instance).
|
||||
|
||||
@@ -1 +1 @@
|
||||
You can use Markdown to format your message. For more information, see "[AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github)."
|
||||
You can use Markdown to format your message. For more information, see [AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github).
|
||||
|
||||
@@ -4,9 +4,9 @@
|
||||
{%- ifversion ghes = 3.11 %} 3.11.8{%- endif %}
|
||||
{%- ifversion ghes = 3.10 %} 3.10.10{%- endif %}
|
||||
. For more information, see
|
||||
{%- ifversion ghes = 3.12 %} "[AUTOTITLE](/enterprise-server@3.12/admin/release-notes#3.12.2-security-fixes)."{%- endif %}
|
||||
{%- ifversion ghes = 3.11 %} "[AUTOTITLE](/enterprise-server@3.11/admin/release-notes#3.11.8-security-fixes)."{%- endif %}
|
||||
{%- ifversion ghes = 3.10 %} "[AUTOTITLE](/enterprise-server@3.10/admin/release-notes#3.10.10-security-fixes)."{%- endif %}
|
||||
{%- ifversion ghes = 3.12 %} [AUTOTITLE](/enterprise-server@3.12/admin/release-notes#3.12.2-security-fixes).{%- endif %}
|
||||
{%- ifversion ghes = 3.11 %} [AUTOTITLE](/enterprise-server@3.11/admin/release-notes#3.11.8-security-fixes).{%- endif %}
|
||||
{%- ifversion ghes = 3.10 %} [AUTOTITLE](/enterprise-server@3.10/admin/release-notes#3.10.10-security-fixes).{%- endif %}
|
||||
|
||||
>
|
||||
> {% data reusables.enterprise_clustering.failover-blocks-ips %}
|
||||
|
||||
@@ -2,4 +2,4 @@ Configure the load balancer to check the following URL.
|
||||
|
||||
`http(s)://HOSTNAME/status`
|
||||
|
||||
The endpoint will return status code `200` (OK) if the node is healthy and available to service end-user requests. For more information, see "[AUTOTITLE](/admin/enterprise-management/configuring-high-availability/monitoring-a-high-availability-configuration#monitoring-replication-from-a-remote-system)."
|
||||
The endpoint will return status code `200` (OK) if the node is healthy and available to service end-user requests. For more information, see [AUTOTITLE](/admin/enterprise-management/configuring-high-availability/monitoring-a-high-availability-configuration#monitoring-replication-from-a-remote-system).
|
||||
|
||||
@@ -1 +1 @@
|
||||
DNS lookups for the {% data variables.product.prodname_ghe_server %} hostname should resolve to the load balancer. We recommend that you enable subdomain isolation. If subdomain isolation is enabled, an additional wildcard record (`*.HOSTNAME`) should also resolve to the load balancer. For more information, see "[AUTOTITLE](/admin/configuration/configuring-network-settings/enabling-subdomain-isolation)."
|
||||
DNS lookups for the {% data variables.product.prodname_ghe_server %} hostname should resolve to the load balancer. We recommend that you enable subdomain isolation. If subdomain isolation is enabled, an additional wildcard record (`*.HOSTNAME`) should also resolve to the load balancer. For more information, see [AUTOTITLE](/admin/configuration/configuring-network-settings/enabling-subdomain-isolation).
|
||||
|
||||
@@ -16,4 +16,4 @@
|
||||
storage-server = true
|
||||
</pre>
|
||||
|
||||
You can choose to defer database seeding of a new MySQL replica node, resulting in being able to open your appliance to traffic sooner. For more information, see "[AUTOTITLE](/admin/monitoring-and-managing-your-instance/configuring-clustering/deferring-database-seeding)."
|
||||
You can choose to defer database seeding of a new MySQL replica node, resulting in being able to open your appliance to traffic sooner. For more information, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/configuring-clustering/deferring-database-seeding).
|
||||
|
||||
@@ -1 +1 @@
|
||||
1. If you're taking a node offline that provides data services, such as `git-server`, `pages-server`, or `storage-server`, evacuate the node. For more information, see "[AUTOTITLE](/admin/enterprise-management/configuring-clustering/evacuating-a-cluster-node-running-data-services)."
|
||||
1. If you're taking a node offline that provides data services, such as `git-server`, `pages-server`, or `storage-server`, evacuate the node. For more information, see [AUTOTITLE](/admin/enterprise-management/configuring-clustering/evacuating-a-cluster-node-running-data-services).
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
1. If you're replacing the primary Redis node, in `cluster.conf`, modify the `redis-master` value with the replacement node name.
|
||||
|
||||
> [!NOTE]
|
||||
> If your primary Redis node is also your primary MySQL node, see "[Replacing the primary MySQL node](#replacing-the-primary-mysql-node)."
|
||||
> If your primary Redis node is also your primary MySQL node, see [Replacing the primary MySQL node](#replacing-the-primary-mysql-node).
|
||||
|
||||
For example, this modified `cluster.conf` file specifies a newly provisioned cluster node, `ghe-replacement-data-node-1` as the primary Redis node:
|
||||
|
||||
|
||||
@@ -1 +1 @@
|
||||
1. SSH into any node in your cluster. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh)."
|
||||
1. SSH into any node in your cluster. For more information, see [AUTOTITLE](/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh).
|
||||
|
||||
@@ -1,2 +1,2 @@
|
||||
> [!NOTE]
|
||||
> If {% data variables.location.product_location %} is in a geo-replication configuration, or if your instance is a cluster, you should use the `ghe-cluster-support-bundle` command to retrieve the support bundle. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-cluster-support-bundle)."
|
||||
> If {% data variables.location.product_location %} is in a geo-replication configuration, or if your instance is a cluster, you should use the `ghe-cluster-support-bundle` command to retrieve the support bundle. For more information, see [AUTOTITLE](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-cluster-support-bundle).
|
||||
|
||||
@@ -1 +1 @@
|
||||
For more information about adjusting resources for an existing instance, see "[AUTOTITLE](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/increasing-storage-capacity)" and "[AUTOTITLE](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/increasing-cpu-or-memory-resources)."
|
||||
For more information about adjusting resources for an existing instance, see [AUTOTITLE](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/increasing-storage-capacity) and [AUTOTITLE](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/increasing-cpu-or-memory-resources).
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
The {% data variables.product.prodname_ghe_server %} appliance requires a premium storage data disk, and is supported on any Azure VM that supports premium storage. Azure VM types with the `s` suffix support premium storage. For more information, see "[What disk types are available in Azure?](https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types#premium-ssd)" and "[Azure premium storage: design for high performance](https://docs.microsoft.com/en-us/azure/virtual-machines/premium-storage-performance)" in the Azure documentation.
|
||||
The {% data variables.product.prodname_ghe_server %} appliance requires a premium storage data disk, and is supported on any Azure VM that supports premium storage. Azure VM types with the `s` suffix support premium storage. For more information, see [What disk types are available in Azure?](https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types#premium-ssd) and [Azure premium storage: design for high performance](https://docs.microsoft.com/en-us/azure/virtual-machines/premium-storage-performance) in the Azure documentation.
|
||||
|
||||
{% data variables.product.company_short %} recommends a memory-optimized VM for {% data variables.product.prodname_ghe_server %}. For more information, see "[Memory optimized virtual machine sizes](https://docs.microsoft.com/en-us/azure/virtual-machines/sizes-memory)" in the Azure documentation.
|
||||
{% data variables.product.company_short %} recommends a memory-optimized VM for {% data variables.product.prodname_ghe_server %}. For more information, see [Memory optimized virtual machine sizes](https://docs.microsoft.com/en-us/azure/virtual-machines/sizes-memory) in the Azure documentation.
|
||||
|
||||
{% data variables.product.prodname_ghe_server %} supports any region that supports your VM type. For more information about the supported regions for each VM, see Azure's "[Products available by region](https://azure.microsoft.com/regions/services/)."
|
||||
{% data variables.product.prodname_ghe_server %} supports any region that supports your VM type. For more information about the supported regions for each VM, see Azure's [Products available by region](https://azure.microsoft.com/regions/services/).
|
||||
|
||||
@@ -1 +1 @@
|
||||
To create the instance, you'll need to import the {% data variables.product.prodname_ghe_server %} image to your virtual machine and attach an additional storage volume for your instance data. For more information, see "[Hardware considerations](#hardware-considerations)."
|
||||
To create the instance, you'll need to import the {% data variables.product.prodname_ghe_server %} image to your virtual machine and attach an additional storage volume for your instance data. For more information, see [Hardware considerations](#hardware-considerations).
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{% ifversion ghes %}
|
||||
|
||||
> [!WARNING]
|
||||
> If subdomain isolation is disabled, we recommend also disabling {% data variables.product.prodname_pages %} on your enterprise. There will be no way to isolate user-supplied {% data variables.product.prodname_pages %} content from the rest of your enterprise's data. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/configuring-github-pages-for-your-enterprise)."
|
||||
> If subdomain isolation is disabled, we recommend also disabling {% data variables.product.prodname_pages %} on your enterprise. There will be no way to isolate user-supplied {% data variables.product.prodname_pages %} content from the rest of your enterprise's data. For more information, see [AUTOTITLE](/admin/configuration/configuring-your-enterprise/configuring-github-pages-for-your-enterprise).
|
||||
|
||||
{% endif %}
|
||||
|
||||
@@ -1 +1 @@
|
||||
1. Download your license. For more information, see "[AUTOTITLE](/billing/managing-your-license-for-github-enterprise/downloading-your-license-for-github-enterprise)."
|
||||
1. Download your license. For more information, see [AUTOTITLE](/billing/managing-your-license-for-github-enterprise/downloading-your-license-for-github-enterprise).
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user