From 664be59a9b4757c068da61cfa5e145ee3352c213 Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Sun, 5 Jan 2025 23:47:10 -0800 Subject: [PATCH 01/37] Update audit log event data (#53722) --- src/audit-logs/lib/config.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/audit-logs/lib/config.json b/src/audit-logs/lib/config.json index c977d1c4072e..996d9f04d8ce 100644 --- a/src/audit-logs/lib/config.json +++ b/src/audit-logs/lib/config.json @@ -3,5 +3,5 @@ "apiOnlyEvents": "This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", "apiRequestEvent": "This event is only available via audit log streaming." }, - "sha": "cf8e25bad05e4b14ca3b701b3ecfe9e5d0187544" + "sha": "2145bc8b2a41ef2ccd1bb9c9d84842f3f4a30184" } \ No newline at end of file From f5fef061b610220a1591b7509fbc490bc20fb177 Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Sun, 5 Jan 2025 23:47:10 -0800 Subject: [PATCH 02/37] Delete orphaned features (2024-12-23-16-28) (#53725) --- data/features/dependabot-alerts-vulnerable-calls.yml | 4 ---- .../security-overview-feature-specific-alert-page.yml | 6 ------ data/features/status-check-retention.yml | 4 ---- data/features/supply-chain-features-swift-support.yml | 6 ------ data/features/tag-protection-rules-deprecation.yml | 6 ------ 5 files changed, 26 deletions(-) delete mode 100644 data/features/dependabot-alerts-vulnerable-calls.yml delete mode 100644 data/features/security-overview-feature-specific-alert-page.yml delete mode 100644 data/features/status-check-retention.yml delete mode 100644 data/features/supply-chain-features-swift-support.yml delete mode 100644 data/features/tag-protection-rules-deprecation.yml diff --git a/data/features/dependabot-alerts-vulnerable-calls.yml b/data/features/dependabot-alerts-vulnerable-calls.yml deleted file mode 100644 index a67e03d32def..000000000000 --- a/data/features/dependabot-alerts-vulnerable-calls.yml +++ /dev/null @@ -1,4 +0,0 @@ -# Reference: Issue #6076 introduction of label for "vulnerable calls" in Dependabot alerts -versions: - fpt: '*' - ghec: '*' diff --git a/data/features/security-overview-feature-specific-alert-page.yml b/data/features/security-overview-feature-specific-alert-page.yml deleted file mode 100644 index 68f589e9ef4d..000000000000 --- a/data/features/security-overview-feature-specific-alert-page.yml +++ /dev/null @@ -1,6 +0,0 @@ -# Reference: #7028. -# Documentation for feature-specific page for security overview at enterprise-level. -versions: - fpt: '*' - ghec: '*' - ghes: '>= 3.7' diff --git a/data/features/status-check-retention.yml b/data/features/status-check-retention.yml deleted file mode 100644 index c58c3f3fc122..000000000000 --- a/data/features/status-check-retention.yml +++ /dev/null @@ -1,4 +0,0 @@ -versions: - fpt: '*' - ghec: '*' - ghes: '>= 3.8' diff --git a/data/features/supply-chain-features-swift-support.yml b/data/features/supply-chain-features-swift-support.yml deleted file mode 100644 index c1a48b16fe64..000000000000 --- a/data/features/supply-chain-features-swift-support.yml +++ /dev/null @@ -1,6 +0,0 @@ -# Reference: #10144. -# Advisory Database + Dependency Graph + Dependabot Alerts support Swift [GA] -versions: - fpt: '*' - ghec: '*' - ghes: '>=3.10' diff --git a/data/features/tag-protection-rules-deprecation.yml b/data/features/tag-protection-rules-deprecation.yml deleted file mode 100644 index 3b72b415a07c..000000000000 --- a/data/features/tag-protection-rules-deprecation.yml +++ /dev/null @@ -1,6 +0,0 @@ -# Reference: Issue #12436 - Tag protection rules deprecation - -versions: - fpt: '*' - ghec: '*' - ghes: '>=3.16' From 3610cc65d9dfcff420e904fb56630b8ece8a4ad5 Mon Sep 17 00:00:00 2001 From: Roniece Ricardo <33437850+RonRicardo@users.noreply.github.com> Date: Mon, 6 Jan 2025 02:47:10 -0500 Subject: [PATCH 03/37] [Quote removal] Remove quotes from data/reusables/advanced-formatting through data/reusables/dependabot (#53658) Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> Co-authored-by: Rachael Sewell Co-authored-by: Ashish Keshan --- .../administrator-must-enable-mapping.md | 2 +- .../about-ghas-organization-policy.md | 4 +- .../check-for-ghas-license.md | 2 +- .../ghas-helps-developers.md | 2 +- .../advanced-security/ghas-must-be-enabled.md | 2 +- .../reusables/advanced-security/ghas-trial.md | 4 +- .../advanced-security/more-info-ghas.md | 2 +- .../note-org-enable-uses-seats.md | 2 +- .../advanced-security/purchase-ghas.md | 2 +- ...ret-scanning-add-custom-pattern-details.md | 2 +- ...g-enable-push-protection-custom-pattern.md | 2 +- ...erate-regular-expression-custom-pattern.md | 2 +- data/reusables/apps/about-installation.md | 4 +- data/reusables/apps/app-scans.md | 2 +- data/reusables/apps/app_manager_role.md | 2 +- .../apps/best-practice-use-durable-id.md | 2 +- .../apps/best-practice-validate-org-access.md | 2 +- .../apps/general-apps-restrictions.md | 2 +- .../generate-installation-access-token.md | 8 ++-- data/reusables/apps/github-app-managers.md | 4 +- data/reusables/apps/github_app_auth_saml.md | 2 +- .../reusables/apps/github_app_install_saml.md | 2 +- data/reusables/apps/install-vs-authorize.md | 2 +- .../navigate-to-app-settings-this-article.md | 2 +- data/reusables/apps/reauthorize-apps-saml.md | 2 +- .../apps/web-app-flow-exchange-code.md | 2 +- .../audit_log/audit-log-action-categories.md | 48 +++++++++---------- data/reusables/audit_log/audit-log-search.md | 2 +- .../audit_log/only-three-months-displayed.md | 2 +- data/reusables/audit_log/retention-periods.md | 2 +- .../audit_log/users-agree-to-ip-collection.md | 2 +- data/reusables/billing/billing-info.md | 2 +- .../enhanced-billing-platform-licenses.md | 2 +- .../billing/enhanced-billing-platform.md | 2 +- .../ghas-metered-billing-note-with-link.md | 2 +- data/reusables/billing/us-sales-tax.md | 2 +- data/reusables/billing/usage-based-billing.md | 4 +- .../branches/change-default-branch.md | 2 +- data/reusables/branches/set-default-branch.md | 2 +- .../classroom/about-feedback-pull-requests.md | 2 +- .../classroom/about-ide-integration.md | 2 +- .../assignments-classroom-prerequisite.md | 2 +- .../assignments-guide-make-cutoff-date.md | 2 +- .../assignments-guide-protected-paths.md | 2 +- .../assignments-guide-using-autograding.md | 4 +- ...s-repository-visibility-and-permissions.md | 2 +- .../classroom/classroom-admins-link.md | 2 +- .../classroom/classroom-codespaces-link.md | 2 +- ...e-information-about-assignment-creation.md | 2 +- .../classroom/google-classroom-note.md | 2 +- .../classroom/guide-create-new-classroom.md | 2 +- .../link-to-assignment-overview-article.md | 2 +- .../classroom/reuse-assignment-link.md | 2 +- .../you-can-choose-a-template-repository.md | 2 +- ...-can-create-a-pull-request-for-feedback.md | 2 +- data/reusables/cli/cli-learn-more.md | 2 +- .../filter-issues-and-pull-requests-tip.md | 2 +- .../about-multiple-configurations-link.md | 2 +- .../code-scanning/alert-tracking-link.md | 2 +- .../alerts-found-in-generated-code.md | 4 +- .../audit-code-scanning-events.md | 2 +- data/reusables/code-scanning/billing.md | 2 +- .../choose-alert-dismissal-reason.md | 2 +- .../codeql-action-version-ghes.md | 2 +- .../codeql-language-identifiers-table.md | 2 +- .../code-scanning/codeql-languages-bullets.md | 2 +- .../codeql-query-suites-explanation.md | 2 +- .../code-scanning/codeql-query-suites.md | 2 +- .../codeql-version-info.md | 2 +- .../links-to-all-tables.md | 16 +++---- .../query-suite-behavior.md | 2 +- ...efault-setup-pre-enablement-explanation.md | 2 +- ...default-setup-swift-self-hosted-runners.md | 2 +- .../code-scanning/enabling-options.md | 4 +- ...enterprise-enable-code-scanning-actions.md | 2 +- .../enterprise-enable-code-scanning.md | 4 +- .../example-configuration-files.md | 2 +- .../false-positive-fix-codeql.md | 2 +- ...eroperable-with-tools-that-output-sarif.md | 2 +- .../reusables/code-scanning/licensing-note.md | 4 +- .../code-scanning/max-paths-setting.md | 2 +- .../code-scanning/pull-request-checks.md | 2 +- .../code-scanning/run-additional-queries.md | 6 +-- .../code-scanning/sarif-upload-retry.md | 2 +- ...troubleshooting-multiple-configurations.md | 2 +- .../code-scanning/upload-sarif-alert-limit.md | 2 +- .../code-scanning/upload-sarif-ghas.md | 2 +- .../using-security-overview-coverage.md | 4 +- .../using-security-overview-risk.md | 2 +- data/reusables/codeql-cli/launch-codeql.md | 2 +- .../codespaces/about-changing-storage-size.md | 2 +- .../codespaces/about-publishing-templates.md | 2 +- .../codespaces/additional-container-config.md | 2 +- .../codespaces/check-for-default-image.md | 2 +- .../codespaces-continue-by-paying.md | 2 +- .../codespaces-machine-type-availability.md | 2 +- .../codespaces/codespaces-machine-types.md | 2 +- .../codespaces-org-policies-note.md | 2 +- .../codespaces-unavailable-for-emus.md | 2 +- .../committing-link-to-procedure.md | 2 +- .../connect-to-codespace-from-vscode.md | 2 +- data/reusables/codespaces/contact-support.md | 2 +- .../codespaces/customize-vcpus-and-ram.md | 4 +- .../codespaces/devcontainer-properties-1.md | 4 +- .../codespaces/devcontainer-properties-2.md | 2 +- .../codespaces/developing-in-vscode.md | 8 ++-- .../codespaces/disabling-settings-sync.md | 4 +- .../codespaces/edit-devcontainer-json.md | 2 +- .../codespaces/emus-create-codespaces.md | 2 +- .../reusables/codespaces/exporting-changes.md | 2 +- .../forwarded-ports-environment-variable.md | 2 +- data/reusables/codespaces/full-rebuild-tip.md | 2 +- .../codespaces/gpg-in-active-codespaces.md | 2 +- .../codespaces/jupyterlab-in-default-image.md | 2 +- .../codespaces/links-to-get-started.md | 2 +- .../next-steps-adding-devcontainer.md | 8 ++-- .../opening-codespace-in-jetbrains.md | 4 +- .../codespaces/permanent-codespace-names.md | 2 +- .../port-forwarding-adding-non-jetbrains.md | 2 +- .../port-forwarding-sharing-non-jetbrains.md | 2 +- .../codespaces/prebuilds-crossreference.md | 2 +- .../prebuilds-permission-authorization.md | 2 +- data/reusables/codespaces/rebuild-note.md | 2 +- .../codespaces/restrict-port-visibility.md | 2 +- data/reusables/codespaces/secrets-on-start.md | 2 +- .../codespaces/setting-up-project-intro.md | 2 +- .../codespaces/settings-sync-and-gpg.md | 2 +- .../codespaces/settings-sync-link.md | 2 +- .../codespaces/setup-custom-devcontainer.md | 2 +- data/reusables/codespaces/source-control.md | 4 +- .../codespaces/stopping-a-codespace.md | 2 +- .../template-codespaces-default-editor.md | 2 +- .../codespaces/tips-included-usage.md | 2 +- .../troubleshooting-simple-browser.md | 2 +- .../codespaces/trusted-repos-step.md | 2 +- .../when-you-can-create-codespaces.md | 2 +- data/reusables/command-palette/default.md | 2 +- .../command_line/provide-an-access-token.md | 2 +- .../community/tools-for-moderating.md | 2 +- .../link-azure-subscription.md | 4 +- .../manage-your-enterprise.md | 8 ++-- data/reusables/copilot/chat-access-denied.md | 2 +- .../code-review/custom-coding-guidelines.md | 2 +- .../copilot/content-exclusion-fnmatch-tip.md | 2 +- .../copilot/content-exclusion-tooltip.md | 2 +- .../copilot-chat-models-list-o1-preview.md | 2 +- .../copilot/copilot-chat-models-list-o1.md | 2 +- ...ferences-between-agents-and-skillsets-2.md | 2 +- .../extending-copilot-chat.md | 2 +- .../copilot/copilot-requires-subscription.md | 2 +- .../example-prompts/further-reading-items.md | 4 +- .../copilot/jetbrains-plugin-prerequisites.md | 4 +- .../copilot/link-to-vs-install-docs.md | 2 +- .../copilot/model-picker-enable-o1-models.md | 2 +- data/reusables/copilot/policies-for-dotcom.md | 6 +-- data/reusables/copilot/quickstart-intro.md | 2 +- .../copilot/quickstart-nextsteps1.md | 6 +-- .../copilot/quickstart-nextsteps2.md | 6 +-- .../signup-procedure-enterprise-msft-ea.md | 2 +- .../reusables/copilot/signup-procedure-org.md | 2 +- data/reusables/copilot/signup-procedure.md | 2 +- data/reusables/copilot/sku-isolation.md | 2 +- .../copilot/subscription-prerequisite.md | 2 +- .../copilot/visual-studio-version.md | 2 +- .../reusables/copilot/vscode-prerequisites.md | 4 +- .../copilot/windows-terminal-access-denied.md | 2 +- ...ata-resident-enterprises-network-access.md | 2 +- .../advanced-private-registry-config-link.md | 2 +- .../dependabot/automated-tests-note.md | 2 +- .../automatically-pause-dependabot-updates.md | 2 +- .../dependabot/dependabot-alert-create-PR.md | 2 +- .../dependabot/dependabot-alert-rules.md | 2 +- ...abot-alerts-dependency-graph-enterprise.md | 2 +- ...s-enterprise-server-repo-org-enablement.md | 2 +- .../dependabot/dependabot-alerts-filters.md | 2 +- .../dependabot-custom-rules-ghas.md | 2 +- .../dependabot-ignore-dependencies.md | 2 +- ...-on-actions-enterprise-policy-condition.md | 2 +- .../dependabot-on-actions-self-hosted-link.md | 2 +- ...dependabot-runners-network-requirements.md | 2 +- ...ecurity-updates-disable-for-alert-rules.md | 2 +- ...dabot-security-updates-groups-supported.md | 2 +- data/reusables/dependabot/dependabot-tos.md | 2 +- .../dependabot-updates-prs-and-actions.md | 2 +- .../dependabot-updates-signed-commits.md | 2 +- ...abot-updates-supported-repos-ecosystems.md | 2 +- ...-submission-api-build-time-dependencies.md | 2 +- .../dependabot/dismiss-low-impact-rule.md | 2 +- ...disabling-dependency-graph-private-repo.md | 4 +- .../enterprise-enable-dependabot.md | 4 +- .../ghes-enabling-dependency-graph.md | 2 +- .../no-dependabot-alerts-for-malware.md | 2 +- .../dependabot/pull-request-introduction.md | 2 +- data/reusables/dependabot/quickstart-link.md | 2 +- .../dependabot/supported-package-managers.md | 16 +++---- .../dependabot/version-updates-for-actions.md | 2 +- 196 files changed, 275 insertions(+), 275 deletions(-) diff --git a/data/reusables/advanced-formatting/administrator-must-enable-mapping.md b/data/reusables/advanced-formatting/administrator-must-enable-mapping.md index fc2f5ff2abd7..cd711403db71 100644 --- a/data/reusables/advanced-formatting/administrator-must-enable-mapping.md +++ b/data/reusables/advanced-formatting/administrator-must-enable-mapping.md @@ -1,5 +1,5 @@ {% ifversion azure-maps %} -To display interactive maps, a site administrator must configure the feature for {% data variables.location.product_location %}. For more information, see "[AUTOTITLE](/admin/configuration/configuring-user-applications-for-your-enterprise/configuring-interactive-maps)." +To display interactive maps, a site administrator must configure the feature for {% data variables.location.product_location %}. For more information, see [AUTOTITLE](/admin/configuration/configuring-user-applications-for-your-enterprise/configuring-interactive-maps). {% endif %} diff --git a/data/reusables/advanced-security/about-ghas-organization-policy.md b/data/reusables/advanced-security/about-ghas-organization-policy.md index 5b4ea8d90f67..16ba19a1d4ab 100644 --- a/data/reusables/advanced-security/about-ghas-organization-policy.md +++ b/data/reusables/advanced-security/about-ghas-organization-policy.md @@ -1,5 +1,5 @@ -{% data variables.product.company_short %} bills for {% data variables.product.prodname_advanced_security %} on a per-committer basis. See "[AUTOTITLE](/billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security)." +{% data variables.product.company_short %} bills for {% data variables.product.prodname_advanced_security %} on a per-committer basis. See [AUTOTITLE](/billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security). You can enforce a policy that controls whether repository administrators are allowed to enable features for {% data variables.product.prodname_advanced_security %} in an organization's repositories. You can configure a policy for all organizations owned by your enterprise account, or for individual organizations that you choose. -Disallowing {% data variables.product.prodname_advanced_security %} for an organization prevents repository administrators from enabling {% data variables.product.prodname_advanced_security %} features for additional repositories, but does not disable the features for repositories where the features are already enabled. For more information about configuration of {% data variables.product.prodname_advanced_security %} features, see "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization)" or "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository)." +Disallowing {% data variables.product.prodname_advanced_security %} for an organization prevents repository administrators from enabling {% data variables.product.prodname_advanced_security %} features for additional repositories, but does not disable the features for repositories where the features are already enabled. For more information about configuration of {% data variables.product.prodname_advanced_security %} features, see [AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization) or [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository). diff --git a/data/reusables/advanced-security/check-for-ghas-license.md b/data/reusables/advanced-security/check-for-ghas-license.md index 788eb885a2d8..d3aef0afb9d1 100644 --- a/data/reusables/advanced-security/check-for-ghas-license.md +++ b/data/reusables/advanced-security/check-for-ghas-license.md @@ -1 +1 @@ -You can identify if your enterprise has a {% data variables.product.prodname_GH_advanced_security %} license by reviewing your enterprise settings. For more information, see "[AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/enabling-github-advanced-security-for-your-enterprise#checking-whether-your-license-includes-github-advanced-security)." +You can identify if your enterprise has a {% data variables.product.prodname_GH_advanced_security %} license by reviewing your enterprise settings. For more information, see [AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/enabling-github-advanced-security-for-your-enterprise#checking-whether-your-license-includes-github-advanced-security). diff --git a/data/reusables/advanced-security/ghas-helps-developers.md b/data/reusables/advanced-security/ghas-helps-developers.md index adfde488bc3d..9d391c8ee218 100644 --- a/data/reusables/advanced-security/ghas-helps-developers.md +++ b/data/reusables/advanced-security/ghas-helps-developers.md @@ -1 +1 @@ -{% data variables.product.prodname_GH_advanced_security %} helps developers improve and maintain the security and quality of code. For more information, see "[AUTOTITLE](/get-started/learning-about-github/about-github-advanced-security)." +{% data variables.product.prodname_GH_advanced_security %} helps developers improve and maintain the security and quality of code. For more information, see [AUTOTITLE](/get-started/learning-about-github/about-github-advanced-security). diff --git a/data/reusables/advanced-security/ghas-must-be-enabled.md b/data/reusables/advanced-security/ghas-must-be-enabled.md index 2d72473fecae..a99266b02865 100644 --- a/data/reusables/advanced-security/ghas-must-be-enabled.md +++ b/data/reusables/advanced-security/ghas-must-be-enabled.md @@ -1 +1 @@ -{% data variables.product.prodname_GH_advanced_security %} features must be available to the organization for this policy to take effect. For more information, see "[Enforcing a policy for the use of {% data variables.product.prodname_GH_advanced_security %} in your enterprise's organizations](#enforcing-a-policy-for-the-use-of-github-advanced-security-in-your-enterprises-organizations)." +{% data variables.product.prodname_GH_advanced_security %} features must be available to the organization for this policy to take effect. For more information, see [Enforcing a policy for the use of {% data variables.product.prodname_GH_advanced_security %} in your enterprise's organizations](#enforcing-a-policy-for-the-use-of-github-advanced-security-in-your-enterprises-organizations). diff --git a/data/reusables/advanced-security/ghas-trial.md b/data/reusables/advanced-security/ghas-trial.md index 9bb719ac8bab..0b5ba75c5b4b 100644 --- a/data/reusables/advanced-security/ghas-trial.md +++ b/data/reusables/advanced-security/ghas-trial.md @@ -1,2 +1,2 @@ -{% ifversion ghec %}For information about how you can try {% data variables.product.prodname_GH_advanced_security %} for free, see "[AUTOTITLE](/billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security/setting-up-a-trial-of-github-advanced-security)." -{% elsif fpt %}For information about how you can try {% data variables.product.prodname_enterprise %} with {% data variables.product.prodname_GH_advanced_security %} for free, see "[AUTOTITLE](/enterprise-cloud@latest/admin/overview/setting-up-a-trial-of-github-enterprise-cloud)" and "[AUTOTITLE](/enterprise-cloud@latest/billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security/setting-up-a-trial-of-github-advanced-security#setting-up-your-trial-of-github-advanced-security)" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% endif %} +{% ifversion ghec %}For information about how you can try {% data variables.product.prodname_GH_advanced_security %} for free, see [AUTOTITLE](/billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security/setting-up-a-trial-of-github-advanced-security). +{% elsif fpt %}For information about how you can try {% data variables.product.prodname_enterprise %} with {% data variables.product.prodname_GH_advanced_security %} for free, see [AUTOTITLE](/enterprise-cloud@latest/admin/overview/setting-up-a-trial-of-github-enterprise-cloud) and [AUTOTITLE](/enterprise-cloud@latest/billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security/setting-up-a-trial-of-github-advanced-security#setting-up-your-trial-of-github-advanced-security) in the {% data variables.product.prodname_ghe_cloud %} documentation.{% endif %} diff --git a/data/reusables/advanced-security/more-info-ghas.md b/data/reusables/advanced-security/more-info-ghas.md index ebbc3664227f..cee0cd9db703 100644 --- a/data/reusables/advanced-security/more-info-ghas.md +++ b/data/reusables/advanced-security/more-info-ghas.md @@ -1 +1 @@ -For more information, see "[AUTOTITLE](/get-started/learning-about-github/about-github-advanced-security)." +For more information, see [AUTOTITLE](/get-started/learning-about-github/about-github-advanced-security). diff --git a/data/reusables/advanced-security/note-org-enable-uses-seats.md b/data/reusables/advanced-security/note-org-enable-uses-seats.md index accfe3bc22fe..fe3928696d92 100644 --- a/data/reusables/advanced-security/note-org-enable-uses-seats.md +++ b/data/reusables/advanced-security/note-org-enable-uses-seats.md @@ -1,6 +1,6 @@ {% ifversion ghes or ghec %} > [!NOTE] -> If you enable {% data variables.product.prodname_GH_advanced_security %}, active committers to these repositories will use {% data variables.product.prodname_GH_advanced_security %} {% ifversion ghas-billing-UI-update %}licenses{% else %}seats{% endif %}. This option is deactivated if you have exceeded your license capacity. {% ifversion fpt or ghec %}See "[AUTOTITLE](/billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)."{% endif %} +> If you enable {% data variables.product.prodname_GH_advanced_security %}, active committers to these repositories will use {% data variables.product.prodname_GH_advanced_security %} {% ifversion ghas-billing-UI-update %}licenses{% else %}seats{% endif %}. This option is deactivated if you have exceeded your license capacity. {% ifversion fpt or ghec %}See [AUTOTITLE](/billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security).{% endif %} {% endif %} diff --git a/data/reusables/advanced-security/purchase-ghas.md b/data/reusables/advanced-security/purchase-ghas.md index 61560a0c2b43..c5147a131c03 100644 --- a/data/reusables/advanced-security/purchase-ghas.md +++ b/data/reusables/advanced-security/purchase-ghas.md @@ -1,4 +1,4 @@ -1. Under "How many committers do you want to include?", enter the number of committers you want to purchase licenses for. For more information about committer numbers, see "[AUTOTITLE](/billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)." +1. Under "How many committers do you want to include?", enter the number of committers you want to purchase licenses for. For more information about committer numbers, see [AUTOTITLE](/billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security). You won't see this option if you're enrolled in usage-based billing for {% data variables.product.prodname_GH_advanced_security %} licenses. 1. Confirm your billing information and payment method. diff --git a/data/reusables/advanced-security/secret-scanning-add-custom-pattern-details.md b/data/reusables/advanced-security/secret-scanning-add-custom-pattern-details.md index 4bbab8ffbe98..765263a76d04 100644 --- a/data/reusables/advanced-security/secret-scanning-add-custom-pattern-details.md +++ b/data/reusables/advanced-security/secret-scanning-add-custom-pattern-details.md @@ -1,6 +1,6 @@ 1. Enter the details for your new custom pattern. You must at least provide the name for your pattern, and a regular expression for the format of your secret pattern. 1. In the "Pattern name" field, type a name for your pattern. - 1. In the "Secret format" field, type a regular expression for the format of your secret pattern.{% ifversion secret-scanning-custom-pattern-ai-generated %} Alternatively, you can use the generator to generate a regular expression for you. For more information, see "[AUTOTITLE](/code-security/secret-scanning/copilot-secret-scanning/generating-regular-expressions-for-custom-patterns-with-copilot-secret-scanning)."{% endif %} + 1. In the "Secret format" field, type a regular expression for the format of your secret pattern.{% ifversion secret-scanning-custom-pattern-ai-generated %} Alternatively, you can use the generator to generate a regular expression for you. For more information, see [AUTOTITLE](/code-security/secret-scanning/copilot-secret-scanning/generating-regular-expressions-for-custom-patterns-with-copilot-secret-scanning).{% endif %} 1. You can click **More options {% octicon "chevron-down" aria-hidden="true" %}** to provide other surrounding content or additional match requirements for the secret format. 1. Provide a sample test string to make sure your configuration is matching the patterns you expect. diff --git a/data/reusables/advanced-security/secret-scanning-enable-push-protection-custom-pattern.md b/data/reusables/advanced-security/secret-scanning-enable-push-protection-custom-pattern.md index ece63ac154b1..b316774406c6 100644 --- a/data/reusables/advanced-security/secret-scanning-enable-push-protection-custom-pattern.md +++ b/data/reusables/advanced-security/secret-scanning-enable-push-protection-custom-pattern.md @@ -1,7 +1,7 @@ 1. Optionally, to enable push protection for your custom pattern, click **Enable**. > [!NOTE] - > * Push protection for custom patterns will only apply to repositories that have {% data variables.product.prodname_secret_scanning %} as push protection enabled. For more information about enabling push protection, see "[AUTOTITLE](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." + > * Push protection for custom patterns will only apply to repositories that have {% data variables.product.prodname_secret_scanning %} as push protection enabled. For more information about enabling push protection, see [AUTOTITLE](/code-security/secret-scanning/protecting-pushes-with-secret-scanning). > * Enabling push protection for commonly found custom patterns can be disruptive to contributors. ![Screenshot of custom pattern page with the button to enable push protection emphasized.](/assets/images/help/repository/secret-scanning-custom-pattern-enable-push-protection.png) diff --git a/data/reusables/advanced-security/secret-scanning-generate-regular-expression-custom-pattern.md b/data/reusables/advanced-security/secret-scanning-generate-regular-expression-custom-pattern.md index 8824fed109e6..7cbdffaf806c 100644 --- a/data/reusables/advanced-security/secret-scanning-generate-regular-expression-custom-pattern.md +++ b/data/reusables/advanced-security/secret-scanning-generate-regular-expression-custom-pattern.md @@ -2,7 +2,7 @@ 1. On the top right, click **Generate with AI**. > [!NOTE] - > You can enter a regular expression manually instead of using the generator, by typing a regular expression for the format of your secret pattern in the "Secret format" field. For more information, see "[Defining a custom pattern for a repository](/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-a-repository)" or "[Defining a custom pattern for an organization](/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-an-organization)." + > You can enter a regular expression manually instead of using the generator, by typing a regular expression for the format of your secret pattern in the "Secret format" field. For more information, see [Defining a custom pattern for a repository](/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-a-repository) or [Defining a custom pattern for an organization](/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-an-organization). 1. In the sliding panel that is displayed: * Complete the "I want a regular expression that" field, describing, ideally in plain English, what patterns you want your regular expression to capture. You can use other natural languages, but the performance may not be as good as with English. diff --git a/data/reusables/apps/about-installation.md b/data/reusables/apps/about-installation.md index 3652b8408cba..bfd5ba8b7af3 100644 --- a/data/reusables/apps/about-installation.md +++ b/data/reusables/apps/about-installation.md @@ -1,9 +1,9 @@ In order to use a {% data variables.product.prodname_github_app %} on your repositories or organization, you must install the app on your organization or personal account. You can install the same {% data variables.product.prodname_github_app %} on multiple accounts. For example, if you install the app on your personal account and on a few organizations that you own, you'll be able to use the app on your personal repositories, on the organizations where you installed the app, and on repositories owned by those organizations. -When you install an app, you grant the app permission to access the organization and repository resources that it requested. During the installation process, {% data variables.product.company_short %} will tell you which permissions the {% data variables.product.prodname_github_app %} requested. For more information about the REST API requests the {% data variables.product.prodname_github_app %} can make with those permissions, see "[AUTOTITLE](/rest/overview/permissions-required-for-github-apps)." +When you install an app, you grant the app permission to access the organization and repository resources that it requested. During the installation process, {% data variables.product.company_short %} will tell you which permissions the {% data variables.product.prodname_github_app %} requested. For more information about the REST API requests the {% data variables.product.prodname_github_app %} can make with those permissions, see [AUTOTITLE](/rest/overview/permissions-required-for-github-apps). When you install an app, you will also choose which repositories to grant the {% data variables.product.prodname_github_app %} access to. -Before installing a {% data variables.product.prodname_github_app %}, you should ensure you trust the owner of the {% data variables.product.prodname_github_app %}. You should also review the permissions that the {% data variables.product.prodname_github_app %} is requesting and make sure you are comfortable granting those permissions. For more information about the REST API requests the {% data variables.product.prodname_github_app %} can make with those permissions, see "[AUTOTITLE](/rest/overview/permissions-required-for-github-apps)." +Before installing a {% data variables.product.prodname_github_app %}, you should ensure you trust the owner of the {% data variables.product.prodname_github_app %}. You should also review the permissions that the {% data variables.product.prodname_github_app %} is requesting and make sure you are comfortable granting those permissions. For more information about the REST API requests the {% data variables.product.prodname_github_app %} can make with those permissions, see [AUTOTITLE](/rest/overview/permissions-required-for-github-apps). There is no limit to how many apps you can install. diff --git a/data/reusables/apps/app-scans.md b/data/reusables/apps/app-scans.md index 4cb14320734a..2fd643670003 100644 --- a/data/reusables/apps/app-scans.md +++ b/data/reusables/apps/app-scans.md @@ -1 +1 @@ -You should conduct regular vulnerability scans for your app. For example, you might set up code scanning and secret scanning for the repository that hosts your app's code. For more information, see "[AUTOTITLE](/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning)" and "[AUTOTITLE](/code-security/secret-scanning/introduction/about-secret-scanning)." +You should conduct regular vulnerability scans for your app. For example, you might set up code scanning and secret scanning for the repository that hosts your app's code. For more information, see [AUTOTITLE](/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning) and [AUTOTITLE](/code-security/secret-scanning/introduction/about-secret-scanning). diff --git a/data/reusables/apps/app_manager_role.md b/data/reusables/apps/app_manager_role.md index 6ed6fbb17b24..7f247e60775a 100644 --- a/data/reusables/apps/app_manager_role.md +++ b/data/reusables/apps/app_manager_role.md @@ -1 +1 @@ -By default, only organization owners can manage the settings of GitHub Apps in an organization. To allow additional users to change the developer settings of GitHub Apps owned by the organization, an owner can grant them GitHub App manager permissions. GitHub App Managers can't manage third-party applications. For more information about adding and removing GitHub App managers in your organization, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#github-app-managers)." +By default, only organization owners can manage the settings of GitHub Apps in an organization. To allow additional users to change the developer settings of GitHub Apps owned by the organization, an owner can grant them GitHub App manager permissions. GitHub App Managers can't manage third-party applications. For more information about adding and removing GitHub App managers in your organization, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#github-app-managers). diff --git a/data/reusables/apps/best-practice-use-durable-id.md b/data/reusables/apps/best-practice-use-durable-id.md index bb0c864b8b73..868649453f45 100644 --- a/data/reusables/apps/best-practice-use-durable-id.md +++ b/data/reusables/apps/best-practice-use-durable-id.md @@ -1,6 +1,6 @@ When a user signs in and performs actions in your application, you have to remember which user took that action in order to grant them access to the same resources the next time they sign in. -To store users in your database correctly, always use the `id` of the user. This value will never change for the user or be used to point to a different user, so it ensures you are providing access to the user you intend. You can find a user's `id` with the `GET /user` REST API endpoint. See "[AUTOTITLE](/rest/users/users#get-a-user)." +To store users in your database correctly, always use the `id` of the user. This value will never change for the user or be used to point to a different user, so it ensures you are providing access to the user you intend. You can find a user's `id` with the `GET /user` REST API endpoint. See [AUTOTITLE](/rest/users/users#get-a-user). If you store references to repositories, organizations, and enterprises, use their `id` as well to ensure your links to them remain accurate. diff --git a/data/reusables/apps/best-practice-validate-org-access.md b/data/reusables/apps/best-practice-validate-org-access.md index 4bd622b3c668..3cbc9be01338 100644 --- a/data/reusables/apps/best-practice-validate-org-access.md +++ b/data/reusables/apps/best-practice-validate-org-access.md @@ -1 +1 @@ -When you use a user access token, you should track which organizations the token is authorized for. If an organization uses SAML SSO and a user has not performed SAML SSO, the user access token will not have access to that organization. You can use the `GET /user/installations` REST API endpoint to verify which organizations a user access token has access to. If the user is not authorized to access an organization, you should prevent their access to organization owned data within your own application until they perform SAML SSO. For more information, see "[AUTOTITLE](/rest/apps/installations#list-app-installations-accessible-to-the-user-access-token)." +When you use a user access token, you should track which organizations the token is authorized for. If an organization uses SAML SSO and a user has not performed SAML SSO, the user access token will not have access to that organization. You can use the `GET /user/installations` REST API endpoint to verify which organizations a user access token has access to. If the user is not authorized to access an organization, you should prevent their access to organization owned data within your own application until they perform SAML SSO. For more information, see [AUTOTITLE](/rest/apps/installations#list-app-installations-accessible-to-the-user-access-token). diff --git a/data/reusables/apps/general-apps-restrictions.md b/data/reusables/apps/general-apps-restrictions.md index 2749a11fca2b..12dcae31f6b3 100644 --- a/data/reusables/apps/general-apps-restrictions.md +++ b/data/reusables/apps/general-apps-restrictions.md @@ -1 +1 @@ -{% ifversion fpt or ghec %}If you are using your app with GitHub Actions and want to modify workflow files, you must authenticate on behalf of the user with an OAuth token that includes the `workflow` scope. The user must have admin or write permission to the repository that contains the workflow file. For more information, see "[AUTOTITLE](/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps#available-scopes)."{% endif %} +{% ifversion fpt or ghec %}If you are using your app with GitHub Actions and want to modify workflow files, you must authenticate on behalf of the user with an OAuth token that includes the `workflow` scope. The user must have admin or write permission to the repository that contains the workflow file. For more information, see [AUTOTITLE](/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps#available-scopes).{% endif %} diff --git a/data/reusables/apps/generate-installation-access-token.md b/data/reusables/apps/generate-installation-access-token.md index ead0d79c09f8..f7a8320d3406 100644 --- a/data/reusables/apps/generate-installation-access-token.md +++ b/data/reusables/apps/generate-installation-access-token.md @@ -1,11 +1,11 @@ -1. Generate a JSON web token (JWT) for your app. For more information, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-json-web-token-jwt-for-a-github-app)". +1. Generate a JSON web token (JWT) for your app. For more information, see [AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-json-web-token-jwt-for-a-github-app). 1. Get the ID of the installation that you want to authenticate as. If you are responding to a webhook event, the webhook payload will include the installation ID. - You can also use the REST API to find the ID for an installation of your app. For example, you can get an installation ID with the `GET /users/{username}/installation`, `GET /repos/{owner}/{repo}/installation`, `GET /orgs/{org}/installation`, or `GET /app/installations` endpoints. For more information, see "[AUTOTITLE](/rest/apps/apps)". + You can also use the REST API to find the ID for an installation of your app. For example, you can get an installation ID with the `GET /users/{username}/installation`, `GET /repos/{owner}/{repo}/installation`, `GET /orgs/{org}/installation`, or `GET /app/installations` endpoints. For more information, see [AUTOTITLE](/rest/apps/apps). - You can also find the app ID on the settings page for your app. The app ID is different from the client ID. For more information about navigating to the settings page for your {% data variables.product.prodname_github_app %}, see "[AUTOTITLE](/apps/maintaining-github-apps/modifying-a-github-app-registration#navigating-to-your-github-app-settings)". + You can also find the app ID on the settings page for your app. The app ID is different from the client ID. For more information about navigating to the settings page for your {% data variables.product.prodname_github_app %}, see [AUTOTITLE](/apps/maintaining-github-apps/modifying-a-github-app-registration#navigating-to-your-github-app-settings). 1. Send a REST API `POST` request to `/app/installations/INSTALLATION_ID/access_tokens`. Include your JSON web token in the `Authorization` header of your request. Replace `INSTALLATION_ID` with the ID of the installation that you want to authenticate as. @@ -27,7 +27,7 @@ The response will include an installation access token, the time that the token expires, the permissions that the token has, and the repositories that the token can access. The installation access token will expire after 1 hour. - For more information about this endpoint, see "[AUTOTITLE](/rest/apps/apps)". + For more information about this endpoint, see [AUTOTITLE](/rest/apps/apps). > [!NOTE] > {% data reusables.getting-started.bearer-vs-token %} diff --git a/data/reusables/apps/github-app-managers.md b/data/reusables/apps/github-app-managers.md index e9776b381072..7ac2be201651 100644 --- a/data/reusables/apps/github-app-managers.md +++ b/data/reusables/apps/github-app-managers.md @@ -1,3 +1,3 @@ -Organization owners can designate other users in their organization as {% data variables.product.prodname_github_app %} managers. {% data variables.product.prodname_github_app %} managers can manage the settings of some or all of the {% data variables.product.prodname_github_app %} registrations that are owned by the organization. The {% data variables.product.prodname_github_app %} manager role does not grant users access to install and uninstall {% data variables.product.prodname_github_apps %} on an organization. For more information about the specific app settings that a {% data variables.product.prodname_github_app %} manager can control, see "[AUTOTITLE](/apps/maintaining-github-apps/modifying-a-github-app)." +Organization owners can designate other users in their organization as {% data variables.product.prodname_github_app %} managers. {% data variables.product.prodname_github_app %} managers can manage the settings of some or all of the {% data variables.product.prodname_github_app %} registrations that are owned by the organization. The {% data variables.product.prodname_github_app %} manager role does not grant users access to install and uninstall {% data variables.product.prodname_github_apps %} on an organization. For more information about the specific app settings that a {% data variables.product.prodname_github_app %} manager can control, see [AUTOTITLE](/apps/maintaining-github-apps/modifying-a-github-app). -For more information about {% data variables.product.prodname_github_app %} manager permissions, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#github-app-managers)." +For more information about {% data variables.product.prodname_github_app %} manager permissions, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#github-app-managers). diff --git a/data/reusables/apps/github_app_auth_saml.md b/data/reusables/apps/github_app_auth_saml.md index c8ad5734c866..6d168ea726cd 100644 --- a/data/reusables/apps/github_app_auth_saml.md +++ b/data/reusables/apps/github_app_auth_saml.md @@ -1 +1 @@ -If a user reports that they cannot see resources owned by their organization after authorizing your {% data variables.product.prodname_github_app %} and the organization uses SAML SSO, instruct the user to start an active SAML session for their organization before reauthorizing. For more information, see {% ifversion ghec %}"[AUTOTITLE](/apps/using-github-apps/saml-and-github-apps)."{% else %}"[AUTOTITLE](/enterprise-cloud@latest/apps/using-github-apps/saml-and-github-apps)" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% endif %} +If a user reports that they cannot see resources owned by their organization after authorizing your {% data variables.product.prodname_github_app %} and the organization uses SAML SSO, instruct the user to start an active SAML session for their organization before reauthorizing. For more information, see {% ifversion ghec %}[AUTOTITLE](/apps/using-github-apps/saml-and-github-apps).{% else %}[AUTOTITLE](/enterprise-cloud@latest/apps/using-github-apps/saml-and-github-apps) in the {% data variables.product.prodname_ghe_cloud %} documentation.{% endif %} diff --git a/data/reusables/apps/github_app_install_saml.md b/data/reusables/apps/github_app_install_saml.md index a46766d46c93..e6d255472426 100644 --- a/data/reusables/apps/github_app_install_saml.md +++ b/data/reusables/apps/github_app_install_saml.md @@ -1 +1 @@ -If your organization uses SAML SSO and you do not see your organization listed, you may need to start an active SAML session for your organization. For more information, see "[AUTOTITLE](/apps/using-github-apps/saml-and-github-apps)." +If your organization uses SAML SSO and you do not see your organization listed, you may need to start an active SAML session for your organization. For more information, see [AUTOTITLE](/apps/using-github-apps/saml-and-github-apps). diff --git a/data/reusables/apps/install-vs-authorize.md b/data/reusables/apps/install-vs-authorize.md index be3f62f0cae3..5e81fdf30694 100644 --- a/data/reusables/apps/install-vs-authorize.md +++ b/data/reusables/apps/install-vs-authorize.md @@ -1,4 +1,4 @@ -When you **install** a {% data variables.product.prodname_github_app %} on your account or organization, you grant the app permission to access the organization and repository resources that it requested. You also specify which repositories the app can access. During the installation process, the {% data variables.product.prodname_github_app %} will indicate which repository and organization permissions you are granting. For more information about what different permissions enable a {% data variables.product.prodname_github_app %} to do, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/choosing-permissions-for-a-github-app)." +When you **install** a {% data variables.product.prodname_github_app %} on your account or organization, you grant the app permission to access the organization and repository resources that it requested. You also specify which repositories the app can access. During the installation process, the {% data variables.product.prodname_github_app %} will indicate which repository and organization permissions you are granting. For more information about what different permissions enable a {% data variables.product.prodname_github_app %} to do, see [AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/choosing-permissions-for-a-github-app). For example, you might grant the {% data variables.product.prodname_github_app %} permission to read repository metadata and write issues, and you might grant the {% data variables.product.prodname_github_app %} access to all of your repositories. diff --git a/data/reusables/apps/navigate-to-app-settings-this-article.md b/data/reusables/apps/navigate-to-app-settings-this-article.md index 21a78ef4767d..150356503f2f 100644 --- a/data/reusables/apps/navigate-to-app-settings-this-article.md +++ b/data/reusables/apps/navigate-to-app-settings-this-article.md @@ -1 +1 @@ -1. Navigate to the settings page for the app you'd like to modify. For more information, see "[Navigating to your {% data variables.product.prodname_github_app %} settings](#navigating-to-your-github-app-settings)" in this article. +1. Navigate to the settings page for the app you'd like to modify. For more information, see [Navigating to your {% data variables.product.prodname_github_app %} settings](#navigating-to-your-github-app-settings) in this article. diff --git a/data/reusables/apps/reauthorize-apps-saml.md b/data/reusables/apps/reauthorize-apps-saml.md index b45a130a008d..7f18a9ad877e 100644 --- a/data/reusables/apps/reauthorize-apps-saml.md +++ b/data/reusables/apps/reauthorize-apps-saml.md @@ -1 +1 @@ -After you enable SAML SSO, {% data variables.product.prodname_oauth_app %} and {% data variables.product.prodname_github_app %} authorizations may need to be revoked and reauthorized before they can access the organization. For more information, see "[AUTOTITLE](/apps/oauth-apps/using-oauth-apps/authorizing-oauth-apps#oauth-apps-and-organizations)." +After you enable SAML SSO, {% data variables.product.prodname_oauth_app %} and {% data variables.product.prodname_github_app %} authorizations may need to be revoked and reauthorized before they can access the organization. For more information, see [AUTOTITLE](/apps/oauth-apps/using-oauth-apps/authorizing-oauth-apps#oauth-apps-and-organizations). diff --git a/data/reusables/apps/web-app-flow-exchange-code.md b/data/reusables/apps/web-app-flow-exchange-code.md index 235d71a42fc3..23098943045e 100644 --- a/data/reusables/apps/web-app-flow-exchange-code.md +++ b/data/reusables/apps/web-app-flow-exchange-code.md @@ -2,7 +2,7 @@ Query parameter | Type | Description -----|------|------------ - `client_id` | `string` | **Required.** The client ID for your {% data variables.product.prodname_github_app %}. The client ID is different from the app ID. You can find the client ID on the settings page for your app. For more information about navigating to the settings page for your {% data variables.product.prodname_github_app %}, see "[AUTOTITLE](/apps/maintaining-github-apps/modifying-a-github-app-registration#navigating-to-your-github-app-settings)." + `client_id` | `string` | **Required.** The client ID for your {% data variables.product.prodname_github_app %}. The client ID is different from the app ID. You can find the client ID on the settings page for your app. For more information about navigating to the settings page for your {% data variables.product.prodname_github_app %}, see [AUTOTITLE](/apps/maintaining-github-apps/modifying-a-github-app-registration#navigating-to-your-github-app-settings). `client_secret` | `string` | **Required.** The client secret for your {% data variables.product.prodname_github_app %}. You can generate a client secret on the settings page for your app. `code` | `string` | **Required.** The code you received in the previous step. `redirect_uri` | `string` | The URL in your application where users will be sent after authorization. This must be an exact match to one of the URLs you provided as a "Callback URL" when setting up your {% data variables.product.prodname_github_app %} and can't contain any additional parameters. diff --git a/data/reusables/audit_log/audit-log-action-categories.md b/data/reusables/audit_log/audit-log-action-categories.md index 3ca3a35db895..b659012a77ac 100644 --- a/data/reusables/audit_log/audit-log-action-categories.md +++ b/data/reusables/audit_log/audit-log-action-categories.md @@ -2,7 +2,7 @@ |------------------|-------------------| | {% ifversion fpt or ghec %} | | `account` | Contains activities related to an organization account. | -| `advisory_credit` | Contains activities related to crediting a contributor for a security advisory in the {% data variables.product.prodname_advisory_database %}. For more information, see "[AUTOTITLE](/code-security/security-advisories/working-with-repository-security-advisories/about-repository-security-advisories)." | +| `advisory_credit` | Contains activities related to crediting a contributor for a security advisory in the {% data variables.product.prodname_advisory_database %}. For more information, see [AUTOTITLE](/code-security/security-advisories/working-with-repository-security-advisories/about-repository-security-advisories). | | {% endif %} | | `artifact` | Contains activities related to {% data variables.product.prodname_actions %} workflow run artifacts. | | {% ifversion audit-log-streaming %} | @@ -15,21 +15,21 @@ | `business` | Contains activities related to business settings for an enterprise. | | {% endif %} | | {% ifversion code-security-audit-log-events %} | -| `business_advanced_security` | Contains activities related to {% data variables.product.prodname_GH_advanced_security %} in an enterprise. For more information, see "[AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise)." | -| `business_secret_scanning` | Contains activities related to {% data variables.product.prodname_secret_scanning %} in an enterprise. For more information, see "[AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise)." | +| `business_advanced_security` | Contains activities related to {% data variables.product.prodname_GH_advanced_security %} in an enterprise. For more information, see [AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise). | +| `business_secret_scanning` | Contains activities related to {% data variables.product.prodname_secret_scanning %} in an enterprise. For more information, see [AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise). | | {% endif %} | | {% ifversion secret-scanning-validity-check-audit-log %} | -| `business_secret_scanning_automatic_validity_checks` | Contains activities related to enabling or disabling automatic validity checks for {% data variables.product.prodname_secret_scanning %} in an enterprise. For more information, see "[AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise#managing-advanced-security-features)." | +| `business_secret_scanning_automatic_validity_checks` | Contains activities related to enabling or disabling automatic validity checks for {% data variables.product.prodname_secret_scanning %} in an enterprise. For more information, see [AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise#managing-advanced-security-features). | | {% endif %} | | {% ifversion secret-scanning-audit-log-custom-patterns %} | | `business_secret_scanning_custom_pattern` | Contains activities related to custom patterns for {% data variables.product.prodname_secret_scanning %} in an enterprise. | | {% endif %} | | {% ifversion secret-scanning-custom-pattern-push-protection-audit %} | -| `business_secret_scanning_custom_pattern_push_protection` | Contains activities related to push protection of a custom pattern for {% data variables.product.prodname_secret_scanning %} in an enterprise. For more information, see "[AUTOTITLE](/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-an-enterprise-account)." | +| `business_secret_scanning_custom_pattern_push_protection` | Contains activities related to push protection of a custom pattern for {% data variables.product.prodname_secret_scanning %} in an enterprise. For more information, see [AUTOTITLE](/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-an-enterprise-account). | | {% endif %} | | {% ifversion code-security-audit-log-events %} | -| `business_secret_scanning_push_protection` | Contains activities related to the push protection feature of {% data variables.product.prodname_secret_scanning %} in an enterprise. For more information, see "[AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise)." | -| `business_secret_scanning_push_protection_custom_message` | Contains activities related to the custom message displayed when push protection is triggered in an enterprise. For more information, see "[AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise)." | +| `business_secret_scanning_push_protection` | Contains activities related to the push protection feature of {% data variables.product.prodname_secret_scanning %} in an enterprise. For more information, see [AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise). | +| `business_secret_scanning_push_protection_custom_message` | Contains activities related to the custom message displayed when push protection is triggered in an enterprise. For more information, see [AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise). | | {% endif %} | | `checks` | Contains activities related to check suites and runs. | | {% ifversion fpt or ghec %} | @@ -39,12 +39,12 @@ | {% ifversion ghes %} | | `config_entry` | Contains activities related to configuration settings. These events are only visible in the site admin audit log. | | {% endif %} | -| `dependabot_alerts` | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot_alerts %} in existing repositories. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." | +| `dependabot_alerts` | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot_alerts %} in existing repositories. For more information, see [AUTOTITLE](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts). | | `dependabot_alerts_new_repos` | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot_alerts %} in new repositories created in the organization. | | `dependabot_repository_access` | Contains activities related to which private repositories in an organization {% data variables.product.prodname_dependabot %} is allowed to access. | -| `dependabot_security_updates` | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot_security_updates %} in existing repositories. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates)." | +| `dependabot_security_updates` | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot_security_updates %} in existing repositories. For more information, see [AUTOTITLE](/code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates). | | `dependabot_security_updates_new_repos` | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot_security_updates %} for new repositories created in the organization. | -| `dependency_graph` | Contains organization-level configuration activities for dependency graphs for repositories. For more information, see "[AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph)." | +| `dependency_graph` | Contains organization-level configuration activities for dependency graphs for repositories. For more information, see [AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph). | | `dependency_graph_new_repos` | Contains organization-level configuration activities for new repositories created in the organization. | | {% ifversion ghec or ghes %} | | `dotcom_connection` | Contains activities related to {% data variables.product.prodname_github_connect %}. | @@ -72,7 +72,7 @@ | `marketplace_agreement_signature` | Contains activities related to signing the {% data variables.product.prodname_marketplace %} Developer Agreement. | | `marketplace_listing` | Contains activities related to listing apps in {% data variables.product.prodname_marketplace %}. | | {% endif %} | -| `members_can_create_pages` | Contains activities related to managing the publication of {% data variables.product.prodname_pages %} sites for repositories in the organization. For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization)." | +| `members_can_create_pages` | Contains activities related to managing the publication of {% data variables.product.prodname_pages %} sites for repositories in the organization. For more information, see [AUTOTITLE](/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization). | | `members_can_create_private_pages` | Contains activities related to managing the publication of private {% data variables.product.prodname_pages %} sites for repositories in the organization. | | `members_can_create_public_pages` | Contains activities related to managing the publication of public {% data variables.product.prodname_pages %} sites for repositories in the organization. | | {% ifversion ghec or ghes %} | @@ -92,10 +92,10 @@ | `org_credential_authorization` | Contains activities related to authorizing credentials for use with SAML single sign-on. | | {% endif %} | | {% ifversion secret-scanning-validity-check-audit-log %} | -| `org_secret_scanning_automatic_validity_checks` | Contains activities related to enabling or disabling automatic validity checks for {% data variables.product.prodname_secret_scanning %} in an organization. For more information, see "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#allowing-validity-checks-for-partner-patterns-in-an-organization)." | +| `org_secret_scanning_automatic_validity_checks` | Contains activities related to enabling or disabling automatic validity checks for {% data variables.product.prodname_secret_scanning %} in an organization. For more information, see [AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#allowing-validity-checks-for-partner-patterns-in-an-organization). | | {% endif %} | | {% ifversion secret-scanning-audit-log-custom-patterns %} | -| `org_secret_scanning_custom_pattern` | Contains activities related to custom patterns for {% data variables.product.prodname_secret_scanning %} in an organization. For more information, see "[AUTOTITLE](/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning)." | +| `org_secret_scanning_custom_pattern` | Contains activities related to custom patterns for {% data variables.product.prodname_secret_scanning %} in an organization. For more information, see [AUTOTITLE](/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning). | | {% endif %} | | `organization_default_label` | Contains activities related to default labels for repositories in an organization. | | `organization_domain` | Contains activities related to verified organization domains. | @@ -126,27 +126,27 @@ | `pull_request_review_comment` | Contains activities related to pull request review comments. | | `repo` | Contains activities related to the repositories owned by an organization. | | {% ifversion fpt or ghec %} | -| `repository_advisory` | Contains repository-level activities related to security advisories in the {% data variables.product.prodname_advisory_database %}. For more information, see "[AUTOTITLE](/code-security/security-advisories/working-with-repository-security-advisories/about-repository-security-advisories)." | -| `repository_content_analysis` | Contains activities related to enabling or disabling data use for a private repository. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#enabling-or-disabling-security-and-analysis-features-for-private-repositories)." | -| `repository_dependency_graph` | Contains repository-level activities related to enabling or disabling the dependency graph for a {% ifversion fpt or ghec %}private {% endif %}repository. For more information, see "[AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph)." | +| `repository_advisory` | Contains repository-level activities related to security advisories in the {% data variables.product.prodname_advisory_database %}. For more information, see [AUTOTITLE](/code-security/security-advisories/working-with-repository-security-advisories/about-repository-security-advisories). | +| `repository_content_analysis` | Contains activities related to enabling or disabling data use for a private repository. For more information, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#enabling-or-disabling-security-and-analysis-features-for-private-repositories). | +| `repository_dependency_graph` | Contains repository-level activities related to enabling or disabling the dependency graph for a {% ifversion fpt or ghec %}private {% endif %}repository. For more information, see [AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph). | | {% endif %} | | `repository_image` | Contains activities related to images for a repository. | | `repository_invitation` | Contains activities related to invitations to join a repository. | | `repository_projects_change` | Contains activities related to enabling projects for a repository or for all repositories in an organization. | | {% ifversion ghec or ghes %} | -| `repository_secret_scanning` | Contains repository-level activities related to {% data variables.product.prodname_secret_scanning %}. For more information, see "[AUTOTITLE](/code-security/secret-scanning/introduction/about-secret-scanning)." | +| `repository_secret_scanning` | Contains repository-level activities related to {% data variables.product.prodname_secret_scanning %}. For more information, see [AUTOTITLE](/code-security/secret-scanning/introduction/about-secret-scanning). | | {% endif %} | | {% ifversion secret-scanning-validity-check-audit-log %} | -| `repository_secret_scanning_automatic_validity_checks` | Contains activities related to enabling or disabling automatic validity checks for {% data variables.product.prodname_secret_scanning %} in a repository. For more information, see "[AUTOTITLE](/code-security/secret-scanning/enabling-secret-scanning-features/enabling-secret-scanning-for-your-repository)." | +| `repository_secret_scanning_automatic_validity_checks` | Contains activities related to enabling or disabling automatic validity checks for {% data variables.product.prodname_secret_scanning %} in a repository. For more information, see [AUTOTITLE](/code-security/secret-scanning/enabling-secret-scanning-features/enabling-secret-scanning-for-your-repository). | | {% endif %} | | {% ifversion secret-scanning-audit-log-custom-patterns %} | -| `repository_secret_scanning_custom_pattern` | Contains activities related to {% data variables.product.prodname_secret_scanning %} custom patterns in a repository. For more information, see "[AUTOTITLE](/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning)." | +| `repository_secret_scanning_custom_pattern` | Contains activities related to {% data variables.product.prodname_secret_scanning %} custom patterns in a repository. For more information, see [AUTOTITLE](/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning). | | {% endif %} | | {% ifversion secret-scanning-custom-pattern-push-protection-audit %} | -| `repository_secret_scanning_custom_pattern_push_protection` | Contains activities related to push protection of a custom pattern for {% data variables.product.prodname_secret_scanning %} in a repository. For more information, see "[AUTOTITLE](/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-a-repository)." | +| `repository_secret_scanning_custom_pattern_push_protection` | Contains activities related to push protection of a custom pattern for {% data variables.product.prodname_secret_scanning %} in a repository. For more information, see [AUTOTITLE](/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-a-repository). | | {% endif %} | | {% ifversion secret-scanning-audit-log-custom-patterns %} -| `repository_secret_scanning_push_protection` | Contains activities related to the push protection feature of {% data variables.product.prodname_secret_scanning %} in a repository. For more information, see "[AUTOTITLE](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." | +| `repository_secret_scanning_push_protection` | Contains activities related to the push protection feature of {% data variables.product.prodname_secret_scanning %} in a repository. For more information, see [AUTOTITLE](/code-security/secret-scanning/protecting-pushes-with-secret-scanning). | | {% endif %} | | {% ifversion fpt or ghec %} | | `repository_visibility_change` | Contains activities related to allowing organization members to change repository visibilities for the organization. | @@ -163,21 +163,21 @@ | `role` | Contains activities related to [custom repository roles](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-custom-repository-roles-for-an-organization). | | {% endif %} | | {% ifversion ghec or ghes %} | -| `secret_scanning` | Contains organization-level configuration activities for {% data variables.product.prodname_secret_scanning %} in existing repositories. For more information, see "[AUTOTITLE](/code-security/secret-scanning/introduction/about-secret-scanning)." | +| `secret_scanning` | Contains organization-level configuration activities for {% data variables.product.prodname_secret_scanning %} in existing repositories. For more information, see [AUTOTITLE](/code-security/secret-scanning/introduction/about-secret-scanning). | | `secret_scanning_new_repos` | Contains organization-level configuration activities for {% data variables.product.prodname_secret_scanning %} for new repositories created in the organization. | | {% endif %} | | {% ifversion ghec or ghes %} | | `security_key` | Contains activities related to security keys registration and removal. | | {% endif %} | | {% ifversion fpt or ghec %} | -| `sponsors` | Contains events related to sponsor buttons (see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository)"). | +| `sponsors` | Contains events related to sponsor buttons (see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository)). | | {% endif %} | | {% ifversion ghec or ghes %} | | `ssh_certificate_authority` | Contains activities related to a SSH certificate authority in an organization or enterprise. | | `ssh_certificate_requirement` | Contains activities related to requiring members use SSH certificates to access organization resources. | | {% endif %} | | {% ifversion sso-redirect %} | -| `sso_redirect` | Contains activities related to automatically redirecting users to sign in (see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise#managing-sso-for-unauthenticated-users)"). +| `sso_redirect` | Contains activities related to automatically redirecting users to sign in (see [AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise#managing-sso-for-unauthenticated-users)). | {% endif %} | | `staff` | Contains activities related to a site admin performing an action. | | `team` | Contains activities related to teams in an organization.{% ifversion team-discussions %} | diff --git a/data/reusables/audit_log/audit-log-search.md b/data/reusables/audit_log/audit-log-search.md index 21b12fd61dac..c4a0fbac3ab2 100644 --- a/data/reusables/audit_log/audit-log-search.md +++ b/data/reusables/audit_log/audit-log-search.md @@ -1,6 +1,6 @@ {% data reusables.audit_log.audit-log-search-list-info-about-action %} -Note that you cannot search for entries using text. You can, however, construct search queries using a variety of filters. Many operators used when querying the log, such as `-`, `>`, or `<`, match the same format as searching across {% data variables.product.product_name %}. For more information, see "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/about-searching-on-github)." +Note that you cannot search for entries using text. You can, however, construct search queries using a variety of filters. Many operators used when querying the log, such as `-`, `>`, or `<`, match the same format as searching across {% data variables.product.product_name %}. For more information, see [AUTOTITLE](/search-github/getting-started-with-searching-on-github/about-searching-on-github). {% data reusables.audit_log.audit-log-search-by-operation %} diff --git a/data/reusables/audit_log/only-three-months-displayed.md b/data/reusables/audit_log/only-three-months-displayed.md index baf8a184de48..82af0065c6cc 100644 --- a/data/reusables/audit_log/only-three-months-displayed.md +++ b/data/reusables/audit_log/only-three-months-displayed.md @@ -1 +1 @@ -By default, only events from the past three months are displayed. To view older events, you must specify a date range with the `created` parameter. See "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." +By default, only events from the past three months are displayed. To view older events, you must specify a date range with the `created` parameter. See [AUTOTITLE](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates). diff --git a/data/reusables/audit_log/retention-periods.md b/data/reusables/audit_log/retention-periods.md index c4bcb79fe921..56142efb7f69 100644 --- a/data/reusables/audit_log/retention-periods.md +++ b/data/reusables/audit_log/retention-periods.md @@ -1,3 +1,3 @@ -The audit log lists events triggered by activities that affect your enterprise{% ifversion not ghec %}. Audit logs for {% data variables.product.product_name %} are retained indefinitely{% ifversion audit-data-retention-tab %}, unless an enterprise owner configured a different retention period. See "[AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/configuring-the-audit-log-for-your-enterprise)."{% else %}.{% endif %}{% else %} within the last 180 days. {% data reusables.audit_log.git-events-retention-period %}{% endif %} +The audit log lists events triggered by activities that affect your enterprise{% ifversion not ghec %}. Audit logs for {% data variables.product.product_name %} are retained indefinitely{% ifversion audit-data-retention-tab %}, unless an enterprise owner configured a different retention period. See [AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/configuring-the-audit-log-for-your-enterprise).{% else %}.{% endif %}{% else %} within the last 180 days. {% data reusables.audit_log.git-events-retention-period %}{% endif %} {% data reusables.audit_log.only-three-months-displayed %} diff --git a/data/reusables/audit_log/users-agree-to-ip-collection.md b/data/reusables/audit_log/users-agree-to-ip-collection.md index 5eaeca540227..5b667342445e 100644 --- a/data/reusables/audit_log/users-agree-to-ip-collection.md +++ b/data/reusables/audit_log/users-agree-to-ip-collection.md @@ -1 +1 @@ -When anyone creates an account on {% data variables.product.github %}, the person agrees to {% data variables.product.company_short %}'s collection of basic information about connections to {% data variables.product.company_short %}'s services, including source IP address. For more information, see "[AUTOTITLE](/free-pro-team@latest/site-policy/privacy-policies/github-privacy-statement#usage-information)." +When anyone creates an account on {% data variables.product.github %}, the person agrees to {% data variables.product.company_short %}'s collection of basic information about connections to {% data variables.product.company_short %}'s services, including source IP address. For more information, see [AUTOTITLE](/free-pro-team@latest/site-policy/privacy-policies/github-privacy-statement#usage-information). diff --git a/data/reusables/billing/billing-info.md b/data/reusables/billing/billing-info.md index 3b18cfcd5e98..5cac8188727f 100644 --- a/data/reusables/billing/billing-info.md +++ b/data/reusables/billing/billing-info.md @@ -1 +1 @@ -For more information about billing in general, like adding a payment method or viewing your payment history, see "[AUTOTITLE](/billing/managing-your-github-billing-settings)." +For more information about billing in general, like adding a payment method or viewing your payment history, see [AUTOTITLE](/billing/managing-your-github-billing-settings). diff --git a/data/reusables/billing/enhanced-billing-platform-licenses.md b/data/reusables/billing/enhanced-billing-platform-licenses.md index a2644ab302b3..51b4c06003c9 100644 --- a/data/reusables/billing/enhanced-billing-platform-licenses.md +++ b/data/reusables/billing/enhanced-billing-platform-licenses.md @@ -1,3 +1,3 @@ >[!NOTE] Enterprise accounts, and organizations owned by enterprise accounts, created after June 2, 2024, have access to the enhanced billing platform. Enterprises that participated in the {% data variables.release-phases.public_preview %} program also have access to the enhanced billing platform. > -> The page to view license usage has moved in the enhanced billing platform. See "[AUTOTITLE](/billing/using-the-new-billing-platform/gathering-insights-on-your-spending#viewing-license-usage)." +> The page to view license usage has moved in the enhanced billing platform. See [AUTOTITLE](/billing/using-the-new-billing-platform/gathering-insights-on-your-spending#viewing-license-usage). diff --git a/data/reusables/billing/enhanced-billing-platform.md b/data/reusables/billing/enhanced-billing-platform.md index 994d7fcd8a10..1f63f6644e05 100644 --- a/data/reusables/billing/enhanced-billing-platform.md +++ b/data/reusables/billing/enhanced-billing-platform.md @@ -1,3 +1,3 @@ >[!NOTE] {% ifversion fpt %}Organization accounts, created after November 13, 2024 on a {% data variables.product.prodname_team %} plan, have access to the enhanced billing platform.{% elsif ghec %}Enterprise accounts, and organizations owned by enterprise accounts, created after June 2, 2024, have access to the enhanced billing platform. Enterprises that participated in the {% data variables.release-phases.public_preview %} program also have access to the enhanced billing platform.{% endif %} > -> The enhanced billing platform offers better spending control and detailed visibility to help you understand your usage with more granular controls. See "[AUTOTITLE](/billing/using-the-new-billing-platform)." +> The enhanced billing platform offers better spending control and detailed visibility to help you understand your usage with more granular controls. See [AUTOTITLE](/billing/using-the-new-billing-platform). diff --git a/data/reusables/billing/ghas-metered-billing-note-with-link.md b/data/reusables/billing/ghas-metered-billing-note-with-link.md index c0ee5a520e86..9167364e9113 100644 --- a/data/reusables/billing/ghas-metered-billing-note-with-link.md +++ b/data/reusables/billing/ghas-metered-billing-note-with-link.md @@ -1 +1 @@ -If you started a free trial of {% data variables.product.prodname_GH_advanced_security %} during your {% data variables.product.prodname_ghe_cloud %} trial on or after August 1, 2024, your billing for {% data variables.product.prodname_GH_advanced_security %} will be usage-based. See, "[AUTOTITLE](/billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security#metered-billing-for-github-advanced-security)." +If you started a free trial of {% data variables.product.prodname_GH_advanced_security %} during your {% data variables.product.prodname_ghe_cloud %} trial on or after August 1, 2024, your billing for {% data variables.product.prodname_GH_advanced_security %} will be usage-based. See, [AUTOTITLE](/billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security#metered-billing-for-github-advanced-security). diff --git a/data/reusables/billing/us-sales-tax.md b/data/reusables/billing/us-sales-tax.md index c433a548d9ab..0800df1988b9 100644 --- a/data/reusables/billing/us-sales-tax.md +++ b/data/reusables/billing/us-sales-tax.md @@ -1 +1 @@ -If you're a customer in the United States and you're exempt from sales tax, you will need to upload a sales tax exemption certificate to your account. See "[AUTOTITLE](/billing/managing-your-github-billing-settings/adding-a-sales-tax-certificate)." +If you're a customer in the United States and you're exempt from sales tax, you will need to upload a sales tax exemption certificate to your account. See [AUTOTITLE](/billing/managing-your-github-billing-settings/adding-a-sales-tax-certificate). diff --git a/data/reusables/billing/usage-based-billing.md b/data/reusables/billing/usage-based-billing.md index 24b3b4f38d8e..714714ac521a 100644 --- a/data/reusables/billing/usage-based-billing.md +++ b/data/reusables/billing/usage-based-billing.md @@ -1,3 +1,3 @@ -If you created a trial of {% data variables.product.prodname_ghe_cloud %} on or after August 1, 2024, you use usage-based billing to pay for your licenses. With usage-based billing, you pay for the number of licenses you use each month. You do not need to buy a predefined number of licenses in advance. See, "[AUTOTITLE](/billing/using-the-enhanced-billing-platform-for-enterprises/about-usage-based-billing-for-licenses)." +If you created a trial of {% data variables.product.prodname_ghe_cloud %} on or after August 1, 2024, you use usage-based billing to pay for your licenses. With usage-based billing, you pay for the number of licenses you use each month. You do not need to buy a predefined number of licenses in advance. See, [AUTOTITLE](/billing/using-the-enhanced-billing-platform-for-enterprises/about-usage-based-billing-for-licenses). -> [!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). diff --git a/data/reusables/branches/change-default-branch.md b/data/reusables/branches/change-default-branch.md index 5c696d36c1b1..9c26f48d255b 100644 --- a/data/reusables/branches/change-default-branch.md +++ b/data/reusables/branches/change-default-branch.md @@ -1 +1 @@ -You can change the default branch for an existing repository. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/changing-the-default-branch)." +You can change the default branch for an existing repository. For more information, see [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/changing-the-default-branch). diff --git a/data/reusables/branches/set-default-branch.md b/data/reusables/branches/set-default-branch.md index 6e3897534dd1..7e5c55f0eb6b 100644 --- a/data/reusables/branches/set-default-branch.md +++ b/data/reusables/branches/set-default-branch.md @@ -1 +1 @@ -You can set the name of the default branch for new repositories. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-the-default-branch-name-for-your-repositories)," "[AUTOTITLE](/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization)," and "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-on-the-default-branch-name)." +You can set the name of the default branch for new repositories. For more information, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-the-default-branch-name-for-your-repositories), [AUTOTITLE](/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization), and [AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-on-the-default-branch-name). diff --git a/data/reusables/classroom/about-feedback-pull-requests.md b/data/reusables/classroom/about-feedback-pull-requests.md index 8990991c2829..db228cb1f582 100644 --- a/data/reusables/classroom/about-feedback-pull-requests.md +++ b/data/reusables/classroom/about-feedback-pull-requests.md @@ -1 +1 @@ -Optionally, you can enable feedback pull requests on assignments. If you enable this feature for an assignment, {% data variables.product.prodname_classroom %} creates a special pull request titled **Feedback** in the assignment repository for each student or group. For more information, see "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/leave-feedback-with-pull-requests)." +Optionally, you can enable feedback pull requests on assignments. If you enable this feature for an assignment, {% data variables.product.prodname_classroom %} creates a special pull request titled **Feedback** in the assignment repository for each student or group. For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/leave-feedback-with-pull-requests). diff --git a/data/reusables/classroom/about-ide-integration.md b/data/reusables/classroom/about-ide-integration.md index b62d5c930558..1b921b481662 100644 --- a/data/reusables/classroom/about-ide-integration.md +++ b/data/reusables/classroom/about-ide-integration.md @@ -1 +1 @@ -You can integrate a classroom with an IDE. Students can make changes to their assignment repositories through the IDE, or by checking out and running code locally with the appropriate software. For more information, see "[AUTOTITLE](/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/integrate-github-classroom-with-an-ide)." +You can integrate a classroom with an IDE. Students can make changes to their assignment repositories through the IDE, or by checking out and running code locally with the appropriate software. For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/integrate-github-classroom-with-an-ide). diff --git a/data/reusables/classroom/assignments-classroom-prerequisite.md b/data/reusables/classroom/assignments-classroom-prerequisite.md index 11d8e3ed2fc3..a06a6bab014d 100644 --- a/data/reusables/classroom/assignments-classroom-prerequisite.md +++ b/data/reusables/classroom/assignments-classroom-prerequisite.md @@ -1 +1 @@ -You must create a classroom before you can create an assignment. For more information, see "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms)." +You must create a classroom before you can create an assignment. For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms). diff --git a/data/reusables/classroom/assignments-guide-make-cutoff-date.md b/data/reusables/classroom/assignments-guide-make-cutoff-date.md index d6948c9962b7..df236d865019 100644 --- a/data/reusables/classroom/assignments-guide-make-cutoff-date.md +++ b/data/reusables/classroom/assignments-guide-make-cutoff-date.md @@ -1 +1 @@ -Optionally, to make the deadline a cutoff date, select **This is a cutoff date**. If you use a cutoff date, students will lose write access to their assignment repositories after the cutoff date has passed unless they receive an extension. For more information on extending assignment deadlines, see "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/extending-an-assignments-deadline-for-an-individual-or-group)." +Optionally, to make the deadline a cutoff date, select **This is a cutoff date**. If you use a cutoff date, students will lose write access to their assignment repositories after the cutoff date has passed unless they receive an extension. For more information on extending assignment deadlines, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/extending-an-assignments-deadline-for-an-individual-or-group). diff --git a/data/reusables/classroom/assignments-guide-protected-paths.md b/data/reusables/classroom/assignments-guide-protected-paths.md index 3fd5a300db0c..8073e7af01fd 100644 --- a/data/reusables/classroom/assignments-guide-protected-paths.md +++ b/data/reusables/classroom/assignments-guide-protected-paths.md @@ -1,4 +1,4 @@ -If your assignment has files or directories that are used in the grading process or otherwise shouldn't be edited by students, you can designate them as protected file paths. If a student edits a protected file, a label will be applied to their submission on the assignment overview page for you to investigate. For more information, see "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/monitor-students-progress-with-the-assignment-overview-page)." +If your assignment has files or directories that are used in the grading process or otherwise shouldn't be edited by students, you can designate them as protected file paths. If a student edits a protected file, a label will be applied to their submission on the assignment overview page for you to investigate. For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/monitor-students-progress-with-the-assignment-overview-page). The patterns for protected paths follow rules similar to shell filename globs. It may contain the following meta-characters: diff --git a/data/reusables/classroom/assignments-guide-using-autograding.md b/data/reusables/classroom/assignments-guide-using-autograding.md index db3b00440678..1d3b83854822 100644 --- a/data/reusables/classroom/assignments-guide-using-autograding.md +++ b/data/reusables/classroom/assignments-guide-using-autograding.md @@ -1,6 +1,6 @@ -{% data reusables.classroom.about-autograding %} For more information, see "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-autograding)." +{% data reusables.classroom.about-autograding %} For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-autograding). -{% data reusables.classroom.use-add-test-drop-down-to-click-grading-method %} For more information, see "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-autograding#grading-methods)." +{% data reusables.classroom.use-add-test-drop-down-to-click-grading-method %} For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-autograding#grading-methods). Define the parameters of your test case, like the name, commands, inputs, outputs, timeout, and points. When you're done, click **Save test case**. diff --git a/data/reusables/classroom/assignments-repository-visibility-and-permissions.md b/data/reusables/classroom/assignments-repository-visibility-and-permissions.md index b19b4af8068b..2af8192ddfda 100644 --- a/data/reusables/classroom/assignments-repository-visibility-and-permissions.md +++ b/data/reusables/classroom/assignments-repository-visibility-and-permissions.md @@ -1,3 +1,3 @@ The repositories for an assignment can be public or private. If you use private repositories, only the student or team can see the feedback you provide. -You can also decide whether to grant students admin permissions to the repository for an assignment. Grant admin permissions if the student should be able to perform administrative tasks for the assignment repository. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)" and "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization)." +You can also decide whether to grant students admin permissions to the repository for an assignment. Grant admin permissions if the student should be able to perform administrative tasks for the assignment repository. For more information, see [AUTOTITLE](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility) and [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization). diff --git a/data/reusables/classroom/classroom-admins-link.md b/data/reusables/classroom/classroom-admins-link.md index 6dcbe627660c..687460525ab0 100644 --- a/data/reusables/classroom/classroom-admins-link.md +++ b/data/reusables/classroom/classroom-admins-link.md @@ -1 +1 @@ -For more information on classroom admins, see "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms#about-management-of-classrooms)." +For more information on classroom admins, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms#about-management-of-classrooms). diff --git a/data/reusables/classroom/classroom-codespaces-link.md b/data/reusables/classroom/classroom-codespaces-link.md index 03cfb08ab3e4..43c1f4288162 100644 --- a/data/reusables/classroom/classroom-codespaces-link.md +++ b/data/reusables/classroom/classroom-codespaces-link.md @@ -1 +1 @@ -You can choose to configure an assignment with {% data variables.product.prodname_github_codespaces %} to give students access to a browser-based {% data variables.product.prodname_vscode %} environment with one-click setup. For more information, see "[AUTOTITLE](/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom)." +You can choose to configure an assignment with {% data variables.product.prodname_github_codespaces %} to give students access to a browser-based {% data variables.product.prodname_vscode %} environment with one-click setup. For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom). diff --git a/data/reusables/classroom/for-more-information-about-assignment-creation.md b/data/reusables/classroom/for-more-information-about-assignment-creation.md index c0be945b3c52..0f8131ccf27e 100644 --- a/data/reusables/classroom/for-more-information-about-assignment-creation.md +++ b/data/reusables/classroom/for-more-information-about-assignment-creation.md @@ -1 +1 @@ -For more information, see "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment)" or "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment)." +For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment) or [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment). diff --git a/data/reusables/classroom/google-classroom-note.md b/data/reusables/classroom/google-classroom-note.md index 501c72c73bec..e60c139203ce 100644 --- a/data/reusables/classroom/google-classroom-note.md +++ b/data/reusables/classroom/google-classroom-note.md @@ -1 +1 @@ -Google Classroom does not use the LTI protocol, so does not need to be connected to GitHub Classroom before importing the roster. For more information, see "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom#importing-a-roster-from-google-classroom)." +Google Classroom does not use the LTI protocol, so does not need to be connected to GitHub Classroom before importing the roster. For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom#importing-a-roster-from-google-classroom). diff --git a/data/reusables/classroom/guide-create-new-classroom.md b/data/reusables/classroom/guide-create-new-classroom.md index f2507897ea63..5bad90c3a124 100644 --- a/data/reusables/classroom/guide-create-new-classroom.md +++ b/data/reusables/classroom/guide-create-new-classroom.md @@ -1,3 +1,3 @@ -1. In the list of organizations, click the organization you'd like to use for your classroom. Optionally, you can create a new organization. For more information, see "[AUTOTITLE](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)." +1. In the list of organizations, click the organization you'd like to use for your classroom. Optionally, you can create a new organization. For more information, see [AUTOTITLE](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch). 1. Under "Classroom name", type the name for your classroom. 1. Click **Create classroom**. diff --git a/data/reusables/classroom/link-to-assignment-overview-article.md b/data/reusables/classroom/link-to-assignment-overview-article.md index 4fcb6337909e..42ee9e1e505f 100644 --- a/data/reusables/classroom/link-to-assignment-overview-article.md +++ b/data/reusables/classroom/link-to-assignment-overview-article.md @@ -1 +1 @@ -The assignment overview page provides an overview of your assignment acceptances and student progress. For more information on viewing and using the assignment overview page, see "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/monitor-students-progress-with-the-assignment-overview-page)." +The assignment overview page provides an overview of your assignment acceptances and student progress. For more information on viewing and using the assignment overview page, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/monitor-students-progress-with-the-assignment-overview-page). diff --git a/data/reusables/classroom/reuse-assignment-link.md b/data/reusables/classroom/reuse-assignment-link.md index 3fcd2adf1f05..e04763ca669e 100644 --- a/data/reusables/classroom/reuse-assignment-link.md +++ b/data/reusables/classroom/reuse-assignment-link.md @@ -1 +1 @@ -You can reuse existing assignments in any other classroom you have admin access to, including classrooms in a different organization. For more information, see "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/reuse-an-assignment)." +You can reuse existing assignments in any other classroom you have admin access to, including classrooms in a different organization. For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/reuse-an-assignment). diff --git a/data/reusables/classroom/you-can-choose-a-template-repository.md b/data/reusables/classroom/you-can-choose-a-template-repository.md index 9d0a80a9f07f..3f74c6914e6e 100644 --- a/data/reusables/classroom/you-can-choose-a-template-repository.md +++ b/data/reusables/classroom/you-can-choose-a-template-repository.md @@ -1,4 +1,4 @@ -You can optionally choose a template repository as starter code for the assignment. For more information, see "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-assignment-from-a-template-repository)." +You can optionally choose a template repository as starter code for the assignment. For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-assignment-from-a-template-repository). > [!NOTE] > The template repository must belong to your organization or be a public repository on {% data variables.product.product_name %}. diff --git a/data/reusables/classroom/you-can-create-a-pull-request-for-feedback.md b/data/reusables/classroom/you-can-create-a-pull-request-for-feedback.md index a0cec017f05a..36103b1dc4cf 100644 --- a/data/reusables/classroom/you-can-create-a-pull-request-for-feedback.md +++ b/data/reusables/classroom/you-can-create-a-pull-request-for-feedback.md @@ -1 +1 @@ -You can automatically create a pull request where you can provide feedback and answer a student's questions about an assignment. For more information about the review of changes in a pull request, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests)." +You can automatically create a pull request where you can provide feedback and answer a student's questions about an assignment. For more information about the review of changes in a pull request, see [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests). diff --git a/data/reusables/cli/cli-learn-more.md b/data/reusables/cli/cli-learn-more.md index c9685c71e238..488f8b5cc674 100644 --- a/data/reusables/cli/cli-learn-more.md +++ b/data/reusables/cli/cli-learn-more.md @@ -1,2 +1,2 @@ > [!NOTE] -> To learn more about {% data variables.product.prodname_cli %}, see "[AUTOTITLE](/github-cli/github-cli/about-github-cli)." +> To learn more about {% data variables.product.prodname_cli %}, see [AUTOTITLE](/github-cli/github-cli/about-github-cli). diff --git a/data/reusables/cli/filter-issues-and-pull-requests-tip.md b/data/reusables/cli/filter-issues-and-pull-requests-tip.md index 28f1eb8993cb..fe8544417d9a 100644 --- a/data/reusables/cli/filter-issues-and-pull-requests-tip.md +++ b/data/reusables/cli/filter-issues-and-pull-requests-tip.md @@ -1,2 +1,2 @@ > [!TIP] -> You can also filter issues or pull requests using the {% data variables.product.prodname_cli %}. For more information, see "[`gh issue list`](https://cli.github.com/manual/gh_issue_list)" or "[`gh pr list`](https://cli.github.com/manual/gh_pr_list)" in the {% data variables.product.prodname_cli %} documentation. +> You can also filter issues or pull requests using the {% data variables.product.prodname_cli %}. For more information, see [`gh issue list`](https://cli.github.com/manual/gh_issue_list) or [`gh pr list`](https://cli.github.com/manual/gh_pr_list) in the {% data variables.product.prodname_cli %} documentation. diff --git a/data/reusables/code-scanning/about-multiple-configurations-link.md b/data/reusables/code-scanning/about-multiple-configurations-link.md index 62637bbad928..397b0e5b2257 100644 --- a/data/reusables/code-scanning/about-multiple-configurations-link.md +++ b/data/reusables/code-scanning/about-multiple-configurations-link.md @@ -1 +1 @@ -If you run code scanning using multiple configurations, an alert will sometimes have multiple analysis origins. If an alert has multiple analysis origins, you can view the status of the alert for each analysis origin on the alert page. For more information, see "[AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-analysis-origins)." +If you run code scanning using multiple configurations, an alert will sometimes have multiple analysis origins. If an alert has multiple analysis origins, you can view the status of the alert for each analysis origin on the alert page. For more information, see [AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-analysis-origins). diff --git a/data/reusables/code-scanning/alert-tracking-link.md b/data/reusables/code-scanning/alert-tracking-link.md index 7d210ce989b0..aac200c42611 100644 --- a/data/reusables/code-scanning/alert-tracking-link.md +++ b/data/reusables/code-scanning/alert-tracking-link.md @@ -1,2 +1,2 @@ -For more information about creating issues to track {% data variables.product.prodname_code_scanning %} alerts, see "[AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/tracking-code-scanning-alerts-in-issues-using-task-lists)." +For more information about creating issues to track {% data variables.product.prodname_code_scanning %} alerts, see [AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/tracking-code-scanning-alerts-in-issues-using-task-lists). diff --git a/data/reusables/code-scanning/alerts-found-in-generated-code.md b/data/reusables/code-scanning/alerts-found-in-generated-code.md index 4a75de4510a2..3ddaeb6faa28 100644 --- a/data/reusables/code-scanning/alerts-found-in-generated-code.md +++ b/data/reusables/code-scanning/alerts-found-in-generated-code.md @@ -1,3 +1,3 @@ -For compiled languages like Java, Kotlin, Go, C, C++, and C#, {% data variables.product.prodname_codeql %} analyzes all of the code which was built during the workflow run. To limit the amount of code being analyzed, build only the code which you wish to analyze by specifying your own build steps in a `run` block. You can combine specifying your own build steps with using the `paths` or `paths-ignore` filters on the `pull_request` and `push` events to ensure that your workflow only runs when specific code is changed. For more information, see "[AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#onpushpull_requestpull_request_targetpathspaths-ignore)." +For compiled languages like Java, Kotlin, Go, C, C++, and C#, {% data variables.product.prodname_codeql %} analyzes all of the code which was built during the workflow run. To limit the amount of code being analyzed, build only the code which you wish to analyze by specifying your own build steps in a `run` block. You can combine specifying your own build steps with using the `paths` or `paths-ignore` filters on the `pull_request` and `push` events to ensure that your workflow only runs when specific code is changed. For more information, see [AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#onpushpull_requestpull_request_targetpathspaths-ignore). -For languages like JavaScript, Python, and TypeScript, that {% data variables.product.prodname_codeql %} analyzes without compiling the source code, you can specify additional configuration options to limit the amount of code to analyze. For more information, see "[AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning#specifying-directories-to-scan)." +For languages like JavaScript, Python, and TypeScript, that {% data variables.product.prodname_codeql %} analyzes without compiling the source code, you can specify additional configuration options to limit the amount of code to analyze. For more information, see [AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning#specifying-directories-to-scan). diff --git a/data/reusables/code-scanning/audit-code-scanning-events.md b/data/reusables/code-scanning/audit-code-scanning-events.md index 2b14d129a0c4..815bc09a264d 100644 --- a/data/reusables/code-scanning/audit-code-scanning-events.md +++ b/data/reusables/code-scanning/audit-code-scanning-events.md @@ -1 +1 @@ -You can audit the actions taken in response to {% data variables.product.prodname_code_scanning %} alerts using {% data variables.product.prodname_dotcom %} tools. For more information, see "[AUTOTITLE](/code-security/getting-started/auditing-security-alerts)." +You can audit the actions taken in response to {% data variables.product.prodname_code_scanning %} alerts using {% data variables.product.prodname_dotcom %} tools. For more information, see [AUTOTITLE](/code-security/getting-started/auditing-security-alerts). diff --git a/data/reusables/code-scanning/billing.md b/data/reusables/code-scanning/billing.md index 5d09d75853b9..96f529454515 100644 --- a/data/reusables/code-scanning/billing.md +++ b/data/reusables/code-scanning/billing.md @@ -1 +1 @@ -{% ifversion fpt or ghec %}Using actions to run {% data variables.product.prodname_code_scanning %} will use minutes. For more information, see "[AUTOTITLE](/billing/managing-billing-for-github-actions/about-billing-for-github-actions)."{% endif %} +{% ifversion fpt or ghec %}Using actions to run {% data variables.product.prodname_code_scanning %} will use minutes. For more information, see [AUTOTITLE](/billing/managing-billing-for-github-actions/about-billing-for-github-actions).{% endif %} diff --git a/data/reusables/code-scanning/choose-alert-dismissal-reason.md b/data/reusables/code-scanning/choose-alert-dismissal-reason.md index 2ef1bc3c7e1a..b09bebf5b144 100644 --- a/data/reusables/code-scanning/choose-alert-dismissal-reason.md +++ b/data/reusables/code-scanning/choose-alert-dismissal-reason.md @@ -1 +1 @@ -It's important to choose the appropriate reason from the drop-down menu as this may affect whether a query continues to be included in future analysis. Optionally, you can comment on a dismissal to record the context of an alert dismissal. The dismissal comment is added to the alert timeline and can be used as justification during auditing and reporting. You can retrieve or set a comment by using the code scanning REST API. The comment is contained in `dismissed_comment` for the `alerts/{alert_number}` endpoint. For more information, see "[AUTOTITLE](/rest/code-scanning#update-a-code-scanning-alert)." +It's important to choose the appropriate reason from the drop-down menu as this may affect whether a query continues to be included in future analysis. Optionally, you can comment on a dismissal to record the context of an alert dismissal. The dismissal comment is added to the alert timeline and can be used as justification during auditing and reporting. You can retrieve or set a comment by using the code scanning REST API. The comment is contained in `dismissed_comment` for the `alerts/{alert_number}` endpoint. For more information, see [AUTOTITLE](/rest/code-scanning#update-a-code-scanning-alert). diff --git a/data/reusables/code-scanning/codeql-action-version-ghes.md b/data/reusables/code-scanning/codeql-action-version-ghes.md index 674dc71199a2..ab8930ed2575 100644 --- a/data/reusables/code-scanning/codeql-action-version-ghes.md +++ b/data/reusables/code-scanning/codeql-action-version-ghes.md @@ -2,6 +2,6 @@ > [!NOTE] > This article describes the features available with the version of the {% data variables.product.prodname_codeql %} action and associated {% data variables.product.prodname_codeql_cli %} bundle included in the initial release of this version of {% data variables.product.product_name %}. If your enterprise uses a more recent version of the {% data variables.product.prodname_codeql %} action, see the [{% data variables.product.prodname_ghe_cloud %} version](/enterprise-cloud@latest/{{ currentArticle }}) of this article for information on the latest features. -For information on using the latest version, see "[AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-code-scanning-for-your-appliance#configuring-codeql-analysis-on-a-server-without-internet-access)." +For information on using the latest version, see [AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-code-scanning-for-your-appliance#configuring-codeql-analysis-on-a-server-without-internet-access). {% endif %} diff --git a/data/reusables/code-scanning/codeql-language-identifiers-table.md b/data/reusables/code-scanning/codeql-language-identifiers-table.md index 5990905105ce..7e084877f80b 100644 --- a/data/reusables/code-scanning/codeql-language-identifiers-table.md +++ b/data/reusables/code-scanning/codeql-language-identifiers-table.md @@ -17,7 +17,7 @@ {% data reusables.code-scanning.beta-actions-analysis %} > [!NOTE] -> If you specify one of the alternative identifiers, this is equivalent to using the standard language identifier. For example, specifying `javascript` instead of `javascript-typescript` will not exclude analysis of TypeScript code. You can do this in an advanced setup workflow with the `--paths-ignore` option. For more information, see "[AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning#specifying-directories-to-scan)." +> If you specify one of the alternative identifiers, this is equivalent to using the standard language identifier. For example, specifying `javascript` instead of `javascript-typescript` will not exclude analysis of TypeScript code. You can do this in an advanced setup workflow with the `--paths-ignore` option. For more information, see [AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning#specifying-directories-to-scan). {% else %} diff --git a/data/reusables/code-scanning/codeql-languages-bullets.md b/data/reusables/code-scanning/codeql-languages-bullets.md index c5d2010e22f3..89ff06eee026 100644 --- a/data/reusables/code-scanning/codeql-languages-bullets.md +++ b/data/reusables/code-scanning/codeql-languages-bullets.md @@ -14,4 +14,4 @@ > * Use {% ifversion codeql-language-identifiers-311 %}`java-kotlin`{% else %}`java`{% endif %} to analyze code written in Java, Kotlin or both. > * Use {% ifversion codeql-language-identifiers-311 %}`javascript-typescript`{% else %}`javascript`{% endif %} to analyze code written in JavaScript, TypeScript or both. -For more information, see the documentation on the {% data variables.product.prodname_codeql %} website: "[Supported languages and frameworks](https://codeql.github.com/docs/codeql-overview/supported-languages-and-frameworks/)." +For more information, see the documentation on the {% data variables.product.prodname_codeql %} website: [Supported languages and frameworks](https://codeql.github.com/docs/codeql-overview/supported-languages-and-frameworks/). diff --git a/data/reusables/code-scanning/codeql-query-suites-explanation.md b/data/reusables/code-scanning/codeql-query-suites-explanation.md index 3fdfa11337ad..162190048153 100644 --- a/data/reusables/code-scanning/codeql-query-suites-explanation.md +++ b/data/reusables/code-scanning/codeql-query-suites-explanation.md @@ -2,7 +2,7 @@ The following query suites are built into {% data variables.product.prodname_cod {% data reusables.code-scanning.codeql-query-suites %} -Each of these query suites contains a different subset of the queries included in the built-in {% data variables.product.prodname_codeql %} query pack for that language. The query suites are automatically generated using the metadata for each query. For more information, see "[Metadata for CodeQL queries](https://codeql.github.com/docs/writing-codeql-queries/metadata-for-codeql-queries/)." +Each of these query suites contains a different subset of the queries included in the built-in {% data variables.product.prodname_codeql %} query pack for that language. The query suites are automatically generated using the metadata for each query. For more information, see [Metadata for CodeQL queries](https://codeql.github.com/docs/writing-codeql-queries/metadata-for-codeql-queries/). diff --git a/data/reusables/code-scanning/codeql-query-suites.md b/data/reusables/code-scanning/codeql-query-suites.md index dbdbcfd795e6..e27e4bacf26a 100644 --- a/data/reusables/code-scanning/codeql-query-suites.md +++ b/data/reusables/code-scanning/codeql-query-suites.md @@ -3,4 +3,4 @@ | `security-extended` | Queries from the default suite, plus lower severity and precision queries | | `security-and-quality` | Queries from `security-extended`, plus maintainability and reliability queries | -For more information, see: "[AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/built-in-codeql-query-suites)." +For more information, see: [AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/built-in-codeql-query-suites). diff --git a/data/reusables/code-scanning/codeql-query-tables/codeql-version-info.md b/data/reusables/code-scanning/codeql-query-tables/codeql-version-info.md index 67f62ea16908..4553699a47b7 100644 --- a/data/reusables/code-scanning/codeql-query-tables/codeql-version-info.md +++ b/data/reusables/code-scanning/codeql-query-tables/codeql-version-info.md @@ -3,6 +3,6 @@ This table lists the queries available with the latest release of the {% data va {% ifversion ghes %} > [!NOTE] -> The initial release of {% data variables.product.product_name %} {{ allVersions[currentVersion].currentRelease }} included {% data variables.product.prodname_codeql %} action and {% data variables.product.prodname_codeql_cli %} {% data variables.product.codeql_cli_ghes_recommended_version %}, which may not include all of these queries. Your site administrator can update your {% data variables.product.prodname_codeql %} version to a newer release. For more information, see "[AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-code-scanning-for-your-appliance)." +> The initial release of {% data variables.product.product_name %} {{ allVersions[currentVersion].currentRelease }} included {% data variables.product.prodname_codeql %} action and {% data variables.product.prodname_codeql_cli %} {% data variables.product.codeql_cli_ghes_recommended_version %}, which may not include all of these queries. Your site administrator can update your {% data variables.product.prodname_codeql %} version to a newer release. For more information, see [AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-code-scanning-for-your-appliance). {% endif %} diff --git a/data/reusables/code-scanning/codeql-query-tables/links-to-all-tables.md b/data/reusables/code-scanning/codeql-query-tables/links-to-all-tables.md index 839919974fc9..944821fbdc92 100644 --- a/data/reusables/code-scanning/codeql-query-tables/links-to-all-tables.md +++ b/data/reusables/code-scanning/codeql-query-tables/links-to-all-tables.md @@ -1,8 +1,8 @@ -* "[AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/c-cpp-built-in-queries)" -* "[AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/csharp-built-in-queries)" -* "[AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/go-built-in-queries)" -* "[AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/java-kotlin-built-in-queries)" -* "[AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/javascript-typescript-built-in-queries)" -* "[AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/python-built-in-queries)" -* "[AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/ruby-built-in-queries)" -* "[AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/swift-built-in-queries)" +* [AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/c-cpp-built-in-queries) +* [AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/csharp-built-in-queries) +* [AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/go-built-in-queries) +* [AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/java-kotlin-built-in-queries) +* [AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/javascript-typescript-built-in-queries) +* [AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/python-built-in-queries) +* [AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/ruby-built-in-queries) +* [AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/swift-built-in-queries) diff --git a/data/reusables/code-scanning/codeql-query-tables/query-suite-behavior.md b/data/reusables/code-scanning/codeql-query-tables/query-suite-behavior.md index 646d5c64f1ad..9eae39607864 100644 --- a/data/reusables/code-scanning/codeql-query-tables/query-suite-behavior.md +++ b/data/reusables/code-scanning/codeql-query-tables/query-suite-behavior.md @@ -1 +1 @@ -All queries in the `default` query suite are run by default. If you choose to use the `security-extended` query suite, additional queries are run. For more information, see "[AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/built-in-codeql-query-suites)." +All queries in the `default` query suite are run by default. If you choose to use the `security-extended` query suite, additional queries are run. For more information, see [AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/built-in-codeql-query-suites). diff --git a/data/reusables/code-scanning/default-setup-pre-enablement-explanation.md b/data/reusables/code-scanning/default-setup-pre-enablement-explanation.md index c1481f662d39..535a6355c7de 100644 --- a/data/reusables/code-scanning/default-setup-pre-enablement-explanation.md +++ b/data/reusables/code-scanning/default-setup-pre-enablement-explanation.md @@ -1 +1 @@ -We recommend enabling default setup for eligible repositories if there is any chance the repositories will include at least one {% data variables.product.prodname_codeql %}-supported language in the future. If you enable default setup on a repository that does not include any {% data variables.product.prodname_codeql %}-supported languages, default setup will not run any scans or use any {% data variables.product.prodname_actions %} minutes. If {% data variables.product.prodname_codeql %}-supported languages are added to the repository, default setup will automatically begin scanning {% data variables.product.prodname_codeql %}-supported languages and using {% data variables.product.prodname_actions %} minutes. For more information on {% data variables.product.prodname_codeql %}-supported languages, see "[AUTOTITLE](/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning-with-codeql#about-codeql)." +We recommend enabling default setup for eligible repositories if there is any chance the repositories will include at least one {% data variables.product.prodname_codeql %}-supported language in the future. If you enable default setup on a repository that does not include any {% data variables.product.prodname_codeql %}-supported languages, default setup will not run any scans or use any {% data variables.product.prodname_actions %} minutes. If {% data variables.product.prodname_codeql %}-supported languages are added to the repository, default setup will automatically begin scanning {% data variables.product.prodname_codeql %}-supported languages and using {% data variables.product.prodname_actions %} minutes. For more information on {% data variables.product.prodname_codeql %}-supported languages, see [AUTOTITLE](/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning-with-codeql#about-codeql). diff --git a/data/reusables/code-scanning/default-setup-swift-self-hosted-runners.md b/data/reusables/code-scanning/default-setup-swift-self-hosted-runners.md index d89e76f5be43..c6ffd787a2a6 100644 --- a/data/reusables/code-scanning/default-setup-swift-self-hosted-runners.md +++ b/data/reusables/code-scanning/default-setup-swift-self-hosted-runners.md @@ -1 +1 @@ -{% data variables.product.prodname_code_scanning_caps %} of Swift code is not supported for runners that are part of an {% data variables.product.prodname_actions_runner_controller %} (ARC), because ARC runners only use Linux and Swift requires macOS runners. However, you can have a mixture of both ARC runners and self-hosted macOS runners. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/about-actions-runner-controller)." +{% data variables.product.prodname_code_scanning_caps %} of Swift code is not supported for runners that are part of an {% data variables.product.prodname_actions_runner_controller %} (ARC), because ARC runners only use Linux and Swift requires macOS runners. However, you can have a mixture of both ARC runners and self-hosted macOS runners. For more information, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/about-actions-runner-controller). diff --git a/data/reusables/code-scanning/enabling-options.md b/data/reusables/code-scanning/enabling-options.md index 69ab845cced5..1e28b5e1768e 100644 --- a/data/reusables/code-scanning/enabling-options.md +++ b/data/reusables/code-scanning/enabling-options.md @@ -1,2 +1,2 @@ -* **{% data variables.product.prodname_codeql %}:** Uses {% data variables.product.prodname_actions %} with either default setup (see "[AUTOTITLE](/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning)") or advanced setup (see "[AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning#configuring-advanced-setup-for-code-scanning-with-codeql)"), or runs {% data variables.product.prodname_codeql %} analysis in a third-party continuous integration (CI) system (see "[AUTOTITLE](/code-security/code-scanning/integrating-with-code-scanning/using-code-scanning-with-your-existing-ci-system)"). -* **Third‑party:** Uses {% data variables.product.prodname_actions %} {% ifversion fpt or ghec %}(see "[AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning#configuring-code-scanning-using-third-party-workflows)") {% endif %}or third-party tools and uploads results to {% data variables.product.product_name %} (see "[AUTOTITLE](/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)"). +* **{% data variables.product.prodname_codeql %}:** Uses {% data variables.product.prodname_actions %} with either default setup (see [AUTOTITLE](/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning)) or advanced setup (see [AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning#configuring-advanced-setup-for-code-scanning-with-codeql)), or runs {% data variables.product.prodname_codeql %} analysis in a third-party continuous integration (CI) system (see [AUTOTITLE](/code-security/code-scanning/integrating-with-code-scanning/using-code-scanning-with-your-existing-ci-system)). +* **Third‑party:** Uses {% data variables.product.prodname_actions %} {% ifversion fpt or ghec %}(see [AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning#configuring-code-scanning-using-third-party-workflows)) {% endif %}or third-party tools and uploads results to {% data variables.product.product_name %} (see [AUTOTITLE](/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)). diff --git a/data/reusables/code-scanning/enterprise-enable-code-scanning-actions.md b/data/reusables/code-scanning/enterprise-enable-code-scanning-actions.md index 95bb42ca256d..06a225011957 100644 --- a/data/reusables/code-scanning/enterprise-enable-code-scanning-actions.md +++ b/data/reusables/code-scanning/enterprise-enable-code-scanning-actions.md @@ -1,6 +1,6 @@ {% ifversion ghes %} > [!NOTE] -> Your site administrator must enable {% data variables.product.prodname_code_scanning %} before you can use this feature. If you want to use {% data variables.product.prodname_actions %} to scan your code, the site administrator must also enable {% data variables.product.prodname_actions %} and set up the infrastructure required. For more information, see "[AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-code-scanning-for-your-appliance)." +> Your site administrator must enable {% data variables.product.prodname_code_scanning %} before you can use this feature. If you want to use {% data variables.product.prodname_actions %} to scan your code, the site administrator must also enable {% data variables.product.prodname_actions %} and set up the infrastructure required. For more information, see [AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-code-scanning-for-your-appliance). {% endif %} diff --git a/data/reusables/code-scanning/enterprise-enable-code-scanning.md b/data/reusables/code-scanning/enterprise-enable-code-scanning.md index 9276f1ba0f47..be50ad250f15 100644 --- a/data/reusables/code-scanning/enterprise-enable-code-scanning.md +++ b/data/reusables/code-scanning/enterprise-enable-code-scanning.md @@ -1,8 +1,8 @@ {% ifversion ghes %} > [!NOTE] -> Your site administrator must enable {% data variables.product.prodname_code_scanning %} before you can use this feature. For more information, see "[AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-code-scanning-for-your-appliance)." +> Your site administrator must enable {% data variables.product.prodname_code_scanning %} before you can use this feature. For more information, see [AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-code-scanning-for-your-appliance). > -> You may not be able to enable or disable {% data variables.product.prodname_code_scanning %} if an enterprise owner has set a {% data variables.product.prodname_GH_advanced_security %} (GHAS) policy at the enterprise level. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise)." +> You may not be able to enable or disable {% data variables.product.prodname_code_scanning %} if an enterprise owner has set a {% data variables.product.prodname_GH_advanced_security %} (GHAS) policy at the enterprise level. For more information, see [AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise). {% endif %} diff --git a/data/reusables/code-scanning/example-configuration-files.md b/data/reusables/code-scanning/example-configuration-files.md index 5330b43debec..aa07d3993ead 100644 --- a/data/reusables/code-scanning/example-configuration-files.md +++ b/data/reusables/code-scanning/example-configuration-files.md @@ -1,4 +1,4 @@ -This configuration file adds the `security-and-quality` query suite to the list of queries run by {% data variables.product.prodname_codeql %} when scanning your code. For more information about the query suites available for use, see "[Running additional queries](#running-additional-queries)." +This configuration file adds the `security-and-quality` query suite to the list of queries run by {% data variables.product.prodname_codeql %} when scanning your code. For more information about the query suites available for use, see [Running additional queries](#running-additional-queries). ``` yaml name: "My {% data variables.product.prodname_codeql %} config" diff --git a/data/reusables/code-scanning/false-positive-fix-codeql.md b/data/reusables/code-scanning/false-positive-fix-codeql.md index 116630a498fe..7f6ca71a2e42 100644 --- a/data/reusables/code-scanning/false-positive-fix-codeql.md +++ b/data/reusables/code-scanning/false-positive-fix-codeql.md @@ -1 +1 @@ -If you dismiss a {% data variables.product.prodname_codeql %} alert as a false positive result, for example because the code uses a sanitization library that isn't supported, consider contributing to the {% data variables.product.prodname_codeql %} repository and improving the analysis. For more information about {% data variables.product.prodname_codeql %}, see "[Contributing to {% data variables.product.prodname_codeql %}](https://github.com/github/codeql/blob/main/CONTRIBUTING.md)." +If you dismiss a {% data variables.product.prodname_codeql %} alert as a false positive result, for example because the code uses a sanitization library that isn't supported, consider contributing to the {% data variables.product.prodname_codeql %} repository and improving the analysis. For more information about {% data variables.product.prodname_codeql %}, see [Contributing to {% data variables.product.prodname_codeql %}](https://github.com/github/codeql/blob/main/CONTRIBUTING.md). diff --git a/data/reusables/code-scanning/interoperable-with-tools-that-output-sarif.md b/data/reusables/code-scanning/interoperable-with-tools-that-output-sarif.md index 49508a90c705..0a436d919992 100644 --- a/data/reusables/code-scanning/interoperable-with-tools-that-output-sarif.md +++ b/data/reusables/code-scanning/interoperable-with-tools-that-output-sarif.md @@ -1 +1 @@ -{% data variables.product.prodname_code_scanning_caps %} is interoperable with third-party code scanning tools that output Static Analysis Results Interchange Format (SARIF) data. SARIF is an open standard. For more information, see "[AUTOTITLE](/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning)." +{% data variables.product.prodname_code_scanning_caps %} is interoperable with third-party code scanning tools that output Static Analysis Results Interchange Format (SARIF) data. SARIF is an open standard. For more information, see [AUTOTITLE](/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning). diff --git a/data/reusables/code-scanning/licensing-note.md b/data/reusables/code-scanning/licensing-note.md index 4272fa2fdf2d..a771480755be 100644 --- a/data/reusables/code-scanning/licensing-note.md +++ b/data/reusables/code-scanning/licensing-note.md @@ -1,7 +1,7 @@ > [!NOTE] {% ifversion fpt %} -> * The {% data variables.product.prodname_codeql_cli %} is free to use on public repositories. The {% data variables.product.prodname_codeql_cli %} is also available in private repositories owned by organizations that use {% data variables.product.prodname_ghe_cloud %} and have a license for {% data variables.product.prodname_GH_advanced_security %}. For information, see "[{% data variables.product.product_name %} {% data variables.product.prodname_codeql %} Terms and Conditions](https://securitylab.github.com/tools/codeql/license)" and "[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)." +> * The {% data variables.product.prodname_codeql_cli %} is free to use on public repositories. The {% data variables.product.prodname_codeql_cli %} is also available in private repositories owned by organizations that use {% data variables.product.prodname_ghe_cloud %} and have a license for {% data variables.product.prodname_GH_advanced_security %}. For information, see [{% data variables.product.product_name %} {% data variables.product.prodname_codeql %} Terms and Conditions](https://securitylab.github.com/tools/codeql/license) and [{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/). {%- elsif ghec %} -> * The {% data variables.product.prodname_codeql_cli %} is free to use on public repositories that are maintained on {% data variables.product.prodname_dotcom_the_website %}, and available to use on private repositories that are owned by customers with an {% data variables.product.prodname_advanced_security %} license. For information, see "[{% data variables.product.product_name %} {% data variables.product.prodname_codeql %} Terms and Conditions](https://securitylab.github.com/tools/codeql/license)" and "[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)." +> * The {% data variables.product.prodname_codeql_cli %} is free to use on public repositories that are maintained on {% data variables.product.prodname_dotcom_the_website %}, and available to use on private repositories that are owned by customers with an {% data variables.product.prodname_advanced_security %} license. For information, see [{% data variables.product.product_name %} {% data variables.product.prodname_codeql %} Terms and Conditions](https://securitylab.github.com/tools/codeql/license) and [{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/). {%- elsif ghes %} > * The {% data variables.product.prodname_codeql_cli %} is available to customers with an {% data variables.product.prodname_advanced_security %} license.{% endif %} > * {% data reusables.code-scanning.non-glibc-linux-support %} diff --git a/data/reusables/code-scanning/max-paths-setting.md b/data/reusables/code-scanning/max-paths-setting.md index 5f7f2905a2c4..a7d87935f787 100644 --- a/data/reusables/code-scanning/max-paths-setting.md +++ b/data/reusables/code-scanning/max-paths-setting.md @@ -7,7 +7,7 @@ CODEQL_ACTION_EXTRA_OPTIONS: '{"database":{"interpret-results":["--max-paths", 1]}}' ``` -* {% data variables.product.prodname_codeql_cli %} `database analyze`: update the database analysis command to include the `--max-paths=1` flag. For more information, see "[AUTOTITLE](/code-security/codeql-cli/codeql-cli-manual/database-analyze#--max-pathsmaxpaths)." +* {% data variables.product.prodname_codeql_cli %} `database analyze`: update the database analysis command to include the `--max-paths=1` flag. For more information, see [AUTOTITLE](/code-security/codeql-cli/codeql-cli-manual/database-analyze#--max-pathsmaxpaths). > [!NOTE] > The `max-paths` setting affects the results of all dataflow queries. diff --git a/data/reusables/code-scanning/pull-request-checks.md b/data/reusables/code-scanning/pull-request-checks.md index 9a170c73c212..f0d79f65f341 100644 --- a/data/reusables/code-scanning/pull-request-checks.md +++ b/data/reusables/code-scanning/pull-request-checks.md @@ -1 +1 @@ -When you enable {% data variables.product.prodname_code_scanning %} on pull requests, the check fails only if one or more alerts of severity `error`, or security severity `critical` or `high` are detected. The check will succeed if alerts with lower severities or security severities are detected. For important codebases, you may want the {% data variables.product.prodname_code_scanning %} check to fail if any alerts are detected, so that the alert must be fixed or dismissed before the code change is merged. For more information about severity levels, see "[About alert severity and security severity levels](/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." +When you enable {% data variables.product.prodname_code_scanning %} on pull requests, the check fails only if one or more alerts of severity `error`, or security severity `critical` or `high` are detected. The check will succeed if alerts with lower severities or security severities are detected. For important codebases, you may want the {% data variables.product.prodname_code_scanning %} check to fail if any alerts are detected, so that the alert must be fixed or dismissed before the code change is merged. For more information about severity levels, see [About alert severity and security severity levels](/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels). diff --git a/data/reusables/code-scanning/run-additional-queries.md b/data/reusables/code-scanning/run-additional-queries.md index 614f24bb30a4..bbde8d8c481a 100644 --- a/data/reusables/code-scanning/run-additional-queries.md +++ b/data/reusables/code-scanning/run-additional-queries.md @@ -1,14 +1,14 @@ When you use {% data variables.product.prodname_codeql %} to scan code, the {% data variables.product.prodname_codeql %} analysis engine generates a database from the code and runs queries on it. {% data variables.product.prodname_codeql %} analysis uses a default set of queries, but you can specify more queries to run, in addition to the default queries. > [!TIP] -> You can also specify the queries you want to exclude from analysis, or include in the analysis. This requires the use of a custom configuration file. For more information, see "[Using a custom configuration file](#using-a-custom-configuration-file)" and "[Excluding specific queries from analysis](#excluding-specific-queries-from-analysis)" below. +> You can also specify the queries you want to exclude from analysis, or include in the analysis. This requires the use of a custom configuration file. For more information, see [Using a custom configuration file](#using-a-custom-configuration-file) and [Excluding specific queries from analysis](#excluding-specific-queries-from-analysis) below. -You can run extra queries if they are part of a {% data variables.product.prodname_codeql %} pack published to the {% data variables.product.company_short %} {% data variables.product.prodname_container_registry %} or a {% data variables.product.prodname_codeql %} pack stored in a repository. For more information, see "[AUTOTITLE](/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning-with-codeql#about-codeql-queries)." +You can run extra queries if they are part of a {% data variables.product.prodname_codeql %} pack published to the {% data variables.product.company_short %} {% data variables.product.prodname_container_registry %} or a {% data variables.product.prodname_codeql %} pack stored in a repository. For more information, see [AUTOTITLE](/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning-with-codeql#about-codeql-queries). The options available to specify the additional queries you want to run are: * `packs` to install one or more {% data variables.product.prodname_codeql %} query packs and run the default query suite or queries for those packs. -* `queries` to specify a single _.ql_ file, a directory containing multiple _.ql_ files, a _.qls_ query suite definition file, or any combination. For more information about query suite definitions, see "[Creating {% data variables.product.prodname_codeql %} query suites](https://codeql.github.com/docs/codeql-cli/creating-codeql-query-suites/)." +* `queries` to specify a single _.ql_ file, a directory containing multiple _.ql_ files, a _.qls_ query suite definition file, or any combination. For more information about query suite definitions, see [Creating {% data variables.product.prodname_codeql %} query suites](https://codeql.github.com/docs/codeql-cli/creating-codeql-query-suites/). You can use both `packs` and `queries` in the same workflow. diff --git a/data/reusables/code-scanning/sarif-upload-retry.md b/data/reusables/code-scanning/sarif-upload-retry.md index 05f647079de8..9d42e5c1a477 100644 --- a/data/reusables/code-scanning/sarif-upload-retry.md +++ b/data/reusables/code-scanning/sarif-upload-retry.md @@ -1 +1 @@ -1. Rerun the process to upload the SARIF file. It should now succeed if the SARIF file meets the requirements for {% data variables.product.prodname_code_scanning %}. For information about validation and the format supported by {% data variables.product.prodname_code_scanning %}, see "[AUTOTITLE](/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning)." +1. Rerun the process to upload the SARIF file. It should now succeed if the SARIF file meets the requirements for {% data variables.product.prodname_code_scanning %}. For information about validation and the format supported by {% data variables.product.prodname_code_scanning %}, see [AUTOTITLE](/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning). diff --git a/data/reusables/code-scanning/troubleshooting-multiple-configurations.md b/data/reusables/code-scanning/troubleshooting-multiple-configurations.md index 91cfefbd11a0..567b71805d83 100644 --- a/data/reusables/code-scanning/troubleshooting-multiple-configurations.md +++ b/data/reusables/code-scanning/troubleshooting-multiple-configurations.md @@ -1 +1 @@ -In some cases, your repository may use multiple {% data variables.product.prodname_code_scanning %} configurations. These configurations can generate duplicate alerts. Additionally, stale configurations that no longer run will display outdated alert statuses, and the stale alerts will stay open indefinitely. To avoid outdated alerts, you should remove stale {% data variables.product.prodname_code_scanning %} configurations from a branch. For more information on multiple configurations and deleting stale configurations, see "[AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alerts-from-multiple-configurations)" and "[AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/resolving-code-scanning-alerts#removing-stale-configurations-and-alerts-from-a-branch)." +In some cases, your repository may use multiple {% data variables.product.prodname_code_scanning %} configurations. These configurations can generate duplicate alerts. Additionally, stale configurations that no longer run will display outdated alert statuses, and the stale alerts will stay open indefinitely. To avoid outdated alerts, you should remove stale {% data variables.product.prodname_code_scanning %} configurations from a branch. For more information on multiple configurations and deleting stale configurations, see [AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alerts-from-multiple-configurations) and [AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/resolving-code-scanning-alerts#removing-stale-configurations-and-alerts-from-a-branch). diff --git a/data/reusables/code-scanning/upload-sarif-alert-limit.md b/data/reusables/code-scanning/upload-sarif-alert-limit.md index a59d9abe2bbc..0691e32e0fdb 100644 --- a/data/reusables/code-scanning/upload-sarif-alert-limit.md +++ b/data/reusables/code-scanning/upload-sarif-alert-limit.md @@ -1 +1 @@ -You can check that the SARIF properties have the supported size for upload and that the file is compatible with code scanning. For more information, see "[AUTOTITLE](/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning#validating-your-sarif-file)". +You can check that the SARIF properties have the supported size for upload and that the file is compatible with code scanning. For more information, see [AUTOTITLE](/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning#validating-your-sarif-file). diff --git a/data/reusables/code-scanning/upload-sarif-ghas.md b/data/reusables/code-scanning/upload-sarif-ghas.md index a7192d040d66..57b93b11b307 100644 --- a/data/reusables/code-scanning/upload-sarif-ghas.md +++ b/data/reusables/code-scanning/upload-sarif-ghas.md @@ -1,2 +1,2 @@ > [!NOTE] -> Uploading SARIF data to display as {% data variables.product.prodname_code_scanning %} results in {% data variables.product.product_name %} is supported for organization-owned repositories with {% data variables.product.prodname_GH_advanced_security %} enabled{% ifversion fpt or ghec %}, and public repositories on {% data variables.product.prodname_dotcom_the_website %}{% endif %}. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository)." +> Uploading SARIF data to display as {% data variables.product.prodname_code_scanning %} results in {% data variables.product.product_name %} is supported for organization-owned repositories with {% data variables.product.prodname_GH_advanced_security %} enabled{% ifversion fpt or ghec %}, and public repositories on {% data variables.product.prodname_dotcom_the_website %}{% endif %}. For more information, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository). diff --git a/data/reusables/code-scanning/using-security-overview-coverage.md b/data/reusables/code-scanning/using-security-overview-coverage.md index cf622137c5f7..66564b12f11e 100644 --- a/data/reusables/code-scanning/using-security-overview-coverage.md +++ b/data/reusables/code-scanning/using-security-overview-coverage.md @@ -1,5 +1,5 @@ -1. Use options in the page summary to filter results to show the repositories you want to assess. The list of repositories and metrics displayed on the page automatically update to match your current selection. For more information on filtering, see "[AUTOTITLE](/code-security/security-overview/filtering-alerts-in-security-overview)." - * Use the **Teams** dropdown to show information only for the repositories owned by one or more teams. For more information, see "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-team-access-to-an-organization-repository)." +1. Use options in the page summary to filter results to show the repositories you want to assess. The list of repositories and metrics displayed on the page automatically update to match your current selection. For more information on filtering, see [AUTOTITLE](/code-security/security-overview/filtering-alerts-in-security-overview). + * Use the **Teams** dropdown to show information only for the repositories owned by one or more teams. For more information, see [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-team-access-to-an-organization-repository). * Click **NUMBER enabled** or **NUMBER not enabled** in the header for any feature to show only the repositories with that feature enabled or not enabled. * At the top of the list of repositories, click **NUMBER Archived** to show only repositories that are archived. * Click in the search box to add further filters to the repositories displayed. diff --git a/data/reusables/code-scanning/using-security-overview-risk.md b/data/reusables/code-scanning/using-security-overview-risk.md index 459750b6375f..f59f4af96bd6 100644 --- a/data/reusables/code-scanning/using-security-overview-risk.md +++ b/data/reusables/code-scanning/using-security-overview-risk.md @@ -1,4 +1,4 @@ -1. Use options in the page summary to filter results to show the repositories you want to assess. The list of repositories and metrics displayed on the page automatically update to match your current selection. For more information on filtering, see "[AUTOTITLE](/code-security/security-overview/filtering-alerts-in-security-overview)." +1. Use options in the page summary to filter results to show the repositories you want to assess. The list of repositories and metrics displayed on the page automatically update to match your current selection. For more information on filtering, see [AUTOTITLE](/code-security/security-overview/filtering-alerts-in-security-overview). * Use the **Teams** dropdown to show information only for the repositories owned by one or more teams. * Click **NUMBER affected** or **NUMBER unaffected** in the header for any feature to show only the repositories with open alerts or no open alerts of that type. * Click any of the descriptions of "Open alerts" in the header to show only repositories with alerts of that type and category. For example, **1 critical** to show the repository with a critical alert for {% data variables.product.prodname_dependabot %}. diff --git a/data/reusables/codeql-cli/launch-codeql.md b/data/reusables/codeql-cli/launch-codeql.md index a2fe664f1dc9..b490ebda9fb9 100644 --- a/data/reusables/codeql-cli/launch-codeql.md +++ b/data/reusables/codeql-cli/launch-codeql.md @@ -5,4 +5,4 @@ package. * By adding `/codeql` to your `PATH`, so that you can run the executable as just `codeql`. -At this point, you can execute {% data variables.product.prodname_codeql %} commands. For a full list of the {% data variables.product.prodname_codeql_cli %} commands, see "[AUTOTITLE](/code-security/codeql-cli/codeql-cli-manual)." +At this point, you can execute {% data variables.product.prodname_codeql %} commands. For a full list of the {% data variables.product.prodname_codeql_cli %} commands, see [AUTOTITLE](/code-security/codeql-cli/codeql-cli-manual). diff --git a/data/reusables/codespaces/about-changing-storage-size.md b/data/reusables/codespaces/about-changing-storage-size.md index 16fff8101c74..c2d9154af467 100644 --- a/data/reusables/codespaces/about-changing-storage-size.md +++ b/data/reusables/codespaces/about-changing-storage-size.md @@ -1,3 +1,3 @@ If you changed to a virtual machine with a different storage capacity (for example, from 32 GB to 64 GB), your codespace will be unavailable for a short time while the machine type is changed. If the codespace is currently active, it will automatically be stopped. When the change is complete, you'll be able to restart the codespace running on the new machine type. -If you changed to a virtual machine with the same storage capacity, the change will be applied the next time you restart the codespace. An active codespace will not be stopped automatically. For more information on restarting a codespace, see "[AUTOTITLE](/codespaces/developing-in-codespaces/stopping-and-starting-a-codespace#restarting-a-codespace)." +If you changed to a virtual machine with the same storage capacity, the change will be applied the next time you restart the codespace. An active codespace will not be stopped automatically. For more information on restarting a codespace, see [AUTOTITLE](/codespaces/developing-in-codespaces/stopping-and-starting-a-codespace#restarting-a-codespace). diff --git a/data/reusables/codespaces/about-publishing-templates.md b/data/reusables/codespaces/about-publishing-templates.md index c40a30f662ec..9060f4417d6d 100644 --- a/data/reusables/codespaces/about-publishing-templates.md +++ b/data/reusables/codespaces/about-publishing-templates.md @@ -5,4 +5,4 @@ You can save your files, close and stop your codespace, and come back to your wo However, if you delete an unpublished codespace, or if it's automatically deleted by being left unused for the duration of the retention period, then your work will be deleted too. To persist your work, and to allow others to work on your project, you will need to publish your codespace to a repository on {% data variables.product.prodname_dotcom %}. > [!NOTE] -> If an unpublished codespace is currently billed to an organization, publishing the codespace transfers ownership and billing of the codespace to your personal account. See "[AUTOTITLE](/billing/managing-billing-for-your-products/managing-billing-for-github-codespaces/about-billing-for-github-codespaces#how-billing-is-handled-for-github-codespaces-templates)." +> If an unpublished codespace is currently billed to an organization, publishing the codespace transfers ownership and billing of the codespace to your personal account. See [AUTOTITLE](/billing/managing-billing-for-your-products/managing-billing-for-github-codespaces/about-billing-for-github-codespaces#how-billing-is-handled-for-github-codespaces-templates). diff --git a/data/reusables/codespaces/additional-container-config.md b/data/reusables/codespaces/additional-container-config.md index 1973698ae0a8..94a8fac8154a 100644 --- a/data/reusables/codespaces/additional-container-config.md +++ b/data/reusables/codespaces/additional-container-config.md @@ -2,4 +2,4 @@ For a complete list of available properties, see the [dev containers specificati #### Additional dev container configuration files -If you are familiar with Docker, you may want to use a Dockerfile, or Docker Compose, to configure your codespace environment, in addition to the `devcontainer.json` file. You can do this by adding your `Dockerfile` or `docker-compose.yml` files alongside the `devcontainer.json` file. For more information, see "[Using Images, Dockerfiles, and Docker Compose](https://containers.dev/guide/dockerfile)" on the Development Containers website. +If you are familiar with Docker, you may want to use a Dockerfile, or Docker Compose, to configure your codespace environment, in addition to the `devcontainer.json` file. You can do this by adding your `Dockerfile` or `docker-compose.yml` files alongside the `devcontainer.json` file. For more information, see [Using Images, Dockerfiles, and Docker Compose](https://containers.dev/guide/dockerfile) on the Development Containers website. diff --git a/data/reusables/codespaces/check-for-default-image.md b/data/reusables/codespaces/check-for-default-image.md index 9a1628f6cf24..18b97f89bf5f 100644 --- a/data/reusables/codespaces/check-for-default-image.md +++ b/data/reusables/codespaces/check-for-default-image.md @@ -1 +1 @@ -For information on how to check whether a codespace was built from the default dev container image, see "[AUTOTITLE](/codespaces/troubleshooting/troubleshooting-included-usage#storage-usage-for-your-base-dev-container)." +For information on how to check whether a codespace was built from the default dev container image, see [AUTOTITLE](/codespaces/troubleshooting/troubleshooting-included-usage#storage-usage-for-your-base-dev-container). diff --git a/data/reusables/codespaces/codespaces-continue-by-paying.md b/data/reusables/codespaces/codespaces-continue-by-paying.md index 1814fa409499..51b33755c5c2 100644 --- a/data/reusables/codespaces/codespaces-continue-by-paying.md +++ b/data/reusables/codespaces/codespaces-continue-by-paying.md @@ -1 +1 @@ -You can continue using {% data variables.product.prodname_github_codespaces %} beyond your monthly included storage and compute usage by providing payment details and setting a spending limit. See "[AUTOTITLE](/billing/managing-billing-for-your-products/managing-billing-for-github-codespaces/about-billing-for-github-codespaces)." +You can continue using {% data variables.product.prodname_github_codespaces %} beyond your monthly included storage and compute usage by providing payment details and setting a spending limit. See [AUTOTITLE](/billing/managing-billing-for-your-products/managing-billing-for-github-codespaces/about-billing-for-github-codespaces). diff --git a/data/reusables/codespaces/codespaces-machine-type-availability.md b/data/reusables/codespaces/codespaces-machine-type-availability.md index f5d660caef07..efd325850315 100644 --- a/data/reusables/codespaces/codespaces-machine-type-availability.md +++ b/data/reusables/codespaces/codespaces-machine-type-availability.md @@ -1 +1 @@ -Your choice of available machine types may be limited by a number of factors. These can include a policy configured for your organization, or a minimum machine type specification for your repository. For more information, see "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types)" and "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/configuring-dev-containers/setting-a-minimum-specification-for-codespace-machines)." +Your choice of available machine types may be limited by a number of factors. These can include a policy configured for your organization, or a minimum machine type specification for your repository. For more information, see [AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types) and [AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/configuring-dev-containers/setting-a-minimum-specification-for-codespace-machines). diff --git a/data/reusables/codespaces/codespaces-machine-types.md b/data/reusables/codespaces/codespaces-machine-types.md index b4a4288bec81..41636c6b1804 100644 --- a/data/reusables/codespaces/codespaces-machine-types.md +++ b/data/reusables/codespaces/codespaces-machine-types.md @@ -1,3 +1,3 @@ -Typically, you can run your codespace on a choice of remote machine types. These machine types offer a choice of hardware specifications ranging from 2 cores to 32 cores, although the full range of machine types may not always be available. Each machine type has a different level of resources and a different billing tier. For information, see "[AUTOTITLE](/billing/managing-billing-for-your-products/managing-billing-for-github-codespaces/about-billing-for-github-codespaces)." +Typically, you can run your codespace on a choice of remote machine types. These machine types offer a choice of hardware specifications ranging from 2 cores to 32 cores, although the full range of machine types may not always be available. Each machine type has a different level of resources and a different billing tier. For information, see [AUTOTITLE](/billing/managing-billing-for-your-products/managing-billing-for-github-codespaces/about-billing-for-github-codespaces). By default the machine type with the lowest valid resources is used when you create a codespace. diff --git a/data/reusables/codespaces/codespaces-org-policies-note.md b/data/reusables/codespaces/codespaces-org-policies-note.md index 5a64d23ec5b0..3de26763de77 100644 --- a/data/reusables/codespaces/codespaces-org-policies-note.md +++ b/data/reusables/codespaces/codespaces-org-policies-note.md @@ -1,2 +1,2 @@ > [!NOTE] -> Codespaces policies only apply to codespaces that your organizations pays for. If someone creates a codespace for a repository in your organization at their own expense, then the codespace will not be bound by these policies. For more information, see "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/choosing-who-owns-and-pays-for-codespaces-in-your-organization)." +> Codespaces policies only apply to codespaces that your organizations pays for. If someone creates a codespace for a repository in your organization at their own expense, then the codespace will not be bound by these policies. For more information, see [AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/choosing-who-owns-and-pays-for-codespaces-in-your-organization). diff --git a/data/reusables/codespaces/codespaces-unavailable-for-emus.md b/data/reusables/codespaces/codespaces-unavailable-for-emus.md index 6f8c13e10d1d..b0cb3a7a85dc 100644 --- a/data/reusables/codespaces/codespaces-unavailable-for-emus.md +++ b/data/reusables/codespaces/codespaces-unavailable-for-emus.md @@ -1 +1 @@ ->[!NOTE] {% data variables.product.prodname_github_codespaces %} is not available for repositories that are owned by managed user accounts. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users)." +>[!NOTE] {% data variables.product.prodname_github_codespaces %} is not available for repositories that are owned by managed user accounts. For more information, see [AUTOTITLE](/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users). diff --git a/data/reusables/codespaces/committing-link-to-procedure.md b/data/reusables/codespaces/committing-link-to-procedure.md index 0f8436edaff4..d636dcfd1172 100644 --- a/data/reusables/codespaces/committing-link-to-procedure.md +++ b/data/reusables/codespaces/committing-link-to-procedure.md @@ -2,4 +2,4 @@ When you've made changes to your codespace, either new code or configuration cha For this tutorial, you created a codespace from a template repository, so the code in your codespace is not yet stored in a repository. You can create a repository by publishing the current branch to {% data variables.product.github %}. -For information, see "[AUTOTITLE](/codespaces/developing-in-codespaces/using-source-control-in-your-codespace?tool=webui#publishing-a-codespace-created-from-a-template)." +For information, see [AUTOTITLE](/codespaces/developing-in-codespaces/using-source-control-in-your-codespace?tool=webui#publishing-a-codespace-created-from-a-template). diff --git a/data/reusables/codespaces/connect-to-codespace-from-vscode.md b/data/reusables/codespaces/connect-to-codespace-from-vscode.md index 9e899ddea24c..cadfb904a5a8 100644 --- a/data/reusables/codespaces/connect-to-codespace-from-vscode.md +++ b/data/reusables/codespaces/connect-to-codespace-from-vscode.md @@ -1 +1 @@ -You can connect to your codespace directly from {% data variables.product.prodname_vscode_shortname %}. For more information, see "[AUTOTITLE](/codespaces/developing-in-codespaces/using-github-codespaces-in-visual-studio-code)." +You can connect to your codespace directly from {% data variables.product.prodname_vscode_shortname %}. For more information, see [AUTOTITLE](/codespaces/developing-in-codespaces/using-github-codespaces-in-visual-studio-code). diff --git a/data/reusables/codespaces/contact-support.md b/data/reusables/codespaces/contact-support.md index 3900e65c6a36..3109e8f20ec7 100644 --- a/data/reusables/codespaces/contact-support.md +++ b/data/reusables/codespaces/contact-support.md @@ -1 +1 @@ -you may need to contact support. For more information, see "[AUTOTITLE](/codespaces/troubleshooting/working-with-support-for-github-codespaces)." +you may need to contact support. For more information, see [AUTOTITLE](/codespaces/troubleshooting/working-with-support-for-github-codespaces). diff --git a/data/reusables/codespaces/customize-vcpus-and-ram.md b/data/reusables/codespaces/customize-vcpus-and-ram.md index d2a9e8b129d6..6cb0581aa91f 100644 --- a/data/reusables/codespaces/customize-vcpus-and-ram.md +++ b/data/reusables/codespaces/customize-vcpus-and-ram.md @@ -1,5 +1,5 @@ -You can customize your codespace by adjusting the amount of vCPUs and RAM, adding dotfiles to personalize your environment, or by modifying the tools and scripts installed. For more information, see "[AUTOTITLE](/codespaces/customizing-your-codespace)." +You can customize your codespace by adjusting the amount of vCPUs and RAM, adding dotfiles to personalize your environment, or by modifying the tools and scripts installed. For more information, see [AUTOTITLE](/codespaces/customizing-your-codespace). {% data variables.product.prodname_github_codespaces %} uses a file called `devcontainer.json` to configure the development container that you use when you work in a codespace. Each repository can contain one or more `devcontainer.json` files, to give you exactly the development environment you need to work on your code in a codespace. -On launch, {% data variables.product.prodname_github_codespaces %} uses a `devcontainer.json` file, and any dependent files that make up the dev container configuration, to install tools and runtimes, and perform other setup tasks that the project requires. For more information, see "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers)." +On launch, {% data variables.product.prodname_github_codespaces %} uses a `devcontainer.json` file, and any dependent files that make up the dev container configuration, to install tools and runtimes, and perform other setup tasks that the project requires. For more information, see [AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers). diff --git a/data/reusables/codespaces/devcontainer-properties-1.md b/data/reusables/codespaces/devcontainer-properties-1.md index 23a037fc65ed..0c9e7862e9df 100644 --- a/data/reusables/codespaces/devcontainer-properties-1.md +++ b/data/reusables/codespaces/devcontainer-properties-1.md @@ -1,4 +1,4 @@ * **name:** You can name your dev container anything you want. A default value is supplied. * **image:** The name of an image in a container registry ([DockerHub](https://hub.docker.com/), [{% data variables.product.prodname_dotcom %} {% data variables.product.prodname_container_registry %}](/packages/learn-github-packages/introduction-to-github-packages), or [Azure Container Registry](https://azure.microsoft.com/services/container-registry/)) that will be used to create the dev container for the codespace. -* **features:** A list of one or more objects, each of which references one of the available dev container features. Features are self-contained, shareable units of installation code and development container configuration. They provide an easy way to add more tooling, runtime, or library features to your development container. You can add features either within {% data variables.product.prodname_vscode_shortname %} or in the `devcontainer.json` editor on {% data variables.product.github %}. For more information, click either the **{% data variables.product.prodname_vscode %}** or **Web browser** tab in "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/configuring-dev-containers/adding-features-to-a-devcontainer-file?tool=webui)." -* **forwardPorts:** Any ports listed here will be forwarded automatically. For more information, see "[AUTOTITLE](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace)." +* **features:** A list of one or more objects, each of which references one of the available dev container features. Features are self-contained, shareable units of installation code and development container configuration. They provide an easy way to add more tooling, runtime, or library features to your development container. You can add features either within {% data variables.product.prodname_vscode_shortname %} or in the `devcontainer.json` editor on {% data variables.product.github %}. For more information, click either the **{% data variables.product.prodname_vscode %}** or **Web browser** tab in [AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/configuring-dev-containers/adding-features-to-a-devcontainer-file?tool=webui). +* **forwardPorts:** Any ports listed here will be forwarded automatically. For more information, see [AUTOTITLE](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace). diff --git a/data/reusables/codespaces/devcontainer-properties-2.md b/data/reusables/codespaces/devcontainer-properties-2.md index a1a9b6c8d177..0734c8fb7b2e 100644 --- a/data/reusables/codespaces/devcontainer-properties-2.md +++ b/data/reusables/codespaces/devcontainer-properties-2.md @@ -1,3 +1,3 @@ * **postCreateCommand:** Use this property to run commands after your codespace is created. This can be formatted as a string (as above), an array, or an object. For more information, see the [dev containers specification](https://containers.dev/implementors/json_reference/#lifecycle-scripts) on the Development Containers website. -* **customizations:** This property allows you to customize a specific tool or service when it is used for working in a codespace. For example, you can configure specific settings and extensions for {% data variables.product.prodname_vscode_shortname %}. For more information, see "[Supporting tools and services](https://containers.dev/supporting)" on the Development Containers website. +* **customizations:** This property allows you to customize a specific tool or service when it is used for working in a codespace. For example, you can configure specific settings and extensions for {% data variables.product.prodname_vscode_shortname %}. For more information, see [Supporting tools and services](https://containers.dev/supporting) on the Development Containers website. * **remoteUser:** By default, you’re running as the vscode user, but you can optionally set this to root. diff --git a/data/reusables/codespaces/developing-in-vscode.md b/data/reusables/codespaces/developing-in-vscode.md index 875795b4c94e..543ba1a6b75d 100644 --- a/data/reusables/codespaces/developing-in-vscode.md +++ b/data/reusables/codespaces/developing-in-vscode.md @@ -1,14 +1,14 @@ ### Customizing the codespaces for a repository -You can customize the codespaces that are created for a repository by creating or updating the dev container configuration for the repository. You can do this from within a codespace. After you change a dev container configuration, you can apply the changes to the current codespace by rebuilding the Docker container for the codespace. For more information, see "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers)." +You can customize the codespaces that are created for a repository by creating or updating the dev container configuration for the repository. You can do this from within a codespace. After you change a dev container configuration, you can apply the changes to the current codespace by rebuilding the Docker container for the codespace. For more information, see [AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers). ### Personalizing your codespace -You can use a [dotfiles](https://dotfiles.github.io/tutorials/) repository and [Settings Sync](https://code.visualstudio.com/docs/editor/settings-sync) to personalize aspects of the codespace environment for any codespace that you create. Personalization can include shell preferences and additional tools. For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account)." +You can use a [dotfiles](https://dotfiles.github.io/tutorials/) repository and [Settings Sync](https://code.visualstudio.com/docs/editor/settings-sync) to personalize aspects of the codespace environment for any codespace that you create. Personalization can include shell preferences and additional tools. For more information, see [AUTOTITLE](/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account). ### Running your app from a codespace -{% data reusables.codespaces.about-port-forwarding %} For more information, see "[AUTOTITLE](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace)." +{% data reusables.codespaces.about-port-forwarding %} For more information, see [AUTOTITLE](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace). ### Committing your changes @@ -16,4 +16,4 @@ You can use a [dotfiles](https://dotfiles.github.io/tutorials/) repository and [ ### Using the {% data variables.product.prodname_vscode_command_palette %} -The {% data variables.product.prodname_vscode_command_palette %} allows you to access and manage many features for {% data variables.product.prodname_codespaces %} and {% data variables.product.prodname_vscode %}. For more information, see "[AUTOTITLE](/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces)." +The {% data variables.product.prodname_vscode_command_palette %} allows you to access and manage many features for {% data variables.product.prodname_codespaces %} and {% data variables.product.prodname_vscode %}. For more information, see [AUTOTITLE](/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces). diff --git a/data/reusables/codespaces/disabling-settings-sync.md b/data/reusables/codespaces/disabling-settings-sync.md index b63ce7dae144..72d71b4ba0f9 100644 --- a/data/reusables/codespaces/disabling-settings-sync.md +++ b/data/reusables/codespaces/disabling-settings-sync.md @@ -1,10 +1,10 @@ You can turn off Settings Sync to stop syncing settings to and from an instance of {% data variables.product.prodname_vscode_shortname %}. -When you turn off Settings Sync in a codespace, new codespaces continue to use the settings cached from the last time your settings were pushed to the cloud. If you use the {% data variables.product.prodname_vscode_shortname %} web client for codespaces, and want codespaces to use the default settings instead of your cached settings, you can disable Settings Sync. For more information, see "[Managing your preferences for Settings Sync](/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account#managing-your-preferences-for-settings-sync)." +When you turn off Settings Sync in a codespace, new codespaces continue to use the settings cached from the last time your settings were pushed to the cloud. If you use the {% data variables.product.prodname_vscode_shortname %} web client for codespaces, and want codespaces to use the default settings instead of your cached settings, you can disable Settings Sync. For more information, see [Managing your preferences for Settings Sync](/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account#managing-your-preferences-for-settings-sync). If you want to return to using the default {% data variables.product.prodname_vscode_shortname %} settings in all instances of {% data variables.product.prodname_vscode_shortname %}, including the desktop application, you can clear the cache in the cloud when you turn off Settings Sync. -1. If Settings Sync is currently turned off in your instance of {% data variables.product.prodname_vscode_shortname %}, and you want to clear your cached settings, you must first turn it on. For instructions, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account#turning-on-settings-sync-in-a-codespace)." +1. If Settings Sync is currently turned off in your instance of {% data variables.product.prodname_vscode_shortname %}, and you want to clear your cached settings, you must first turn it on. For instructions, see [AUTOTITLE](/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account#turning-on-settings-sync-in-a-codespace). 1. At the bottom of the Activity Bar, select {% octicon "gear" aria-label="The gear icon" %} and click **Settings Sync is On**. 1. In the dropdown, click **Settings Sync: Turn Off**. diff --git a/data/reusables/codespaces/edit-devcontainer-json.md b/data/reusables/codespaces/edit-devcontainer-json.md index 1d6a768e74c8..ab7c02a89c57 100644 --- a/data/reusables/codespaces/edit-devcontainer-json.md +++ b/data/reusables/codespaces/edit-devcontainer-json.md @@ -1 +1 @@ -1. You can configure the codespaces that are created for your repository by adding settings to a `devcontainer.json` file. If your repository doesn't already contain a `devcontainer.json` file, you can add one now. See "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration)." +1. You can configure the codespaces that are created for your repository by adding settings to a `devcontainer.json` file. If your repository doesn't already contain a `devcontainer.json` file, you can add one now. See [AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration). diff --git a/data/reusables/codespaces/emus-create-codespaces.md b/data/reusables/codespaces/emus-create-codespaces.md index 38e8e652a723..4dc9baf9c00c 100644 --- a/data/reusables/codespaces/emus-create-codespaces.md +++ b/data/reusables/codespaces/emus-create-codespaces.md @@ -1 +1 @@ -If you have a {% data variables.enterprise.prodname_managed_user %}, you cannot create codespaces for your personal repositories, unless the repository is a fork of an organization-owned repository and you are allowed to use {% data variables.product.prodname_github_codespaces %} at the organization's expense. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users#abilities-and-restrictions-of-managed-user-accounts)." +If you have a {% data variables.enterprise.prodname_managed_user %}, you cannot create codespaces for your personal repositories, unless the repository is a fork of an organization-owned repository and you are allowed to use {% data variables.product.prodname_github_codespaces %} at the organization's expense. For more information, see [AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users#abilities-and-restrictions-of-managed-user-accounts). diff --git a/data/reusables/codespaces/exporting-changes.md b/data/reusables/codespaces/exporting-changes.md index 575a8220af18..550a51c4db3c 100644 --- a/data/reusables/codespaces/exporting-changes.md +++ b/data/reusables/codespaces/exporting-changes.md @@ -1 +1 @@ -If your personal, organization, or enterprise account reaches its spending limit, you will no longer be able to create or resume codespaces that are billable to that account. However, you can still export any work-in-progress changes to a new branch. For more information, see "[AUTOTITLE](/codespaces/troubleshooting/exporting-changes-to-a-branch)." +If your personal, organization, or enterprise account reaches its spending limit, you will no longer be able to create or resume codespaces that are billable to that account. However, you can still export any work-in-progress changes to a new branch. For more information, see [AUTOTITLE](/codespaces/troubleshooting/exporting-changes-to-a-branch). diff --git a/data/reusables/codespaces/forwarded-ports-environment-variable.md b/data/reusables/codespaces/forwarded-ports-environment-variable.md index 29b139f84f0c..5c42a06a132c 100644 --- a/data/reusables/codespaces/forwarded-ports-environment-variable.md +++ b/data/reusables/codespaces/forwarded-ports-environment-variable.md @@ -1 +1 @@ -The domain {% data variables.product.prodname_dotcom %} uses for port forwarding may change from time to time. If you reference a forwarded port in your code, for example in a test, we recommend that you use an environment variable instead of hardcoding the URL. For more information, see "[AUTOTITLE](/codespaces/developing-in-codespaces/default-environment-variables-for-your-codespace#list-of-default-environment-variables)." +The domain {% data variables.product.prodname_dotcom %} uses for port forwarding may change from time to time. If you reference a forwarded port in your code, for example in a test, we recommend that you use an environment variable instead of hardcoding the URL. For more information, see [AUTOTITLE](/codespaces/developing-in-codespaces/default-environment-variables-for-your-codespace#list-of-default-environment-variables). diff --git a/data/reusables/codespaces/full-rebuild-tip.md b/data/reusables/codespaces/full-rebuild-tip.md index d0513894d1c7..78dc2262a089 100644 --- a/data/reusables/codespaces/full-rebuild-tip.md +++ b/data/reusables/codespaces/full-rebuild-tip.md @@ -1,2 +1,2 @@ > [!TIP] -> You may occasionally want to perform a full rebuild to clear your cache and rebuild your container with fresh images. For more information, see "[AUTOTITLE](/codespaces/developing-in-codespaces/rebuilding-the-container-in-a-codespace#about-rebuilding-a-container)." +> You may occasionally want to perform a full rebuild to clear your cache and rebuild your container with fresh images. For more information, see [AUTOTITLE](/codespaces/developing-in-codespaces/rebuilding-the-container-in-a-codespace#about-rebuilding-a-container). diff --git a/data/reusables/codespaces/gpg-in-active-codespaces.md b/data/reusables/codespaces/gpg-in-active-codespaces.md index 7f712caaaa1b..dd8fbb6a65f0 100644 --- a/data/reusables/codespaces/gpg-in-active-codespaces.md +++ b/data/reusables/codespaces/gpg-in-active-codespaces.md @@ -1 +1 @@ -Once you enable GPG verification, it will automatically take effect in any new codespaces you create from the relevant repositories. To have GPG verification take effect in an existing active codespace, you will need to stop and restart the codespace. For more information, see "[AUTOTITLE](/codespaces/developing-in-codespaces/stopping-and-starting-a-codespace)." +Once you enable GPG verification, it will automatically take effect in any new codespaces you create from the relevant repositories. To have GPG verification take effect in an existing active codespace, you will need to stop and restart the codespace. For more information, see [AUTOTITLE](/codespaces/developing-in-codespaces/stopping-and-starting-a-codespace). diff --git a/data/reusables/codespaces/jupyterlab-in-default-image.md b/data/reusables/codespaces/jupyterlab-in-default-image.md index 3772a074c55c..508bab46b30c 100644 --- a/data/reusables/codespaces/jupyterlab-in-default-image.md +++ b/data/reusables/codespaces/jupyterlab-in-default-image.md @@ -1 +1 @@ -The default dev container image includes JupyterLab, so codespaces created from the default image will always have JupyterLab installed. For more information about the default image, see "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers#using-the-default-dev-container-configuration)" and the [`devcontainers/images`](https://github.com/devcontainers/images/tree/main/src/universal) repository. If you're not using the default image in your dev container configuration, you can install JupyterLab by adding the `ghcr.io/devcontainers/features/python` feature to your `devcontainer.json` file. You should include the option `"installJupyterlab": true`. For more information, see the README for the [`python`](https://github.com/devcontainers/features/tree/main/src/python#python-python) feature, in the `devcontainers/features` repository. +The default dev container image includes JupyterLab, so codespaces created from the default image will always have JupyterLab installed. For more information about the default image, see [AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers#using-the-default-dev-container-configuration) and the [`devcontainers/images`](https://github.com/devcontainers/images/tree/main/src/universal) repository. If you're not using the default image in your dev container configuration, you can install JupyterLab by adding the `ghcr.io/devcontainers/features/python` feature to your `devcontainer.json` file. You should include the option `"installJupyterlab": true`. For more information, see the README for the [`python`](https://github.com/devcontainers/features/tree/main/src/python#python-python) feature, in the `devcontainers/features` repository. diff --git a/data/reusables/codespaces/links-to-get-started.md b/data/reusables/codespaces/links-to-get-started.md index 7bddf800c234..5a4ffb3a48ae 100644 --- a/data/reusables/codespaces/links-to-get-started.md +++ b/data/reusables/codespaces/links-to-get-started.md @@ -1 +1 @@ -To get started with {% data variables.product.prodname_github_codespaces %}, see "[AUTOTITLE](/codespaces/getting-started/quickstart)." For more information on creating a codespace, see "[AUTOTITLE](/codespaces/developing-in-codespaces/creating-a-codespace-for-a-repository)" or "[AUTOTITLE](/codespaces/developing-in-codespaces/creating-a-codespace-from-a-template)." If you want to return to a codespace you've already created, see "[AUTOTITLE](/codespaces/developing-in-codespaces/opening-an-existing-codespace)." To learn more about how {% data variables.product.prodname_github_codespaces %} works, see "[AUTOTITLE](/codespaces/getting-started/deep-dive)." +To get started with {% data variables.product.prodname_github_codespaces %}, see [AUTOTITLE](/codespaces/getting-started/quickstart). For more information on creating a codespace, see [AUTOTITLE](/codespaces/developing-in-codespaces/creating-a-codespace-for-a-repository) or [AUTOTITLE](/codespaces/developing-in-codespaces/creating-a-codespace-from-a-template). If you want to return to a codespace you've already created, see [AUTOTITLE](/codespaces/developing-in-codespaces/opening-an-existing-codespace). To learn more about how {% data variables.product.prodname_github_codespaces %} works, see [AUTOTITLE](/codespaces/getting-started/deep-dive). diff --git a/data/reusables/codespaces/next-steps-adding-devcontainer.md b/data/reusables/codespaces/next-steps-adding-devcontainer.md index 71849136838f..a44c08bc3a7b 100644 --- a/data/reusables/codespaces/next-steps-adding-devcontainer.md +++ b/data/reusables/codespaces/next-steps-adding-devcontainer.md @@ -1,6 +1,6 @@ Here are some additional resources for more advanced scenarios. -* "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/configuring-dev-containers/adding-features-to-a-devcontainer-file?tool=webui)" -* "[AUTOTITLE](/codespaces/managing-your-codespaces/managing-your-account-specific-secrets-for-github-codespaces)" -* "[AUTOTITLE](/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces)" -* "[AUTOTITLE](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace)" +* [AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/configuring-dev-containers/adding-features-to-a-devcontainer-file?tool=webui) +* [AUTOTITLE](/codespaces/managing-your-codespaces/managing-your-account-specific-secrets-for-github-codespaces) +* [AUTOTITLE](/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces) +* [AUTOTITLE](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace) diff --git a/data/reusables/codespaces/opening-codespace-in-jetbrains.md b/data/reusables/codespaces/opening-codespace-in-jetbrains.md index d6cd82fb44c1..9f42bbd932e7 100644 --- a/data/reusables/codespaces/opening-codespace-in-jetbrains.md +++ b/data/reusables/codespaces/opening-codespace-in-jetbrains.md @@ -1,6 +1,6 @@ If you have set the JetBrains Gateway as your default editor, then the Gateway will launch automatically when you open a codespace from {% data variables.product.github %}. -If the JetBrains Gateway is not your default editor, you can still open a codespace in JetBrains by going to the "Your codespaces" page at [github.com/codespaces](https://github.com/codespaces) and clicking the ellipsis (...) to the right of the codespace you want to open. For more information, see "[AUTOTITLE](/codespaces/developing-in-codespaces/opening-an-existing-codespace?tool=webui)." +If the JetBrains Gateway is not your default editor, you can still open a codespace in JetBrains by going to the "Your codespaces" page at [github.com/codespaces](https://github.com/codespaces) and clicking the ellipsis (...) to the right of the codespace you want to open. For more information, see [AUTOTITLE](/codespaces/developing-in-codespaces/opening-an-existing-codespace?tool=webui). Alternatively, you can also open the JetBrains Gateway and select an existing codespace, as described in the following procedure. @@ -22,6 +22,6 @@ Alternatively, you can also open the JetBrains Gateway and select an existing co > [!NOTE] > * If you chose Rider as your JetBrains IDE and the repository contains multiple solution files, the "Set Solution Path" dialog is displayed prompting you to choose which solution you want to work in. Choose a solution file from the dropdown menu and click **OK**. > - > If the repository doesn't have a solution file, Rider opens in a basic project directory view and will have limited capabilities. For instance, you won't get .NET-specific code navigation. If there is just a single solution file in the repository it will be used automatically, without the prompt being displayed. For more information, see "[Create and open projects and solutions](https://www.jetbrains.com/help/rider/Creating_and_Opening_Projects_and_Solutions.html)" in the JetBrains documentation.

+ > If the repository doesn't have a solution file, Rider opens in a basic project directory view and will have limited capabilities. For instance, you won't get .NET-specific code navigation. If there is just a single solution file in the repository it will be used automatically, without the prompt being displayed. For more information, see [Create and open projects and solutions](https://www.jetbrains.com/help/rider/Creating_and_Opening_Projects_and_Solutions.html) in the JetBrains documentation.

> > * If you are running a firewall, then the first time you connect to a remote resource you may be prompted to allow the JetBrains Gateway to communicate across your network. diff --git a/data/reusables/codespaces/permanent-codespace-names.md b/data/reusables/codespaces/permanent-codespace-names.md index 4b9c39ce5964..e32e9d8a1bec 100644 --- a/data/reusables/codespaces/permanent-codespace-names.md +++ b/data/reusables/codespaces/permanent-codespace-names.md @@ -7,4 +7,4 @@ To find the permanent name of a codespace, do one of the following: * In a codespace, use this command in the terminal: `echo $CODESPACE_NAME`. * If {% data variables.product.prodname_cli %} is installed, either locally or in a codespace, use this command in the terminal to list all of your codespaces: `gh codespace list`. -The permanent name the codespace is also included in many of the log files. For example, in the {% data variables.product.prodname_github_codespaces %} extension log, after `fetching codespace` or `Connecting to codespace`, and in the browser console log after `clientUrl`. For more information, see "[AUTOTITLE](/codespaces/troubleshooting/github-codespaces-logs)." +The permanent name the codespace is also included in many of the log files. For example, in the {% data variables.product.prodname_github_codespaces %} extension log, after `fetching codespace` or `Connecting to codespace`, and in the browser console log after `clientUrl`. For more information, see [AUTOTITLE](/codespaces/troubleshooting/github-codespaces-logs). diff --git a/data/reusables/codespaces/port-forwarding-adding-non-jetbrains.md b/data/reusables/codespaces/port-forwarding-adding-non-jetbrains.md index 8de1805e4e8f..769739def4db 100644 --- a/data/reusables/codespaces/port-forwarding-adding-non-jetbrains.md +++ b/data/reusables/codespaces/port-forwarding-adding-non-jetbrains.md @@ -1,6 +1,6 @@ ## Automatically forwarding a port -You can add a forwarded port to the {% data variables.product.prodname_github_codespaces %} configuration for the repository, so that the port will be automatically forwarded for all codespaces created from the repository. After you update the configuration, any previously created codespaces must be rebuilt for the change to apply. For more information about the dev container configuration file, see "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers#applying-configuration-changes-to-a-codespace)." +You can add a forwarded port to the {% data variables.product.prodname_github_codespaces %} configuration for the repository, so that the port will be automatically forwarded for all codespaces created from the repository. After you update the configuration, any previously created codespaces must be rebuilt for the change to apply. For more information about the dev container configuration file, see [AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers#applying-configuration-changes-to-a-codespace). 1. In your codespace, open the dev container configuration file you want to update. Typically this file is `.devcontainer/devcontainer.json`. 1. Add the `forwardPorts` property. diff --git a/data/reusables/codespaces/port-forwarding-sharing-non-jetbrains.md b/data/reusables/codespaces/port-forwarding-sharing-non-jetbrains.md index 6bc8540ae1b3..74435aeabe68 100644 --- a/data/reusables/codespaces/port-forwarding-sharing-non-jetbrains.md +++ b/data/reusables/codespaces/port-forwarding-sharing-non-jetbrains.md @@ -6,4 +6,4 @@ If you want to share a forwarded port with others, you can either make the port private to your organization or make the port public. After you make a port private to your organization, anyone in the organization with the port's URL can view the running application. After you make a port public, anyone who knows the URL and port number can view the running application without needing to authenticate. > [!NOTE] -> Your choice of port visibility options may be limited by a policy configured for your organization. For more information, see "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/restricting-the-visibility-of-forwarded-ports)." +> Your choice of port visibility options may be limited by a policy configured for your organization. For more information, see [AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/restricting-the-visibility-of-forwarded-ports). diff --git a/data/reusables/codespaces/prebuilds-crossreference.md b/data/reusables/codespaces/prebuilds-crossreference.md index 2a7b165787c4..d7468450d0a2 100644 --- a/data/reusables/codespaces/prebuilds-crossreference.md +++ b/data/reusables/codespaces/prebuilds-crossreference.md @@ -1 +1 @@ -To speed up codespace creation, repository administrators can enable {% data variables.product.prodname_github_codespaces %} prebuilds for a repository. For more information, see "[AUTOTITLE](/codespaces/prebuilding-your-codespaces/about-github-codespaces-prebuilds)." +To speed up codespace creation, repository administrators can enable {% data variables.product.prodname_github_codespaces %} prebuilds for a repository. For more information, see [AUTOTITLE](/codespaces/prebuilding-your-codespaces/about-github-codespaces-prebuilds). diff --git a/data/reusables/codespaces/prebuilds-permission-authorization.md b/data/reusables/codespaces/prebuilds-permission-authorization.md index 3d7736cc6c3b..f84cdd827260 100644 --- a/data/reusables/codespaces/prebuilds-permission-authorization.md +++ b/data/reusables/codespaces/prebuilds-permission-authorization.md @@ -1,4 +1,4 @@ - If the dev container configuration for the repository specifies permissions for accessing other repositories, you will be shown an authorization page. For more information on how this is specified in the `devcontainer.json` file, see "[AUTOTITLE](/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces)." + If the dev container configuration for the repository specifies permissions for accessing other repositories, you will be shown an authorization page. For more information on how this is specified in the `devcontainer.json` file, see [AUTOTITLE](/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces). Click {% octicon "chevron-down" aria-label="The expand down icon" %} to view the details of the requested permissions. diff --git a/data/reusables/codespaces/rebuild-note.md b/data/reusables/codespaces/rebuild-note.md index 1a82d1b1dba2..bf1e5ffc53f1 100644 --- a/data/reusables/codespaces/rebuild-note.md +++ b/data/reusables/codespaces/rebuild-note.md @@ -1,2 +1,2 @@ > [!NOTE] -> When you rebuild the container in a codespace, changes you have made outside the `/workspaces` directory are cleared. Changes you have made inside the `/workspaces` directory, which includes the clone of the repository or template from which you created the codespace, are preserved over a rebuild. For more information, see "[AUTOTITLE](/codespaces/getting-started/deep-dive#about-the-directory-structure-of-a-codespace)." +> When you rebuild the container in a codespace, changes you have made outside the `/workspaces` directory are cleared. Changes you have made inside the `/workspaces` directory, which includes the clone of the repository or template from which you created the codespace, are preserved over a rebuild. For more information, see [AUTOTITLE](/codespaces/getting-started/deep-dive#about-the-directory-structure-of-a-codespace). diff --git a/data/reusables/codespaces/restrict-port-visibility.md b/data/reusables/codespaces/restrict-port-visibility.md index 09267ba86e16..603edaa44a18 100644 --- a/data/reusables/codespaces/restrict-port-visibility.md +++ b/data/reusables/codespaces/restrict-port-visibility.md @@ -1 +1 @@ -Organization owners can restrict the ability to make forward ports available publicly or within the organization. For more information, see "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/restricting-the-visibility-of-forwarded-ports)." +Organization owners can restrict the ability to make forward ports available publicly or within the organization. For more information, see [AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/restricting-the-visibility-of-forwarded-ports). diff --git a/data/reusables/codespaces/secrets-on-start.md b/data/reusables/codespaces/secrets-on-start.md index c9dd8104bf4d..2f2284a3ea48 100644 --- a/data/reusables/codespaces/secrets-on-start.md +++ b/data/reusables/codespaces/secrets-on-start.md @@ -1 +1 @@ -Once you have created a secret, it will be available when you create a new codespace or restart the codespace. If you've created a secret on {% data variables.product.github %} and you want to use it in a currently running codespace, stop the codespace and then restart it. For information about stopping the codespace, see "[AUTOTITLE](/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces#suspending-or-stopping-a-codespace)." +Once you have created a secret, it will be available when you create a new codespace or restart the codespace. If you've created a secret on {% data variables.product.github %} and you want to use it in a currently running codespace, stop the codespace and then restart it. For information about stopping the codespace, see [AUTOTITLE](/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces#suspending-or-stopping-a-codespace). diff --git a/data/reusables/codespaces/setting-up-project-intro.md b/data/reusables/codespaces/setting-up-project-intro.md index e4271e1018aa..015e3621231c 100644 --- a/data/reusables/codespaces/setting-up-project-intro.md +++ b/data/reusables/codespaces/setting-up-project-intro.md @@ -2,4 +2,4 @@ in {% data variables.product.prodname_github_codespaces %} using the {% data var After you complete this tutorial, you'll be able to add a dev container configuration to your own repository, using either the {% data variables.product.prodname_vscode_shortname %} web client or the {% data variables.product.prodname_vscode_shortname %} desktop application. -For more information about dev containers, see "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers)." +For more information about dev containers, see [AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers). diff --git a/data/reusables/codespaces/settings-sync-and-gpg.md b/data/reusables/codespaces/settings-sync-and-gpg.md index 99aa82182d03..92893c4e15eb 100644 --- a/data/reusables/codespaces/settings-sync-and-gpg.md +++ b/data/reusables/codespaces/settings-sync-and-gpg.md @@ -1,4 +1,4 @@ Your list of trusted repositories for {% data variables.product.prodname_github_codespaces %} is shared between the GPG verification and Settings Sync features. Assuming you have both features enabled, if you have added a selected list of trusted repositories for GPG verification, Settings Sync is turned on in codespaces created from these repositories. If you trust a new repository for Settings Sync, GPG verification is enabled for the same repository. Although the features share the same list of trusted repositories, you can enable or disable GPG verification and Settings Sync independently. > [!NOTE] -> If you have previously enabled GPG verification for all repositories, we recommend changing your preferences to use a selected list of trusted repositories. For more information, see "[AUTOTITLE](/codespaces/codespaces-reference/security-in-github-codespaces#using-settings-sync)." +> If you have previously enabled GPG verification for all repositories, we recommend changing your preferences to use a selected list of trusted repositories. For more information, see [AUTOTITLE](/codespaces/codespaces-reference/security-in-github-codespaces#using-settings-sync). diff --git a/data/reusables/codespaces/settings-sync-link.md b/data/reusables/codespaces/settings-sync-link.md index 576d20ba6953..2423431dc95d 100644 --- a/data/reusables/codespaces/settings-sync-link.md +++ b/data/reusables/codespaces/settings-sync-link.md @@ -1 +1 @@ -You can use Settings Sync to share these settings across all codespaces you open in the {% data variables.product.prodname_vscode_shortname %} web client and desktop application. If you're working in the web client, Settings Sync is disabled by default, and you must enable Settings Sync to push changes to your settings or pull in new changes you have made elsewhere. For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account#settings-sync)." +You can use Settings Sync to share these settings across all codespaces you open in the {% data variables.product.prodname_vscode_shortname %} web client and desktop application. If you're working in the web client, Settings Sync is disabled by default, and you must enable Settings Sync to push changes to your settings or pull in new changes you have made elsewhere. For more information, see [AUTOTITLE](/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account#settings-sync). diff --git a/data/reusables/codespaces/setup-custom-devcontainer.md b/data/reusables/codespaces/setup-custom-devcontainer.md index 0cea927e243e..aa077b51c7da 100644 --- a/data/reusables/codespaces/setup-custom-devcontainer.md +++ b/data/reusables/codespaces/setup-custom-devcontainer.md @@ -1 +1 @@ -To set up your repository to use a custom dev container, you will need to create one or more `devcontainer.json` files. You can either add these from a predefined configuration template, in {% data variables.product.prodname_vscode %}, or you can write your own. For more information on dev container configurations, see "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers)." +To set up your repository to use a custom dev container, you will need to create one or more `devcontainer.json` files. You can either add these from a predefined configuration template, in {% data variables.product.prodname_vscode %}, or you can write your own. For more information on dev container configurations, see [AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers). diff --git a/data/reusables/codespaces/source-control.md b/data/reusables/codespaces/source-control.md index 9dc5c6fc90d7..f30abcdcc9cb 100644 --- a/data/reusables/codespaces/source-control.md +++ b/data/reusables/codespaces/source-control.md @@ -1,6 +1,6 @@ ## Publishing a codespace created from a template -When you create a codespace from a template repository or a template on the "Your codespaces" page, the work you do won't be stored in a repository on {% data variables.product.prodname_dotcom %} until you publish your codespace. For more information, see "[AUTOTITLE](/codespaces/developing-in-codespaces/creating-a-codespace-from-a-template#publishing-to-a-repository-on-github)." +When you create a codespace from a template repository or a template on the "Your codespaces" page, the work you do won't be stored in a repository on {% data variables.product.prodname_dotcom %} until you publish your codespace. For more information, see [AUTOTITLE](/codespaces/developing-in-codespaces/creating-a-codespace-from-a-template#publishing-to-a-repository-on-github). {% data reusables.codespaces.publishing-template-codespaces %} @@ -37,7 +37,7 @@ You can pull changes from the remote repository into your codespace at any time. 1. In the dropdown menu, click **Pull**. -If the dev container configuration has been changed since you created the codespace, you can apply the changes by rebuilding the container for the codespace. For more information, see "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers#applying-changes-to-your-configuration)." +If the dev container configuration has been changed since you created the codespace, you can apply the changes by rebuilding the container for the codespace. For more information, see [AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers#applying-changes-to-your-configuration). ## Setting your codespace to automatically fetch new changes diff --git a/data/reusables/codespaces/stopping-a-codespace.md b/data/reusables/codespaces/stopping-a-codespace.md index 7927116623b1..05f2b3fc5ece 100644 --- a/data/reusables/codespaces/stopping-a-codespace.md +++ b/data/reusables/codespaces/stopping-a-codespace.md @@ -1,6 +1,6 @@ You can stop a codespace at any time. When you stop a codespace, any running processes are stopped. Any saved changes in your codespace will still be available when you next start it. The terminal history is preserved, but the visible contents of the terminal window are not preserved between codespace sessions. -If you do not explicitly stop a codespace, it will continue to run until it times out from inactivity. Closing a codespace does not stop the codespace. For example, if you're using a codespace in the {% data variables.product.prodname_vscode_shortname %} web client and you close the browser tab, the codespace remains running on the remote machine. For information about timeouts, see "[AUTOTITLE](/codespaces/getting-started/the-codespace-lifecycle#timeouts-for-github-codespaces)." +If you do not explicitly stop a codespace, it will continue to run until it times out from inactivity. Closing a codespace does not stop the codespace. For example, if you're using a codespace in the {% data variables.product.prodname_vscode_shortname %} web client and you close the browser tab, the codespace remains running on the remote machine. For information about timeouts, see [AUTOTITLE](/codespaces/getting-started/the-codespace-lifecycle#timeouts-for-github-codespaces). Only running codespaces incur CPU charges. A stopped codespace incurs only storage costs. diff --git a/data/reusables/codespaces/template-codespaces-default-editor.md b/data/reusables/codespaces/template-codespaces-default-editor.md index ce53ebf2e1db..54194d0a1b0c 100644 --- a/data/reusables/codespaces/template-codespaces-default-editor.md +++ b/data/reusables/codespaces/template-codespaces-default-editor.md @@ -1 +1 @@ -When you create a new codespace from a template, it is always opened in the {% data variables.product.prodname_vscode %} web client. You can reopen an existing codespace in any supported editor. For more information, see "[AUTOTITLE](/codespaces/developing-in-codespaces/opening-an-existing-codespace)." +When you create a new codespace from a template, it is always opened in the {% data variables.product.prodname_vscode %} web client. You can reopen an existing codespace in any supported editor. For more information, see [AUTOTITLE](/codespaces/developing-in-codespaces/opening-an-existing-codespace). diff --git a/data/reusables/codespaces/tips-included-usage.md b/data/reusables/codespaces/tips-included-usage.md index 829e7758b880..cd1a997640aa 100644 --- a/data/reusables/codespaces/tips-included-usage.md +++ b/data/reusables/codespaces/tips-included-usage.md @@ -1 +1 @@ -For tips on making your allowed usage go further, see "[AUTOTITLE](/codespaces/troubleshooting/troubleshooting-included-usage)." +For tips on making your allowed usage go further, see [AUTOTITLE](/codespaces/troubleshooting/troubleshooting-included-usage). diff --git a/data/reusables/codespaces/troubleshooting-simple-browser.md b/data/reusables/codespaces/troubleshooting-simple-browser.md index f9228720b783..7ad6d163fa1d 100644 --- a/data/reusables/codespaces/troubleshooting-simple-browser.md +++ b/data/reusables/codespaces/troubleshooting-simple-browser.md @@ -41,7 +41,7 @@ To implement the port configuration specified in `devcontainer.json`, {% data va } ``` -If the `settings.json` file doesn't contain these settings, check whether you have dotfiles enabled, and whether any configuration in your dotfiles is overwriting the `settings.json` file. For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account#dotfiles)." +If the `settings.json` file doesn't contain these settings, check whether you have dotfiles enabled, and whether any configuration in your dotfiles is overwriting the `settings.json` file. For more information, see [AUTOTITLE](/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account#dotfiles). #### The application does not load diff --git a/data/reusables/codespaces/trusted-repos-step.md b/data/reusables/codespaces/trusted-repos-step.md index e034be13f29e..baa96fd78421 100644 --- a/data/reusables/codespaces/trusted-repos-step.md +++ b/data/reusables/codespaces/trusted-repos-step.md @@ -1,4 +1,4 @@ 1. To change your trusted repositories for GPG verification and Settings Sync, under "Trusted repositories," either select **All repositories**, or select **Selected repositories** and use the "Select repositories" dropdown to add repositories you trust. > [!NOTE] - > We recommend using a selected list of trusted repositories. For more information, see "[AUTOTITLE](/codespaces/codespaces-reference/security-in-github-codespaces#using-settings-sync)." + > We recommend using a selected list of trusted repositories. For more information, see [AUTOTITLE](/codespaces/codespaces-reference/security-in-github-codespaces#using-settings-sync). diff --git a/data/reusables/codespaces/when-you-can-create-codespaces.md b/data/reusables/codespaces/when-you-can-create-codespaces.md index fda1a3904dfa..e40beb41d2c2 100644 --- a/data/reusables/codespaces/when-you-can-create-codespaces.md +++ b/data/reusables/codespaces/when-you-can-create-codespaces.md @@ -1 +1 @@ -Your ability to create codespaces from organization-owned repositories depends on several factors, including the repository's visibility and the settings of the organization or its parent enterprise. For more information, see "[AUTOTITLE](/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces#no-access-to-create-a-codespace)." +Your ability to create codespaces from organization-owned repositories depends on several factors, including the repository's visibility and the settings of the organization or its parent enterprise. For more information, see [AUTOTITLE](/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces#no-access-to-create-a-codespace). diff --git a/data/reusables/command-palette/default.md b/data/reusables/command-palette/default.md index 1cdb2670f58f..feeacddb72ee 100644 --- a/data/reusables/command-palette/default.md +++ b/data/reusables/command-palette/default.md @@ -1 +1 @@ -The {% data variables.product.prodname_command_palette %} is deactivated by default. You can enable the {% data variables.product.prodname_command_palette %} with feature preview. See "[AUTOTITLE](/get-started/using-github/exploring-early-access-releases-with-feature-preview)." +The {% data variables.product.prodname_command_palette %} is deactivated by default. You can enable the {% data variables.product.prodname_command_palette %} with feature preview. See [AUTOTITLE](/get-started/using-github/exploring-early-access-releases-with-feature-preview). diff --git a/data/reusables/command_line/provide-an-access-token.md b/data/reusables/command_line/provide-an-access-token.md index 4090a883cb9c..05758d334a19 100644 --- a/data/reusables/command_line/provide-an-access-token.md +++ b/data/reusables/command_line/provide-an-access-token.md @@ -1 +1 @@ -{% ifversion fpt or ghec %}If you are accessing an organization that uses SAML SSO{% ifversion pat-v2 %} and you are using a {% data variables.product.pat_v1 %}{% endif %}, you must also authorize your {% data variables.product.pat_generic %} to access the organization before you authenticate. For more information, see "[AUTOTITLE](/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on)" and "[AUTOTITLE](/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)."{% endif %} +{% ifversion fpt or ghec %}If you are accessing an organization that uses SAML SSO{% ifversion pat-v2 %} and you are using a {% data variables.product.pat_v1 %}{% endif %}, you must also authorize your {% data variables.product.pat_generic %} to access the organization before you authenticate. For more information, see [AUTOTITLE](/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on) and [AUTOTITLE](/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on).{% endif %} diff --git a/data/reusables/community/tools-for-moderating.md b/data/reusables/community/tools-for-moderating.md index 5a1f67c9fe75..fb147236e14c 100644 --- a/data/reusables/community/tools-for-moderating.md +++ b/data/reusables/community/tools-for-moderating.md @@ -1 +1 @@ -When disruptive behavior occurs in your community, {% data variables.product.prodname_dotcom %} offers tools for applying your code of conduct and de-escalating conflict. For example, you can lock a conversation to defuse a heated interaction. For more information, see "[AUTOTITLE](/communities/moderating-comments-and-conversations)." +When disruptive behavior occurs in your community, {% data variables.product.prodname_dotcom %} offers tools for applying your code of conduct and de-escalating conflict. For example, you can lock a conversation to defuse a heated interaction. For more information, see [AUTOTITLE](/communities/moderating-comments-and-conversations). diff --git a/data/reusables/copilot-business-for-non-ghe/link-azure-subscription.md b/data/reusables/copilot-business-for-non-ghe/link-azure-subscription.md index ae5c5ed57853..80e5f686e813 100644 --- a/data/reusables/copilot-business-for-non-ghe/link-azure-subscription.md +++ b/data/reusables/copilot-business-for-non-ghe/link-azure-subscription.md @@ -1,6 +1,6 @@ To pay for licenses, you must connect your enterprise to an Azure subscription. For instructions, read the following sections in the "Connecting an Azure subscription" article: -* "[Prerequisites](/billing/managing-the-plan-for-your-github-account/connecting-an-azure-subscription#prerequisites)" -* "[Connecting your Azure subscription to an enterprise account](/billing/managing-the-plan-for-your-github-account/connecting-an-azure-subscription#connecting-your-azure-subscription-to-your-enterprise-account)" +* [Prerequisites](/billing/managing-the-plan-for-your-github-account/connecting-an-azure-subscription#prerequisites) +* [Connecting your Azure subscription to an enterprise account](/billing/managing-the-plan-for-your-github-account/connecting-an-azure-subscription#connecting-your-azure-subscription-to-your-enterprise-account) If you prefer a visual overview of the process, watch [Billing {% data variables.product.company_short %} consumption through an Azure subscription](https://www.youtube.com/watch?v=Y-f7JKJ4_8Y) on our YouTube channel. diff --git a/data/reusables/copilot-business-for-non-ghe/manage-your-enterprise.md b/data/reusables/copilot-business-for-non-ghe/manage-your-enterprise.md index f57328a1a10a..d75d6bd5c4a3 100644 --- a/data/reusables/copilot-business-for-non-ghe/manage-your-enterprise.md +++ b/data/reusables/copilot-business-for-non-ghe/manage-your-enterprise.md @@ -1,4 +1,4 @@ -For next steps that apply to any enterprise using {% data variables.product.prodname_copilot_business_short %}, see "[AUTOTITLE](/copilot/setting-up-github-copilot/setting-up-github-copilot-for-your-enterprise)." The step for granting access to organizations does not apply. +For next steps that apply to any enterprise using {% data variables.product.prodname_copilot_business_short %}, see [AUTOTITLE](/copilot/setting-up-github-copilot/setting-up-github-copilot-for-your-enterprise). The step for granting access to organizations does not apply. The following sections contain specific information for your enterprise. @@ -6,13 +6,13 @@ The following sections contain specific information for your enterprise. You can use the REST API to automate license management. For example, you can list assigned licenses and latest activity, then remove access for users who haven't been using their license. -To do this in your enterprise, you can use the "[List all {% data variables.product.prodname_copilot_short %} seat assignments for an enterprise](/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-enterprise)" endpoint, then use the API to manage access to enterprise teams. To request documentation for the API endpoints for enterprise teams, please contact your account manager. +To do this in your enterprise, you can use the [List all {% data variables.product.prodname_copilot_short %} seat assignments for an enterprise](/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-enterprise) endpoint, then use the API to manage access to enterprise teams. To request documentation for the API endpoints for enterprise teams, please contact your account manager. ### Manage billing Your enterprise has access to the enhanced billing platform, which allows you to estimate upcoming spending, control overspending with budgets, and track spending changes over time. -See "[AUTOTITLE](/billing/using-the-enhanced-billing-platform-for-enterprises)." +See [AUTOTITLE](/billing/using-the-enhanced-billing-platform-for-enterprises). ### Configure content exclusions @@ -20,4 +20,4 @@ You can prevent specified files or repositories from being used to inform code c {% data reusables.enterprise-accounts.policies-tab %} 1. Click the **Content exclusion** tab. -1. Use paths to specify which content to exclude. See "[AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/configuring-content-exclusions-for-github-copilot)." +1. Use paths to specify which content to exclude. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/configuring-content-exclusions-for-github-copilot). diff --git a/data/reusables/copilot/chat-access-denied.md b/data/reusables/copilot/chat-access-denied.md index dda6b1d31579..9353a5333e77 100644 --- a/data/reusables/copilot/chat-access-denied.md +++ b/data/reusables/copilot/chat-access-denied.md @@ -1 +1 @@ -If you have access to {% data variables.product.prodname_copilot %} via your organization{% ifversion ghec %} or enterprise{% endif %}, you won't be able to use {% data variables.product.prodname_copilot_chat %} if your organization owner{% ifversion ghec %} or enterprise administrator{% endif %} has disabled chat. See "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/managing-policies-and-features-for-copilot-in-your-organization)." +If you have access to {% data variables.product.prodname_copilot %} via your organization{% ifversion ghec %} or enterprise{% endif %}, you won't be able to use {% data variables.product.prodname_copilot_chat %} if your organization owner{% ifversion ghec %} or enterprise administrator{% endif %} has disabled chat. See [AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/managing-policies-and-features-for-copilot-in-your-organization). diff --git a/data/reusables/copilot/code-review/custom-coding-guidelines.md b/data/reusables/copilot/code-review/custom-coding-guidelines.md index bed3e0eca158..bd6066e7384e 100644 --- a/data/reusables/copilot/code-review/custom-coding-guidelines.md +++ b/data/reusables/copilot/code-review/custom-coding-guidelines.md @@ -1,5 +1,5 @@ {% data reusables.copilot.code-review.custom-coding-guidelines-prerequisites %} -When using {% data variables.copilot.copilot_code-review_short %} to review changes in {% data variables.product.prodname_vscode %} or the {% data variables.product.github %} website, you can customize {% data variables.product.prodname_copilot_short %}'s review with custom coding guidelines written in natural language. {% data variables.product.prodname_copilot_short %} will give feedback based on your coding guidelines when it reviews your code. For more information, see "[AUTOTITLE](/copilot/using-github-copilot/code-review/configuring-coding-guidelines)." +When using {% data variables.copilot.copilot_code-review_short %} to review changes in {% data variables.product.prodname_vscode %} or the {% data variables.product.github %} website, you can customize {% data variables.product.prodname_copilot_short %}'s review with custom coding guidelines written in natural language. {% data variables.product.prodname_copilot_short %} will give feedback based on your coding guidelines when it reviews your code. For more information, see [AUTOTITLE](/copilot/using-github-copilot/code-review/configuring-coding-guidelines). Comments generated based on a coding guideline will include a message, highlighting their source. diff --git a/data/reusables/copilot/content-exclusion-fnmatch-tip.md b/data/reusables/copilot/content-exclusion-fnmatch-tip.md index 16deb3797691..86002a03c6c9 100644 --- a/data/reusables/copilot/content-exclusion-fnmatch-tip.md +++ b/data/reusables/copilot/content-exclusion-fnmatch-tip.md @@ -1 +1 @@ -You can use fnmatch pattern matching notation to specify file paths. Patterns are case insensitive. See "[File](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch)" in the ruby-doc.org documentation. +You can use fnmatch pattern matching notation to specify file paths. Patterns are case insensitive. See [File](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch) in the ruby-doc.org documentation. diff --git a/data/reusables/copilot/content-exclusion-tooltip.md b/data/reusables/copilot/content-exclusion-tooltip.md index b977ee8fc75e..61284a05b7f1 100644 --- a/data/reusables/copilot/content-exclusion-tooltip.md +++ b/data/reusables/copilot/content-exclusion-tooltip.md @@ -2,4 +2,4 @@ If a file has been configured as excluded content for {% data variables.product. ![Screenshot of the {% data variables.product.prodname_copilot_short %} icon in {% data variables.product.prodname_vscode_shortname %} with a tooltip for a content exclusion.](/assets/images/help/copilot/copilot-disabled-for-repo.png) -For more information, see "[AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-github-copilot-features-in-your-organization/about-content-exclusions-for-github-copilot)." +For more information, see [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-github-copilot-features-in-your-organization/about-content-exclusions-for-github-copilot). diff --git a/data/reusables/copilot/copilot-chat-models-list-o1-preview.md b/data/reusables/copilot/copilot-chat-models-list-o1-preview.md index b58322cb07b7..44a39a26aa6d 100644 --- a/data/reusables/copilot/copilot-chat-models-list-o1-preview.md +++ b/data/reusables/copilot/copilot-chat-models-list-o1-preview.md @@ -10,4 +10,4 @@ The following models are currently available through multi-model {% data variabl For more information about the o1 models, see [Models](https://platform.openai.com/docs/models/models) in the OpenAI Platform documentation. -For more information about the {% data variables.copilot.copilot_claude_sonnet %} model from Anthropic, see "[AUTOTITLE](/copilot/using-github-copilot/using-claude-sonnet-in-github-copilot)." +For more information about the {% data variables.copilot.copilot_claude_sonnet %} model from Anthropic, see [AUTOTITLE](/copilot/using-github-copilot/using-claude-sonnet-in-github-copilot). diff --git a/data/reusables/copilot/copilot-chat-models-list-o1.md b/data/reusables/copilot/copilot-chat-models-list-o1.md index 3e29a6903f00..b68ec487514f 100644 --- a/data/reusables/copilot/copilot-chat-models-list-o1.md +++ b/data/reusables/copilot/copilot-chat-models-list-o1.md @@ -7,4 +7,4 @@ The following models are currently available through multi-model {% data variabl For more information about the o1 models, see [Models](https://platform.openai.com/docs/models/models) in the OpenAI Platform documentation. -For more information about the {% data variables.copilot.copilot_claude_sonnet %} model from Anthropic, see "[AUTOTITLE](/copilot/using-github-copilot/using-claude-sonnet-in-github-copilot)." +For more information about the {% data variables.copilot.copilot_claude_sonnet %} model from Anthropic, see [AUTOTITLE](/copilot/using-github-copilot/using-claude-sonnet-in-github-copilot). diff --git a/data/reusables/copilot/copilot-extensions/differences-between-agents-and-skillsets-2.md b/data/reusables/copilot/copilot-extensions/differences-between-agents-and-skillsets-2.md index 783bb9f187d1..39af0f6f9560 100644 --- a/data/reusables/copilot/copilot-extensions/differences-between-agents-and-skillsets-2.md +++ b/data/reusables/copilot/copilot-extensions/differences-between-agents-and-skillsets-2.md @@ -1 +1 @@ -* **Agents** are for complex integrations that need full control over how requests are processed and responses are generated. They let you implement custom logic, integrate with other LLMs and/or the Copilot API, manage conversation context, and handle all aspects of the user interaction. While Agents require more engineering and maintenance, they offer maximum flexibility for sophisticated workflows. For more information about agents, see "[AUTOTITLE](/copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/about-copilot-agents)." +* **Agents** are for complex integrations that need full control over how requests are processed and responses are generated. They let you implement custom logic, integrate with other LLMs and/or the Copilot API, manage conversation context, and handle all aspects of the user interaction. While Agents require more engineering and maintenance, they offer maximum flexibility for sophisticated workflows. For more information about agents, see [AUTOTITLE](/copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/about-copilot-agents). diff --git a/data/reusables/copilot/copilot-extensions/extending-copilot-chat.md b/data/reusables/copilot/copilot-extensions/extending-copilot-chat.md index 6c10c1287c58..1e4f83f4953c 100644 --- a/data/reusables/copilot/copilot-extensions/extending-copilot-chat.md +++ b/data/reusables/copilot/copilot-extensions/extending-copilot-chat.md @@ -2,4 +2,4 @@ {% data variables.product.prodname_copilot_extensions %} integrate the power of external tools into {% data variables.product.prodname_copilot_chat_short %}, helping you reduce context switching and receive responses with domain-specific context. You can install {% data variables.product.prodname_copilot_extensions_short %} from the {% data variables.product.prodname_marketplace %} or build private ones within your organization, then type `@` in a chat window to see a list of your available extensions. To use an extension, select the extension from the list or type the full slug name, then type your prompt. -To learn more, see "[AUTOTITLE](/copilot/using-github-copilot/using-extensions-to-integrate-external-tools-with-copilot-chat)." +To learn more, see [AUTOTITLE](/copilot/using-github-copilot/using-extensions-to-integrate-external-tools-with-copilot-chat). diff --git a/data/reusables/copilot/copilot-requires-subscription.md b/data/reusables/copilot/copilot-requires-subscription.md index 45d899e05d41..cb9545305f37 100644 --- a/data/reusables/copilot/copilot-requires-subscription.md +++ b/data/reusables/copilot/copilot-requires-subscription.md @@ -1 +1 @@ -You'll need a {% data variables.product.prodname_copilot %} subscription. For more information, see "[AUTOTITLE](/copilot/about-github-copilot/what-is-github-copilot#getting-access-to-copilot)." +You'll need a {% data variables.product.prodname_copilot %} subscription. For more information, see [AUTOTITLE](/copilot/about-github-copilot/what-is-github-copilot#getting-access-to-copilot). diff --git a/data/reusables/copilot/example-prompts/further-reading-items.md b/data/reusables/copilot/example-prompts/further-reading-items.md index 2a30fafb4a3b..9202381c6717 100644 --- a/data/reusables/copilot/example-prompts/further-reading-items.md +++ b/data/reusables/copilot/example-prompts/further-reading-items.md @@ -1,2 +1,2 @@ -* "[AUTOTITLE](/copilot/using-github-copilot/prompt-engineering-for-github-copilot)" -* "[AUTOTITLE](/copilot/using-github-copilot/best-practices-for-using-github-copilot)" +* [AUTOTITLE](/copilot/using-github-copilot/prompt-engineering-for-github-copilot) +* [AUTOTITLE](/copilot/using-github-copilot/best-practices-for-using-github-copilot) diff --git a/data/reusables/copilot/jetbrains-plugin-prerequisites.md b/data/reusables/copilot/jetbrains-plugin-prerequisites.md index db7b8703f465..cefcfcbcc414 100644 --- a/data/reusables/copilot/jetbrains-plugin-prerequisites.md +++ b/data/reusables/copilot/jetbrains-plugin-prerequisites.md @@ -1,2 +1,2 @@ -* **{% data variables.product.prodname_copilot %} plugin**. See the [{% data variables.product.prodname_copilot %} plugin](https://plugins.jetbrains.com/plugin/17718-github-copilot) in the JetBrains Marketplace. For installation instructions, see "[AUTOTITLE](/copilot/configuring-github-copilot/installing-the-github-copilot-extension-in-your-environment)." -* **Log in to {% data variables.product.company_short %} in your JetBrains IDE**. For authentication instructions, see "[AUTOTITLE](/copilot/configuring-github-copilot/installing-the-github-copilot-extension-in-your-environment?tool=jetbrains#installing-the-github-copilot-plugin-in-your-jetbrains-ide)." +* **{% data variables.product.prodname_copilot %} plugin**. See the [{% data variables.product.prodname_copilot %} plugin](https://plugins.jetbrains.com/plugin/17718-github-copilot) in the JetBrains Marketplace. For installation instructions, see [AUTOTITLE](/copilot/configuring-github-copilot/installing-the-github-copilot-extension-in-your-environment). +* **Log in to {% data variables.product.company_short %} in your JetBrains IDE**. For authentication instructions, see [AUTOTITLE](/copilot/configuring-github-copilot/installing-the-github-copilot-extension-in-your-environment?tool=jetbrains#installing-the-github-copilot-plugin-in-your-jetbrains-ide). diff --git a/data/reusables/copilot/link-to-vs-install-docs.md b/data/reusables/copilot/link-to-vs-install-docs.md index 04353eb60f68..882a1162943f 100644 --- a/data/reusables/copilot/link-to-vs-install-docs.md +++ b/data/reusables/copilot/link-to-vs-install-docs.md @@ -1 +1 @@ -For instructions on how to install the {% data variables.product.prodname_copilot_short %} extension, see "[Install GitHub Copilot in Visual Studio](https://learn.microsoft.com/visualstudio/ide/visual-studio-github-copilot-install-and-states)" in the Microsoft documentation. +For instructions on how to install the {% data variables.product.prodname_copilot_short %} extension, see [Install GitHub Copilot in Visual Studio](https://learn.microsoft.com/visualstudio/ide/visual-studio-github-copilot-install-and-states) in the Microsoft documentation. diff --git a/data/reusables/copilot/model-picker-enable-o1-models.md b/data/reusables/copilot/model-picker-enable-o1-models.md index 65a247ddec4c..cd177ba95ea7 100644 --- a/data/reusables/copilot/model-picker-enable-o1-models.md +++ b/data/reusables/copilot/model-picker-enable-o1-models.md @@ -1 +1 @@ -1. If you access {% data variables.product.prodname_copilot_chat_short %} through a {% data variables.product.prodname_copilot_business_short %}{% ifversion ghec %} or {% data variables.product.prodname_copilot_enterprise_short %}{% endif %} subscription, your organization{% ifversion ghec %} or enterprise{% endif %} must grant members the ability to switch to a different model. See "[AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization){% ifversion ghec %}" or "[AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise){% endif %}." +1. If you access {% data variables.product.prodname_copilot_chat_short %} through a {% data variables.product.prodname_copilot_business_short %}{% ifversion ghec %} or {% data variables.product.prodname_copilot_enterprise_short %}{% endif %} subscription, your organization{% ifversion ghec %} or enterprise{% endif %} must grant members the ability to switch to a different model. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization){% ifversion ghec %} or [AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise){% endif %}. diff --git a/data/reusables/copilot/policies-for-dotcom.md b/data/reusables/copilot/policies-for-dotcom.md index 965cd9a678da..e5359ea49948 100644 --- a/data/reusables/copilot/policies-for-dotcom.md +++ b/data/reusables/copilot/policies-for-dotcom.md @@ -1,5 +1,5 @@ -* **Opt in to user feedback collection:** If enabled, users can provide feedback on {% data variables.product.prodname_copilot_short %} pull request summaries. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/copilot/github-copilot-enterprise/copilot-pull-request-summaries/creating-a-pull-request-summary-with-github-copilot)." +* **Opt in to user feedback collection:** If enabled, users can provide feedback on {% data variables.product.prodname_copilot_short %} pull request summaries. For more information, see [AUTOTITLE](/enterprise-cloud@latest/copilot/github-copilot-enterprise/copilot-pull-request-summaries/creating-a-pull-request-summary-with-github-copilot). * **Opt in to preview features:** If enabled, users can test new {% data variables.product.prodname_copilot_short %} features that are not yet generally available. Be aware that previews of features may have flaws, and the features may be changed or discontinued at any time. Current previews of {% data variables.product.prodname_copilot_short %} features include: - * {% data variables.product.prodname_copilot_autocomplete_pr %}. See "[AUTOTITLE](/copilot/using-github-copilot/using-copilot-text-completion)." - * Asking {% data variables.product.prodname_copilot_short %} why a workflow has failed. See "[AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-githubcom#ask-why-a-workflow-has-failed)." + * {% data variables.product.prodname_copilot_autocomplete_pr %}. See [AUTOTITLE](/copilot/using-github-copilot/using-copilot-text-completion). + * Asking {% data variables.product.prodname_copilot_short %} why a workflow has failed. See [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-githubcom#ask-why-a-workflow-has-failed). diff --git a/data/reusables/copilot/quickstart-intro.md b/data/reusables/copilot/quickstart-intro.md index b164a6e09e35..b1daf6260156 100644 --- a/data/reusables/copilot/quickstart-intro.md +++ b/data/reusables/copilot/quickstart-intro.md @@ -1 +1 @@ -{% data variables.product.prodname_copilot %} provides coding suggestions as you type in your editor. You can also ask {% data variables.product.prodname_copilot_short %} coding-related questions, such as how best to code something, how to fix a bug, or how someone else's code works. For full details of what {% data variables.product.prodname_copilot_short %} can do, see "[AUTOTITLE](/copilot/about-github-copilot/what-is-github-copilot)." +{% data variables.product.prodname_copilot %} provides coding suggestions as you type in your editor. You can also ask {% data variables.product.prodname_copilot_short %} coding-related questions, such as how best to code something, how to fix a bug, or how someone else's code works. For full details of what {% data variables.product.prodname_copilot_short %} can do, see [AUTOTITLE](/copilot/about-github-copilot/what-is-github-copilot). diff --git a/data/reusables/copilot/quickstart-nextsteps1.md b/data/reusables/copilot/quickstart-nextsteps1.md index 114c54b9e8ea..997fee5c2790 100644 --- a/data/reusables/copilot/quickstart-nextsteps1.md +++ b/data/reusables/copilot/quickstart-nextsteps1.md @@ -1,3 +1,3 @@ -* **Find out more about {% data variables.product.prodname_copilot_short %} code completion"** - See "[AUTOTITLE](/copilot/using-github-copilot/using-github-copilot-code-suggestions-in-your-editor)." -* **Find out more about {% data variables.product.prodname_copilot_chat %}** - See "[AUTOTITLE](/copilot/github-copilot-chat/using-github-copilot-chat-in-your-ide){% ifversion fpt %}.{% endif %}"{% ifversion ghec %} and "[AUTOTITLE](/copilot/github-copilot-enterprise/copilot-chat-in-github/using-github-copilot-chat-in-githubcom)."{% endif %} -* **Learn how to write effective prompts** - See "[AUTOTITLE](/copilot/using-github-copilot/prompt-engineering-for-github-copilot)." +* **Find out more about {% data variables.product.prodname_copilot_short %} code completion"** - See [AUTOTITLE](/copilot/using-github-copilot/using-github-copilot-code-suggestions-in-your-editor). +* **Find out more about {% data variables.product.prodname_copilot_chat %}** - See [AUTOTITLE](/copilot/github-copilot-chat/using-github-copilot-chat-in-your-ide){% ifversion fpt %}.{% endif %}{% ifversion ghec %} and [AUTOTITLE](/copilot/github-copilot-enterprise/copilot-chat-in-github/using-github-copilot-chat-in-githubcom).{% endif %} +* **Learn how to write effective prompts** - See [AUTOTITLE](/copilot/using-github-copilot/prompt-engineering-for-github-copilot). diff --git a/data/reusables/copilot/quickstart-nextsteps2.md b/data/reusables/copilot/quickstart-nextsteps2.md index 5467ca1b6d98..4a8441b3b74c 100644 --- a/data/reusables/copilot/quickstart-nextsteps2.md +++ b/data/reusables/copilot/quickstart-nextsteps2.md @@ -1,3 +1,3 @@ -* **Use {% data variables.product.prodname_copilot_short %} on your mobile device** - See "[AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-github-mobile/using-github-copilot-chat-in-github-mobile)." -* **Use {% data variables.product.prodname_copilot_short %} on the command line** - See "[AUTOTITLE](/copilot/github-copilot-in-the-cli/using-github-copilot-in-the-cli)." -* **Configure {% data variables.product.prodname_copilot_short %} in your editor** - You can enable or disable {% data variables.product.prodname_copilot %} from within your editor, and create your own preferred keyboard shortcuts for {% data variables.product.prodname_copilot_short %}. See "[AUTOTITLE](/copilot/configuring-github-copilot/configuring-github-copilot-in-your-environment)." +* **Use {% data variables.product.prodname_copilot_short %} on your mobile device** - See [AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-github-mobile/using-github-copilot-chat-in-github-mobile). +* **Use {% data variables.product.prodname_copilot_short %} on the command line** - See [AUTOTITLE](/copilot/github-copilot-in-the-cli/using-github-copilot-in-the-cli). +* **Configure {% data variables.product.prodname_copilot_short %} in your editor** - You can enable or disable {% data variables.product.prodname_copilot %} from within your editor, and create your own preferred keyboard shortcuts for {% data variables.product.prodname_copilot_short %}. See [AUTOTITLE](/copilot/configuring-github-copilot/configuring-github-copilot-in-your-environment). diff --git a/data/reusables/copilot/signup-procedure-enterprise-msft-ea.md b/data/reusables/copilot/signup-procedure-enterprise-msft-ea.md index 8bca1eb7aa12..0d600a007a53 100644 --- a/data/reusables/copilot/signup-procedure-enterprise-msft-ea.md +++ b/data/reusables/copilot/signup-procedure-enterprise-msft-ea.md @@ -1 +1 @@ -If you're under a Microsoft Enterprise Agreement, you need to connect your Azure subscription ID to your enterprise account to enable and pay for {% data variables.product.prodname_copilot %}. For more information, see "[AUTOTITLE](/billing/managing-the-plan-for-your-github-account/connecting-an-azure-subscription)." +If you're under a Microsoft Enterprise Agreement, you need to connect your Azure subscription ID to your enterprise account to enable and pay for {% data variables.product.prodname_copilot %}. For more information, see [AUTOTITLE](/billing/managing-the-plan-for-your-github-account/connecting-an-azure-subscription). diff --git a/data/reusables/copilot/signup-procedure-org.md b/data/reusables/copilot/signup-procedure-org.md index cf8c6fa78ab7..6e6c0d304a2c 100644 --- a/data/reusables/copilot/signup-procedure-org.md +++ b/data/reusables/copilot/signup-procedure-org.md @@ -1,4 +1,4 @@ 1. Navigate to the [{% data variables.product.prodname_copilot %} sign up page](https://github.com/github-copilot/purchase). 1. Ensure you are signed in to the right organization account. If you are not, click **{% octicon "arrow-switch" aria-hidden="true" %} Switch** and select the organization for which you want to purchase {% data variables.product.prodname_copilot %}. 1. Click **Enable {% data variables.product.prodname_copilot %}**. -1. Enable {% data variables.product.prodname_copilot_short %} for some or all members of your organization. For more information about assigning seats, see "[AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization)." +1. Enable {% data variables.product.prodname_copilot_short %} for some or all members of your organization. For more information about assigning seats, see [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization). diff --git a/data/reusables/copilot/signup-procedure.md b/data/reusables/copilot/signup-procedure.md index 21cbc62b06f8..fecf0441be98 100644 --- a/data/reusables/copilot/signup-procedure.md +++ b/data/reusables/copilot/signup-procedure.md @@ -9,4 +9,4 @@ The **Suggestions matching public code** preference controls whether {% data variables.product.prodname_copilot_short %} will provide code completion suggestions that match publicly available code. - For details about the preferences, see "[AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-copilot-policies-as-an-individual-subscriber)." You can change the preferences at any time. + For details about the preferences, see [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-copilot-policies-as-an-individual-subscriber). You can change the preferences at any time. diff --git a/data/reusables/copilot/sku-isolation.md b/data/reusables/copilot/sku-isolation.md index d47ad03eb60c..c1df46b1439e 100644 --- a/data/reusables/copilot/sku-isolation.md +++ b/data/reusables/copilot/sku-isolation.md @@ -14,7 +14,7 @@ Configuring {% data variables.product.prodname_copilot_sku_isolation %} will aff ## Important steps to ensure continued access to {% data variables.product.prodname_copilot %} -You should ensure that your firewall allows access to all of the hostnames listed in "[AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/configuring-your-proxy-server-or-firewall-for-copilot)." +You should ensure that your firewall allows access to all of the hostnames listed in [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/configuring-your-proxy-server-or-firewall-for-copilot). ## Configuring {% data variables.product.prodname_copilot_sku_isolation %} for your {% ifversion ghec %}enterprise or {% endif %}organization diff --git a/data/reusables/copilot/subscription-prerequisite.md b/data/reusables/copilot/subscription-prerequisite.md index 736ad45c17d4..afa2abdb1f03 100644 --- a/data/reusables/copilot/subscription-prerequisite.md +++ b/data/reusables/copilot/subscription-prerequisite.md @@ -1 +1 @@ -For information about how to get access to {% data variables.product.prodname_copilot_short %}, see "[AUTOTITLE](/copilot/about-github-copilot/what-is-github-copilot#getting-access-to-copilot)." +For information about how to get access to {% data variables.product.prodname_copilot_short %}, see [AUTOTITLE](/copilot/about-github-copilot/what-is-github-copilot#getting-access-to-copilot). diff --git a/data/reusables/copilot/visual-studio-version.md b/data/reusables/copilot/visual-studio-version.md index f4f5074058ef..62b5ee0f1d8b 100644 --- a/data/reusables/copilot/visual-studio-version.md +++ b/data/reusables/copilot/visual-studio-version.md @@ -1 +1 @@ -To use {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vs %}, you must have version 2022 17.8 or later of {% data variables.product.prodname_vs %} for Windows installed. For more information, see "[Install {% data variables.product.prodname_vs %}](https://learn.microsoft.com/en-us/visualstudio/install/install-visual-studio)" in the Microsoft documentation. +To use {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vs %}, you must have version 2022 17.8 or later of {% data variables.product.prodname_vs %} for Windows installed. For more information, see [Install {% data variables.product.prodname_vs %}](https://learn.microsoft.com/en-us/visualstudio/install/install-visual-studio) in the Microsoft documentation. diff --git a/data/reusables/copilot/vscode-prerequisites.md b/data/reusables/copilot/vscode-prerequisites.md index df2802e3c9f8..a19a06cece39 100644 --- a/data/reusables/copilot/vscode-prerequisites.md +++ b/data/reusables/copilot/vscode-prerequisites.md @@ -1,3 +1,3 @@ * **Latest version of {% data variables.product.prodname_vscode %}**. See the [{% data variables.product.prodname_vscode %} download page](https://code.visualstudio.com/Download). -* **The {% data variables.product.prodname_copilot %} extension** - Install this from the [{% data variables.product.prodname_vs %} Marketplace](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot). For more information, see "[Set up {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode %}](https://code.visualstudio.com/docs/copilot/setup)" in the Microsoft documentation. -* **Sign in to {% data variables.product.company_short %} in {% data variables.product.prodname_vscode %}**. If you experience authentication issues, see "[AUTOTITLE](/copilot/troubleshooting-github-copilot/troubleshooting-issues-with-github-copilot-chat-in-ides#troubleshooting-authentication-issues-in-your-editor)." +* **The {% data variables.product.prodname_copilot %} extension** - Install this from the [{% data variables.product.prodname_vs %} Marketplace](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot). For more information, see [Set up {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode %}](https://code.visualstudio.com/docs/copilot/setup) in the Microsoft documentation. +* **Sign in to {% data variables.product.company_short %} in {% data variables.product.prodname_vscode %}**. If you experience authentication issues, see [AUTOTITLE](/copilot/troubleshooting-github-copilot/troubleshooting-issues-with-github-copilot-chat-in-ides#troubleshooting-authentication-issues-in-your-editor). diff --git a/data/reusables/copilot/windows-terminal-access-denied.md b/data/reusables/copilot/windows-terminal-access-denied.md index 6fe2a47fa7bb..0917c1d700a0 100644 --- a/data/reusables/copilot/windows-terminal-access-denied.md +++ b/data/reusables/copilot/windows-terminal-access-denied.md @@ -1 +1 @@ -If you have access to {% data variables.product.prodname_copilot %} via your organization{% ifversion ghec %} or enterprise{% endif %}, you won't be able to use {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_windows_terminal %} if your organization owner{% ifversion ghec %} or enterprise administrator{% endif %} has disabled {% data variables.product.prodname_copilot_cli %}. See "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/managing-policies-and-features-for-copilot-in-your-organization)." +If you have access to {% data variables.product.prodname_copilot %} via your organization{% ifversion ghec %} or enterprise{% endif %}, you won't be able to use {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_windows_terminal %} if your organization owner{% ifversion ghec %} or enterprise administrator{% endif %} has disabled {% data variables.product.prodname_copilot_cli %}. See [AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/managing-policies-and-features-for-copilot-in-your-organization). diff --git a/data/reusables/data-residency/data-resident-enterprises-network-access.md b/data/reusables/data-residency/data-resident-enterprises-network-access.md index 7db66e845b49..c2fb3fe3cbdc 100644 --- a/data/reusables/data-residency/data-resident-enterprises-network-access.md +++ b/data/reusables/data-residency/data-resident-enterprises-network-access.md @@ -1 +1 @@ -You must ensure that client systems trust {% data variables.product.company_short %}'s SSH key fingerprints and can access certain hostnames and IP addresses. See "[AUTOTITLE](/admin/data-residency/network-details-for-ghecom)." +You must ensure that client systems trust {% data variables.product.company_short %}'s SSH key fingerprints and can access certain hostnames and IP addresses. See [AUTOTITLE](/admin/data-residency/network-details-for-ghecom). diff --git a/data/reusables/dependabot/advanced-private-registry-config-link.md b/data/reusables/dependabot/advanced-private-registry-config-link.md index 8ee254297c4f..25d62f3c4267 100644 --- a/data/reusables/dependabot/advanced-private-registry-config-link.md +++ b/data/reusables/dependabot/advanced-private-registry-config-link.md @@ -1 +1 @@ -For in-depth information about available options, as well as recommendations and advice when configuring private registries, see "[AUTOTITLE](/code-security/dependabot/working-with-dependabot/guidance-for-the-configuration-of-private-registries-for-dependabot)." +For in-depth information about available options, as well as recommendations and advice when configuring private registries, see [AUTOTITLE](/code-security/dependabot/working-with-dependabot/guidance-for-the-configuration-of-private-registries-for-dependabot). diff --git a/data/reusables/dependabot/automated-tests-note.md b/data/reusables/dependabot/automated-tests-note.md index 816d8d103fcf..9571f829facc 100644 --- a/data/reusables/dependabot/automated-tests-note.md +++ b/data/reusables/dependabot/automated-tests-note.md @@ -1,2 +1,2 @@ > [!NOTE] -> It's good practice to have automated tests and acceptance processes in place so that checks are carried out before the pull request is merged. This is particularly important if the suggested version to upgrade to contains additional functionality, or a change that breaks your project's code. For more information about continuous integration, see "[AUTOTITLE](/actions/automating-builds-and-tests/about-continuous-integration)." +> It's good practice to have automated tests and acceptance processes in place so that checks are carried out before the pull request is merged. This is particularly important if the suggested version to upgrade to contains additional functionality, or a change that breaks your project's code. For more information about continuous integration, see [AUTOTITLE](/actions/automating-builds-and-tests/about-continuous-integration). diff --git a/data/reusables/dependabot/automatically-pause-dependabot-updates.md b/data/reusables/dependabot/automatically-pause-dependabot-updates.md index 107f9f55e9a9..fcaf65da0533 100644 --- a/data/reusables/dependabot/automatically-pause-dependabot-updates.md +++ b/data/reusables/dependabot/automatically-pause-dependabot-updates.md @@ -17,7 +17,7 @@ When {% data variables.product.prodname_dependabot %} is paused, {% data variabl * To the UI of the **Settings** tab of the repository (under **{% ifversion code-security-wording-only %}**Code security**{% else %}**Code security and analysis**{% endif %}**, then **{% data variables.product.prodname_dependabot %}**). * To the list of {% data variables.product.prodname_dependabot_alerts %} (if {% data variables.product.prodname_dependabot_security_updates %} are affected). -{% ifversion dependabot-updates-paused-enterprise-orgs %} Additionally, you will be able to see whether {% data variables.product.prodname_dependabot %} is paused at the organization-level in the security overview. The `paused` status will also be visible via the API. For more information, see "[AUTOTITLE](/rest/repos#enable-automated-security-fixes)."{% endif %} +{% ifversion dependabot-updates-paused-enterprise-orgs %} Additionally, you will be able to see whether {% data variables.product.prodname_dependabot %} is paused at the organization-level in the security overview. The `paused` status will also be visible via the API. For more information, see [AUTOTITLE](/rest/repos#enable-automated-security-fixes).{% endif %} As soon as a maintainer interacts with a {% data variables.product.prodname_dependabot %} pull request again, {% data variables.product.prodname_dependabot %} will unpause itself: * Security updates are automatically resumed for {% data variables.product.prodname_dependabot_alerts %}. diff --git a/data/reusables/dependabot/dependabot-alert-create-PR.md b/data/reusables/dependabot/dependabot-alert-create-PR.md index b9ba972431c5..c0ac1d7d5069 100644 --- a/data/reusables/dependabot/dependabot-alert-create-PR.md +++ b/data/reusables/dependabot/dependabot-alert-create-PR.md @@ -1 +1 @@ -If you have enabled {% data variables.product.prodname_dependabot_security_updates %} for your repository, the alert may also contain a link to a pull request to update the manifest or lock file to the minimum version that resolves the vulnerability. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates)." +If you have enabled {% data variables.product.prodname_dependabot_security_updates %} for your repository, the alert may also contain a link to a pull request to update the manifest or lock file to the minimum version that resolves the vulnerability. For more information, see [AUTOTITLE](/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates). diff --git a/data/reusables/dependabot/dependabot-alert-rules.md b/data/reusables/dependabot/dependabot-alert-rules.md index 4de8c6f50dab..01b56a4053dd 100644 --- a/data/reusables/dependabot/dependabot-alert-rules.md +++ b/data/reusables/dependabot/dependabot-alert-rules.md @@ -1 +1 @@ -Additionally, you can use {% data variables.dependabot.auto_triage_rules %} to manage your alerts at scale, so you can auto-dismiss or snooze alerts, and specify which alerts you want {% data variables.product.prodname_dependabot %} to open pull requests for. For information about the different types of auto-triage rules, and whether your repositories are eligible, see "[AUTOTITLE](/code-security/dependabot/dependabot-auto-triage-rules/about-dependabot-auto-triage-rules)." +Additionally, you can use {% data variables.dependabot.auto_triage_rules %} to manage your alerts at scale, so you can auto-dismiss or snooze alerts, and specify which alerts you want {% data variables.product.prodname_dependabot %} to open pull requests for. For information about the different types of auto-triage rules, and whether your repositories are eligible, see [AUTOTITLE](/code-security/dependabot/dependabot-auto-triage-rules/about-dependabot-auto-triage-rules). diff --git a/data/reusables/dependabot/dependabot-alerts-dependency-graph-enterprise.md b/data/reusables/dependabot/dependabot-alerts-dependency-graph-enterprise.md index 168833580d3f..9c81dfc894df 100644 --- a/data/reusables/dependabot/dependabot-alerts-dependency-graph-enterprise.md +++ b/data/reusables/dependabot/dependabot-alerts-dependency-graph-enterprise.md @@ -1,2 +1,2 @@ {% ifversion ghes %} -Enterprise owners can configure {% ifversion ghes %}the dependency graph and {% endif %}{% data variables.product.prodname_dependabot_alerts %} for an enterprise. For more information, see {% ifversion ghes %}"[AUTOTITLE](/admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise)" and {% endif %}"[AUTOTITLE](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)."{% endif %} +Enterprise owners can configure {% ifversion ghes %}the dependency graph and {% endif %}{% data variables.product.prodname_dependabot_alerts %} for an enterprise. For more information, see {% ifversion ghes %}[AUTOTITLE](/admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise) and {% endif %}[AUTOTITLE](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise).{% endif %} diff --git a/data/reusables/dependabot/dependabot-alerts-enterprise-server-repo-org-enablement.md b/data/reusables/dependabot/dependabot-alerts-enterprise-server-repo-org-enablement.md index 472187bfda8e..381ebf9cb810 100644 --- a/data/reusables/dependabot/dependabot-alerts-enterprise-server-repo-org-enablement.md +++ b/data/reusables/dependabot/dependabot-alerts-enterprise-server-repo-org-enablement.md @@ -1,3 +1,3 @@ Enterprise owners must configure the dependency graph and {% data variables.product.prodname_dependabot_alerts %} for an enterprise. -Once {% data variables.product.prodname_dependabot_alerts %} have been configured, repository administrators and organization owners can enable {% data variables.product.prodname_dependabot_alerts %} for private and internal repositories in their {% ifversion code-security-wording-only %}"Code security"{% else %}"Code security and analysis"{% endif %} settings page. Public repositories are enabled by default. For more information, see "[AUTOTITLE](/admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise)", "[AUTOTITLE](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)," and "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts)." +Once {% data variables.product.prodname_dependabot_alerts %} have been configured, repository administrators and organization owners can enable {% data variables.product.prodname_dependabot_alerts %} for private and internal repositories in their {% ifversion code-security-wording-only %}"Code security"{% else %}"Code security and analysis"{% endif %} settings page. Public repositories are enabled by default. For more information, see [AUTOTITLE](/admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise), [AUTOTITLE](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise), and [AUTOTITLE](/code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts). diff --git a/data/reusables/dependabot/dependabot-alerts-filters.md b/data/reusables/dependabot/dependabot-alerts-filters.md index cdd1e4c50ece..d47b18ca1b2b 100644 --- a/data/reusables/dependabot/dependabot-alerts-filters.md +++ b/data/reusables/dependabot/dependabot-alerts-filters.md @@ -8,7 +8,7 @@ You can sort and filter {% data variables.product.prodname_dependabot_alerts %} | `manifest` | Displays alerts for the selected manifest | Use `manifest:webwolf/pom.xml` to show alerts on the pom.xml file of the webwolf application | | `package` | Displays alerts for the selected package | Use `package:django` to show alerts for django | | `resolution` | Displays alerts of the selected resolution status | Use `resolution:no-bandwidth` to show alerts previously parked due to lack of resources or time to fix them | -| `repo` | Displays alerts based on the repository they relate to
Note that this filter is only available for security overview. For more information, see "[AUTOTITLE](/code-security/security-overview/about-security-overview)" | Use `repo:octocat-repo` to show alerts in the repository called `octocat-repo` | +| `repo` | Displays alerts based on the repository they relate to
Note that this filter is only available for security overview. For more information, see [AUTOTITLE](/code-security/security-overview/about-security-overview) | Use `repo:octocat-repo` to show alerts in the repository called `octocat-repo` | | `scope` | Displays alerts based on the scope of the dependency they relate to | Use `scope:development` to show alerts for dependencies that are only used during development | | `severity` | Displays alerts based on their level of severity | Use `severity:high` to show alerts with a severity of High | | `sort` | Displays alerts according to the selected sort order | The default sorting option for alerts is `sort:most-important`, which ranks alerts by importance
Use `sort:newest` to show the latest alerts reported by {% data variables.product.prodname_dependabot %} | diff --git a/data/reusables/dependabot/dependabot-custom-rules-ghas.md b/data/reusables/dependabot/dependabot-custom-rules-ghas.md index b22d628fa4dc..d1443e673bb9 100644 --- a/data/reusables/dependabot/dependabot-custom-rules-ghas.md +++ b/data/reusables/dependabot/dependabot-custom-rules-ghas.md @@ -1 +1 @@ -Help you manage your {% data variables.product.prodname_dependabot_alerts %} at scale. With {% data variables.dependabot.custom_rules %} you have control over the alerts you want to ignore, snooze, or trigger a {% data variables.product.prodname_dependabot %} security update for. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)" and "[AUTOTITLE](/code-security/dependabot/dependabot-auto-triage-rules/customizing-auto-triage-rules-to-prioritize-dependabot-alerts)." +Help you manage your {% data variables.product.prodname_dependabot_alerts %} at scale. With {% data variables.dependabot.custom_rules %} you have control over the alerts you want to ignore, snooze, or trigger a {% data variables.product.prodname_dependabot %} security update for. For more information, see [AUTOTITLE](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts) and [AUTOTITLE](/code-security/dependabot/dependabot-auto-triage-rules/customizing-auto-triage-rules-to-prioritize-dependabot-alerts). diff --git a/data/reusables/dependabot/dependabot-ignore-dependencies.md b/data/reusables/dependabot/dependabot-ignore-dependencies.md index f6093d36d69f..a1ef1ce36a97 100644 --- a/data/reusables/dependabot/dependabot-ignore-dependencies.md +++ b/data/reusables/dependabot/dependabot-ignore-dependencies.md @@ -1,4 +1,4 @@ If you want to ignore updates for the dependency, you must do one of the following. -* Configure an `ignore` rule for the dependency in the `dependabot.yml` file. For more information, see "[AUTOTITLE](/code-security/dependabot/working-with-dependabot/dependabot-options-reference#ignore)." +* Configure an `ignore` rule for the dependency in the `dependabot.yml` file. For more information, see [AUTOTITLE](/code-security/dependabot/working-with-dependabot/dependabot-options-reference#ignore). * Use the `@dependabot ignore` comment command for the dependency in the pull request for the grouped updates. For more information, see "[AUTOTITLE](/code-security/dependabot/working-with-dependabot/managing-pull-requests-for-dependency-updates#managing-dependabot-pull-requests-for-grouped-{% ifversion dependabot-grouped-security-updates-config %}{% else %}version-{% endif %}updates-with-comment-commands)." diff --git a/data/reusables/dependabot/dependabot-on-actions-enterprise-policy-condition.md b/data/reusables/dependabot/dependabot-on-actions-enterprise-policy-condition.md index 6279970e7297..e128a4886fa2 100644 --- a/data/reusables/dependabot/dependabot-on-actions-enterprise-policy-condition.md +++ b/data/reusables/dependabot/dependabot-on-actions-enterprise-policy-condition.md @@ -1,3 +1,3 @@ {% ifversion ghec %} -When you enforce a policy to only allow actions and reusable workflows from your enterprise, and you enable {% data variables.product.prodname_dependabot %} on {% data variables.product.prodname_actions %}, {% data variables.product.prodname_dependabot %} will not run. To enable {% data variables.product.prodname_dependabot %} to run with your enterprise actions and reusable workflows, you should choose either to allow actions created by {% data variables.product.prodname_dotcom %}, or allow specified actions and reusable workflows. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#allowing-select-actions-and-reusable-workflows-to-run)." +When you enforce a policy to only allow actions and reusable workflows from your enterprise, and you enable {% data variables.product.prodname_dependabot %} on {% data variables.product.prodname_actions %}, {% data variables.product.prodname_dependabot %} will not run. To enable {% data variables.product.prodname_dependabot %} to run with your enterprise actions and reusable workflows, you should choose either to allow actions created by {% data variables.product.prodname_dotcom %}, or allow specified actions and reusable workflows. For more information, see [AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#allowing-select-actions-and-reusable-workflows-to-run). {% endif %} diff --git a/data/reusables/dependabot/dependabot-on-actions-self-hosted-link.md b/data/reusables/dependabot/dependabot-on-actions-self-hosted-link.md index 9107da907c7b..d00d4b815ea6 100644 --- a/data/reusables/dependabot/dependabot-on-actions-self-hosted-link.md +++ b/data/reusables/dependabot/dependabot-on-actions-self-hosted-link.md @@ -1,3 +1,3 @@ {% ifversion dependabot-on-actions-self-hosted %} -To have greater control over {% data variables.product.prodname_dependabot %}'s access to your private registries and internal network resources, you can configure {% data variables.product.prodname_dependabot %} to run on {% data variables.product.prodname_actions %} self-hosted runners. For more information, see "[AUTOTITLE](/code-security/dependabot/working-with-dependabot/about-dependabot-on-github-actions-runners)" and "[AUTOTITLE](/code-security/dependabot/maintain-dependencies/managing-dependabot-on-self-hosted-runners)." +To have greater control over {% data variables.product.prodname_dependabot %}'s access to your private registries and internal network resources, you can configure {% data variables.product.prodname_dependabot %} to run on {% data variables.product.prodname_actions %} self-hosted runners. For more information, see [AUTOTITLE](/code-security/dependabot/working-with-dependabot/about-dependabot-on-github-actions-runners) and [AUTOTITLE](/code-security/dependabot/maintain-dependencies/managing-dependabot-on-self-hosted-runners). {% endif %} diff --git a/data/reusables/dependabot/dependabot-runners-network-requirements.md b/data/reusables/dependabot/dependabot-runners-network-requirements.md index 72613c1627ba..443c054f21c5 100644 --- a/data/reusables/dependabot/dependabot-runners-network-requirements.md +++ b/data/reusables/dependabot/dependabot-runners-network-requirements.md @@ -1,6 +1,6 @@ {% data variables.product.prodname_dependabot %} runners require access to the public internet, {% data variables.product.prodname_dotcom_the_website %}, and any internal registries that will be used in {% data variables.product.prodname_dependabot_updates %}. To minimize the risk to your internal network, you should limit access from the Virtual Machine (VM) to your internal network. This reduces the potential for damage to internal systems if a runner were to download a hijacked dependency. {% ifversion fpt or ghec %} -You must also allow outbound traffic to `dependabot-actions.githubapp.com` to prevent the jobs for {% data variables.product.prodname_dependabot_security_updates %} from failing. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#communication-between-self-hosted-runners-and-github)." +You must also allow outbound traffic to `dependabot-actions.githubapp.com` to prevent the jobs for {% data variables.product.prodname_dependabot_security_updates %} from failing. For more information, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#communication-between-self-hosted-runners-and-github). {% endif %} diff --git a/data/reusables/dependabot/dependabot-security-updates-disable-for-alert-rules.md b/data/reusables/dependabot/dependabot-security-updates-disable-for-alert-rules.md index f2b7cba07a7c..9c3e686a1955 100644 --- a/data/reusables/dependabot/dependabot-security-updates-disable-for-alert-rules.md +++ b/data/reusables/dependabot/dependabot-security-updates-disable-for-alert-rules.md @@ -1,6 +1,6 @@ {% ifversion dependabot-auto-triage-rules %} > [!NOTE] -> When {% data variables.product.prodname_dependabot_security_updates %} are enabled for a repository, {% data variables.product.prodname_dependabot %} will automatically try to open pull requests to resolve **every** open {% data variables.product.prodname_dependabot %} alert that has an available patch. If you prefer to customize which alerts {% data variables.product.prodname_dependabot %} opens pull requests for, you should leave {% data variables.product.prodname_dependabot_security_updates %} **disabled** and create an auto-triage rule. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-auto-triage-rules/customizing-auto-triage-rules-to-prioritize-dependabot-alerts)." +> When {% data variables.product.prodname_dependabot_security_updates %} are enabled for a repository, {% data variables.product.prodname_dependabot %} will automatically try to open pull requests to resolve **every** open {% data variables.product.prodname_dependabot %} alert that has an available patch. If you prefer to customize which alerts {% data variables.product.prodname_dependabot %} opens pull requests for, you should leave {% data variables.product.prodname_dependabot_security_updates %} **disabled** and create an auto-triage rule. For more information, see [AUTOTITLE](/code-security/dependabot/dependabot-auto-triage-rules/customizing-auto-triage-rules-to-prioritize-dependabot-alerts). {% endif %} diff --git a/data/reusables/dependabot/dependabot-security-updates-groups-supported.md b/data/reusables/dependabot/dependabot-security-updates-groups-supported.md index 9b07638794e7..7c28b22f73a8 100644 --- a/data/reusables/dependabot/dependabot-security-updates-groups-supported.md +++ b/data/reusables/dependabot/dependabot-security-updates-groups-supported.md @@ -1,5 +1,5 @@ {% ifversion dependabot-grouped-security-updates-config %}You can use the `dependabot.yml` file to create separate rules to group {% data variables.product.prodname_dependabot_version_updates %} and {% data variables.product.prodname_dependabot_security_updates %}.{% else %} -You can only use the `dependabot.yml` file to create groups for {% data variables.product.prodname_dependabot_version_updates %}. Grouped {% data variables.product.prodname_dependabot_security_updates %} are enabled or disabled in your repository or organization settings and do not support customization. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates#about-grouped-security-updates)."{% endif %} +You can only use the `dependabot.yml` file to create groups for {% data variables.product.prodname_dependabot_version_updates %}. Grouped {% data variables.product.prodname_dependabot_security_updates %} are enabled or disabled in your repository or organization settings and do not support customization. For more information, see [AUTOTITLE](/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates#about-grouped-security-updates).{% endif %} > [!NOTE] > If a grouped pull request for {% data variables.product.prodname_dependabot_version_updates %} contains a vulnerable package, {% data variables.product.prodname_dependabot_security_updates %} will still attempt to create a _separate_ pull request to update the vulnerable package to a secure version. Creating a separate pull request for security updates ensures you have visibility into package vulnerabilities. diff --git a/data/reusables/dependabot/dependabot-tos.md b/data/reusables/dependabot/dependabot-tos.md index accadedb4580..cd2eecff7f70 100644 --- a/data/reusables/dependabot/dependabot-tos.md +++ b/data/reusables/dependabot/dependabot-tos.md @@ -1,5 +1,5 @@ {% ifversion fpt %} {% data variables.product.prodname_dependabot %} and all related features are covered by [{% data variables.product.prodname_dotcom %}'s Terms of Service](/free-pro-team@latest/site-policy/github-terms/github-terms-of-service). {% elsif ghec %} -{% data variables.product.prodname_dependabot %} and all related features are covered by your license agreement. For more information, see "[{% data variables.product.company_short %} Enterprise Customer Terms](https://github.com/customer-terms)." +{% data variables.product.prodname_dependabot %} and all related features are covered by your license agreement. For more information, see [{% data variables.product.company_short %} Enterprise Customer Terms](https://github.com/customer-terms). {% endif %} diff --git a/data/reusables/dependabot/dependabot-updates-prs-and-actions.md b/data/reusables/dependabot/dependabot-updates-prs-and-actions.md index ed221af284eb..2b118a59d60e 100644 --- a/data/reusables/dependabot/dependabot-updates-prs-and-actions.md +++ b/data/reusables/dependabot/dependabot-updates-prs-and-actions.md @@ -1 +1 @@ -{% ifversion fpt or ghec %}Pull requests opened by {% data variables.product.prodname_dependabot %} can trigger workflows that run actions. For more information, see "[AUTOTITLE](/code-security/dependabot/working-with-dependabot/automating-dependabot-with-github-actions)."{% elsif ghes %} {% data reusables.dependabot.enabling-actions-for-ghes %} {% data variables.product.prodname_actions %} is required for {% data variables.product.prodname_dependabot_version_updates %} and {% data variables.product.prodname_dependabot_security_updates %} to run on {% data variables.product.product_name %}. For more information, see "[AUTOTITLE](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)."{% endif %} +{% ifversion fpt or ghec %}Pull requests opened by {% data variables.product.prodname_dependabot %} can trigger workflows that run actions. For more information, see [AUTOTITLE](/code-security/dependabot/working-with-dependabot/automating-dependabot-with-github-actions).{% elsif ghes %} {% data reusables.dependabot.enabling-actions-for-ghes %} {% data variables.product.prodname_actions %} is required for {% data variables.product.prodname_dependabot_version_updates %} and {% data variables.product.prodname_dependabot_security_updates %} to run on {% data variables.product.product_name %}. For more information, see [AUTOTITLE](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise).{% endif %} diff --git a/data/reusables/dependabot/dependabot-updates-signed-commits.md b/data/reusables/dependabot/dependabot-updates-signed-commits.md index cf5406c8c0dc..2035c5302d84 100644 --- a/data/reusables/dependabot/dependabot-updates-signed-commits.md +++ b/data/reusables/dependabot/dependabot-updates-signed-commits.md @@ -1 +1 @@ -{% data variables.product.prodname_dependabot %} signs its own commits by default, even if commit signing is not a requirement for the repository. For more information about verified commits, see "[AUTOTITLE](/authentication/managing-commit-signature-verification/about-commit-signature-verification)." +{% data variables.product.prodname_dependabot %} signs its own commits by default, even if commit signing is not a requirement for the repository. For more information about verified commits, see [AUTOTITLE](/authentication/managing-commit-signature-verification/about-commit-signature-verification). diff --git a/data/reusables/dependabot/dependabot-updates-supported-repos-ecosystems.md b/data/reusables/dependabot/dependabot-updates-supported-repos-ecosystems.md index bd4589dfc894..5b46a07a782b 100644 --- a/data/reusables/dependabot/dependabot-updates-supported-repos-ecosystems.md +++ b/data/reusables/dependabot/dependabot-updates-supported-repos-ecosystems.md @@ -1 +1 @@ -For information on the supported repositories and ecosystems, see "[AUTOTITLE](/code-security/dependabot/ecosystems-supported-by-dependabot/supported-ecosystems-and-repositories)." +For information on the supported repositories and ecosystems, see [AUTOTITLE](/code-security/dependabot/ecosystems-supported-by-dependabot/supported-ecosystems-and-repositories). diff --git a/data/reusables/dependabot/dependency-submission-api-build-time-dependencies.md b/data/reusables/dependabot/dependency-submission-api-build-time-dependencies.md index 155fa49dc9df..37b91def80fb 100644 --- a/data/reusables/dependabot/dependency-submission-api-build-time-dependencies.md +++ b/data/reusables/dependabot/dependency-submission-api-build-time-dependencies.md @@ -1 +1 @@ -You may not see all of your dependencies represented in the dependency graph, especially if some dependencies are build-time dependencies. You can use the {% data variables.dependency-submission-api.name %} to inform {% data variables.product.prodname_dotcom %} about your other dependencies, and receive security updates for them. For more information, see "[AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/using-the-dependency-submission-api)." +You may not see all of your dependencies represented in the dependency graph, especially if some dependencies are build-time dependencies. You can use the {% data variables.dependency-submission-api.name %} to inform {% data variables.product.prodname_dotcom %} about your other dependencies, and receive security updates for them. For more information, see [AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/using-the-dependency-submission-api). diff --git a/data/reusables/dependabot/dismiss-low-impact-rule.md b/data/reusables/dependabot/dismiss-low-impact-rule.md index 7a564ab66b76..d944cfc3247c 100644 --- a/data/reusables/dependabot/dismiss-low-impact-rule.md +++ b/data/reusables/dependabot/dismiss-low-impact-rule.md @@ -1 +1 @@ -The `Dismiss low impact issues for development-scoped dependencies` is a {% data variables.product.company_short %} preset rule. This rule auto-dismisses certain types of vulnerabilities that are found in npm dependencies used in development. The rule has been curated to reduce false positives and reduce alert fatigue. You cannot modify {% data variables.dependabot.github_presets %}. For more information about {% data variables.dependabot.github_presets %}, see "[AUTOTITLE](/code-security/dependabot/dependabot-auto-triage-rules/using-github-preset-rules-to-prioritize-dependabot-alerts)." +The `Dismiss low impact issues for development-scoped dependencies` is a {% data variables.product.company_short %} preset rule. This rule auto-dismisses certain types of vulnerabilities that are found in npm dependencies used in development. The rule has been curated to reduce false positives and reduce alert fatigue. You cannot modify {% data variables.dependabot.github_presets %}. For more information about {% data variables.dependabot.github_presets %}, see [AUTOTITLE](/code-security/dependabot/dependabot-auto-triage-rules/using-github-preset-rules-to-prioritize-dependabot-alerts). diff --git a/data/reusables/dependabot/enabling-disabling-dependency-graph-private-repo.md b/data/reusables/dependabot/enabling-disabling-dependency-graph-private-repo.md index 3975804c8c78..b388db3ad60b 100644 --- a/data/reusables/dependabot/enabling-disabling-dependency-graph-private-repo.md +++ b/data/reusables/dependabot/enabling-disabling-dependency-graph-private-repo.md @@ -1,8 +1,8 @@ Repository administrators can enable or disable the dependency graph for private {% ifversion ghec %}or internal{% endif %} repositories. -You can enable or disable the dependency graph for all repositories owned by your user account. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-security-and-analysis-settings-for-your-personal-account)". +You can enable or disable the dependency graph for all repositories owned by your user account. For more information, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-security-and-analysis-settings-for-your-personal-account). -You can also enable the dependency graph for multiple repositories in an organization at the same time. For more information, see {% ifversion security-configurations %}"[AUTOTITLE](/code-security/securing-your-organization)."{% else %}"[AUTOTITLE](/code-security/getting-started/quickstart-for-securing-your-organization)."{% endif %} +You can also enable the dependency graph for multiple repositories in an organization at the same time. For more information, see {% ifversion security-configurations %}[AUTOTITLE](/code-security/securing-your-organization).{% else %}[AUTOTITLE](/code-security/getting-started/quickstart-for-securing-your-organization).{% endif %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} diff --git a/data/reusables/dependabot/enterprise-enable-dependabot.md b/data/reusables/dependabot/enterprise-enable-dependabot.md index 42bc0c5be299..44573f948b9a 100644 --- a/data/reusables/dependabot/enterprise-enable-dependabot.md +++ b/data/reusables/dependabot/enterprise-enable-dependabot.md @@ -1,10 +1,10 @@ {% ifversion ghes %} > [!NOTE] -> Your site administrator must set up {% data variables.product.prodname_dependabot_updates %} for {% data variables.location.product_location %} before you can use this feature. For more information, see "[AUTOTITLE](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)." +> Your site administrator must set up {% data variables.product.prodname_dependabot_updates %} for {% data variables.location.product_location %} before you can use this feature. For more information, see [AUTOTITLE](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise). {% ifversion security-feature-enablement-policies-dependabot %} > -> You may not be able to enable or disable {% data variables.product.prodname_dependabot_updates %} if an enterprise owner has set a policy at the enterprise level. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise)." +> You may not be able to enable or disable {% data variables.product.prodname_dependabot_updates %} if an enterprise owner has set a policy at the enterprise level. For more information, see [AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise). {% endif %} {% endif %} diff --git a/data/reusables/dependabot/ghes-enabling-dependency-graph.md b/data/reusables/dependabot/ghes-enabling-dependency-graph.md index cbac93869c10..9dc8c461b5a2 100644 --- a/data/reusables/dependabot/ghes-enabling-dependency-graph.md +++ b/data/reusables/dependabot/ghes-enabling-dependency-graph.md @@ -1 +1 @@ -If the dependency graph is not available in your system, your enterprise owner can enable the dependency graph. For more information, see "[AUTOTITLE](/admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise)." +If the dependency graph is not available in your system, your enterprise owner can enable the dependency graph. For more information, see [AUTOTITLE](/admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise). diff --git a/data/reusables/dependabot/no-dependabot-alerts-for-malware.md b/data/reusables/dependabot/no-dependabot-alerts-for-malware.md index 4e9dbd18721a..8549af2f6e1a 100644 --- a/data/reusables/dependabot/no-dependabot-alerts-for-malware.md +++ b/data/reusables/dependabot/no-dependabot-alerts-for-malware.md @@ -1 +1 @@ -{% data variables.product.prodname_dependabot %} doesn't generate {% data variables.product.prodname_dependabot_alerts %} for malware. For more information, see "[AUTOTITLE](/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-the-github-advisory-database#malware-advisories)." +{% data variables.product.prodname_dependabot %} doesn't generate {% data variables.product.prodname_dependabot_alerts %} for malware. For more information, see [AUTOTITLE](/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-the-github-advisory-database#malware-advisories). diff --git a/data/reusables/dependabot/pull-request-introduction.md b/data/reusables/dependabot/pull-request-introduction.md index e51cfadd3dae..ceb23738f2a7 100644 --- a/data/reusables/dependabot/pull-request-introduction.md +++ b/data/reusables/dependabot/pull-request-introduction.md @@ -1 +1 @@ -{% data variables.product.prodname_dependabot %} raises pull requests to update dependencies. Depending on how your repository is configured, {% data variables.product.prodname_dependabot %} may raise pull requests for version updates and/or for security updates. You manage these pull requests in the same way as any other pull request, but there are also some extra commands available. For information about enabling {% data variables.product.prodname_dependabot %} dependency updates, see "[AUTOTITLE](/code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates)" and "[AUTOTITLE](/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates)." +{% data variables.product.prodname_dependabot %} raises pull requests to update dependencies. Depending on how your repository is configured, {% data variables.product.prodname_dependabot %} may raise pull requests for version updates and/or for security updates. You manage these pull requests in the same way as any other pull request, but there are also some extra commands available. For information about enabling {% data variables.product.prodname_dependabot %} dependency updates, see [AUTOTITLE](/code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates) and [AUTOTITLE](/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates). diff --git a/data/reusables/dependabot/quickstart-link.md b/data/reusables/dependabot/quickstart-link.md index b7aa3afe98fe..01ccb7695b03 100644 --- a/data/reusables/dependabot/quickstart-link.md +++ b/data/reusables/dependabot/quickstart-link.md @@ -1 +1 @@ -For an overview of the different features offered by {% data variables.product.prodname_dependabot %} and instructions on how to get started, see "[AUTOTITLE](/code-security/getting-started/dependabot-quickstart-guide)." +For an overview of the different features offered by {% data variables.product.prodname_dependabot %} and instructions on how to get started, see [AUTOTITLE](/code-security/getting-started/dependabot-quickstart-guide). diff --git a/data/reusables/dependabot/supported-package-managers.md b/data/reusables/dependabot/supported-package-managers.md index 5dc9929b6d99..d9ae8da1eef9 100644 --- a/data/reusables/dependabot/supported-package-managers.md +++ b/data/reusables/dependabot/supported-package-managers.md @@ -39,11 +39,11 @@ poetry | `pip` | v1 | {% octicon "check" aria-l > [!TIP] > For package managers such as `pipenv` and `poetry`, you need to use the `pip` YAML value. For example, if you use `poetry` to manage your Python dependencies and want {% data variables.product.prodname_dependabot %} to monitor your dependency manifest file for new versions, use `package-ecosystem: "pip"` in your `dependabot.yml` file. -For further information about ecosystem support for {% data variables.product.prodname_dependabot_security_updates %}, see also "[AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/dependency-graph-supported-package-ecosystems)." +For further information about ecosystem support for {% data variables.product.prodname_dependabot_security_updates %}, see also [AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/dependency-graph-supported-package-ecosystems). #### Cargo -{% ifversion dependabot-updates-cargo-private-registry-support %}Private registry support includes cargo registries, so you can use {% data variables.product.prodname_dependabot %} to keep your Rust dependencies up-to-date. For more information, see "[AUTOTITLE](/code-security/dependabot/working-with-dependabot/guidance-for-the-configuration-of-private-registries-for-dependabot#cargo)."{% else %}Private registry support applies to Git registries, and doesn't include cargo registries.{% endif %} +{% ifversion dependabot-updates-cargo-private-registry-support %}Private registry support includes cargo registries, so you can use {% data variables.product.prodname_dependabot %} to keep your Rust dependencies up-to-date. For more information, see [AUTOTITLE](/code-security/dependabot/working-with-dependabot/guidance-for-the-configuration-of-private-registries-for-dependabot#cargo).{% else %}Private registry support applies to Git registries, and doesn't include cargo registries.{% endif %} {% ifversion dependabot-version-updates-devcontainer-support %} @@ -69,9 +69,9 @@ Features in any valid dev container location will be updated in a single pull re In order for {% data variables.product.prodname_dependabot %} to fetch Docker metadata, maintainers of Docker images must add the `org.opencontainers.image.source` label to their Dockerfile, and include the URL of the source repository. Additionally, maintainers must tag the repository with the same tags as the published Docker images. For an example, see the [`dependabot-fixtures/docker-with-source`](https://github.com/dependabot-fixtures/docker-with-source) repository. For more information on Docker labels, see [Extension image labels](https://docs.docker.com/desktop/extensions-sdk/extensions/labels/) and [BUILDX_GIT_LABELS](https://docs.docker.com/build/building/env-vars/#buildx_git_labels) in the Docker documentation. {% endif %} -{% data variables.product.prodname_dependabot %} can update Docker image tags in Kubernetes manifests. Add an entry to the Docker `package-ecosystem` element of your `dependabot.yml` file for each directory containing a Kubernetes manifest which references Docker image tags. Kubernetes manifests can be Kubernetes Deployment YAML files or Helm charts. For information about configuring your `dependabot.yml` file for `docker`, see "`package-ecosystem`" in "[AUTOTITLE](/code-security/dependabot/working-with-dependabot/dependabot-options-reference#package-ecosystem)." +{% data variables.product.prodname_dependabot %} can update Docker image tags in Kubernetes manifests. Add an entry to the Docker `package-ecosystem` element of your `dependabot.yml` file for each directory containing a Kubernetes manifest which references Docker image tags. Kubernetes manifests can be Kubernetes Deployment YAML files or Helm charts. For information about configuring your `dependabot.yml` file for `docker`, see "`package-ecosystem`" in [AUTOTITLE](/code-security/dependabot/working-with-dependabot/dependabot-options-reference#package-ecosystem). -{% data variables.product.prodname_dependabot %} supports both public and private Docker registries. For a list of the supported registries, see "`docker-registry`" in "[AUTOTITLE](/code-security/dependabot/working-with-dependabot/configuring-access-to-private-registries-for-dependabot#docker-registry)." +{% data variables.product.prodname_dependabot %} supports both public and private Docker registries. For a list of the supported registries, see "`docker-registry`" in [AUTOTITLE](/code-security/dependabot/working-with-dependabot/configuring-access-to-private-registries-for-dependabot#docker-registry). {% endif %} {% data variables.product.prodname_dependabot %} parses Docker image tags for Semantic Versioning ([SemVer](https://semver.org/)). If {% data variables.product.prodname_dependabot %} detects a tag with a pre-release, then it will only suggest an update to the latest version with a matching pre-release, and it will not suggest a newer version that use a different pre-release label. For more information, see the `dependabot-docker` [README.md](https://github.com/dependabot/dependabot-core/blob/main/docker/README.md) file in the `dependabot/dependabot-core` repository. @@ -82,7 +82,7 @@ In order for {% data variables.product.prodname_dependabot %} to fetch Docker me {% data reusables.actions.dependabot-version-updates-actions-caveats %} -For more information about using {% data variables.product.prodname_dependabot_version_updates %} with {% data variables.product.prodname_actions %}, see "[AUTOTITLE](/actions/security-guides/using-githubs-security-features-to-secure-your-use-of-github-actions#keeping-the-actions-in-your-workflows-secure-and-up-to-date)." +For more information about using {% data variables.product.prodname_dependabot_version_updates %} with {% data variables.product.prodname_actions %}, see [AUTOTITLE](/actions/security-guides/using-githubs-security-features-to-secure-your-use-of-github-actions#keeping-the-actions-in-your-workflows-secure-and-up-to-date). #### Gradle @@ -93,10 +93,10 @@ For more information about using {% data variables.product.prodname_dependabot_v * `gradle/libs.versions.toml` (for projects using a standard Gradle version catalog){% endif %} * Files included via the `apply` declaration that have `dependencies` in the filename. Note that `apply` does not support `apply to`, recursion, or advanced syntaxes (for example, Kotlin's `apply` with `mapOf`, filenames defined by property). -{% data variables.product.prodname_dependabot %} uses information from the `pom.xml` file of dependencies to add links to release information in update pull requests. If the information is omitted from the `pom.xml` file, then it cannot be included in {% data variables.product.prodname_dependabot %} pull requests, see "[AUTOTITLE](/code-security/dependabot/ecosystems-supported-by-dependabot/optimizing-java-packages-dependabot)". +{% data variables.product.prodname_dependabot %} uses information from the `pom.xml` file of dependencies to add links to release information in update pull requests. If the information is omitted from the `pom.xml` file, then it cannot be included in {% data variables.product.prodname_dependabot %} pull requests, see [AUTOTITLE](/code-security/dependabot/ecosystems-supported-by-dependabot/optimizing-java-packages-dependabot). {% ifversion dependabot-security-updates-gradle-support %} -For {% data variables.product.prodname_dependabot_security_updates %}, Gradle support is limited to manual uploads of the dependency graph data using the {% data variables.dependency-submission-api.name %}. For more information about the {% data variables.dependency-submission-api.name %}, see "[AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/using-the-dependency-submission-api)." +For {% data variables.product.prodname_dependabot_security_updates %}, Gradle support is limited to manual uploads of the dependency graph data using the {% data variables.dependency-submission-api.name %}. For more information about the {% data variables.dependency-submission-api.name %}, see [AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/using-the-dependency-submission-api). > [!NOTE] > * When you upload Gradle dependencies to the dependency graph using the {% data variables.dependency-submission-api.name %}, all project dependencies are uploaded, even transitive dependencies that aren't explicitly mentioned in any dependency file. When an alert is detected in a transitive dependency, {% data variables.product.prodname_dependabot %} isn't able to find the vulnerable dependency in the repository, and therefore won't create a security update for that alert. @@ -108,7 +108,7 @@ For {% data variables.product.prodname_dependabot_security_updates %}, Gradle su {% data variables.product.prodname_dependabot %} doesn't run Maven but supports updates to `pom.xml` files. -{% data variables.product.prodname_dependabot %} uses information from the `pom.xml` file of dependencies to add links to release information in update pull requests. If the information is omitted from the `pom.xml` file, then it cannot be included in {% data variables.product.prodname_dependabot %} pull requests, see "[AUTOTITLE](/code-security/dependabot/ecosystems-supported-by-dependabot/optimizing-java-packages-dependabot)". +{% data variables.product.prodname_dependabot %} uses information from the `pom.xml` file of dependencies to add links to release information in update pull requests. If the information is omitted from the `pom.xml` file, then it cannot be included in {% data variables.product.prodname_dependabot %} pull requests, see [AUTOTITLE](/code-security/dependabot/ecosystems-supported-by-dependabot/optimizing-java-packages-dependabot). #### NuGet CLI diff --git a/data/reusables/dependabot/version-updates-for-actions.md b/data/reusables/dependabot/version-updates-for-actions.md index 9de624df48f5..4ff1f927a650 100644 --- a/data/reusables/dependabot/version-updates-for-actions.md +++ b/data/reusables/dependabot/version-updates-for-actions.md @@ -1 +1 @@ -You can also enable {% data variables.product.prodname_dependabot_version_updates %} for the actions that you add to your workflow. For more information, see "[AUTOTITLE](/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot)." +You can also enable {% data variables.product.prodname_dependabot_version_updates %} for the actions that you add to your workflow. For more information, see [AUTOTITLE](/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot). From 36b19c2203d26984b548b5428a002f3c128a06ec Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Mon, 6 Jan 2025 01:02:21 -0800 Subject: [PATCH 04/37] Sync secret scanning data (#53744) Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> --- src/secret-scanning/data/public-docs.yml | 11 +++++++++++ src/secret-scanning/lib/config.json | 4 ++-- 2 files changed, 13 insertions(+), 2 deletions(-) diff --git a/src/secret-scanning/data/public-docs.yml b/src/secret-scanning/data/public-docs.yml index 4df0fdafe14f..f5fd387e858a 100644 --- a/src/secret-scanning/data/public-docs.yml +++ b/src/secret-scanning/data/public-docs.yml @@ -898,6 +898,17 @@ hasPushProtection: false hasValidityCheck: false isduplicate: false +- provider: Cockroach Labs + supportedSecret: CockroachDB Cloud API Key + secretType: ccdb_api_key + versions: + fpt: '*' + ghec: '*' + isPublic: true + isPrivateWithGhas: false + hasPushProtection: false + hasValidityCheck: false + isduplicate: false - provider: Contentful supportedSecret: Contentful Personal Access Token secretType: contentful_personal_access_token diff --git a/src/secret-scanning/lib/config.json b/src/secret-scanning/lib/config.json index 721fe00f022a..ece357ddfced 100644 --- a/src/secret-scanning/lib/config.json +++ b/src/secret-scanning/lib/config.json @@ -1,5 +1,5 @@ { - "sha": "cc2ad2addc1a78be626037470b48db546e8a35ec", - "blob-sha": "7cd3674e6d0419376506fc41828588bd3eaed01d", + "sha": "bf52728536b76da82125c18eb2bc0930f83dd204", + "blob-sha": "adac04b16de61577ace4eb6536d63df74379b45d", "targetFilename": "code-security/secret-scanning/introduction/supported-secret-scanning-patterns" } \ No newline at end of file From 9f81b5b129cc521f974a3b683e44efd8683dc056 Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Mon, 6 Jan 2025 01:15:27 -0800 Subject: [PATCH 05/37] Update audit log event data (#53731) Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> --- src/audit-logs/lib/config.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/audit-logs/lib/config.json b/src/audit-logs/lib/config.json index 996d9f04d8ce..42c52e76fcbd 100644 --- a/src/audit-logs/lib/config.json +++ b/src/audit-logs/lib/config.json @@ -3,5 +3,5 @@ "apiOnlyEvents": "This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", "apiRequestEvent": "This event is only available via audit log streaming." }, - "sha": "2145bc8b2a41ef2ccd1bb9c9d84842f3f4a30184" + "sha": "5a0cf4257c3fb76abb87498a8eceeab4a78c710a" } \ No newline at end of file From 072c62999e7756804ef243b02d38a3aff625caab Mon Sep 17 00:00:00 2001 From: hubwriter Date: Mon, 6 Jan 2025 09:28:17 +0000 Subject: [PATCH 06/37] Copilot: fix bad link and typo (#53755) --- .../managing-copilot-policies-as-an-individual-subscriber.md | 2 +- .../github-terms-for-additional-products-and-features.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-copilot-policies-as-an-individual-subscriber.md b/content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-copilot-policies-as-an-individual-subscriber.md index 9c58b66d4e27..e4cbcdeefbcc 100644 --- a/content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-copilot-policies-as-an-individual-subscriber.md +++ b/content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-copilot-policies-as-an-individual-subscriber.md @@ -33,7 +33,7 @@ If you choose to allow suggestions matching public code, when {% data variables. ## Enabling or disabling prompt and suggestion collection -You can choose whether your prompts and {% data variables.product.prodname_copilot_short %}'s suggestions are collected and retained by {% data variables.product.prodname_dotcom %}, and further processed and shared with Microsoft. For more information about data that {% data variables.product.prodname_copilot %} may collect depending on your settings, see [AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-terms-for-additional-products-and-features#github-copilot) and the [{% data variables.product.prodname_copilot %} privacy FAQ](https://github.com/features/copilot/#faq-privacy-copilot-for-business). +You can choose whether your prompts and {% data variables.product.prodname_copilot_short %}'s suggestions are collected and retained by {% data variables.product.prodname_dotcom %}, and further processed and shared with Microsoft. For more information about data that {% data variables.product.prodname_copilot %} may collect depending on your settings, see [AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-terms-for-additional-products-and-features#github-copilot) and the [{% data variables.product.prodname_copilot %} privacy FAQ](https://github.com/features/copilot/#faq). {% data reusables.user-settings.copilot-settings %} 1. To allow or prevent {% data variables.product.prodname_dotcom %} using your data, select or deselect **Allow {% data variables.product.prodname_dotcom %} to use my code snippets from the code editor for product improvements**. diff --git a/content/site-policy/github-terms/github-terms-for-additional-products-and-features.md b/content/site-policy/github-terms/github-terms-for-additional-products-and-features.md index 633d5f78939b..6ad07a563607 100644 --- a/content/site-policy/github-terms/github-terms-for-additional-products-and-features.md +++ b/content/site-policy/github-terms/github-terms-for-additional-products-and-features.md @@ -116,7 +116,7 @@ Your use of GitHub Copilot is subject to the GitHub [Acceptable Use Policies](/s _Data_ -GitHub Copilot (i) may collect and process data based on your settings and the sepcific GitHub Copilot Service you use - this may include Prompts, Suggestions, and code snippets, and (ii) will collect additional usage information through the GitHub Copilot Service you use tied to your Account - this may include Service Usage Information, Website Usage Data, and Feedback Data. Upon your instructions, we may share this data with third-party applications such as those on the [GitHub Marketplace](https://github.com/marketplace) or third-party AI models of your choosing. This may include personal data, as referenced in the [GitHub Privacy Statement](/site-policy/privacy-policies/github-privacy-statement). You can learn more about the collection and use of GitHub Copilot data in the [GitHub Copilot Trust Center](https://resources.github.com/copilot-trust-center/). +GitHub Copilot (i) may collect and process data based on your settings and the specific GitHub Copilot Service you use - this may include Prompts, Suggestions, and code snippets, and (ii) will collect additional usage information through the GitHub Copilot Service you use tied to your Account - this may include Service Usage Information, Website Usage Data, and Feedback Data. Upon your instructions, we may share this data with third-party applications such as those on the [GitHub Marketplace](https://github.com/marketplace) or third-party AI models of your choosing. This may include personal data, as referenced in the [GitHub Privacy Statement](/site-policy/privacy-policies/github-privacy-statement). You can learn more about the collection and use of GitHub Copilot data in the [GitHub Copilot Trust Center](https://resources.github.com/copilot-trust-center/). For GitHub Copilot Free users, the data collected by GitHub Copilot may be used for AI Model training where permitted and if you allow in your settings. From f83df362ad4e2ae8ccac5cccdd6b4f75c1e0dc7a Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Mon, 6 Jan 2025 01:34:42 -0800 Subject: [PATCH 07/37] Update audit log event data (#53752) Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> --- src/audit-logs/lib/config.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/audit-logs/lib/config.json b/src/audit-logs/lib/config.json index 42c52e76fcbd..dbe913ddaefe 100644 --- a/src/audit-logs/lib/config.json +++ b/src/audit-logs/lib/config.json @@ -3,5 +3,5 @@ "apiOnlyEvents": "This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", "apiRequestEvent": "This event is only available via audit log streaming." }, - "sha": "5a0cf4257c3fb76abb87498a8eceeab4a78c710a" + "sha": "1cc65784575c62d12e1571bedef9126c2b7d2f15" } \ No newline at end of file From e3ac5872b20c40927bff6314f12fb5f891227c5d Mon Sep 17 00:00:00 2001 From: hubwriter Date: Mon, 6 Jan 2025 09:48:28 +0000 Subject: [PATCH 08/37] Reword text about the Bing skill teaching Copilot (#53698) --- .../asking-github-copilot-questions-in-github.md | 2 +- .../asking-github-copilot-questions-in-your-ide.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/content/copilot/using-github-copilot/asking-github-copilot-questions-in-github.md b/content/copilot/using-github-copilot/asking-github-copilot-questions-in-github.md index 40d62c2da744..43a50c201be0 100644 --- a/content/copilot/using-github-copilot/asking-github-copilot-questions-in-github.md +++ b/content/copilot/using-github-copilot/asking-github-copilot-questions-in-github.md @@ -61,7 +61,7 @@ The skills you can use in {% data variables.product.prodname_copilot_chat_dotcom | **Repository details** | Retrieves a specific {% data variables.product.prodname_dotcom %} repository. This is useful for finding out details such as the repository owner and the main language used. | Yes | `Tell me about this repo` | | **Semantic code search** | Natural language semantic code search in the default branch of the Git repository. This skill is useful when you want to know where or how certain functionality has been implemented in the code. | Yes

Available for all repositories with a {% data variables.product.prodname_copilot_enterprise_short %} subscription, and for public repositories with a {% data variables.product.prodname_copilot_individuals_short %} or {% data variables.product.prodname_copilot_business_short %} subscription. | `How does this repo manage HTTP requests and responses?`| | **Support search** | Retrieves information from the {% data variables.contact.contact_support_portal %}. This skill is useful for asking {% data variables.product.prodname_copilot_chat_short %} about {% data variables.product.prodname_dotcom %} products and support related questions. | Yes | `Can I use {% data variables.product.prodname_copilot_short %} knowledge bases with {% data variables.product.prodname_copilot_individuals_short %}?` | -| **Web search** | Searches the web using the Bing search engine. This skill is useful for teaching {% data variables.product.prodname_copilot_short %} about recent events, new developments, trends, technologies, or extremely specific, detailed, or niche subjects. | No

{% ifversion fpt %}_For {% data variables.product.prodname_copilot_individuals_short %}:_
Enable in your user settings.

_For {% data variables.product.prodname_copilot_business_short %}:_
Enable in organization settings.{% else %}Enable in enterprise or organization settings.{% endif %} | `What are some recent articles about SAT tokens securing against vulnerabilities in Node?` | +| **Web search** | Searches the web using the Bing search engine. This skill allows {% data variables.product.prodname_copilot_short %} to access information about recent events, new developments, trends, technologies, or extremely specific, detailed, or niche subjects. | No

{% ifversion fpt %}_For {% data variables.product.prodname_copilot_individuals_short %}:_
Enable in your user settings.

_For {% data variables.product.prodname_copilot_business_short %}:_
Enable in organization settings.{% else %}Enable in enterprise or organization settings.{% endif %} | `What are some recent articles about SAT tokens securing against vulnerabilities in Node?` | ## AI models for {% data variables.product.prodname_copilot_chat_short %} diff --git a/content/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide.md b/content/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide.md index d74b61f71b67..ee16f17bdafd 100644 --- a/content/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide.md +++ b/content/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide.md @@ -130,7 +130,7 @@ The skills you can use in {% data variables.product.prodname_copilot_chat_short | **Repository details** | Retrieves a specific {% data variables.product.prodname_dotcom %} repository. This is useful for finding out details such as the repository owner and the main language used. | Yes | `@github Tell me about PATH-TO-REPOSITORY` | | **Semantic code search** | Natural language semantic code search in the default branch of the Git repository. This skill is useful when you want to know where or how certain functionality has been implemented in the code. For more information, see [AUTOTITLE](/copilot/using-github-copilot/indexing-repositories-for-copilot-chat). | Yes

Available for all repositories with a {% data variables.product.prodname_copilot_enterprise_short %} subscription, and for public repositories with a {% data variables.product.prodname_copilot_individuals_short %} or {% data variables.product.prodname_copilot_business_short %} subscription. | `How does this repo manage HTTP requests and responses?`| | **Support search** | Retrieves information from the {% data variables.contact.contact_support_portal %}. This skill is useful for asking {% data variables.product.prodname_copilot_chat_short %} about {% data variables.product.prodname_dotcom %} products and support related questions. | Yes | `@github Can I use {% data variables.product.prodname_copilot_short %} knowledge bases with {% data variables.product.prodname_copilot_individuals_short %}?` | -| **Web search** | Searches the web using the Bing search engine. This skill is useful for teaching {% data variables.product.prodname_copilot_short %} about recent events, new developments, trends, technologies, or extremely specific, detailed, or niche subjects. | No

{% ifversion fpt %}_For {% data variables.product.prodname_copilot_individuals_short %}:_
Enable in your user settings.

_For {% data variables.product.prodname_copilot_business_short %}:_
Enable in organization settings.{% else %}Enable in enterprise or organization settings.{% endif %} | `@github #web What are some recent articles about SAT tokens securing against vulnerabilities in Node?` | +| **Web search** | Searches the web using the Bing search engine. This skill allows {% data variables.product.prodname_copilot_short %} to access information about recent events, new developments, trends, technologies, or extremely specific, detailed, or niche subjects. | No

{% ifversion fpt %}_For {% data variables.product.prodname_copilot_individuals_short %}:_
Enable in your user settings.

_For {% data variables.product.prodname_copilot_business_short %}:_
Enable in organization settings.{% else %}Enable in enterprise or organization settings.{% endif %} | `@github #web What are some recent articles about SAT tokens securing against vulnerabilities in Node?` | {% ifversion ghec %} @@ -284,7 +284,7 @@ The skills you can use in {% data variables.product.prodname_copilot_chat_short | **Lexical code search** | Keyword code search in the default branch of the Git repository. This skill is useful when you want to know about specific functions, methods or keywords that exist in the code. This skill leverages most of the functionality available to [{% data variables.product.prodname_dotcom %} Search](/search-github/github-code-search/understanding-github-code-search-syntax#using-qualifiers) like `symbol` and `path`. | Yes | `Find me the tests for the GitService class` | | **Path search** | Retrieves a specific file in the default branch of the Git repository. This skill is useful when you provide the exact path of a file in the repository. | Yes | `@github What logic does user_auth.js encapsulate?` | | **Semantic code search** | Natural language semantic code search in the default branch of the Git repository. This skill is useful when you want to know where or how certain functionality has been implemented in the code. For more information, see [AUTOTITLE](/copilot/using-github-copilot/indexing-repositories-for-copilot-chat). | Yes

Available for all repositories with a {% data variables.product.prodname_copilot_enterprise_short %} subscription, and for public repositories with a {% data variables.product.prodname_copilot_individuals_short %} or {% data variables.product.prodname_copilot_business_short %} subscription. | `How does this repo manage HTTP requests and responses?`| -| **Web search** | Searches the web using the Bing search engine. This skill is useful for teaching Copilot about recent events, new developments, trends, technologies, or extremely specific, detailed, or niche subjects. | No

{% ifversion fpt %}_For {% data variables.product.prodname_copilot_individuals_short %}:_
Enable in your user settings.

_For {% data variables.product.prodname_copilot_business_short %}:_
Enable in organization settings.{% else %}Enable in enterprise or organization settings.{% endif %} | `@github What are some recent articles about SAT tokens securing against vulnerabilities in Node?` | +| **Web search** | Searches the web using the Bing search engine. This skill allows {% data variables.product.prodname_copilot_short %} to access information about recent events, new developments, trends, technologies, or extremely specific, detailed, or niche subjects. | No

{% ifversion fpt %}_For {% data variables.product.prodname_copilot_individuals_short %}:_
Enable in your user settings.

_For {% data variables.product.prodname_copilot_business_short %}:_
Enable in organization settings.{% else %}Enable in enterprise or organization settings.{% endif %} | `@github What are some recent articles about SAT tokens securing against vulnerabilities in Node?` | {% ifversion ghec %} From 7fd4f5ae196d4ec066aa9fe7c0715c69db55f810 Mon Sep 17 00:00:00 2001 From: hubwriter Date: Mon, 6 Jan 2025 09:47:50 +0000 Subject: [PATCH 09/37] Copilot content exclusion: update table for dotcom/mobile support (#53663) --- .../excluding-content-from-github-copilot.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/content/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot.md b/content/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot.md index fb15356e9168..c550c02d9d8b 100644 --- a/content/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot.md +++ b/content/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot.md @@ -46,8 +46,11 @@ Repository administrators{% ifversion ghec %}, organization owners, and enterpri | Vim/Neovim | {% octicon "check" aria-label="Supported" %} | Not applicable | | Xcode | {% octicon "check" aria-label="Supported" %} | Not applicable | | Azure Data Studio | {% octicon "x" aria-label="Not supported" %} | Not applicable | -| The {% data variables.product.github %} website | Not applicable | {% octicon "x" aria-label="Not supported" %} | -| {% data variables.product.prodname_mobile %} | Not applicable | {% octicon "x" aria-label="Not supported" %} | +| The {% data variables.product.github %} website | Not applicable | {% octicon "check" aria-label="Supported" %} | +| {% data variables.product.prodname_mobile %} | Not applicable | {% octicon "check" aria-label="Supported" %} | + +> [!NOTE] +> Content exclusion is in {% data variables.release-phases.public_preview %} on the {% data variables.product.github %} website and in {% data variables.product.prodname_mobile %} and is subject to change. ### Limitations of content exclusions From 9d1c973d9830926e95a7268a820c4c96f79da73e Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Mon, 6 Jan 2025 01:47:52 -0800 Subject: [PATCH 10/37] Update audit log event data (#53735) Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> --- src/audit-logs/lib/config.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/audit-logs/lib/config.json b/src/audit-logs/lib/config.json index dbe913ddaefe..290606d8031f 100644 --- a/src/audit-logs/lib/config.json +++ b/src/audit-logs/lib/config.json @@ -3,5 +3,5 @@ "apiOnlyEvents": "This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", "apiRequestEvent": "This event is only available via audit log streaming." }, - "sha": "1cc65784575c62d12e1571bedef9126c2b7d2f15" + "sha": "aed021929f55efd8e1f773834dff3f02e75d1eba" } \ No newline at end of file From 86b5d312a4cbe700676e0e8406e46a748e0298bd Mon Sep 17 00:00:00 2001 From: Lili <92824518+queenofcorgis@users.noreply.github.com> Date: Mon, 6 Jan 2025 05:06:01 -0500 Subject: [PATCH 11/37] Update managing-environments-for-deployment.md (#53757) Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> --- .../managing-environments-for-deployment.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/actions/managing-workflow-runs-and-deployments/managing-deployments/managing-environments-for-deployment.md b/content/actions/managing-workflow-runs-and-deployments/managing-deployments/managing-environments-for-deployment.md index 9f9dddceaef9..ff1b2db5ede4 100644 --- a/content/actions/managing-workflow-runs-and-deployments/managing-deployments/managing-environments-for-deployment.md +++ b/content/actions/managing-workflow-runs-and-deployments/managing-deployments/managing-environments-for-deployment.md @@ -66,7 +66,7 @@ For more information on reviewing jobs that reference an environment with requir ### Wait timer -Use a wait timer to delay a job for a specific amount of time after the job is initially triggered. The time (in minutes) must be an integer between 1 and 43,200 (30 days). +Use a wait timer to delay a job for a specific amount of time after the job is initially triggered. The time (in minutes) must be an integer between 1 and 43,200 (30 days). Wait time will not count towards your billable time. {% ifversion fpt %} From d6723b058079f8dcdc5480ee276d07ce57b3b4d8 Mon Sep 17 00:00:00 2001 From: Felix Guntrip Date: Mon, 6 Jan 2025 10:17:54 +0000 Subject: [PATCH 12/37] Update broken link to "check-snmp" man page (#53749) Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> --- .../monitoring-your-instance/monitoring-using-snmp.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/admin/monitoring-and-managing-your-instance/monitoring-your-instance/monitoring-using-snmp.md b/content/admin/monitoring-and-managing-your-instance/monitoring-your-instance/monitoring-using-snmp.md index 08ddcae531a4..91284d8316e9 100644 --- a/content/admin/monitoring-and-managing-your-instance/monitoring-your-instance/monitoring-using-snmp.md +++ b/content/admin/monitoring-and-managing-your-instance/monitoring-your-instance/monitoring-using-snmp.md @@ -20,7 +20,7 @@ topics: --- SNMP is a common standard for monitoring devices over a network. We strongly recommend enabling SNMP so you can monitor the health of {% data variables.location.product_location %} and know when to add more memory, storage, or processor power to the host machine. -{% data variables.product.prodname_enterprise %} has a standard SNMP installation, so you can take advantage of the [many plugins](https://www.monitoring-plugins.org/doc/man/check_snmp.html) available for Nagios or for any other monitoring system. +{% data variables.product.prodname_enterprise %} has a standard SNMP installation, so you can take advantage of the [many plugins](https://nagios-plugins.org/doc/man/check_snmp.html) available for Nagios or for any other monitoring system. ## Configuring SNMP v2c From e93f56bac2e11c87e3fea8999831ab02dbc0f976 Mon Sep 17 00:00:00 2001 From: Tomoko Tanaka <28242405+tallzeebaa@users.noreply.github.com> Date: Mon, 6 Jan 2025 19:29:35 +0900 Subject: [PATCH 13/37] Add note for the setup-LANGUAGE limitation (#53748) Co-authored-by: Felix Guntrip Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> --- .../about-self-hosted-runners.md | 1 + .../about-using-actions-in-your-enterprise.md | 6 ++---- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners.md b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners.md index c6b063300ea7..2a1ddb51f9cb 100644 --- a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners.md +++ b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners.md @@ -124,6 +124,7 @@ The following processor architectures are supported for the self-hosted runner a ## Supported actions on self-hosted runners +All `actions/setup-LANGUAGE` action repositories currently support three platforms: macOS, Windows, and Ubuntu. Some extra configuration might be required to use actions from {% data variables.product.github %} with {% data variables.product.prodname_ghe_server %}, or to use the `actions/setup-LANGUAGE` actions with self-hosted runners that do not have internet access. For more information, see [AUTOTITLE](/admin/github-actions/managing-access-to-actions-from-githubcom) and contact your {% data variables.product.prodname_enterprise %} site administrator. {% endif %} diff --git a/content/admin/managing-github-actions-for-your-enterprise/managing-access-to-actions-from-githubcom/about-using-actions-in-your-enterprise.md b/content/admin/managing-github-actions-for-your-enterprise/managing-access-to-actions-from-githubcom/about-using-actions-in-your-enterprise.md index 2a57a1614116..06084b3be460 100644 --- a/content/admin/managing-github-actions-for-your-enterprise/managing-access-to-actions-from-githubcom/about-using-actions-in-your-enterprise.md +++ b/content/admin/managing-github-actions-for-your-enterprise/managing-access-to-actions-from-githubcom/about-using-actions-in-your-enterprise.md @@ -45,7 +45,9 @@ Each action is a repository in the `actions` organization, and each action repos > [!NOTE] > * When using setup actions (such as `actions/setup-LANGUAGE`) on {% data variables.product.product_name %} with self-hosted runners, you might need to set up the tools cache on runners that do not have internet access. For more information, see [AUTOTITLE](/admin/github-actions/managing-access-to-actions-from-githubcom/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access). +> * All `actions/setup-LANGUAGE` action repositories currently support three platforms: macOS, Windows, and Ubuntu. > * When {% data variables.product.product_name %} is updated, bundled actions are automatically replaced with default versions in the upgrade package. +> * Being bundled with {% data variables.product.prodname_ghe_server %} means the action is available within that environment, but it doesn’t automatically guarantee compatibility with all platforms or self-hosted runners. ## Configuring access to actions on {% data variables.product.prodname_dotcom_the_website %} @@ -53,13 +55,9 @@ Each action is a repository in the `actions` organization, and each action repos The recommended approach is to enable automatic access to all actions from {% data variables.product.prodname_dotcom_the_website %}. You can do this by using {% data variables.product.prodname_github_connect %} to integrate {% data variables.product.product_name %} with {% data variables.product.prodname_ghe_cloud %}. For more information, see [AUTOTITLE](/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect). -{% ifversion ghes %} - > [!NOTE] > Before you can configure access to actions on {% data variables.product.prodname_dotcom_the_website %}, you must configure {% data variables.location.product_location %} to use {% data variables.product.prodname_actions %}. For more information, see [AUTOTITLE](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server). -{% endif %} - {% data reusables.actions.self-hosted-runner-networking-to-dotcom %} {% data reusables.actions.enterprise-limit-actions-use %} From 406f75cd95a4d5bd8ef28bf345f7fddeccf25773 Mon Sep 17 00:00:00 2001 From: Ryan Trauntvein Date: Mon, 6 Jan 2025 02:41:08 -0800 Subject: [PATCH 14/37] Add note about using Alt+F2 to access emergency admin console on GHES (#53743) Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> --- .../accessing-the-administrative-shell-ssh.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh.md b/content/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh.md index 79413075d81b..59efbdced6a7 100644 --- a/content/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh.md +++ b/content/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh.md @@ -66,7 +66,7 @@ Host HOSTNAME ## Accessing the administrative shell using the local console -In an emergency situation, for example if SSH is unavailable, you can access the administrative shell locally. Sign in as the `admin` user and use the password established during initial setup of {% data variables.product.prodname_ghe_server %}. +In an emergency situation, for example if SSH is unavailable, you can access the administrative shell locally if your hypervisor provides console access. Press `Alt` + `F2` to switch to an interactive prompt, then sign in as the `admin` user and use the password established during initial setup of {% data variables.product.prodname_ghe_server %}. ## Access limitations for the administrative shell From 777180ad422e21a44bda601905b836aa109a9dc6 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 6 Jan 2025 02:43:24 -0800 Subject: [PATCH 15/37] Content strategy bug fix Dec. '24 (#53728) Co-authored-by: Felicity Chapman Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> --- .../contents-of-a-github-docs-article.md | 11 +++++------ .../annotating-code-examples.md | 5 +++-- .../writing-for-github-docs/creating-screenshots.md | 2 ++ 3 files changed, 10 insertions(+), 8 deletions(-) diff --git a/content/contributing/style-guide-and-content-model/contents-of-a-github-docs-article.md b/content/contributing/style-guide-and-content-model/contents-of-a-github-docs-article.md index fea67f234b95..2bd87f5422d6 100644 --- a/content/contributing/style-guide-and-content-model/contents-of-a-github-docs-article.md +++ b/content/contributing/style-guide-and-content-model/contents-of-a-github-docs-article.md @@ -77,13 +77,12 @@ Occasionally, it's relevant to mention required permissions in conceptual conten * Don't include permissions in an article’s intro. * Roles exist at different levels. Refer only to the role at the same level as the action. For example, you need admin access to a repository (repository-level role) to configure protected branches. You can get admin access to a repository by being an organization owner (organization-level role), but the repository-level role is what actually governs your ability to take the action, so that is the only role that should be mentioned in the permissions statement. * Language to use in a permissions statement: + * People with [ACCOUNT ROLE]. * [ACCOUNT ROLE] can [ACTION]. * People with [FEATURE ROLE] access for a [FEATURE] can [ACTION]. * AVOID: [ACCOUNT ROLE] and people with [FEATURE ROLE] access for a [FEATURE] can [ACTION]. -### Examples of permissions statements - -* Article with single permissions statement for multiple procedures: [AUTOTITLE](/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise) +See the [AUTOTITLE](/contributing/style-guide-and-content-model/style-guide#permission-statements-and-product-callouts) for more information on formatting permission statements. ## Product callout @@ -94,10 +93,10 @@ All product callouts are stored as reusables in [`gated-features`](https://githu ### How to write a product callout * Product callouts follow a strict format, clearly identifying the feature and which products it’s available in. -* Product callouts also include a link to "GitHub’s products” and occasionally to another relevant article. +* Product callouts may include links to articles that directly help users understand who can use the feature. These links can be inline links to the specific products or GitHub plans that are required. * Examples: - * [Feature name] is available in [product(s)]. For more information, see "GitHub’s products.” - * [Feature name] is available in public repositories with [free product(s)], and in public and private repositories with [paid products]. For more information, see "GitHub’s products.” + * [Feature name] is available in [product(s)]. + * [Feature name] is available in public repositories with [free product(s)], and in public and private repositories with [paid products]. ### Examples of articles with product callouts diff --git a/content/contributing/writing-for-github-docs/annotating-code-examples.md b/content/contributing/writing-for-github-docs/annotating-code-examples.md index 6dc17e35d85c..d6d4e2e0c2ec 100644 --- a/content/contributing/writing-for-github-docs/annotating-code-examples.md +++ b/content/contributing/writing-for-github-docs/annotating-code-examples.md @@ -35,8 +35,9 @@ You can annotate multiple code examples in a single article, but keep in mind th The following rules apply to all code annotations. * Multiline-style comments, such as `/*` are not supported. -* You can include any number of spaces before the comment tag starts. -* You can include any number of spaces after the comment tag ends. +* There must be a space between the symbol that starts a code annotation and the comment. + * **Use:** `# comment` + * **Avoid:** `#comment` * To create a blank annotation, insert a comment tag with no text after it. Blank annotations are useful if some lines of a sample don't require an annotation. * Strings that begin with `#!` will render in the code block and are not treated as comments. * Anything after the comment tag will be parsed with Markdown. Links, versioning, and other styling will render as if they were written in Markdown. diff --git a/content/contributing/writing-for-github-docs/creating-screenshots.md b/content/contributing/writing-for-github-docs/creating-screenshots.md index 771f743084f3..436b44325c23 100644 --- a/content/contributing/writing-for-github-docs/creating-screenshots.md +++ b/content/contributing/writing-for-github-docs/creating-screenshots.md @@ -93,6 +93,8 @@ In addition to the criteria for inclusion, screenshots must meet the following r * 750–1000 pixels wide for full-column images * File size of 250 KB or less * Descriptive file names, such as `gist-embed-link.png` instead of `right_side_page_03.png` +* Images captured on macOS must be retina images + * In Snagit, select **Snagit** > **Preferences** > **Advanced** and deselect "Scale down retina images when sharing" ### Accessibility From 589acad8fc7ac9e98d16ce5285f8ba7e181c45a8 Mon Sep 17 00:00:00 2001 From: Cody Soyland Date: Mon, 6 Jan 2025 04:57:16 -0600 Subject: [PATCH 16/37] Document image verification in artifact attestations K8s guide (#53703) Signed-off-by: Cody Soyland Co-authored-by: Joe Clark <31087804+jc-clark@users.noreply.github.com> Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> --- ...attestations-with-a-kubernetes-admission-controller.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/content/actions/security-for-github-actions/using-artifact-attestations/enforcing-artifact-attestations-with-a-kubernetes-admission-controller.md b/content/actions/security-for-github-actions/using-artifact-attestations/enforcing-artifact-attestations-with-a-kubernetes-admission-controller.md index b34148e5cb28..27ed0f68b719 100644 --- a/content/actions/security-for-github-actions/using-artifact-attestations/enforcing-artifact-attestations-with-a-kubernetes-admission-controller.md +++ b/content/actions/security-for-github-actions/using-artifact-attestations/enforcing-artifact-attestations-with-a-kubernetes-admission-controller.md @@ -9,6 +9,8 @@ redirect_from: - /actions/security-guides/enforcing-artifact-attestations-with-a-kubernetes-admission-controller --- +>[!NOTE] Before proceeding, ensure you have enabled build provenance for container images, including setting the `push-to-registry` attribute in the [`attest-build-provenance` action](https://github.com/actions/attest-build-provenance) as documented in [Generating build provenance for container images](/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds#generating-build-provenance-for-container-images). This is required for the Policy Controller to verify the attestation. + ## About Kubernetes admission controller [Artifact attestations](/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds) enable you to create unfalsifiable provenance and integrity guarantees for the software you build. In turn, people who consume your software can verify where and how your software was built. @@ -19,6 +21,12 @@ Using the open source [Sigstore Policy Controller](https://docs.sigstore.dev/pol To [install the controller](#getting-started-with-kubernetes-admission-controller), we offer [two Helm charts](https://github.com/github/artifact-attestations-helm-charts): one for deploying the Sigstore Policy Controller, and another for loading the GitHub trust root and a default policy. +### About image verification + +When the Policy Controller is installed, it will intercept all image pull requests and verify the attestation for the image. The attestation must be stored in the image registry as an [OCI attached artifact](https://oras.land/docs/concepts/reftypes/) containing a [Sigstore Bundle](https://docs.sigstore.dev/about/bundle/) which contains the attestation and cryptographic material (e.g. certificates and signatures) used to verify the attestation. A verification process is then performed that ensures the image was built with the specified build provenance and matches any policies enabled by the cluster administrator. + +In order for an image to be verifiable, it must have a valid provenance attestation in the registry, which can be done by enabling the `push-to-registry: true` attribute in the `actions/attest-build-provenance` action. See [Generating build provenance for container images](/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds#generating-build-provenance-for-container-images) for more details on how to generate attestations for container images. + ### About trust roots and policies The Sigstore Policy Controller is primarily configured with trust roots and policies, represented by the Custom Resources `TrustRoot` and `ClusterImagePolicy`. A `TrustRoot` represents a trusted distribution channel for the public key material used to verify attestations. A `ClusterImagePolicy` represents a policy for enforcing attestations on images. From 6fb7f4930db51bb11681e254e85c72c51e3abc9a Mon Sep 17 00:00:00 2001 From: Felix Guntrip Date: Mon, 6 Jan 2025 10:57:42 +0000 Subject: [PATCH 17/37] Update guidance on issue templates in .github repositories (#53723) Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> --- .../creating-a-default-community-health-file.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md b/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md index a4af5f6e7e2d..d62aed29cdbc 100644 --- a/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md +++ b/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md @@ -53,7 +53,7 @@ You can create defaults in your organization or personal account for the followi | _FUNDING.yml_ | A FUNDING file displays a sponsor button in your repository to increase the visibility of funding options for your open source project. For more information, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository). | | {% endif %} | | _GOVERNANCE.md_ | A GOVERNANCE file lets people know about how your project is governed. For example, it might discuss project roles and how decisions are made. | -| Issue and pull request templates and _config.yml_ | Issue and pull request templates customize and standardize the information you'd like contributors to include when they open issues and pull requests in your repository. For more information, see [AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates). | +| Issue and pull request templates and _config.yml_ | Issue and pull request templates customize and standardize the information you'd like contributors to include when they open issues and pull requests in your repository. For more information, see [AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates).

If an issue template sets a label, that label must be created in your `.github` repository and any repositories where the template will be used. | | _SECURITY.md_ | A SECURITY file gives instructions on how to report a security vulnerability in your project and description that hyperlinks the file. For more information, see [AUTOTITLE](/code-security/getting-started/adding-a-security-policy-to-your-repository). | | _SUPPORT.md_ | A SUPPORT file lets people know about ways to get help with your project. For more information, see [AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/adding-support-resources-to-your-project). | From 8ba01772352b2d951d2602855f5bdbd2ddeb116d Mon Sep 17 00:00:00 2001 From: Junko Suzuki Date: Mon, 6 Jan 2025 20:15:03 +0900 Subject: [PATCH 18/37] Add the operations for reclaiming mannequin for bbs2gh migration (#53571) Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> --- ...nnequins-for-github-enterprise-importer.md | 35 +++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/content/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/reclaiming-mannequins-for-github-enterprise-importer.md b/content/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/reclaiming-mannequins-for-github-enterprise-importer.md index cf032836b927..be68fec8bf6f 100644 --- a/content/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/reclaiming-mannequins-for-github-enterprise-importer.md +++ b/content/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/reclaiming-mannequins-for-github-enterprise-importer.md @@ -53,6 +53,7 @@ The exact command you need to use depends on which extension of the {% data vari * [Reclaiming mannequins with the {% data variables.product.prodname_gei_cli_short %}](#reclaiming-mannequins-with-the-gei-extension) * [Reclaiming mannequins with the {% data variables.product.prodname_ado2gh_cli_short %}](#reclaiming-mannequins-with-the-ado2gh-extension) +* [Reclaiming mannequins with the {% data variables.product.prodname_bbs2gh_cli_short %}](#reclaiming-mannequins-with-the-bbs2gh-extension) #### Reclaiming mannequins with the {% data variables.product.prodname_gei_cli_short %} @@ -122,6 +123,40 @@ If your migration source is Azure DevOps, you can reclaim mannequins with the {% {% data reusables.enterprise-migration-tool.mannequin-reclaim-must-accept %} +#### Reclaiming mannequins with the {% data variables.product.prodname_bbs2gh_cli_short %} + +If your migration source is Bitbucket Server, you can reclaim mannequins with the {% data variables.product.prodname_bbs2gh_cli %}. + +* {% data reusables.enterprise-migration-tool.add-pat-to-reclaim-mannequins %} For {% data variables.product.pat_generic %} 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-scopes-for-personal-access-tokens)." +* {% data reusables.enterprise-migration-tool.add-target-api-url %} + +{% data reusables.enterprise-migration-tool.create-csv-mannequins %} + + * To generate a CSV file with a list of mannequins for an organization, use the `gh bbs2gh generate-mannequin-csv` command, replacing DESTINATION with the destination organization and FILENAME with a file name for the resulting CSV file. + + {% data reusables.enterprise-migration-tool.include-reclaimed %} + + ```shell copy + gh bbs2gh generate-mannequin-csv --github-org DESTINATION --output FILENAME.csv + ``` + + {% data reusables.enterprise-migration-tool.edit-csv %} +1. To reclaim mannequins, use the `gh bbs2gh reclaim-mannequin` command. + + {% data reusables.enterprise-migration-tool.reclaim-bulk-csv %} + + ```shell copy + gh bbs2gh reclaim-mannequin --github-org DESTINATION --csv FILENAME.csv + ``` + + {% data reusables.enterprise-migration-tool.reclaim-individual-mannequin %} + + ```shell copy + gh bbs2gh reclaim-mannequin --github-org DESTINATION --mannequin-user MANNEQUIN --target-user USERNAME + ``` + +{% data reusables.enterprise-migration-tool.mannequin-reclaim-must-accept %} + ### Reclaiming mannequins in your browser {% data reusables.profile.access_org %} From e44344fcc8765041210b1ac17ecd00fae140d74d Mon Sep 17 00:00:00 2001 From: hubwriter Date: Mon, 6 Jan 2025 11:28:26 +0000 Subject: [PATCH 19/37] Remove mention of JetBrains from Codespaces docs (#53683) Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> --- .../creating-a-codespace-for-a-repository.md | 3 - .../deleting-a-codespace.md | 2 +- .../developing-in-a-codespace.md | 63 +-------- .../forwarding-ports-in-your-codespace.md | 38 ++---- .../developing-in-a-codespace/index.md | 1 - .../opening-an-existing-codespace.md | 17 +-- .../stopping-and-starting-a-codespace.md | 18 --- ...github-codespaces-in-your-jetbrains-ide.md | 121 ------------------ .../using-source-control-in-your-codespace.md | 71 +--------- .../codespaces/getting-started/deep-dive.md | 20 +-- .../codespaces/getting-started/quickstart.md | 1 - content/codespaces/guides.md | 1 - content/codespaces/index.md | 3 +- content/codespaces/overview.md | 2 +- content/codespaces/reference/index.md | 2 - ...-github-codespaces-plugin-for-jetbrains.md | 56 -------- ...ur-default-editor-for-github-codespaces.md | 11 -- .../troubleshooting/github-codespaces-logs.md | 27 ---- ...oubleshooting-github-codespaces-clients.md | 86 ------------- .../application-installed-locally.md | 2 +- .../codespaces-jetbrains-beta-note.md | 3 - .../jetbrains-open-codespace-plugin.md | 3 - .../linking-to-an-existing-codespace.md | 1 - .../opening-codespace-in-jetbrains.md | 27 ---- ...jetbrains.md => port-forwarding-adding.md} | 0 ...-jetbrains.md => port-forwarding-intro.md} | 0 ...tbrains.md => port-forwarding-labeling.md} | 0 ...etbrains.md => port-forwarding-sharing.md} | 0 .../rebuilding-container-procedures.md | 2 +- 29 files changed, 23 insertions(+), 558 deletions(-) delete mode 100644 content/codespaces/developing-in-a-codespace/using-github-codespaces-in-your-jetbrains-ide.md delete mode 100644 content/codespaces/reference/using-the-github-codespaces-plugin-for-jetbrains.md delete mode 100644 data/reusables/codespaces/codespaces-jetbrains-beta-note.md delete mode 100644 data/reusables/codespaces/jetbrains-open-codespace-plugin.md delete mode 100644 data/reusables/codespaces/opening-codespace-in-jetbrains.md rename data/reusables/codespaces/{port-forwarding-adding-non-jetbrains.md => port-forwarding-adding.md} (100%) rename data/reusables/codespaces/{port-forwarding-intro-non-jetbrains.md => port-forwarding-intro.md} (100%) rename data/reusables/codespaces/{port-forwarding-labeling-non-jetbrains.md => port-forwarding-labeling.md} (100%) rename data/reusables/codespaces/{port-forwarding-sharing-non-jetbrains.md => port-forwarding-sharing.md} (100%) diff --git a/content/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository.md b/content/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository.md index 129814286939..b63b7ffc06f5 100644 --- a/content/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository.md +++ b/content/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository.md @@ -42,9 +42,6 @@ Organizations can enable members and outside collaborators to create and use cod {% data reusables.codespaces.starting-new-project-template %} For more information, see [AUTOTITLE](/codespaces/developing-in-a-codespace/creating-a-codespace-from-a-template). -> [!NOTE] -> If you use a JetBrains IDE, you can use {% data variables.product.prodname_cli %} to create a codespace. You can then use the JetBrains Gateway application to open the codespace in a JetBrains IDE. For more information, see [AUTOTITLE](/codespaces/developing-in-a-codespace/using-github-codespaces-in-your-jetbrains-ide). - If you create a codespace from a repository, the codespace will be associated with a specific branch, which cannot be empty. You can create more than one codespace per repository or even per branch. {% data reusables.codespaces.you-can-see-all-your-codespaces %} diff --git a/content/codespaces/developing-in-a-codespace/deleting-a-codespace.md b/content/codespaces/developing-in-a-codespace/deleting-a-codespace.md index 94eb74845b6b..c34c52aed15e 100644 --- a/content/codespaces/developing-in-a-codespace/deleting-a-codespace.md +++ b/content/codespaces/developing-in-a-codespace/deleting-a-codespace.md @@ -28,7 +28,7 @@ You can manually delete a codespace in a variety of ways: Use the tabs at the top of this article to display instructions for each of these ways of deleting a codespace. > [!NOTE] -> You can't delete a codespace from within the JetBrains Gateway, or the JetBrains client application, or from within JupyterLab. +> You can't delete a codespace from within JupyterLab. ## Why you should delete unused codespaces diff --git a/content/codespaces/developing-in-a-codespace/developing-in-a-codespace.md b/content/codespaces/developing-in-a-codespace/developing-in-a-codespace.md index b5f4d69a41c4..0bc22bcfd116 100644 --- a/content/codespaces/developing-in-a-codespace/developing-in-a-codespace.md +++ b/content/codespaces/developing-in-a-codespace/developing-in-a-codespace.md @@ -1,6 +1,6 @@ --- title: Developing in a codespace -intro: 'You can work in a codespace using your browser, {% data variables.product.prodname_vscode %}, a JetBrains IDE, or in a command shell.' +intro: 'You can work in a codespace using your browser, {% data variables.product.prodname_vscode %}, or in a command shell.' redirect_from: - /github/developing-online-with-github-codespaces/developing-in-a-codespace - /github/developing-online-with-codespaces/developing-in-a-codespace @@ -16,12 +16,6 @@ topics: shortTitle: Develop in a codespace --- -{% jetbrains_beta %} - -{% data reusables.codespaces.codespaces-jetbrains-beta-note %} - -{% endjetbrains_beta %} - ## About development with {% data variables.product.prodname_github_codespaces %} {% ifversion ghec %} @@ -33,7 +27,6 @@ shortTitle: Develop in a codespace You can develop code in a codespace using your choice of tool: * A command shell, via an SSH connection initiated using {% data variables.product.prodname_cli %} -* One of the JetBrains IDEs, via the JetBrains Gateway * The {% data variables.product.prodname_vscode %} desktop application * A browser-based version of {% data variables.product.prodname_vscode %} @@ -76,60 +69,6 @@ For troubleshooting information, see [AUTOTITLE](/codespaces/troubleshooting/tro {% endvscode %} -{% jetbrains_beta %} - -The tabs in this article allow you to switch between information for each of these ways of working. You're currently on the tab for JetBrains IDEs. - -## Working in a codespace in a JetBrains IDE - -To use {% data variables.product.prodname_github_codespaces %} with a JetBrains IDE you must have already installed JetBrains Gateway. For information about installing JetBrains Gateway, see [the JetBrains website](https://www.jetbrains.com/remote-development/gateway/). - -You can work in a codespace using your choice of JetBrains IDE. After creating a codespace, you can use the JetBrains Gateway application to open the codespace in your preferred IDE. - -You can edit code, debug, and use Git commands while developing in a codespace with your JetBrains IDE. For more information about the various JetBrains IDEs, see the [JetBrains documentation](https://www.jetbrains.com/help/). - -### IntelliJ IDEA user interface - -Within the {% data variables.product.prodname_github_codespaces %} documentation we use IntelliJ IDEA as a representative JetBrains IDE. Different JetBrains IDEs may have different layouts. - -![Annotated screenshot of the six main components of the user interface for JetBrains IntelliJ IDEA.](/assets/images/help/codespaces/jetbrains-gui-with-callouts.png) - -The main components of the user interface are: - -1. **Navigation bar** - This displays the path to the currently selected file or directory. Use the buttons to the right of the navigation bar to perform various actions, including building, running, or debugging the project, or running Git commands to commit and push your changes. -1. **Project tool window** - This shows you the structure of your project and allows you to open files in the editor. -1. **{% data variables.product.prodname_github_codespaces %} tool window** - This is displayed by clicking the {% data variables.product.prodname_github_codespaces %} plugin in the bar to the left of the tool window. It displays information about your codespace, including its display name and machine type. The buttons at the top of this tool window allow you to: - * Refresh the details in the tool window for the active codespace - * Display the "Your codespaces" web page - * View the codespace creation logs -1. **Editor** - This is where you edit your files. You can right-click the tab for a file to access options such as moving the tab to a new window. -1. **Terminal** - This is displayed by clicking **Terminal** in the tool window bar at the bottom of the main window (just above the status bar). The integrated terminal allows you to perform command-line tasks without having to switch to a dedicated terminal application. -1. **Status bar** - Hover over the icon at the left of the status bar to see a list of tools. Click the icon to hide or show the tool window bars. The right side of the status bar shows information about the project, including the current Git branch. - -For more information about the IntelliJ IDEA user interface, see the [JetBrains documentation for IntelliJ IDEA](https://www.jetbrains.com/help/idea/guided-tour-around-the-user-interface.html). - -### Customizing the codespaces for a repository - -You can customize the codespaces that are created for a repository by creating or updating the dev container configuration for the repository. You can do this from within a codespace. After you change a dev container configuration, you can apply the changes to the current codespace by rebuilding the Docker container for the codespace. For more information, see [AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers). - -### Personalizing your codespace - -You can use a [dotfiles](https://dotfiles.github.io/tutorials/) repository to personalize aspects of the codespace environment for any codespace that you create. For more information, see [AUTOTITLE](/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account#dotfiles). - -### Committing your changes - -Once you've made changes to your codespace, either new code or configuration changes, you'll want to commit and push your changes. Pushing changes to a repository ensures that anyone else who creates a codespace from this repository has the same configuration. This also means that any customization you do, to modify the configuration of codespaces created for a repository, will be available to everybody who uses the repository. - -For more information, see [AUTOTITLE](/codespaces/developing-in-a-codespace/using-source-control-in-your-codespace#committing-your-changes). - -## Further reading - -* [AUTOTITLE](/codespaces/developing-in-a-codespace/using-github-codespaces-in-your-jetbrains-ide) -* [AUTOTITLE](/codespaces/reference/using-the-github-codespaces-plugin-for-jetbrains) -* [AUTOTITLE](/codespaces/troubleshooting/troubleshooting-github-codespaces-clients) - -{% endjetbrains_beta %} - {% cli %} The tabs in this article allow you to switch between information for each of these ways of working. You're currently on the tab for {% data variables.product.prodname_cli %}. diff --git a/content/codespaces/developing-in-a-codespace/forwarding-ports-in-your-codespace.md b/content/codespaces/developing-in-a-codespace/forwarding-ports-in-your-codespace.md index 638f72b07c5e..0bb790dd03f3 100644 --- a/content/codespaces/developing-in-a-codespace/forwarding-ports-in-your-codespace.md +++ b/content/codespaces/developing-in-a-codespace/forwarding-ports-in-your-codespace.md @@ -15,19 +15,13 @@ topics: - Developer --- -{% jetbrains_beta %} - -{% data reusables.codespaces.codespaces-jetbrains-beta-note %} - -{% endjetbrains_beta %} - ## About forwarded ports Port forwarding gives you access to TCP ports running within your codespace. For example, if you're running a web application on a particular port in your codespace, you can forward that port. This allows you to access the application from the browser on your local machine for testing and debugging. {% webui %} -{% data reusables.codespaces.port-forwarding-intro-non-jetbrains %} +{% data reusables.codespaces.port-forwarding-intro %} {% data reusables.codespaces.navigate-to-ports-tab %} 1. Under the list of ports, click **Add port**. @@ -48,7 +42,7 @@ By default, {% data variables.product.prodname_github_codespaces %} forwards por 1. Select the protocol needed for this port. The protocol that you select will be remembered for this port for the lifetime of the codespace. -{% data reusables.codespaces.port-forwarding-sharing-non-jetbrains %} +{% data reusables.codespaces.port-forwarding-sharing %} {% data reusables.codespaces.navigate-to-ports-tab %} 1. Right-click the port that you want to share, click the **Port Visibility**, then click **Private to Organization** or **Public**. @@ -64,14 +58,14 @@ By default, {% data variables.product.prodname_github_codespaces %} forwards por {% data reusables.codespaces.using-tools-to-access-ports-1 %} {% data reusables.codespaces.find-address-and-token %} {% data reusables.codespaces.using-tools-to-access-ports-2 %} -{% data reusables.codespaces.port-forwarding-adding-non-jetbrains %} -{% data reusables.codespaces.port-forwarding-labeling-non-jetbrains %} +{% data reusables.codespaces.port-forwarding-adding %} +{% data reusables.codespaces.port-forwarding-labeling %} {% endwebui %} {% vscode %} -{% data reusables.codespaces.port-forwarding-intro-non-jetbrains %} +{% data reusables.codespaces.port-forwarding-intro %} {% data reusables.codespaces.navigate-to-ports-tab %} 1. Under the list of ports, click **Add port**. @@ -81,7 +75,7 @@ By default, {% data variables.product.prodname_github_codespaces %} forwards por ![Screenshot of the number 3000 being entered into the port number field for a new forwarded port.](/assets/images/help/codespaces/port-number-text-box.png) -{% data reusables.codespaces.port-forwarding-sharing-non-jetbrains %} +{% data reusables.codespaces.port-forwarding-sharing %} {% data reusables.codespaces.navigate-to-ports-tab %} @@ -98,8 +92,8 @@ By default, {% data variables.product.prodname_github_codespaces %} forwards por {% data reusables.codespaces.using-tools-to-access-ports-1 %} {% data reusables.codespaces.find-address-and-token %} {% data reusables.codespaces.using-tools-to-access-ports-2 %} -{% data reusables.codespaces.port-forwarding-adding-non-jetbrains %} -{% data reusables.codespaces.port-forwarding-labeling-non-jetbrains %} +{% data reusables.codespaces.port-forwarding-adding %} +{% data reusables.codespaces.port-forwarding-labeling %} {% endvscode %} @@ -117,7 +111,7 @@ For more information about this command, see [the {% data variables.product.prod To see details of forwarded ports enter `gh codespace ports` and then choose a codespace. -{% data reusables.codespaces.port-forwarding-sharing-non-jetbrains %} +{% data reusables.codespaces.port-forwarding-sharing %} To change the visibility of a forwarded port, use the `gh codespace ports visibility` subcommand. {% data reusables.codespaces.port-visibility-settings %} @@ -172,21 +166,11 @@ Copy the address and paste it somewhere for later use. ``` {% data reusables.codespaces.using-tools-to-access-ports-2 %} -{% data reusables.codespaces.port-forwarding-adding-non-jetbrains %} -{% data reusables.codespaces.port-forwarding-labeling-non-jetbrains %} +{% data reusables.codespaces.port-forwarding-adding %} +{% data reusables.codespaces.port-forwarding-labeling %} ### Seeing port labels on the command line You can see the port labels when you list the forwarded ports for a codespace. To do this, use the `gh codespace ports` command and then select a codespace. {% endcli %} - -{% jetbrains_beta %} - -## Forwarding a port - -For information on how to forward a port in a codespace to a port on your local machine, see the "Port forwarding" section of the [Security model](https://www.jetbrains.com/help/idea/security-model.html#port_forwarding) article in the JetBrains documentation. - -Alternatively, you can use {% data variables.product.prodname_cli %} to forward a port. For more information, click the "{% data variables.product.prodname_cli %}" tab at the top of this page. - -{% endjetbrains_beta %} diff --git a/content/codespaces/developing-in-a-codespace/index.md b/content/codespaces/developing-in-a-codespace/index.md index f4b62050b870..f8f54b7daa68 100644 --- a/content/codespaces/developing-in-a-codespace/index.md +++ b/content/codespaces/developing-in-a-codespace/index.md @@ -23,7 +23,6 @@ children: - /connecting-to-a-private-network - /getting-started-with-github-codespaces-for-machine-learning - /using-github-codespaces-in-visual-studio-code - - /using-github-codespaces-in-your-jetbrains-ide - /using-github-codespaces-with-github-cli redirect_from: - /codespaces/developing-in-codespaces diff --git a/content/codespaces/developing-in-a-codespace/opening-an-existing-codespace.md b/content/codespaces/developing-in-a-codespace/opening-an-existing-codespace.md index f9bc037f85b3..d67193f68998 100644 --- a/content/codespaces/developing-in-a-codespace/opening-an-existing-codespace.md +++ b/content/codespaces/developing-in-a-codespace/opening-an-existing-codespace.md @@ -20,13 +20,7 @@ redirect_from: {% endif %} -{% jetbrains_beta %} - -{% data reusables.codespaces.codespaces-jetbrains-beta-note %} - -{% endjetbrains_beta %} - -You can reopen any of your active or stopped codespaces on {% data variables.product.github %}, in a JetBrains IDE, in {% data variables.product.prodname_vscode %}, or by using {% data variables.product.prodname_cli %}. You can't reopen a codespace that has been deleted. See [AUTOTITLE](/codespaces/getting-started/understanding-the-codespace-lifecycle). +You can reopen any of your active or stopped codespaces on {% data variables.product.github %}, in {% data variables.product.prodname_vscode %}, or by using {% data variables.product.prodname_cli %}. You can't reopen a codespace that has been deleted. See [AUTOTITLE](/codespaces/getting-started/understanding-the-codespace-lifecycle). You can view all your codespaces on the "Your codespaces" page at [github.com/codespaces](https://github.com/codespaces). From this page, you can: @@ -73,7 +67,6 @@ You can bookmark the address of this page if you want to get back to it quickly You can open the codespace in: * Your browser * {% data variables.product.prodname_vscode %} - * JetBrains Gateway * JupyterLab {% data reusables.codespaces.application-installed-locally %} @@ -153,14 +146,6 @@ See [`gh codespace code`](https://cli.github.com/manual/gh_codespace_code) in th {% endcli %} -{% jetbrains_beta %} - -## Reopening an existing codespace - -{% data reusables.codespaces.opening-codespace-in-jetbrains %} - -{% endjetbrains_beta %} - ## Further reading * [AUTOTITLE](/rest/codespaces/organizations) diff --git a/content/codespaces/developing-in-a-codespace/stopping-and-starting-a-codespace.md b/content/codespaces/developing-in-a-codespace/stopping-and-starting-a-codespace.md index c7a8fb1777bf..67ce5dbbbb28 100644 --- a/content/codespaces/developing-in-a-codespace/stopping-and-starting-a-codespace.md +++ b/content/codespaces/developing-in-a-codespace/stopping-and-starting-a-codespace.md @@ -14,12 +14,6 @@ redirect_from: - /codespaces/developing-in-codespaces/stopping-and-starting-a-codespace --- -{% jetbrains_beta %} - -{% data reusables.codespaces.codespaces-jetbrains-beta-note %} - -{% endjetbrains_beta %} - ## About stopping and starting a codespace {% data reusables.codespaces.stopping-a-codespace %} @@ -58,12 +52,6 @@ gh codespace stop {% endvscode %} -{% jetbrains_beta %} - -You can stop a codespace from the "Your codespaces" page (see [the web browser instructions](/codespaces/developing-in-a-codespace/stopping-and-starting-a-codespace?tool=webui#stopping-a-codespace)) or by using {% data variables.product.prodname_cli %} (see [the CLI instructions](/codespaces/developing-in-a-codespace/stopping-and-starting-a-codespace?tool=cli#stopping-a-codespace)). - -{% endjetbrains_beta %} - ## Restarting a codespace {% webui %} @@ -101,12 +89,6 @@ When you restart a codespace you can choose to open it in {% data variables.prod {% endvscode %} -{% jetbrains_beta %} - -{% data reusables.codespaces.opening-codespace-in-jetbrains %} - -{% endjetbrains_beta %} - ## Further reading * [AUTOTITLE](/codespaces/getting-started/understanding-the-codespace-lifecycle) diff --git a/content/codespaces/developing-in-a-codespace/using-github-codespaces-in-your-jetbrains-ide.md b/content/codespaces/developing-in-a-codespace/using-github-codespaces-in-your-jetbrains-ide.md deleted file mode 100644 index e567ed87728d..000000000000 --- a/content/codespaces/developing-in-a-codespace/using-github-codespaces-in-your-jetbrains-ide.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -title: Using GitHub Codespaces in your JetBrains IDE -shortTitle: JetBrains IDEs -intro: You can use the JetBrains Gateway to connect to your codespace and work in your favorite JetBrains IDE. -versions: - fpt: '*' - ghec: '*' -type: how_to -topics: - - Codespaces - - Developer -redirect_from: - - /codespaces/developing-in-codespaces/using-github-codespaces-in-your-jetbrains-ide ---- - -{% data reusables.codespaces.codespaces-jetbrains-beta-note %} - -## About {% data variables.product.prodname_codespaces %} in JetBrains IDEs - -If you use a JetBrains IDE to work on your code, you can take advantage of working in a codespace. You do this by using the JetBrains Gateway application. - -After installing the JetBrains Gateway, you can set JetBrains as your default editor for {% data variables.product.prodname_codespaces %}. If you do, then whenever you open a codespace from {% data variables.product.github %}, the JetBrains Gateway will launch to allow you to choose your JetBrains IDE and connect to the codespace. - -When you work in a codespace, you use the JetBrains thin client application on your local computer. This provides the graphical interface for the full JetBrains IDE of your choice, which runs on the remote virtual machine that hosts your codespace. The thin client is always used, even if the full JetBrains IDE is installed locally. Any local JetBrains IDE settings are imported and used by the thin client. - -> [!NOTE] -> Only existing codespaces are available in the JetBrains Gateway. You can create codespaces in {% data variables.product.github %}, or by using {% data variables.product.prodname_cli %}. For more information, see [AUTOTITLE](/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository). - -### The JetBrains remote development connection process - -The basic process behind using a codespace in your JetBrains IDE is as follows. -1. In the JetBrains Gateway application you select one of your active or stopped codespaces. -1. You then choose which JetBrains IDE you want to use. -1. The selected JetBrains IDE is then downloaded to the remote virtual machine that hosts your codespace and source code. -1. The JetBrains thin client application is then downloaded to your local machine and started. -1. The client application connects to the full backend IDE. -1. You can work on your code in the client application in just the same way you would in a local environment. - -## Prerequisites - -To work in a codespace in a JetBrains IDE you need: - -* A valid JetBrains license -* The JetBrains Gateway application, versions 2023.3.\* or 2024.1.\* -* An existing codespace running on a virtual machine that has at least 4 cores. The codespace must also be running an SSH server. For more information, see [Codespace running an SSH server](#codespace-running-an-ssh-server). - -### JetBrains license - -You must have a JetBrains license that supports the IDE you choose in the JetBrains Gateway. - -### JetBrains Gateway - -You can install and update the JetBrains Gateway from the JetBrains Toolbox application. - -1. Download and install the [JetBrains Toolbox](https://www.jetbrains.com/toolbox-app). -1. Open the JetBrains Toolbox. -1. Find **Gateway** in the list of available tools. - - ![Screenshot of the JetBrains Toolbox with "Gateway" at the bottom of the list of applications. Each application has an "Install" button next to it.](/assets/images/help/codespaces/jetbrains-toolbox.png) - -1. To the right of **Gateway**, click the ellipsis (**...**), then click **Available versions**. -1. In the list of versions, beside a supported version (see [Prerequisites](#prerequisites)), click **Install**. - -### Codespace running an SSH server - -You must have an existing codespace to connect to, and the virtual machine that hosts the codespace must have at least 4 cores. {% data reusables.codespaces.ways-to-create-a-codespace %} For more information, see [AUTOTITLE](/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository). - -{% data reusables.codespaces.ssh-server-installed %} - -For more information about the `devcontainer.json` file and the default container image, see [AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers). - -> [!NOTE] -> For help with connecting to your codespace over SSH, see [AUTOTITLE](/codespaces/troubleshooting/troubleshooting-github-codespaces-clients?tool=jetbrains#ssh-connection-issues). - -## Setting up the JetBrains Gateway - -The first time you use JetBrains Gateway for {% data variables.product.prodname_github_codespaces %}, you must install the {% data variables.product.prodname_codespaces %} plugin. You must also allow the JetBrains Gateway to access {% data variables.product.github %} using your {% data variables.product.prodname_dotcom %} account. - -1. Open the JetBrains Toolbox application. -1. In the list of installed tools, click **Gateway**. -1. Under **Install More Providers** click the **Install** link for {% data variables.product.prodname_github_codespaces %}. - - ![Screenshot of the "Welcome to JetBrains Gateway" page, with "{% data variables.product.prodname_github_codespaces %}" listed under "Install More Providers."](/assets/images/help/codespaces/jetbrains-gateway-initial-view.png) - -1. Click **Connect to Codespace**. - - ![Screenshot of the Gateway with the "Connect to {% data variables.product.prodname_codespaces %}" button.](/assets/images/help/codespaces/jetbrains-gateway-connect.png) - -1. The first time you connect, you're prompted to choose whether you want to allow {% data variables.product.prodname_dotcom %} to collect anonymized usage data, to improve functionality and user experience. Click **Allow** or **Deny**. - - You can change your choice later, if required, in the settings for the {% data variables.product.prodname_github_codespaces %} plugin, which you can access within the JetBrains Gateway settings. - -1. In the "Welcome to JetBrains Gateway" dialog, click **Sign In with {% data variables.product.prodname_dotcom %}**. -1. Click the icon beside the one-time code to copy it. - - ![Screenshot of a one-time login code. The copy icon beside the code is highlighted with a dark orange outline.](/assets/images/help/codespaces/jetbrains-gateway-login-code.png) - -1. Click the login link, below the login code. -1. If you are not currently signed in to {% data variables.product.prodname_dotcom %}, the sign-in page is displayed. - * Enter your details and click **Sign in**. - * Verify your authentication, for example by entering a two-factor authentication code. -1. On the "Device activation" page, paste the copied code and click **Continue**. -1. If you belong to organizations, the "Single sign-on to your organizations" page is displayed. Click **Authorize** beside the organizations you want to authorize the JetBrains Gateway to access, then click **Continue**. -1. On the "Authorize {% data variables.product.prodname_github_codespaces %} for JetBrains" page, click **Authorize {% data variables.product.prodname_dotcom %}**. -1. Return to the JetBrains Gateway application and open a codespace from the list of your currently active or stopped codespaces, see step 3 of the following procedure. - -## Opening a codespace in your JetBrains IDE - -{% data reusables.codespaces.opening-codespace-in-jetbrains %} - - The first time you connect to a codespace, the backend IDE will be downloaded to the remote machine. This may take a few minutes. The next time you connect to the same codespace this step won't be necessary, making the connection process quicker. - - The backend IDE is then started. Again, this step will not be required in future if you are reconnecting to a backend IDE that you have left running. - - The client application is then launched. - -## Further reading - -* [AUTOTITLE](/codespaces/developing-in-a-codespace/developing-in-a-codespace) -* [AUTOTITLE](/codespaces/reference/using-the-github-codespaces-plugin-for-jetbrains) -* [AUTOTITLE](/codespaces/troubleshooting/troubleshooting-github-codespaces-clients?tool=jetbrains) diff --git a/content/codespaces/developing-in-a-codespace/using-source-control-in-your-codespace.md b/content/codespaces/developing-in-a-codespace/using-source-control-in-your-codespace.md index 611c33798b46..c7fb357f6285 100644 --- a/content/codespaces/developing-in-a-codespace/using-source-control-in-your-codespace.md +++ b/content/codespaces/developing-in-a-codespace/using-source-control-in-your-codespace.md @@ -14,12 +14,6 @@ redirect_from: - /codespaces/developing-in-codespaces/using-source-control-in-your-codespace --- -{% jetbrains_beta %} - -{% data reusables.codespaces.codespaces-jetbrains-beta-note %} - -{% endjetbrains_beta %} - ## About source control in {% data variables.product.prodname_github_codespaces %} You can perform all the Git actions you need directly within your codespace. For example, you can fetch changes from a remote repository, switch branches, create a new branch, commit and push changes, and create a pull request. You can use the integrated terminal within your codespace to enter Git commands, or you can click icons and menu options to complete all the most common Git tasks. This guide explains how to use the graphical user interface for source control. @@ -55,7 +49,7 @@ You do not need to fork the repository before you create the codespace. For exam If you make a commit from the codespace, or push a new branch, {% data variables.product.prodname_github_codespaces %} either creates a fork of the repository under your account and links it to your codespace, or it links your codespace to an existing fork if you already have one for the repository. You can then push your changes to the fork and create a pull request to propose the changes to the upstream repository. -If you make a commit from the command line, you will see a prompt asking if you would like to proceed with linking your codespace to a new or existing fork. Enter `y` to proceed. If you commit changes from the **Source Control** view in {% data variables.product.prodname_vscode_shortname %}, or from the navigation bar in a JetBrains IDE, your codespace is automatically linked to a fork without you being prompted. +If you make a commit from the command line, you will see a prompt asking if you would like to proceed with linking your codespace to a new or existing fork. Enter `y` to proceed. If you commit changes from the **Source Control** view in {% data variables.product.prodname_vscode_shortname %}, your codespace is automatically linked to a fork without you being prompted. > [!NOTE] > * If you delete your fork repository, then any codespaces linked to the fork are deleted, even if you originally created them from the upstream repository. @@ -91,66 +85,3 @@ For more information, see [AUTOTITLE](/pull-requests/collaborating-with-pull-req {% data reusables.codespaces.source-control %} {% endvscode %} - -{% jetbrains_beta %} - -## Creating or switching branches - -1. Click the branch name at the right side of the status bar. - - ![Screenshot of the status bar, with the tooltip for the branch name displayed. The branch icon and name, "main," are highlighted with a dark orange outline.](/assets/images/help/codespaces/jetbrains-branch-button.png) - -1. In the pop-up menu, do one of the following: - * **To create a new branch based on the current branch**, click **New Branch**. - - ![Screenshot of the branches pop-up menu with the "New Branch" option selected.](/assets/images/help/codespaces/jetbrains-new-branch-option.png) - - Enter a name for the new branch and click **Create**. - - ![Screenshot of the "Create New Branch" dialog, with "Create" and "Cancel" buttons. "my-branch" has been entered as a branch name.](/assets/images/help/codespaces/jetbrains-create-branch-dialog.png) - - * **To check out an existing branch**, start typing the name of the branch you want to check out. Click the branch from the list, then click **Checkout**. - - ![Screenshot of the branches pop-up menu with the "origin/templates" branch selected and "Checkout" selected in the submenu.](/assets/images/help/codespaces/jetbrains-checkout-submenu.png) - - > [!TIP] - > If someone has recently changed a file on the remote repository, in the branch you switched to, you may not see those changes until you pull the changes into your codespace. - -## Committing your changes - -1. At the right side of the navigation bar, click the check mark. - - ![Screenshot of the navigation bar at the top of the JetBrains client. The check mark icon for committing your changes is highlighted.](/assets/images/help/codespaces/jetbrains-commit-button.png) - -1. In the Commit Changes dialog, enter a commit message. -1. Click **Commit**. - - Alternatively, click the down arrow beside **Commit** and click **Commit and Push**. - - ![Screenshot of the "Commit Changes" dialog showing the "Commit and Push" button.](/assets/images/help/codespaces/jetbrains-commit-and-push.png) - -## Pulling changes from the remote repository - -You can pull changes from the same branch on the remote repository and apply those changes to the copy of the repository you are working on in your codespace. - -1. At the right side of the navigation bar, click the downward pointing arrow. - - ![Screenshot of the navigation bar at the top of the JetBrains client. The downward arrow icon is highlighted with a dark orange outline.](/assets/images/help/codespaces/jetbrains-update-project-button.png) - -1. In the Update Project dialog, choose whether you want to merge or rebase the incoming changes. - - ![Screenshot of the "Update Project" dialog with options to merge or rebase, and a "Don't show again" checkbox.](/assets/images/help/codespaces/jetbrains-update-options.png) - -1. Click **OK**. - -## Pushing changes to your remote repository - -You can push changes you've saved and committed. This applies those changes to the upstream branch on the remote repository. You might want to do this if you're not yet ready to create a pull request, or if you prefer to create a pull request on {% data variables.product.prodname_dotcom %}. - -1. At the right side of the navigation bar, click the upward pointing arrow. - - ![Screenshot of the navigation bar at the top of the JetBrains client. The upward arrow icon is highlighted with a dark orange outline.](/assets/images/help/codespaces/jetbrains-push-button.png) - -1. In the Push Commits dialog, click **Push**. - -{% endjetbrains_beta %} diff --git a/content/codespaces/getting-started/deep-dive.md b/content/codespaces/getting-started/deep-dive.md index f55b168176aa..e7cbc28eef74 100644 --- a/content/codespaces/getting-started/deep-dive.md +++ b/content/codespaces/getting-started/deep-dive.md @@ -56,7 +56,6 @@ When your container has been created and any other initialization has run, you'l * Your web browser * [{% data variables.product.prodname_vscode %}](/codespaces/developing-in-a-codespace/using-github-codespaces-in-visual-studio-code) -* [A JetBrains IDE](/codespaces/developing-in-a-codespace/using-github-codespaces-in-your-jetbrains-ide) * [{% data variables.product.prodname_cli %}](/codespaces/developing-in-a-codespace/using-github-codespaces-with-github-cli) ### Step 4: Post-creation setup @@ -89,7 +88,6 @@ To stop your codespace you can * In the browser: on your list of codespaces at [https://github.com/codespaces](https://github.com/codespaces), click the ellipsis (**...**) to the right of the codespace you want to stop and click **Stop codespace**. * In {% data variables.product.prodname_vscode_shortname %}: open the {% data variables.product.prodname_vscode_command_palette %} - for example, by pressing Ctrl+Shift+P (Windows/Linux) or Shift+Command+P (Mac) - type `Codespaces: stop` then press Enter. For more information, see [AUTOTITLE](/codespaces/reference/using-the-vs-code-command-palette-in-codespaces#suspending-or-stopping-a-codespace). -* In the JetBrains client, click the stop button at the top of the {% data variables.product.prodname_github_codespaces %} tool window. For more information, see the "JetBrains IDEs" tab of [AUTOTITLE](/codespaces/developing-in-a-codespace/stopping-and-starting-a-codespace). * In a terminal window: use the {% data variables.product.prodname_cli %} command `gh codespace stop`. For more information, see [AUTOTITLE](/codespaces/developing-in-a-codespace/using-github-codespaces-with-github-cli#gh-commands-for-github-codespaces). If you exit your codespace without running the stop command (for example, by closing the browser tab), or if you leave the codespace running without interaction, the codespace and its running processes will continue for the duration of the inactivity timeout period. @@ -112,7 +110,7 @@ Running your application when you first land in your codespace can make for a fa ## Committing and pushing your changes -Git is installed by default in your codespace and so you can rely on your existing Git workflow. You can work with Git in your codespace either via the Terminal or by using the source control features of {% data variables.product.prodname_vscode_shortname %} or JetBrains. +Git is installed by default in your codespace and so you can rely on your existing Git workflow. You can work with Git in your codespace either via the Terminal or by using the source control features of {% data variables.product.prodname_vscode_shortname %}. If you're working with an existing repository, you can create a codespace from any branch, commit, or pull request in the repository, or you can switch to a new or existing branch from within your active codespace. Because {% data variables.product.prodname_github_codespaces %} is designed to be ephemeral, you can use it as an isolated environment to experiment, check a teammate's pull request, or fix merge conflicts. @@ -125,9 +123,9 @@ For more information, see [AUTOTITLE](/codespaces/developing-in-a-codespace/usin > [!NOTE] > Commits from your codespace will be attributed to the name and public email configured at https://github.com/settings/profile. A token scoped to the repository, included in the environment as `GITHUB_TOKEN`, and your GitHub credentials will be used to authenticate. -## Personalizing your codespace with extensions or plugins +## Personalizing your codespace with extensions -You can add plugins and extensions within a codespace to personalize your experience in JetBrains and {% data variables.product.prodname_vscode_shortname %} respectively. +You can add extensions within a codespace to personalize your experience in {% data variables.product.prodname_vscode_shortname %}. ### {% data variables.product.prodname_vscode_shortname %} extensions @@ -135,18 +133,6 @@ If you work on your codespaces in the {% data variables.product.prodname_vscode_ If you already use {% data variables.product.prodname_vscode_shortname %}, you can use [Settings Sync](https://code.visualstudio.com/docs/editor/settings-sync) to automatically sync extensions, settings, themes, and keyboard shortcuts between your local instance and any codespaces you create. -### JetBrains plugins - -If you work on your codespaces in a JetBrains IDE, you can add plugins from the JetBrains Marketplace. - -1. Click **JetBrains Client**, then click **Preferences**. -1. In the Preferences dialog, click either **Plugins On Host** to install a plugin in the full JetBrains IDE that's running remotely, or **Plugins** to install a plugin on the local client, for example to change the user interface theme. -1. Click the **Marketplace** tab. - - ![Screenshot of the "Preferences" dialog, with the "Marketplace" tab displayed. The "Plugins On Host" option is highlighted with a dark orange outline.](/assets/images/help/codespaces/jetbrains-preferences-plugins.png) - -1. Click **Install** beside the required plugin. - ## About the directory structure of a codespace {% data reusables.codespaces.workspaces-directory %} For more information on the `/tmp` directory, see [AUTOTITLE](/codespaces/developing-in-a-codespace/persisting-environment-variables-and-temporary-files#preventing-temporary-files-from-being-automatically-deleted). diff --git a/content/codespaces/getting-started/quickstart.md b/content/codespaces/getting-started/quickstart.md index 9a9b9695893b..66f53c48e242 100644 --- a/content/codespaces/getting-started/quickstart.md +++ b/content/codespaces/getting-started/quickstart.md @@ -118,7 +118,6 @@ You've successfully created, personalized, and run your first application within * [AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/enabling-or-disabling-github-codespaces-for-your-organization) * [AUTOTITLE](/codespaces/developing-in-a-codespace/using-github-codespaces-in-visual-studio-code) -* [AUTOTITLE](/codespaces/developing-in-a-codespace/using-github-codespaces-in-your-jetbrains-ide) * [AUTOTITLE](/codespaces/developing-in-a-codespace/using-github-codespaces-with-github-cli) * [AUTOTITLE](/codespaces/setting-your-user-preferences/setting-your-default-editor-for-github-codespaces). * [AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/managing-the-cost-of-github-codespaces-in-your-organization) diff --git a/content/codespaces/guides.md b/content/codespaces/guides.md index 396ec7aa2708..a79512d9fca4 100644 --- a/content/codespaces/guides.md +++ b/content/codespaces/guides.md @@ -32,7 +32,6 @@ includeGuides: - /codespaces/developing-in-a-codespace/stopping-and-starting-a-codespace - /codespaces/developing-in-a-codespace/working-collaboratively-in-a-codespace - /codespaces/developing-in-a-codespace/using-github-codespaces-in-visual-studio-code - - /codespaces/developing-in-a-codespace/using-github-codespaces-in-your-jetbrains-ide - /codespaces/developing-in-a-codespace/using-github-codespaces-with-github-cli - /codespaces/developing-in-a-codespace/using-source-control-in-your-codespace - /codespaces/developing-in-a-codespace/using-github-codespaces-for-pull-requests diff --git a/content/codespaces/index.md b/content/codespaces/index.md index 32c007c711d9..0b7711367643 100644 --- a/content/codespaces/index.md +++ b/content/codespaces/index.md @@ -19,7 +19,6 @@ featuredLinks: - /codespaces/developing-in-a-codespace/opening-an-existing-codespace - /codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account - /codespaces/developing-in-a-codespace/using-github-codespaces-in-visual-studio-code - - /codespaces/developing-in-a-codespace/using-github-codespaces-in-your-jetbrains-ide popular: - /codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/setting-up-your-nodejs-project-for-codespaces - /codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/setting-up-your-python-project-for-codespaces @@ -37,6 +36,8 @@ communityRedirect: redirect_from: - /github/developing-online-with-github-codespaces - /github/developing-online-with-codespaces + - /codespaces/developing-in-a-codespace/using-github-codespaces-in-your-jetbrains-ide + - /codespaces/reference/using-the-github-codespaces-plugin-for-jetbrains layout: product-landing versions: fpt: '*' diff --git a/content/codespaces/overview.md b/content/codespaces/overview.md index 1dcfbf5ad2bf..a09ecb8c5992 100644 --- a/content/codespaces/overview.md +++ b/content/codespaces/overview.md @@ -31,7 +31,7 @@ Each codespace you create is hosted by {% data variables.product.prodname_dotcom By default, the codespace development environment is created from an Ubuntu Linux image that includes a selection of popular languages and tools, but you can use an image based on a Linux distribution of your choice and configure it for your particular requirements. Regardless of your local operating system, your codespace will run in a Linux environment. Windows and macOS are not supported operating systems for the remote development container. -You can connect to your codespaces from your browser, from {% data variables.product.prodname_vscode %}, from the JetBrains Gateway application, or by using {% data variables.product.prodname_cli %}. When you connect, you are placed within the Docker container. You have limited access to the outer Linux virtual machine host. +You can connect to your codespaces from your browser, from {% data variables.product.prodname_vscode %}, or by using {% data variables.product.prodname_cli %}. When you connect, you are placed within the Docker container. You have limited access to the outer Linux virtual machine host. ![Diagram showing the relationship between a code editor and a codespace running on an Azure virtual machine.](/assets/images/help/codespaces/codespaces-diagram.png) diff --git a/content/codespaces/reference/index.md b/content/codespaces/reference/index.md index 5df97e3f838f..dc25d253d4c0 100644 --- a/content/codespaces/reference/index.md +++ b/content/codespaces/reference/index.md @@ -7,11 +7,9 @@ versions: children: - /allowing-your-codespace-to-access-a-private-registry - /using-github-copilot-in-github-codespaces - - /using-the-github-codespaces-plugin-for-jetbrains - /using-the-vs-code-command-palette-in-codespaces - /security-in-github-codespaces - /disaster-recovery-for-github-codespaces redirect_from: - /codespaces/codespaces-reference --- - diff --git a/content/codespaces/reference/using-the-github-codespaces-plugin-for-jetbrains.md b/content/codespaces/reference/using-the-github-codespaces-plugin-for-jetbrains.md deleted file mode 100644 index e54e3d97d696..000000000000 --- a/content/codespaces/reference/using-the-github-codespaces-plugin-for-jetbrains.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: Using the GitHub Codespaces plugin for JetBrains -shortTitle: Plugin for JetBrains -intro: 'You can use the {% data variables.product.prodname_github_codespaces %} plugin for the JetBrains client application to find out about your codespace or to stop your codespace when you''ve finished working.' -versions: - fpt: '*' - ghec: '*' -type: reference -topics: - - Codespaces -redirect_from: - - /codespaces/codespaces-reference/using-the-github-codespaces-plugin-for-jetbrains ---- - -{% data reusables.codespaces.codespaces-jetbrains-beta-note %} - -## About the {% data variables.product.prodname_github_codespaces %} plugin - -The JetBrains client application is launched when you connect to a codespace from the JetBrains Gateway application. It allows you to use {% data variables.product.prodname_github_codespaces %} with your favorite JetBrains IDE. For more information, see [AUTOTITLE](/codespaces/developing-in-a-codespace/using-github-codespaces-in-your-jetbrains-ide). - -The {% data variables.product.prodname_github_codespaces %} plugin is already installed in the JetBrains client when you connect to a codespace from the JetBrains Gateway. The plugin adds the {% data variables.product.prodname_github_codespaces %} tool window to the user interface. - -Click **{% data variables.product.prodname_github_codespaces %}** at the bottom left of the JetBrains client's application window to open the {% data variables.product.prodname_github_codespaces %} tool window. - -![Screenshot of the {% data variables.product.prodname_github_codespaces %} tool window. The "{% data variables.product.prodname_github_codespaces %}" tool window selector is highlighted with an orange outline.](/assets/images/help/codespaces/jetbrains-codespaces-tool-window.png) - -## Using the {% data variables.product.prodname_github_codespaces %} tool window - -The {% data variables.product.prodname_github_codespaces %} tool window shows: -* The repository from which you created this codespace -* The display name of the codespace -* The current branch -* The machine specifications -* The time for which this codespace can remain idle before it is automatically stopped -* The age of the codespace -* The period for which a stopped codespace will be retained before it is automatically deleted - -The icons at the top of the {% data variables.product.prodname_github_codespaces %} tool window provide the following functions. - -* **Refresh active codespace** - - ![Screenshot of the {% data variables.product.prodname_github_codespaces %} tool window. A refresh icon, which refreshes the active code space, is highlighted.](/assets/images/help/codespaces/jetbrains-plugin-icon-refresh.png) - - Refresh the details in the {% data variables.product.prodname_github_codespaces %} tool window. For example, if you used {% data variables.product.prodname_cli %} to change the display name, you could click this button to show the new name. - -* **Manage your codespaces from the web** - - ![Screenshot of the {% data variables.product.prodname_github_codespaces %} tool window. A world icon, which manages {% data variables.product.prodname_github_codespaces %} from the web, is highlighted.](/assets/images/help/codespaces/jetbrains-plugin-icon-index.png) - - Open your list of codespaces at https://github.com/codespaces. - -* **View the codespace creation log** - - ![Screenshot of the {% data variables.product.prodname_github_codespaces %} tool window. A document icon, which allows you to view a code space creation log, is highlighted.](/assets/images/help/codespaces/jetbrains-plugin-icon-log.png) - - Open the codespace creation log in the editor window. For more information, see [AUTOTITLE](/codespaces/troubleshooting/github-codespaces-logs). diff --git a/content/codespaces/setting-your-user-preferences/setting-your-default-editor-for-github-codespaces.md b/content/codespaces/setting-your-user-preferences/setting-your-default-editor-for-github-codespaces.md index dc78611be260..5eb31f1c3b26 100644 --- a/content/codespaces/setting-your-user-preferences/setting-your-default-editor-for-github-codespaces.md +++ b/content/codespaces/setting-your-user-preferences/setting-your-default-editor-for-github-codespaces.md @@ -17,15 +17,12 @@ type: how_to On the settings page, you can set your editor preference so that when you create a codespace, or open an existing codespace, it is opened in your choice of: * {% data variables.product.prodname_vscode %} (desktop application) * {% data variables.product.prodname_vscode %} (web client application) -* JetBrains Gateway - for opening codespaces in a JetBrains IDE * JupyterLab - the web interface for Project Jupyter {% data reusables.codespaces.template-codespaces-default-editor %} If you want to use {% data variables.product.prodname_vscode %} as your default editor for {% data variables.product.prodname_github_codespaces %}, you need to install {% data variables.product.prodname_vscode %} and the {% data variables.product.prodname_github_codespaces %} extension for {% data variables.product.prodname_vscode %}. For more information, see the [download page for {% data variables.product.prodname_vscode %}](https://code.visualstudio.com/download/) and the [{% data variables.product.prodname_github_codespaces %} extension on the {% data variables.product.prodname_vscode %} marketplace](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces). -If you want to work on a codespace in a JetBrains IDE you must install the JetBrains Gateway. For more information, see [AUTOTITLE](/codespaces/developing-in-a-codespace/using-github-codespaces-in-your-jetbrains-ide). - ## Setting your default editor {% data reusables.user-settings.access_settings %} @@ -40,14 +37,6 @@ If you want to work on a codespace in a JetBrains IDE you must install the JetBr You may need to allow access to both your browser and {% data variables.product.prodname_vscode %} for it to open successfully.

- * If you choose **JetBrains Gateway**, the Gateway application will automatically open when you next create or open a codespace. - - The first time you open a codespace this way you must give permission to open the application. - - The Gateway application will open and the codespace will then be automatically selected. You can then choose a JetBrains IDE, if you have not previously done so, and click **Connect** to open the codespace in the JetBrains client. For more information, see [AUTOTITLE](/codespaces/developing-in-a-codespace/using-github-codespaces-in-your-jetbrains-ide). - - To connect to a codespace from the Gateway application, you must have an SSH server running on the codespace. {% indented_data_reference reusables.codespaces.ssh-server-installed spaces=5 %} - * If you choose **JupyterLab**, the JupyterLab application must be installed in the codespaces you open. {% data reusables.codespaces.jupyterlab-in-default-image %} ## Further reading diff --git a/content/codespaces/troubleshooting/github-codespaces-logs.md b/content/codespaces/troubleshooting/github-codespaces-logs.md index 69be947f6348..5fca4f6e4006 100644 --- a/content/codespaces/troubleshooting/github-codespaces-logs.md +++ b/content/codespaces/troubleshooting/github-codespaces-logs.md @@ -13,12 +13,6 @@ redirect_from: - /codespaces/troubleshooting/codespaces-logs --- -{% jetbrains_beta %} - -{% data reusables.codespaces.codespaces-jetbrains-beta-note %} - -{% endjetbrains_beta %} - Information on {% data variables.product.prodname_github_codespaces %} is output to various logs: {% webui %} @@ -50,14 +44,6 @@ Other logs are available if you are using {% data variables.product.prodname_git {% endcli %} -{% jetbrains_beta %} - -* Creation logs - -Other logs are available if you are using {% data variables.product.prodname_github_codespaces %} in {% data variables.product.prodname_vscode_shortname %} or in your web browser. Click the tabs above for details. - -{% endjetbrains_beta %} - {% webui %} {% data reusables.codespaces.codespace-logs %} @@ -159,19 +145,6 @@ The following instructions are for Chrome. The steps for other browsers are simi {% endwebui %} -{% jetbrains_beta %} - -{% data reusables.codespaces.jetbrains-open-codespace-plugin %} -1. In the {% data variables.product.prodname_github_codespaces %} tool window, click the log icon. - - ![Screenshot of the log button (a book symbol).](/assets/images/help/codespaces/jetbrains-plugin-icon-log.png) - -## JetBrains logs - -You can download logs for the remote JetBrains IDE and the local client application by going to the **Help** menu in the JetBrains client application and clicking **Collect Host and Client Logs**. - -{% endjetbrains_beta %} - ## Further reading * [AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-github-codespaces) diff --git a/content/codespaces/troubleshooting/troubleshooting-github-codespaces-clients.md b/content/codespaces/troubleshooting/troubleshooting-github-codespaces-clients.md index a3a4c01cd9c5..6724dea53775 100644 --- a/content/codespaces/troubleshooting/troubleshooting-github-codespaces-clients.md +++ b/content/codespaces/troubleshooting/troubleshooting-github-codespaces-clients.md @@ -12,12 +12,6 @@ redirect_from: - /codespaces/troubleshooting/troubleshooting-codespaces-clients --- -{% jetbrains_beta %} - -{% data reusables.codespaces.codespaces-jetbrains-beta-note %} - -{% endjetbrains_beta %} - {% webui %} ## Troubleshooting the {% data variables.product.prodname_vscode %} web client @@ -67,83 +61,3 @@ If the problem isn't fixed in {% data variables.product.prodname_vscode %} Stabl {% data reusables.codespaces.troubleshooting-simple-browser %} {% endvscode %} - -{% jetbrains_beta %} - -## Troubleshooting JetBrains IDEs - -### Performance issues - -A {% data variables.product.prodname_github_codespaces %} machine type with at least 4 cores is recommended for running any of the JetBrains IDEs. For more information, see [AUTOTITLE](/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace). - -If you are using a machine with 4 or more cores and the performance you are experiencing in JetBrains feels a little sluggish, you may need to increase the maximum Java heap size. - -The recommended heap size varies according to the machine type of your codespace. - -| Machine type | Maximum heap size | -| -------------------- | ----------------- | -| 4 core, 16 GB RAM | 2048 MiB | -| 8 core, 32 GB RAM | 4096 MiB | -| 16 cores, 64 GB RAM | 8192 MiB | -| 32 cores, 128 GB RAM | 16,384 MiB | - -If the heap size is below the recommended value, a message is displayed when your codespace starts, suggesting that you increase the heap size. You can click the link in the message to increase the heap size automatically. - -![Screenshot of the message recommending you increase the heap size.](/assets/images/help/codespaces/heap-size-message.png) - -Depending on the size of your codebase, and the memory needed to run your application, you may need to increase the heap size further. You should set the heap size to somewhere between the size shown in the table above and 60% of the remote host's RAM. If you have a large application, you should not set too large a heap size, so that you allow the application adequate memory. - -1. On the left of the navigation bar, at the top of the application window, click the name of the codespace. - - ![Screenshot of the JetBrains client. The codespace name "urban meme," labeled "Resources critical," is highlighted with a dark orange outline.](/assets/images/help/codespaces/jetbrains-resources-button.png) - -1. In the Performance tab, note the CPU Load and Memory details. These will indicate whether the machine is overloaded. - - ![Screenshot of the "Performance" tab in the resources dropdown, showing CPU Load at 97.5%, Memory at 60.6%, and Disk at 28.8%.](/assets/images/help/codespaces/jetbrains-performance.png) - -1. Click the Settings tab and edit the heap size, increasing it to no more than 60% of the available memory for your codespace. - - ![Screenshot of the "Performance" tab. In the "Maximum heap size" field, 3072 is entered and outlined in dark orange. Below this are "Save" and "Save and restart" buttons.](/assets/images/help/codespaces/jetbrains-heap-setting.png) - -1. Click **Save and restart**. - -### Client can't be opened in macOS Ventura - -In macOS Ventura, using versions of the JetBrains Gateway prior to version 2022.3, the first time you try to connect to a codespace from the JetBrains Gateway a message was displayed telling you that the JetBrains client application "is damaged and can't be opened." - -Screenshot of the 'cannot be opened' error message - -This issue is fixed in the JetBrains Gateway, version 2022.3 and later. - -To avoid this issue, update the JetBrains Gateway. - -To work around this problem with older versions of the Gateway: - -1. Click **Cancel** to dismiss this message. -1. Click the Apple icon, top left of the screen, and click **System Settings**. -1. Click **Privacy & Security** and scroll down to the "Security" section. - - ![Screenshot of macOS "Privacy & Security" dialog, with a security message above the JetBrains Client and the "Open Anyway" button.](/assets/images/help/codespaces/jetbrains-privacy-and-security.png) - - You will see a message telling you that the JetBrains Client was blocked from use. - -1. Click **Open Anyway** to add the JetBrains client to your recognized applications. - The message is displayed again but this time with an **Open** button. - - Screenshot of the error message with an 'Open' button - -1. Click **Cancel** again. -1. Go back to the JetBrains Gateway application and connect to the required codespace again. - The JetBrains client will now open successfully. Having authorized the client application to run on your Mac, you will not see the message when you connect to your codespaces in future. - -### SSH connection issues - -To connect via the SSH server running in your codespace, you must have an SSH key in your `~/.ssh` directory (macOS and Linux) or `%HOMEPATH%\.ssh` directory (Windows) that has already been added to your {% data variables.product.prodname_dotcom %} account. If you do not have any keys in this directory, {% data variables.product.prodname_cli %} will generate keys for you. For more information, see [AUTOTITLE](/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account?platform=windows&tool=webui). - -If you encounter problems with key validation, try upgrading your version of {% data variables.product.prodname_cli %}. For information, see the [upgrade instructions](https://github.com/cli/cli#installation) in the README for {% data variables.product.prodname_cli %}. - -### JetBrains IDE issues - -For help with issues specific to the JetBrains IDE you are using, or the JetBrains Gateway application, see [Product Support](https://www.jetbrains.com/support/) on the JetBrains website. - -{% endjetbrains_beta %} diff --git a/data/reusables/codespaces/application-installed-locally.md b/data/reusables/codespaces/application-installed-locally.md index 69042ce72204..2466e8de32d2 100644 --- a/data/reusables/codespaces/application-installed-locally.md +++ b/data/reusables/codespaces/application-installed-locally.md @@ -1 +1 @@ -If you choose **{% data variables.product.prodname_vscode %}** or **JetBrains Gateway**, you must make sure you have installed the selected application on your local machine. +If you choose **{% data variables.product.prodname_vscode %}**, you must make sure you have installed the selected application on your local machine. diff --git a/data/reusables/codespaces/codespaces-jetbrains-beta-note.md b/data/reusables/codespaces/codespaces-jetbrains-beta-note.md deleted file mode 100644 index 9a8e6675cbfb..000000000000 --- a/data/reusables/codespaces/codespaces-jetbrains-beta-note.md +++ /dev/null @@ -1,3 +0,0 @@ -> [!NOTE] -> * Using {% data variables.product.prodname_github_codespaces %} with JetBrains IDEs is currently in {% data variables.release-phases.public_preview %} and is subject to change. -> * To work on a codespace in a JetBrains IDE you must use release 2023.3.\* or 2024.1.\* of the JetBrains Gateway. diff --git a/data/reusables/codespaces/jetbrains-open-codespace-plugin.md b/data/reusables/codespaces/jetbrains-open-codespace-plugin.md deleted file mode 100644 index 8229bfff6369..000000000000 --- a/data/reusables/codespaces/jetbrains-open-codespace-plugin.md +++ /dev/null @@ -1,3 +0,0 @@ -1. In the JetBrains client, click the {% data variables.product.prodname_github_codespaces %} plugin to display the {% data variables.product.prodname_github_codespaces %} tool window. - - ![Screenshot of the {% data variables.product.prodname_github_codespaces %} tool window. The "{% data variables.product.prodname_github_codespaces %}" tool window selector is highlighted with an orange outline.](/assets/images/help/codespaces/jetbrains-codespaces-tool-window.png) diff --git a/data/reusables/codespaces/linking-to-an-existing-codespace.md b/data/reusables/codespaces/linking-to-an-existing-codespace.md index 1029be005808..09376464adad 100644 --- a/data/reusables/codespaces/linking-to-an-existing-codespace.md +++ b/data/reusables/codespaces/linking-to-an-existing-codespace.md @@ -12,5 +12,4 @@ Create a link using one of the following URL patterns. In these URLs `CODESPACE- | {% data variables.product.prodname_vscode_shortname %} web client | `https://CODESPACE-NAME.github.dev` | | {% data variables.product.prodname_vscode_shortname %} web client with a specified workspace | `https://CODESPACE-NAME.github.dev?folder=/workspaces/PATH/TO/WORKSPACE/DIRECTORY` | | {% data variables.product.prodname_vscode_shortname %} desktop application | `https://github.com/codespaces/CODESPACE-NAME?editor=vscode` | -| JetBrains Gateway | `https://github.com/codespaces/CODESPACE-NAME?editor=jetbrains` | | JupyterLab | `https://github.com/codespaces/CODESPACE-NAME?editor=jupyter` | diff --git a/data/reusables/codespaces/opening-codespace-in-jetbrains.md b/data/reusables/codespaces/opening-codespace-in-jetbrains.md deleted file mode 100644 index 9f42bbd932e7..000000000000 --- a/data/reusables/codespaces/opening-codespace-in-jetbrains.md +++ /dev/null @@ -1,27 +0,0 @@ -If you have set the JetBrains Gateway as your default editor, then the Gateway will launch automatically when you open a codespace from {% data variables.product.github %}. - -If the JetBrains Gateway is not your default editor, you can still open a codespace in JetBrains by going to the "Your codespaces" page at [github.com/codespaces](https://github.com/codespaces) and clicking the ellipsis (...) to the right of the codespace you want to open. For more information, see [AUTOTITLE](/codespaces/developing-in-codespaces/opening-an-existing-codespace?tool=webui). - -Alternatively, you can also open the JetBrains Gateway and select an existing codespace, as described in the following procedure. - -1. Open the JetBrains Gateway application. -1. Click **Connect to {% data variables.product.prodname_codespaces %}**. - - ![Screenshot of the JetBrains Gateway home page, showing the "Connect to Codespaces" button.](/assets/images/help/codespaces/jetbrains-gateway-connect.png) - -1. In the "Your Codespaces" list, click the codespace you want to work in. - - ![Screenshot of the "Your Codespaces" list in the JetBrains Gateway.](/assets/images/help/codespaces/jetbrains-gateway-codespaces.png) - -1. In the "Available IDEs" list, click the JetBrains IDE you want to use. The Gateway will remember your choice the next time you connect to a codespace. - - ![Screenshot the "Select IDE" dropdown list in the JetBrains Gateway. The mouse pointer is pointing to "IntelliJ IDEA."](/assets/images/help/codespaces/jetbrains-gateway-ides.png) - -1. Click **Connect**. - - > [!NOTE] - > * If you chose Rider as your JetBrains IDE and the repository contains multiple solution files, the "Set Solution Path" dialog is displayed prompting you to choose which solution you want to work in. Choose a solution file from the dropdown menu and click **OK**. - > - > If the repository doesn't have a solution file, Rider opens in a basic project directory view and will have limited capabilities. For instance, you won't get .NET-specific code navigation. If there is just a single solution file in the repository it will be used automatically, without the prompt being displayed. For more information, see [Create and open projects and solutions](https://www.jetbrains.com/help/rider/Creating_and_Opening_Projects_and_Solutions.html) in the JetBrains documentation.

- > - > * If you are running a firewall, then the first time you connect to a remote resource you may be prompted to allow the JetBrains Gateway to communicate across your network. diff --git a/data/reusables/codespaces/port-forwarding-adding-non-jetbrains.md b/data/reusables/codespaces/port-forwarding-adding.md similarity index 100% rename from data/reusables/codespaces/port-forwarding-adding-non-jetbrains.md rename to data/reusables/codespaces/port-forwarding-adding.md diff --git a/data/reusables/codespaces/port-forwarding-intro-non-jetbrains.md b/data/reusables/codespaces/port-forwarding-intro.md similarity index 100% rename from data/reusables/codespaces/port-forwarding-intro-non-jetbrains.md rename to data/reusables/codespaces/port-forwarding-intro.md diff --git a/data/reusables/codespaces/port-forwarding-labeling-non-jetbrains.md b/data/reusables/codespaces/port-forwarding-labeling.md similarity index 100% rename from data/reusables/codespaces/port-forwarding-labeling-non-jetbrains.md rename to data/reusables/codespaces/port-forwarding-labeling.md diff --git a/data/reusables/codespaces/port-forwarding-sharing-non-jetbrains.md b/data/reusables/codespaces/port-forwarding-sharing.md similarity index 100% rename from data/reusables/codespaces/port-forwarding-sharing-non-jetbrains.md rename to data/reusables/codespaces/port-forwarding-sharing.md diff --git a/data/reusables/codespaces/rebuilding-container-procedures.md b/data/reusables/codespaces/rebuilding-container-procedures.md index 4064e16d3496..d96b9ea17390 100644 --- a/data/reusables/codespaces/rebuilding-container-procedures.md +++ b/data/reusables/codespaces/rebuilding-container-procedures.md @@ -8,7 +8,7 @@ ### Using {% data variables.product.prodname_cli %} to rebuild a dev container -If you've changed a dev container configuration outside of {% data variables.product.prodname_vscode_shortname %} (for example, on {% data variables.product.github %} or in a JetBrains IDE), you can use {% data variables.product.prodname_cli %} to rebuild the dev container for an existing codespace. +If you've changed a dev container configuration outside of {% data variables.product.prodname_vscode_shortname %} (for example, on {% data variables.product.github %}), you can use {% data variables.product.prodname_cli %} to rebuild the dev container for an existing codespace. 1. In a terminal, enter the following command. From 14c1272aad40e17d8e2db96f5539d6021bcf06e7 Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Mon, 6 Jan 2025 03:43:40 -0800 Subject: [PATCH 20/37] Update audit log event data (#53734) Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> --- src/audit-logs/lib/config.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/audit-logs/lib/config.json b/src/audit-logs/lib/config.json index 290606d8031f..c58ab834cd17 100644 --- a/src/audit-logs/lib/config.json +++ b/src/audit-logs/lib/config.json @@ -3,5 +3,5 @@ "apiOnlyEvents": "This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", "apiRequestEvent": "This event is only available via audit log streaming." }, - "sha": "aed021929f55efd8e1f773834dff3f02e75d1eba" + "sha": "f35047bbdf790cfb45ee2be4eb74ee966b7f3d52" } \ No newline at end of file From 4fe5ba706547a79dcf58e228525d70ee34f70875 Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Mon, 6 Jan 2025 03:59:38 -0800 Subject: [PATCH 21/37] Delete orphaned features (2024-12-30-16-28) (#53739) Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> --- data/features/default-setup-pre-enablement-ghes.yml | 7 ------- 1 file changed, 7 deletions(-) delete mode 100644 data/features/default-setup-pre-enablement-ghes.yml diff --git a/data/features/default-setup-pre-enablement-ghes.yml b/data/features/default-setup-pre-enablement-ghes.yml deleted file mode 100644 index ce0b2a3e3b11..000000000000 --- a/data/features/default-setup-pre-enablement-ghes.yml +++ /dev/null @@ -1,7 +0,0 @@ -# Default setup for code scanning can now be enabled on any repository, including repositories that don't contain a -# CodeQL-supported language, and scans will begin automatically if/when a CodeQL-supported language is added. This -# versioning pairs with `default-setup-pre-enablement` and was created to future-proof GHES-specific sections. -# Reference: #12363 - -versions: - ghes: '>3.12' From 325c1308707fc9759144d0365fa39ed7338fcea9 Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Mon, 6 Jan 2025 04:16:24 -0800 Subject: [PATCH 22/37] Update audit log event data (#53740) Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> --- src/audit-logs/lib/config.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/audit-logs/lib/config.json b/src/audit-logs/lib/config.json index c58ab834cd17..39421fd41e1a 100644 --- a/src/audit-logs/lib/config.json +++ b/src/audit-logs/lib/config.json @@ -3,5 +3,5 @@ "apiOnlyEvents": "This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", "apiRequestEvent": "This event is only available via audit log streaming." }, - "sha": "f35047bbdf790cfb45ee2be4eb74ee966b7f3d52" + "sha": "eafe424495cc22bd92b9122b9bb41a01f07314d9" } \ No newline at end of file From 318822480cdd513a03b93703da8e1d1e53914bd5 Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Mon, 6 Jan 2025 04:29:21 -0800 Subject: [PATCH 23/37] Update audit log event data (#53747) Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> --- src/audit-logs/lib/config.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/audit-logs/lib/config.json b/src/audit-logs/lib/config.json index 39421fd41e1a..9a9fdde4059f 100644 --- a/src/audit-logs/lib/config.json +++ b/src/audit-logs/lib/config.json @@ -3,5 +3,5 @@ "apiOnlyEvents": "This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", "apiRequestEvent": "This event is only available via audit log streaming." }, - "sha": "eafe424495cc22bd92b9122b9bb41a01f07314d9" + "sha": "20c2272a952ed0bd5281b59da7c6b538ed330b75" } \ No newline at end of file From 8d0c7bffc1f7f6e40fda8e54943aa62247749d84 Mon Sep 17 00:00:00 2001 From: RSKR Date: Mon, 6 Jan 2025 21:08:44 +0530 Subject: [PATCH 24/37] fix(docs): replaces `actions` with the right keyword `OWNER` (#35816) Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> --- .../creating-actions/creating-a-composite-action.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/actions/sharing-automations/creating-actions/creating-a-composite-action.md b/content/actions/sharing-automations/creating-actions/creating-a-composite-action.md index ed1f8397c398..faa79ccf0324 100644 --- a/content/actions/sharing-automations/creating-actions/creating-a-composite-action.md +++ b/content/actions/sharing-automations/creating-actions/creating-a-composite-action.md @@ -155,7 +155,7 @@ Before you begin, you'll create a repository on {% data variables.product.github The following workflow code uses the completed hello world action that you made in [AUTOTITLE](/actions/creating-actions/creating-a-composite-action#creating-an-action-metadata-file). -Copy the workflow code into a `.github/workflows/main.yml` file in another repository, replacing `actions` and `SHA` with the repository owner and the SHA of the commit you want to use, respectively. You can also replace the `who-to-greet` input with your name. +Copy the workflow code into a `.github/workflows/main.yml` file in another repository, replacing `OWNER` and `SHA` with the repository owner and the SHA of the commit you want to use, respectively. You can also replace the `who-to-greet` input with your name. ```yaml copy on: [push] From a494a7bddaa0a03937fc2417edc5d55d2b15ef82 Mon Sep 17 00:00:00 2001 From: Jason Frey Date: Mon, 6 Jan 2025 10:39:50 -0500 Subject: [PATCH 25/37] Simplify the links for languages by pointing to the full list directly (#35811) Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> --- .../migrating-from-travis-ci-to-github-actions.md | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/content/actions/migrating-to-github-actions/manually-migrating-to-github-actions/migrating-from-travis-ci-to-github-actions.md b/content/actions/migrating-to-github-actions/manually-migrating-to-github-actions/migrating-from-travis-ci-to-github-actions.md index fdca1ee9a597..e37b7d91df3f 100644 --- a/content/actions/migrating-to-github-actions/manually-migrating-to-github-actions/migrating-from-travis-ci-to-github-actions.md +++ b/content/actions/migrating-to-github-actions/manually-migrating-to-github-actions/migrating-from-travis-ci-to-github-actions.md @@ -183,13 +183,7 @@ The concurrent jobs and workflow execution times in {% data variables.product.pr ### Using different languages in {% data variables.product.prodname_actions %} -When working with different languages in {% data variables.product.prodname_actions %}, you can create a step in your job to set up your language dependencies. For more information about working with a particular language, see the specific guide: -* [Building and testing Node.js](/actions/automating-builds-and-tests/building-and-testing-nodejs) -* [Building and testing Python](/actions/automating-builds-and-tests/building-and-testing-python) -* [Building and testing PowerShell](/actions/automating-builds-and-tests/building-and-testing-powershell) -* [Building and testing Java with Maven](/actions/automating-builds-and-tests/building-and-testing-java-with-maven) -* [Building and testing Java with Gradle](/actions/automating-builds-and-tests/building-and-testing-java-with-gradle) -* [Building and testing Java with Ant](/actions/automating-builds-and-tests/building-and-testing-java-with-ant) +When working with different languages in {% data variables.product.prodname_actions %}, you can create a step in your job to set up your language dependencies. For more information about working with a particular language, see [AUTOTITLE](/actions/use-cases-and-examples/building-and-testing). ## Executing scripts From 4e8773ccb9311e8ef119fd786a15f30a782e916b Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Mon, 6 Jan 2025 23:40:55 +0800 Subject: [PATCH 26/37] Be sure to define 'description' (#35804) Co-authored-by: Felicity Chapman Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> --- .../using-issues/linking-a-pull-request-to-an-issue.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/content/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue.md b/content/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue.md index 3c090bd42abb..a11759f859e6 100644 --- a/content/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue.md +++ b/content/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue.md @@ -19,16 +19,16 @@ topics: shortTitle: Link PR to issue --- -> [!NOTE] -> The special keywords in a pull request description are interpreted when the pull request targets the repository's _default_ branch. However, if the PR's base is _any other branch_, then these keywords are ignored, no links are created and merging the PR has no effect on the issues. **If you want to link a pull request to an issue using a keyword, the PR must be on the default branch.** - ## About linked issues and pull requests -You can link an issue to a pull request manually or using a supported keyword in the pull request description. +You can link an issue to a pull request manually or using a supported keyword in the pull request description, that is, the summary text added by the author when they created the pull request. When you link a pull request to the issue the pull request addresses, collaborators can see that someone is working on the issue. -When you merge a linked pull request into the default branch of a repository, its linked issue is automatically closed. For more information about the default branch, see [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/changing-the-default-branch). +When you merge a linked pull request into the **default branch** of a repository, its linked issue is automatically closed. For more information about the default branch, see [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/changing-the-default-branch). + +> [!NOTE] +> The special keywords in a pull request description are interpreted only when the pull request targets the repository's _default_ branch. If the pull request targets _any other branch_, then these keywords are ignored, no links are created, and merging the PR has no effect on the issues. ## Linking a pull request to an issue using a keyword From 6c20e887bed0e6fb174bd697502f4f60cb657af9 Mon Sep 17 00:00:00 2001 From: StefanFB <68238380+StefanFB@users.noreply.github.com> Date: Mon, 6 Jan 2025 16:40:59 +0100 Subject: [PATCH 27/37] Fixed command for listing domains required for Codespaces (#35800) Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> --- .../troubleshooting-your-connection-to-github-codespaces.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/codespaces/troubleshooting/troubleshooting-your-connection-to-github-codespaces.md b/content/codespaces/troubleshooting/troubleshooting-your-connection-to-github-codespaces.md index dea2a4501054..6221c90c30cd 100644 --- a/content/codespaces/troubleshooting/troubleshooting-your-connection-to-github-codespaces.md +++ b/content/codespaces/troubleshooting/troubleshooting-your-connection-to-github-codespaces.md @@ -36,7 +36,7 @@ If you see rejected connections, make sure the domains documented by the `/meta` To get the list of domains required by {% data variables.product.prodname_github_codespaces %}, execute the following command using {% data variables.product.prodname_cli %}: -`gh api meta | jq .domains.codespaces` +`gh api meta --jq .domains.codespaces` ### "We are having trouble fetching your codespace information" From 9c90fc89567b64b75852f5d7518cac598e4a513f Mon Sep 17 00:00:00 2001 From: Jacob Harris Date: Mon, 6 Jan 2025 10:42:07 -0500 Subject: [PATCH 28/37] use backticks to format _layouts directory in securing-your-github-pages-site-with-https#resolving-problems-with-mixed-content (#35795) Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> --- .../securing-your-github-pages-site-with-https.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https.md b/content/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https.md index 53741c38af94..40a407842b71 100644 --- a/content/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https.md +++ b/content/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https.md @@ -46,7 +46,7 @@ If you enable HTTPS for your {% data variables.product.prodname_pages %} site bu To remove your site's mixed content, make sure all your assets are served over HTTPS by changing `http://` to `https://` in your site's HTML. Assets are commonly found in the following locations: -* If your site uses Jekyll, your HTML files will probably be found in the __layouts_ folder. +* If your site uses Jekyll, your HTML files will probably be found in the `_layouts` folder. * CSS is usually found in the `` section of your HTML file. * JavaScript is usually found in the `` section or just before the closing `` tag. * Images are often found in the `` section. From c422ad22dc8021c946cc00f1d3cb0d375e15994e Mon Sep 17 00:00:00 2001 From: Piyush Bhaskar <102078527+Piyush-r-bhaskar@users.noreply.github.com> Date: Mon, 6 Jan 2025 21:36:50 +0530 Subject: [PATCH 29/37] docs: Use backticks to format file name in working-with-the-npm-registry#installing-a-package. (#35793) Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> --- .../working-with-the-npm-registry.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md b/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md index eb971e2eeb29..f44cbde6f1e1 100644 --- a/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md +++ b/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md @@ -58,9 +58,9 @@ This registry supports granular permissions. {% data reusables.package_registry. {% data reusables.package_registry.required-scopes %} -You can authenticate to {% data variables.product.prodname_registry %} with npm by either editing your per-user _~/.npmrc_ file to include your {% data variables.product.pat_v1 %} or by logging in to npm on the command line using your username and {% data variables.product.pat_generic %}. +You can authenticate to {% data variables.product.prodname_registry %} with npm by either editing your per-user `~/.npmrc` file to include your {% data variables.product.pat_v1 %} or by logging in to npm on the command line using your username and {% data variables.product.pat_generic %}. -To authenticate by adding your {% data variables.product.pat_v1 %} to your _~/.npmrc_ file, edit the _~/.npmrc_ file for your project to include the following line, replacing {% ifversion ghes %}HOSTNAME with the host name of {% data variables.location.product_location %} and {% endif %}TOKEN with your {% data variables.product.pat_generic %}. Create a new _~/.npmrc_ file if one doesn't exist. +To authenticate by adding your {% data variables.product.pat_v1 %} to your `~/.npmrc` file, edit the `~/.npmrc` file for your project to include the following line, replacing {% ifversion ghes %}HOSTNAME with the host name of {% data variables.location.product_location %} and {% endif %}TOKEN with your {% data variables.product.pat_generic %}. Create a new `~/.npmrc` file if one doesn't exist. {% ifversion ghes %} If your instance has subdomain isolation enabled: @@ -137,9 +137,9 @@ You can set up the scope mapping for your project using either a local `.npmrc` {% data reusables.package_registry.viewing-packages %} -### Publishing a package using a local _.npmrc_ file +### Publishing a package using a local `.npmrc` file -You can use an _.npmrc_ file to configure the scope mapping for your project. In the _.npmrc_ file, use the {% data variables.product.prodname_registry %} URL and account owner so {% data variables.product.prodname_registry %} knows where to route package requests. Using an _.npmrc_ file prevents other developers from accidentally publishing the package to npmjs.org instead of {% data variables.product.prodname_registry %}. +You can use an `.npmrc` file to configure the scope mapping for your project. In the `.npmrc` file, use the {% data variables.product.prodname_registry %} URL and account owner so {% data variables.product.prodname_registry %} knows where to route package requests. Using an `.npmrc` file prevents other developers from accidentally publishing the package to npmjs.org instead of {% data variables.product.prodname_registry %}. {% data reusables.package_registry.authenticate-step %} {% data reusables.package_registry.create-npmrc-owner-step %} @@ -194,7 +194,7 @@ You can install packages from {% data variables.product.prodname_registry %} by By default, you can add packages from one organization. For more information, see [Installing packages from other organizations](#installing-packages-from-other-organizations). -You also need to add the _.npmrc_ file to your project so that all requests to install packages will go through {% data variables.product.prodname_registry %}. When you route all package requests through {% data variables.product.prodname_registry %}, you can use both scoped and unscoped packages from _npmjs.org_. For more information, see [npm-scope](https://docs.npmjs.com/misc/scope) in the npm documentation. +You also need to add the `.npmrc` file to your project so that all requests to install packages will go through {% data variables.product.prodname_registry %}. When you route all package requests through {% data variables.product.prodname_registry %}, you can use both scoped and unscoped packages from _npmjs.org_. For more information, see [npm-scope](https://docs.npmjs.com/misc/scope) in the npm documentation. {% data reusables.package_registry.authenticate-step %} {% data reusables.package_registry.create-npmrc-owner-step %} @@ -223,7 +223,7 @@ You also need to add the _.npmrc_ file to your project so that all requests to i ### Installing packages from other organizations -By default, you can only use {% data variables.product.prodname_registry %} packages from one organization. If you'd like to route package requests to multiple organizations and users, you can add additional lines to your _.npmrc_ file, replacing {% ifversion ghes %}`HOSTNAME` with the host name of {% data variables.location.product_location %} and {% endif %}`NAMESPACE` with the name of the personal account or organization {% ifversion packages-npm-v2 %}to which the package is scoped{% else %}that owns the repository containing the project{% endif %}. +By default, you can only use {% data variables.product.prodname_registry %} packages from one organization. If you'd like to route package requests to multiple organizations and users, you can add additional lines to your `.npmrc` file, replacing {% ifversion ghes %}`HOSTNAME` with the host name of {% data variables.location.product_location %} and {% endif %}`NAMESPACE` with the name of the personal account or organization {% ifversion packages-npm-v2 %}to which the package is scoped{% else %}that owns the repository containing the project{% endif %}. {% ifversion ghes %} If your instance has subdomain isolation enabled: From 99024c5f0b76964dde2164bfbcd30b10d9a0b393 Mon Sep 17 00:00:00 2001 From: Piyush Bhaskar <102078527+Piyush-r-bhaskar@users.noreply.github.com> Date: Mon, 6 Jan 2025 21:37:10 +0530 Subject: [PATCH 30/37] Capitalize list line in working-with-the-apache-maven-registry#authenticating-to-github-packages. (#35792) Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> --- data/reusables/package_registry/authenticate-packages.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/reusables/package_registry/authenticate-packages.md b/data/reusables/package_registry/authenticate-packages.md index c15920beb25b..fc5f87ddcbc2 100644 --- a/data/reusables/package_registry/authenticate-packages.md +++ b/data/reusables/package_registry/authenticate-packages.md @@ -6,4 +6,4 @@ You can use a {% data variables.product.pat_v1 %} to authenticate to {% data var To authenticate to a {% data variables.product.prodname_registry %} registry within a {% data variables.product.prodname_actions %} workflow, you can use: * `GITHUB_TOKEN` to publish packages associated with the workflow repository. -* a {% data variables.product.pat_v1 %} with at least `read:packages` scope to install packages associated with other private repositories (which `GITHUB_TOKEN` can't access). +* A {% data variables.product.pat_v1 %} with at least `read:packages` scope to install packages associated with other private repositories (which `GITHUB_TOKEN` can't access). From aa20214dd9d878400a2c558edf3458854097bd12 Mon Sep 17 00:00:00 2001 From: Piyush Bhaskar <102078527+Piyush-r-bhaskar@users.noreply.github.com> Date: Mon, 6 Jan 2025 21:37:26 +0530 Subject: [PATCH 31/37] Add colons in about-github-packages-and-github-actions#workflows-for-publishing-packages | issue/35774 (#35791) Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> --- .../reusables/package_registry/about-packaging-and-actions.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/data/reusables/package_registry/about-packaging-and-actions.md b/data/reusables/package_registry/about-packaging-and-actions.md index b359bdfad755..bdcd36ed22e4 100644 --- a/data/reusables/package_registry/about-packaging-and-actions.md +++ b/data/reusables/package_registry/about-packaging-and-actions.md @@ -16,12 +16,12 @@ This will let you run the code in the pull request on your machine, which can he In addition to uploading packaging artifacts for testing in a continuous integration workflow, you can create workflows that build your project and publish packages to a package registry. -* **Publish packages to {% data variables.product.prodname_registry %}** +* **Publish packages to {% data variables.product.prodname_registry %}:** {% data variables.product.prodname_registry %} can act as a package hosting service for many types of packages. You can choose to share your packages with all of {% data variables.product.prodname_dotcom %}, or private packages to share with collaborators or an organization. For more information, see "[AUTOTITLE](/packages/learn-github-packages/introduction-to-github-packages)." You may want to publish packages to {% data variables.product.prodname_registry %} on every push into the default branch. This will allow developers on your project to always be able to run and test the latest build from the default branch easily, by installing it from {% data variables.product.prodname_registry %}. -* **Publish packages to a package registry** +* **Publish packages to a package registry:** For many projects, publishing to a package registry is performed whenever a new version of a project is released. For example, a project that produces a JAR file may upload new releases to the Maven Central repository. Or, a .NET project may produce a nuget package and upload it to the NuGet Gallery. You can automate this by creating a workflow that publishes packages to a package registry on every release creation. For more information, see "[AUTOTITLE](/repositories/releasing-projects-on-github/managing-releases-in-a-repository)." From eef734ae68615738322db277bd29f74cc9407184 Mon Sep 17 00:00:00 2001 From: Shashwat Pathak <111122076+shashwatpathak98@users.noreply.github.com> Date: Mon, 6 Jan 2025 22:42:18 +0530 Subject: [PATCH 32/37] fix: Add missing period in about-github-pages#usage-limits (#35781) Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> --- .../getting-started-with-github-pages/about-github-pages.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/pages/getting-started-with-github-pages/about-github-pages.md b/content/pages/getting-started-with-github-pages/about-github-pages.md index 5fe9a21bb32b..e2af4547ee82 100644 --- a/content/pages/getting-started-with-github-pages/about-github-pages.md +++ b/content/pages/getting-started-with-github-pages/about-github-pages.md @@ -117,7 +117,7 @@ Using {% data variables.product.prodname_pages %} to create a copy of an existin {% data variables.product.prodname_pages %} sites are subject to the following usage limits: -* {% data variables.product.prodname_pages %} source repositories have a recommended limit of 1 GB.{% ifversion fpt or ghec %} For more information, see [AUTOTITLE](/repositories/working-with-files/managing-large-files/about-large-files-on-github#file-and-repository-size-limitations){% endif %} +* {% data variables.product.prodname_pages %} source repositories have a recommended limit of 1 GB.{% ifversion fpt or ghec %} For more information, see [AUTOTITLE](/repositories/working-with-files/managing-large-files/about-large-files-on-github#file-and-repository-size-limitations){% endif %}. * Published {% data variables.product.prodname_pages %} sites may be no larger than 1 GB. * {% data variables.product.prodname_pages %} deployments will timeout if they take longer than 10 minutes. {% ifversion fpt or ghec %} From d31c0bad84b936549b922070b08faaaf498d995b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nikola=20Kolo=C5=A1njaji?= Date: Mon, 6 Jan 2025 18:12:18 +0100 Subject: [PATCH 33/37] Update building-and-testing-java-with-maven.md (#35777) Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> --- .../building-and-testing-java-with-maven.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/actions/use-cases-and-examples/building-and-testing/building-and-testing-java-with-maven.md b/content/actions/use-cases-and-examples/building-and-testing/building-and-testing-java-with-maven.md index 13230c3a7323..4cd3b9aeccab 100644 --- a/content/actions/use-cases-and-examples/building-and-testing/building-and-testing-java-with-maven.md +++ b/content/actions/use-cases-and-examples/building-and-testing/building-and-testing-java-with-maven.md @@ -117,7 +117,7 @@ You can cache your dependencies to speed up your workflow runs. After a successf ```yaml copy steps: - uses: {% data reusables.actions.action-checkout %} - - name: Set up JDK 11 + - name: Set up JDK 17 uses: {% data reusables.actions.action-setup-java %} with: java-version: '17' From 17f081f68886e70712d0b61c24bafe8441282094 Mon Sep 17 00:00:00 2001 From: Jan Brasna <1784648+janbrasna@users.noreply.github.com> Date: Mon, 6 Jan 2025 18:12:56 +0100 Subject: [PATCH 34/37] Fit disable-selfhosted-runners reusable sentence in its ifversion (#35770) Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> --- data/reusables/actions/disable-selfhosted-runners-crossrefs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/reusables/actions/disable-selfhosted-runners-crossrefs.md b/data/reusables/actions/disable-selfhosted-runners-crossrefs.md index 2cc86e9ea8fb..d275c5ae2767 100644 --- a/data/reusables/actions/disable-selfhosted-runners-crossrefs.md +++ b/data/reusables/actions/disable-selfhosted-runners-crossrefs.md @@ -1,4 +1,4 @@ -{% ifversion ghec or ghes %}Enterprise owners and organization {% elsif fpt %}Organization {% endif %}owners can choose which repositories are allowed to create repository-level self-hosted runners. {% ifversion custom-org-roles %}Users with the “Manage organization runners and runner groups” permission can only choose which repositories are allowed to create repository-level self-hosted runners for repositories in your organization{% endif %}. +{% ifversion ghec or ghes %}Enterprise owners and organization {% elsif fpt %}Organization {% endif %}owners can choose which repositories are allowed to create repository-level self-hosted runners. {% ifversion custom-org-roles %}Users with the “Manage organization runners and runner groups” permission can only choose which repositories are allowed to create repository-level self-hosted runners for repositories in your organization.{% endif %} {% ifversion custom-org-roles %}For more information about custom organization roles, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).{% endif %} From 5c0a7b2cff102332d47469427e49574cdd9fd0fa Mon Sep 17 00:00:00 2001 From: yolocat <81561018+yolocat-dev@users.noreply.github.com> Date: Mon, 6 Jan 2025 18:40:58 +0100 Subject: [PATCH 35/37] Use backtick to format references to file names in `working-with-the-npm-registry` (#35765) Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> --- data/reusables/package_registry/verify_repository_field.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/reusables/package_registry/verify_repository_field.md b/data/reusables/package_registry/verify_repository_field.md index 462e08bc54ea..58ba6af4b6c0 100644 --- a/data/reusables/package_registry/verify_repository_field.md +++ b/data/reusables/package_registry/verify_repository_field.md @@ -1 +1 @@ -1. Verify the `repository` field in your project's _package.json_. The `repository` field must match the URL for your {% data variables.product.prodname_dotcom %} repository. For example, if your repository URL is `github.com/my-org/test` then the repository field should be `https://github.com/my-org/test.git`. +1. Verify the `repository` field in your project's `package.json`. The `repository` field must match the URL for your {% data variables.product.prodname_dotcom %} repository. For example, if your repository URL is `github.com/my-org/test` then the repository field should be `https://github.com/my-org/test.git`. From 6fb3316152c6e85b9ced6a81234924098be7f1c5 Mon Sep 17 00:00:00 2001 From: Michael21107 <121039033+Michael21107@users.noreply.github.com> Date: Mon, 6 Jan 2025 18:41:18 +0100 Subject: [PATCH 36/37] Update about-task-lists.md (#35764) Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> --- .../working-with-advanced-formatting/about-task-lists.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists.md b/content/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists.md index 1ad7172042c6..83a4fd280108 100644 --- a/content/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists.md +++ b/content/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists.md @@ -44,7 +44,7 @@ If you add a task list to the body of an issue, the list has added functionality {% data reusables.repositories.task-list-markdown %} -> [!TIP] +> [!NOTE] > You cannot create task list items within closed issues or issues with linked pull requests. ## Reordering tasks From 6225df505c85c85a9b2cf3030ca2595f3714a420 Mon Sep 17 00:00:00 2001 From: satler <119724672+satler-git@users.noreply.github.com> Date: Tue, 7 Jan 2025 02:41:24 +0900 Subject: [PATCH 37/37] fix: payload and secret are translated in some langs(use inline code) (#35759) Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> --- .../webhooks/using-webhooks/validating-webhook-deliveries.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/webhooks/using-webhooks/validating-webhook-deliveries.md b/content/webhooks/using-webhooks/validating-webhook-deliveries.md index 75cb20c2b573..4ad442197c6e 100644 --- a/content/webhooks/using-webhooks/validating-webhook-deliveries.md +++ b/content/webhooks/using-webhooks/validating-webhook-deliveries.md @@ -57,8 +57,8 @@ There are a few important things to keep in mind when validating webhook payload You can use the following `secret` and `payload` values to verify that your implementation is correct: -* `secret`: "It's a Secret to Everybody" -* `payload`: "Hello, World!" +* `secret`: `It's a Secret to Everybody` +* `payload`: `Hello, World!` If your implementation is correct, the signatures that you generate should match the following signature values: