From aeebc41481b50b8a6232fecd6feb833b43100f0c Mon Sep 17 00:00:00 2001 From: Steve S Date: Thu, 9 Jul 2026 11:39:59 -0400 Subject: [PATCH 01/15] Set ELASTICSEARCH_URL inline in copilot-setup-steps index step (#62202) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .github/workflows/copilot-setup-steps.yml | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/.github/workflows/copilot-setup-steps.yml b/.github/workflows/copilot-setup-steps.yml index 694548cf43ae..19efaecd7380 100644 --- a/.github/workflows/copilot-setup-steps.yml +++ b/.github/workflows/copilot-setup-steps.yml @@ -57,5 +57,11 @@ jobs: run: npm run build # Populate Elasticsearch with fixture data so search/language tests work. + # ELASTICSEARCH_URL is set inline in the run command because the + # Copilot/GHAS agent runtime executes these setup steps with its own + # injected environment and does not apply the workflow's `env:` blocks + # (job-level or step-level). The inline assignment is part of the run + # command, which the agent runs verbatim, so it is honored in both the + # agent context and normal workflow_dispatch runs. - name: Index fixtures into the local Elasticsearch - run: npm run index-test-fixtures + run: ELASTICSEARCH_URL=http://localhost:9200/ npm run index-test-fixtures From c92d36614e4ce33e1ad6a1ca886a8a8322c12f3f Mon Sep 17 00:00:00 2001 From: Kevin Heis Date: Thu, 9 Jul 2026 08:40:47 -0700 Subject: [PATCH 02/15] Update redirected internal links in copilot (get-started) (#62160) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- content/copilot/get-started/best-practices.md | 14 +++++----- content/copilot/get-started/features.md | 26 +++++++++---------- content/copilot/get-started/plans.md | 2 +- content/copilot/get-started/quickstart.md | 20 +++++++------- .../get-started/what-is-github-copilot.md | 8 +++--- 5 files changed, 35 insertions(+), 35 deletions(-) diff --git a/content/copilot/get-started/best-practices.md b/content/copilot/get-started/best-practices.md index fd16e744a0cb..6124c0c12390 100644 --- a/content/copilot/get-started/best-practices.md +++ b/content/copilot/get-started/best-practices.md @@ -43,7 +43,7 @@ While {% data variables.product.prodname_copilot_short %} inline suggestions and * Answering questions about code in natural language * Generating large sections of code, then iterating on that code to meet your needs -* Accomplishing specific tasks with keywords and skills. {% data variables.copilot.copilot_chat_short %} has built-in keywords and skills designed to provide important context for prompts and accomplish common tasks quickly. Different types of keywords and skills are available in different {% data variables.copilot.copilot_chat_short %} platforms. See [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide#using-keywords-in-your-prompt){% ifversion fpt %}.{% else %} and [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-githubcom#powered-by-skills).{% endif %} +* Accomplishing specific tasks with keywords and skills. {% data variables.copilot.copilot_chat_short %} has built-in keywords and skills designed to provide important context for prompts and accomplish common tasks quickly. Different types of keywords and skills are available in different {% data variables.copilot.copilot_chat_short %} platforms. See [AUTOTITLE](/copilot/how-tos/chat-with-copilot/chat-in-ide#using-keywords-in-your-prompt){% ifversion fpt %}.{% else %} and [AUTOTITLE](/copilot/how-tos/copilot-on-github/chat-with-copilot/chat-in-github).{% endif %} * Completing a task as a specific persona. For example, you can tell {% data variables.copilot.copilot_chat_short %} that it is a Senior C++ Developer who cares greatly about code quality, readability, and efficiency, then ask it to review your code. ## Create thoughtful prompts @@ -55,7 +55,7 @@ Prompt engineering, or structuring your request so {% data variables.product.pro * Provide examples of things like input data, outputs, and implementations. * Follow good coding practices. -To learn more, see [AUTOTITLE](/copilot/using-github-copilot/copilot-chat/prompt-engineering-for-copilot-chat). +To learn more, see [AUTOTITLE](/copilot/concepts/prompting/prompt-engineering). ## Check {% data variables.product.prodname_copilot_short %}'s work @@ -65,7 +65,7 @@ While {% data variables.product.prodname_copilot_short %} is very powerful, it i * **Review {% data variables.product.prodname_copilot_short %}'s suggestions carefully.** Consider not just the functionality and security of the suggested code, but also the readability and maintainability of the code moving forward. * **Use automated tests and tooling to check {% data variables.product.prodname_copilot_short %}'s work.** With the help of tools like linting, {% data variables.product.prodname_code_scanning %}, and IP scanning, you can automate an additional layer of security and accuracy checks. -> [!TIP] Optionally, you may want to check {% data variables.product.prodname_copilot_short %}'s work for similarities to existing public code. If you don't want to use similar code, you can turn off suggestions matching public code. See {% ifversion fpt %}[AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-copilot-policies-as-an-individual-subscriber#enabling-or-disabling-suggestions-matching-public-code) or [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).{% else %}[AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-copilot-policies-as-an-individual-subscriber#enabling-or-disabling-suggestions-matching-public-code), [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching), or [AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise#suggestions-matching-public-code).{% endif %} +> [!TIP] Optionally, you may want to check {% data variables.product.prodname_copilot_short %}'s work for similarities to existing public code. If you don't want to use similar code, you can turn off suggestions matching public code. See {% ifversion fpt %}[AUTOTITLE](/copilot/how-tos/manage-your-account/manage-policies#enabling-or-disabling-suggestions-matching-public-code) or [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/manage-policies).{% else %}[AUTOTITLE](/copilot/how-tos/manage-your-account/manage-policies#enabling-or-disabling-suggestions-matching-public-code), [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/manage-policies), or [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-enterprise-policies).{% endif %} ## Guide {% data variables.product.prodname_copilot_short %} towards helpful outputs @@ -74,14 +74,14 @@ There are several adjustments you can make to steer {% data variables.product.pr * **Provide {% data variables.product.prodname_copilot_short %} with helpful context:** * If you are using {% data variables.product.prodname_copilot_short %} in your IDE, open relevant files and close irrelevant files. * In {% data variables.copilot.copilot_chat_short %}, if a particular request is no longer helpful context, delete that request from the conversation. Alternatively, if none of the context of a particular conversation is helpful, start a new conversation. - * If you are using {% data variables.copilot.copilot_chat_dotcom_short %}, provide specific repositories, files, symbols, and more as context. See [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-githubcom). - * If you are using {% data variables.copilot.copilot_chat_short %} in your IDE, use keywords to focus {% data variables.product.prodname_copilot_short %} on a specific task or piece of context. See [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide#using-keywords-in-your-prompt). + * If you are using {% data variables.copilot.copilot_chat_dotcom_short %}, provide specific repositories, files, symbols, and more as context. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/chat-with-copilot/chat-in-github). + * If you are using {% data variables.copilot.copilot_chat_short %} in your IDE, use keywords to focus {% data variables.product.prodname_copilot_short %} on a specific task or piece of context. See [AUTOTITLE](/copilot/how-tos/chat-with-copilot/chat-in-ide#using-keywords-in-your-prompt). * **Rewrite your prompts to generate different responses.** If {% data variables.product.prodname_copilot_short %} is not providing a helpful response, try rephrasing your prompt, or even breaking your request down into multiple smaller prompts. -* **Pick the best available suggestion.** When you are using inline suggestions, {% data variables.product.prodname_copilot_short %} might offer more than one suggestion. You can use keyboard shortcuts to quickly look through all available suggestions. For the default keyboard shortcuts for your operating system, see [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/configuring-github-copilot-in-your-environment#keyboard-shortcuts-for-github-copilot). +* **Pick the best available suggestion.** When you are using inline suggestions, {% data variables.product.prodname_copilot_short %} might offer more than one suggestion. You can use keyboard shortcuts to quickly look through all available suggestions. For the default keyboard shortcuts for your operating system, see [AUTOTITLE](/copilot/reference/keyboard-shortcuts). * **Provide feedback to improve future suggestions.** You can provide feedback in many ways: * For inline suggestions, accept or reject {% data variables.product.prodname_copilot_short %}'s suggestion. * For individual responses in {% data variables.copilot.copilot_chat_short %}, click the thumbs up or thumbs down icons next to the response. - * For {% data variables.copilot.copilot_chat_short %} in your IDE, see [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide#sharing-feedback) for instructions specific to your environment. + * For {% data variables.copilot.copilot_chat_short %} in your IDE, see [AUTOTITLE](/copilot/how-tos/chat-with-copilot/chat-in-ide#sharing-feedback) for instructions specific to your environment. * For {% data variables.copilot.copilot_chat_dotcom_short %}, leave a comment on the [feedback discussion](https://github.com/orgs/community/discussions/110314). ## Stay up-to-date on {% data variables.product.prodname_copilot_short %}'s features diff --git a/content/copilot/get-started/features.md b/content/copilot/get-started/features.md index 409cf82d43d7..04dcf9243490 100644 --- a/content/copilot/get-started/features.md +++ b/content/copilot/get-started/features.md @@ -21,17 +21,17 @@ These tools are used synchronously, providing advice or suggestions as people wo ### {% data variables.copilot.copilot_chat_short %} -A chat interface that lets you ask coding-related questions. {% data variables.copilot.copilot_chat %} is available on the {% data variables.product.github %} website, in {% data variables.product.prodname_mobile %}, in supported IDEs, and in {% data variables.product.prodname_windows_terminal %}. Users can also use skills with {% data variables.copilot.copilot_chat_short %}. See [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-github) and [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide). +A chat interface that lets you ask coding-related questions. {% data variables.copilot.copilot_chat %} is available on the {% data variables.product.github %} website, in {% data variables.product.prodname_mobile %}, in supported IDEs, and in {% data variables.product.prodname_windows_terminal %}. Users can also use skills with {% data variables.copilot.copilot_chat_short %}. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/chat-with-copilot/chat-in-github) and [AUTOTITLE](/copilot/how-tos/chat-with-copilot/chat-in-ide). ### Inline suggestions -Autocomplete-style suggestions from {% data variables.product.prodname_copilot_short %} in supported IDEs. See [AUTOTITLE](/copilot/using-github-copilot/getting-code-suggestions-in-your-ide-with-github-copilot). +Autocomplete-style suggestions from {% data variables.product.prodname_copilot_short %} in supported IDEs. See [AUTOTITLE](/copilot/how-tos/get-code-suggestions/get-ide-code-suggestions). If you use {% data variables.product.prodname_vscode_shortname %}, Xcode, or Eclipse, you can also use {% data variables.copilot.next_edit_suggestions %}, which will predict the location of the next edit you are likely to make and suggest a completion for it. ### {% data variables.copilot.copilot_for_prs %} -AI-generated summaries of the changes that were made in a pull request, which files they impact, and what a reviewer should focus on when they conduct their review. See [AUTOTITLE](/copilot/using-github-copilot/creating-a-pull-request-summary-with-github-copilot). +AI-generated summaries of the changes that were made in a pull request, which files they impact, and what a reviewer should focus on when they conduct their review. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/copilot-for-github-tasks/create-a-pr-summary). ### {% data variables.copilot.copilot_desktop_short %} @@ -43,7 +43,7 @@ These features can work autonomously without direct human supervision. However, ### {% data variables.copilot.copilot_cli_short %} -A command line interface that lets you use {% data variables.product.prodname_copilot_short %} in your terminal. Use the CLI to add features or fix bugs, then create a pull request. Start {% data variables.product.prodname_copilot_short %} working on a task in your terminal, then continue working in the same session on {% data variables.product.prodname_dotcom_the_website %}, or on your mobile. See [AUTOTITLE](/copilot/concepts/agents/about-copilot-cli). +A command line interface that lets you use {% data variables.product.prodname_copilot_short %} in your terminal. Use the CLI to add features or fix bugs, then create a pull request. Start {% data variables.product.prodname_copilot_short %} working on a task in your terminal, then continue working in the same session on {% data variables.product.prodname_dotcom_the_website %}, or on your mobile. See [AUTOTITLE](/copilot/concepts/agents/copilot-cli/about-copilot-cli). ### {% data variables.copilot.copilot_cloud_agent %} @@ -55,7 +55,7 @@ You can use third-party coding agents alongside {% data variables.copilot.copilo ### {% data variables.copilot.copilot_code-review_short %} -AI-generated code review suggestions to help you write better code. See [AUTOTITLE](/copilot/using-github-copilot/code-review/using-copilot-code-review). +AI-generated code review suggestions to help you write better code. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/request-a-code-review/use-code-review). Several {% data variables.copilot.copilot_code-review-tools_short %} are in {% data variables.release-phases.public_preview %} and subject to change. See [AUTOTITLE](/copilot/concepts/agents/code-review). @@ -73,7 +73,7 @@ These features can be used to add context to {% data variables.product.prodname_ ### {% data variables.copilot.copilot_spaces %} -Organize and centralize relevant content—like code, docs, specs, and more—into {% data variables.copilot.copilot_spaces_short %} that ground {% data variables.product.prodname_copilot_short %}’s responses in the right context for a specific task. See [AUTOTITLE](/copilot/using-github-copilot/copilot-spaces/about-organizing-and-sharing-context-with-copilot-spaces). +Organize and centralize relevant content—like code, docs, specs, and more—into {% data variables.copilot.copilot_spaces_short %} that ground {% data variables.product.prodname_copilot_short %}’s responses in the right context for a specific task. See [AUTOTITLE](/copilot/concepts/context/spaces). ### Custom instructions @@ -105,25 +105,25 @@ The following features are available to organization and enterprise owners with ### Policy management -Manage policies for {% data variables.product.prodname_copilot_short %} in your organization or enterprise. 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) and [AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise). +Manage policies for {% data variables.product.prodname_copilot_short %} in your organization or enterprise. See [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/manage-policies) and [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-enterprise-policies). ### Access management -Enterprise owners can specify which organizations in the enterprise can use {% data variables.product.prodname_copilot_short %}, and organization owners can specify which organization members can use Copilot. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization) and [AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise). +Enterprise owners can specify which organizations in the enterprise can use {% data variables.product.prodname_copilot_short %}, and organization owners can specify which organization members can use Copilot. See [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/manage-access) and [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-access). ### Usage data -Review {% data variables.product.prodname_copilot_short %} usage data within your organization or enterprise to inform how to manage access and drive adoption of {% data variables.product.prodname_copilot_short %}. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization) and [AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise/viewing-copilot-license-usage-in-your-enterprise). +Review {% data variables.product.prodname_copilot_short %} usage data within your organization or enterprise to inform how to manage access and drive adoption of {% data variables.product.prodname_copilot_short %}. See [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/review-activity/review-user-activity-data) and [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-access/view-license-usage). ### Audit logs -Review audit logs for {% data variables.product.prodname_copilot_short %} in your organization to understand what actions have been taken and by which users. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-audit-logs-for-copilot-business). +Review audit logs for {% data variables.product.prodname_copilot_short %} in your enterprise to understand what actions have been taken and by which users. See [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/review-audit-logs). ### File exclusions -Configure {% data variables.product.prodname_copilot_short %} to ignore certain files. This can be useful if you have files that you don't want to be available to {% data variables.product.prodname_copilot_short %}. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/excluding-content-from-github-copilot). +Configure {% data variables.product.prodname_copilot_short %} to ignore certain files. This can be useful if you have files that you don't want to be available to {% data variables.product.prodname_copilot_short %}. See [AUTOTITLE](/copilot/how-tos/configure-content-exclusion/exclude-content-from-copilot). ## Next steps -* To learn more about the plans available for {% data variables.product.prodname_copilot %}, see [AUTOTITLE](/copilot/about-github-copilot/subscription-plans-for-github-copilot). -* To start using {% data variables.product.prodname_copilot_short %}, see [AUTOTITLE](/copilot/setting-up-github-copilot). +* To learn more about the plans available for {% data variables.product.prodname_copilot %}, see [AUTOTITLE](/copilot/get-started/plans). +* To start using {% data variables.product.prodname_copilot_short %}, see [AUTOTITLE](/copilot/how-tos/set-up). diff --git a/content/copilot/get-started/plans.md b/content/copilot/get-started/plans.md index 7b66ff20879f..16343f093af4 100644 --- a/content/copilot/get-started/plans.md +++ b/content/copilot/get-started/plans.md @@ -39,7 +39,7 @@ The tables below show the features available in each {% data variables.product.p {% data reusables.copilot.differences-cfi-cfb-table %} -For more information, see [AUTOTITLE](/copilot/about-github-copilot/github-copilot-features). +For more information, see [AUTOTITLE](/copilot/get-started/features). ## Ready to choose a plan? diff --git a/content/copilot/get-started/quickstart.md b/content/copilot/get-started/quickstart.md index 335c546941c3..9471ad27944e 100644 --- a/content/copilot/get-started/quickstart.md +++ b/content/copilot/get-started/quickstart.md @@ -30,7 +30,7 @@ category: {% webui %} -You can use {% data variables.product.prodname_copilot_short %} to get answers to 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). +You can use {% data variables.product.prodname_copilot_short %} to get answers to 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/get-started/what-is-github-copilot). Instructions for using {% data variables.product.prodname_copilot_short %} differ depending on where you are using it. This version of the quickstart is for using {% data variables.product.prodname_copilot_short %} on the {% data variables.product.github %} website. Click the tabs above for instructions on using {% data variables.product.prodname_copilot_short %} in other environments. @@ -73,15 +73,15 @@ There are many more things you can do with {% data variables.copilot.copilot_cha * Find out about the changes in a pull request * Ask a question about a specific issue or commit -For more information, see [AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-github/using-github-copilot-chat-in-githubcom). +For more information, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/chat-with-copilot/chat-in-github). ## Next steps -* **Find out more about {% data variables.copilot.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 %} -* **Get {% data variables.product.prodname_copilot_short %} inline suggestions in an IDE** - See [AUTOTITLE](/enterprise-cloud@latest/copilot/using-github-copilot/using-github-copilot-code-suggestions-in-your-editor). -* **Learn how to write effective prompts** - See [AUTOTITLE](/copilot/using-github-copilot/prompt-engineering-for-github-copilot). -* **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). +* **Find out more about {% data variables.copilot.copilot_chat %}** - See [AUTOTITLE](/copilot/how-tos/chat-with-copilot/chat-in-ide){% ifversion fpt %}.{% endif %}{% ifversion ghec %} and [AUTOTITLE](/copilot/how-tos/copilot-on-github/chat-with-copilot/chat-in-github).{% endif %} +* **Get {% data variables.product.prodname_copilot_short %} inline suggestions in an IDE** - See [AUTOTITLE](/enterprise-cloud@latest/copilot/how-tos/get-code-suggestions/get-ide-code-suggestions). +* **Learn how to write effective prompts** - See [AUTOTITLE](/copilot/concepts/prompting/prompt-engineering). +* **Use {% data variables.product.prodname_copilot_short %} on your mobile device** - See [AUTOTITLE](/copilot/how-tos/copilot-on-github/chat-with-copilot/chat-in-mobile). +* **Use {% data variables.product.prodname_copilot_short %} on the command line** - See [AUTOTITLE](/copilot/how-tos/use-copilot-for-common-tasks/use-copilot-in-the-cli). {% endwebui %} @@ -256,7 +256,7 @@ Instructions for using {% data variables.product.prodname_copilot_short %} diffe ## Prerequisites * **Subscription to {% data variables.product.prodname_copilot_short %}**. To use {% data variables.product.prodname_copilot %} in a JetBrains IDE, you must have an active {% data variables.product.prodname_copilot %} subscription. {% data reusables.copilot.subscription-prerequisite %} -* **A compatible JetBrains IDE**. {% data variables.product.prodname_copilot_short %} is supported in a large number of JetBrains IDEs. For a full list, see [AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-ides/using-github-copilot-chat-in-your-ide?tool=jetbrains). +* **A compatible JetBrains IDE**. {% data variables.product.prodname_copilot_short %} is supported in a large number of JetBrains IDEs. For a full list, see [AUTOTITLE](/copilot/how-tos/chat-with-copilot/chat-in-ide?tool=jetbrains). {% data reusables.copilot.jetbrains-plugin-prerequisites %} ## Chat with {% data variables.product.prodname_copilot %} @@ -311,7 +311,7 @@ Instructions for using {% data variables.product.prodname_copilot_short %} diffe * **Subscription to {% data variables.product.prodname_copilot_short %}**. To use {% data variables.product.prodname_copilot %} in Xcode, you must have an active {% data variables.product.prodname_copilot %} subscription. {% data reusables.copilot.subscription-prerequisite %} * **Latest version of the {% data variables.product.prodname_copilot %} extension**. For installation instructions, see [AUTOTITLE](/copilot/how-tos/set-up/install-copilot-extension?tool=xcode). -* **Sign in to {% data variables.product.company_short %} in Xcode**. If you experience authentication issues, see [AUTOTITLE](/copilot/troubleshooting-github-copilot/troubleshooting-issues-with-github-copilot-chat#troubleshooting-authentication-issues-in-your-editor). +* **Sign in to {% data variables.product.company_short %} in Xcode**. If you experience authentication issues, see [AUTOTITLE](/copilot/how-tos/troubleshoot-copilot/troubleshoot-common-issues). ## Chat with {% data variables.product.prodname_copilot %} @@ -378,7 +378,7 @@ Instructions for using {% data variables.product.prodname_copilot_short %} diffe * **Subscription to {% data variables.product.prodname_copilot_short %}**. To use {% data variables.product.prodname_copilot %} in Eclipse, you must have an active {% data variables.product.prodname_copilot %} subscription. {% data reusables.copilot.subscription-prerequisite %} * **Latest version of the {% data variables.product.prodname_copilot %} extension**. For installation instructions, see [AUTOTITLE](/copilot/how-tos/set-up/install-copilot-extension?tool=eclipse). -* **Sign in to {% data variables.product.company_short %} in Eclipse**. If you experience authentication issues, see [AUTOTITLE](/copilot/troubleshooting-github-copilot/troubleshooting-issues-with-github-copilot-chat#troubleshooting-authentication-issues-in-your-editor). +* **Sign in to {% data variables.product.company_short %} in Eclipse**. If you experience authentication issues, see [AUTOTITLE](/copilot/how-tos/troubleshoot-copilot/troubleshoot-common-issues). ## Chat with {% data variables.product.prodname_copilot %} diff --git a/content/copilot/get-started/what-is-github-copilot.md b/content/copilot/get-started/what-is-github-copilot.md index c60a54817f5b..bacbffb08b26 100644 --- a/content/copilot/get-started/what-is-github-copilot.md +++ b/content/copilot/get-started/what-is-github-copilot.md @@ -52,7 +52,7 @@ Use {% data variables.product.prodname_copilot_short %} in the following places: * The command line, through the {% data variables.product.prodname_cli %} * The {% data variables.product.github %} website -See [AUTOTITLE](/copilot/about-github-copilot/github-copilot-features). +See [AUTOTITLE](/copilot/get-started/features). ## Get access @@ -65,7 +65,7 @@ You can start using {% data variables.product.prodname_copilot_short %} in sever * **Get free access if you're eligible.** Students, teachers, and open source maintainers may qualify for access to premium features at no cost. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/set-up-copilot/enable-copilot/set-up-for-students) and [AUTOTITLE](/copilot/how-tos/copilot-on-github/set-up-copilot/enable-copilot/set-up-for-teachers-and-os-maintainers). * **Request access from your organization.** If your organization or enterprise has a {% data variables.product.prodname_copilot %} plan, you can request access by going to [https://github.com/settings/copilot](https://github.com/settings/copilot) and request access under "Get {% data variables.product.prodname_copilot_short %} from an organization." -See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/getting-started-with-copilot-on-your-personal-account/getting-started-with-a-copilot-plan) for more information. +See [AUTOTITLE](/copilot/how-tos/manage-your-account/get-started-with-a-copilot-plan) for more information. ### Organizations and enterprises @@ -80,8 +80,8 @@ If your organization is owned by an enterprise that has a {% data variables.prod ## Next steps -* Learn more about {% data variables.product.prodname_copilot_short %} features. See [AUTOTITLE](/copilot/about-github-copilot/github-copilot-features). -* Start using {% data variables.product.prodname_copilot_short %}. See [AUTOTITLE](/copilot/setting-up-github-copilot). +* Learn more about {% data variables.product.prodname_copilot_short %} features. See [AUTOTITLE](/copilot/get-started/features). +* Start using {% data variables.product.prodname_copilot_short %}. See [AUTOTITLE](/copilot/how-tos/set-up). ## Further reading From 9f5e5c809fcc60731697e1ddebd3b1bc952284d9 Mon Sep 17 00:00:00 2001 From: Kevin Heis Date: Thu, 9 Jul 2026 08:48:45 -0700 Subject: [PATCH 03/15] Update redirected internal links in copilot (concepts) (#62159) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../about-cloud-and-local-sandboxes.md | 4 +-- .../concepts/agents/about-agent-skills.md | 4 +-- .../about-enterprise-plugin-standards.md | 2 +- .../agents/about-third-party-coding-agents.md | 6 ++-- .../concepts/agents/anthropic-claude.md | 2 +- .../agents/cloud-agent/about-automations.md | 4 +-- .../agents/cloud-agent/about-cloud-agent.md | 18 +++++------ .../agents/cloud-agent/about-custom-agents.md | 2 +- .../agents/cloud-agent/access-management.md | 10 +++---- .../agents/cloud-agent/agent-management.md | 4 +-- .../agents/cloud-agent/mcp-and-cloud-agent.md | 4 +-- .../cloud-agent/risks-and-mitigations.md | 4 +-- .../copilot/concepts/agents/code-review.md | 14 ++++----- .../copilot-cli/about-cli-extensions.md | 2 +- .../agents/copilot-cli/about-copilot-cli.md | 12 ++++---- .../copilot-cli/comparing-cli-features.md | 6 ++-- .../agents/copilot-cli/context-management.md | 2 +- .../concepts/agents/copilot-cli/fleet.md | 2 +- .../agents/copilot-cli/lsp-servers.md | 2 +- .../concepts/agents/copilot-cli/research.md | 2 +- .../concepts/agents/enterprise-management.md | 2 +- .../concepts/agents/github-copilot-app.md | 2 +- content/copilot/concepts/agents/hooks.md | 2 +- .../copilot/concepts/agents/openai-codex.md | 4 +-- .../concepts/billing/individual-plans.md | 4 +-- .../billing/organizations-and-enterprises.md | 6 ++-- .../usage-based-billing-for-individuals.md | 8 ++--- content/copilot/concepts/chat.md | 10 +++---- .../concepts/completions/code-referencing.md | 6 ++-- .../concepts/completions/code-suggestions.md | 6 ++-- .../concepts/context/content-exclusion.md | 4 +-- content/copilot/concepts/context/mcp.md | 14 ++++----- .../concepts/context/repository-indexing.md | 4 +-- content/copilot/concepts/context/spaces.md | 2 +- .../copilot-usage-metrics/copilot-metrics.md | 6 ++-- .../concepts/models/auto-model-selection.md | 2 +- content/copilot/concepts/network-settings.md | 4 +-- content/copilot/concepts/policies.md | 4 +-- .../concepts/prompting/prompt-engineering.md | 2 +- .../prompting/response-customization.md | 30 +++++++++---------- content/copilot/concepts/spark.md | 2 +- 41 files changed, 115 insertions(+), 115 deletions(-) diff --git a/content/copilot/concepts/about-cloud-and-local-sandboxes.md b/content/copilot/concepts/about-cloud-and-local-sandboxes.md index 5aab63aef3cb..57a68ea8f409 100644 --- a/content/copilot/concepts/about-cloud-and-local-sandboxes.md +++ b/content/copilot/concepts/about-cloud-and-local-sandboxes.md @@ -92,7 +92,7 @@ When you stop a session, the cloud sandbox creates a snapshot of its state so yo An organization or enterprise owner must enable the **Cloud Sandbox access** policy in the organization or enterprise settings before members can use {% data variables.copilot.sandbox_short %}. -For information about signing in to {% data variables.copilot.copilot_cli_short %}, see [AUTOTITLE](/copilot/how-tos/set-up/install-copilot-cli). +For information about signing in to {% data variables.copilot.copilot_cli_short %}, see [AUTOTITLE](/copilot/how-tos/copilot-cli/set-up-copilot-cli/install-copilot-cli). ## Billing @@ -112,4 +112,4 @@ For more information about how cloud sandbox usage is measured and billed, see [ * [AUTOTITLE](/copilot/concepts/agents/copilot-cli/about-copilot-cli) * [AUTOTITLE](/copilot/how-tos/cloud-and-local-sandboxes/enabling-or-disabling-cloud-sandboxes-for-your-organization) -* [AUTOTITLE](/copilot/how-tos/set-up/install-copilot-cli) +* [AUTOTITLE](/copilot/how-tos/copilot-cli/set-up-copilot-cli/install-copilot-cli) diff --git a/content/copilot/concepts/agents/about-agent-skills.md b/content/copilot/concepts/agents/about-agent-skills.md index ecf2747d859c..3fdc99c4ab70 100644 --- a/content/copilot/concepts/agents/about-agent-skills.md +++ b/content/copilot/concepts/agents/about-agent-skills.md @@ -20,7 +20,7 @@ Agent skills are folders of instructions, scripts, and resources that {% data va You can create your own skills to teach {% data variables.product.prodname_copilot_short %} to perform tasks in a specific, repeatable way—or use skills shared online, for example in the [`anthropics/skills`](https://github.com/anthropics/skills) repository or {% data variables.product.company_short %}'s community-created [`github/awesome-copilot`](https://github.com/github/awesome-copilot) collection. -You can also use `gh skill` in {% data variables.product.prodname_cli %} to discover and install skills from {% data variables.product.github %} repositories. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/add-skills#managing-skills-with-github-cli). +You can also use `gh skill` in {% data variables.product.prodname_cli %} to discover and install skills from {% data variables.product.github %} repositories. For more information, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/add-skills#managing-skills-with-github-cli). {% data variables.product.prodname_copilot_short %} supports: @@ -31,7 +31,7 @@ You can also use `gh skill` in {% data variables.product.prodname_cli %} to disc To create or add agent skills, see: -* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/add-skills) +* [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/add-skills) * [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-copilot/add-skills) * [AUTOTITLE](/copilot/how-tos/github-copilot-app/customize-github-copilot-app) * [AUTOTITLE](/copilot/reference/customization-cheat-sheet) diff --git a/content/copilot/concepts/agents/about-enterprise-plugin-standards.md b/content/copilot/concepts/agents/about-enterprise-plugin-standards.md index fa0287a16c57..fd1aa1cb8ddb 100644 --- a/content/copilot/concepts/agents/about-enterprise-plugin-standards.md +++ b/content/copilot/concepts/agents/about-enterprise-plugin-standards.md @@ -50,4 +50,4 @@ Enterprise-managed plugin standards help administrators address several common c ## Next step -To configure enterprise plugin standards, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/configure-enterprise-plugin-standards). +To configure enterprise plugin standards, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/configure-enterprise-managed-settings). diff --git a/content/copilot/concepts/agents/about-third-party-coding-agents.md b/content/copilot/concepts/agents/about-third-party-coding-agents.md index 7b35a8117440..7768c904e601 100644 --- a/content/copilot/concepts/agents/about-third-party-coding-agents.md +++ b/content/copilot/concepts/agents/about-third-party-coding-agents.md @@ -26,7 +26,7 @@ You can kick off tasks with coding agents in the following locations: * **The Agents tab**: Select an agent under the prompt box in the [Agents tab](https://github.com/copilot/agents?ref_product=copilot&ref_type=engagement&ref_style=text&utm_source=docs-3p-agents-tab-cta&utm_medium=docs&utm_campaign=agent-3p-platform-feb-2026), then kick off a new task and watch the agent get to work on a pull request. * **Issues**: Assign the agent to an existing issue in a repository. * **Pull requests**: Mention `@AGENT_NAME` in a comment on an existing pull request to ask it to make changes. -* On [**{% data variables.product.prodname_mobile %}**](/copilot/how-tos/chat-with-copilot/chat-in-mobile): From the **Home** view, click {% octicon "plus" aria-hidden="true" aria-label="plus" %} to start a new agent session. +* On [**{% data variables.product.prodname_mobile %}**](/copilot/how-tos/copilot-on-github/chat-with-copilot/chat-in-mobile): From the **Home** view, click {% octicon "plus" aria-hidden="true" aria-label="plus" %} to start a new agent session. * In [**{% data variables.product.prodname_vscode %}**](https://code.visualstudio.com/docs/copilot/agents/overview#_create-an-agent-session): Start a new session in the chat view, or delegate an existing session to a different agent. ### Making coding agents available @@ -49,7 +49,7 @@ The following third-party agents are supported on {% data variables.product.gith When starting a task with a third-party agent, you can select the AI model used by the agent. You may find that different models perform better, or provide more useful responses, depending on the type of task. For help deciding which model to use, see [AUTOTITLE](/copilot/reference/ai-models/model-comparison). -You can also select **Auto**, which allows {% data variables.copilot.copilot_auto_model_selection %} to choose the best available model on your behalf. See [AUTOTITLE](/copilot/concepts/auto-model-selection). +You can also select **Auto**, which allows {% data variables.copilot.copilot_auto_model_selection %} to choose the best available model on your behalf. See [AUTOTITLE](/copilot/concepts/models/auto-model-selection). The following models are available for each agent: @@ -92,5 +92,5 @@ Actions taken by these {% data variables.product.prodname_github_apps %} will be ## Next steps -* To start managing agents, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/manage-agents). +* To start managing agents, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/use-copilot-agents/manage-and-track-agents). * To learn how AI models are hosted and served, see [AUTOTITLE](/copilot/reference/ai-models/model-hosting). diff --git a/content/copilot/concepts/agents/anthropic-claude.md b/content/copilot/concepts/agents/anthropic-claude.md index 3a602de0057c..7a82870d3beb 100644 --- a/content/copilot/concepts/agents/anthropic-claude.md +++ b/content/copilot/concepts/agents/anthropic-claude.md @@ -27,4 +27,4 @@ When starting a task with the {% data variables.product.prodname_anthropic_claud * Auto {% data reusables.copilot.anthropic-claude-agent-models %} -If you select **Auto**, {% data variables.copilot.copilot_auto_model_selection %} will select the best model based on availability and to help reduce rate limiting. For more information, see [AUTOTITLE](/copilot/concepts/auto-model-selection). +If you select **Auto**, {% data variables.copilot.copilot_auto_model_selection %} will select the best model based on availability and to help reduce rate limiting. For more information, see [AUTOTITLE](/copilot/concepts/models/auto-model-selection). diff --git a/content/copilot/concepts/agents/cloud-agent/about-automations.md b/content/copilot/concepts/agents/cloud-agent/about-automations.md index 1a05c095ab7a..72e59ac1209b 100644 --- a/content/copilot/concepts/agents/cloud-agent/about-automations.md +++ b/content/copilot/concepts/agents/cloud-agent/about-automations.md @@ -76,9 +76,9 @@ An {% data variables.copilot.copilot_automation %} can only take action in the s {% data variables.copilot.copilot_automations_cap %} use the {% data variables.copilot.copilot_cloud_agent %} configuration for the repository they are scoped to, including: -* **Custom instructions**. See [AUTOTITLE](/copilot/how-tos/configure-custom-instructions/add-repository-instructions). +* **Custom instructions**. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-repository-instructions). * **Agent skills**. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/add-skills). -* **Firewall rules**. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-firewall). +* **Firewall rules**. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/customize-the-agent-firewall). * **Secrets and variables**. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/configure-secrets-and-variables). {% data variables.copilot.copilot_automations_cap %} are stored separately from your repository's contents. They are not committed to Git, so they are not versioned alongside your code or managed through pull requests. diff --git a/content/copilot/concepts/agents/cloud-agent/about-cloud-agent.md b/content/copilot/concepts/agents/cloud-agent/about-cloud-agent.md index 0ef9e08e7fa8..f36da14b9faa 100644 --- a/content/copilot/concepts/agents/cloud-agent/about-cloud-agent.md +++ b/content/copilot/concepts/agents/cloud-agent/about-cloud-agent.md @@ -38,11 +38,11 @@ With {% data variables.copilot.copilot_cloud_agent %}, {% data variables.product When you delegate tasks to {% data variables.copilot.copilot_cloud_agent %}, you can: -* Use the agents panel or other agents entry points on {% data variables.product.prodname_dotcom_the_website %} to have {% data variables.product.prodname_copilot_short %} research, plan, and make code changes on a branch, then iterate before creating a pull request. You can also specify in your prompt that you want a pull request created right away. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/research-plan-iterate). +* Use the agents panel or other agents entry points on {% data variables.product.prodname_dotcom_the_website %} to have {% data variables.product.prodname_copilot_short %} research, plan, and make code changes on a branch, then iterate before creating a pull request. You can also specify in your prompt that you want a pull request created right away. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/use-copilot-agents/research-plan-iterate). * Ask {% data variables.product.prodname_copilot_short %} to open a new pull request from other entry points, including {% data variables.product.prodname_github_issues %} and {% data variables.product.prodname_vscode %}. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/start-copilot-sessions). -* Mention `@copilot` in a comment on an existing pull request to ask it to make changes. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/make-changes-to-an-existing-pr). +* Mention `@copilot` in a comment on an existing pull request to ask it to make changes. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/use-cloud-agent-on-github). * Set up an {% data variables.copilot.copilot_automation %} to run {% data variables.product.prodname_copilot_short %} automatically, on a schedule or in response to events such as an issue being opened. See [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-automations). -{% ifversion security-campaigns-assign-to-cca %}* Assign security alerts to {% data variables.product.prodname_copilot_short %} from security campaigns. See [AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/fixing-alerts-in-security-campaign#assigning-alerts-to-copilot-cloud-agent).{% endif %} +{% ifversion security-campaigns-assign-to-cca %}* Assign security alerts to {% data variables.product.prodname_copilot_short %} from security campaigns. See [AUTOTITLE](/code-security/how-tos/manage-security-alerts/remediate-alerts-at-scale/fixing-alerts-in-security-campaign#assigning-alerts-to-copilot-cloud-agent).{% endif %} {% data variables.copilot.copilot_cloud_agent %} will evaluate the task it has been assigned based on the prompt you give it. @@ -64,7 +64,7 @@ When you start a {% data variables.copilot.copilot_cloud_agent %} session from { ## {% data variables.copilot.copilot_cloud_agent %} versus agent mode -{% data variables.copilot.copilot_cloud_agent %} is distinct from the "agent mode" feature available in your IDE. {% data variables.copilot.copilot_cloud_agent %} works autonomously in a {% data variables.product.prodname_actions %}-powered environment to complete development tasks assigned through {% data variables.product.github %} issues or {% data variables.copilot.copilot_chat %} prompts. It can research a repository, create a plan, make code changes on a branch, and optionally open a pull request. In contrast, agent mode in your IDE makes autonomous edits directly in your local development environment. For more information about agent mode, see [AUTOTITLE](/copilot/using-github-copilot/copilot-chat/asking-github-copilot-questions-in-your-ide). +{% data variables.copilot.copilot_cloud_agent %} is distinct from the "agent mode" feature available in your IDE. {% data variables.copilot.copilot_cloud_agent %} works autonomously in a {% data variables.product.prodname_actions %}-powered environment to complete development tasks assigned through {% data variables.product.github %} issues or {% data variables.copilot.copilot_chat %} prompts. It can research a repository, create a plan, make code changes on a branch, and optionally open a pull request. In contrast, agent mode in your IDE makes autonomous edits directly in your local development environment. For more information about agent mode, see [AUTOTITLE](/copilot/how-tos/chat-with-copilot/chat-in-ide). ## Streamlining software development with {% data variables.copilot.copilot_cloud_agent %} @@ -74,7 +74,7 @@ For example, you can assign {% data variables.copilot.copilot_cloud_agent %} to Having {% data variables.copilot.copilot_cloud_agent %} as an additional coding resource also allows you to start tasks that you might not have otherwise started due to lack of resources. For example, you might create issues to refactor code or add more logging, and then immediately assign these to {% data variables.product.prodname_copilot_short %}. -You can also use {% data variables.copilot.copilot_cloud_agent %} to research a repository and create a plan before any code is written, helping you understand how a codebase works or agree on an approach before committing to changes. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/research-plan-iterate). +You can also use {% data variables.copilot.copilot_cloud_agent %} to research a repository and create a plan before any code is written, helping you understand how a codebase works or agree on an approach before committing to changes. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/use-copilot-agents/research-plan-iterate). {% data variables.copilot.copilot_cloud_agent %} can start a task, which you then pick up and continue working on yourself. By assigning the initial work to {% data variables.product.prodname_copilot_short %}, you free up time that you would otherwise have spent doing repetitive tasks, such as setting up the scaffolding for a new project. @@ -136,7 +136,7 @@ Within your included {% data variables.product.prodname_actions %} minutes and { You can customize {% data variables.copilot.copilot_cloud_agent %} in a number of ways: -* **Custom instructions**: Custom instructions allow you to give {% data variables.product.prodname_copilot_short %} additional context on your project and how to build, test and validate its changes. See [AUTOTITLE](/copilot/how-tos/configure-custom-instructions/add-repository-instructions). +* **Custom instructions**: Custom instructions allow you to give {% data variables.product.prodname_copilot_short %} additional context on your project and how to build, test and validate its changes. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-repository-instructions). * **Model Context Protocol (MCP) servers**: MCP servers allow you to give {% data variables.product.prodname_copilot_short %} access to different data sources and tools. Repository MCP settings on {% data variables.product.github %} apply to both {% data variables.copilot.copilot_cloud_agent %} and {% data variables.copilot.copilot_code-review_short %}. The {% data variables.product.github %} MCP server and Playwright MCP server are enabled by default for both features. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/configure-mcp-servers). * **{% data variables.copilot.custom_agents_caps_short %}**: {% data variables.copilot.custom_agents_caps_short %} allow you to create different specialized versions of {% data variables.product.prodname_copilot_short %} for different tasks. For example, you could customize {% data variables.product.prodname_copilot_short %} to be an expert frontend engineer following your team's guidelines. See [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-custom-agents). * **Hooks**: Hooks allow you to execute custom shell commands at key points during agent execution, enabling you to add validation, logging, security scanning, or workflow automation. See [AUTOTITLE](/copilot/concepts/agents/hooks). @@ -151,12 +151,12 @@ You can customize {% data variables.copilot.copilot_cloud_agent %} in a number o * **{% data variables.product.prodname_copilot_short %} can only make changes in the repository specified when you start a task**. {% data variables.product.prodname_copilot_short %} cannot make changes across multiple repositories in one run. * **By default, {% data variables.product.prodname_copilot_short %} can only access context in the repository specified when you start a task**. The {% data variables.product.prodname_copilot_short %} MCP server is configured by default to allow {% data variables.product.prodname_copilot_short %} to access context (for example issues and historic pull requests) in the repository where it is working. You can, however, configure broader access through repository MCP settings. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/configure-mcp-servers). * **{% data variables.product.prodname_copilot_short %} can only work on one branch at a time** and can open exactly one pull request to address each task it is assigned. -* **Each {% data variables.copilot.copilot_cloud_agent %} session has a maximum execution time of 59 minutes**. This is a hard limit that cannot be extended or bypassed. If a task exceeds this limit, the session will time out and stop. For complex tasks that may require more time, consider breaking the work into smaller, more focused tasks. You can configure a shorter timeout using the `timeout-minutes` setting in your `copilot-setup-steps.yml` file. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-environment). +* **Each {% data variables.copilot.copilot_cloud_agent %} session has a maximum execution time of 59 minutes**. This is a hard limit that cannot be extended or bypassed. If a task exceeds this limit, the session will time out and stop. For complex tasks that may require more time, consider breaking the work into smaller, more focused tasks. You can configure a shorter timeout using the `timeout-minutes` setting in your `copilot-setup-steps.yml` file. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/customize-the-agent-environment). ### Limitations in {% data variables.copilot.copilot_cloud_agent %}'s compatibility with other features * **{% data variables.product.prodname_copilot_short %} isn't able to comply with certain rules that may be configured for your repository**. If you have configured a ruleset or branch protection rule that isn't compatible with {% data variables.copilot.copilot_cloud_agent %}, access to the agent will be blocked. For example, a rule that only allows specific commit authors can prevent {% data variables.copilot.copilot_cloud_agent %} from creating or updating pull requests. If the rule is configured using rulesets, you can add {% data variables.product.prodname_copilot_short %} as a bypass actor to enable access. See [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/creating-rulesets-for-a-repository#granting-bypass-permissions-for-your-branch-or-tag-ruleset). -* **{% data variables.copilot.copilot_cloud_agent %} doesn't account for content exclusions**. Content exclusions allow administrators to configure {% data variables.product.prodname_copilot_short %} to ignore certain files. When using {% data variables.copilot.copilot_cloud_agent %}, {% data variables.product.prodname_copilot_short %} will not ignore these files, and will be able to see and update them. See [AUTOTITLE](/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot). +* **{% data variables.copilot.copilot_cloud_agent %} doesn't account for content exclusions**. Content exclusions allow administrators to configure {% data variables.product.prodname_copilot_short %} to ignore certain files. When using {% data variables.copilot.copilot_cloud_agent %}, {% data variables.product.prodname_copilot_short %} will not ignore these files, and will be able to see and update them. See [AUTOTITLE](/copilot/how-tos/configure-content-exclusion/exclude-content-from-copilot). * **{% data variables.copilot.copilot_cloud_agent %} only works with repositories hosted on {% data variables.product.github %}**. If your repository is stored using a different code hosting platform, {% data variables.product.prodname_copilot_short %} won't be able to work on it. ## Hands-on practice @@ -167,4 +167,4 @@ Try the [Expand your team with {% data variables.copilot.copilot_cloud_agent %}] * [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent) how-to articles * [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-custom-agents) -* [AUTOTITLE](/copilot/responsible-use/copilot-cloud-agent) +* [AUTOTITLE](/copilot/responsible-use/agents) diff --git a/content/copilot/concepts/agents/cloud-agent/about-custom-agents.md b/content/copilot/concepts/agents/cloud-agent/about-custom-agents.md index 5a2cf30f7b88..f05c5d257c63 100644 --- a/content/copilot/concepts/agents/cloud-agent/about-custom-agents.md +++ b/content/copilot/concepts/agents/cloud-agent/about-custom-agents.md @@ -33,6 +33,6 @@ For more information on using {% data variables.copilot.custom_agents_short %} i To create your own {% data variables.copilot.custom_agents_short %}, see: -* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-custom-agents) +* [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/create-custom-agents) * [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-copilot/create-custom-agents-for-cli) * [AUTOTITLE](/copilot/reference/customization-cheat-sheet) diff --git a/content/copilot/concepts/agents/cloud-agent/access-management.md b/content/copilot/concepts/agents/cloud-agent/access-management.md index 81d8c101a3a5..580134f36e0b 100644 --- a/content/copilot/concepts/agents/cloud-agent/access-management.md +++ b/content/copilot/concepts/agents/cloud-agent/access-management.md @@ -48,9 +48,9 @@ Enterprise administrators and organization owners (for organization-owned reposi For information on disabling {% data variables.copilot.copilot_cloud_agent %} in some or all repositories owned by an organization, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/add-copilot-cloud-agent). -For information on disabling {% data variables.copilot.copilot_cloud_agent %} in all repositories owned by an enterprise, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/block-copilot-cloud-agent). +For information on disabling {% data variables.copilot.copilot_cloud_agent %} in all repositories owned by an enterprise, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/block-agentic-features). -For information on disabling {% data variables.copilot.copilot_cloud_agent %} in repositories owned by your personal user account, see [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-copilot-plan/managing-copilot-policies-as-an-individual-subscriber#enabling-or-disabling-copilot-cloud-agent). +For information on disabling {% data variables.copilot.copilot_cloud_agent %} in repositories owned by your personal user account, see [AUTOTITLE](/copilot/how-tos/manage-your-account/manage-policies#enabling-or-disabling-copilot-cloud-agent). ## Managing access to {% data variables.copilot.copilot_automations_cap %} @@ -63,7 +63,7 @@ In addition to the {% data variables.copilot.copilot_cloud_agent %} policy, orga ## Further reading * [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent) -* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-environment) -* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-firewall) -* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/extend-cloud-agent-with-mcp) +* [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/customize-the-agent-environment) +* [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/customize-the-agent-firewall) +* [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/configure-mcp-servers) * [AUTOTITLE](/copilot/tutorials/cloud-agent/pilot-cloud-agent) diff --git a/content/copilot/concepts/agents/cloud-agent/agent-management.md b/content/copilot/concepts/agents/cloud-agent/agent-management.md index 89b2974659c4..ea08bdb554b3 100644 --- a/content/copilot/concepts/agents/cloud-agent/agent-management.md +++ b/content/copilot/concepts/agents/cloud-agent/agent-management.md @@ -42,10 +42,10 @@ From the Agents tab, you can: * **Steer agents mid-session**: If you realize you didn't scope a request correctly, or want the agent to use a specific tool or service, you can step in and provide **steering input** without stopping the run. Steering consumes {% data variables.product.prodname_ai_credits_short %} per message. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/use-copilot-agents/manage-and-track-agents#steer-an-agent-session). * **Open a session in {% data variables.product.prodname_vscode_shortname %} or {% data variables.copilot.copilot_cli %}**: When you want to start working on changes to an agent session in your local development environment, click **{% octicon "vscode" aria-label="VS Code" %} Open in {% data variables.product.prodname_vscode_shortname %}** or **{% octicon "agent" aria-label="Agent" %} Continue in {% data variables.copilot.copilot_cli %}** to bring the session to your local machine. {% data reusables.copilot.cloud-agent.use-latest-vscode %} -* **Review and merge agent code**: Once the agent completes a session, you can jump to the pull request to review the changes, request further improvements, or approve and merge. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/review-copilot-prs). +* **Review and merge agent code**: Once the agent completes a session, you can jump to the pull request to review the changes, request further improvements, or approve and merge. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/use-copilot-agents/review-copilot-output). * **Set up {% data variables.copilot.copilot_automations %}**: Run {% data variables.copilot.copilot_cloud_agent %} automatically, on a schedule or in response to events such as an issue being opened. See [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-automations). * **Query your past sessions**: You can search and reference your past agent sessions using natural language from {% data variables.copilot.copilot_cli_short %} or {% data variables.product.prodname_vscode_shortname %}. See [AUTOTITLE](/copilot/concepts/agents/copilot-cli/chronicle). ## Next steps -To start managing agents, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/manage-agents). +To start managing agents, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/use-copilot-agents/manage-and-track-agents). diff --git a/content/copilot/concepts/agents/cloud-agent/mcp-and-cloud-agent.md b/content/copilot/concepts/agents/cloud-agent/mcp-and-cloud-agent.md index 20e3902ed9fa..bd51a3b819cf 100644 --- a/content/copilot/concepts/agents/cloud-agent/mcp-and-cloud-agent.md +++ b/content/copilot/concepts/agents/cloud-agent/mcp-and-cloud-agent.md @@ -27,8 +27,8 @@ For more information on MCP, see [the official MCP documentation](https://modelc The following MCP servers are configured automatically for {% data variables.copilot.copilot_cloud_agent %}: -* **{% data variables.product.github %}**: The {% data variables.product.github %} MCP server gives {% data variables.product.prodname_copilot_short %} access to {% data variables.product.github %} data like issues and pull requests. To learn more, see [AUTOTITLE](/copilot/customizing-copilot/using-model-context-protocol/using-the-github-mcp-server). - * By default, the {% data variables.product.github %} MCP server connects to {% data variables.product.github %} using a specially scoped token that only has read-only access to the current repository. You can customize it to use a different token with broader access. For more details, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/extend-cloud-agent-with-mcp#customizing-the-built-in-github-mcp-server). +* **{% data variables.product.github %}**: The {% data variables.product.github %} MCP server gives {% data variables.product.prodname_copilot_short %} access to {% data variables.product.github %} data like issues and pull requests. To learn more, see [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp-in-your-ide/use-the-github-mcp-server). + * By default, the {% data variables.product.github %} MCP server connects to {% data variables.product.github %} using a specially scoped token that only has read-only access to the current repository. You can customize it to use a different token with broader access. For more details, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/configure-mcp-servers#customizing-the-built-in-github-mcp-server). * **Playwright**: The [Playwright MCP server](https://github.com/microsoft/playwright-mcp) gives {% data variables.product.prodname_copilot_short %} access to web pages, including the ability to read, interact and take screenshots. * By default, the Playwright MCP server is only able to access web resources hosted within {% data variables.product.prodname_copilot_short %}'s own environment, accessible on `localhost` or `127.0.0.1`. diff --git a/content/copilot/concepts/agents/cloud-agent/risks-and-mitigations.md b/content/copilot/concepts/agents/cloud-agent/risks-and-mitigations.md index 7b846a448ce7..1a84332bb511 100644 --- a/content/copilot/concepts/agents/cloud-agent/risks-and-mitigations.md +++ b/content/copilot/concepts/agents/cloud-agent/risks-and-mitigations.md @@ -36,14 +36,14 @@ To mitigate this risk, {% data variables.product.github %}: * **Limits the branch the agent can push to.** {% data variables.copilot.copilot_cloud_agent %} only has the ability to push to a single branch. When the agent is triggered by mentioning `@copilot` on an existing pull request, {% data variables.product.prodname_copilot_short %} has write access to the pull request's branch. In other cases, a new `copilot/` branch is created for {% data variables.product.prodname_copilot_short %}, and the agent can only push to that branch. The agent is also subject to any branch protections and required checks for the working repository. * **Limits the agent's credentials.** {% data variables.copilot.copilot_cloud_agent %} can only perform simple push operations. It cannot directly run `git push` or other Git commands. * **Requires human review before merging.** Draft pull requests created by {% data variables.copilot.copilot_cloud_agent %} must be reviewed and merged by a human. {% data variables.copilot.copilot_cloud_agent %} cannot mark its pull requests as "Ready for review" and cannot approve or merge a pull request. -* **Restricts {% data variables.product.prodname_actions %} workflow runs.** By default, workflows are not triggered until {% data variables.copilot.copilot_cloud_agent %}'s code is reviewed and a user with write access to the repository clicks the **Approve and run workflows** button. Optionally, you can configure {% data variables.product.prodname_copilot_short %} to allow workflows to run automatically. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/review-copilot-prs#managing-github-actions-workflow-runs). +* **Restricts {% data variables.product.prodname_actions %} workflow runs.** By default, workflows are not triggered until {% data variables.copilot.copilot_cloud_agent %}'s code is reviewed and a user with write access to the repository clicks the **Approve and run workflows** button. Optionally, you can configure {% data variables.product.prodname_copilot_short %} to allow workflows to run automatically. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/use-copilot-agents/review-copilot-output#managing-github-actions-workflow-runs). * **Prevents the user who asked {% data variables.copilot.copilot_cloud_agent %} to create a pull request from approving it.** This maintains the expected controls in the "Required approvals" rule and branch protection. See [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets). ## {% data variables.copilot.copilot_cloud_agent %} has access to sensitive information {% data variables.copilot.copilot_cloud_agent %} has access to code and other sensitive information, and could leak it, either accidentally or due to malicious user input. -To mitigate this risk, {% data variables.product.github %} **restricts {% data variables.copilot.copilot_cloud_agent %}'s access to the internet**. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-firewall). +To mitigate this risk, {% data variables.product.github %} **restricts {% data variables.copilot.copilot_cloud_agent %}'s access to the internet**. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/customize-the-agent-firewall). ## AI prompts can be vulnerable to injection diff --git a/content/copilot/concepts/agents/code-review.md b/content/copilot/concepts/agents/code-review.md index 975e443fa24f..2cc3063f8849 100644 --- a/content/copilot/concepts/agents/code-review.md +++ b/content/copilot/concepts/agents/code-review.md @@ -20,7 +20,7 @@ category: {% data variables.copilot.copilot_code-review_short %} reviews code written in any language, and provides feedback. It reviews your code from multiple angles to identify issues and suggest fixes. You can apply suggested changes with a couple of clicks. -This article provides an overview of {% data variables.copilot.copilot_code-review_short %}. To learn how to request a code review from {% data variables.product.prodname_copilot_short %}, see [AUTOTITLE](/copilot/how-tos/agents/copilot-code-review/using-copilot-code-review). +This article provides an overview of {% data variables.copilot.copilot_code-review_short %}. To learn how to request a code review from {% data variables.product.prodname_copilot_short %}, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/request-a-code-review/use-code-review). ## Availability @@ -36,7 +36,7 @@ This article provides an overview of {% data variables.copilot.copilot_code-revi * Azure DevOps ({% data variables.release-phases.public_preview %}) > [!NOTE] -> If you receive {% data variables.product.prodname_copilot_short %} from an organization, your organization must enable the **{% data variables.copilot.copilot_code-review_short %}** option in the {% data variables.product.prodname_copilot_short %} policy settings. This applies to reviews on {% data variables.product.prodname_dotcom_the_website %} or in {% data variables.product.prodname_mobile %}. See [AUTOTITLE](/copilot/how-tos/administer/organizations/managing-policies-for-copilot-in-your-organization). +> If you receive {% data variables.product.prodname_copilot_short %} from an organization, your organization must enable the **{% data variables.copilot.copilot_code-review_short %}** option in the {% data variables.product.prodname_copilot_short %} policy settings. This applies to reviews on {% data variables.product.prodname_dotcom_the_website %} or in {% data variables.product.prodname_mobile %}. See [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/manage-policies). ## {% data variables.copilot.copilot_code-review_short %} without a {% data variables.product.prodname_copilot_short %} license @@ -59,7 +59,7 @@ The second policy has these characteristics: When both policies are enabled, users without a {% data variables.product.prodname_copilot_short %} license can request a review from {% data variables.copilot.copilot_code-review_short %} on their pull requests in the organization's repositories. -In repositories where automatic code review is enabled, {% data variables.product.prodname_copilot_short %} automatically reviews all pull requests. This happens regardless of whether the author has a {% data variables.product.prodname_copilot_short %} license. For more information about how to configure automatic code review, see [AUTOTITLE](/copilot/how-tos/agents/copilot-code-review/configuring-automatic-code-review-by-copilot). +In repositories where automatic code review is enabled, {% data variables.product.prodname_copilot_short %} automatically reviews all pull requests. This happens regardless of whether the author has a {% data variables.product.prodname_copilot_short %} license. For more information about how to configure automatic code review, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/set-up-copilot/configure-automatic-review). {% data variables.copilot.copilot_code-review_short %} for users without a license is not available in IDEs. @@ -176,7 +176,7 @@ You can configure MCP servers in your repository settings. Repository MCP config {% data variables.product.prodname_copilot_short %} is not guaranteed to spot all problems or issues in a pull request. Sometimes it will make mistakes. Always validate {% data variables.product.prodname_copilot_short %}'s feedback carefully. Supplement {% data variables.product.prodname_copilot_short %}'s feedback with a human review. -For more information, see [AUTOTITLE](/copilot/responsible-use-of-github-copilot-features/responsible-use-of-github-copilot-code-review). +For more information, see [AUTOTITLE](/copilot/responsible-use/agents). ## Enhancing {% data variables.product.prodname_copilot_short %}'s knowledge of a repository @@ -210,15 +210,15 @@ The triggers for automatic code review depend on the configuration settings. * Review draft pull requests: * Pull requests are automatically reviewed while they are still drafts, before you switch them to "Open". -For full instructions, see [AUTOTITLE](/copilot/how-tos/agents/copilot-code-review/configuring-automatic-code-review-by-copilot). +For full instructions, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/set-up-copilot/configure-automatic-review). > [!NOTE] > Unless {% data variables.product.prodname_copilot_short %} has been configured to review each push to a pull request, it will only review a pull request once. If you make changes to the pull request after it has been automatically reviewed and you want {% data variables.product.prodname_copilot_short %} to re-review it, you can request this manually. Click the {% octicon "sync" aria-label="Re-request review" %} button next to {% data variables.product.prodname_copilot_short %}'s name in the **Reviewers** menu. ## Getting detailed code quality feedback for your whole repository -{% data variables.copilot.copilot_code-review %} reviews your code in pull requests and provides feedback. If you want actionable feedback on the reliability and maintainability of your whole repository, enable {% data variables.product.prodname_code_quality %}. See [AUTOTITLE](/code-security/code-quality/concepts/about-code-quality). +{% data variables.copilot.copilot_code-review %} reviews your code in pull requests and provides feedback. If you want actionable feedback on the reliability and maintainability of your whole repository, enable {% data variables.product.prodname_code_quality %}. See [AUTOTITLE](/code-security/concepts/about-code-quality). ## Further reading -* [AUTOTITLE](/copilot/how-tos/agents/copilot-code-review/using-copilot-code-review) +* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/request-a-code-review/use-code-review) diff --git a/content/copilot/concepts/agents/copilot-cli/about-cli-extensions.md b/content/copilot/concepts/agents/copilot-cli/about-cli-extensions.md index c14b48911591..8b8899350785 100644 --- a/content/copilot/concepts/agents/copilot-cli/about-cli-extensions.md +++ b/content/copilot/concepts/agents/copilot-cli/about-cli-extensions.md @@ -90,7 +90,7 @@ Both extensions and plugins add functionality to {% data variables.copilot.copil * An **extension** is a single JavaScript module that you write to add tools and slash commands, backed by code that runs in your session. * A **plugin** is an installable package that bundles reusable components—such as agents, skills, hooks, and integrations—and can be distributed through a marketplace. -For more information about plugins, see [AUTOTITLE](/copilot/concepts/agents/copilot-cli/about-cli-plugins). +For more information about plugins, see [AUTOTITLE](/copilot/concepts/agents/about-plugins). ## Further reading diff --git a/content/copilot/concepts/agents/copilot-cli/about-copilot-cli.md b/content/copilot/concepts/agents/copilot-cli/about-copilot-cli.md index 53e80d69dd26..aec4b09e2426 100644 --- a/content/copilot/concepts/agents/copilot-cli/about-copilot-cli.md +++ b/content/copilot/concepts/agents/copilot-cli/about-copilot-cli.md @@ -28,7 +28,7 @@ The command-line interface (CLI) for {% data variables.product.prodname_copilot * macOS * Windows from within Powershell and [Windows Subsystem for Linux (WSL)](https://learn.microsoft.com/en-us/windows/wsl/about) -For installation instructions, see [AUTOTITLE](/copilot/how-tos/set-up/install-copilot-cli). +For installation instructions, see [AUTOTITLE](/copilot/how-tos/copilot-cli/set-up-copilot-cli/install-copilot-cli). ## Modes of use @@ -192,8 +192,8 @@ You can interact with {% data variables.product.prodname_copilot_short %} while You can customize {% data variables.copilot.copilot_cli %} in a number of ways: * **Custom instructions**: Custom instructions allow you to give {% data variables.product.prodname_copilot_short %} additional context on your project and how to build, test and validate its changes. All custom instruction files now combine instead of using priority-based fallbacks. For more information, see [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-copilot/add-custom-instructions). -* **Model Context Protocol (MCP) servers**: MCP servers allow you to give {% data variables.product.prodname_copilot_short %} access to different data sources and tools. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/use-copilot-cli#add-an-mcp-server). -* **{% data variables.copilot.custom_agents_caps_short %}**: {% data variables.copilot.custom_agents_caps_short %} allow you to create different specialized versions of {% data variables.product.prodname_copilot_short %} for different tasks. For example, you could customize {% data variables.product.prodname_copilot_short %} to be an expert frontend engineer following your team's guidelines. {% data variables.copilot.copilot_cli %} includes specialized {% data variables.copilot.custom_agents_short %} that it automatically delegates common tasks to. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/use-copilot-cli#use-custom-agents). +* **Model Context Protocol (MCP) servers**: MCP servers allow you to give {% data variables.product.prodname_copilot_short %} access to different data sources and tools. For more information, see [AUTOTITLE](/copilot/how-tos/copilot-cli/use-copilot-cli/overview#add-an-mcp-server). +* **{% data variables.copilot.custom_agents_caps_short %}**: {% data variables.copilot.custom_agents_caps_short %} allow you to create different specialized versions of {% data variables.product.prodname_copilot_short %} for different tasks. For example, you could customize {% data variables.product.prodname_copilot_short %} to be an expert frontend engineer following your team's guidelines. {% data variables.copilot.copilot_cli %} includes specialized {% data variables.copilot.custom_agents_short %} that it automatically delegates common tasks to. For more information, see [AUTOTITLE](/copilot/how-tos/copilot-cli/use-copilot-cli/overview#use-custom-agents). * **Hooks**: Hooks allow you to execute custom shell commands at key points during agent execution, enabling you to add validation, logging, security scanning, or workflow automation. See [AUTOTITLE](/copilot/concepts/agents/hooks). * **Skills**: Skills allow you to enhance the ability of {% data variables.product.prodname_copilot_short %} to perform specialized tasks with instructions, scripts, and resources. For more information, see [AUTOTITLE](/copilot/concepts/agents/about-agent-skills). * **{% data variables.copilot.copilot_memory %}**: {% data variables.copilot.copilot_memory %} allows {% data variables.product.prodname_copilot_short %} to build a persistent understanding of your repository by storing "memories", which are pieces of information about coding conventions, patterns, and preferences that {% data variables.product.prodname_copilot_short %} deduces as it works. This reduces the need to repeatedly explain context in your prompts and makes future sessions more productive. For more information, see [AUTOTITLE](/copilot/concepts/agents/copilot-memory). @@ -364,6 +364,6 @@ For more information, see [AUTOTITLE](/copilot/reference/copilot-cli-reference/a ## Further reading -* [AUTOTITLE](/copilot/how-tos/set-up/install-copilot-cli) -* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/use-copilot-cli) -* [AUTOTITLE](/enterprise-cloud@latest/copilot/responsible-use/copilot-cli) +* [AUTOTITLE](/copilot/how-tos/copilot-cli/set-up-copilot-cli/install-copilot-cli) +* [AUTOTITLE](/copilot/how-tos/copilot-cli/use-copilot-cli/overview) +* [AUTOTITLE](/enterprise-cloud@latest/copilot/responsible-use/agents) diff --git a/content/copilot/concepts/agents/copilot-cli/comparing-cli-features.md b/content/copilot/concepts/agents/copilot-cli/comparing-cli-features.md index c3bcc0f5df07..94f46af20e71 100644 --- a/content/copilot/concepts/agents/copilot-cli/comparing-cli-features.md +++ b/content/copilot/concepts/agents/copilot-cli/comparing-cli-features.md @@ -93,7 +93,7 @@ Avoid or keep them minimal when: ### Find out more about custom instructions -See [AUTOTITLE](/copilot/how-tos/copilot-cli/add-custom-instructions). +See [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-copilot/add-custom-instructions). ## Skills @@ -170,7 +170,7 @@ You’ll see {% data variables.product.prodname_copilot_short %} using tools whe ### Find out more about allowing or denying tools -See [AUTOTITLE](/copilot/concepts/agents/about-copilot-cli#allowed-tools). +See [AUTOTITLE](/copilot/concepts/agents/copilot-cli/about-copilot-cli#allowed-tools). ## MCP servers @@ -270,7 +270,7 @@ Avoid hooks when: ### Find out more about hooks See: -* [AUTOTITLE](/copilot/how-tos/copilot-cli/use-hooks) +* [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-copilot/use-hooks) * [AUTOTITLE](/copilot/reference/hooks-reference) ## Subagents diff --git a/content/copilot/concepts/agents/copilot-cli/context-management.md b/content/copilot/concepts/agents/copilot-cli/context-management.md index f72fc19d375c..15bd23eace6e 100644 --- a/content/copilot/concepts/agents/copilot-cli/context-management.md +++ b/content/copilot/concepts/agents/copilot-cli/context-management.md @@ -144,5 +144,5 @@ Starting a new session is better when: ## Further reading * [AUTOTITLE](/copilot/how-tos/copilot-cli) -* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/use-copilot-cli) +* [AUTOTITLE](/copilot/how-tos/copilot-cli/use-copilot-cli/overview) * [AUTOTITLE](/copilot/reference/copilot-cli-reference/cli-command-reference) diff --git a/content/copilot/concepts/agents/copilot-cli/fleet.md b/content/copilot/concepts/agents/copilot-cli/fleet.md index 665dea0cc8a9..95a5d0eb54b6 100644 --- a/content/copilot/concepts/agents/copilot-cli/fleet.md +++ b/content/copilot/concepts/agents/copilot-cli/fleet.md @@ -70,4 +70,4 @@ For more information about autopilot mode, see [AUTOTITLE](/copilot/concepts/age * [AUTOTITLE](/copilot/how-tos/copilot-cli/use-copilot-cli/speed-up-task-completion) * [AUTOTITLE](/copilot/how-tos/copilot-cli) -* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/use-copilot-cli) +* [AUTOTITLE](/copilot/how-tos/copilot-cli/use-copilot-cli/overview) diff --git a/content/copilot/concepts/agents/copilot-cli/lsp-servers.md b/content/copilot/concepts/agents/copilot-cli/lsp-servers.md index d0be281d6f20..3628b4247964 100644 --- a/content/copilot/concepts/agents/copilot-cli/lsp-servers.md +++ b/content/copilot/concepts/agents/copilot-cli/lsp-servers.md @@ -71,4 +71,4 @@ Once the working directory is trusted, {% data variables.copilot.copilot_cli_sho ## Further reading * [Language Server Protocol](https://microsoft.github.io/language-server-protocol/) on the Microsoft website -* [AUTOTITLE](/copilot/reference/cli-command-reference) +* [AUTOTITLE](/copilot/reference/copilot-cli-reference/cli-command-reference) diff --git a/content/copilot/concepts/agents/copilot-cli/research.md b/content/copilot/concepts/agents/copilot-cli/research.md index ad4eee30ebaf..ed02f18a7d4a 100644 --- a/content/copilot/concepts/agents/copilot-cli/research.md +++ b/content/copilot/concepts/agents/copilot-cli/research.md @@ -155,4 +155,4 @@ To share the report you can either save it to a file or create a {% data variabl ## Further reading * [AUTOTITLE](/copilot/how-tos/copilot-cli) -* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/use-copilot-cli) +* [AUTOTITLE](/copilot/how-tos/copilot-cli/use-copilot-cli/overview) diff --git a/content/copilot/concepts/agents/enterprise-management.md b/content/copilot/concepts/agents/enterprise-management.md index f863018070e0..26a2c4619a01 100644 --- a/content/copilot/concepts/agents/enterprise-management.md +++ b/content/copilot/concepts/agents/enterprise-management.md @@ -46,7 +46,7 @@ Enterprise administrators can use AI Controls to view active and recent agent se For long-term retention and analysis, you can stream enterprise audit log data to supported destinations. For more information, see [AUTOTITLE](/enterprise-cloud@latest/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise) and [AUTOTITLE](/copilot/reference/agentic-audit-log-events). -For billing information on agent sessions, see [AUTOTITLE](/billing/concepts/product-billing/github-copilot-premium-requests#usage-by-copilot-cloud-agent). +For billing information on agent sessions, see [AUTOTITLE](/copilot/reference/copilot-billing/request-based-billing-legacy/github-copilot-premium-requests#usage-by-copilot-cloud-agent). ## Third-party agents diff --git a/content/copilot/concepts/agents/github-copilot-app.md b/content/copilot/concepts/agents/github-copilot-app.md index d19a8fd7a83f..0259388d2469 100644 --- a/content/copilot/concepts/agents/github-copilot-app.md +++ b/content/copilot/concepts/agents/github-copilot-app.md @@ -82,7 +82,7 @@ To share feedback, click the **Give feedback** icon in the bottom-left corner of ## Public code -{% data variables.copilot.github_copilot_app %} may generate code that is a match or near match of publicly available code, even if the "Suggestions matching public code" policy is set to "Block." See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-copilot-plan/managing-copilot-policies-as-an-individual-subscriber#enabling-or-disabling-suggestions-matching-public-code). +{% data variables.copilot.github_copilot_app %} may generate code that is a match or near match of publicly available code, even if the "Suggestions matching public code" policy is set to "Block." See [AUTOTITLE](/copilot/how-tos/manage-your-account/manage-policies#enabling-or-disabling-suggestions-matching-public-code). ## Further reading diff --git a/content/copilot/concepts/agents/hooks.md b/content/copilot/concepts/agents/hooks.md index b993ec38ac93..9597e031f628 100644 --- a/content/copilot/concepts/agents/hooks.md +++ b/content/copilot/concepts/agents/hooks.md @@ -164,5 +164,5 @@ To ensure security is maintained when using hooks, keep the following considerat ## Next steps To start creating hooks, see: -* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/use-hooks) for {% data variables.copilot.copilot_cloud_agent %} +* [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/use-hooks) for {% data variables.copilot.copilot_cloud_agent %} * [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-copilot/use-hooks) for {% data variables.copilot.copilot_cli %} diff --git a/content/copilot/concepts/agents/openai-codex.md b/content/copilot/concepts/agents/openai-codex.md index 997c0e491a4b..04d466d5091a 100644 --- a/content/copilot/concepts/agents/openai-codex.md +++ b/content/copilot/concepts/agents/openai-codex.md @@ -30,13 +30,13 @@ When starting a task with the {% data variables.product.prodname_openai_codex %} * Auto {% data reusables.copilot.openai-codex-agent-models %} -If you select **Auto**, {% data variables.copilot.copilot_auto_model_selection %} will select the best model based on availability and to help reduce rate limiting. For more information, see [AUTOTITLE](/copilot/concepts/auto-model-selection). +If you select **Auto**, {% data variables.copilot.copilot_auto_model_selection %} will select the best model based on availability and to help reduce rate limiting. For more information, see [AUTOTITLE](/copilot/concepts/models/auto-model-selection). ## {% data variables.product.prodname_vscode_shortname %} extension > [!NOTE] The "Sign in with {% data variables.product.prodname_copilot_short %}" option in the {% data variables.product.prodname_openai_codex %} {% data variables.product.prodname_vscode_shortname %} extension is only available to {% data variables.copilot.copilot_pro_plus %} and {% data variables.copilot.copilot_max_short %} subscribers. -Use "Sign in with {% data variables.product.prodname_copilot_short %}" when launching the extension. {% data variables.copilot.copilot_pro_plus_short %} and {% data variables.copilot.copilot_max_short %} users can see this integration in the [Agent Sessions view](https://code.visualstudio.com/docs/copilot/chat/chat-sessions#_agent-sessions-view) in {% data variables.product.prodname_vscode_shortname %} Insiders along with progress on their running tasks. All usage is subject to {% data variables.product.github %} rate limits and billing. See [AUTOTITLE](/copilot/concepts/billing/copilot-requests#premium-features). +Use "Sign in with {% data variables.product.prodname_copilot_short %}" when launching the extension. {% data variables.copilot.copilot_pro_plus_short %} and {% data variables.copilot.copilot_max_short %} users can see this integration in the [Agent Sessions view](https://code.visualstudio.com/docs/copilot/chat/chat-sessions#_agent-sessions-view) in {% data variables.product.prodname_vscode_shortname %} Insiders along with progress on their running tasks. All usage is subject to {% data variables.product.github %} rate limits and billing. See [AUTOTITLE](/copilot/reference/copilot-billing/request-based-billing-legacy/copilot-requests#premium-features). ### Model availability diff --git a/content/copilot/concepts/billing/individual-plans.md b/content/copilot/concepts/billing/individual-plans.md index 152c33a19def..ea8fdc1a20e5 100644 --- a/content/copilot/concepts/billing/individual-plans.md +++ b/content/copilot/concepts/billing/individual-plans.md @@ -96,7 +96,7 @@ The following table shows what's included with each paid plan. For more information on how {% data variables.product.prodname_ai_credits %} work, see [AUTOTITLE](/copilot/concepts/billing/usage-based-billing-for-individuals) and [AUTOTITLE](/copilot/concepts/billing/usage-based-billing-for-organizations-and-enterprises). -For a detailed comparison of features and benefits, see [AUTOTITLE](/copilot/about-github-copilot/subscription-plans-for-github-copilot). +For a detailed comparison of features and benefits, see [AUTOTITLE](/copilot/get-started/plans). ## Choosing the right plan @@ -108,7 +108,7 @@ Consider the following to decide which plan is right for you: * **Want the best performance and premium model access?** [Go with {% data variables.copilot.copilot_pro_plus %}](https://github.com/github-copilot/signup?ref_product=copilot&ref_type=purchase&ref_style=text&ref_plan=pro-plus) to unlock everything {% data variables.product.prodname_copilot_short %} has to offer. * **Doing sustained high-volume {% data variables.product.prodname_copilot_short %} development?** [Subscribe to {% data variables.copilot.copilot_max %}](https://github.com/github-copilot/signup?ref_product=copilot&ref_type=purchase&ref_style=text&ref_plan=max), which offers the highest monthly allowance of {% data variables.product.prodname_ai_credits_short %} for individual plans. -To learn how to set up the plan that’s right for you, see [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/getting-started-with-copilot-on-your-personal-account/getting-started-with-a-copilot-plan). +To learn how to set up the plan that’s right for you, see [AUTOTITLE](/copilot/how-tos/manage-your-account/get-started-with-a-copilot-plan). ### Limitations for enterprises diff --git a/content/copilot/concepts/billing/organizations-and-enterprises.md b/content/copilot/concepts/billing/organizations-and-enterprises.md index 5d32625b4bfa..11a8fca64592 100644 --- a/content/copilot/concepts/billing/organizations-and-enterprises.md +++ b/content/copilot/concepts/billing/organizations-and-enterprises.md @@ -37,7 +37,7 @@ category: With {% data variables.product.prodname_ghe_cloud %}: -* An enterprise owner chooses the plan for each organization in the enterprise. For guidance on choosing a plan, see [AUTOTITLE](/copilot/rolling-out-github-copilot-at-scale/choosing-your-enterprises-plan-for-github-copilot). +* An enterprise owner chooses the plan for each organization in the enterprise. For guidance on choosing a plan, see [AUTOTITLE](/copilot/tutorials/roll-out-at-scale/assign-licenses/choose-enterprise-plan). * Data-resident and FedRAMP-compliant {% data variables.product.prodname_copilot_short %} requests include a 10% model multiplier increase. See [AUTOTITLE](/admin/data-residency/github-copilot-with-data-residency#pricing-for-data-resident-copilot). @@ -51,9 +51,9 @@ For a full explanation of how {% data variables.product.prodname_ai_credits_shor A {% data variables.product.prodname_copilot_short %} seat is a license to use {% data variables.product.prodname_copilot %} for a user. Each month, your organization or enterprise is billed for the number of assigned seats. -Seat assignment is managed by organization owners. With {% data variables.product.prodname_ghe_cloud %}, an enterprise owner must have enabled {% data variables.product.prodname_copilot %} for the organization before an organization owner can assign 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). +Seat assignment is managed by organization owners. With {% data variables.product.prodname_ghe_cloud %}, an enterprise owner must have enabled {% data variables.product.prodname_copilot %} for the organization before an organization owner can assign seats. See [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/manage-access/grant-access). -If a user receives a seat from multiple organizations in the same enterprise, the enterprise will be billed only once, and one organization is selected and billed for the seat. To determine which organization is billed for a given user, request a detailed usage report and refer to the `organization` column for the user's {% data variables.product.prodname_copilot_short %} license. See [AUTOTITLE](/billing/reference/usage-reports). +If a user receives a seat from multiple organizations in the same enterprise, the enterprise will be billed only once, and one organization is selected and billed for the seat. To determine which organization is billed for a given user, request a detailed usage report and refer to the `organization` column for the user's {% data variables.product.prodname_copilot_short %} license. See [AUTOTITLE](/billing/reference/billing-reports). ## Billing cycles diff --git a/content/copilot/concepts/billing/usage-based-billing-for-individuals.md b/content/copilot/concepts/billing/usage-based-billing-for-individuals.md index 22f04a0fbcb1..43f333c48b5e 100644 --- a/content/copilot/concepts/billing/usage-based-billing-for-individuals.md +++ b/content/copilot/concepts/billing/usage-based-billing-for-individuals.md @@ -99,7 +99,7 @@ To set up a budget for {% data variables.product.prodname_ai_credits %}, see [AU {% data reusables.copilot.copilot-one-account %} -You can cancel your {% data variables.product.prodname_copilot_short %} plan at any time. The cancellation will take effect at the end of your current billing cycle. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-copilot-subscription/canceling-copilot-as-an-individual-user). +You can cancel your {% data variables.product.prodname_copilot_short %} plan at any time. The cancellation will take effect at the end of your current billing cycle. See [AUTOTITLE](/copilot/how-tos/manage-your-account/view-and-change-your-copilot-plan). ## Determining your billing date @@ -134,6 +134,6 @@ We recommend keeping your IDE, client, and {% data variables.product.prodname_co ## Further reading -* [AUTOTITLE](/copilot/about-github-copilot/subscription-plans-for-github-copilot) -* [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-copilot-subscription) -* [AUTOTITLE](/billing/managing-your-billing/managing-your-payment-and-billing-information) +* [AUTOTITLE](/copilot/get-started/plans) +* [AUTOTITLE](/copilot/how-tos/manage-your-account) +* [AUTOTITLE](/billing/how-tos/set-up-payment/manage-payment-info) diff --git a/content/copilot/concepts/chat.md b/content/copilot/concepts/chat.md index 91d4a05a3daf..0031cbe214fe 100644 --- a/content/copilot/concepts/chat.md +++ b/content/copilot/concepts/chat.md @@ -24,7 +24,7 @@ category: * {% data variables.product.prodname_mobile %} * {% data variables.copilot.copilot_cli %} -Different environments may have different features and capabilities, but the core functionality remains consistent across platforms. To explore the functionality available in each environment, see the [AUTOTITLE](/copilot/how-tos/chat) how-to guides and the [AUTOTITLE](/copilot/tutorials). +Different environments may have different features and capabilities, but the core functionality remains consistent across platforms. To explore the functionality available in each environment, see the [AUTOTITLE](/copilot/how-tos/chat-with-copilot) how-to guides and the [AUTOTITLE](/copilot/tutorials). ## Limitations @@ -48,7 +48,7 @@ There are various ways you can create custom instructions for {% data variables. * **Repository instructions**: You can store instructions files in a repository, so that all prompts asked in the context of the repository automatically include the instructions you've defined. * **Organization instructions**: If you are an organization owner, you can create a custom instructions file for an organization, so that all prompts asked in the context of any repository owned by the organization automatically include the instructions you've defined. -For more information, see [AUTOTITLE](/copilot/customizing-copilot/adding-personal-custom-instructions-for-github-copilot), [AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot) and [AUTOTITLE](/copilot/customizing-copilot/adding-organization-custom-instructions-for-github-copilot). +For more information, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-personal-instructions), [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-repository-instructions) and [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-organization-instructions). ## AI models for {% data variables.copilot.copilot_chat_short %} @@ -62,10 +62,10 @@ For more information, see [AUTOTITLE](/copilot/customizing-copilot/adding-person MCP is an open standard that defines how applications share context with large language models (LLMs). MCP provides a standardized way to connect AI models to different data sources and tools, enabling them to work together more effectively. -You can configure MCP servers to provide context to {% data variables.copilot.copilot_chat_short %} in various IDEs, such as {% data variables.product.prodname_vscode %} and JetBrains IDEs. For {% data variables.copilot.copilot_chat_dotcom_short %}, the {% data variables.product.github %} MCP server is automatically configured, enabling {% data variables.copilot.copilot_chat_short %} to perform a limited set of tasks, at your request, such as creating branches or merging pull requests. For more information, see [AUTOTITLE](/copilot/how-tos/context/model-context-protocol/extending-copilot-chat-with-mcp) and [AUTOTITLE](/copilot/how-tos/context/model-context-protocol/using-the-github-mcp-server). +You can configure MCP servers to provide context to {% data variables.copilot.copilot_chat_short %} in various IDEs, such as {% data variables.product.prodname_vscode %} and JetBrains IDEs. For {% data variables.copilot.copilot_chat_dotcom_short %}, the {% data variables.product.github %} MCP server is automatically configured, enabling {% data variables.copilot.copilot_chat_short %} to perform a limited set of tasks, at your request, such as creating branches or merging pull requests. For more information, see [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp-in-your-ide/extend-copilot-chat-with-mcp) and [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp-in-your-ide/use-the-github-mcp-server). ### Further reading * [AUTOTITLE](/copilot/how-tos/chat-with-copilot) how-to guides -* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/use-copilot-cli) -* [AUTOTITLE](/copilot/tutorials/copilot-chat-cookbook) +* [AUTOTITLE](/copilot/how-tos/copilot-cli/use-copilot-cli/overview) +* [AUTOTITLE](/copilot/tutorials/copilot-cookbook) diff --git a/content/copilot/concepts/completions/code-referencing.md b/content/copilot/concepts/completions/code-referencing.md index 9dee89705dd2..02f89ab5a57d 100644 --- a/content/copilot/concepts/completions/code-referencing.md +++ b/content/copilot/concepts/completions/code-referencing.md @@ -90,6 +90,6 @@ References to matching code are currently available in JetBrains IDEs, {% data v ## Further reading -* [AUTOTITLE](/copilot/how-tos/completions/finding-public-code-that-matches-github-copilot-suggestions) -* [AUTOTITLE](/copilot/how-tos/manage-your-account/managing-copilot-policies-as-an-individual-subscriber) -* [AUTOTITLE](/copilot/how-tos/administer/organizations/managing-policies-for-copilot-in-your-organization) +* [AUTOTITLE](/copilot/how-tos/get-code-suggestions/find-matching-code) +* [AUTOTITLE](/copilot/how-tos/manage-your-account/manage-policies) +* [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/manage-policies) diff --git a/content/copilot/concepts/completions/code-suggestions.md b/content/copilot/concepts/completions/code-suggestions.md index 436b9803df9e..f431fb205ca6 100644 --- a/content/copilot/concepts/completions/code-suggestions.md +++ b/content/copilot/concepts/completions/code-suggestions.md @@ -19,7 +19,7 @@ category: * **{% data variables.copilot.next_edit_suggestions_caps %}** - Based on the edits you are making, {% data variables.product.prodname_copilot_short %} both predicts the location of the next edit you'll want to make and what that edit should be. To enable {% data variables.copilot.next_edit_suggestions %}, see [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/configuring-github-copilot-in-your-environment#enabling-next-edit-suggestions). + Based on the edits you are making, {% data variables.product.prodname_copilot_short %} both predicts the location of the next edit you'll want to make and what that edit should be. To enable {% data variables.copilot.next_edit_suggestions %}, see [AUTOTITLE](/copilot/how-tos/configure-personal-settings/configure-in-ide#enabling-next-edit-suggestions). * **Ghost text suggestions** @@ -51,7 +51,7 @@ category: * **{% data variables.copilot.next_edit_suggestions_caps %} ({% data variables.release-phases.public_preview %})** - Based on the edits you are making, {% data variables.product.prodname_copilot_short %} will predict the location of the next edit you are likely to make and suggest a completion for it. Suggestions may span a single symbol, an entire line, or multiple lines, depending on the scope of the potential change. To enable {% data variables.copilot.next_edit_suggestions %}, see [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/configuring-github-copilot-in-your-environment#enabling-next-edit-suggestions). + Based on the edits you are making, {% data variables.product.prodname_copilot_short %} will predict the location of the next edit you are likely to make and suggest a completion for it. Suggestions may span a single symbol, an entire line, or multiple lines, depending on the scope of the potential change. To enable {% data variables.copilot.next_edit_suggestions %}, see [AUTOTITLE](/copilot/how-tos/configure-personal-settings/configure-in-ide#enabling-next-edit-suggestions). {% data reusables.copilot.supported-languages %} @@ -177,4 +177,4 @@ The following programming languages and technologies are included in the trainin ## Next steps -* [AUTOTITLE](/copilot/how-tos/completions/getting-code-suggestions-in-your-ide-with-github-copilot) +* [AUTOTITLE](/copilot/how-tos/get-code-suggestions/get-ide-code-suggestions) diff --git a/content/copilot/concepts/context/content-exclusion.md b/content/copilot/concepts/context/content-exclusion.md index f3f0fc1e95f6..d28de1447ccf 100644 --- a/content/copilot/concepts/context/content-exclusion.md +++ b/content/copilot/concepts/context/content-exclusion.md @@ -62,5 +62,5 @@ After you configure content exclusion, the client (for example, the {% data vari ## Further reading -* [AUTOTITLE](/copilot/how-tos/content-exclusion/excluding-content-from-github-copilot) -* [AUTOTITLE](/copilot/how-tos/content-exclusion/reviewing-changes-to-content-exclusions-for-github-copilot) +* [AUTOTITLE](/copilot/how-tos/configure-content-exclusion/exclude-content-from-copilot) +* [AUTOTITLE](/copilot/how-tos/configure-content-exclusion/review-changes) diff --git a/content/copilot/concepts/context/mcp.md b/content/copilot/concepts/context/mcp.md index 2f0d365d7f7c..99d9b247dcf9 100644 --- a/content/copilot/concepts/context/mcp.md +++ b/content/copilot/concepts/context/mcp.md @@ -42,7 +42,7 @@ For more information on MCP, see [the official MCP documentation](https://modelc To learn how to configure and use MCP servers, see: -* [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp/extend-copilot-chat-with-mcp) for {% data variables.copilot.copilot_chat_short %} in your IDE +* [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp-in-your-ide/extend-copilot-chat-with-mcp) for {% data variables.copilot.copilot_chat_short %} in your IDE * [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-copilot/add-mcp-servers) for {% data variables.copilot.copilot_cli_short %} * [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/configure-mcp-servers) for repository MCP configuration on {% data variables.product.prodname_dotcom_the_website %} * [AUTOTITLE](/copilot/how-tos/github-copilot-app/customize-github-copilot-app) for information on MCP server support in the {% data variables.copilot.github_copilot_app %} @@ -68,7 +68,7 @@ The {% data variables.product.github %} MCP server is a Model Context Protocol ( * Enable cloud-based workflows that work from any device, without local setup. * Invoke {% data variables.product.github %} tools, such as {% data variables.copilot.copilot_cloud_agent %} (requires {% data variables.product.prodname_copilot %} subscription) and {% data variables.product.prodname_code_scanning %} (requires {% data variables.product.prodname_GHAS %} subscription), to assist with code generation and security analysis. -To learn how to set up and use the {% data variables.product.github %} MCP server, see [AUTOTITLE](/copilot/how-tos/context/model-context-protocol/using-the-github-mcp-server). +To learn how to set up and use the {% data variables.product.github %} MCP server, see [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp-in-your-ide/use-the-github-mcp-server). To find out whether your editor supports the {% data variables.product.github %} MCP server, and which connection and authentication methods are available, see [Support by host application](https://github.com/github/github-mcp-server/blob/main/docs/installation-guides/README.md#support-by-host-application) in the `github/github-mcp-server` repository. @@ -89,7 +89,7 @@ Enabling only the toolsets you need improves your AI assistant's performance and Toolsets do not only include tools, but also relevant MCP resources and prompts where applicable. -To learn how to configure toolsets for the {% data variables.product.github %} MCP server, see [AUTOTITLE](/copilot/how-tos/context/use-mcp/configure-toolsets). +To learn how to configure toolsets for the {% data variables.product.github %} MCP server, see [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp-in-your-ide/configure-toolsets). ### Security @@ -104,9 +104,9 @@ The {% data variables.product.github %} MCP Registry is a curated list of MCP se ## Next steps -* [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp/extend-copilot-chat-with-mcp)—Add MCP servers to {% data variables.copilot.copilot_chat_short %} in your IDE +* [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp-in-your-ide/extend-copilot-chat-with-mcp)—Add MCP servers to {% data variables.copilot.copilot_chat_short %} in your IDE * [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/configure-mcp-servers)—Configure repository MCP servers for {% data variables.copilot.copilot_cloud_agent %} and {% data variables.copilot.copilot_code-review_short %} -* [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp/set-up-the-github-mcp-server)—Set up the {% data variables.product.github %} MCP server -* [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp/use-the-github-mcp-server)—Use the {% data variables.product.github %} MCP server -* [AUTOTITLE](/copilot/tutorials/enhancing-copilot-agent-mode-with-mcp) +* [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp-in-your-ide/set-up-the-github-mcp-server)—Set up the {% data variables.product.github %} MCP server +* [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp-in-your-ide/use-the-github-mcp-server)—Use the {% data variables.product.github %} MCP server +* [AUTOTITLE](/copilot/tutorials/enhance-agent-mode-with-mcp) * [AUTOTITLE](/copilot/reference/customization-cheat-sheet) diff --git a/content/copilot/concepts/context/repository-indexing.md b/content/copilot/concepts/context/repository-indexing.md index 8c742a100dca..11f767d0faab 100644 --- a/content/copilot/concepts/context/repository-indexing.md +++ b/content/copilot/concepts/context/repository-indexing.md @@ -28,7 +28,7 @@ category: When you start a conversation with {% data variables.copilot.copilot_chat_short %} that has a repository context, the repository is automatically indexed to improve context-enriched answers to your questions about the code's structure and logic in {% data variables.product.github %} and {% data variables.product.prodname_vscode %}. For example, you can ask **“How does this repo manage HTTP requests and responses?”** and {% data variables.copilot.copilot_chat_short %} will reference relevant sections of your code to deliver an informed answer. -For more information on how to ask questions, see [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-github). +For more information on how to ask questions, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/chat-with-copilot/chat-in-github). ## Semantic code search in {% data variables.copilot.copilot_cloud_agent %} @@ -58,6 +58,6 @@ This feature is controlled by policy and is disabled by default. For organizatio ## Excluding content from {% data variables.copilot.copilot_chat_short %} answers -Enterprise or organization owners with a {% data variables.copilot.copilot_enterprise_short %} or {% data variables.copilot.copilot_business_short %} plan can define content exclusions to control the behavior of {% data variables.product.prodname_copilot %} for the {% data variables.product.prodname_copilot_short %} seats they manage. For more information, see [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/excluding-content-from-github-copilot). +Enterprise or organization owners with a {% data variables.copilot.copilot_enterprise_short %} or {% data variables.copilot.copilot_business_short %} plan can define content exclusions to control the behavior of {% data variables.product.prodname_copilot %} for the {% data variables.product.prodname_copilot_short %} seats they manage. For more information, see [AUTOTITLE](/copilot/how-tos/configure-content-exclusion/exclude-content-from-copilot). If a semantic code search index is created for a repository that is included in a content exclusion policy, data is filtered according to the policy before being passed to {% data variables.copilot.copilot_chat_short %}. diff --git a/content/copilot/concepts/context/spaces.md b/content/copilot/concepts/context/spaces.md index 41dafcdf8faa..b9a3cfb80957 100644 --- a/content/copilot/concepts/context/spaces.md +++ b/content/copilot/concepts/context/spaces.md @@ -69,4 +69,4 @@ Questions you submit in a space count as {% data variables.copilot.copilot_chat_ ## Next steps -To start using {% data variables.copilot.copilot_spaces_short %}, see [AUTOTITLE](/copilot/how-tos/provide-context/use-copilot-spaces/create-copilot-spaces). +To start using {% data variables.copilot.copilot_spaces_short %}, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/copilot-spaces/create-copilot-spaces). diff --git a/content/copilot/concepts/copilot-usage-metrics/copilot-metrics.md b/content/copilot/concepts/copilot-usage-metrics/copilot-metrics.md index ad7a2d561e4b..08425918fc93 100644 --- a/content/copilot/concepts/copilot-usage-metrics/copilot-metrics.md +++ b/content/copilot/concepts/copilot-usage-metrics/copilot-metrics.md @@ -65,7 +65,7 @@ The following API resources expose {% data variables.product.prodname_copilot_sh > [!NOTE] > You can grant **organization-only visibility** into {% data variables.product.prodname_copilot_short %} usage metrics without providing enterprise-level access. > -> You can do this by creating an organization custom role that includes the "View organization {% data variables.product.prodname_copilot_short %} metrics" permission, and assigning that role to users who need visibility into metrics for a single organization. See [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles). +> You can do this by creating an organization custom role that includes the "View organization {% data variables.product.prodname_copilot_short %} metrics" permission, and assigning that role to users who need visibility into metrics for a single organization. See [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles). Organization-level {% data variables.product.prodname_copilot_short %} usage metrics are based on organization membership, not on where individual actions occur. To appear in an enterprise’s metrics, a user must have an active {% data variables.product.prodname_copilot_short %} seat assigned within that enterprise (in any organization that belongs to the enterprise). As a result, a single user’s usage may appear in multiple organization dashboards, while that same user is counted only once in the enterprise-level total. Organization-level analytics are intended for visibility into adoption and usage within an organization and are not designed to be directly compared to enterprise-level totals. @@ -139,7 +139,7 @@ Look for patterns across these signals rather than focusing on any single number Now that you understand what each {% data variables.product.prodname_copilot_short %} metric measures and how to use them, you can explore the dashboards to see these metrics in action. -* To view adoption and usage trends across your enterprise and organizations, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/view-usage-and-adoption). -* To analyze how code is being generated by users and agents, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/view-code-generation). +* To view adoption and usage trends across your enterprise and organizations, see [AUTOTITLE](/copilot/how-tos/administer-copilot/view-usage-and-adoption). +* To analyze how code is being generated by users and agents, see [AUTOTITLE](/copilot/how-tos/administer-copilot/view-code-generation). * To access {% data variables.product.prodname_copilot_short %} usage metrics programmatically, see [AUTOTITLE](/rest/copilot/copilot-usage-metrics). * To construct team-level metrics by aggregating per-user records, see [AUTOTITLE](/copilot/reference/copilot-usage-metrics/team-level-metrics). diff --git a/content/copilot/concepts/models/auto-model-selection.md b/content/copilot/concepts/models/auto-model-selection.md index 8b49b184b1aa..46cb1b8966c7 100644 --- a/content/copilot/concepts/models/auto-model-selection.md +++ b/content/copilot/concepts/models/auto-model-selection.md @@ -88,7 +88,7 @@ When you select **Auto**, {% data variables.copilot.copilot_auto_model_selection #### Enabling access during {% data variables.release-phases.public_preview %} -During the {% data variables.release-phases.public_preview %}, if you're using a {% data variables.copilot.copilot_business_short %} or {% data variables.copilot.copilot_enterprise_short %} plan, the organization or enterprise that provides your plan must have the **Editor preview features** policy enabled. See [AUTOTITLE](/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#enabling-copilot-features-in-your-organization) or [AUTOTITLE](/enterprise-cloud@latest/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise#copilot-in-githubcom). +During the {% data variables.release-phases.public_preview %}, if you're using a {% data variables.copilot.copilot_business_short %} or {% data variables.copilot.copilot_enterprise_short %} plan, the organization or enterprise that provides your plan must have the **Editor preview features** policy enabled. See [AUTOTITLE](/enterprise-cloud@latest/copilot/how-tos/administer-copilot/manage-for-organization/manage-policies#enabling-features-and-models-in-your-organization) or [AUTOTITLE](/enterprise-cloud@latest/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-enterprise-policies#defining-policies-for-your-enterprise). ## {% data variables.copilot.copilot_auto_model_selection_short_cap_a %} in third-party agents diff --git a/content/copilot/concepts/network-settings.md b/content/copilot/concepts/network-settings.md index d04806c2f8d5..16f5119bf68d 100644 --- a/content/copilot/concepts/network-settings.md +++ b/content/copilot/concepts/network-settings.md @@ -20,7 +20,7 @@ By default, {% data variables.product.prodname_copilot_short %} connects to {% d Some networks use an HTTP proxy server to intercept Internet traffic before sending it to its intended location. Companies often use an HTTP proxy to detect suspicious traffic or restrict the content entering their networks. If you're working on a corporate network, you may need to configure {% data variables.product.prodname_copilot_short %} to connect via an HTTP proxy. -> [!NOTE] The administrator of your proxy server or firewall also needs to configure network settings for {% data variables.product.prodname_copilot_short %} to work as expected. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/configuring-your-proxy-server-or-firewall-for-copilot). +> [!NOTE] The administrator of your proxy server or firewall also needs to configure network settings for {% data variables.product.prodname_copilot_short %} to work as expected. See [AUTOTITLE](/copilot/reference/copilot-allowlist-reference). {% data variables.product.prodname_copilot_short %} supports basic HTTP proxy setups. If you need to authenticate to a proxy, {% data variables.product.prodname_copilot_short %} supports basic authentication or authentication with Kerberos. If the proxy URL starts `https://`, the proxy is not currently supported. @@ -53,4 +53,4 @@ If the default SPN isn't correct for your proxy, you can override the SPN in {% ## Next steps -To learn how to configure network settings in your editor, see [AUTOTITLE](/copilot/how-tos/personal-settings/configuring-network-settings-for-github-copilot). +To learn how to configure network settings in your editor, see [AUTOTITLE](/copilot/how-tos/configure-personal-settings/configure-network-settings). diff --git a/content/copilot/concepts/policies.md b/content/copilot/concepts/policies.md index 308171693a90..558534db04c9 100644 --- a/content/copilot/concepts/policies.md +++ b/content/copilot/concepts/policies.md @@ -55,5 +55,5 @@ If too many people have access to policy settings and your enterprise's governan To set policies, see: -* [AUTOTITLE](/copilot/how-tos/administer/enterprises/managing-policies-and-features-for-copilot-in-your-enterprise) -* [AUTOTITLE](/copilot/how-tos/administer/organizations/managing-policies-for-copilot-in-your-organization) +* [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-enterprise-policies) +* [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/manage-policies) diff --git a/content/copilot/concepts/prompting/prompt-engineering.md b/content/copilot/concepts/prompting/prompt-engineering.md index aa03d278f702..3173dc8f2f0f 100644 --- a/content/copilot/concepts/prompting/prompt-engineering.md +++ b/content/copilot/concepts/prompting/prompt-engineering.md @@ -86,7 +86,7 @@ Ambiguity can also apply to libraries: If you are using {% data variables.product.prodname_copilot_short %} in your IDE to get suggestions as you code, open any relevant files and close irrelevant files. {% data variables.product.prodname_copilot_short %} will use the open files to understand your request. -If you are using {% data variables.copilot.copilot_chat_short %} in your IDE, open the file or highlight the code that you want {% data variables.product.prodname_copilot_short %} to reference. You can also use keywords to manually supply context to {% data variables.copilot.copilot_chat_short %}. For example, you can add the `@workspace` chat participant in VS Code, or `@project` in JetBrains IDEs. See [AUTOTITLE](/copilot/using-github-copilot/github-copilot-chat-cheat-sheet). +If you are using {% data variables.copilot.copilot_chat_short %} in your IDE, open the file or highlight the code that you want {% data variables.product.prodname_copilot_short %} to reference. You can also use keywords to manually supply context to {% data variables.copilot.copilot_chat_short %}. For example, you can add the `@workspace` chat participant in VS Code, or `@project` in JetBrains IDEs. See [AUTOTITLE](/copilot/reference/chat-cheat-sheet). ## Experiment and iterate diff --git a/content/copilot/concepts/prompting/response-customization.md b/content/copilot/concepts/prompting/response-customization.md index 484c893310a5..d73dd53bf535 100644 --- a/content/copilot/concepts/prompting/response-customization.md +++ b/content/copilot/concepts/prompting/response-customization.md @@ -38,7 +38,7 @@ There are three main types of custom instructions that you can use to customize {% data reusables.copilot.personal-instructions-note %} -You can customize how {% data variables.copilot.copilot_chat_short %} responds to you on {% data variables.product.prodname_dotcom_the_website %} by adding personal instructions, which {% data variables.product.prodname_copilot_short %} will only apply to you. You do this in a popup on the {% data variables.copilot.copilot_chat_short %} page on {% data variables.product.prodname_dotcom_the_website %}. See [AUTOTITLE](/copilot/how-tos/configure-custom-instructions/add-personal-instructions). +You can customize how {% data variables.copilot.copilot_chat_short %} responds to you on {% data variables.product.prodname_dotcom_the_website %} by adding personal instructions, which {% data variables.product.prodname_copilot_short %} will only apply to you. You do this in a popup on the {% data variables.copilot.copilot_chat_short %} page on {% data variables.product.prodname_dotcom_the_website %}. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-personal-instructions). ## About repository custom instructions @@ -97,9 +97,9 @@ Here are some common use cases and examples for each type of custom instructions ## Next steps -* [AUTOTITLE](/copilot/customizing-copilot/adding-personal-custom-instructions-for-github-copilot) -* [AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot) -* [AUTOTITLE](/copilot/customizing-copilot/adding-organization-custom-instructions-for-github-copilot) +* [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-personal-instructions) +* [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-repository-instructions) +* [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-organization-instructions) ## Further reading @@ -184,14 +184,14 @@ The following examples demonstrate how to use prompt files. … ``` -For information on how to enable, create, and use prompt files, see [AUTOTITLE](/copilot/how-tos/configure-custom-instructions/add-repository-instructions?tool=vscode#enabling-and-using-prompt-files). +For information on how to enable, create, and use prompt files, see [AUTOTITLE](/copilot/how-tos/configure-custom-instructions-in-your-ide/add-repository-instructions-in-your-ide?tool=vscode#enabling-and-using-prompt-files). {% data reusables.copilot.custom-instructions-effective %} ## Next steps -* [AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot) -* [AUTOTITLE](/copilot/tutorials/use-custom-instructions) +* [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-repository-instructions) +* [AUTOTITLE](/copilot/tutorials/customize-code-review) * [AUTOTITLE](/copilot/reference/customization-cheat-sheet) {% endvscode %} @@ -282,13 +282,13 @@ The following examples demonstrate how to use prompt files. … ``` -For information on how to create and use prompt files, see [AUTOTITLE](/copilot/how-tos/configure-custom-instructions/add-repository-instructions?tool=visualstudio#using-prompt-files). +For information on how to create and use prompt files, see [AUTOTITLE](/copilot/how-tos/configure-custom-instructions-in-your-ide/add-repository-instructions-in-your-ide?tool=visualstudio#using-prompt-files). {% data reusables.copilot.custom-instructions-effective %} ## Next steps -* [AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot) +* [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-repository-instructions) * [AUTOTITLE](/copilot/reference/customization-cheat-sheet) {% endvisualstudio %} @@ -391,8 +391,8 @@ For a curated collection of examples, see [AUTOTITLE](/copilot/tutorials/customi ## Next steps -* [AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot) -* [AUTOTITLE](/copilot/tutorials/use-custom-instructions) +* [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-repository-instructions) +* [AUTOTITLE](/copilot/tutorials/customize-code-review) * [AUTOTITLE](/copilot/reference/customization-cheat-sheet) {% endjetbrains %} @@ -437,8 +437,8 @@ For a curated collection of examples, see [AUTOTITLE](/copilot/tutorials/customi ## Next steps -* [AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot) -* [AUTOTITLE](/copilot/tutorials/use-custom-instructions) +* [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-repository-instructions) +* [AUTOTITLE](/copilot/tutorials/customize-code-review) * [AUTOTITLE](/copilot/reference/customization-cheat-sheet) {% endxcode %} @@ -484,8 +484,8 @@ For a curated collection of examples, see [AUTOTITLE](/copilot/tutorials/customi ## Next steps -* [AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot) -* [AUTOTITLE](/copilot/tutorials/use-custom-instructions) +* [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-repository-instructions) +* [AUTOTITLE](/copilot/tutorials/customize-code-review) * [AUTOTITLE](/copilot/reference/customization-cheat-sheet) {% endeclipse %} diff --git a/content/copilot/concepts/spark.md b/content/copilot/concepts/spark.md index fdb676ac0eb9..3f2e842626a0 100644 --- a/content/copilot/concepts/spark.md +++ b/content/copilot/concepts/spark.md @@ -137,6 +137,6 @@ By default, your spark's data store is shared for all users of the published spa ## Further reading -* [AUTOTITLE](/copilot/responsible-use/spark) +* [AUTOTITLE](/copilot/responsible-use/agents) * [AUTOTITLE](/copilot/tutorials/spark/build-apps-with-spark) * [AUTOTITLE](/copilot/how-tos/troubleshoot-copilot/troubleshoot-spark) From 3af7cb3042ac2f16645785e9f6dc89922d5e5588 Mon Sep 17 00:00:00 2001 From: Kevin Heis Date: Thu, 9 Jul 2026 09:10:50 -0700 Subject: [PATCH 04/15] Update redirected internal links in copilot (how-tos (part 2)) (#62162) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../copilot-cli/use-copilot-cli/overview.md | 14 ++++---- .../chat-with-copilot/chat-in-github.md | 2 +- ...the-github-mcp-server-from-copilot-chat.md | 6 ++-- .../add-organization-instructions.md | 2 +- .../add-personal-instructions.md | 2 +- .../add-repository-instructions.md | 2 +- .../configure-mcp-servers.md | 10 +++--- .../copilot-spaces/create-copilot-spaces.md | 6 ++-- .../configure-secrets-and-variables.md | 4 +-- .../customize-the-agent-environment.md | 18 +++++------ .../customize-the-agent-firewall.md | 4 +-- .../test-custom-agents.md | 4 +-- .../customize-cloud-agent/use-hooks.md | 4 +-- .../customize-copilot-overview.md | 2 +- .../configure-access-to-ai-models.md | 6 ++-- .../configure-automatic-review.md | 2 +- .../set-up-copilot/configure-runners.md | 10 +++--- .../enable-copilot/set-up-for-enterprise.md | 8 ++--- .../enable-copilot/set-up-for-organization.md | 10 +++--- .../enable-copilot/set-up-for-self.md | 2 +- .../enable-copilot/set-up-for-students.md | 4 +-- .../set-up-for-teachers-and-os-maintainers.md | 4 +-- .../use-copilot-agents/copilot-code-review.md | 4 +-- .../copilot-sdk/troubleshooting/debugging.md | 2 +- .../find-matching-code.md | 2 +- .../get-ide-code-suggestions.md | 32 +++++++++---------- .../customize-github-copilot-app.md | 2 +- .../manage-company-spending.md | 6 ++-- .../disable-copilot-free.md | 2 +- .../get-started-with-a-copilot-plan.md | 2 +- .../manage-your-account/manage-policies.md | 2 +- .../view-and-change-your-copilot-plan.md | 2 +- .../use-copilot-spaces/use-copilot-spaces.md | 10 +++--- .../use-mcp-in-your-ide/configure-toolsets.md | 4 +-- .../enterprise-configuration.md | 6 ++-- .../extend-copilot-chat-with-mcp.md | 12 +++---- .../set-up-the-github-mcp-server.md | 18 +++++------ .../use-the-github-mcp-server.md | 18 +++++------ .../set-up/install-copilot-extension.md | 22 ++++++------- 39 files changed, 136 insertions(+), 136 deletions(-) diff --git a/content/copilot/how-tos/copilot-cli/use-copilot-cli/overview.md b/content/copilot/how-tos/copilot-cli/use-copilot-cli/overview.md index c22825f41fdf..525f0d94da9e 100644 --- a/content/copilot/how-tos/copilot-cli/use-copilot-cli/overview.md +++ b/content/copilot/how-tos/copilot-cli/use-copilot-cli/overview.md @@ -16,11 +16,11 @@ docsTeamMetrics: - copilot-cli --- -The command-line interface (CLI) for {% data variables.product.prodname_copilot %} allows you to use {% data variables.product.prodname_copilot_short %} directly from your terminal. For more information, see [AUTOTITLE](/copilot/concepts/agents/about-copilot-cli). +The command-line interface (CLI) for {% data variables.product.prodname_copilot %} allows you to use {% data variables.product.prodname_copilot_short %} directly from your terminal. For more information, see [AUTOTITLE](/copilot/concepts/agents/copilot-cli/about-copilot-cli). ## Prerequisite -Install {% data variables.copilot.copilot_cli_short %}. See [AUTOTITLE](/copilot/how-tos/set-up/install-copilot-cli). +Install {% data variables.copilot.copilot_cli_short %}. See [AUTOTITLE](/copilot/how-tos/copilot-cli/set-up-copilot-cli/install-copilot-cli). ## Using {% data variables.copilot.copilot_cli_short %} @@ -30,7 +30,7 @@ Install {% data variables.copilot.copilot_cli_short %}. See [AUTOTITLE](/copilot {% data variables.product.prodname_copilot_short %} will ask you to confirm that you trust the files in this folder. > [!IMPORTANT] - > During this {% data variables.copilot.copilot_cli %} session, {% data variables.product.prodname_copilot_short %} may attempt to read, modify, and execute files in and below this folder. You should only proceed if you trust the files in this location. For more information about trusted directories, see [AUTOTITLE](/copilot/concepts/agents/about-copilot-cli#trusted-directories). + > During this {% data variables.copilot.copilot_cli %} session, {% data variables.product.prodname_copilot_short %} may attempt to read, modify, and execute files in and below this folder. You should only proceed if you trust the files in this location. For more information about trusted directories, see [AUTOTITLE](/copilot/concepts/agents/copilot-cli/about-copilot-cli#trusted-directories). 1. Choose one of the options: @@ -53,7 +53,7 @@ Install {% data variables.copilot.copilot_cli_short %}. See [AUTOTITLE](/copilot As an alternative to typing, you can speak your prompt. See [AUTOTITLE](/copilot/how-tos/copilot-cli/use-copilot-cli/voice-input). - For some examples of prompts, see [AUTOTITLE](/copilot/concepts/agents/about-copilot-cli). + For some examples of prompts, see [AUTOTITLE](/copilot/concepts/agents/copilot-cli/about-copilot-cli). 1. When {% data variables.product.prodname_copilot_short %} wants to use a tool that could modify or execute files—{% data reusables.cli.tools-needing-approval %}—it will ask you to approve the use of the tool. @@ -164,7 +164,7 @@ You can enhance {% data variables.product.prodname_copilot_short %}’s performa * Path-specific instructions files: `.github/instructions/**/*.instructions.md`. * Agent files such as `AGENTS.md`. -For more information, see [AUTOTITLE](/copilot/how-tos/copilot-cli/add-custom-instructions). +For more information, see [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-copilot/add-custom-instructions). ### Use {% data variables.copilot.custom_agents_short %} @@ -245,7 +245,7 @@ In the case of naming conflicts, a system-level agent overrides a repository-lev copilot --agent=refactor-agent --prompt "Refactor this code block" ``` -For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-custom-agents). +For more information, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/create-custom-agents). ### Use skills @@ -274,7 +274,7 @@ To extend the functionality available to you in {% data variables.copilot.copilo 1. Fill in the details for the MCP server you want to add, using the Tab key to move between fields. 1. Press Ctrl+S to save the details. -Details of your configured MCP servers are stored in the `mcp-config.json` file, which is located, by default, in the `~/.copilot` directory. This location can be changed by setting the `COPILOT_HOME` environment variable. For information about the JSON structure of a server definition, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/extend-cloud-agent-with-mcp#writing-a-json-configuration-for-mcp-servers). +Details of your configured MCP servers are stored in the `mcp-config.json` file, which is located, by default, in the `~/.copilot` directory. This location can be changed by setting the `COPILOT_HOME` environment variable. For information about the JSON structure of a server definition, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/configure-mcp-servers#writing-a-json-configuration-for-mcp-servers). ### Context management diff --git a/content/copilot/how-tos/copilot-on-github/chat-with-copilot/chat-in-github.md b/content/copilot/how-tos/copilot-on-github/chat-with-copilot/chat-in-github.md index 2586826dcb71..1979ec363a26 100644 --- a/content/copilot/how-tos/copilot-on-github/chat-with-copilot/chat-in-github.md +++ b/content/copilot/how-tos/copilot-on-github/chat-with-copilot/chat-in-github.md @@ -82,4 +82,4 @@ When you start a {% data variables.copilot.copilot_cloud_agent %} task from {% d ## Further reading -* [AUTOTITLE](/copilot/tutorials/using-copilot-to-explore-a-codebase) +* [AUTOTITLE](/copilot/tutorials/explore-a-codebase) diff --git a/content/copilot/how-tos/copilot-on-github/copilot-for-github-tasks/using-the-github-mcp-server-from-copilot-chat.md b/content/copilot/how-tos/copilot-on-github/copilot-for-github-tasks/using-the-github-mcp-server-from-copilot-chat.md index 59857113ea2c..127d614689a5 100644 --- a/content/copilot/how-tos/copilot-on-github/copilot-for-github-tasks/using-the-github-mcp-server-from-copilot-chat.md +++ b/content/copilot/how-tos/copilot-on-github/copilot-for-github-tasks/using-the-github-mcp-server-from-copilot-chat.md @@ -14,7 +14,7 @@ redirect_from: The {% data variables.product.github %} MCP server is pre-configured in {% data variables.copilot.copilot_chat_dotcom_short %} with a limited set of skills, so you can use it immediately. Instruct {% data variables.copilot.copilot_chat_short %} to perform tasks like creating branches or merging pull requests on your behalf. -For a full list of available skills, see [AUTOTITLE](/copilot/reference/github-copilot-chat-cheat-sheet#mcp-skills). For more about MCP, see [AUTOTITLE](/copilot/concepts/about-mcp). +For a full list of available skills, see [AUTOTITLE](/copilot/reference/chat-cheat-sheet#mcp-skills). For more about MCP, see [AUTOTITLE](/copilot/concepts/context/mcp). ## Use the {% data variables.product.github %} MCP server @@ -34,7 +34,7 @@ The {% data variables.product.github %} MCP server in {% data variables.copilot. To access the full set of tools, set up the {% data variables.product.github %} MCP server in your IDE. See [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp-in-your-ide/use-the-github-mcp-server). -You can also use the {% data variables.product.github %} MCP server with {% data variables.copilot.copilot_cloud_agent %}. It is enabled with read-only access by default and can be customized for wider access. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/extend-coding-agent-with-mcp#customizing-the-built-in-github-mcp-server). +You can also use the {% data variables.product.github %} MCP server with {% data variables.copilot.copilot_cloud_agent %}. It is enabled with read-only access by default and can be customized for wider access. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/configure-mcp-servers#customizing-the-built-in-github-mcp-server). ## Further reading -* [AUTOTITLE](/copilot/tutorials/enhancing-copilot-agent-mode-with-mcp) +* [AUTOTITLE](/copilot/tutorials/enhance-agent-mode-with-mcp) diff --git a/content/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-organization-instructions.md b/content/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-organization-instructions.md index 1993941357c2..d3c1ef481a4f 100644 --- a/content/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-organization-instructions.md +++ b/content/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-organization-instructions.md @@ -18,7 +18,7 @@ category: {% data reusables.copilot.custom-instructions-org-support %} -Organization owners can add instructions for {% data variables.product.prodname_copilot_short %}, to tailor responses to specific needs and preferences across the organization. For an overview of this, and other types of custom instructions for {% data variables.product.prodname_copilot_short %}, see [AUTOTITLE](/copilot/concepts/about-customizing-github-copilot-chat-responses?tool=webui). +Organization owners can add instructions for {% data variables.product.prodname_copilot_short %}, to tailor responses to specific needs and preferences across the organization. For an overview of this, and other types of custom instructions for {% data variables.product.prodname_copilot_short %}, see [AUTOTITLE](/copilot/concepts/prompting/response-customization?tool=webui). ## Adding organization custom instructions diff --git a/content/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-personal-instructions.md b/content/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-personal-instructions.md index d7787645f8c3..4e8a6b33821f 100644 --- a/content/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-personal-instructions.md +++ b/content/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-personal-instructions.md @@ -16,7 +16,7 @@ category: {% data reusables.copilot.personal-instructions-note %} -You can layer multiple types of custom instructions to shape {% data variables.copilot.copilot_chat %} responses. For an overview, see [AUTOTITLE](/copilot/concepts/about-customizing-github-copilot-chat-responses?tool=webui). +You can layer multiple types of custom instructions to shape {% data variables.copilot.copilot_chat %} responses. For an overview, see [AUTOTITLE](/copilot/concepts/prompting/response-customization?tool=webui). ## About personal custom instructions for {% data variables.copilot.copilot_chat_short %} diff --git a/content/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-repository-instructions.md b/content/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-repository-instructions.md index 86dba096a540..189bf8d6b274 100644 --- a/content/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-repository-instructions.md +++ b/content/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-repository-instructions.md @@ -186,4 +186,4 @@ Custom instructions are enabled for {% data variables.copilot.copilot_code-revie * [AUTOTITLE](/copilot/reference/custom-instructions-support) * [AUTOTITLE](/copilot/tutorials/customization-library/custom-instructions)—a curated collection of examples -* [AUTOTITLE](/copilot/tutorials/use-custom-instructions) +* [AUTOTITLE](/copilot/tutorials/customize-code-review) diff --git a/content/copilot/how-tos/copilot-on-github/customize-copilot/configure-mcp-servers.md b/content/copilot/how-tos/copilot-on-github/customize-copilot/configure-mcp-servers.md index c66cf1acc749..739e74466845 100644 --- a/content/copilot/how-tos/copilot-on-github/customize-copilot/configure-mcp-servers.md +++ b/content/copilot/how-tos/copilot-on-github/customize-copilot/configure-mcp-servers.md @@ -337,7 +337,7 @@ Once you've set up your MCP configuration, you should test it to make sure it is 1. Click the **Start MCP Servers** step to expand the logs. 1. If your MCP servers have been started successfully, you will see their tools listed at the bottom of the logs. -If your MCP servers require any dependencies that are not installed on the {% data variables.product.prodname_actions %} runner by default, such as `uv` and `pipx`, or that need special setup steps, you may need to create a `copilot-setup-steps.yml` Actions workflow file to install them. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-environment). +If your MCP servers require any dependencies that are not installed on the {% data variables.product.prodname_actions %} runner by default, such as `uv` and `pipx`, or that need special setup steps, you may need to create a `copilot-setup-steps.yml` Actions workflow file to install them. For more information, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/customize-the-agent-environment). ### Validate with {% data variables.copilot.copilot_code-review_short %} @@ -381,7 +381,7 @@ If you want to allow {% data variables.product.prodname_copilot_short %} to acce 1. Click **Save MCP configuration**. 1. Add an Agents secret called `COPILOT_MCP_GITHUB_PERSONAL_ACCESS_TOKEN` with your {% data variables.product.pat_generic %} as the value. You can configure this at either the organization or repository level. For more information, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/configure-secrets-and-variables). -For information on using the {% data variables.product.github %} MCP server in other environments, see [AUTOTITLE](/copilot/customizing-copilot/using-model-context-protocol/using-the-github-mcp-server). +For information on using the {% data variables.product.github %} MCP server in other environments, see [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp-in-your-ide/use-the-github-mcp-server). ## Disabling MCP tools for code review @@ -403,6 +403,6 @@ If you disable this setting, {% data variables.copilot.copilot_code-review_short * [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-copilot/add-mcp-servers) * [AUTOTITLE](/copilot/how-tos/use-copilot-agents/request-a-code-review/use-code-review) -* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-custom-agents) -* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-environment) -* [AUTOTITLE](/copilot/customizing-copilot/extending-copilot-chat-with-mcp) \ No newline at end of file +* [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/create-custom-agents) +* [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/customize-the-agent-environment) +* [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp-in-your-ide/extend-copilot-chat-with-mcp) diff --git a/content/copilot/how-tos/copilot-on-github/customize-copilot/copilot-spaces/create-copilot-spaces.md b/content/copilot/how-tos/copilot-on-github/customize-copilot/copilot-spaces/create-copilot-spaces.md index a78119218fba..9805cd97854a 100644 --- a/content/copilot/how-tos/copilot-on-github/customize-copilot/copilot-spaces/create-copilot-spaces.md +++ b/content/copilot/how-tos/copilot-on-github/customize-copilot/copilot-spaces/create-copilot-spaces.md @@ -66,7 +66,7 @@ You can add files to a space directly from the code view on {% data variables.pr ## Next steps -* For an overview of {% data variables.copilot.copilot_spaces %}, see [AUTOTITLE](/copilot/concepts/about-organizing-and-sharing-context-with-copilot-spaces). +* For an overview of {% data variables.copilot.copilot_spaces %}, see [AUTOTITLE](/copilot/concepts/context/spaces). * To use {% data variables.copilot.copilot_spaces_short %} in {% data variables.product.github %} and your IDE, see [AUTOTITLE](/copilot/how-tos/provide-context/use-copilot-spaces/use-copilot-spaces). -* To speed up development work with {% data variables.copilot.copilot_spaces_short %}, see [AUTOTITLE](/copilot/using-github-copilot/copilot-spaces/speeding-up-development-work-with-copilot-spaces). -* To share your space with your team, see [AUTOTITLE](/copilot/using-github-copilot/copilot-spaces/collaborating-with-your-team-using-copilot-spaces). +* To speed up development work with {% data variables.copilot.copilot_spaces_short %}, see [AUTOTITLE](/copilot/tutorials/speed-up-development-work). +* To share your space with your team, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/copilot-spaces/collaborate-with-others). diff --git a/content/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/configure-secrets-and-variables.md b/content/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/configure-secrets-and-variables.md index f47555c92e92..2ec4649bfad2 100644 --- a/content/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/configure-secrets-and-variables.md +++ b/content/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/configure-secrets-and-variables.md @@ -15,7 +15,7 @@ When you delegate a task to {% data variables.copilot.copilot_cloud_agent %}, it * Give {% data variables.product.prodname_copilot_short %} access to private resources, such as internal package registries, when it builds, tests, or validates your code in the agent's environment. * Configure MCP servers, by passing API keys, tokens, or other configuration to the servers. For more information, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/configure-mcp-servers). -* Set environment variables that are available to scripts and tools that {% data variables.product.prodname_copilot_short %} runs in its environment, including in `copilot-setup-steps.yml`. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-environment). +* Set environment variables that are available to scripts and tools that {% data variables.product.prodname_copilot_short %} runs in its environment, including in `copilot-setup-steps.yml`. For more information, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/customize-the-agent-environment). {% data variables.copilot.copilot_cloud_agent %} has its own dedicated **Agents** secrets and variables, alongside the existing **Actions**, **Codespaces**, and **Dependabot** types. You can configure Agents secrets and variables at: @@ -79,5 +79,5 @@ For secrets and variables that you want to pass to MCP servers, the name must be ## Further reading -* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-environment) +* [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/customize-the-agent-environment) * [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/configure-mcp-servers) diff --git a/content/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/customize-the-agent-environment.md b/content/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/customize-the-agent-environment.md index a5d49147d53c..5571c9129c89 100644 --- a/content/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/customize-the-agent-environment.md +++ b/content/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/customize-the-agent-environment.md @@ -32,7 +32,7 @@ You can customize {% data variables.product.prodname_copilot_short %}'s developm In addition, you can: * [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/configure-secrets-and-variables) -* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-firewall). +* [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/customize-the-agent-firewall). > [!NOTE] > Organization owners can configure the default runner type for {% data variables.copilot.copilot_cloud_agent %} across all repositories in their organization, and choose whether repositories are allowed to override this default. For more information, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/configure-runner-for-coding-agent). @@ -41,7 +41,7 @@ In addition, you can: You can customize {% data variables.product.prodname_copilot_short %}'s environment by creating a special {% data variables.product.prodname_actions %} workflow file, located at `.github/workflows/copilot-setup-steps.yml` within your repository. -A `copilot-setup-steps.yml` file looks like a normal {% data variables.product.prodname_actions %} workflow file, but must contain a single `copilot-setup-steps` job. The steps in this job will be executed in {% data variables.product.prodname_actions %} before {% data variables.product.prodname_copilot_short %} starts working. For more information on {% data variables.product.prodname_actions %} workflow files, see [AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions). +A `copilot-setup-steps.yml` file looks like a normal {% data variables.product.prodname_actions %} workflow file, but must contain a single `copilot-setup-steps` job. The steps in this job will be executed in {% data variables.product.prodname_actions %} before {% data variables.product.prodname_copilot_short %} starts working. For more information on {% data variables.product.prodname_actions %} workflow files, see [AUTOTITLE](/actions/reference/workflows-and-actions/workflow-syntax). > [!NOTE] @@ -90,13 +90,13 @@ In your `copilot-setup-steps.yml` file, you can only customize the following set * `snapshot` * `timeout-minutes` (maximum value: `59`) -For more information on these options, see [AUTOTITLE](/actions/writing-workflows/workflow-syntax-for-github-actions#jobs). +For more information on these options, see [AUTOTITLE](/actions/reference/workflows-and-actions/workflow-syntax#jobs). Any value that is set for the `fetch-depth` option of the `actions/checkout` action will be overridden to allow the agent to rollback commits upon request, while mitigating security risks. For more information, see [`actions/checkout/README.md`](https://github.com/actions/checkout/blob/main/README.md). Your `copilot-setup-steps.yml` file will automatically be run as a normal {% data variables.product.prodname_actions %} workflow when changes are made, so you can see if it runs successfully. This will show alongside other checks in a pull request where you create or modify the file. -Once you have merged the yml file into your default branch, you can manually run the workflow from the repository's **Actions** tab at any time to check that everything works as expected. For more information, see [AUTOTITLE](/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/manually-running-a-workflow). +Once you have merged the yml file into your default branch, you can manually run the workflow from the repository's **Actions** tab at any time to check that everything works as expected. For more information, see [AUTOTITLE](/actions/how-tos/manage-workflow-runs/manually-run-a-workflow). When {% data variables.product.prodname_copilot_short %} starts work, your setup steps will be run, and updates will show in the session logs. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/use-copilot-agents/manage-and-track-agents). @@ -114,14 +114,14 @@ You can use a Copilot setup steps file to deterministically install tools or dep ## Upgrading to larger {% data variables.product.prodname_dotcom %}-hosted {% data variables.product.prodname_actions %} runners -By default, {% data variables.product.prodname_copilot_short %} works in a standard {% data variables.product.prodname_actions %} runner. You can upgrade to larger runners for better performance (CPU and memory), more disk space and advanced features like Azure private networking. For more information, see [AUTOTITLE](/actions/using-github-hosted-runners/using-larger-runners/about-larger-runners). +By default, {% data variables.product.prodname_copilot_short %} works in a standard {% data variables.product.prodname_actions %} runner. You can upgrade to larger runners for better performance (CPU and memory), more disk space and advanced features like Azure private networking. For more information, see [AUTOTITLE](/actions/concepts/runners/larger-runners). -1. Set up larger runners for your organization. For more information, see [AUTOTITLE](/actions/using-github-hosted-runners/managing-larger-runners). +1. Set up larger runners for your organization. For more information, see [AUTOTITLE](/actions/how-tos/manage-runners/larger-runners/manage-larger-runners). 1. If you are using larger runners with Azure private networking, configure your Azure private network to allow outbound access to the hosts required for {% data variables.copilot.copilot_cloud_agent %}: {% data reusables.copilot.cloud-agent-required-hosts %} -1. Use a `copilot-setup-steps.yml` file in your repository to configure {% data variables.copilot.copilot_cloud_agent %} to run on your chosen runners. Set the `runs-on` step of the `copilot-setup-steps` job to the label and/or group for the larger runners you want {% data variables.product.prodname_copilot_short %} to use. For more information on specifying larger runners with `runs-on`, see [AUTOTITLE](/actions/using-github-hosted-runners/running-jobs-on-larger-runners). +1. Use a `copilot-setup-steps.yml` file in your repository to configure {% data variables.copilot.copilot_cloud_agent %} to run on your chosen runners. Set the `runs-on` step of the `copilot-setup-steps` job to the label and/or group for the larger runners you want {% data variables.product.prodname_copilot_short %} to use. For more information on specifying larger runners with `runs-on`, see [AUTOTITLE](/actions/how-tos/manage-runners/larger-runners/use-larger-runners). ```yaml # ... @@ -150,7 +150,7 @@ We recommend that you only use {% data variables.copilot.copilot_cloud_agent %} {% data reusables.copilot.cloud-agent-required-hosts %} -1. Disable {% data variables.copilot.copilot_cloud_agent %}'s integrated firewall in your repository settings. The firewall is not compatible with self-hosted runners. Unless this is disabled, use of {% data variables.copilot.copilot_cloud_agent %} will be blocked. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-firewall). +1. Disable {% data variables.copilot.copilot_cloud_agent %}'s integrated firewall in your repository settings. The firewall is not compatible with self-hosted runners. Unless this is disabled, use of {% data variables.copilot.copilot_cloud_agent %} will be blocked. For more information, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/customize-the-agent-firewall). 1. In your `copilot-setup-steps.yml` file, set the `runs-on` attribute to your ARC-managed scale set name: ```yaml @@ -203,4 +203,4 @@ jobs: ## Further reading * [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/configure-secrets-and-variables) -* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-firewall) +* [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/customize-the-agent-firewall) diff --git a/content/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/customize-the-agent-firewall.md b/content/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/customize-the-agent-firewall.md index f136807a242b..3afcf138d219 100644 --- a/content/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/customize-the-agent-firewall.md +++ b/content/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/customize-the-agent-firewall.md @@ -120,5 +120,5 @@ To access the firewall settings: ## Further reading -* [AUTOTITLE](/actions/writing-workflows/choosing-what-your-workflow-does/store-information-in-variables#creating-configuration-variables-for-a-repository) -* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-environment) +* [AUTOTITLE](/actions/how-tos/write-workflows/choose-what-workflows-do/use-variables#creating-configuration-variables-for-a-repository) +* [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/customize-the-agent-environment) diff --git a/content/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/test-custom-agents.md b/content/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/test-custom-agents.md index 95cc1cdb18fe..973910596f80 100644 --- a/content/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/test-custom-agents.md +++ b/content/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/test-custom-agents.md @@ -26,7 +26,7 @@ Before you can test a {% data variables.copilot.copilot_custom_agent_short %}, y ## 1. Create your test {% data variables.copilot.copilot_custom_agent_short %} 1. In your organization or enterprise's `.github-private` repository, create a new directory called `.github/agents`. Agents stored in this directory are only available to members of your organization or enterprise who have access to the `.github-private` repository, and can only be used when they start a task within that repository. -1. In your `.github/agents` directory, create the {% data variables.copilot.agent_profile %} for your test agent. You can create a net-new profile or duplicate an existing profile to test potential updates. For information on configuring an {% data variables.copilot.agent_profile %}, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-custom-agents#configuring-an-agent-profile). +1. In your `.github/agents` directory, create the {% data variables.copilot.agent_profile %} for your test agent. You can create a net-new profile or duplicate an existing profile to test potential updates. For information on configuring an {% data variables.copilot.agent_profile %}, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/create-custom-agents#configuring-an-agent-profile). 1. Merge your test {% data variables.copilot.agent_profile %} into the default branch of your repository. ## 2. Test your {% data variables.copilot.copilot_custom_agent_short %} @@ -47,4 +47,4 @@ Before you can test a {% data variables.copilot.copilot_custom_agent_short %}, y To monitor the usage of {% data variables.copilot.custom_agents_short %} in your organization, filter your organization's audit log by `actor:Copilot`. See [AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization). -To monitor the usage of {% data variables.copilot.custom_agents_short %} in your enterprise, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/monitor-agentic-activity). \ No newline at end of file +To monitor the usage of {% data variables.copilot.custom_agents_short %} in your enterprise, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/monitor-agentic-activity). diff --git a/content/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/use-hooks.md b/content/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/use-hooks.md index 5f016053b058..26b9f16e612d 100644 --- a/content/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/use-hooks.md +++ b/content/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/use-hooks.md @@ -31,5 +31,5 @@ redirect_from: * [AUTOTITLE](/copilot/reference/hooks-reference) * [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-cloud-agent) -* [AUTOTITLE](/copilot/concepts/agents/about-copilot-cli) -* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-environment) +* [AUTOTITLE](/copilot/concepts/agents/copilot-cli/about-copilot-cli) +* [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/customize-the-agent-environment) diff --git a/content/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview.md b/content/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview.md index 8055f5bbb6b2..07591c5dc3d1 100644 --- a/content/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview.md +++ b/content/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview.md @@ -15,7 +15,7 @@ This quickstart walks you through customizing {% data variables.product.prodname ## Prerequisites -* Any paid {% data variables.product.prodname_copilot_short %} plan. For more information, see [AUTOTITLE](/copilot/about-github-copilot/subscription-plans-for-github-copilot). +* Any paid {% data variables.product.prodname_copilot_short %} plan. For more information, see [AUTOTITLE](/copilot/get-started/plans). * {% data variables.copilot.copilot_cloud_agent_short_cap_c %} enabled for your organization or account. For more information, see [AUTOTITLE](/copilot/concepts/agents/cloud-agent/access-management). * Write access to a {% data variables.product.github %} repository. diff --git a/content/copilot/how-tos/copilot-on-github/set-up-copilot/configure-access-to-ai-models.md b/content/copilot/how-tos/copilot-on-github/set-up-copilot/configure-access-to-ai-models.md index 781d2693b26f..481927865037 100644 --- a/content/copilot/how-tos/copilot-on-github/set-up-copilot/configure-access-to-ai-models.md +++ b/content/copilot/how-tos/copilot-on-github/set-up-copilot/configure-access-to-ai-models.md @@ -21,7 +21,7 @@ Your access to {% data variables.product.prodname_copilot %} models depends on: * The client you use (for example, {% data variables.product.prodname_dotcom_the_website %}, {% data variables.product.prodname_vscode %}, or JetBrains IDEs). * Whether your organization or enterprise restricts access to specific models. -For a list of available AI models, see [AUTOTITLE](/copilot/using-github-copilot/ai-models/supported-ai-models-in-copilot). For information on how {% data variables.copilot.copilot_chat_short %} serves different AI models, see [AUTOTITLE](/copilot/reference/ai-models/model-hosting). +For a list of available AI models, see [AUTOTITLE](/copilot/reference/ai-models/supported-models). For information on how {% data variables.copilot.copilot_chat_short %} serves different AI models, see [AUTOTITLE](/copilot/reference/ai-models/model-hosting). ## Setup for individual use @@ -32,10 +32,10 @@ For individual {% data variables.product.prodname_copilot_short %} plans, you ca ## Setup for organization and enterprise use -As an enterprise or organization owner, you can enable or disable access to AI models for members with a {% data variables.copilot.copilot_enterprise_short %} or {% data variables.copilot.copilot_business_short %} seat. 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) and [AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise). +As an enterprise or organization owner, you can enable or disable access to AI models for members with a {% data variables.copilot.copilot_enterprise_short %} or {% data variables.copilot.copilot_business_short %} seat. See [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/manage-policies) and [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-enterprise-policies). > [!NOTE] -> * Models available in {% data variables.copilot.copilot_auto_model_selection %} will follow the policies set for an organization or enterprise. See [AUTOTITLE](/copilot/concepts/auto-model-selection). +> * Models available in {% data variables.copilot.copilot_auto_model_selection %} will follow the policies set for an organization or enterprise. See [AUTOTITLE](/copilot/concepts/models/auto-model-selection). > * {% data reusables.copilot.byok-no-subscription-required %} {% ifversion copilot-byok %} diff --git a/content/copilot/how-tos/copilot-on-github/set-up-copilot/configure-automatic-review.md b/content/copilot/how-tos/copilot-on-github/set-up-copilot/configure-automatic-review.md index eacb8ced68d1..0b5122ed9b4b 100644 --- a/content/copilot/how-tos/copilot-on-github/set-up-copilot/configure-automatic-review.md +++ b/content/copilot/how-tos/copilot-on-github/set-up-copilot/configure-automatic-review.md @@ -19,7 +19,7 @@ category: ## Introduction -You can configure {% data variables.copilot.copilot_code-review_short %} to review pull requests automatically. For an overview of automatic pull request reviews, see [AUTOTITLE](/copilot/concepts/code-review#about-automatic-pull-request-reviews). +You can configure {% data variables.copilot.copilot_code-review_short %} to review pull requests automatically. For an overview of automatic pull request reviews, see [AUTOTITLE](/copilot/concepts/agents/code-review#about-automatic-pull-request-reviews). ## Configuring automatic code review for your own pull requests diff --git a/content/copilot/how-tos/copilot-on-github/set-up-copilot/configure-runners.md b/content/copilot/how-tos/copilot-on-github/set-up-copilot/configure-runners.md index 403f80bef53d..6539f6d68524 100644 --- a/content/copilot/how-tos/copilot-on-github/set-up-copilot/configure-runners.md +++ b/content/copilot/how-tos/copilot-on-github/set-up-copilot/configure-runners.md @@ -21,7 +21,7 @@ You can also upgrade to larger {% data variables.product.prodname_dotcom %}-host ## Configure self-hosted runners for code review -Run {% data variables.copilot.copilot_code-review_short %} using self-hosted {% data variables.product.prodname_actions %} runners with ARC (Actions Runner Controller). You must first set up ARC-managed scale sets in your environment. For more information on ARC, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/about-actions-runner-controller). +Run {% data variables.copilot.copilot_code-review_short %} using self-hosted {% data variables.product.prodname_actions %} runners with ARC (Actions Runner Controller). You must first set up ARC-managed scale sets in your environment. For more information on ARC, see [AUTOTITLE](/actions/concepts/runners/actions-runner-controller). > [!WARNING] > ARC is the only officially supported solution for self-hosting {% data variables.copilot.copilot_code-review_short %}. For security reasons, do not use non-ARC self-hosted runners. @@ -36,7 +36,7 @@ To configure self-hosted runners for {% data variables.copilot.copilot_code-revi * `api.githubcopilot.com` * `uploads.github.com` * `user-images.githubusercontent.com` -1. In your `copilot-setup-steps.yml` file, set the `runs-on` attribute to your ARC-managed scale set name. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-environment#preinstalling-tools-or-dependencies-in-copilots-environment). +1. In your `copilot-setup-steps.yml` file, set the `runs-on` attribute to your ARC-managed scale set name. For more information, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/customize-the-agent-environment#preinstalling-tools-or-dependencies-in-copilots-environment). ```yaml # ... @@ -49,19 +49,19 @@ To configure self-hosted runners for {% data variables.copilot.copilot_code-revi ## Upgrade to larger {% data variables.product.prodname_dotcom %}-hosted {% data variables.product.prodname_actions %} runners -By default, {% data variables.copilot.copilot_code-review_short %} runs on a standard {% data variables.product.prodname_actions %} runner. Larger runners provide better performance (CPU and memory), more disk space, and advanced features like Azure private networking. See [AUTOTITLE](/actions/using-github-hosted-runners/using-larger-runners/about-larger-runners). +By default, {% data variables.copilot.copilot_code-review_short %} runs on a standard {% data variables.product.prodname_actions %} runner. Larger runners provide better performance (CPU and memory), more disk space, and advanced features like Azure private networking. See [AUTOTITLE](/actions/concepts/runners/larger-runners). > [!NOTE] > Usage of larger {% data variables.product.prodname_dotcom %}-hosted runners is billed at a higher per-minute rate. For more information, see [AUTOTITLE](/billing/concepts/product-billing/github-actions). -1. Set up larger runners for your organization. See [AUTOTITLE](/actions/using-github-hosted-runners/managing-larger-runners). +1. Set up larger runners for your organization. See [AUTOTITLE](/actions/how-tos/manage-runners/larger-runners/manage-larger-runners). 1. If you are using larger runners with Azure private networking, configure your Azure private network to allow outbound access to the following hosts: * `api.githubcopilot.com` * `uploads.github.com` * `user-images.githubusercontent.com` -1. In your `copilot-setup-steps.yml` file, set the `runs-on` attribute to the label for the larger runners you want {% data variables.copilot.copilot_code-review_short %} to use. See [AUTOTITLE](/actions/using-github-hosted-runners/running-jobs-on-larger-runners). +1. In your `copilot-setup-steps.yml` file, set the `runs-on` attribute to the label for the larger runners you want {% data variables.copilot.copilot_code-review_short %} to use. See [AUTOTITLE](/actions/how-tos/manage-runners/larger-runners/use-larger-runners). ```yaml # ... diff --git a/content/copilot/how-tos/copilot-on-github/set-up-copilot/enable-copilot/set-up-for-enterprise.md b/content/copilot/how-tos/copilot-on-github/set-up-copilot/enable-copilot/set-up-for-enterprise.md index b66fa941f06d..e8bf0482f427 100644 --- a/content/copilot/how-tos/copilot-on-github/set-up-copilot/enable-copilot/set-up-for-enterprise.md +++ b/content/copilot/how-tos/copilot-on-github/set-up-copilot/enable-copilot/set-up-for-enterprise.md @@ -34,18 +34,18 @@ You will use enterprise policies to manage two aspects of governance: Generally, enterprise owners can either set each policy for the whole enterprise or "let organizations decide." With the latter option, users are subject to the policy of the organization where they receive their {% data variables.product.prodname_copilot_short %} license or to the default defined in your "Policies for enterprise-assigned users" setting. -To manage policies, see [AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise). +To manage policies, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-enterprise-policies). ## Configure networking -If your corporate network restricts users' traffic, add the required URLs to the allowlist for your firewall or proxy. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/configuring-your-proxy-server-or-firewall-for-copilot). +If your corporate network restricts users' traffic, add the required URLs to the allowlist for your firewall or proxy. See [AUTOTITLE](/copilot/reference/copilot-allowlist-reference). If you route traffic via a proxy server, you may need to ask users to configure proxy settings in their environment. You may also need to install custom certificates on your users' machines. For more information, see [AUTOTITLE](/copilot/concepts/network-settings). -If your enterprise is on {% data variables.enterprise.data_residency_site %}, users will also need to configure their environment to authenticate from their development environment. See [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/using-github-copilot-with-an-account-on-ghecom). +If your enterprise is on {% data variables.enterprise.data_residency_site %}, users will also need to configure their environment to authenticate from their development environment. See [AUTOTITLE](/copilot/how-tos/configure-personal-settings/authenticate-to-ghecom). ## Assign licenses {% data reusables.copilot.enterprise-licensing %} -For instructions, see [AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise/enabling-copilot-for-organizations-in-your-enterprise). +For instructions, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-access/grant-access). diff --git a/content/copilot/how-tos/copilot-on-github/set-up-copilot/enable-copilot/set-up-for-organization.md b/content/copilot/how-tos/copilot-on-github/set-up-copilot/enable-copilot/set-up-for-organization.md index f3dd27ea9cbe..214677df2752 100644 --- a/content/copilot/how-tos/copilot-on-github/set-up-copilot/enable-copilot/set-up-for-organization.md +++ b/content/copilot/how-tos/copilot-on-github/set-up-copilot/enable-copilot/set-up-for-organization.md @@ -28,19 +28,19 @@ If your organization already belongs to an enterprise with a {% data variables.c ## Set policies -Control which {% data variables.product.prodname_copilot_short %} features are available in your organization. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-github-copilot-features-in-your-organization/managing-policies-for-copilot-in-your-organization). +Control which {% data variables.product.prodname_copilot_short %} features are available in your organization. See [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/manage-policies). ## Configure networking -If your organization members connect through an HTTP proxy server or firewall, add the required URLs to the allowlist. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/configuring-your-proxy-server-or-firewall-for-copilot). +If your organization members connect through an HTTP proxy server or firewall, add the required URLs to the allowlist. See [AUTOTITLE](/copilot/reference/copilot-allowlist-reference). -If your environment uses custom SSL certificates, install them on your members' machines. See [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/configuring-network-settings-for-github-copilot#-installing-custom-certificates). +If your environment uses custom SSL certificates, install them on your members' machines. See [AUTOTITLE](/copilot/how-tos/configure-personal-settings/configure-network-settings#-installing-custom-certificates). ## Grant access to members -Enable {% data variables.product.prodname_copilot_short %} for some or all members of your organization. Consider starting with teams most likely to benefit, to discover potential blockers and demonstrate early success. 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). +Enable {% data variables.product.prodname_copilot_short %} for some or all members of your organization. Consider starting with teams most likely to benefit, to discover potential blockers and demonstrate early success. See [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/manage-access/grant-access). -> [!TIP] If your organization belongs to an enterprise on {% data variables.enterprise.data_residency_site %}, users need additional setup to authenticate from their development environment. See [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/using-github-copilot-with-an-account-on-ghecom). +> [!TIP] If your organization belongs to an enterprise on {% data variables.enterprise.data_residency_site %}, users need additional setup to authenticate from their development environment. See [AUTOTITLE](/copilot/how-tos/configure-personal-settings/authenticate-to-ghecom). ## Next steps diff --git a/content/copilot/how-tos/copilot-on-github/set-up-copilot/enable-copilot/set-up-for-self.md b/content/copilot/how-tos/copilot-on-github/set-up-copilot/enable-copilot/set-up-for-self.md index be3d7e83fdfb..a3381360a165 100644 --- a/content/copilot/how-tos/copilot-on-github/set-up-copilot/enable-copilot/set-up-for-self.md +++ b/content/copilot/how-tos/copilot-on-github/set-up-copilot/enable-copilot/set-up-for-self.md @@ -21,7 +21,7 @@ If you have your own {% data variables.product.prodname_copilot_short %} plan, m ## Set up personal custom instructions (optional) -Personal custom instructions tell {% data variables.copilot.copilot_chat_short %} about your preferences — such as your preferred language, coding style, or response format. To add them, open any {% data variables.copilot.copilot_chat_short %} conversation on {% data variables.product.github %}, click your profile picture, and select **Personal instructions**. For more information, see [AUTOTITLE](/copilot/how-tos/configure-custom-instructions/add-personal-instructions). +Personal custom instructions tell {% data variables.copilot.copilot_chat_short %} about your preferences — such as your preferred language, coding style, or response format. To add them, open any {% data variables.copilot.copilot_chat_short %} conversation on {% data variables.product.github %}, click your profile picture, and select **Personal instructions**. For more information, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-personal-instructions). ## Next step diff --git a/content/copilot/how-tos/copilot-on-github/set-up-copilot/enable-copilot/set-up-for-students.md b/content/copilot/how-tos/copilot-on-github/set-up-copilot/enable-copilot/set-up-for-students.md index 76be9fc4cc96..c00e0de29550 100644 --- a/content/copilot/how-tos/copilot-on-github/set-up-copilot/enable-copilot/set-up-for-students.md +++ b/content/copilot/how-tos/copilot-on-github/set-up-copilot/enable-copilot/set-up-for-students.md @@ -16,7 +16,7 @@ category: Verified students on {% data variables.product.prodname_education %} get **free access to {% data variables.product.prodname_copilot_short %}'s features**. See [AUTOTITLE](/copilot/concepts/billing/individual-plans#github-copilot-student). -To become a verified student, see [AUTOTITLE](/free-pro-team@latest/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-students/apply-to-github-education-as-a-student). +To become a verified student, see [AUTOTITLE](/free-pro-team@latest/education/about-github-education/github-education-for-students/apply-to-github-education-as-a-student). {% data variables.product.company_short %} reevaluates your eligibility every month. @@ -26,4 +26,4 @@ To become a verified student, see [AUTOTITLE](/free-pro-team@latest/education/ex If you are not yet a verified student, click **Start an application** and complete the verification process. 1. Under "Free {% data variables.product.github %} developer resources for students and teachers", click **Learn more**. -1. Follow the prompts to activate {% data variables.copilot.copilot_student_short %}, configuring the {% data variables.product.prodname_copilot_short %} use policies to meet your needs. \ No newline at end of file +1. Follow the prompts to activate {% data variables.copilot.copilot_student_short %}, configuring the {% data variables.product.prodname_copilot_short %} use policies to meet your needs. diff --git a/content/copilot/how-tos/copilot-on-github/set-up-copilot/enable-copilot/set-up-for-teachers-and-os-maintainers.md b/content/copilot/how-tos/copilot-on-github/set-up-copilot/enable-copilot/set-up-for-teachers-and-os-maintainers.md index 77d92b20b996..e56e808cdbe0 100644 --- a/content/copilot/how-tos/copilot-on-github/set-up-copilot/enable-copilot/set-up-for-teachers-and-os-maintainers.md +++ b/content/copilot/how-tos/copilot-on-github/set-up-copilot/enable-copilot/set-up-for-teachers-and-os-maintainers.md @@ -21,7 +21,7 @@ category: There are two ways to qualify for free access to {% data variables.copilot.copilot_pro_short %}: -* **As a verified teacher on {% data variables.product.prodname_education %}.** To become a verified teacher, see [AUTOTITLE](/free-pro-team@latest/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-teachers/apply-to-github-education-as-a-teacher). +* **As a verified teacher on {% data variables.product.prodname_education %}.** To become a verified teacher, see [AUTOTITLE](/free-pro-team@latest/education/about-github-education/github-education-for-teachers/apply-to-github-education-as-a-teacher). * **As a maintainer of a popular open-source repository.** To check your eligibility, see [Accessing {% data variables.copilot.copilot_pro_short %} for free](#accessing-copilot-pro-for-free). {% data variables.product.company_short %} reevaluates your eligibility every month. @@ -31,7 +31,7 @@ There are two ways to qualify for free access to {% data variables.copilot.copil If you do not meet the previous criteria, you can do one of the following: * Subscribe to [{% data variables.copilot.copilot_pro_short %}](https://github.com/github-copilot/signup?ref_product=copilot&ref_type=purchase&ref_style=text&ref_plan=pro), [{% data variables.copilot.copilot_pro_plus_short %}](https://github.com/github-copilot/signup?ref_product=copilot&ref_type=purchase&ref_style=text&ref_plan=pro), or [{% data variables.copilot.copilot_max_short %}](https://github.com/settings/billing/licensing?ref_product=copilot&ref_type=purchase&ref_style=text&ref_plan=max) for a paid plan with access to premium models. -* Set up {% data variables.copilot.copilot_free_short %} to get a limited experience of {% data variables.product.prodname_copilot_short %} without a paid plan. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/about-github-copilot-free). +* Set up {% data variables.copilot.copilot_free_short %} to get a limited experience of {% data variables.product.prodname_copilot_short %} without a paid plan. See [AUTOTITLE](/copilot/concepts/billing/individual-plans). ## Accessing {% data variables.copilot.copilot_pro_short %} for free diff --git a/content/copilot/how-tos/copilot-on-github/use-copilot-agents/copilot-code-review.md b/content/copilot/how-tos/copilot-on-github/use-copilot-agents/copilot-code-review.md index de25059273e5..95a5eaf6f594 100644 --- a/content/copilot/how-tos/copilot-on-github/use-copilot-agents/copilot-code-review.md +++ b/content/copilot/how-tos/copilot-on-github/use-copilot-agents/copilot-code-review.md @@ -64,7 +64,7 @@ When re-reviewing, {% data variables.product.prodname_copilot_short %} may repea ## Enable automatic reviews -By default, you request reviews from {% data variables.product.prodname_copilot_short %} manually on each pull request. To enable automatic reviews for all pull requests, see [AUTOTITLE](/copilot/how-tos/agents/copilot-code-review/automatic-code-review). +By default, you request reviews from {% data variables.product.prodname_copilot_short %} manually on each pull request. To enable automatic reviews for all pull requests, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/set-up-copilot/configure-automatic-review). ## Customize reviews with custom instructions @@ -87,5 +87,5 @@ To make these available for {% data variables.copilot.copilot_code-review_short ## Further reading -* [AUTOTITLE](/copilot/concepts/code-review) +* [AUTOTITLE](/copilot/concepts/agents/code-review) * [AUTOTITLE](/copilot/how-tos/copilot-on-github/use-copilot-agents/review-copilot-output) diff --git a/content/copilot/how-tos/copilot-sdk/troubleshooting/debugging.md b/content/copilot/how-tos/copilot-sdk/troubleshooting/debugging.md index 301053a71553..72d819632cd5 100644 --- a/content/copilot/how-tos/copilot-sdk/troubleshooting/debugging.md +++ b/content/copilot/how-tos/copilot-sdk/troubleshooting/debugging.md @@ -193,7 +193,7 @@ var client = new CopilotClient(new CopilotClientOptions **Solution:** -1. Install the CLI: [Installation guide](/copilot/how-tos/set-up/install-copilot-cli) +1. Install the CLI: [Installation guide](/copilot/how-tos/copilot-cli/set-up-copilot-cli/install-copilot-cli) 1. Verify installation: diff --git a/content/copilot/how-tos/get-code-suggestions/find-matching-code.md b/content/copilot/how-tos/get-code-suggestions/find-matching-code.md index f6da4c4326cd..a7d72c09a635 100644 --- a/content/copilot/how-tos/get-code-suggestions/find-matching-code.md +++ b/content/copilot/how-tos/get-code-suggestions/find-matching-code.md @@ -47,7 +47,7 @@ If you allow {% data variables.product.prodname_copilot %} to make suggestions t References to matching code are only generated if you use a product that does not support "Block" mode, or if {% data variables.product.prodname_copilot_short %} is configured to allow suggestions that match publicly available code. This is configured in either your personal{% ifversion ghec %},{% else %} or {% endif %} organization{% ifversion ghec %} or enterprise{% endif %} settings. -For more information, see [AUTOTITLE](/copilot/configuring-github-copilot/configuring-your-personal-github-copilot-settings-on-githubcom#enabling-or-disabling-suggestions-matching-public-code){% ifversion ghec %},{% else %} or {% endif %} [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching){% ifversion ghec %} or [AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise){% endif %}. +For more information, see [AUTOTITLE](/copilot/how-tos/manage-your-account/manage-policies#enabling-or-disabling-suggestions-matching-public-code){% ifversion ghec %},{% else %} or {% endif %} [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/manage-policies#policies-for-suggestion-matching){% ifversion ghec %} or [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-enterprise-policies){% endif %}. {% jetbrains %} diff --git a/content/copilot/how-tos/get-code-suggestions/get-ide-code-suggestions.md b/content/copilot/how-tos/get-code-suggestions/get-ide-code-suggestions.md index af41fd3c02db..f44c56bf5a1f 100644 --- a/content/copilot/how-tos/get-code-suggestions/get-ide-code-suggestions.md +++ b/content/copilot/how-tos/get-code-suggestions/get-ide-code-suggestions.md @@ -72,7 +72,7 @@ void process () { {% data variables.product.prodname_copilot %} will attempt to match the context and style of your code. You can always edit the suggested code. > [!TIP] -> If you receive limited or no suggestions from {% data variables.product.prodname_copilot_short %}, you may have duplication detection enabled. For more information about duplication detection, see [AUTOTITLE](/copilot/configuring-github-copilot/configuring-your-personal-github-copilot-settings-on-githubcom#enabling-or-disabling-suggestions-matching-public-code). +> If you receive limited or no suggestions from {% data variables.product.prodname_copilot_short %}, you may have duplication detection enabled. For more information about duplication detection, see [AUTOTITLE](/copilot/how-tos/manage-your-account/manage-policies#enabling-or-disabling-suggestions-matching-public-code). ## Showing alternative suggestions @@ -133,7 +133,7 @@ Alternatively, you can use a keyboard shortcut to accept the next word of a sugg |macOS|Command+→|Command+Control+→| |Windows or Linux|Control+→|Control+Alt+→| -If you want to accept the next line of a suggestion, you will need to set a custom keyboard shortcut for the command `editor.action.inlineSuggest.acceptNextLine`. For more information on setting custom keyboard shortcuts, see [AUTOTITLE](/copilot/configuring-github-copilot/configuring-github-copilot-in-your-environment). +If you want to accept the next line of a suggestion, you will need to set a custom keyboard shortcut for the command `editor.action.inlineSuggest.acceptNextLine`. For more information on setting custom keyboard shortcuts, see [AUTOTITLE](/copilot/how-tos/configure-personal-settings/configure-in-ide). {% endjetbrains %} @@ -177,7 +177,7 @@ var doc = XDocument.Load("index.xhml"); {% data variables.product.prodname_copilot %} will suggest an implementation of the function. {% data reusables.copilot.accept-suggestion %} > [!TIP] -> If you receive limited or no suggestions from {% data variables.product.prodname_copilot_short %}, you may have duplication detection enabled. For more information about duplication detection, see [AUTOTITLE](/copilot/configuring-github-copilot/configuring-your-personal-github-copilot-settings-on-githubcom#enabling-or-disabling-suggestions-matching-public-code). +> If you receive limited or no suggestions from {% data variables.product.prodname_copilot_short %}, you may have duplication detection enabled. For more information about duplication detection, see [AUTOTITLE](/copilot/how-tos/manage-your-account/manage-policies#enabling-or-disabling-suggestions-matching-public-code). ## Showing alternative suggestions @@ -291,7 +291,7 @@ You can also describe something you want to do using natural language within a c {% data variables.product.prodname_copilot %} will automatically suggest code. {% data reusables.copilot.accept-suggestion %} > [!TIP] -> If you receive limited or no suggestions from {% data variables.product.prodname_copilot_short %}, you may have duplication detection enabled. For more information about duplication detection, see [AUTOTITLE](/copilot/configuring-github-copilot/configuring-your-personal-github-copilot-settings-on-githubcom#enabling-or-disabling-suggestions-matching-public-code). +> If you receive limited or no suggestions from {% data variables.product.prodname_copilot_short %}, you may have duplication detection enabled. For more information about duplication detection, see [AUTOTITLE](/copilot/how-tos/manage-your-account/manage-policies#enabling-or-disabling-suggestions-matching-public-code). ## Showing alternative suggestions @@ -351,7 +351,7 @@ Alternatively, you can use a keyboard shortcut to accept the next word of a sugg |macOS|Command+→| |Windows or Linux |Control+→| -If you want to accept the next line of a suggestion, you will need to set a custom keyboard shortcut for the command `editor.action.inlineSuggest.acceptNextLine`. For more information on setting custom keyboard shortcuts, see [AUTOTITLE](/copilot/configuring-github-copilot/configuring-github-copilot-in-your-environment). +If you want to accept the next line of a suggestion, you will need to set a custom keyboard shortcut for the command `editor.action.inlineSuggest.acceptNextLine`. For more information on setting custom keyboard shortcuts, see [AUTOTITLE](/copilot/how-tos/configure-personal-settings/configure-in-ide). ## Navigating and accepting {% data variables.copilot.next_edit_suggestions %} @@ -383,7 +383,7 @@ This guide demonstrates how to get coding suggestions from {% data variables.pro * **Compatible version of Vim/Neovim**. To use {% data variables.product.prodname_copilot %} in Vim/Neovim you must have Vim version 9.0.0185 / Neovim version 0.6 or above and Node.js version 18 or above installed. For more information, see the [Vim](https://vimhelp.org/) / [Neovim documentation](https://neovim.io/doc/) and the [Node.js website](https://nodejs.org/en/). -* **{% data variables.product.prodname_copilot %} extension for Vim/Neovim**. To use {% data variables.product.prodname_copilot %} in Vim/Neovim, you must install the {% data variables.product.prodname_copilot %} plugin. For more information, see [AUTOTITLE](/copilot/configuring-github-copilot/installing-the-github-copilot-extension-in-your-environment). +* **{% data variables.product.prodname_copilot %} extension for Vim/Neovim**. To use {% data variables.product.prodname_copilot %} in Vim/Neovim, you must install the {% data variables.product.prodname_copilot %} plugin. For more information, see [AUTOTITLE](/copilot/how-tos/set-up/install-copilot-extension). ## Learning to use {% data variables.product.prodname_copilot %} in Vim/Neovim @@ -409,7 +409,7 @@ This guide demonstrates how to get coding suggestions from {% data variables.pro * **Compatible version of Azure Data Studio**. To use {% data variables.product.prodname_copilot %} in Azure Data Studio, you must have Azure Data Studio version 1.44.0 or later installed. For more information, see the [Azure Data Studio download page](https://docs.microsoft.com/sql/azure-data-studio/download-azure-data-studio) in the Azure Data Studio documentation. -* **{% data variables.product.prodname_copilot %} extension for Azure Data Studio**. To use {% data variables.product.prodname_copilot %} in Azure Data Studio, you must install the {% data variables.product.prodname_copilot %} extension. For more information, see [AUTOTITLE](/copilot/configuring-github-copilot/installing-the-github-copilot-extension-in-your-environment). +* **{% data variables.product.prodname_copilot %} extension for Azure Data Studio**. To use {% data variables.product.prodname_copilot %} in Azure Data Studio, you must install the {% data variables.product.prodname_copilot %} extension. For more information, see [AUTOTITLE](/copilot/how-tos/set-up/install-copilot-extension). ## Getting code suggestions @@ -439,7 +439,7 @@ SELECT [Purple], [Blue], [Green], [Yellow], [Orange], [Red] {% data variables.product.prodname_copilot %} will automatically suggest code. {% data reusables.copilot.accept-suggestion %} > [!TIP] - > If you receive limited or no suggestions from {% data variables.product.prodname_copilot_short %}, you may have duplication detection enabled. For more information on duplication detection, see [AUTOTITLE](/copilot/configuring-github-copilot/configuring-your-personal-github-copilot-settings-on-githubcom#enabling-or-disabling-suggestions-matching-public-code). + > If you receive limited or no suggestions from {% data variables.product.prodname_copilot_short %}, you may have duplication detection enabled. For more information on duplication detection, see [AUTOTITLE](/copilot/how-tos/manage-your-account/manage-policies#enabling-or-disabling-suggestions-matching-public-code). ## Showing alternative suggestions @@ -503,7 +503,7 @@ This guide demonstrates how to get coding suggestions from {% data variables.pro * **Access to {% data variables.product.prodname_copilot_short %}**. To use {% data variables.product.prodname_copilot %} in Xcode, you need either limited access through {% data variables.copilot.copilot_free_short %} or a paid {% data variables.product.prodname_copilot_short %} plan for full access. {% data reusables.copilot.subscription-prerequisite %} -* **{% data variables.product.prodname_copilot %} extension for Xcode**. To use {% data variables.product.prodname_copilot %} for Xcode, you must install the {% data variables.product.prodname_copilot %} for Xcode extension. See [AUTOTITLE](/copilot/configuring-github-copilot/installing-the-github-copilot-extension-in-your-environment). +* **{% data variables.product.prodname_copilot %} extension for Xcode**. To use {% data variables.product.prodname_copilot %} for Xcode, you must install the {% data variables.product.prodname_copilot %} for Xcode extension. See [AUTOTITLE](/copilot/how-tos/set-up/install-copilot-extension). ## Getting code suggestions @@ -521,7 +521,7 @@ func calculateDaysBetweenDates( If you encounter issues with code suggestions, such as conflicting or missing suggestions, you can try the following: * **Disable Xcode's native predictive text completion:** To avoid receiving two sets of code suggestions, you can disable Xcode's native predictive text completion. You can find this setting in the Xcode settings in the "Editing" tab under "Text Editing." -* **Check for duplication detection in {% data variables.product.prodname_copilot_short %}:** If you receive limited or no suggestions from {% data variables.product.prodname_copilot_short %}, you may have duplication detection enabled. For more information on duplication detection, see [AUTOTITLE](/copilot/configuring-github-copilot/configuring-your-personal-github-copilot-settings-on-githubcom#enabling-or-disabling-suggestions-matching-public-code). +* **Check for duplication detection in {% data variables.product.prodname_copilot_short %}:** If you receive limited or no suggestions from {% data variables.product.prodname_copilot_short %}, you may have duplication detection enabled. For more information on duplication detection, see [AUTOTITLE](/copilot/how-tos/manage-your-account/manage-policies#enabling-or-disabling-suggestions-matching-public-code). * **Check for updates and restart Xcode:** Ensure you have the latest version of {% data variables.product.prodname_copilot_short %} for Xcode in the extension application and restart Xcode. You can also open an issue in the [{% data variables.product.prodname_copilot_short %} for Xcode repository](https://github.com/github/CopilotForXcode). @@ -548,7 +548,7 @@ This guide demonstrates how to get coding suggestions from {% data variables.pro * **Access to {% data variables.product.prodname_copilot_short %}**. To use {% data variables.product.prodname_copilot %} in Eclipse, you need either limited access through {% data variables.copilot.copilot_free_short %} or a paid {% data variables.product.prodname_copilot_short %} plan for full access. {% data reusables.copilot.subscription-prerequisite %} -* **{% data variables.product.prodname_copilot %} extension for Eclipse**.To use {% data variables.product.prodname_copilot %} in Eclipse, you must install the {% data variables.product.prodname_copilot %} extension. See [AUTOTITLE](/copilot/configuring-github-copilot/installing-the-github-copilot-extension-in-your-environment?tool=eclipse). +* **{% data variables.product.prodname_copilot %} extension for Eclipse**. To use {% data variables.product.prodname_copilot %} in Eclipse, you must install the {% data variables.product.prodname_copilot %} extension. See [AUTOTITLE](/copilot/how-tos/set-up/install-copilot-extension?tool=eclipse). ## Getting code suggestions @@ -572,7 +572,7 @@ You can also describe something you want to do using natural language within a c {% data variables.product.prodname_copilot %} will automatically suggest code. > [!TIP] -> If you receive limited or no suggestions from {% data variables.product.prodname_copilot_short %}, you may have duplication detection enabled. For more information about duplication detection, see [AUTOTITLE](/copilot/configuring-github-copilot/configuring-your-personal-github-copilot-settings-on-githubcom#enabling-or-disabling-suggestions-matching-public-code). +> If you receive limited or no suggestions from {% data variables.product.prodname_copilot_short %}, you may have duplication detection enabled. For more information about duplication detection, see [AUTOTITLE](/copilot/how-tos/manage-your-account/manage-policies#enabling-or-disabling-suggestions-matching-public-code). ## Manually triggering inline suggestions @@ -606,10 +606,10 @@ An arrow in the gutter indicates an available edit suggestion. Hover over the ar ## Next steps -* **Learn how to write effective prompts** - See [AUTOTITLE](/copilot/using-github-copilot/copilot-chat/prompt-engineering-for-copilot-chat). -* **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). -* **Get started with {% data variables.copilot.copilot_chat %}** - Learn how to ask {% data variables.product.prodname_copilot_short %} for information and assistance, using {% data variables.copilot.copilot_chat %}. See [AUTOTITLE](/copilot/github-copilot-chat/using-github-copilot-chat-in-your-ide){% ifversion ghec %} and [AUTOTITLE](/copilot/github-copilot-enterprise/copilot-chat-in-github/using-github-copilot-chat-in-githubcom){% endif %}. -* **Troubleshoot issues** - Learn more about how to troubleshoot common issues with {% data variables.product.prodname_copilot %}. See [AUTOTITLE](/copilot/troubleshooting-github-copilot). +* **Learn how to write effective prompts** - See [AUTOTITLE](/copilot/concepts/prompting/prompt-engineering). +* **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/how-tos/configure-personal-settings/configure-in-ide). +* **Get started with {% data variables.copilot.copilot_chat %}** - Learn how to ask {% data variables.product.prodname_copilot_short %} for information and assistance, using {% data variables.copilot.copilot_chat %}. See [AUTOTITLE](/copilot/how-tos/chat-with-copilot/chat-in-ide){% ifversion ghec %} and [AUTOTITLE](/copilot/how-tos/copilot-on-github/chat-with-copilot/chat-in-github){% endif %}. +* **Troubleshoot issues** - Learn more about how to troubleshoot common issues with {% data variables.product.prodname_copilot %}. See [AUTOTITLE](/copilot/how-tos/troubleshoot-copilot). ## Further reading diff --git a/content/copilot/how-tos/github-copilot-app/customize-github-copilot-app.md b/content/copilot/how-tos/github-copilot-app/customize-github-copilot-app.md index 40e64476e92c..6e103d878661 100644 --- a/content/copilot/how-tos/github-copilot-app/customize-github-copilot-app.md +++ b/content/copilot/how-tos/github-copilot-app/customize-github-copilot-app.md @@ -48,7 +48,7 @@ Plugins are installable packages that add a preconfigured set of capabilities, s To browse and install plugins, open app settings, then click **Plugins**. -For more information, see [AUTOTITLE](/copilot/concepts/agents/copilot-cli/about-cli-plugins). +For more information, see [AUTOTITLE](/copilot/concepts/agents/about-plugins). ## Working with canvas extensions diff --git a/content/copilot/how-tos/manage-and-track-spending/manage-company-spending.md b/content/copilot/how-tos/manage-and-track-spending/manage-company-spending.md index 30bb6b6747f8..b1434f4b9418 100644 --- a/content/copilot/how-tos/manage-and-track-spending/manage-company-spending.md +++ b/content/copilot/how-tos/manage-and-track-spending/manage-company-spending.md @@ -86,6 +86,6 @@ If you're not sure how best to distribute licenses, {% data variables.product.co For detailed guidance, see: -* [AUTOTITLE](/copilot/rolling-out-github-copilot-at-scale/driving-copilot-adoption-in-your-company) -* [AUTOTITLE](/copilot/rolling-out-github-copilot-at-scale/setting-up-a-self-serve-process-for-github-copilot-licenses) -* [AUTOTITLE](/copilot/rolling-out-github-copilot-at-scale/reminding-inactive-users) +* [AUTOTITLE](/copilot/tutorials/roll-out-at-scale/enable-developers/drive-adoption) +* [AUTOTITLE](/copilot/tutorials/roll-out-at-scale/assign-licenses/set-up-self-serve-licenses) +* [AUTOTITLE](/copilot/tutorials/roll-out-at-scale/assign-licenses/remind-inactive-users) diff --git a/content/copilot/how-tos/manage-your-account/disable-copilot-free.md b/content/copilot/how-tos/manage-your-account/disable-copilot-free.md index ecbd92624520..325121e4ec94 100644 --- a/content/copilot/how-tos/manage-your-account/disable-copilot-free.md +++ b/content/copilot/how-tos/manage-your-account/disable-copilot-free.md @@ -28,7 +28,7 @@ You can disable {% data variables.copilot.copilot_free_short %} in your {% data You can partially or fully disable {% data variables.copilot.copilot_free_short %} in JetBrains IDEs, {% data variables.product.prodname_vscode_shortname %}, {% data variables.product.prodname_vs %}, and XCode: -1. Navigate to [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/configuring-github-copilot-in-your-environment). +1. Navigate to [AUTOTITLE](/copilot/how-tos/configure-personal-settings/configure-in-ide). 1. At the top of the page, select your IDE. 1. At the top right of the page, under "In this article," select **Enabling or disabling {% data variables.product.prodname_copilot_short %}**. 1. Follow the instructions to disable {% data variables.copilot.copilot_free_short %} in your IDE. diff --git a/content/copilot/how-tos/manage-your-account/get-started-with-a-copilot-plan.md b/content/copilot/how-tos/manage-your-account/get-started-with-a-copilot-plan.md index ea121fa8c561..723ddc65d3a6 100644 --- a/content/copilot/how-tos/manage-your-account/get-started-with-a-copilot-plan.md +++ b/content/copilot/how-tos/manage-your-account/get-started-with-a-copilot-plan.md @@ -84,7 +84,7 @@ If you’re already using {% data variables.copilot.copilot_free_short %} and re You can subscribe to {% data variables.copilot.copilot_pro_short %}, {% data variables.copilot.copilot_pro_plus_short %}, or {% data variables.copilot.copilot_max_short %} at any time to unlock advanced AI features, higher usage limits, and access to additional models. -> [!TIP] Not sure which plan to choose? For a side-by-side comparison, see [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/getting-started-with-copilot-on-your-personal-account/about-individual-copilot-plans-and-benefits). +> [!TIP] Not sure which plan to choose? For a side-by-side comparison, see [AUTOTITLE](/copilot/concepts/billing/individual-plans). 1. Go to the [plans page](https://github.com/features/copilot/plans?ref_product=copilot&ref_type=purchase&ref_style=text&ref_plan=pro). 1. Click **Get started** under the plan you want to subscribe to. diff --git a/content/copilot/how-tos/manage-your-account/manage-policies.md b/content/copilot/how-tos/manage-your-account/manage-policies.md index 2a2a74b572cc..b10eba5cd0c2 100644 --- a/content/copilot/how-tos/manage-your-account/manage-policies.md +++ b/content/copilot/how-tos/manage-your-account/manage-policies.md @@ -30,7 +30,7 @@ Your personal settings for {% data variables.product.prodname_copilot %} include If you choose to block suggestions matching public code, in most {% data variables.product.prodname_copilot %} products, {% data variables.product.prodname_copilot %} checks code suggestions with their surrounding code of about 150 characters against public code on {% data variables.product.prodname_dotcom %}. If there is a match, or a near match, the suggestion is not shown to you. -If you choose to allow suggestions matching public code or use a product that does not support "Block" mode, when {% data variables.product.prodname_copilot_short %} suggests matching code you can display details of the matches and click through to the relevant repositories on {% data variables.product.prodname_dotcom %}. For more information, see [AUTOTITLE](/copilot/using-github-copilot/finding-public-code-that-matches-github-copilot-suggestions). +If you choose to allow suggestions matching public code or use a product that does not support "Block" mode, when {% data variables.product.prodname_copilot_short %} suggests matching code you can display details of the matches and click through to the relevant repositories on {% data variables.product.prodname_dotcom %}. For more information, see [AUTOTITLE](/copilot/how-tos/get-code-suggestions/find-matching-code). {% data reusables.user-settings.copilot-settings %} 1. To the right of **Suggestions matching public code**, select the dropdown menu, then click **Allow** to allow suggestions matching public code, or **Block** to block suggestions matching public code. diff --git a/content/copilot/how-tos/manage-your-account/view-and-change-your-copilot-plan.md b/content/copilot/how-tos/manage-your-account/view-and-change-your-copilot-plan.md index 71b0528ee06a..b00816ee8614 100644 --- a/content/copilot/how-tos/manage-your-account/view-and-change-your-copilot-plan.md +++ b/content/copilot/how-tos/manage-your-account/view-and-change-your-copilot-plan.md @@ -65,7 +65,7 @@ You can upgrade or downgrade your {% data variables.product.prodname_copilot_sho You can cancel your {% data variables.product.prodname_copilot_short %} plan at any time. You’ll retain access to your current features until your billing cycle ends. You will automatically be downgraded to {% data variables.copilot.copilot_free_short %} at the end of your billing cycle. -If you have been granted free access to {% data variables.product.prodname_copilot_short %} as a verified student, teacher, or maintainer of a popular open source project, you won’t be able to cancel your plan. If you have access to {% data variables.product.prodname_copilot_short %} through an organization or enterprise, you will not be able to cancel your plan. In these cases, you can disable {% data variables.product.prodname_copilot_short %} in your environment. See [AUTOTITLE](/copilot/configuring-github-copilot/configuring-github-copilot-in-your-environment). +If you have been granted free access to {% data variables.product.prodname_copilot_short %} as a verified student, teacher, or maintainer of a popular open source project, you won’t be able to cancel your plan. If you have access to {% data variables.product.prodname_copilot_short %} through an organization or enterprise, you will not be able to cancel your plan. In these cases, you can disable {% data variables.product.prodname_copilot_short %} in your environment. See [AUTOTITLE](/copilot/how-tos/configure-personal-settings/configure-in-ide). {% data reusables.copilot.copilot-one-account-short %} diff --git a/content/copilot/how-tos/provide-context/use-copilot-spaces/use-copilot-spaces.md b/content/copilot/how-tos/provide-context/use-copilot-spaces/use-copilot-spaces.md index c6b7d169b3f5..688bcf6dcfaa 100644 --- a/content/copilot/how-tos/provide-context/use-copilot-spaces/use-copilot-spaces.md +++ b/content/copilot/how-tos/provide-context/use-copilot-spaces/use-copilot-spaces.md @@ -10,7 +10,7 @@ category: - Author and optimize with Copilot --- -For information on creating {% data variables.copilot.copilot_spaces %}, see [AUTOTITLE](/copilot/how-tos/provide-context/use-copilot-spaces/create-copilot-spaces). +For information on creating {% data variables.copilot.copilot_spaces %}, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/copilot-spaces/create-copilot-spaces). ## Using {% data variables.copilot.copilot_spaces %} in your IDE @@ -30,7 +30,7 @@ Once you've accessed space context from your IDE: To use {% data variables.copilot.copilot_spaces_short %} in your IDE, you need to: -* Set up the remote {% data variables.product.github %} MCP server for your IDE. For more information, see [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp/set-up-the-github-mcp-server) and [Remote {% data variables.product.github %} MCP Server](https://github.com/github/github-mcp-server/blob/main/docs/remote-server.md) in the {% data variables.product.github %} MCP server documentation. +* Set up the remote {% data variables.product.github %} MCP server for your IDE. For more information, see [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp-in-your-ide/set-up-the-github-mcp-server) and [Remote {% data variables.product.github %} MCP Server](https://github.com/github/github-mcp-server/blob/main/docs/remote-server.md) in the {% data variables.product.github %} MCP server documentation. * Configure the remote {% data variables.product.github %} MCP server so that the {% data variables.copilot.copilot_spaces_short %} toolset is enabled. The {% data variables.copilot.copilot_spaces_short %} toolset is not included in the default configuration, so you must explicitly enable it using the `X-MCP-Toolsets` header. The following example configuration enables both the default tools and {% data variables.copilot.copilot_spaces_short %}: @@ -53,7 +53,7 @@ To use {% data variables.copilot.copilot_spaces_short %} in your IDE, you need t ### Accessing space context from your IDE -For more detailed information on using the {% data variables.product.github %} MCP server in a specific IDE, see [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp/use-the-github-mcp-server). +For more detailed information on using the {% data variables.product.github %} MCP server in a specific IDE, see [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp-in-your-ide/use-the-github-mcp-server). Note that {% data variables.copilot.copilot_spaces_short %} can only be used in agent mode in your IDE, since spaces are accessed via the {% data variables.product.github %} MCP server. @@ -70,5 +70,5 @@ Note that {% data variables.copilot.copilot_spaces_short %} can only be used in ## Next steps -* To learn more about how to use {% data variables.copilot.copilot_spaces_short %} to help you with development work, see [AUTOTITLE](/copilot/using-github-copilot/copilot-spaces/speeding-up-development-work-with-copilot-spaces). -* To learn how to share your space with your team, see [AUTOTITLE](/copilot/using-github-copilot/copilot-spaces/collaborating-with-your-team-using-copilot-spaces). +* To learn more about how to use {% data variables.copilot.copilot_spaces_short %} to help you with development work, see [AUTOTITLE](/copilot/tutorials/speed-up-development-work). +* To learn how to share your space with your team, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/copilot-spaces/collaborate-with-others). diff --git a/content/copilot/how-tos/provide-context/use-mcp-in-your-ide/configure-toolsets.md b/content/copilot/how-tos/provide-context/use-mcp-in-your-ide/configure-toolsets.md index 1ced4190fdc4..a5f57fa5775e 100644 --- a/content/copilot/how-tos/provide-context/use-mcp-in-your-ide/configure-toolsets.md +++ b/content/copilot/how-tos/provide-context/use-mcp-in-your-ide/configure-toolsets.md @@ -42,5 +42,5 @@ For detailed setup instructions, see [Local {% data variables.product.github %} ## Further reading -* [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp/set-up-the-github-mcp-server) -* [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp/use-the-github-mcp-server) +* [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp-in-your-ide/set-up-the-github-mcp-server) +* [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp-in-your-ide/use-the-github-mcp-server) diff --git a/content/copilot/how-tos/provide-context/use-mcp-in-your-ide/enterprise-configuration.md b/content/copilot/how-tos/provide-context/use-mcp-in-your-ide/enterprise-configuration.md index 4cfcd9610eb3..3e1345dafdfd 100644 --- a/content/copilot/how-tos/provide-context/use-mcp-in-your-ide/enterprise-configuration.md +++ b/content/copilot/how-tos/provide-context/use-mcp-in-your-ide/enterprise-configuration.md @@ -27,7 +27,7 @@ The {% data variables.product.github %} MCP server supports two enterprise deplo ## Prerequisites * A {% data variables.product.prodname_ghe_server %} instance or {% data variables.product.prodname_ghe_cloud %} account with {% data variables.enterprise.data_residency_short %} -* The {% data variables.product.github %} MCP server configured in your editor. See [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp/set-up-the-github-mcp-server). +* The {% data variables.product.github %} MCP server configured in your editor. See [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp-in-your-ide/set-up-the-github-mcp-server). ## Configuring the remote MCP server for {% data variables.enterprise.data_residency %} @@ -646,5 +646,5 @@ Replace `YOUR_GHES_OR_GHEC_HOSTNAME` with your {% data variables.product.prodnam ## Next steps -* To learn how to use the {% data variables.product.github %} MCP server, see [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp/use-the-github-mcp-server). -* To learn how to configure toolsets for the {% data variables.product.github %} MCP server, see [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp/configure-toolsets). +* To learn how to use the {% data variables.product.github %} MCP server, see [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp-in-your-ide/use-the-github-mcp-server). +* To learn how to configure toolsets for the {% data variables.product.github %} MCP server, see [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp-in-your-ide/configure-toolsets). diff --git a/content/copilot/how-tos/provide-context/use-mcp-in-your-ide/extend-copilot-chat-with-mcp.md b/content/copilot/how-tos/provide-context/use-mcp-in-your-ide/extend-copilot-chat-with-mcp.md index 5a317197920b..35b4bb1b50c5 100644 --- a/content/copilot/how-tos/provide-context/use-mcp-in-your-ide/extend-copilot-chat-with-mcp.md +++ b/content/copilot/how-tos/provide-context/use-mcp-in-your-ide/extend-copilot-chat-with-mcp.md @@ -20,7 +20,7 @@ category: ## Introduction -The Model Context Protocol (MCP) is an open standard that defines how applications share context with large language models (LLMs). For an overview of MCP, see [AUTOTITLE](/copilot/concepts/about-mcp). +The Model Context Protocol (MCP) is an open standard that defines how applications share context with large language models (LLMs). For an overview of MCP, see [AUTOTITLE](/copilot/concepts/context/mcp). For a curated list of MCP servers from partners and the community, see the [{% data variables.product.github %} MCP Registry](https://github.com/mcp). @@ -64,7 +64,7 @@ The steps below show how to configure the Fetch MCP server in your `.vscode/mcp. You can use the same steps to configure MCP servers in your personal {% data variables.product.prodname_vscode %} settings. Details on how to configure other MCP servers are available in the [MCP servers repository](https://github.com/modelcontextprotocol/servers/tree/main). -For information on configuring the {% data variables.product.github %} MCP server, see [AUTOTITLE](/copilot/customizing-copilot/using-model-context-protocol/using-the-github-mcp-server). +For information on configuring the {% data variables.product.github %} MCP server, see [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp-in-your-ide/use-the-github-mcp-server). 1. Add the following configuration to your `.vscode/mcp.json` file: @@ -250,7 +250,7 @@ You can use the following configurations as examples: ## Prerequisites * **Access to {% data variables.product.prodname_copilot_short %}**. {% data reusables.copilot.subscription-prerequisite %} -* **{% data variables.product.prodname_copilot %} for Xcode extension**. See [AUTOTITLE](/copilot/configuring-github-copilot/installing-the-github-copilot-extension-in-your-environment). +* **{% data variables.product.prodname_copilot %} for Xcode extension**. See [AUTOTITLE](/copilot/how-tos/set-up/install-copilot-extension). * {% data reusables.copilot.mcp-policy-requirement %} ## Configuring MCP servers from your MCP registry @@ -322,6 +322,6 @@ For more information on creating and configuring your own MCP servers, see [the ## Further reading * [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-copilot/add-mcp-servers) -* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/extend-cloud-agent-with-mcp) -* [AUTOTITLE](/copilot/customizing-copilot/using-model-context-protocol/using-the-github-mcp-server) -* [AUTOTITLE](/copilot/tutorials/enhancing-copilot-agent-mode-with-mcp) +* [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/configure-mcp-servers) +* [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp-in-your-ide/use-the-github-mcp-server) +* [AUTOTITLE](/copilot/tutorials/enhance-agent-mode-with-mcp) diff --git a/content/copilot/how-tos/provide-context/use-mcp-in-your-ide/set-up-the-github-mcp-server.md b/content/copilot/how-tos/provide-context/use-mcp-in-your-ide/set-up-the-github-mcp-server.md index 298ee4c2919f..0fa6ce5e82f3 100644 --- a/content/copilot/how-tos/provide-context/use-mcp-in-your-ide/set-up-the-github-mcp-server.md +++ b/content/copilot/how-tos/provide-context/use-mcp-in-your-ide/set-up-the-github-mcp-server.md @@ -99,7 +99,7 @@ You do not need to create a PAT or install any additional software to use the re ### Remote MCP server configuration with PAT -To configure the remote {% data variables.product.github %} MCP server with a PAT, ensure you have created a PAT with the necessary scopes for the access you want to grant to the MCP server. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token). +To configure the remote {% data variables.product.github %} MCP server with a PAT, ensure you have created a PAT with the necessary scopes for the access you want to grant to the MCP server. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens). 1. In the {% data variables.product.prodname_vs %} menu bar, click **View**, then click **{% data variables.copilot.copilot_chat %}**. 1. At the bottom of the chat panel, select **Agent** from the mode dropdown. @@ -168,7 +168,7 @@ You do not need to create a PAT or install any additional software to use the re ### Remote MCP server configuration with PAT -To configure the remote {% data variables.product.github %} MCP server with a PAT, ensure you have created a PAT with the necessary scopes for the access you want to grant to the MCP server. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token). +To configure the remote {% data variables.product.github %} MCP server with a PAT, ensure you have created a PAT with the necessary scopes for the access you want to grant to the MCP server. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens). {% data reusables.copilot.jetbrains-mcp-setup-steps %} 1. In the `mcp.json` file, add the following configuration, replacing `YOUR_GITHUB_PAT` with the PAT you created: @@ -197,7 +197,7 @@ To configure the remote {% data variables.product.github %} MCP server with a PA ## Prerequisites * **Access to {% data variables.product.prodname_copilot_short %}**. {% data reusables.copilot.subscription-prerequisite %} -* **{% data variables.product.prodname_copilot %} for Xcode extension**. See [AUTOTITLE](/copilot/configuring-github-copilot/installing-the-github-copilot-extension-in-your-environment). +* **{% data variables.product.prodname_copilot %} for Xcode extension**. See [AUTOTITLE](/copilot/how-tos/set-up/install-copilot-extension). * {% data reusables.copilot.mcp-policy-requirement %} ## Setting up the {% data variables.product.github %} MCP server in Xcode @@ -225,7 +225,7 @@ You do not need to create a PAT or install any additional software to use the re ### Remote MCP server configuration with PAT -To configure the remote {% data variables.product.github %} MCP server with a PAT, ensure you have created a PAT with the necessary scopes for the access you want to grant to the MCP server. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token). +To configure the remote {% data variables.product.github %} MCP server with a PAT, ensure you have created a PAT with the necessary scopes for the access you want to grant to the MCP server. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens). {% data reusables.copilot.xcode-mcp-setup-steps %} 1. Add the following configuration, replacing `YOUR_GITHUB_PAT` with the PAT you created: @@ -254,7 +254,7 @@ To configure the remote {% data variables.product.github %} MCP server with a PA ## Prerequisites {% data reusables.copilot.eclipse-prerequisites %} -* **Latest version of the {% data variables.product.prodname_copilot %} extension**. Download this from the [Eclipse Marketplace](https://aka.ms/copiloteclipse?ref_product=copilot&ref_type=engagement&ref_style=text). For more information, see [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/installing-the-github-copilot-extension-in-your-environment?tool=eclipse). +* **Latest version of the {% data variables.product.prodname_copilot %} extension**. Download this from the [Eclipse Marketplace](https://aka.ms/copiloteclipse?ref_product=copilot&ref_type=engagement&ref_style=text). For more information, see [AUTOTITLE](/copilot/how-tos/set-up/install-copilot-extension?tool=eclipse). * **Sign in to {% data variables.product.company_short %} from Eclipse**. ## Setting up the {% data variables.product.github %} MCP server in Eclipse @@ -283,7 +283,7 @@ You do not need to create a PAT or install any additional software to use the re ### Remote MCP server configuration with PAT -To configure the remote {% data variables.product.github %} MCP server with a PAT, ensure you have created a PAT with the necessary scopes for the access you want to grant to the MCP server. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token). +To configure the remote {% data variables.product.github %} MCP server with a PAT, ensure you have created a PAT with the necessary scopes for the access you want to grant to the MCP server. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens). {% data reusables.copilot.eclipse-mcp-setup-steps %} 1. Add the following configuration under "Server Configurations", replacing `YOUR_GITHUB_PAT` with the PAT you created: @@ -307,9 +307,9 @@ To configure the remote {% data variables.product.github %} MCP server with a PA ## Enterprise configuration -If you are using {% data variables.product.prodname_ghe_server %} or {% data variables.product.prodname_ghe_cloud %} with data residency, additional configuration is required. For more information, see [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp/enterprise-configuration). +If you are using {% data variables.product.prodname_ghe_server %} or {% data variables.product.prodname_ghe_cloud %} with data residency, additional configuration is required. For more information, see [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp-in-your-ide/enterprise-configuration). ## Next steps -* To learn how to use the {% data variables.product.github %} MCP server in {% data variables.product.prodname_vscode %}, see [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp/use-the-github-mcp-server). -* For information on configuring individual toolsets with read-only or read/write access, see [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp/configure-toolsets). +* To learn how to use the {% data variables.product.github %} MCP server in {% data variables.product.prodname_vscode %}, see [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp-in-your-ide/use-the-github-mcp-server). +* For information on configuring individual toolsets with read-only or read/write access, see [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp-in-your-ide/configure-toolsets). diff --git a/content/copilot/how-tos/provide-context/use-mcp-in-your-ide/use-the-github-mcp-server.md b/content/copilot/how-tos/provide-context/use-mcp-in-your-ide/use-the-github-mcp-server.md index e64403250ee6..aa2a6716a0a8 100644 --- a/content/copilot/how-tos/provide-context/use-mcp-in-your-ide/use-the-github-mcp-server.md +++ b/content/copilot/how-tos/provide-context/use-mcp-in-your-ide/use-the-github-mcp-server.md @@ -27,7 +27,7 @@ The {% data variables.product.github %} MCP server is available to all {% data v * A {% data variables.product.github %} account. * {% data variables.product.prodname_vscode %}. -* The {% data variables.product.github %} MCP server, configured in your editor. See [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp/set-up-the-github-mcp-server). +* The {% data variables.product.github %} MCP server, configured in your editor. See [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp-in-your-ide/set-up-the-github-mcp-server). * {% data reusables.copilot.mcp-policy-requirement %} ## Using the {% data variables.product.github %} MCP server in {% data variables.product.prodname_vscode %} @@ -56,7 +56,7 @@ The {% data variables.product.github %} MCP server enables you to perform a wide * **Access to {% data variables.product.prodname_copilot_short %}**. {% data reusables.copilot.subscription-prerequisite %} * **{% data variables.product.prodname_vs %} version 17.14 or later**. For more information on installing {% data variables.product.prodname_vs %}, see the [{% data variables.product.prodname_vs %} downloads page](https://visualstudio.microsoft.com/downloads/). -* The {% data variables.product.github %} MCP server, configured in your editor. See [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp/set-up-the-github-mcp-server). +* The {% data variables.product.github %} MCP server, configured in your editor. See [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp-in-your-ide/set-up-the-github-mcp-server). * **Sign in to {% data variables.product.company_short %} from {% data variables.product.prodname_vs %}**. * {% data reusables.copilot.mcp-policy-requirement %} @@ -87,7 +87,7 @@ The {% data variables.product.github %} MCP server enables you to perform a wide {% data reusables.copilot.jetbrains-compatible-ides %} {% data reusables.copilot.jetbrains-plugin-prerequisites %} -* **The {% data variables.product.github %} MCP server**, configured in your editor. See [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp/set-up-the-github-mcp-server). +* **The {% data variables.product.github %} MCP server**, configured in your editor. See [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp-in-your-ide/set-up-the-github-mcp-server). * {% data reusables.copilot.mcp-policy-requirement %} ## Using the {% data variables.product.github %} MCP server in JetBrains IDEs @@ -117,8 +117,8 @@ The {% data variables.product.github %} MCP server enables you to perform a wide ## Prerequisites * **Access to {% data variables.product.prodname_copilot_short %}**. {% data reusables.copilot.subscription-prerequisite %} -* **{% data variables.product.prodname_copilot %} for Xcode extension**. See [AUTOTITLE](/copilot/configuring-github-copilot/installing-the-github-copilot-extension-in-your-environment). -* The {% data variables.product.github %} MCP server, configured in your editor. See [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp/set-up-the-github-mcp-server). +* **{% data variables.product.prodname_copilot %} for Xcode extension**. See [AUTOTITLE](/copilot/how-tos/set-up/install-copilot-extension). +* The {% data variables.product.github %} MCP server, configured in your editor. See [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp-in-your-ide/set-up-the-github-mcp-server). * {% data reusables.copilot.mcp-policy-requirement %} ## Using the {% data variables.product.github %} MCP server in Xcode @@ -146,8 +146,8 @@ The {% data variables.product.github %} MCP server enables you to perform a wide ## Prerequisites {% data reusables.copilot.eclipse-prerequisites %} -* The {% data variables.product.github %} MCP server, configured in your editor. See [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp/set-up-the-github-mcp-server). -* **Latest version of the {% data variables.product.prodname_copilot %} extension**. Download this from the [Eclipse Marketplace](https://aka.ms/copiloteclipse?ref_product=copilot&ref_type=engagement&ref_style=text). For more information, see [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/installing-the-github-copilot-extension-in-your-environment?tool=eclipse). +* The {% data variables.product.github %} MCP server, configured in your editor. See [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp-in-your-ide/set-up-the-github-mcp-server). +* **Latest version of the {% data variables.product.prodname_copilot %} extension**. Download this from the [Eclipse Marketplace](https://aka.ms/copiloteclipse?ref_product=copilot&ref_type=engagement&ref_style=text). For more information, see [AUTOTITLE](/copilot/how-tos/set-up/install-copilot-extension?tool=eclipse). * **Sign in to {% data variables.product.company_short %} from Eclipse**. ## Using the {% data variables.product.github %} MCP server in Eclipse @@ -170,5 +170,5 @@ The {% data variables.product.github %} MCP server enables you to perform a wide ## Further reading -* [AUTOTITLE](/copilot/tutorials/enhancing-copilot-agent-mode-with-mcp) -* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/extend-cloud-agent-with-mcp) +* [AUTOTITLE](/copilot/tutorials/enhance-agent-mode-with-mcp) +* [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/configure-mcp-servers) diff --git a/content/copilot/how-tos/set-up/install-copilot-extension.md b/content/copilot/how-tos/set-up/install-copilot-extension.md index 8307c5833d93..1e871e5e8240 100644 --- a/content/copilot/how-tos/set-up/install-copilot-extension.md +++ b/content/copilot/how-tos/set-up/install-copilot-extension.md @@ -17,7 +17,7 @@ category: ## Prerequisite -To use {% data variables.product.prodname_copilot_short %} in your IDE, you need either limited access through {% data variables.copilot.copilot_free_short %} or a paid {% data variables.product.prodname_copilot_short %} plan for full access. For more information about how to get access and choose the right plan, see [AUTOTITLE](/copilot/about-github-copilot/what-is-github-copilot#getting-access-to-copilot). +To use {% data variables.product.prodname_copilot_short %} in your IDE, you need either limited access through {% data variables.copilot.copilot_free_short %} or a paid {% data variables.product.prodname_copilot_short %} plan for full access. For more information about how to get access and choose the right plan, see [AUTOTITLE](/copilot/get-started/what-is-github-copilot#get-access). {% azure_data_studio %} @@ -29,7 +29,7 @@ To see instructions for other popular coding environments, use the tool switcher ## Installing the {% data variables.product.prodname_copilot %} extension in Azure Data Studio -1. Make sure you have access to {% data variables.product.prodname_copilot %}. For information, see [AUTOTITLE](/copilot/about-github-copilot/what-is-github-copilot#getting-access-to-copilot). +1. Make sure you have access to {% data variables.product.prodname_copilot %}. For information, see [AUTOTITLE](/copilot/get-started/what-is-github-copilot#get-access). 1. Make sure you have a compatible version of Azure Data Studio. To use {% data variables.product.prodname_copilot %} in Azure Data Studio, you must have Azure Data Studio version 1.44.0 or later installed. See the [Azure Data Studio download page](https://docs.microsoft.com/sql/azure-data-studio/download-azure-data-studio) in the Azure Data Studio documentation. @@ -64,7 +64,7 @@ For information about version compatibility of the {% data variables.product.pro The following procedure will guide you through installation of the {% data variables.product.prodname_copilot %} plugin in IntelliJ IDEA. Steps to install the plugin in another supported IDE may differ. -1. Make sure you have access to {% data variables.product.prodname_copilot %}. For information, see [AUTOTITLE](/copilot/about-github-copilot/what-is-github-copilot#getting-access-to-copilot). +1. Make sure you have access to {% data variables.product.prodname_copilot %}. For information, see [AUTOTITLE](/copilot/get-started/what-is-github-copilot#get-access). 1. Make sure you have a JetBrains IDE that is compatible with {% data variables.product.prodname_copilot %}. {% data variables.product.prodname_copilot %} is compatible with the following IDEs: @@ -76,7 +76,7 @@ The following procedure will guide you through installation of the {% data varia 1. After your JetBrains IDE has restarted, click the **Tools** menu. Click **{% data variables.product.prodname_copilot %}**, then click **Login to {% data variables.product.prodname_dotcom %}**. - >[!NOTE] {% data reusables.copilot.sign-in-ghecom %} See [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/using-github-copilot-with-an-account-on-ghecom?tool=jetbrains#authenticating-from-jetbrains-ides). + > [!NOTE] {% data reusables.copilot.sign-in-ghecom %} See [AUTOTITLE](/copilot/how-tos/configure-personal-settings/authenticate-to-ghecom?tool=jetbrains#authenticating-from-jetbrains-ides). ![Screenshot of the expanded "Tools" menu and "{% data variables.product.prodname_copilot %}" sub-menu. The "Login to {% data variables.product.prodname_dotcom %}" option is highlighted in blue.](/assets/images/help/copilot/jetbrains-tools-menu.png) @@ -110,7 +110,7 @@ To see instructions for other popular coding environments, use the tool switcher {% data variables.product.prodname_dotcom %} recommends that you install the {% data variables.product.prodname_copilot %} plugin with Vim/Neovim's built-in plugin manager. Alternatively, you can use a plugin manager of your choice to install `github/copilot.vim`. For more information, see the [copilot.vim repository](https://github.com/github/copilot.vim). -1. Make sure you have access to {% data variables.product.prodname_copilot %}. For information, see [AUTOTITLE](/copilot/about-github-copilot/what-is-github-copilot#getting-access-to-copilot). +1. Make sure you have access to {% data variables.product.prodname_copilot %}. For information, see [AUTOTITLE](/copilot/get-started/what-is-github-copilot#get-access). 1. Make sure you have a compatible version of Vim/Neovim installed. To use {% data variables.product.prodname_copilot %} in Vim/Neovim you must have Vim version 9.0.0185 / Neovim version 0.6 or above and Node.js version 18 or above. See the [Vim](https://vimhelp.org/) / [Neovim documentation](https://neovim.io/doc/) and the [Node.js website](https://nodejs.org/en/). @@ -164,7 +164,7 @@ The following instructions are for versions 2022 17.8 and 2022 17.9 of {% data v ## Installing the {% data variables.product.prodname_copilot %} extension in {% data variables.product.prodname_vs %} -1. Make sure you have access to {% data variables.product.prodname_copilot %}. For information, see [AUTOTITLE](/copilot/about-github-copilot/what-is-github-copilot#getting-access-to-copilot). +1. Make sure you have access to {% data variables.product.prodname_copilot %}. For information, see [AUTOTITLE](/copilot/get-started/what-is-github-copilot#get-access). 1. Make sure you have a compatible version of {% data variables.product.prodname_vs %} installed. {% data reusables.copilot.visual-studio-version %} @@ -172,7 +172,7 @@ The following instructions are for versions 2022 17.8 and 2022 17.9 of {% data v 1. After installing the {% data variables.product.prodname_copilot %} extension, to enable {% data variables.product.prodname_copilot %}, ensure you have added your {% data variables.product.prodname_dotcom %} account to {% data variables.product.prodname_vs %}. For more information, see [Add your {% data variables.product.prodname_dotcom %} accounts to your {% data variables.product.prodname_vs %} keychain](https://learn.microsoft.com/en-us/visualstudio/ide/work-with-github-accounts?ref_product=copilot&ref_type=engagement&ref_style=text) in the Microsoft documentation. - >[!NOTE] {% data reusables.copilot.sign-in-ghecom %} See [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/using-github-copilot-with-an-account-on-ghecom?tool=visualstudio#authenticating-from-visual-studio). + > [!NOTE] {% data reusables.copilot.sign-in-ghecom %} See [AUTOTITLE](/copilot/how-tos/configure-personal-settings/authenticate-to-ghecom?tool=visualstudio#authenticating-from-visual-studio). {% endvisualstudio %} @@ -190,7 +190,7 @@ When you set up {% data variables.product.prodname_copilot %} in {% data variabl For detailed instructions, see [Set up {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode %}](https://code.visualstudio.com/docs/copilot/setup?ref_product=copilot&ref_type=engagement&ref_style=text#_set-up-copilot-in-vs-code) in the {% data variables.product.prodname_vscode %} documentation. ->[!NOTE] {% data reusables.copilot.sign-in-ghecom %} See [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/using-github-copilot-with-an-account-on-ghecom?tool=vscode#authenticating-from-vs-code). +> [!NOTE] {% data reusables.copilot.sign-in-ghecom %} See [AUTOTITLE](/copilot/how-tos/configure-personal-settings/authenticate-to-ghecom?tool=vscode#authenticating-from-vs-code). {% endvscode %} @@ -208,7 +208,7 @@ To use {% data variables.product.prodname_copilot %} for Xcode you must have Xco ## Installing the {% data variables.product.prodname_copilot %} extension for Xcode -1. Make sure you have access to {% data variables.product.prodname_copilot %}. For information, see [AUTOTITLE](/copilot/about-github-copilot#getting-access-to-github-copilot). +1. Make sure you have access to {% data variables.product.prodname_copilot %}. For information, see [AUTOTITLE](/copilot/get-started/what-is-github-copilot#get-access). 1. Make sure you have a compatible version of Xcode installed. To use {% data variables.product.prodname_copilot %} for Xcode you must have Xcode version 8.0 or above and macOS Monterey (12.0) or above. See [Xcode](https://developer.apple.com/xcode/) on the Apple Developer site. 1. Download the latest version of the {% data variables.product.prodname_copilot %} for Xcode extension from the [`github/CopilotForXcode` repository](https://github.com/github/CopilotForXcode/releases/latest/download/GitHubCopilotForXcode.dmg?ref_product=copilot&ref_type=engagement&ref_style=text) and install it. A background item will be added for the application to be able to start itself when Xcode starts. 1. Open the **{% data variables.product.prodname_copilot %} for Xcode** application from the Applications folder and step through the on-screen instructions for setting up the extension. @@ -229,7 +229,7 @@ After granting the required permissions, restart Xcode. You will see a new item Before you can use the {% data variables.product.prodname_copilot %} extension for Xcode, you need to authorize the extension to access your {% data variables.product.github %} account. ->[!NOTE] {% data reusables.copilot.sign-in-ghecom %} See [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/using-github-copilot-with-an-account-on-ghecom?tool=xcode#authenticating-from-xcode). +> [!NOTE] {% data reusables.copilot.sign-in-ghecom %} See [AUTOTITLE](/copilot/how-tos/configure-personal-settings/authenticate-to-ghecom?tool=xcode#authenticating-from-xcode). 1. Open the {% data variables.product.prodname_copilot %} for Xcode application. 1. Click **Login to {% data variables.product.github %}** and follow the prompts to authorize the extension. @@ -268,4 +268,4 @@ To use the {% data variables.product.prodname_copilot %} extension, you must hav ## Next steps -* **Get started with {% data variables.product.prodname_copilot_short %}** - Learn how to use {% data variables.product.prodname_copilot_short %} in your preferred coding environment. See [AUTOTITLE](/copilot/using-github-copilot/using-github-copilot-code-suggestions-in-your-editor). +* **Get started with {% data variables.product.prodname_copilot_short %}** - Learn how to use {% data variables.product.prodname_copilot_short %} in your preferred coding environment. See [AUTOTITLE](/copilot/how-tos/get-code-suggestions/get-ide-code-suggestions). From 3c82d55225dacd8085eff49ad51ab7a928dc9c59 Mon Sep 17 00:00:00 2001 From: Kevin Heis Date: Thu, 9 Jul 2026 09:25:46 -0700 Subject: [PATCH 05/15] Update redirected internal links in rest (#62103) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- ...he-openapi-description-for-the-rest-api.md | 2 +- .../about-the-rest-api/about-the-rest-api.md | 14 ++++---- .../rest/about-the-rest-api/api-versions.md | 2 +- .../about-the-rest-api/breaking-changes.md | 2 +- content/rest/actions/artifacts.md | 2 +- content/rest/actions/cache.md | 2 +- content/rest/actions/concurrency-groups.md | 2 +- content/rest/actions/oidc.md | 2 +- content/rest/actions/permissions.md | 2 +- content/rest/actions/secrets.md | 2 +- .../rest/actions/self-hosted-runner-groups.md | 2 +- content/rest/actions/self-hosted-runners.md | 2 +- content/rest/actions/variables.md | 2 +- content/rest/actions/workflow-jobs.md | 2 +- content/rest/actions/workflow-runs.md | 2 +- content/rest/actions/workflows.md | 2 +- content/rest/activity/events.md | 2 +- content/rest/activity/notifications.md | 6 ++-- content/rest/apps/marketplace.md | 4 +-- .../authenticating-to-the-rest-api.md | 26 +++++++------- .../keeping-your-api-credentials-secure.md | 18 +++++----- ...for-fine-grained-personal-access-tokens.md | 2 +- .../permissions-required-for-github-apps.md | 2 +- content/rest/billing/billing.md | 2 +- content/rest/checks/suites.md | 2 +- content/rest/code-scanning/code-scanning.md | 2 +- content/rest/dependabot/alerts.md | 2 +- content/rest/dependabot/secrets.md | 2 +- .../dependency-graph/dependency-review.md | 2 +- .../dependency-graph/dependency-submission.md | 6 ++-- content/rest/deploy-keys/deploy-keys.md | 2 +- content/rest/deployments/branch-policies.md | 2 +- content/rest/deployments/deployments.md | 4 +-- content/rest/deployments/environments.md | 2 +- content/rest/enterprise-admin/admin-stats.md | 2 +- content/rest/enterprise-admin/announcement.md | 2 +- .../rest/enterprise-admin/global-webhooks.md | 4 +-- content/rest/enterprise-admin/index.md | 4 +-- content/rest/enterprise-admin/ldap.md | 2 +- content/rest/enterprise-admin/manage-ghes.md | 6 ++-- content/rest/enterprise-admin/orgs.md | 2 +- .../pre-receive-environments.md | 2 +- .../enterprise-admin/pre-receive-hooks.md | 2 +- content/rest/enterprise-admin/scim.md | 14 ++++---- content/rest/enterprise-admin/users.md | 2 +- content/rest/git/blobs.md | 2 +- content/rest/guides/building-a-ci-server.md | 6 ++-- content/rest/guides/delivering-deployments.md | 4 +-- .../discovering-resources-for-a-user.md | 4 +-- ...ipting-with-the-rest-api-and-javascript.md | 14 ++++---- .../scripting-with-the-rest-api-and-ruby.md | 12 +++---- ...ng-the-rest-api-to-interact-with-checks.md | 14 ++++---- content/rest/guides/working-with-comments.md | 2 +- content/rest/issues/events.md | 2 +- content/rest/issues/timeline.md | 2 +- content/rest/migrations/orgs.md | 2 +- content/rest/migrations/source-imports.md | 2 +- content/rest/migrations/users.md | 2 +- content/rest/packages/packages.md | 2 +- content/rest/quickstart.md | 36 +++++++++---------- content/rest/rate-limit/rate-limit.md | 10 +++--- content/rest/repos/custom-properties.md | 2 +- content/rest/repos/lfs.md | 4 +-- content/rest/scim/scim.md | 4 +-- .../rest/secret-scanning/secret-scanning.md | 2 +- .../security-advisories/global-advisories.md | 2 +- content/rest/teams/external-groups.md | 2 +- content/rest/teams/team-sync.md | 2 +- .../best-practices-for-using-the-rest-api.md | 4 +-- .../getting-started-with-the-rest-api.md | 16 ++++----- .../using-the-rest-api/issue-event-types.md | 6 ++-- .../rate-limits-for-the-rest-api.md | 10 +++--- .../troubleshooting-the-rest-api.md | 14 ++++---- .../using-pagination-in-the-rest-api.md | 6 ++-- 74 files changed, 182 insertions(+), 182 deletions(-) diff --git a/content/rest/about-the-rest-api/about-the-openapi-description-for-the-rest-api.md b/content/rest/about-the-rest-api/about-the-openapi-description-for-the-rest-api.md index 78e9e41ae8c8..847c4629140f 100644 --- a/content/rest/about-the-rest-api/about-the-openapi-description-for-the-rest-api.md +++ b/content/rest/about-the-rest-api/about-the-openapi-description-for-the-rest-api.md @@ -25,7 +25,7 @@ OpenAPI is a specification for describing REST API interfaces. It describes the For each description, there is a version for each product: {% data variables.product.prodname_free_user %}/{% data variables.product.prodname_pro %}/{% data variables.product.prodname_team %} (`api.github.com`), {% data variables.product.prodname_ghe_cloud %} (`ghec`), and each version of {% data variables.product.prodname_ghe_server %} (`ghes-X.X`). -For each product, if date-based versioning is supported, there is also a description for each date-based version. For more information, see [AUTOTITLE](/rest/overview/api-versions). +For each product, if date-based versioning is supported, there is also a description for each date-based version. For more information, see [AUTOTITLE](/rest/about-the-rest-api/api-versions). Each description is available in a bundled or in a dereferenced format. The bundled format uses `$ref` to refer to OpenAPI components that are shared between endpoints. The dereferenced format includes the fully expanded description. diff --git a/content/rest/about-the-rest-api/about-the-rest-api.md b/content/rest/about-the-rest-api/about-the-rest-api.md index a073f50a108d..5935f8a5221b 100644 --- a/content/rest/about-the-rest-api/about-the-rest-api.md +++ b/content/rest/about-the-rest-api/about-the-rest-api.md @@ -21,11 +21,11 @@ Each REST API endpoint is documented individually, and the endpoints are categor **If you are new to REST APIs**, you may find it helpful to refer to the Quickstart or Getting Started guide for an introduction. For more information, see: * [AUTOTITLE](/rest/quickstart) -* [AUTOTITLE](/rest/guides/getting-started-with-the-rest-api) +* [AUTOTITLE](/rest/using-the-rest-api/getting-started-with-the-rest-api) **If you are familiar with REST APIs** but new to {% data variables.product.company_short %}'s REST API, you may find it helpful to refer to the authentication documentation. For more information, see: -* [AUTOTITLE](/rest/overview/authenticating-to-the-rest-api) +* [AUTOTITLE](/rest/authentication/authenticating-to-the-rest-api) **If you are building scripts or applications** that use the REST API, you may find some of the following guides helpful. For examples of scripting with the REST API, see: @@ -35,13 +35,13 @@ Each REST API endpoint is documented individually, and the endpoints are categor * [AUTOTITLE](/apps/creating-github-apps/writing-code-for-a-github-app/building-a-cli-with-a-github-app) * [AUTOTITLE](/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-a-repository-webhook) -For a list of libraries to facilitate scripting with the REST API, see [AUTOTITLE](/rest/overview/libraries-for-the-rest-api). +For a list of libraries to facilitate scripting with the REST API, see [AUTOTITLE](/rest/using-the-rest-api/libraries-for-the-rest-api). If you are building scripts or applications that use the REST API, you might also be interested in using webhooks to get notified about events or a {% data variables.product.prodname_github_app %} to access resources on behalf of a user or in an organization. For more information, see [AUTOTITLE](/webhooks/about-webhooks) and [AUTOTITLE](/apps/creating-github-apps/about-creating-github-apps/deciding-when-to-build-a-github-app). ## Further reading -* [AUTOTITLE](/rest/overview/comparing-githubs-rest-api-and-graphql-api) -* [AUTOTITLE](/rest/guides/best-practices-for-using-the-rest-api) -* [AUTOTITLE](/rest/overview/keeping-your-api-credentials-secure) -* [AUTOTITLE](/rest/overview/troubleshooting-the-rest-api) +* [AUTOTITLE](/rest/about-the-rest-api/comparing-githubs-rest-api-and-graphql-api) +* [AUTOTITLE](/rest/using-the-rest-api/best-practices-for-using-the-rest-api) +* [AUTOTITLE](/rest/authentication/keeping-your-api-credentials-secure) +* [AUTOTITLE](/rest/using-the-rest-api/troubleshooting-the-rest-api) diff --git a/content/rest/about-the-rest-api/api-versions.md b/content/rest/about-the-rest-api/api-versions.md index 068243fcd4bc..7fba1393bbdb 100644 --- a/content/rest/about-the-rest-api/api-versions.md +++ b/content/rest/about-the-rest-api/api-versions.md @@ -40,7 +40,7 @@ If you specify an API version that is no longer supported, you will receive a `4 ## Upgrading to a new API version -Before upgrading to a new REST API version, you should read the changelog of breaking changes for the new API version to understand what breaking changes are included and to learn more about how to upgrade to that specific API version. For more information, see [AUTOTITLE](/rest/overview/breaking-changes). +Before upgrading to a new REST API version, you should read the changelog of breaking changes for the new API version to understand what breaking changes are included and to learn more about how to upgrade to that specific API version. For more information, see [AUTOTITLE](/rest/about-the-rest-api/breaking-changes). When you update your integration to specify the new API version in the `X-GitHub-Api-Version` header, you'll also need to make any changes required for your integration to work with the new API version. diff --git a/content/rest/about-the-rest-api/breaking-changes.md b/content/rest/about-the-rest-api/breaking-changes.md index 754568a4115e..424e3b291710 100644 --- a/content/rest/about-the-rest-api/breaking-changes.md +++ b/content/rest/about-the-rest-api/breaking-changes.md @@ -16,7 +16,7 @@ category: {% data reusables.rest-api.about-api-versions %} -For more information about API versions, see [AUTOTITLE](/rest/overview/api-versions). +For more information about API versions, see [AUTOTITLE](/rest/about-the-rest-api/api-versions). ## Upgrading to a new API version diff --git a/content/rest/actions/artifacts.md b/content/rest/actions/artifacts.md index 41955b5536a7..519238908b78 100644 --- a/content/rest/actions/artifacts.md +++ b/content/rest/actions/artifacts.md @@ -16,6 +16,6 @@ category: ## About artifacts in {% data variables.product.prodname_actions %} -You can use the REST API to download, delete, and retrieve information about workflow artifacts in {% data variables.product.prodname_actions %}. {% data reusables.actions.about-artifacts %} For more information, see [AUTOTITLE](/actions/using-workflows/storing-workflow-data-as-artifacts). +You can use the REST API to download, delete, and retrieve information about workflow artifacts in {% data variables.product.prodname_actions %}. {% data reusables.actions.about-artifacts %} For more information, see [AUTOTITLE](/actions/tutorials/store-and-share-data). diff --git a/content/rest/actions/cache.md b/content/rest/actions/cache.md index 31e4e9bc0b7b..f4ce369a772f 100644 --- a/content/rest/actions/cache.md +++ b/content/rest/actions/cache.md @@ -16,6 +16,6 @@ category: ## About the cache in {% data variables.product.prodname_actions %} -You can use the REST API to query and manage the cache for repositories in {% data variables.product.prodname_actions %}. You can also install a {% data variables.product.prodname_cli %} extension to manage your caches from the command line. For more information, see [AUTOTITLE](/actions/using-workflows/caching-dependencies-to-speed-up-workflows#managing-caches). +You can use the REST API to query and manage the cache for repositories in {% data variables.product.prodname_actions %}. You can also install a {% data variables.product.prodname_cli %} extension to manage your caches from the command line. For more information, see [AUTOTITLE](/actions/reference/workflows-and-actions/dependency-caching#managing-caches). diff --git a/content/rest/actions/concurrency-groups.md b/content/rest/actions/concurrency-groups.md index 40c7c5ec849f..2322200df4a1 100644 --- a/content/rest/actions/concurrency-groups.md +++ b/content/rest/actions/concurrency-groups.md @@ -15,6 +15,6 @@ category: ## About concurrency groups in {% data variables.product.prodname_actions %} -You can use the REST API to read the state of {% data variables.product.prodname_actions %} concurrency groups, which ensure that only a single job or workflow using the same group will run at a time while additional runs are pending or canceled depending on configuration. For more information, see [AUTOTITLE](/actions/using-jobs/using-concurrency). +You can use the REST API to read the state of {% data variables.product.prodname_actions %} concurrency groups, which ensure that only a single job or workflow using the same group will run at a time while additional runs are pending or canceled depending on configuration. For more information, see [AUTOTITLE](/actions/how-tos/write-workflows/choose-when-workflows-run/control-workflow-concurrency). diff --git a/content/rest/actions/oidc.md b/content/rest/actions/oidc.md index d41dec68dae5..e81e0828a30c 100644 --- a/content/rest/actions/oidc.md +++ b/content/rest/actions/oidc.md @@ -14,6 +14,6 @@ category: ## About {% data variables.product.prodname_actions %} OIDC -You can use the REST API to query and manage a customization template for an OpenID Connect (OIDC) subject claim. For more information, see [AUTOTITLE](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect). +You can use the REST API to query and manage a customization template for an OpenID Connect (OIDC) subject claim. For more information, see [AUTOTITLE](/actions/concepts/security/openid-connect). diff --git a/content/rest/actions/permissions.md b/content/rest/actions/permissions.md index d8bc68575a41..7e5456e9a1b4 100644 --- a/content/rest/actions/permissions.md +++ b/content/rest/actions/permissions.md @@ -16,6 +16,6 @@ category: ## About permissions for {% data variables.product.prodname_actions %} -You can use the REST API to set permissions for the {% ifversion ghes or ghec %}enterprises, {% endif %}organizations and repositories that are allowed to run {% data variables.product.prodname_actions %}, and the actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %} that are allowed to run. For more information, see [AUTOTITLE](/actions/learn-github-actions/usage-limits-billing-and-administration#disabling-or-limiting-github-actions-for-your-repository-or-organization). +You can use the REST API to set permissions for the {% ifversion ghes or ghec %}enterprises, {% endif %}organizations and repositories that are allowed to run {% data variables.product.prodname_actions %}, and the actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %} that are allowed to run. For more information, see [AUTOTITLE](/actions/concepts/billing-and-usage#disabling-or-limiting-github-actions-for-your-repository-or-organization). diff --git a/content/rest/actions/secrets.md b/content/rest/actions/secrets.md index 76f9d036ff33..3d5f483e1d91 100644 --- a/content/rest/actions/secrets.md +++ b/content/rest/actions/secrets.md @@ -16,6 +16,6 @@ category: ## About secrets in {% data variables.product.prodname_actions %} -You can use the REST API to create, update, delete, and retrieve information about secrets that can be used in workflows in {% data variables.product.prodname_actions %}. {% data reusables.actions.about-secrets %} For more information, see [AUTOTITLE](/actions/security-for-github-actions/security-guides/about-secrets). +You can use the REST API to create, update, delete, and retrieve information about secrets that can be used in workflows in {% data variables.product.prodname_actions %}. {% data reusables.actions.about-secrets %} For more information, see [AUTOTITLE](/actions/concepts/security/secrets). diff --git a/content/rest/actions/self-hosted-runner-groups.md b/content/rest/actions/self-hosted-runner-groups.md index 87dbc39c5c81..c3b9192731e6 100644 --- a/content/rest/actions/self-hosted-runner-groups.md +++ b/content/rest/actions/self-hosted-runner-groups.md @@ -16,7 +16,7 @@ category: ## About self-hosted runner groups in {% data variables.product.prodname_actions %} -You can use the REST API to manage groups of self-hosted runners in {% data variables.product.prodname_actions %}. For more information, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups). +You can use the REST API to manage groups of self-hosted runners in {% data variables.product.prodname_actions %}. For more information, see [AUTOTITLE](/actions/how-tos/manage-runners/self-hosted-runners/manage-access). {% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} must have the `administration` permission for repositories or the `organization_self_hosted_runners` permission for organizations. Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises to use these endpoints. diff --git a/content/rest/actions/self-hosted-runners.md b/content/rest/actions/self-hosted-runners.md index 509027255850..f9a9fdfd88cf 100644 --- a/content/rest/actions/self-hosted-runners.md +++ b/content/rest/actions/self-hosted-runners.md @@ -16,6 +16,6 @@ category: ## About self-hosted runners in {% data variables.product.prodname_actions %} -You can use the REST API to register, view, and delete self-hosted runners in {% data variables.product.prodname_actions %}. {% data reusables.actions.about-self-hosted-runners %} For more information, see [AUTOTITLE](/actions/how-tos/managing-self-hosted-runners). +You can use the REST API to register, view, and delete self-hosted runners in {% data variables.product.prodname_actions %}. {% data reusables.actions.about-self-hosted-runners %} For more information, see [AUTOTITLE](/actions/how-tos/manage-runners/self-hosted-runners). diff --git a/content/rest/actions/variables.md b/content/rest/actions/variables.md index 86b5be444f50..6fa517fef00a 100644 --- a/content/rest/actions/variables.md +++ b/content/rest/actions/variables.md @@ -14,6 +14,6 @@ category: ## About variables in {% data variables.product.prodname_actions %} -You can use the REST API to create, update, delete, and retrieve information about variables that can be used in workflows in {% data variables.product.prodname_actions %}. {% data reusables.actions.about-variables %} For more information, see [AUTOTITLE](/actions/learn-github-actions/variables) in the {% data variables.product.prodname_actions %} documentation. +You can use the REST API to create, update, delete, and retrieve information about variables that can be used in workflows in {% data variables.product.prodname_actions %}. {% data reusables.actions.about-variables %} For more information, see [AUTOTITLE](/actions/how-tos/write-workflows/choose-what-workflows-do/use-variables) in the {% data variables.product.prodname_actions %} documentation. diff --git a/content/rest/actions/workflow-jobs.md b/content/rest/actions/workflow-jobs.md index 132075d203c9..9c514a667fdf 100644 --- a/content/rest/actions/workflow-jobs.md +++ b/content/rest/actions/workflow-jobs.md @@ -16,6 +16,6 @@ category: ## About workflow jobs in {% data variables.product.prodname_actions %} -You can use the REST API to view logs and workflow jobs in {% data variables.product.prodname_actions %}. {% data reusables.actions.about-workflow-jobs %} For more information, see [AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions). +You can use the REST API to view logs and workflow jobs in {% data variables.product.prodname_actions %}. {% data reusables.actions.about-workflow-jobs %} For more information, see [AUTOTITLE](/actions/reference/workflows-and-actions/workflow-syntax). diff --git a/content/rest/actions/workflow-runs.md b/content/rest/actions/workflow-runs.md index 9ef11019b797..49e75ba4cf94 100644 --- a/content/rest/actions/workflow-runs.md +++ b/content/rest/actions/workflow-runs.md @@ -16,6 +16,6 @@ category: ## About workflow runs in {% data variables.product.prodname_actions %} -You can use the REST API to view, re-run, cancel, and view logs for workflow runs in {% data variables.product.prodname_actions %}. {% data reusables.actions.about-workflow-runs %} For more information, see [AUTOTITLE](/actions/managing-workflow-runs). +You can use the REST API to view, re-run, cancel, and view logs for workflow runs in {% data variables.product.prodname_actions %}. {% data reusables.actions.about-workflow-runs %} For more information, see [AUTOTITLE](/actions/how-tos/manage-workflow-runs). diff --git a/content/rest/actions/workflows.md b/content/rest/actions/workflows.md index 38e041089da0..a07a448809de 100644 --- a/content/rest/actions/workflows.md +++ b/content/rest/actions/workflows.md @@ -16,6 +16,6 @@ category: ## About workflows in {% data variables.product.prodname_actions %} -You can use the REST API to view workflows for a repository in {% data variables.product.prodname_actions %}. {% data reusables.actions.about-workflows %} For more information, see [AUTOTITLE](/actions/using-workflows/about-workflows) in the {% data variables.product.prodname_actions %} documentation. +You can use the REST API to view workflows for a repository in {% data variables.product.prodname_actions %}. {% data reusables.actions.about-workflows %} For more information, see [AUTOTITLE](/actions/concepts/workflows-and-actions/workflows) in the {% data variables.product.prodname_actions %} documentation. diff --git a/content/rest/activity/events.md b/content/rest/activity/events.md index 9771afbf1679..9fa5bca1ca32 100644 --- a/content/rest/activity/events.md +++ b/content/rest/activity/events.md @@ -18,7 +18,7 @@ category: {% data variables.product.github %} events power the various activity streams on the site. -You can use the REST API to return different types of events triggered by activity on {% data variables.product.github %}. For more information about the specific events that you can receive, see [AUTOTITLE](/webhooks-and-events/events/github-event-types). Endpoints for repository issues are also available. For more information, see [AUTOTITLE](/rest/issues/events). +You can use the REST API to return different types of events triggered by activity on {% data variables.product.github %}. For more information about the specific events that you can receive, see [AUTOTITLE](/rest/using-the-rest-api/github-event-types). Endpoints for repository issues are also available. For more information, see [AUTOTITLE](/rest/issues/events). Events are optimized for polling with the "ETag" header. If no new events have been triggered, you will see a "304 Not Modified" response, and your current rate limit will be untouched. There is also an "X-Poll-Interval" header that specifies how often (in seconds) you are allowed to poll. In times of high server load, the time may increase. Please obey the header. diff --git a/content/rest/activity/notifications.md b/content/rest/activity/notifications.md index e0dabead8a6b..edc1e22f92a4 100644 --- a/content/rest/activity/notifications.md +++ b/content/rest/activity/notifications.md @@ -18,7 +18,7 @@ category: {% data reusables.user-settings.notifications-api-classic-pat-only %} -You can use the REST API to manage {% data variables.product.github %} notifications. For more information about notifications, see [AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications). +You can use the REST API to manage {% data variables.product.github %} notifications. For more information about notifications, see [AUTOTITLE](/subscriptions-and-notifications/concepts/about-notifications). All calls to these endpoints require the `notifications` or `repo` scopes. You will need the `repo` scope to access issues and commits from their respective endpoints. @@ -48,7 +48,7 @@ There are a few potential `reason`s for receiving a notification. Reason Name | Description ------------|------------ -`approval_requested` | You were requested to review and approve a deployment. For more information, see [AUTOTITLE](/actions/managing-workflow-runs/reviewing-deployments). +`approval_requested` | You were requested to review and approve a deployment. For more information, see [AUTOTITLE](/actions/how-tos/deploy/configure-and-manage-deployments/review-deployments). `assign` | You were assigned to the issue. `author` | You created the thread. `ci_activity` | A {% data variables.product.prodname_actions %} workflow run that you triggered was completed. @@ -59,7 +59,7 @@ Reason Name | Description `mention` | You were specifically **@mentioned** in the content. `review_requested` | You, or a team you're a member of, were requested to review a pull request.{% ifversion fpt or ghec %} `security_advisory_credit` | You were credited for contributing to a security advisory. -`security_alert` | {% data variables.product.prodname_dotcom %} discovered a [security vulnerability](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts) in your repository.{% endif %} +`security_alert` | {% data variables.product.prodname_dotcom %} discovered a [security vulnerability](/code-security/concepts/supply-chain-security/dependabot-alerts) in your repository.{% endif %} `state_change` | You changed the thread state (for example, closing an issue or merging a pull request). `subscribed` | You're watching the repository. `team_mention` | You were on a team that was mentioned. diff --git a/content/rest/apps/marketplace.md b/content/rest/apps/marketplace.md index 93c0db07d088..11447d0e943f 100644 --- a/content/rest/apps/marketplace.md +++ b/content/rest/apps/marketplace.md @@ -15,13 +15,13 @@ category: ## About {% data variables.product.prodname_marketplace %} -For more information about {% data variables.product.prodname_marketplace %}, see [AUTOTITLE](/apps/publishing-apps-to-github-marketplace). +For more information about {% data variables.product.prodname_marketplace %}, see [AUTOTITLE](/apps/github-marketplace). These endpoints allow you to see which customers are using a pricing plan, see a customer's purchases, and see if an account has an active subscription. ### Testing with stubbed endpoints -You can [test your {% data variables.product.prodname_github_app %}](/apps/publishing-apps-to-github-marketplace/using-the-github-marketplace-api-in-your-app/testing-your-app) with **stubbed data**. Stubbed data is hard-coded, fake data that will not change based on actual subscriptions. +You can [test your {% data variables.product.prodname_github_app %}](/apps/github-marketplace/using-the-github-marketplace-api-in-your-app/testing-your-app) with **stubbed data**. Stubbed data is hard-coded, fake data that will not change based on actual subscriptions. To test with stubbed data, use a stubbed endpoint in place of its production counterpart. This allows you to test whether the API logic succeeds before listing {% data variables.product.prodname_github_apps %} on {% data variables.product.prodname_marketplace %}. diff --git a/content/rest/authentication/authenticating-to-the-rest-api.md b/content/rest/authentication/authenticating-to-the-rest-api.md index 6764eb61fe24..2194dd7ffbd8 100644 --- a/content/rest/authentication/authenticating-to-the-rest-api.md +++ b/content/rest/authentication/authenticating-to-the-rest-api.md @@ -36,13 +36,13 @@ curl --request GET \ If you try to use a REST API endpoint without a token or with a token that has insufficient permissions, you will receive a `404 Not Found` or `403 Forbidden` response. Authenticating with invalid credentials will initially return a `401 Unauthorized` response. -After detecting several requests with invalid credentials within a short period, the API will temporarily reject all authentication attempts for that user (including ones with valid credentials) with a `403 Forbidden` response. For more information, see [AUTOTITLE](/rest/overview/rate-limits-for-the-rest-api). +After detecting several requests with invalid credentials within a short period, the API will temporarily reject all authentication attempts for that user (including ones with valid credentials) with a `403 Forbidden` response. For more information, see [AUTOTITLE](/rest/using-the-rest-api/rate-limits-for-the-rest-api). ## Authenticating with a {% data variables.product.pat_generic %} -If you want to use the {% data variables.product.company_short %} REST API for personal use, you can create a {% data variables.product.pat_generic %}. If possible, {% data variables.product.company_short %} recommends that you use a {% data variables.product.pat_v2 %} instead of a {% data variables.product.pat_v1 %}. For more information about creating a {% data variables.product.pat_generic %}, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token). +If you want to use the {% data variables.product.company_short %} REST API for personal use, you can create a {% data variables.product.pat_generic %}. If possible, {% data variables.product.company_short %} recommends that you use a {% data variables.product.pat_v2 %} instead of a {% data variables.product.pat_v1 %}. For more information about creating a {% data variables.product.pat_generic %}, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens). -If you are using a {% data variables.product.pat_v2 %}, your {% data variables.product.pat_v2 %} requires specific permissions in order to access each REST API endpoint. The REST API reference document for each endpoint states whether the endpoint works with {% data variables.product.pat_v2 %}s and states what permissions are required in order for the token to use the endpoint. Some endpoints may require multiple permissions, and some endpoints may require one of multiple permissions. For an overview of which REST API endpoints a {% data variables.product.pat_v2 %} can access with each permission, see [AUTOTITLE](/rest/overview/permissions-required-for-fine-grained-personal-access-tokens). +If you are using a {% data variables.product.pat_v2 %}, your {% data variables.product.pat_v2 %} requires specific permissions in order to access each REST API endpoint. The REST API reference document for each endpoint states whether the endpoint works with {% data variables.product.pat_v2 %}s and states what permissions are required in order for the token to use the endpoint. Some endpoints may require multiple permissions, and some endpoints may require one of multiple permissions. For an overview of which REST API endpoints a {% data variables.product.pat_v2 %} can access with each permission, see [AUTOTITLE](/rest/authentication/permissions-required-for-fine-grained-personal-access-tokens). If you are using a {% data variables.product.pat_v1 %}, it requires specific scopes in order to access each REST API endpoint. For general guidance about what scopes to choose, see [AUTOTITLE](/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps#available-scopes). @@ -50,7 +50,7 @@ If you are using a {% data variables.product.pat_v1 %}, it requires specific sco ### {% data variables.product.pat_generic_caps_plural %} and SAML SSO -{% ifversion fpt or ghec %}If you use a {% data variables.product.pat_v1 %} to access an organization that enforces SAML single sign-on (SSO) for authentication, you will need to authorize your token after creation. {% data variables.product.pat_v2_caps %}s are authorized during token creation, before access to the organization is granted. For more information, see [AUTOTITLE](/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on). +{% ifversion fpt or ghec %}If you use a {% data variables.product.pat_v1 %} to access an organization that enforces SAML single sign-on (SSO) for authentication, you will need to authorize your token after creation. {% data variables.product.pat_v2_caps %}s are authorized during token creation, before access to the organization is granted. For more information, see [AUTOTITLE](/authentication/authenticating-with-single-sign-on/authorizing-a-personal-access-token-for-use-with-single-sign-on). If you do not authorize your {% data variables.product.pat_v1 %} for SAML SSO before you try to use it to access a single organization that enforces SAML SSO, you may receive a `404 Not Found` or a `403 Forbidden` error. If you receive a `403 Forbidden` error, the `X-GitHub-SSO` header will include a URL that you can follow to authorize your token. The URL expires after one hour. @@ -62,7 +62,7 @@ If you do not authorize your {% data variables.product.pat_v1 %} for SAML SSO be If you want to use the API for an organization or on behalf of another user, {% data variables.product.company_short %} recommends that you use a {% data variables.product.prodname_github_app %}. For more information, see [AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/about-authentication-with-a-github-app). -The REST API reference documentation for each endpoint states whether the endpoint works with {% data variables.product.prodname_github_apps %} and states what permissions are required in order for the app to use the endpoint. Some endpoints may require multiple permissions, and some endpoints may require one of multiple permissions. For an overview of which REST API endpoints a {% data variables.product.prodname_github_app %} can access with each permission, see [AUTOTITLE](/rest/overview/permissions-required-for-github-apps). +The REST API reference documentation for each endpoint states whether the endpoint works with {% data variables.product.prodname_github_apps %} and states what permissions are required in order for the app to use the endpoint. Some endpoints may require multiple permissions, and some endpoints may require one of multiple permissions. For an overview of which REST API endpoints a {% data variables.product.prodname_github_app %} can access with each permission, see [AUTOTITLE](/rest/authentication/permissions-required-for-github-apps). You can also create an OAuth token with an {% data variables.product.prodname_oauth_app %} to access the REST API. However, {% data variables.product.company_short %} recommends that you use a {% data variables.product.prodname_github_app %} instead. {% data variables.product.prodname_github_apps %} allow more control over the access and permission that the app has. @@ -103,15 +103,15 @@ If you are the owner of a {% data variables.product.prodname_github_app %} or {% ## Authenticating in a {% data variables.product.prodname_actions %} workflow -If you want to use the API in a {% data variables.product.prodname_actions %} workflow, {% data variables.product.company_short %} recommends that you authenticate with the built-in `GITHUB_TOKEN` instead of creating a token. You can grant permissions to the `GITHUB_TOKEN` with the `permissions` key. For more information, see [AUTOTITLE](/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token). +If you want to use the API in a {% data variables.product.prodname_actions %} workflow, {% data variables.product.company_short %} recommends that you authenticate with the built-in `GITHUB_TOKEN` instead of creating a token. You can grant permissions to the `GITHUB_TOKEN` with the `permissions` key. For more information, see [AUTOTITLE](/actions/tutorials/authenticate-with-github_token#modifying-the-permissions-for-the-github_token). -If this is not possible, you can store your token as a secret and use the name of your secret in your {% data variables.product.prodname_actions %} workflow. For more information about secrets, see [AUTOTITLE](/actions/security-guides/encrypted-secrets). +If this is not possible, you can store your token as a secret and use the name of your secret in your {% data variables.product.prodname_actions %} workflow. For more information about secrets, see [AUTOTITLE](/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets). ### Authenticating in a {% data variables.product.prodname_actions %} workflow using {% data variables.product.prodname_cli %} -To make an authenticated request to the API in a {% data variables.product.prodname_actions %} workflow using {% data variables.product.prodname_cli %}, you can store the value of `GITHUB_TOKEN` as an environment variable, and use the `run` keyword to execute the {% data variables.product.prodname_cli %} `api` subcommand. For more information about the `run` keyword, see [AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun). +To make an authenticated request to the API in a {% data variables.product.prodname_actions %} workflow using {% data variables.product.prodname_cli %}, you can store the value of `GITHUB_TOKEN` as an environment variable, and use the `run` keyword to execute the {% data variables.product.prodname_cli %} `api` subcommand. For more information about the `run` keyword, see [AUTOTITLE](/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idstepsrun). -In the following example workflow, replace `PATH` with the path of the endpoint. For more information about the path, see [AUTOTITLE](/rest/guides/getting-started-with-the-rest-api?tool=cli#path).{% ifversion ghes %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}.{% endif %} +In the following example workflow, replace `PATH` with the path of the endpoint. For more information about the path, see [AUTOTITLE](/rest/using-the-rest-api/getting-started-with-the-rest-api?tool=cli#path).{% ifversion ghes %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}.{% endif %} ```yaml jobs: @@ -127,9 +127,9 @@ jobs: ### Authenticating in a {% data variables.product.prodname_actions %} workflow using `curl` -To make an authenticated request to the API in a {% data variables.product.prodname_actions %} workflow using `curl`, you can store the value of `GITHUB_TOKEN` as an environment variable, and use the `run` keyword to execute a `curl` request to the API. For more information about the `run` keyword, see [AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun). +To make an authenticated request to the API in a {% data variables.product.prodname_actions %} workflow using `curl`, you can store the value of `GITHUB_TOKEN` as an environment variable, and use the `run` keyword to execute a `curl` request to the API. For more information about the `run` keyword, see [AUTOTITLE](/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idstepsrun). -In the following example workflow, replace `PATH` with the path of the endpoint. For more information about the path, see [AUTOTITLE](/rest/guides/getting-started-with-the-rest-api?tool=cli#path).{% ifversion ghes %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}.{% endif %} +In the following example workflow, replace `PATH` with the path of the endpoint. For more information about the path, see [AUTOTITLE](/rest/using-the-rest-api/getting-started-with-the-rest-api?tool=cli#path).{% ifversion ghes %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}.{% endif %} ```yaml copy jobs: @@ -170,5 +170,5 @@ Authentication with username and password is not supported. If you try to authen ## Further reading -* [AUTOTITLE](/rest/overview/keeping-your-api-credentials-secure) -* [AUTOTITLE](/rest/guides/getting-started-with-the-rest-api#authentication) +* [AUTOTITLE](/rest/authentication/keeping-your-api-credentials-secure) +* [AUTOTITLE](/rest/using-the-rest-api/getting-started-with-the-rest-api#authentication) diff --git a/content/rest/authentication/keeping-your-api-credentials-secure.md b/content/rest/authentication/keeping-your-api-credentials-secure.md index 4c883dd13062..310b24727e09 100644 --- a/content/rest/authentication/keeping-your-api-credentials-secure.md +++ b/content/rest/authentication/keeping-your-api-credentials-secure.md @@ -28,9 +28,9 @@ When creating a {% data variables.product.pat_generic %}, only select the minimu {% data reusables.user-settings.token_access_capabilities %} -When creating a {% data variables.product.prodname_github_app %}, select the minimum permissions that your {% data variables.product.prodname_github_app %} will need. For more information, see [AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/best-practices-for-creating-a-github-app). +When creating a {% data variables.product.prodname_github_app %}, select the minimum permissions that your {% data variables.product.prodname_github_app %} will need. For more information, see [AUTOTITLE](/apps/creating-github-apps/about-creating-github-apps/best-practices-for-creating-a-github-app). -When authenticating with `GITHUB_TOKEN` in a {% data variables.product.prodname_actions %} workflow, only give the minimum amount of permissions needed. For more information, see [AUTOTITLE](/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token). +When authenticating with `GITHUB_TOKEN` in a {% data variables.product.prodname_actions %} workflow, only give the minimum amount of permissions needed. For more information, see [AUTOTITLE](/actions/tutorials/authenticate-with-github_token#modifying-the-permissions-for-the-github_token). ## Store your authentication credentials securely @@ -38,20 +38,20 @@ Treat authentication credentials the same way you would treat your passwords or * Don't share authentication credentials using an unencrypted messaging or email system. * Don't pass your {% data variables.product.pat_generic %} as plain text in the command line. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#keeping-your-personal-access-tokens-secure). -* Don't push unencrypted authentication credentials like tokens or keys to any repository, even if the repository is private. Instead consider using a {% data variables.product.prodname_actions %} secret{% ifversion fpt or ghec %} or Codespaces secret{% endif %}. For more information, see [AUTOTITLE](/actions/security-guides/encrypted-secrets){% ifversion fpt or ghec %} and [AUTOTITLE](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces){% endif %}. -* You can use secret scanning to discover tokens, private keys, and other secrets that were pushed to a repository, or to block future pushes that contain secrets. For more information, see [AUTOTITLE](/code-security/secret-scanning/introduction/about-secret-scanning). +* Don't push unencrypted authentication credentials like tokens or keys to any repository, even if the repository is private. Instead consider using a {% data variables.product.prodname_actions %} secret{% ifversion fpt or ghec %} or Codespaces secret{% endif %}. For more information, see [AUTOTITLE](/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets){% ifversion fpt or ghec %} and [AUTOTITLE](/codespaces/managing-your-codespaces/managing-your-account-specific-secrets-for-github-codespaces){% endif %}. +* You can use secret scanning to discover tokens, private keys, and other secrets that were pushed to a repository, or to block future pushes that contain secrets. For more information, see [AUTOTITLE](/code-security/concepts/secret-security/secret-scanning). ## Limit who can access your authentication credentials -Don't share your {% data variables.product.pat_generic %} with others. Instead of sharing a {% data variables.product.pat_generic %}, consider creating a {% data variables.product.prodname_github_app %}. For more information, see [AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/about-creating-github-apps). +Don't share your {% data variables.product.pat_generic %} with others. Instead of sharing a {% data variables.product.pat_generic %}, consider creating a {% data variables.product.prodname_github_app %}. For more information, see [AUTOTITLE](/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps). If you need to share credentials with a team, store the credentials in a secure shared system. For example, you could store and share passwords securely using [1Password](https://1password.com/), or you could store keys in [Azure KeyVault](https://azure.microsoft.com/en-gb/products/key-vault) and manage access with your IAM (Identity and access management). -If you're creating a {% data variables.product.prodname_actions %} workflow that needs to access the API, you can store your credentials in an encrypted secret, and access the encrypted secret from the workflow. For more information, see [AUTOTITLE](/actions/security-guides/encrypted-secrets) and [AUTOTITLE](/apps/creating-github-apps/guides/making-authenticated-api-requests-with-a-github-app-in-a-github-actions-workflow). +If you're creating a {% data variables.product.prodname_actions %} workflow that needs to access the API, you can store your credentials in an encrypted secret, and access the encrypted secret from the workflow. For more information, see [AUTOTITLE](/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets) and [AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/making-authenticated-api-requests-with-a-github-app-in-a-github-actions-workflow). ## Use authentication credentials securely in your code -Never hardcode authentication credentials like tokens, keys, or app-related secrets into your code. Instead, consider using a secret manager such as [Azure Key Vault](https://azure.microsoft.com/products/key-vault) or [HashiCorp Vault](https://www.hashicorp.com/products/vault). For more information about securing {% data variables.product.prodname_github_app %} credentials, see [AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/best-practices-for-creating-a-github-app). +Never hardcode authentication credentials like tokens, keys, or app-related secrets into your code. Instead, consider using a secret manager such as [Azure Key Vault](https://azure.microsoft.com/products/key-vault) or [HashiCorp Vault](https://www.hashicorp.com/products/vault). For more information about securing {% data variables.product.prodname_github_app %} credentials, see [AUTOTITLE](/apps/creating-github-apps/about-creating-github-apps/best-practices-for-creating-a-github-app). {% ifversion fpt or ghec %} @@ -64,7 +64,7 @@ If you find another user's {% data variables.product.pat_generic %} exposed on { {% endif %} {% endif %} -When using a {% data variables.product.pat_generic %} in a script, consider storing your token as a {% data variables.product.prodname_actions %} secret and running your script through {% data variables.product.prodname_actions %}.{% ifversion fpt or ghec %} You can also store your token as a Codespaces secret and run your script in Codespaces.{% endif %} For more information, see [AUTOTITLE](/actions/security-guides/encrypted-secrets){% ifversion fpt or ghec %} and [AUTOTITLE](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces){% endif %}. +When using a {% data variables.product.pat_generic %} in a script, consider storing your token as a {% data variables.product.prodname_actions %} secret and running your script through {% data variables.product.prodname_actions %}.{% ifversion fpt or ghec %} You can also store your token as a Codespaces secret and run your script in Codespaces.{% endif %} For more information, see [AUTOTITLE](/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets){% ifversion fpt or ghec %} and [AUTOTITLE](/codespaces/managing-your-codespaces/managing-your-account-specific-secrets-for-github-codespaces){% endif %}. If none of these options are possible, you can store authentication credentials in a `.env` file. Make sure to encrypt your `.env` file, and never push it to any repository. @@ -76,6 +76,6 @@ You should create a plan to handle any security breaches in a timely manner. In * Replace the old credential with the new one everywhere that you are storing or accessing the credential. * Delete the old compromised credential. -For information about rotating compromised credentials for a {% data variables.product.prodname_github_app %}, see [AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/best-practices-for-creating-a-github-app). +For information about rotating compromised credentials for a {% data variables.product.prodname_github_app %}, see [AUTOTITLE](/apps/creating-github-apps/about-creating-github-apps/best-practices-for-creating-a-github-app). For information about creating and deleting {% data variables.product.pat_generic %}s, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens). diff --git a/content/rest/authentication/permissions-required-for-fine-grained-personal-access-tokens.md b/content/rest/authentication/permissions-required-for-fine-grained-personal-access-tokens.md index 5a7b237c78f7..662a43f6c730 100644 --- a/content/rest/authentication/permissions-required-for-fine-grained-personal-access-tokens.md +++ b/content/rest/authentication/permissions-required-for-fine-grained-personal-access-tokens.md @@ -15,7 +15,7 @@ category: ## About permissions required for {% data variables.product.pat_v2 %} -When you create a {% data variables.product.pat_v2 %}, you grant it a set of permissions. Permissions define what resources the {% data variables.product.prodname_github_app %} can access via the API. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token). +When you create a {% data variables.product.pat_v2 %}, you grant it a set of permissions. Permissions define what resources the token can access via the API. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens). {% data reusables.rest-api.permission-header %} diff --git a/content/rest/authentication/permissions-required-for-github-apps.md b/content/rest/authentication/permissions-required-for-github-apps.md index 48c9d39ce0d5..b0e46cd36b47 100644 --- a/content/rest/authentication/permissions-required-for-github-apps.md +++ b/content/rest/authentication/permissions-required-for-github-apps.md @@ -17,7 +17,7 @@ category: ## About {% data variables.product.prodname_github_app %} permissions -{% data variables.product.prodname_github_apps %} are created with a set of permissions. Permissions define what resources the {% data variables.product.prodname_github_app %} can access via the API. For more information, see [AUTOTITLE](/apps/creating-github-apps/creating-github-apps/setting-permissions-for-github-apps). +{% data variables.product.prodname_github_apps %} are created with a set of permissions. Permissions define what resources the {% data variables.product.prodname_github_app %} can access via the API. For more information, see [AUTOTITLE](/apps/creating-github-apps/registering-a-github-app/choosing-permissions-for-a-github-app). {% data reusables.rest-api.permission-header %} diff --git a/content/rest/billing/billing.md b/content/rest/billing/billing.md index 6b76c289d668..2e33ee1e2710 100644 --- a/content/rest/billing/billing.md +++ b/content/rest/billing/billing.md @@ -16,6 +16,6 @@ category: ## About billing -You can get billing information for an enterprise. For more information, see [AUTOTITLE](/rest/enterprise-admin/billing). +You can get billing information for an enterprise. For more information, see [AUTOTITLE](/rest/billing/billing). diff --git a/content/rest/checks/suites.md b/content/rest/checks/suites.md index 2cb37be7f421..cd0d0c5aeb67 100644 --- a/content/rest/checks/suites.md +++ b/content/rest/checks/suites.md @@ -16,6 +16,6 @@ category: > {% data reusables.apps.checks-availability %} > [!NOTE] -> A GitHub App usually only receives one [`check_suite`](/webhooks-and-events/webhooks/webhook-events-and-payloads#check_suite) event per commit SHA, even if you push the commit SHA to more than one branch. To find out when a commit SHA is pushed to a branch, you can subscribe to branch [`create`](/webhooks-and-events/webhooks/webhook-events-and-payloads#create) events. +> A GitHub App usually only receives one [`check_suite`](/webhooks/webhook-events-and-payloads#check_suite) event per commit SHA, even if you push the commit SHA to more than one branch. To find out when a commit SHA is pushed to a branch, you can subscribe to branch [`create`](/webhooks/webhook-events-and-payloads#create) events. diff --git a/content/rest/code-scanning/code-scanning.md b/content/rest/code-scanning/code-scanning.md index 163730aab4e3..bd44b1b40c16 100644 --- a/content/rest/code-scanning/code-scanning.md +++ b/content/rest/code-scanning/code-scanning.md @@ -18,6 +18,6 @@ category: ## About code scanning -You can retrieve and update {% data variables.product.prodname_code_scanning %} alerts from a repository. You can use the endpoints to create automated reports for the {% data variables.product.prodname_code_scanning %} alerts in an organization or upload analysis results generated using offline {% data variables.product.prodname_code_scanning %} tools. For more information, see [AUTOTITLE](/code-security/code-scanning). +You can retrieve and update {% data variables.product.prodname_code_scanning %} alerts from a repository. You can use the endpoints to create automated reports for the {% data variables.product.prodname_code_scanning %} alerts in an organization or upload analysis results generated using offline {% data variables.product.prodname_code_scanning %} tools. For more information, see [AUTOTITLE](/code-security/how-tos/find-and-fix-code-vulnerabilities). diff --git a/content/rest/dependabot/alerts.md b/content/rest/dependabot/alerts.md index a58c42fc6200..322279e6cf56 100644 --- a/content/rest/dependabot/alerts.md +++ b/content/rest/dependabot/alerts.md @@ -17,6 +17,6 @@ category: ## About {% data variables.product.prodname_dependabot_alerts %} -You can view {% data variables.product.prodname_dependabot %} alerts for a repository and update individual alerts with the REST API. For more information, see [AUTOTITLE](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts). +You can view {% data variables.product.prodname_dependabot %} alerts for a repository and update individual alerts with the REST API. For more information, see [AUTOTITLE](/code-security/concepts/supply-chain-security/dependabot-alerts). diff --git a/content/rest/dependabot/secrets.md b/content/rest/dependabot/secrets.md index d3935603827a..9e44d8431bfa 100644 --- a/content/rest/dependabot/secrets.md +++ b/content/rest/dependabot/secrets.md @@ -16,7 +16,7 @@ category: ## About {% data variables.product.prodname_dependabot %} secrets -You can create, update, delete, and retrieve information about encrypted secrets using the REST API. {% data reusables.actions.about-secrets %} For more information, see [AUTOTITLE](/code-security/dependabot/working-with-dependabot/configuring-access-to-private-registries-for-dependabot#storing-credentials-for-dependabot-to-use). +You can create, update, delete, and retrieve information about encrypted secrets using the REST API. {% data reusables.actions.about-secrets %} For more information, see [AUTOTITLE](/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/configure-access-to-private-registries#storing-credentials-for-dependabot-to-use). {% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} must have the `dependabot_secrets` permission to use these endpoints. Authenticated users must have collaborator access to a repository to create, update, or read secrets. diff --git a/content/rest/dependency-graph/dependency-review.md b/content/rest/dependency-graph/dependency-review.md index 1af4e8b53a4c..c93bdc46f13a 100644 --- a/content/rest/dependency-graph/dependency-review.md +++ b/content/rest/dependency-graph/dependency-review.md @@ -14,6 +14,6 @@ category: ## About dependency review -You can use the REST API to view dependency changes, and the security impact of these changes, before you add them to your environment. You can view the diff of dependencies between two commits of a repository, including vulnerability data for any version updates with known vulnerabilities. For more information about dependency review, see [AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review). +You can use the REST API to view dependency changes, and the security impact of these changes, before you add them to your environment. You can view the diff of dependencies between two commits of a repository, including vulnerability data for any version updates with known vulnerabilities. For more information about dependency review, see [AUTOTITLE](/code-security/concepts/supply-chain-security/dependency-review). diff --git a/content/rest/dependency-graph/dependency-submission.md b/content/rest/dependency-graph/dependency-submission.md index ece360e22d9f..255bccfa64c4 100644 --- a/content/rest/dependency-graph/dependency-submission.md +++ b/content/rest/dependency-graph/dependency-submission.md @@ -16,13 +16,13 @@ category: You can use the REST API to submit dependencies for a project. This enables you to add dependencies, such as those resolved when software is compiled or built, to {% data variables.product.prodname_dotcom %}'s dependency graph feature, providing a more complete picture of all of your project's dependencies. -The dependency graph shows any dependencies you submit using the API in addition to any dependencies that are identified from manifest or lock files in the repository (for example, a `package-lock.json` file in a JavaScript project). For more information about viewing the dependency graph, see [AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository#viewing-the-dependency-graph). +The dependency graph shows any dependencies you submit using the API in addition to any dependencies that are identified from manifest or lock files in the repository (for example, a `package-lock.json` file in a JavaScript project). For more information about viewing the dependency graph, see [AUTOTITLE](/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/explore-dependencies#viewing-the-dependency-graph). -Submitted dependencies will receive {% data variables.product.prodname_dependabot_alerts %} and {% data variables.product.prodname_dependabot_security_updates %} for any known vulnerabilities. You will only get {% data variables.product.prodname_dependabot_alerts %} for dependencies that are from one of the supported ecosystems for the {% data variables.product.prodname_advisory_database %}. For more information about these ecosystems, see [AUTOTITLE](/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#github-reviewed-advisories). For transitive dependencies submitted via the {% data variables.dependency-submission-api.name %}, {% data variables.product.prodname_dependabot %} will automatically open pull requests to update the parent dependency, if an update is available. +Submitted dependencies will receive {% data variables.product.prodname_dependabot_alerts %} and {% data variables.product.prodname_dependabot_security_updates %} for any known vulnerabilities. You will only get {% data variables.product.prodname_dependabot_alerts %} for dependencies that are from one of the supported ecosystems for the {% data variables.product.prodname_advisory_database %}. For more information about these ecosystems, see [AUTOTITLE](/code-security/concepts/vulnerability-reporting-and-management/github-advisory-database#github-reviewed-advisories). For transitive dependencies submitted via the {% data variables.dependency-submission-api.name %}, {% data variables.product.prodname_dependabot %} will automatically open pull requests to update the parent dependency, if an update is available. {% data reusables.dependency-submission.about-dependency-submission %} -You can submit dependencies in the form of a snapshot. A snapshot is a set of dependencies associated with a commit SHA and other metadata, that reflects the current state of your repository for a commit. You can choose to use pre-made actions or create your own actions to submit your dependencies in the required format each time your project is built. For more information, see [AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/using-the-dependency-submission-api). +You can submit dependencies in the form of a snapshot. A snapshot is a set of dependencies associated with a commit SHA and other metadata, that reflects the current state of your repository for a commit. You can choose to use pre-made actions or create your own actions to submit your dependencies in the required format each time your project is built. For more information, see [AUTOTITLE](/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/use-dependency-submission-api). You can submit multiple sets of dependencies to be included in your dependency graph. The REST API uses the `job.correlator` property and the `detector.name` category of the snapshot to ensure the latest submissions for each workflow get shown. The `correlator` property itself is the primary field you will use to keep independent submissions distinct. An example `correlator` could be a simple combination of two variables available in actions runs: ` `. diff --git a/content/rest/deploy-keys/deploy-keys.md b/content/rest/deploy-keys/deploy-keys.md index 507e34b5184a..1e45cf3f5d50 100644 --- a/content/rest/deploy-keys/deploy-keys.md +++ b/content/rest/deploy-keys/deploy-keys.md @@ -22,7 +22,7 @@ Deploy keys can either be set up using the following API endpoints, or by using {% ifversion deploy-keys-enterprise-org-policy %} -You may be unable to create deploy keys if your organization or enterprise owner has set a policy to restrict their use. Furthermore, if this policy is enabled at the organization or enterprise level, existing deploy keys may be disabled. For more information, see [AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-deploy-keys) and [AUTOTITLE](/organizations/managing-organization-settings/restricting-deploy-keys-in-your-organization). +You may be unable to create deploy keys if your organization or enterprise owner has set a policy to restrict their use. Furthermore, if this policy is enabled at the organization or enterprise level, existing deploy keys may be disabled. For more information, see [AUTOTITLE](/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-deploy-keys) and [AUTOTITLE](/organizations/managing-organization-settings/restricting-deploy-keys-in-your-organization). {% endif %} There are a few cases when a deploy key will be deleted by other activity: diff --git a/content/rest/deployments/branch-policies.md b/content/rest/deployments/branch-policies.md index 279e84958cd4..02f66a03131a 100644 --- a/content/rest/deployments/branch-policies.md +++ b/content/rest/deployments/branch-policies.md @@ -16,6 +16,6 @@ category: You can use the REST API to specify custom name patterns that branches must match in order to deploy to an environment. The `deployment_branch_policy.custom_branch_policies` property for the environment must be set to `true` to use these endpoints. To update the `deployment_branch_policy` for an environment, see [AUTOTITLE](/rest/deployments/environments#create-or-update-an-environment). -For more information about restricting environment deployments to certain branches, see [AUTOTITLE](/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-branches). +For more information about restricting environment deployments to certain branches, see [AUTOTITLE](/actions/how-tos/deploy/configure-and-manage-deployments/manage-environments#deployment-branches). diff --git a/content/rest/deployments/deployments.md b/content/rest/deployments/deployments.md index a6540dd81522..f6f828ac9c56 100644 --- a/content/rest/deployments/deployments.md +++ b/content/rest/deployments/deployments.md @@ -14,9 +14,9 @@ category: ## About deployments -Deployments are requests to deploy a specific ref (branch, SHA, tag). GitHub dispatches a [`deployment` event](/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment) that external services can listen for and act on when new deployments are created. Deployments enable developers and organizations to build loosely coupled tooling around deployments, without having to worry about the implementation details of delivering different types of applications (e.g., web, native). +Deployments are requests to deploy a specific ref (branch, SHA, tag). GitHub dispatches a [`deployment` event](/webhooks/webhook-events-and-payloads#deployment) that external services can listen for and act on when new deployments are created. Deployments enable developers and organizations to build loosely coupled tooling around deployments, without having to worry about the implementation details of delivering different types of applications (e.g., web, native). -Deployment statuses allow external services to mark deployments with an `error`, `failure`, `pending`, `in_progress`, `queued`, or `success` state that systems listening to [`deployment_status` events](/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment_status) can consume. +Deployment statuses allow external services to mark deployments with an `error`, `failure`, `pending`, `in_progress`, `queued`, or `success` state that systems listening to [`deployment_status` events](/webhooks/webhook-events-and-payloads#deployment_status) can consume. Deployment statuses can also include an optional `description` and `log_url`, which are highly recommended because they make deployment statuses more useful. The `log_url` is the full URL to the deployment output, and the `description` is a high-level summary of what happened with the deployment. diff --git a/content/rest/deployments/environments.md b/content/rest/deployments/environments.md index 0d6f35824fc0..16824685f690 100644 --- a/content/rest/deployments/environments.md +++ b/content/rest/deployments/environments.md @@ -14,7 +14,7 @@ category: ## About deployment environments -For more information about environments, see [AUTOTITLE](/actions/deployment/targeting-different-environments/using-environments-for-deployment). To manage environment secrets, see [AUTOTITLE](/rest/actions/secrets). +For more information about environments, see [AUTOTITLE](/actions/how-tos/deploy/configure-and-manage-deployments/manage-environments). To manage environment secrets, see [AUTOTITLE](/rest/actions/secrets). {% data reusables.gated-features.environments %} diff --git a/content/rest/enterprise-admin/admin-stats.md b/content/rest/enterprise-admin/admin-stats.md index f3d38e2af908..a7374a873390 100644 --- a/content/rest/enterprise-admin/admin-stats.md +++ b/content/rest/enterprise-admin/admin-stats.md @@ -13,7 +13,7 @@ category: {% ifversion ghes %}## About admin stats -These endpoints are only available to [authenticated](/rest/overview/authenticating-to-the-rest-api) site administrators. Normal users will receive a `404` response. +These endpoints are only available to [authenticated](/rest/authentication/authenticating-to-the-rest-api) site administrators. Normal users will receive a `404` response. {% data reusables.user-settings.enterprise-admin-api-classic-pat-only %}{% elsif ghec %}{% data reusables.user-settings.enterprise-admin-api-classic-pat-only %}{% endif %} diff --git a/content/rest/enterprise-admin/announcement.md b/content/rest/enterprise-admin/announcement.md index f81570928f02..07185a314b7b 100644 --- a/content/rest/enterprise-admin/announcement.md +++ b/content/rest/enterprise-admin/announcement.md @@ -12,7 +12,7 @@ category: ## About announcements -You can use the REST API to manage the global announcement banner in your enterprise. For more information, see [AUTOTITLE](/admin/user-management/managing-users-in-your-enterprise/customizing-user-messages-for-your-enterprise#creating-a-global-announcement-banner). +You can use the REST API to manage the global announcement banner in your enterprise. For more information, see [AUTOTITLE](/admin/managing-accounts-and-repositories/communicating-information-to-users-in-your-enterprise/customizing-user-messages-for-your-enterprise#creating-a-global-announcement-banner). {% data reusables.user-settings.enterprise-admin-api-classic-pat-only %} diff --git a/content/rest/enterprise-admin/global-webhooks.md b/content/rest/enterprise-admin/global-webhooks.md index 2f493d70516b..4a6a77dd2fab 100644 --- a/content/rest/enterprise-admin/global-webhooks.md +++ b/content/rest/enterprise-admin/global-webhooks.md @@ -12,11 +12,11 @@ category: ## About global webhooks -These endpoints are only available to [authenticated](/rest/overview/authenticating-to-the-rest-api) site administrators Normal users will receive a `404` response. To learn how to configure global webhooks, see [About global webhooks](/admin/monitoring-activity-in-your-enterprise/exploring-user-activity/managing-global-webhooks). +These endpoints are only available to [authenticated](/rest/authentication/authenticating-to-the-rest-api) site administrators Normal users will receive a `404` response. To learn how to configure global webhooks, see [About global webhooks](/admin/monitoring-activity-in-your-enterprise/exploring-user-activity-in-your-enterprise/managing-global-webhooks). Global webhooks are automatically installed on your enterprise. You can use global webhooks to automatically monitor, respond to, or enforce rules for users, organizations, teams, and repositories on your enterprise. -Global webhooks can subscribe to the [organization](/webhooks-and-events/webhooks/webhook-events-and-payloads#organization), [user](/webhooks-and-events/webhooks/webhook-events-and-payloads#user), [repository](/webhooks-and-events/webhooks/webhook-events-and-payloads#repository), [team](/webhooks-and-events/webhooks/webhook-events-and-payloads#team), [member](/webhooks-and-events/webhooks/webhook-events-and-payloads#member), [membership](/webhooks-and-events/webhooks/webhook-events-and-payloads#membership), [fork](/webhooks-and-events/webhooks/webhook-events-and-payloads#fork), and [ping](/webhooks-and-events/webhooks/about-webhooks#ping-event) event types. +Global webhooks can subscribe to the [organization](/webhooks/webhook-events-and-payloads#organization), [user](/webhooks/webhook-events-and-payloads#user), [repository](/webhooks/webhook-events-and-payloads#repository), [team](/webhooks/webhook-events-and-payloads#team), [member](/webhooks/webhook-events-and-payloads#member), [membership](/webhooks/webhook-events-and-payloads#membership), [fork](/webhooks/webhook-events-and-payloads#fork), and [ping](/webhooks/about-webhooks#ping-event) event types. {% data reusables.user-settings.enterprise-admin-api-classic-pat-only %} diff --git a/content/rest/enterprise-admin/index.md b/content/rest/enterprise-admin/index.md index 3336f7a7c623..99e506ca0b6f 100644 --- a/content/rest/enterprise-admin/index.md +++ b/content/rest/enterprise-admin/index.md @@ -74,11 +74,11 @@ http(s)://HOSTNAME:ADMINISTRATION-PORT/ ## Authentication -Your {% data variables.product.prodname_ghe_server %} installation's API endpoints accept the same authentication methods as the {% data variables.product.github %} API. For more information, see [AUTOTITLE](/rest/overview/authenticating-to-the-rest-api). +Your {% data variables.product.prodname_ghe_server %} installation's API endpoints accept the same authentication methods as the {% data variables.product.github %} API. For more information, see [AUTOTITLE](/rest/authentication/authenticating-to-the-rest-api). OAuth tokens must have the `site_admin` [OAuth scope](/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps#available-scopes) when used with these endpoints. -These endpoints are only accessible to authenticated {% data variables.product.prodname_ghe_server %} site administrators, except for endpoints of the [AUTOTITLE](/rest/enterprise-admin/manage-ghes) API, which allow authentication as a Management Console user. See [AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console). +These endpoints are only accessible to authenticated {% data variables.product.prodname_ghe_server %} site administrators, except for endpoints of the [AUTOTITLE](/rest/enterprise-admin/manage-ghes) API, which allow authentication as a Management Console user. See [AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-web-ui). {% data reusables.enterprise_management_console.api-deprecation %} diff --git a/content/rest/enterprise-admin/ldap.md b/content/rest/enterprise-admin/ldap.md index 4457006611d9..f14898f74e39 100644 --- a/content/rest/enterprise-admin/ldap.md +++ b/content/rest/enterprise-admin/ldap.md @@ -14,7 +14,7 @@ category: ## About LDAP -You can use these endpoints to update the Distinguished Name (DN) that a user or team maps to. Note that in most cases, you must have [LDAP Sync enabled](/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap) for your {% data variables.product.prodname_ghe_server %} appliance. The [Update LDAP mapping for a user](#update-ldap-mapping-for-a-user) endpoint can be used when LDAP is enabled, even if LDAP Sync is disabled. +You can use these endpoints to update the Distinguished Name (DN) that a user or team maps to. Note that in most cases, you must have [LDAP Sync enabled](/admin/managing-iam/using-ldap-for-enterprise-iam/using-ldap) for your {% data variables.product.prodname_ghe_server %} appliance. The [Update LDAP mapping for a user](#update-ldap-mapping-for-a-user) endpoint can be used when LDAP is enabled, even if LDAP Sync is disabled. {% data reusables.user-settings.enterprise-admin-api-classic-pat-only %} diff --git a/content/rest/enterprise-admin/manage-ghes.md b/content/rest/enterprise-admin/manage-ghes.md index 585c454d7da4..4dead8aa4e88 100644 --- a/content/rest/enterprise-admin/manage-ghes.md +++ b/content/rest/enterprise-admin/manage-ghes.md @@ -18,7 +18,7 @@ You can manage {% data variables.location.product_location %} using the Manage { > [!TIP] You can use this API to replace the functionality of the **Management Console API**, which was removed in {% data variables.product.prodname_ghe_server %} version 3.15. -Specify the port number when making API calls to endpoints for the Manage {% data variables.product.prodname_ghe_server %} API. If your instance uses TLS, the port number is 8443. Otherwise, the port number is 8080. If you cannot provide a port number, you'll need to configure your client to automatically follow redirects. For more information, see [AUTOTITLE](/admin/configuration/configuring-network-settings/configuring-tls). +Specify the port number when making API calls to endpoints for the Manage {% data variables.product.prodname_ghe_server %} API. If your instance uses TLS, the port number is 8443. Otherwise, the port number is 8080. If you cannot provide a port number, you'll need to configure your client to automatically follow redirects. For more information, see [AUTOTITLE](/admin/configuring-settings/hardening-security-for-your-enterprise/configuring-tls). You can also use the {% data variables.product.prodname_ghe_server %} extension of the {% data variables.product.prodname_cli %} to invoke endpoints in the Manage {% data variables.product.prodname_ghe_server %} API. For more information, see the [`github/gh-es`](https://github.com/github/gh-es/blob/main/README.md) repository. @@ -32,7 +32,7 @@ curl -L -u "api_key:ROOT-SITE-ADMINISTRATOR-PASSWORD" 'http(s)://HOSTNAME:ADMINI ### Authentication as a {% data variables.enterprise.management_console %} user -{% data variables.enterprise.management_console %} user accounts can also authenticate to access these endpoints. For more information, see [AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console/managing-access-to-the-management-console#management-console-user). +{% data variables.enterprise.management_console %} user accounts can also authenticate to access these endpoints. For more information, see [AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-web-ui/managing-access-to-the-management-console#management-console-user). To authenticate with the password for a {% data variables.enterprise.management_console %} user account, use standard HTTP authentication. In the following example, replace YOUR_USER_NAME and YOUR_PASSWORD with the account's user name and password. @@ -47,7 +47,7 @@ By default, the response includes information from about all configured nodes fo | Query parameter | Description | | :- | :- | | `uuid` | Unique identifier for the node. | -| `cluster_role` | For nodes in a cluster, the roles that apply to the node. For more information, see [AUTOTITLE](/admin/enterprise-management/configuring-clustering/about-cluster-nodes). | +| `cluster_role` | For nodes in a cluster, the roles that apply to the node. For more information, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/configuring-clustering/about-cluster-nodes). | You can specify multiple values for the query parameter by delimiting the values with a comma. For example, the following request uses curl to return any nodes with the `web-server` or `storage-server` role. diff --git a/content/rest/enterprise-admin/orgs.md b/content/rest/enterprise-admin/orgs.md index 32163bf84291..5b2d52938aad 100644 --- a/content/rest/enterprise-admin/orgs.md +++ b/content/rest/enterprise-admin/orgs.md @@ -12,7 +12,7 @@ category: ## About organization administration -These endpoints are only available to [authenticated](/rest/overview/authenticating-to-the-rest-api) site administrators. Normal users will receive a `404` response. +These endpoints are only available to [authenticated](/rest/authentication/authenticating-to-the-rest-api) site administrators. Normal users will receive a `404` response. {% data reusables.user-settings.enterprise-admin-api-classic-pat-only %} diff --git a/content/rest/enterprise-admin/pre-receive-environments.md b/content/rest/enterprise-admin/pre-receive-environments.md index 0a8705de1c8b..8de47a5f7310 100644 --- a/content/rest/enterprise-admin/pre-receive-environments.md +++ b/content/rest/enterprise-admin/pre-receive-environments.md @@ -14,7 +14,7 @@ category: ## About pre-receive environments -These endpoints are only available to [authenticated](/rest/overview/authenticating-to-the-rest-api) site administrators. Normal users will receive a `404` response. +These endpoints are only available to [authenticated](/rest/authentication/authenticating-to-the-rest-api) site administrators. Normal users will receive a `404` response. {% data reusables.user-settings.enterprise-admin-api-classic-pat-only %} diff --git a/content/rest/enterprise-admin/pre-receive-hooks.md b/content/rest/enterprise-admin/pre-receive-hooks.md index a17160517d6f..4b493831aaad 100644 --- a/content/rest/enterprise-admin/pre-receive-hooks.md +++ b/content/rest/enterprise-admin/pre-receive-hooks.md @@ -12,7 +12,7 @@ category: ## About pre-receive hooks -These endpoints are only available to [authenticated](/rest/overview/authenticating-to-the-rest-api) site administrators. Normal users will receive a `404` response. +These endpoints are only available to [authenticated](/rest/authentication/authenticating-to-the-rest-api) site administrators. Normal users will receive a `404` response. {% data reusables.user-settings.enterprise-admin-api-classic-pat-only %} diff --git a/content/rest/enterprise-admin/scim.md b/content/rest/enterprise-admin/scim.md index 9d40bef38c5d..24b337362d2c 100644 --- a/content/rest/enterprise-admin/scim.md +++ b/content/rest/enterprise-admin/scim.md @@ -23,7 +23,7 @@ category: {% ifversion ghec %} -{% data reusables.enterprise_user_management.about-scim-provisioning %} If you don't use a partner IdP with an existing integration, you can integrate using the following API endpoints. For more information, see [AUTOTITLE](/admin/identity-and-access-management/provisioning-user-accounts-for-enterprise-managed-users/provisioning-users-with-scim-using-the-rest-api). +{% data reusables.enterprise_user_management.about-scim-provisioning %} If you don't use a partner IdP with an existing integration, you can integrate using the following API endpoints. For more information, see [AUTOTITLE](/admin/managing-iam/provisioning-user-accounts-with-scim/provisioning-users-and-groups-with-scim-using-the-rest-api). ### Base URL @@ -35,9 +35,9 @@ To manage your enterprise's users and groups using SCIM, use the following base ### Authentication -To authenticate API requests, the person who configures SCIM on the IdP must use a {% data variables.product.pat_v1 %} with `scim:enterprise` scope, which the IdP must provide in the request's `Authorization` header. For more information about {% data variables.product.pat_v1_plural %}, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token). +To authenticate API requests, the person who configures SCIM on the IdP must use a {% data variables.product.pat_v1 %} with `scim:enterprise` scope, which the IdP must provide in the request's `Authorization` header. For more information about {% data variables.product.pat_v1_plural %}, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens). -{% data variables.product.company_short %} recommends authenticating as the setup user for the enterprise. Other user accounts are created through SCIM, so authenticating as a different user could result in unintended consequences, such as getting locked out of your enterprise. Write requests to these APIs are possible through our published IdP applications, or through direct API access to our SCIM endpoints. If another enterprise owner needs to read information from the API, use a {% data variables.product.pat_v1 %} with the `admin:enterprise` scope to make `GET` requests on your current SCIM implementation. For more information, see [AUTOTITLE](/admin/identity-and-access-management/provisioning-user-accounts-for-enterprise-managed-users/configuring-scim-provisioning-for-enterprise-managed-users#creating-a-personal-access-token). +{% data variables.product.company_short %} recommends authenticating as the setup user for the enterprise. Other user accounts are created through SCIM, so authenticating as a different user could result in unintended consequences, such as getting locked out of your enterprise. Write requests to these APIs are possible through our published IdP applications, or through direct API access to our SCIM endpoints. If another enterprise owner needs to read information from the API, use a {% data variables.product.pat_v1 %} with the `admin:enterprise` scope to make `GET` requests on your current SCIM implementation. For more information, see [AUTOTITLE](/admin/managing-iam/provisioning-user-accounts-with-scim/configuring-scim-provisioning-for-users#creating-a-personal-access-token). ### Mapping of SAML and SCIM data @@ -71,7 +71,7 @@ To use other IdPs for SAML, the following SAML claims and SCIM attribute must ma | `name.formatted` | String | The user's full name, including all middle names, titles, and suffixes, formatted for display.| | `name.givenName` | String | The first name of the user. | | `name.familyName` | String | The last name of the user. | -| `userName` | String | The username for the user, generated by the SCIM provider. Undergoes [normalization](/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication#about-username-normalization) before being used. Must be unique per user. | +| `userName` | String | The username for the user, generated by the SCIM provider. Undergoes [normalization](/admin/managing-iam/iam-configuration-reference/username-considerations-for-external-authentication#about-username-normalization) before being used. Must be unique per user. | | `emails` | Array | List of the user's emails. | | `roles` | Array | List of the user's roles. | | `externalId` | String | This identifier is generated by a SCIM provider. Must be unique per user. | @@ -116,9 +116,9 @@ GET /scim/v2/Users/{scim_user_id} ### Authentication -The SCIM integration on the IdP performs actions on behalf of an enterprise owner for the {% data variables.product.prodname_ghe_server %} instance. For more information, see [AUTOTITLE](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise#enterprise-owners). +The SCIM integration on the IdP performs actions on behalf of an enterprise owner for the {% data variables.product.prodname_ghe_server %} instance. For more information, see [AUTOTITLE](/admin/managing-accounts-and-repositories/managing-roles-in-your-enterprise/abilities-of-roles#enterprise-owners). -To authenticate API requests, the person who configures SCIM on the IdP must use a {% data variables.product.pat_v1 %} with the {% ifversion scim-enterprise-scope %}`scim:enterprise`{% else %}`admin:enterprise`{% endif %} scope, which the IdP must provide in the request's `Authorization` header. For more information about {% data variables.product.pat_v1_plural %}, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token). +To authenticate API requests, the person who configures SCIM on the IdP must use a {% data variables.product.pat_v1 %} with the {% ifversion scim-enterprise-scope %}`scim:enterprise`{% else %}`admin:enterprise`{% endif %} scope, which the IdP must provide in the request's `Authorization` header. For more information about {% data variables.product.pat_v1_plural %}, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens). > [!NOTE] > Enterprise owners must generate and use a {% data variables.product.pat_v1 %} for authentication of requests to endpoints in this category. {% data variables.product.pat_v2_caps %} and GitHub app callers are not supported at this time. @@ -157,7 +157,7 @@ To use other IdPs for SAML, {% data variables.product.company_short %} will use | `name.formatted` | String | The user's full name, including all middle names, titles, and suffixes, formatted for display. | `name.givenName` | String | The first name of the user. | | `name.familyName` | String | The last name of the user. | -| `userName` | String | The username for the user, generated by the IdP. Undergoes [normalization](/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication#about-username-normalization) before being used. +| `userName` | String | The username for the user, generated by the IdP. Undergoes [normalization](/admin/managing-iam/iam-configuration-reference/username-considerations-for-external-authentication#about-username-normalization) before being used. | `emails` | Array | List of the user's emails. | | `roles` | Array | List of the user's roles. | | `externalId` | String | This identifier is generated by an IdP provider. You can find the `externalId` for a user either on the IdP, or by using the [List SCIM provisioned identities](#list-scim-provisioned-identities-for-an-enterprise) endpoint and filtering on other known attributes, such as a user's username or email address on the {% data variables.product.prodname_ghe_server %} instance. | diff --git a/content/rest/enterprise-admin/users.md b/content/rest/enterprise-admin/users.md index e18c62a56305..4f423b03ae6d 100644 --- a/content/rest/enterprise-admin/users.md +++ b/content/rest/enterprise-admin/users.md @@ -14,7 +14,7 @@ category: ## About user administration -These endpoints are only available to [authenticated](/rest/overview/authenticating-to-the-rest-api) site administrators. Normal users will receive a `403` response. +These endpoints are only available to [authenticated](/rest/authentication/authenticating-to-the-rest-api) site administrators. Normal users will receive a `403` response. {% data reusables.user-settings.enterprise-admin-api-classic-pat-only %} diff --git a/content/rest/git/blobs.md b/content/rest/git/blobs.md index 98c45c14f8ca..aed9e9eab043 100644 --- a/content/rest/git/blobs.md +++ b/content/rest/git/blobs.md @@ -17,6 +17,6 @@ category: ## About Git blobs A Git blob (binary large object) is the object type used to store the contents of each file in a repository. The file's SHA-1 hash is computed and stored in the blob object. These endpoints allow you to read and write [blob objects](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects) -to your Git database on {% data variables.product.github %}. Blobs leverage custom media types. For more information about the use of media types in the API, see [AUTOTITLE](/rest/overview/media-types). +to your Git database on {% data variables.product.github %}. Blobs leverage custom media types. For more information about the use of media types in the API, see [AUTOTITLE](/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). diff --git a/content/rest/guides/building-a-ci-server.md b/content/rest/guides/building-a-ci-server.md index e2c92dab91b3..6b29cf3add10 100644 --- a/content/rest/guides/building-a-ci-server.md +++ b/content/rest/guides/building-a-ci-server.md @@ -29,13 +29,13 @@ Travis, Jenkins, or something else entirely. The crux of this guide will be sett and configuring the server managing the communication. If you haven't already, [download `ngrok`](https://ngrok.com/), and learn how -to [use it](/webhooks-and-events/webhooks/configuring-your-server-to-receive-payloads#using-ngrok). We find it to be a very useful tool for exposing local +to [use it](/webhooks/using-webhooks/handling-webhook-deliveries#using-ngrok). We find it to be a very useful tool for exposing local applications to the internet. {% ifversion cli-webhook-forwarding %} > [!NOTE] -> Alternatively, you can use webhook forwarding to set up your local environment to receive webhooks. For more information, see [AUTOTITLE](/webhooks-and-events/webhooks/receiving-webhooks-with-the-github-cli). +> Alternatively, you can use webhook forwarding to set up your local environment to receive webhooks. For more information, see [AUTOTITLE](/webhooks/testing-and-troubleshooting-webhooks/using-the-github-cli-to-forward-webhooks-for-testing). {% endif %} @@ -115,7 +115,7 @@ new pull request every time you make a change! Since we're interacting with the {% data variables.product.github %} API, we'll use [Octokit.rb](https://github.com/octokit/octokit.rb) to manage our interactions. We'll configure that client with -[a {% data variables.product.pat_generic %}](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token): +[a {% data variables.product.pat_generic %}](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens): ``` ruby # !!! DO NOT EVER USE HARD-CODED VALUES IN A REAL APP !!! diff --git a/content/rest/guides/delivering-deployments.md b/content/rest/guides/delivering-deployments.md index b8811352794e..16696b0e6fc4 100644 --- a/content/rest/guides/delivering-deployments.md +++ b/content/rest/guides/delivering-deployments.md @@ -29,13 +29,13 @@ Heroku, Amazon, or something else entirely. The crux of this guide will be setti and configuring the server managing the communication. If you haven't already, be sure to [download `ngrok`](https://ngrok.com/), and learn how -to [use it](/webhooks-and-events/webhooks/configuring-your-server-to-receive-payloads#using-ngrok). We find it to be a very useful tool for exposing local +to [use it](/webhooks/using-webhooks/handling-webhook-deliveries#using-ngrok). We find it to be a very useful tool for exposing local applications to the internet. {% ifversion cli-webhook-forwarding %} > [!NOTE] -> Alternatively, you can use webhook forwarding to set up your local environment to receive webhooks. For more information, see [AUTOTITLE](/webhooks-and-events/webhooks/receiving-webhooks-with-the-github-cli). +> Alternatively, you can use webhook forwarding to set up your local environment to receive webhooks. For more information, see [AUTOTITLE](/webhooks/testing-and-troubleshooting-webhooks/using-the-github-cli-to-forward-webhooks-for-testing). {% endif %} diff --git a/content/rest/guides/discovering-resources-for-a-user.md b/content/rest/guides/discovering-resources-for-a-user.md index 669b9a8a3e7d..cc028782d20d 100644 --- a/content/rest/guides/discovering-resources-for-a-user.md +++ b/content/rest/guides/discovering-resources-for-a-user.md @@ -29,7 +29,7 @@ In addition to having their own personal repositories, a user may be a collabora [OAuth scopes](/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps) and [organization application policies](https://developer.github.com/changes/2015-01-19-an-integrators-guide-to-organization-application-policies/) determine which of those repositories your app can access for a user. Use the workflow below to discover those repositories. -As always, first we'll require [GitHub's Octokit.rb](https://github.com/octokit/octokit.rb) Ruby library. Then we'll configure Octokit.rb to automatically handle pagination for us. For more information about pagination, see [AUTOTITLE](/rest/guides/using-pagination-in-the-rest-api). +As always, first we'll require [GitHub's Octokit.rb](https://github.com/octokit/octokit.rb) Ruby library. Then we'll configure Octokit.rb to automatically handle pagination for us. For more information about pagination, see [AUTOTITLE](/rest/using-the-rest-api/using-pagination-in-the-rest-api). ``` ruby require 'octokit' @@ -66,7 +66,7 @@ end Applications can perform all sorts of organization-related tasks for a user. To perform these tasks, the app needs an [OAuth authorization](/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps) with sufficient permission. For example, the `read:org` scope allows you to [list teams](/rest/teams/teams#list-teams), and the `user` scope lets you [publicize the user’s organization membership](/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user). Once a user has granted one or more of these scopes to your app, you're ready to fetch the user’s organizations. -Just as we did when discovering repositories above, we'll start by requiring [GitHub's Octokit.rb](https://github.com/octokit/octokit.rb) Ruby library and configuring it to take care of pagination for us. For more information about pagination, see [AUTOTITLE](/rest/guides/using-pagination-in-the-rest-api). +Just as we did when discovering repositories above, we'll start by requiring [GitHub's Octokit.rb](https://github.com/octokit/octokit.rb) Ruby library and configuring it to take care of pagination for us. For more information about pagination, see [AUTOTITLE](/rest/using-the-rest-api/using-pagination-in-the-rest-api). ``` ruby require 'octokit' diff --git a/content/rest/guides/scripting-with-the-rest-api-and-javascript.md b/content/rest/guides/scripting-with-the-rest-api-and-javascript.md index 2378baebea5b..b0f6eac9f09d 100644 --- a/content/rest/guides/scripting-with-the-rest-api-and-javascript.md +++ b/content/rest/guides/scripting-with-the-rest-api-and-javascript.md @@ -17,7 +17,7 @@ If you want to write a script using JavaScript to interact with {% data variable ## Prerequisites -This guide assumes that you are familiar with JavaScript and the {% data variables.product.company_short %} REST API. For more information about the REST API, see [AUTOTITLE](/rest/guides/getting-started-with-the-rest-api). +This guide assumes that you are familiar with JavaScript and the {% data variables.product.company_short %} REST API. For more information about the REST API, see [AUTOTITLE](/rest/using-the-rest-api/getting-started-with-the-rest-api). You must install and import `octokit` in order to use the Octokit.js library. This guide uses import statements in accordance with ES6. For more information about different installation and import methods, see [the Octokit.js README's Usage section](https://github.com/octokit/octokit.js/#usage). @@ -26,17 +26,17 @@ You must install and import `octokit` in order to use the Octokit.js library. Th > [!WARNING] > Treat your authentication credentials like a password. > -> To keep your credentials secure, you can store your credentials as a secret and run your script through {% data variables.product.prodname_actions %}. For more information, see [AUTOTITLE](/actions/security-guides/encrypted-secrets). +> To keep your credentials secure, you can store your credentials as a secret and run your script through {% data variables.product.prodname_actions %}. For more information, see [AUTOTITLE](/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets). {% ifversion ghec or fpt %} > -> You can also store your credentials as a {% data variables.product.prodname_codespaces %} secret and run your script in {% data variables.product.prodname_codespaces %}. For more information, see [AUTOTITLE](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces). +> You can also store your credentials as a {% data variables.product.prodname_codespaces %} secret and run your script in {% data variables.product.prodname_codespaces %}. For more information, see [AUTOTITLE](/codespaces/managing-your-codespaces/managing-your-account-specific-secrets-for-github-codespaces). {% endif %} > > If {% ifversion ghec or fpt %}these options are not possible{% else %}this is not possible{% endif %}, consider using another CLI service to store your credentials securely. ### Authenticating with a {% data variables.product.pat_generic %} -If you want to use the {% data variables.product.company_short %} REST API for personal use, you can create a {% data variables.product.pat_generic %}. For more information about creating a {% data variables.product.pat_generic %}, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token). +If you want to use the {% data variables.product.company_short %} REST API for personal use, you can create a {% data variables.product.pat_generic %}. For more information about creating a {% data variables.product.pat_generic %}, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens). First, import `Octokit` from `octokit`. Then, pass your {% data variables.product.pat_generic %} when you create an instance of `Octokit`. In the following example, replace `YOUR-TOKEN` with a reference to your {% data variables.product.pat_generic %}.{% ifversion ghes %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}.{% endif %} @@ -51,7 +51,7 @@ const octokit = new Octokit({ {% ifversion ghes %} ### Authenticating with a {% data variables.product.prodname_github_app %} -If you want to use the API on behalf of an organization or another user, {% data variables.product.company_short %} recommends that you use a {% data variables.product.prodname_github_app %}. If an endpoint is available to {% data variables.product.prodname_github_apps %}, the REST reference documentation for that endpoint will indicate what type of {% data variables.product.prodname_github_app %} token is required. For more information, see [AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app) and [AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/about-authentication-with-a-github-app). +If you want to use the API on behalf of an organization or another user, {% data variables.product.company_short %} recommends that you use a {% data variables.product.prodname_github_app %}. If an endpoint is available to {% data variables.product.prodname_github_apps %}, the REST reference documentation for that endpoint will indicate what type of {% data variables.product.prodname_github_app %} token is required. For more information, see [AUTOTITLE](/apps/creating-github-apps/registering-a-github-app/registering-a-github-app) and [AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/about-authentication-with-a-github-app). Instead of importing `Octokit` from `octokit`, import `App`. In the following example, replace `APP_ID` with a reference to your app's ID. Replace `PRIVATE_KEY` with a reference to your app's private key. Replace `INSTALLATION_ID` with the ID of the installation of your app that you want to authenticate on behalf of. You can find your app's ID and generate a private key on the settings page for your app. For more information, see [AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/managing-private-keys-for-github-apps). You can get an installation ID with the `GET /users/{username}/installation`, `GET /repos/{owner}/{repo}/installation`, or `GET /orgs/{org}/installation` endpoints. For more information, see [AUTOTITLE](/rest/apps/apps).{% ifversion ghes %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}.{% endif %} @@ -73,7 +73,7 @@ const octokit = await app.getInstallationOctokit(INSTALLATION_ID); If you want to use the API in a {% data variables.product.prodname_actions %} workflow, {% data variables.product.company_short %} recommends that you authenticate with the built-in `GITHUB_TOKEN` instead of creating a token. You can grant permissions to the `GITHUB_TOKEN` with the `permissions` key. For more information about `GITHUB_TOKEN`, see [AUTOTITLE](/actions/concepts/security/github_token). -If your workflow needs to access resources outside of the workflow's repository, then you will not be able to use `GITHUB_TOKEN`. In that case, store your credentials as a secret and replace `GITHUB_TOKEN` in the examples below with the name of your secret. For more information about secrets, see [AUTOTITLE](/actions/security-guides/encrypted-secrets). +If your workflow needs to access resources outside of the workflow's repository, then you will not be able to use `GITHUB_TOKEN`. In that case, store your credentials as a secret and replace `GITHUB_TOKEN` in the examples below with the name of your secret. For more information about secrets, see [AUTOTITLE](/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets). If you use the `run` keyword to execute your JavaScript script in your {% data variables.product.prodname_actions %} workflows, you can store the value of `GITHUB_TOKEN` as an environment variable. Your script can access the environment variable as `process.env.VARIABLE_NAME`. @@ -229,7 +229,7 @@ const iterator = octokit.paginate.iterator(octokit.rest.issues.listForRepo, { }); ``` -For more information about pagination, see [AUTOTITLE](/rest/guides/using-pagination-in-the-rest-api). +For more information about pagination, see [AUTOTITLE](/rest/using-the-rest-api/using-pagination-in-the-rest-api). ## Catching errors diff --git a/content/rest/guides/scripting-with-the-rest-api-and-ruby.md b/content/rest/guides/scripting-with-the-rest-api-and-ruby.md index a0e0e8556352..e3d16db13cd3 100644 --- a/content/rest/guides/scripting-with-the-rest-api-and-ruby.md +++ b/content/rest/guides/scripting-with-the-rest-api-and-ruby.md @@ -17,7 +17,7 @@ If you want to write a script using Ruby to interact with the {% data variables. ## Prerequisites -This guide assumes that you are familiar with Ruby and the {% data variables.product.company_short %} REST API. For more information about the REST API, see [AUTOTITLE](/rest/guides/getting-started-with-the-rest-api). +This guide assumes that you are familiar with Ruby and the {% data variables.product.company_short %} REST API. For more information about the REST API, see [AUTOTITLE](/rest/using-the-rest-api/getting-started-with-the-rest-api). You must install and import the `octokit` gem in order to use the Octokit.rb library. This guide uses import statements in accordance with Ruby's conventions. For more information about different installation methods, see [the Octokit.rb README's Installation section](https://github.com/octokit/octokit.rb/#installation). @@ -26,10 +26,10 @@ You must install and import the `octokit` gem in order to use the Octokit.rb lib > [!WARNING] > Treat your authentication credentials like a password. > -> To keep your credentials secure, you can store your credentials as a secret and run your script through {% data variables.product.prodname_actions %}. For more information, see [AUTOTITLE](/actions/security-guides/encrypted-secrets). +> To keep your credentials secure, you can store your credentials as a secret and run your script through {% data variables.product.prodname_actions %}. For more information, see [AUTOTITLE](/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets). {% ifversion ghec or fpt %} > -> You can also store your credentials as a {% data variables.product.prodname_codespaces %} secret and run your script in {% data variables.product.prodname_codespaces %}. For more information, see [AUTOTITLE](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces). +> You can also store your credentials as a {% data variables.product.prodname_codespaces %} secret and run your script in {% data variables.product.prodname_codespaces %}. For more information, see [AUTOTITLE](/codespaces/managing-your-codespaces/managing-your-account-specific-secrets-for-github-codespaces). {% endif %} > > If {% ifversion ghec or fpt %}these options are not possible{% else %}this is not possible{% endif %}, consider using another CLI service to store your credentials securely. @@ -48,7 +48,7 @@ octokit = Octokit::Client.new(access_token: 'YOUR-TOKEN') ### Authenticating with a {% data variables.product.prodname_github_app %} -If you want to use the API on behalf of an organization or another user, {% data variables.product.company_short %} recommends that you use a {% data variables.product.prodname_github_app %}. If an endpoint is available to {% data variables.product.prodname_github_apps %}, the REST reference documentation for that endpoint will indicate what type of {% data variables.product.prodname_github_app %} token is required. For more information, see [AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app) and [AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/about-authentication-with-a-github-app). +If you want to use the API on behalf of an organization or another user, {% data variables.product.company_short %} recommends that you use a {% data variables.product.prodname_github_app %}. If an endpoint is available to {% data variables.product.prodname_github_apps %}, the REST reference documentation for that endpoint will indicate what type of {% data variables.product.prodname_github_app %} token is required. For more information, see [AUTOTITLE](/apps/creating-github-apps/registering-a-github-app/registering-a-github-app) and [AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/about-authentication-with-a-github-app). Instead of requiring `octokit`, create an instance of `Octokit::Client` by passing your {% data variables.product.prodname_github_app %}'s information as options. In the following example, replace `APP_ID` with your app's ID, `PRIVATE_KEY` with your app's private key, and `INSTALLATION_ID` with the ID of the installation of your app that you want to authenticate on behalf of. You can find your app's ID and generate a private key on the settings page for your app. For more information, see [AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/managing-private-keys-for-github-apps). You can get an installation ID with the `GET /users/{username}/installation`, `GET /repos/{owner}/{repo}/installation`, or `GET /orgs/{org}/installation` endpoints. For more information, see [AUTOTITLE](/rest/apps/apps).{% ifversion ghes %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}.{% endif %} @@ -68,7 +68,7 @@ octokit = Octokit::Client.new(bearer_token: app.create_app_installation.access_t If you want to use the API in a {% data variables.product.prodname_actions %} workflow, {% data variables.product.company_short %} recommends that you authenticate with the built-in `GITHUB_TOKEN` instead of creating a token. You can grant permissions to the `GITHUB_TOKEN` with the `permissions` key. For more information about `GITHUB_TOKEN`, see [AUTOTITLE](/actions/concepts/security/github_token). -If your workflow needs to access resources outside of the workflow's repository, then you will not be able to use `GITHUB_TOKEN`. In that case, store your credentials as a secret and replace `GITHUB_TOKEN` in the examples below with the name of your secret. For more information about secrets, see [AUTOTITLE](/actions/security-guides/using-secrets-in-github-actions). +If your workflow needs to access resources outside of the workflow's repository, then you will not be able to use `GITHUB_TOKEN`. In that case, store your credentials as a secret and replace `GITHUB_TOKEN` in the examples below with the name of your secret. For more information about secrets, see [AUTOTITLE](/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets). If you use the `run` keyword to execute your Ruby script in your {% data variables.product.prodname_actions %} workflows, you can store the value of `GITHUB_TOKEN` as an environment variable. Your script can access the environment variable as `ENV['VARIABLE_NAME']`. @@ -174,7 +174,7 @@ You can use the `paginate` method with the `rest` endpoint methods as well. Pass iterator = octokit.paginate.iterator(octokit.rest.issues.list_for_repo, owner: "github", repo: "docs", per_page: 100) ``` -For more information about pagination, see [AUTOTITLE](/rest/guides/using-pagination-in-the-rest-api). +For more information about pagination, see [AUTOTITLE](/rest/using-the-rest-api/using-pagination-in-the-rest-api). ## Catching errors diff --git a/content/rest/guides/using-the-rest-api-to-interact-with-checks.md b/content/rest/guides/using-the-rest-api-to-interact-with-checks.md index 65a5bdd940e0..c32447fc8343 100644 --- a/content/rest/guides/using-the-rest-api-to-interact-with-checks.md +++ b/content/rest/guides/using-the-rest-api-to-interact-with-checks.md @@ -16,7 +16,7 @@ category: Rather than binary pass/fail build statuses, {% data variables.product.prodname_github_apps %} can report rich statuses, annotate lines of code with detailed information, and re-run tests. REST API to manage checks is available exclusively to your GitHub Apps. -For an example of how to use the REST API with a {% data variables.product.prodname_github_app %}, see [AUTOTITLE](/apps/creating-github-apps/guides/creating-ci-tests-with-the-checks-api). +For an example of how to use the REST API with a {% data variables.product.prodname_github_app %}, see [AUTOTITLE](/apps/creating-github-apps/writing-code-for-a-github-app/building-ci-checks-with-a-github-app). You can use statuses with [protected branches](/rest/repos#branches) to prevent people from merging pull requests prematurely. For more information, see [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-status-checks-before-merging). @@ -45,7 +45,7 @@ If you don't want to use the default automatic flow, you can control when you cr {% data reusables.apps.checks-availability %} -To use the endpoints to manage check suites, the {% data variables.product.prodname_github_app %} must have the `checks:write` permission and can also subscribe to the [check_suite](/webhooks-and-events/webhooks/webhook-events-and-payloads#check_suite) webhook. +To use the endpoints to manage check suites, the {% data variables.product.prodname_github_app %} must have the `checks:write` permission and can also subscribe to the [check_suite](/webhooks/webhook-events-and-payloads#check_suite) webhook. {% data reusables.shortdesc.authenticating_github_app %} @@ -66,15 +66,15 @@ If the status is `completed`, the conclusion can be any of the following: If a check run is in an incomplete state for more than 14 days, then the check run's `conclusion` becomes `stale` and appears on {% data variables.product.prodname_dotcom %} as stale with {% octicon "issue-reopened" aria-label="The issue-reopened icon" %}. Only {% data variables.product.prodname_dotcom %} can mark check runs as `stale`. For more information about possible conclusions of a check run, see the [`conclusion` parameter](/rest/checks#create-a-check-run--parameters). -As soon as you receive the [`check_suite`](/webhooks-and-events/webhooks/webhook-events-and-payloads#check_suite) webhook, you can create the check run, even if the check is not complete. You can update the `status` of the check run as it completes with the values `queued`, `in_progress`, or `completed`, and you can update the `output` as more details become available. A check run can contain timestamps, a link to more details on your external site, detailed annotations for specific lines of code, and information about the analysis performed. +As soon as you receive the [`check_suite`](/webhooks/webhook-events-and-payloads#check_suite) webhook, you can create the check run, even if the check is not complete. You can update the `status` of the check run as it completes with the values `queued`, `in_progress`, or `completed`, and you can update the `output` as more details become available. A check run can contain timestamps, a link to more details on your external site, detailed annotations for specific lines of code, and information about the analysis performed. Annotations add information from your check run to specific lines of code. Each annotation includes an `annotation_level` property, which can be `notice`, `warning`, or `failure`. The annotation also includes `path`, `start_line`, and `end_line` to specify what location the annotation refers to. The annotation includes a `message` to describe the result. For more information, see [AUTOTITLE](/rest/checks/runs). -A check can also be manually re-run in the GitHub UI. See [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks#checks) for more details. When this occurs, the {% data variables.product.prodname_github_app %} that created the check run will receive the [`check_run`](/webhooks-and-events/webhooks/webhook-events-and-payloads#check_run) webhook requesting a new check run. If you create a check run without creating a check suite, {% data variables.product.github %} creates the check suite for you automatically. +A check can also be manually re-run in the GitHub UI. See [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks#checks) for more details. When this occurs, the {% data variables.product.prodname_github_app %} that created the check run will receive the [`check_run`](/webhooks/webhook-events-and-payloads#check_run) webhook requesting a new check run. If you create a check run without creating a check suite, {% data variables.product.github %} creates the check suite for you automatically. {% data reusables.apps.checks-availability %} -To use the endpoints to manage check runs, the {% data variables.product.prodname_github_app %} must have the `checks:write` permission and can also subscribe to the [check_run](/webhooks-and-events/webhooks/webhook-events-and-payloads#check_run) webhook. +To use the endpoints to manage check runs, the {% data variables.product.prodname_github_app %} must have the `checks:write` permission and can also subscribe to the [check_run](/webhooks/webhook-events-and-payloads#check_run) webhook. ## Check runs and requested actions @@ -92,9 +92,9 @@ To create a button that can request additional actions from your app, use the [` }] ``` -When a user clicks the button, {% data variables.product.prodname_dotcom %} sends the [`check_run.requested_action` webhook](/webhooks-and-events/webhooks/webhook-events-and-payloads#check_run) to your app. When your app receives a `check_run.requested_action` webhook event, it can look for the `requested_action.identifier` key in the webhook payload to determine which button was clicked and perform the requested task. +When a user clicks the button, {% data variables.product.prodname_dotcom %} sends the [`check_run.requested_action` webhook](/webhooks/webhook-events-and-payloads#check_run) to your app. When your app receives a `check_run.requested_action` webhook event, it can look for the `requested_action.identifier` key in the webhook payload to determine which button was clicked and perform the requested task. -For a detailed example of how to set up requested actions with the REST API, see [AUTOTITLE](/apps/creating-github-apps/guides/creating-ci-tests-with-the-checks-api#part-2-creating-the-octo-rubocop-ci-test). +For a detailed example of how to set up requested actions with the REST API, see [AUTOTITLE](/apps/creating-github-apps/writing-code-for-a-github-app/building-ci-checks-with-a-github-app#part-2-creating-the-octo-rubocop-ci-test). ## Retention of checks data diff --git a/content/rest/guides/working-with-comments.md b/content/rest/guides/working-with-comments.md index 6aadd77186ab..f6ec4d1b4ff0 100644 --- a/content/rest/guides/working-with-comments.md +++ b/content/rest/guides/working-with-comments.md @@ -31,7 +31,7 @@ Request is just an Issue with code, it makes sense to use these endpoints to create comments on a Pull Request. We'll demonstrate fetching Pull Request comments by creating a Ruby script using -[Octokit.rb](https://github.com/octokit/octokit.rb). You'll also want to create a [{% data variables.product.pat_generic %}](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token). +[Octokit.rb](https://github.com/octokit/octokit.rb). You'll also want to create a [{% data variables.product.pat_generic %}](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens). The following code should help you get started accessing comments from a Pull Request using Octokit.rb: diff --git a/content/rest/issues/events.md b/content/rest/issues/events.md index d982a313c6e7..2d7b6e942c95 100644 --- a/content/rest/issues/events.md +++ b/content/rest/issues/events.md @@ -16,7 +16,7 @@ category: ## About events -You can use the REST API to view different types of events triggered by activity in issues and pull requests. For more information about the specific events that you can receive, see [AUTOTITLE](/webhooks-and-events/events/issue-event-types). To view {% data variables.product.github %} activity outside of issues and pull requests, you can use the [Events](/webhooks-and-events/events/github-event-types) endpoints. +You can use the REST API to view different types of events triggered by activity in issues and pull requests. For more information about the specific events that you can receive, see [AUTOTITLE](/rest/using-the-rest-api/issue-event-types). To view {% data variables.product.github %} activity outside of issues and pull requests, you can use the [Events](/rest/using-the-rest-api/github-event-types) endpoints. {% data reusables.pull_requests.issues-pr-shared-api %} diff --git a/content/rest/issues/timeline.md b/content/rest/issues/timeline.md index 645590805737..9d9f51b6507f 100644 --- a/content/rest/issues/timeline.md +++ b/content/rest/issues/timeline.md @@ -16,7 +16,7 @@ category: ## About timeline events -You can use the REST API to view different types of events triggered by timeline activity in issues and pull requests. For more information about the specific events that you can receive, see [AUTOTITLE](/webhooks-and-events/events/issue-event-types). To view {% data variables.product.github %} activity outside of issues and pull requests, see [AUTOTITLE](/webhooks-and-events/events/github-event-types). +You can use the REST API to view different types of events triggered by timeline activity in issues and pull requests. For more information about the specific events that you can receive, see [AUTOTITLE](/rest/using-the-rest-api/issue-event-types). To view {% data variables.product.github %} activity outside of issues and pull requests, see [AUTOTITLE](/rest/using-the-rest-api/github-event-types). You can use timeline events to display information about issues and pull requests or determine who should be notified of issue comments. diff --git a/content/rest/migrations/orgs.md b/content/rest/migrations/orgs.md index b8ec8c46185c..c21fad98b915 100644 --- a/content/rest/migrations/orgs.md +++ b/content/rest/migrations/orgs.md @@ -18,7 +18,7 @@ category: ## About organization migrations -These endpoints are only available to authenticated organization owners. For more information, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#permission-levels-for-an-organization) and [AUTOTITLE](/rest/overview/authenticating-to-the-rest-api). +These endpoints are only available to authenticated organization owners. For more information, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#permission-levels-for-an-organization) and [AUTOTITLE](/rest/authentication/authenticating-to-the-rest-api). {% data variables.migrations.organization_migrations_intro %} diff --git a/content/rest/migrations/source-imports.md b/content/rest/migrations/source-imports.md index 0d3269cc66ad..dcba3359178d 100644 --- a/content/rest/migrations/source-imports.md +++ b/content/rest/migrations/source-imports.md @@ -17,7 +17,7 @@ category: > [!WARNING] > Due to very low levels of usage and available alternatives, the Source Imports API has been {% data variables.release-phases.retired %}. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). -{% data variables.migrations.source_imports_intro %} A typical source import would start the import and then (optionally) update the authors and/or update the preference for using Git LFS if large files exist in the import. You can also create a webhook that listens for the [`RepositoryImportEvent`](/webhooks-and-events/webhooks/webhook-events-and-payloads#repository_import) to find out the status of the import. +{% data variables.migrations.source_imports_intro %} A typical source import would start the import and then (optionally) update the authors and/or update the preference for using Git LFS if large files exist in the import. You can also create a webhook that listens for the [`RepositoryImportEvent`](/webhooks/webhook-events-and-payloads#repository_import) to find out the status of the import. {% data reusables.user-settings.imports-api-classic-pat-only %} diff --git a/content/rest/migrations/users.md b/content/rest/migrations/users.md index e2100ec893bb..00500b639e2d 100644 --- a/content/rest/migrations/users.md +++ b/content/rest/migrations/users.md @@ -16,7 +16,7 @@ category: ## About user migrations -These endpoints are only available to authenticated account owners. For more information, see [AUTOTITLE](/rest/overview/authenticating-to-the-rest-api). +These endpoints are only available to authenticated account owners. For more information, see [AUTOTITLE](/rest/authentication/authenticating-to-the-rest-api). {% data variables.migrations.user_migrations_intro %} For a list of migration data that you can download, see [Download a user migration archive](#download-a-user-migration-archive). diff --git a/content/rest/packages/packages.md b/content/rest/packages/packages.md index 2da83554b292..f72049eda167 100644 --- a/content/rest/packages/packages.md +++ b/content/rest/packages/packages.md @@ -28,7 +28,7 @@ To use the REST API to manage {% data variables.product.prodname_registry %}, yo If your package is in a registry that supports granular permissions, then your token does not need the `repo` scope to access or manage this package. If your package is in a registry that only supports repository-scoped permissions, then your token must also include the `repo` scope since your package inherits permissions from a {% data variables.product.prodname_dotcom %} repository. For a list of registries that only support repository-scoped permissions, see [AUTOTITLE](/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages). {% ifversion ghec %} -To access resources in an organization with SSO enabled, you must enable SSO for your {% data variables.product.pat_v1 %}. For more information, see [AUTOTITLE](/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on). +To access resources in an organization with SSO enabled, you must enable SSO for your {% data variables.product.pat_v1 %}. For more information, see [AUTOTITLE](/authentication/authenticating-with-single-sign-on/authorizing-a-personal-access-token-for-use-with-single-sign-on). {% endif %} diff --git a/content/rest/quickstart.md b/content/rest/quickstart.md index dcac999f9a68..a6501d44c955 100644 --- a/content/rest/quickstart.md +++ b/content/rest/quickstart.md @@ -16,7 +16,7 @@ category: ## Introduction -This article describes how to quickly get started with the {% data variables.product.prodname_dotcom %} REST API using {% data variables.product.prodname_cli %}, `curl`, or JavaScript. For a more detailed guide, see [AUTOTITLE](/rest/guides/getting-started-with-the-rest-api). +This article describes how to quickly get started with the {% data variables.product.prodname_dotcom %} REST API using {% data variables.product.prodname_cli %}, `curl`, or JavaScript. For a more detailed guide, see [AUTOTITLE](/rest/using-the-rest-api/getting-started-with-the-rest-api). {% cli %} @@ -36,11 +36,11 @@ This article describes how to quickly get started with the {% data variables.pro ## Using {% data variables.product.prodname_cli %} in {% data variables.product.prodname_actions %} -You can also use {% data variables.product.prodname_cli %} in your {% data variables.product.prodname_actions %} workflows. For more information, see [AUTOTITLE](/actions/using-workflows/using-github-cli-in-workflows). +You can also use {% data variables.product.prodname_cli %} in your {% data variables.product.prodname_actions %} workflows. For more information, see [AUTOTITLE](/actions/how-tos/write-workflows/choose-what-workflows-do/use-github-cli). ### Authenticating with an access token -Instead of using the `gh auth login` command, pass an access token as an environment variable called `GH_TOKEN`. {% data variables.product.prodname_dotcom %} recommends that you use the built-in `GITHUB_TOKEN` instead of creating a token. If this is not possible, store your token as a secret and replace `GITHUB_TOKEN` in the example below with the name of your secret. For more information about `GITHUB_TOKEN`, see [AUTOTITLE](/actions/security-guides/automatic-token-authentication). For more information about secrets, see [AUTOTITLE](/actions/security-guides/encrypted-secrets). +Instead of using the `gh auth login` command, pass an access token as an environment variable called `GH_TOKEN`. {% data variables.product.prodname_dotcom %} recommends that you use the built-in `GITHUB_TOKEN` instead of creating a token. If this is not possible, store your token as a secret and replace `GITHUB_TOKEN` in the example below with the name of your secret. For more information about `GITHUB_TOKEN`, see [AUTOTITLE](/actions/tutorials/authenticate-with-github_token). For more information about secrets, see [AUTOTITLE](/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets). The following example workflow uses the [List repository issues](/rest/issues/issues#list-repository-issues) endpoint, and requests a list of issues in {% ifversion ghes %}a repository you specify{% else %}the `octocat/Spoon-Knife` repository{% endif %}.{% ifversion ghes %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}. Replace `REPO-OWNER` with the name of the account that owns the repository. Replace `REPO-NAME` with the name of the repository.{% endif %} @@ -63,8 +63,8 @@ jobs: If you are authenticating with a {% data variables.product.prodname_github_app %}, you can create an installation access token within your workflow: -1. Store your {% data variables.product.prodname_github_app %}'s client ID as a configuration variable. In the following example, replace `APP_CLIENT_ID` with the name of the configuration variable. You can find your client ID on the settings page for your app or through the API. For more information, see [AUTOTITLE](/rest/apps/apps#get-an-app). For more information about configuration variables, see [AUTOTITLE](/actions/learn-github-actions/variables#defining-configuration-variables-for-multiple-workflows). -1. Generate a private key for your app. Store the contents of the resulting file as a secret. (Store the entire contents of the file, including `-----BEGIN RSA PRIVATE KEY-----` and `-----END RSA PRIVATE KEY-----`.) In the following example, replace `APP_PRIVATE_KEY` with the name of the secret. For more information, see [AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/managing-private-keys-for-github-apps). For more information about secrets, see [AUTOTITLE](/actions/security-guides/encrypted-secrets). +1. Store your {% data variables.product.prodname_github_app %}'s client ID as a configuration variable. In the following example, replace `APP_CLIENT_ID` with the name of the configuration variable. You can find your client ID on the settings page for your app or through the API. For more information, see [AUTOTITLE](/rest/apps/apps#get-an-app). For more information about configuration variables, see [AUTOTITLE](/actions/how-tos/write-workflows/choose-what-workflows-do/use-variables#defining-configuration-variables-for-multiple-workflows). +1. Generate a private key for your app. Store the contents of the resulting file as a secret. (Store the entire contents of the file, including `-----BEGIN RSA PRIVATE KEY-----` and `-----END RSA PRIVATE KEY-----`.) In the following example, replace `APP_PRIVATE_KEY` with the name of the secret. For more information, see [AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/managing-private-keys-for-github-apps). For more information about secrets, see [AUTOTITLE](/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets). 1. Add a step to generate a token, and use that token instead of `GITHUB_TOKEN`. Note that this token will expire after 60 minutes. {% ifversion fpt or ghec %}For example:{% else %}In the following example, replace `HOSTNAME` with the name of {% data variables.location.product_location %}. Replace `REPO-OWNER` with the name of the account that owns the repository. Replace `REPO-NAME` with the name of the repository.{% endif %} ```yaml copy @@ -95,7 +95,7 @@ If you are authenticating with a {% data variables.product.prodname_github_app % You can use Octokit.js to interact with the {% data variables.product.prodname_dotcom %} REST API in your JavaScript scripts. For more information, see [Scripting with the REST API and JavaScript](/rest/guides/scripting-with-the-rest-api-and-javascript). -1. Create an access token. For example, create a {% data variables.product.pat_generic %} or a {% data variables.product.prodname_github_app %} user access token. You will use this token to authenticate your request, so you should give it any scopes or permissions that are required to access that endpoint. For more information, see [AUTOTITLE](/rest/overview/authenticating-to-the-rest-api) or [Identifying and authorizing users for GitHub Apps](/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps). +1. Create an access token. For example, create a {% data variables.product.pat_generic %} or a {% data variables.product.prodname_github_app %} user access token. You will use this token to authenticate your request, so you should give it any scopes or permissions that are required to access that endpoint. For more information, see [AUTOTITLE](/rest/authentication/authenticating-to-the-rest-api) or [Identifying and authorizing users for GitHub Apps](/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user). > [!WARNING] > Treat your access token like a password. @@ -103,7 +103,7 @@ You can use Octokit.js to interact with the {% data variables.product.prodname_d > To keep your token secure, you can store your token as a secret and run your script through {% data variables.product.prodname_actions %}. For more information, see the [Using Octokit.js in {% data variables.product.prodname_actions %}](#using-octokitjs-in-github-actions) section. {%- ifversion fpt or ghec %} > - You can also store your token as a {% data variables.product.prodname_codespaces %} secret and run your script in {% data variables.product.prodname_codespaces %}. For more information, see [Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces). + You can also store your token as a {% data variables.product.prodname_codespaces %} secret and run your script in {% data variables.product.prodname_codespaces %}. For more information, see [Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-your-account-specific-secrets-for-github-codespaces). {% endif %} > > If these options are not possible, consider using another CLI service to store your token securely. @@ -119,7 +119,7 @@ You can use Octokit.js to interact with the {% data variables.product.prodname_d }); ``` -1. Use `octokit.request` to execute your request. Send the HTTP method and path as the first argument. Specify any path, query, and body parameters in an object as the second argument. For more information about parameters, see [AUTOTITLE](/rest/guides/getting-started-with-the-rest-api#using-parameters). +1. Use `octokit.request` to execute your request. Send the HTTP method and path as the first argument. Specify any path, query, and body parameters in an object as the second argument. For more information about parameters, see [AUTOTITLE](/rest/using-the-rest-api/getting-started-with-the-rest-api#using-parameters). For example, in the following request the HTTP method is `GET`, the path is `/repos/{owner}/{repo}/issues`, and the parameters are {% ifversion ghes %}`owner: "REPO-OWNER"` and `repo: "REPO-NAME"`{% else %}`owner: "octocat"` and `repo: "Spoon-Knife"`{% endif %}.{% ifversion ghes %} Replace `REPO-OWNER` with the name of the account that owns the repository, and `REPO-NAME` with the name of the repository.{% endif %} @@ -132,11 +132,11 @@ You can use Octokit.js to interact with the {% data variables.product.prodname_d ## Using Octokit.js in {% data variables.product.prodname_actions %} -You can also execute your JavaScript scripts in your {% data variables.product.prodname_actions %} workflows. For more information, see [AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun). +You can also execute your JavaScript scripts in your {% data variables.product.prodname_actions %} workflows. For more information, see [AUTOTITLE](/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idstepsrun). ### Authenticating with an access token -{% data variables.product.prodname_dotcom %} recommends that you use the built-in `GITHUB_TOKEN` instead of creating a token. If this is not possible, store your token as a secret and replace `GITHUB_TOKEN` in the example below with the name of your secret. For more information about `GITHUB_TOKEN`, see [AUTOTITLE](/actions/security-guides/automatic-token-authentication). For more information about secrets, see [AUTOTITLE](/actions/security-guides/encrypted-secrets). +{% data variables.product.prodname_dotcom %} recommends that you use the built-in `GITHUB_TOKEN` instead of creating a token. If this is not possible, store your token as a secret and replace `GITHUB_TOKEN` in the example below with the name of your secret. For more information about `GITHUB_TOKEN`, see [AUTOTITLE](/actions/tutorials/authenticate-with-github_token). For more information about secrets, see [AUTOTITLE](/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets). The following example workflow: @@ -202,8 +202,8 @@ try { If you are authenticating with a {% data variables.product.prodname_github_app %}, you can create an installation access token within your workflow: -1. Store your {% data variables.product.prodname_github_app %}'s client ID as a configuration variable. In the following example, replace `APP_CLIENT_ID` with the name of the configuration variable. You can find your client ID on the settings page for your app or through the App API. For more information, see [AUTOTITLE](/rest/apps/apps#get-an-app). For more information about configuration variables, see [AUTOTITLE](/actions/learn-github-actions/variables#defining-configuration-variables-for-multiple-workflows). -1. Generate a private key for your app. Store the contents of the resulting file as a secret. (Store the entire contents of the file, including `-----BEGIN RSA PRIVATE KEY-----` and `-----END RSA PRIVATE KEY-----`.) In the following example, replace `APP_PRIVATE_KEY` with the name of the secret. For more information, see [AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/managing-private-keys-for-github-apps). For more information about secrets, see [AUTOTITLE](/actions/security-guides/encrypted-secrets). +1. Store your {% data variables.product.prodname_github_app %}'s client ID as a configuration variable. In the following example, replace `APP_CLIENT_ID` with the name of the configuration variable. You can find your client ID on the settings page for your app or through the App API. For more information, see [AUTOTITLE](/rest/apps/apps#get-an-app). For more information about configuration variables, see [AUTOTITLE](/actions/how-tos/write-workflows/choose-what-workflows-do/use-variables#defining-configuration-variables-for-multiple-workflows). +1. Generate a private key for your app. Store the contents of the resulting file as a secret. (Store the entire contents of the file, including `-----BEGIN RSA PRIVATE KEY-----` and `-----END RSA PRIVATE KEY-----`.) In the following example, replace `APP_PRIVATE_KEY` with the name of the secret. For more information, see [AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/managing-private-keys-for-github-apps). For more information about secrets, see [AUTOTITLE](/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets). 1. Add a step to generate a token, and use that token instead of `GITHUB_TOKEN`. Note that this token will expire after 60 minutes. For example: ```yaml @@ -251,13 +251,13 @@ If you are authenticating with a {% data variables.product.prodname_github_app % 1. Install `curl` if it isn't already installed on your machine. To check if `curl` is installed, execute `curl --version` in the command line. If the output provides information about the version of `curl`, that means `curl` is installed. If you get a message similar to `command not found: curl`, you need to download and install `curl`. For more information, see [the curl project download page](https://curl.se/download.html). -1. Create an access token. For example, create a {% data variables.product.pat_generic %} or a {% data variables.product.prodname_github_app %} user access token. You will use this token to authenticate your request, so you should give it any scopes or permissions that are required to access the endpoint. For more information, see [AUTOTITLE](/rest/overview/authenticating-to-the-rest-api). +1. Create an access token. For example, create a {% data variables.product.pat_generic %} or a {% data variables.product.prodname_github_app %} user access token. You will use this token to authenticate your request, so you should give it any scopes or permissions that are required to access the endpoint. For more information, see [AUTOTITLE](/rest/authentication/authenticating-to-the-rest-api). > [!WARNING] > Treat your access token like a password. {%- ifversion fpt or ghec %} > - > To keep your token secure, you can store your token as a {% data variables.product.prodname_codespaces %} secret and use the command line through {% data variables.product.prodname_codespaces %}. For more information, see [Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces). + > To keep your token secure, you can store your token as a {% data variables.product.prodname_codespaces %} secret and use the command line through {% data variables.product.prodname_codespaces %}. For more information, see [Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-your-account-specific-secrets-for-github-codespaces). {% endif %} > > You can also use {% data variables.product.prodname_cli %} instead of `curl`. {% data variables.product.prodname_cli %} will take care of authentication for you. For more information, see the {% data variables.product.prodname_cli %} version of this page. @@ -282,7 +282,7 @@ You can also use `curl` commands in your {% data variables.product.prodname_acti ### Authenticating with an access token -{% data variables.product.prodname_dotcom %} recommends that you use the built-in `GITHUB_TOKEN` instead of creating a token. If this is not possible, store your token as a secret and replace `GITHUB_TOKEN` in the example below with the name of your secret. For more information about `GITHUB_TOKEN`, see [AUTOTITLE](/actions/security-guides/automatic-token-authentication). For more information about secrets, see [AUTOTITLE](/actions/security-guides/encrypted-secrets). +{% data variables.product.prodname_dotcom %} recommends that you use the built-in `GITHUB_TOKEN` instead of creating a token. If this is not possible, store your token as a secret and replace `GITHUB_TOKEN` in the example below with the name of your secret. For more information about `GITHUB_TOKEN`, see [AUTOTITLE](/actions/tutorials/authenticate-with-github_token). For more information about secrets, see [AUTOTITLE](/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets). {% ifversion ghes %}In the following example, replace `HOSTNAME` with the name of {% data variables.location.product_location %}. Replace `REPO-OWNER` with the name of the account that owns the repository. Replace `REPO-NAME` with the name of the repository.{% endif %} @@ -308,8 +308,8 @@ jobs: If you are authenticating with a {% data variables.product.prodname_github_app %}, you can create an installation access token within your workflow: -1. Store your {% data variables.product.prodname_github_app %}'s client ID as a configuration variable. In the following example, replace `APP_CLIENT_ID` with the name of the configuration variable. You can find your client ID on the settings page for your app or through the App API. For more information, see [AUTOTITLE](/rest/apps/apps#get-an-app). For more information about configuration variables, see [AUTOTITLE](/actions/learn-github-actions/variables#defining-configuration-variables-for-multiple-workflows). -1. Generate a private key for your app. Store the contents of the resulting file as a secret. (Store the entire contents of the file, including `-----BEGIN RSA PRIVATE KEY-----` and `-----END RSA PRIVATE KEY-----`.) In the following example, replace `APP_PRIVATE_KEY` with the name of the secret. For more information, see [AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/managing-private-keys-for-github-apps). For more information about storing secrets, see [AUTOTITLE](/actions/security-guides/encrypted-secrets). +1. Store your {% data variables.product.prodname_github_app %}'s client ID as a configuration variable. In the following example, replace `APP_CLIENT_ID` with the name of the configuration variable. You can find your client ID on the settings page for your app or through the App API. For more information, see [AUTOTITLE](/rest/apps/apps#get-an-app). For more information about configuration variables, see [AUTOTITLE](/actions/how-tos/write-workflows/choose-what-workflows-do/use-variables#defining-configuration-variables-for-multiple-workflows). +1. Generate a private key for your app. Store the contents of the resulting file as a secret. (Store the entire contents of the file, including `-----BEGIN RSA PRIVATE KEY-----` and `-----END RSA PRIVATE KEY-----`.) In the following example, replace `APP_PRIVATE_KEY` with the name of the secret. For more information, see [AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/managing-private-keys-for-github-apps). For more information about storing secrets, see [AUTOTITLE](/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets). 1. Add a step to generate a token, and use that token instead of `GITHUB_TOKEN`. Note that this token will expire after 60 minutes. {% ifversion fpt or ghec %}For example:{% else %}In the following example, replace `HOSTNAME` with the name of {% data variables.location.product_location %}. Replace `REPO-OWNER` with the name of the account that owns the repository. Replace `REPO-NAME` with the name of the repository.{% endif %} ```yaml copy @@ -341,4 +341,4 @@ If you are authenticating with a {% data variables.product.prodname_github_app % ## Next steps -For a more detailed guide, see [Getting started with the REST API](/rest/guides/getting-started-with-the-rest-api). +For a more detailed guide, see [Getting started with the REST API](/rest/using-the-rest-api/getting-started-with-the-rest-api). diff --git a/content/rest/rate-limit/rate-limit.md b/content/rest/rate-limit/rate-limit.md index cad2b0499335..27cb83c06e06 100644 --- a/content/rest/rate-limit/rate-limit.md +++ b/content/rest/rate-limit/rate-limit.md @@ -16,9 +16,9 @@ category: ## About rate limits -You can check your current rate limit status at any time. For more information about rate limit rules, see [AUTOTITLE](/rest/overview/rate-limits-for-the-rest-api). +You can check your current rate limit status at any time. For more information about rate limit rules, see [AUTOTITLE](/rest/using-the-rest-api/rate-limits-for-the-rest-api). -The REST API for searching items has a custom rate limit that is separate from the rate limit governing the other REST API endpoints. For more information, see [AUTOTITLE](/rest/search/search). The GraphQL API also has a custom rate limit that is separate from and calculated differently than rate limits in the REST API. For more information, see [AUTOTITLE](/graphql/overview/resource-limitations#rate-limit). For these reasons, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: +The REST API for searching items has a custom rate limit that is separate from the rate limit governing the other REST API endpoints. For more information, see [AUTOTITLE](/rest/search/search). The GraphQL API also has a custom rate limit that is separate from and calculated differently than rate limits in the REST API. For more information, see [AUTOTITLE](/graphql/overview/rate-limits-and-query-limits-for-the-graphql-api#rate-limit). For these reasons, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: * The `core` object provides your rate limit status for all non-search-related resources in the REST API. @@ -28,14 +28,14 @@ The REST API for searching items has a custom rate limit that is separate from t * The `graphql` object provides your rate limit status for the GraphQL API. -* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see [AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration). +* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see [AUTOTITLE](/apps/sharing-github-apps/registering-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration). * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see [AUTOTITLE](/rest/dependency-graph). -* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see [AUTOTITLE](/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github). +* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see [AUTOTITLE](/code-security/how-tos/find-and-fix-code-vulnerabilities/integrate-with-existing-tools/upload-sarif-file). * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in {% data variables.product.prodname_actions %}. For more information, see [AUTOTITLE](/rest/actions/self-hosted-runners). -For more information on the headers and values in the rate limit response, see [AUTOTITLE](/rest/overview/rate-limits-for-the-rest-api). +For more information on the headers and values in the rate limit response, see [AUTOTITLE](/rest/using-the-rest-api/rate-limits-for-the-rest-api). diff --git a/content/rest/repos/custom-properties.md b/content/rest/repos/custom-properties.md index 6872cfac5f37..d9fdd298cebd 100644 --- a/content/rest/repos/custom-properties.md +++ b/content/rest/repos/custom-properties.md @@ -16,6 +16,6 @@ category: ## About custom properties -You can use the REST API to view the custom properties that were assigned to a repository by the organization that owns the repository. For more information, see [AUTOTITLE](/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization). For more information about the REST API endpoints to manage custom properties, see [AUTOTITLE](/rest/orgs/properties). +You can use the REST API to view the custom properties that were assigned to a repository by the organization that owns the repository. For more information, see [AUTOTITLE](/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization). For more information about the REST API endpoints to manage custom properties, see [AUTOTITLE](/rest/orgs/custom-properties). diff --git a/content/rest/repos/lfs.md b/content/rest/repos/lfs.md index f4501eddbb62..98961d8d2166 100644 --- a/content/rest/repos/lfs.md +++ b/content/rest/repos/lfs.md @@ -21,13 +21,13 @@ People with admin access to a repository can use these endpoints. {% ifversion ghec %} -Usage of {% data variables.large_files.product_name_short %} is subject to billing. For more information, see [AUTOTITLE](/billing/managing-billing-for-your-products/managing-billing-for-git-large-file-storage/about-billing-for-git-large-file-storage). +Usage of {% data variables.large_files.product_name_short %} is subject to billing. For more information, see [AUTOTITLE](/billing/concepts/product-billing/git-lfs). If you want to use these endpoints for a repository that belongs to an organization, you must have admin access to the repository (which can be inherited as an organization owner), and your role must also provide you with access to the organization's billing. * If repository is owned by an organization on {% data variables.product.prodname_team %}, you must be an organization owner or billing manager. For more information, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#organization-owners). * If repository is owned by an organization that is on {% data variables.product.prodname_ghe_cloud %} and is not owned by an enterprise account, you must be an organization owner or billing manager. For more information, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#organization-owners). -* If repository is owned by an organization that is owned by an enterprise account, you must be an enterprise owner or billing manager. For more information, see [AUTOTITLE](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise#enterprise-owners). +* If repository is owned by an organization that is owned by an enterprise account, you must be an enterprise owner or billing manager. For more information, see [AUTOTITLE](/admin/managing-accounts-and-repositories/managing-roles-in-your-enterprise/abilities-of-roles#enterprise-owners). {% endif %} diff --git a/content/rest/scim/scim.md b/content/rest/scim/scim.md index 61cf285cc9d3..07392ed6e5a0 100644 --- a/content/rest/scim/scim.md +++ b/content/rest/scim/scim.md @@ -23,12 +23,12 @@ category: These endpoints are used by SCIM-enabled Identity Providers (IdPs) to automate provisioning of {% data variables.product.github %} organization membership and are based on version 2.0 of the [SCIM standard](http://www.simplecloud.info/). IdPs should use the base URL `{% data variables.product.rest_url %}/scim/v2/organizations/{org}/` for {% data variables.product.github %} SCIM endpoints. > [!NOTE] -> * These endpoints are only available for individual organizations that use {% data variables.product.prodname_ghe_cloud %} with SAML SSO enabled. For more information about SCIM, see [AUTOTITLE](/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/about-scim-for-organizations). For more information about authorizing a token for a SAML SSO organization, see [AUTOTITLE](/rest/overview/authenticating-to-the-rest-api). +> * These endpoints are only available for individual organizations that use {% data variables.product.prodname_ghe_cloud %} with SAML SSO enabled. For more information about SCIM, see [AUTOTITLE](/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/about-scim-for-organizations). For more information about authorizing a token for a SAML SSO organization, see [AUTOTITLE](/rest/authentication/authenticating-to-the-rest-api). > * These endpoints cannot be used with an enterprise account or with an {% data variables.enterprise.prodname_emu_org %}. ### Authentication -You must authenticate as an owner of a {% data variables.product.github %} organization to use these endpoints. The REST API expects an OAuth 2.0 Bearer token (for example, a {% data variables.product.prodname_github_app %} user access token) to be included in the `Authorization` header. If you use a {% data variables.product.pat_v1 %} for authentication, it must have the `admin:org` scope and you must also [authorize it for use with your SAML SSO organization](/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on). +You must authenticate as an owner of a {% data variables.product.github %} organization to use these endpoints. The REST API expects an OAuth 2.0 Bearer token (for example, a {% data variables.product.prodname_github_app %} user access token) to be included in the `Authorization` header. If you use a {% data variables.product.pat_v1 %} for authentication, it must have the `admin:org` scope and you must also [authorize it for use with your SAML SSO organization](/authentication/authenticating-with-single-sign-on/authorizing-a-personal-access-token-for-use-with-single-sign-on). ### Matching SAML and SCIM attributes diff --git a/content/rest/secret-scanning/secret-scanning.md b/content/rest/secret-scanning/secret-scanning.md index bd681b95122e..2b5216bc2975 100644 --- a/content/rest/secret-scanning/secret-scanning.md +++ b/content/rest/secret-scanning/secret-scanning.md @@ -23,6 +23,6 @@ You can use the API to: * Enable or disable {% data variables.product.prodname_secret_scanning %} and push protection for a repository. For more information, see [AUTOTITLE](/rest/repos/repos#update-a-repository) and expand the "Properties of the `security_and_analysis` object" section. * Retrieve and update {% data variables.secret-scanning.alerts %} from a repository. For further details, see the sections below. -For more information about {% data variables.product.prodname_secret_scanning %}, see [AUTOTITLE](/code-security/secret-scanning/introduction/about-secret-scanning). +For more information about {% data variables.product.prodname_secret_scanning %}, see [AUTOTITLE](/code-security/concepts/secret-security/secret-scanning). diff --git a/content/rest/security-advisories/global-advisories.md b/content/rest/security-advisories/global-advisories.md index 93fc4c63263d..e2d65896826e 100644 --- a/content/rest/security-advisories/global-advisories.md +++ b/content/rest/security-advisories/global-advisories.md @@ -15,7 +15,7 @@ category: {% ifversion ghes %} > [!NOTE] -> To use these endpoints, an administrator must enable {% data variables.product.prodname_github_connect %} for {% data variables.location.product_location %}. For more information, see [AUTOTITLE](/code-security/security-advisories/global-security-advisories/browsing-security-advisories-in-the-github-advisory-database#accessing-the-local-advisory-database-on-your-github-enterprise-server-instance). +> To use these endpoints, an administrator must enable {% data variables.product.prodname_github_connect %} for {% data variables.location.product_location %}. For more information, see [AUTOTITLE](/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/browse-advisory-database#accessing-the-local-advisory-database-on-your-github-enterprise-server-instance). {% endif %} diff --git a/content/rest/teams/external-groups.md b/content/rest/teams/external-groups.md index 449ae8151718..0ef034c2a292 100644 --- a/content/rest/teams/external-groups.md +++ b/content/rest/teams/external-groups.md @@ -21,7 +21,7 @@ To use these endpoints, the authenticated user must be a team maintainer or an o {% ifversion ghec %} > [!NOTE] -> * These endpoints are only available for organizations that are part of an enterprise using {% data variables.product.prodname_emus %}. For more information, see [AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users). +> * These endpoints are only available for organizations that are part of an enterprise using {% data variables.product.prodname_emus %}. For more information, see [AUTOTITLE](/admin/concepts/identity-and-access-management/enterprise-managed-users). > * If your organization uses team synchronization, you can use the API to manage team synchronization. For more information, see [AUTOTITLE](/rest/teams/team-sync). {% endif %} diff --git a/content/rest/teams/team-sync.md b/content/rest/teams/team-sync.md index c266e63eecb1..2fe7131639e3 100644 --- a/content/rest/teams/team-sync.md +++ b/content/rest/teams/team-sync.md @@ -15,7 +15,7 @@ category: ## About team synchronization -To use these endpoints, the authenticated user must be a team maintainer or an owner of the organization associated with the team. The token you use to authenticate will also need to be authorized for use with your IdP (SSO) provider. For more information, see [AUTOTITLE](/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on). +To use these endpoints, the authenticated user must be a team maintainer or an owner of the organization associated with the team. The token you use to authenticate will also need to be authorized for use with your IdP (SSO) provider. For more information, see [AUTOTITLE](/enterprise-cloud@latest/authentication/authenticating-with-single-sign-on/authorizing-a-personal-access-token-for-use-with-single-sign-on). You can manage {% data variables.product.github %} team members through your IdP with team synchronization. Team synchronization must be enabled to use these endpoints. For more information, see [AUTOTITLE](/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization). diff --git a/content/rest/using-the-rest-api/best-practices-for-using-the-rest-api.md b/content/rest/using-the-rest-api/best-practices-for-using-the-rest-api.md index 9009367f1705..b1f7b419e1b6 100644 --- a/content/rest/using-the-rest-api/best-practices-for-using-the-rest-api.md +++ b/content/rest/using-the-rest-api/best-practices-for-using-the-rest-api.md @@ -28,7 +28,7 @@ You should subscribe to webhook events instead of polling the API for data. This ## Make authenticated requests -Authenticated requests have a higher primary rate limit than unauthenticated requests. To avoid exceeding the rate limit, you should make authenticated requests. For more information, see [AUTOTITLE](/rest/overview/rate-limits-for-the-rest-api). +Authenticated requests have a higher primary rate limit than unauthenticated requests. To avoid exceeding the rate limit, you should make authenticated requests. For more information, see [AUTOTITLE](/rest/using-the-rest-api/rate-limits-for-the-rest-api). ## Avoid concurrent requests @@ -65,7 +65,7 @@ Other redirection status codes may be used in accordance with HTTP specification Many API endpoints return URL values for fields in the response body. You should not try to parse these URLs or to predict the structure of future URLs. This can cause your integration to break if {% data variables.product.company_short %} changes the structure of the URL in the future. Instead, you should look for a field that contains the information that you need. For example, the endpoint to create an issue returns an `html_url` field with a value like `https://github.com/octocat/Hello-World/issues/1347` and a `number` field with a value like `1347`. If you need to know the number of the issue, use the `number` field instead of parsing the `html_url` field. -Similarly, you should not try to manually construct pagination queries. Instead, you should use the link headers to determine what pages of results you can request. For more information, see [AUTOTITLE](/rest/guides/using-pagination-in-the-rest-api). +Similarly, you should not try to manually construct pagination queries. Instead, you should use the link headers to determine what pages of results you can request. For more information, see [AUTOTITLE](/rest/using-the-rest-api/using-pagination-in-the-rest-api). ## Use conditional requests if appropriate diff --git a/content/rest/using-the-rest-api/getting-started-with-the-rest-api.md b/content/rest/using-the-rest-api/getting-started-with-the-rest-api.md index 8ac3854cedc2..c93a61b3f030 100644 --- a/content/rest/using-the-rest-api/getting-started-with-the-rest-api.md +++ b/content/rest/using-the-rest-api/getting-started-with-the-rest-api.md @@ -77,7 +77,7 @@ Most {% data variables.product.prodname_dotcom %} REST API endpoints specify tha #### `X-GitHub-Api-Version` -You should use this header to specify a version of the REST API to use for your request. For more information, see [AUTOTITLE](/rest/overview/api-versions). +You should use this header to specify a version of the REST API to use for your request. For more information, see [AUTOTITLE](/rest/about-the-rest-api/api-versions). {% ifversion fpt or ghec %} @@ -136,15 +136,15 @@ Many endpoints require authentication or return additional information if you ar {% curl %} -To authenticate your request, you will need to provide an authentication token with the required scopes or permissions. There a few different ways to get a token: You can create a {% data variables.product.pat_generic %}, generate a token with a {% data variables.product.prodname_github_app %}, or use the built-in `GITHUB_TOKEN` in a {% data variables.product.prodname_actions %} workflow. For more information, see [AUTOTITLE](/rest/overview/authenticating-to-the-rest-api). +To authenticate your request, you will need to provide an authentication token with the required scopes or permissions. There a few different ways to get a token: You can create a {% data variables.product.pat_generic %}, generate a token with a {% data variables.product.prodname_github_app %}, or use the built-in `GITHUB_TOKEN` in a {% data variables.product.prodname_actions %} workflow. For more information, see [AUTOTITLE](/rest/authentication/authenticating-to-the-rest-api). For an example of a request that uses an authentication token, see [Making a request](#making-a-request). > [!NOTE] -> If you don't want to create a token, you can use {% data variables.product.prodname_cli %}. {% data variables.product.prodname_cli %} will take care of authentication for you, and help keep your account secure. For more information, see the [{% data variables.product.prodname_cli %} version of this page](/rest/guides/getting-started-with-the-rest-api?tool=cli). +> If you don't want to create a token, you can use {% data variables.product.prodname_cli %}. {% data variables.product.prodname_cli %} will take care of authentication for you, and help keep your account secure. For more information, see the [{% data variables.product.prodname_cli %} version of this page](/rest/using-the-rest-api/getting-started-with-the-rest-api?tool=cli). > [!WARNING] -> Treat your access token the same way you would treat your passwords or other sensitive credentials. For more information, see [AUTOTITLE](/rest/overview/keeping-your-api-credentials-secure). +> Treat your access token the same way you would treat your passwords or other sensitive credentials. For more information, see [AUTOTITLE](/rest/authentication/keeping-your-api-credentials-secure). {% endcurl %} @@ -156,12 +156,12 @@ Although some REST API endpoints are accessible without authentication, {% data {% javascript %} -To authenticate your request, you will need to provide an authentication token with the required scopes or permissions. There a few different ways to get a token: You can create a {% data variables.product.pat_generic %}, generate a token with a {% data variables.product.prodname_github_app %}, or use the built-in `GITHUB_TOKEN` in a {% data variables.product.prodname_actions %} workflow. For more information, see [AUTOTITLE](/rest/overview/authenticating-to-the-rest-api). +To authenticate your request, you will need to provide an authentication token with the required scopes or permissions. There a few different ways to get a token: You can create a {% data variables.product.pat_generic %}, generate a token with a {% data variables.product.prodname_github_app %}, or use the built-in `GITHUB_TOKEN` in a {% data variables.product.prodname_actions %} workflow. For more information, see [AUTOTITLE](/rest/authentication/authenticating-to-the-rest-api). For an example of a request that uses an authentication token, see [Making a request](#making-a-request). > [!WARNING] -> Treat your access token the same way you would treat your passwords or other sensitive credentials. For more information, see [AUTOTITLE](/rest/overview/keeping-your-api-credentials-secure). +> Treat your access token the same way you would treat your passwords or other sensitive credentials. For more information, see [AUTOTITLE](/rest/authentication/keeping-your-api-credentials-secure). {% endjavascript %} @@ -352,7 +352,7 @@ curl --request GET \ The following example uses the [Create an issue](/rest/issues/issues#create-an-issue) endpoint to create a new issue in {% ifversion ghes %}a specified{% else %}the octocat/Spoon-Knife{% endif %} repository.{% ifversion ghes %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}. Replace `REPO-NAME` with the name of the repository where you want to create a new issue, and replace `REPO-OWNER` with the name of the account that owns the repository.{% endif %} Replace `YOUR-TOKEN` with the authentication token you created in a previous step. > [!NOTE] -> If you are using a {% data variables.product.pat_v2 %}, you must replace `{% ifversion ghes %}REPO-OWNER` and `REPO-NAME{% else %}octocat/Spoon-Knife{% endif %}` with a repository that you own or that is owned by an organization that you are a member of. Your token must have access to that repository and have read and write permissions for repository issues. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token). +> If you are using a {% data variables.product.pat_v2 %}, you must replace `{% ifversion ghes %}REPO-OWNER` and `REPO-NAME{% else %}octocat/Spoon-Knife{% endif %}` with a repository that you own or that is owned by an organization that you are a member of. Your token must have access to that repository and have read and write permissions for repository issues. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens). ```shell copy curl \ @@ -414,7 +414,7 @@ Create an access token to authenticate your request. You can save your token and In the following example request, the HTTP method is `POST`, the path is `/repos/{owner}/{repo}/issues`, the path parameters are `owner: "{% ifversion ghes %}REPO-OWNER{% else %}octocat{% endif %}"` and `repo: "{% ifversion ghes %}REPO-NAME{% else %}Spoon-Knife{% endif %}"`, and the body parameters are `title: "Created with the REST API"` and `body: "This is a test issue created by the REST API"`.{% ifversion ghes %} Replace `REPO-OWNER` with the name of the account that owns the repository, and `REPO-NAME` with the name of the repository.{% endif %} > [!NOTE] - > If you are using a {% data variables.product.pat_v2 %}, you must replace `{% ifversion ghes %}REPO-OWNER` and `REPO-NAME{% else %}octocat/Spoon-Knife{% endif %}` with a repository that you own or that is owned by an organization that you are a member of. Your token must have access to that repository and have read and write permissions for repository issues. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token). + > If you are using a {% data variables.product.pat_v2 %}, you must replace `{% ifversion ghes %}REPO-OWNER` and `REPO-NAME{% else %}octocat/Spoon-Knife{% endif %}` with a repository that you own or that is owned by an organization that you are a member of. Your token must have access to that repository and have read and write permissions for repository issues. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens). ```javascript copy await octokit.request("POST /repos/{owner}/{repo}/issues", { diff --git a/content/rest/using-the-rest-api/issue-event-types.md b/content/rest/using-the-rest-api/issue-event-types.md index f61a000a7772..01b10a31c8e3 100644 --- a/content/rest/using-the-rest-api/issue-event-types.md +++ b/content/rest/using-the-rest-api/issue-event-types.md @@ -101,7 +101,7 @@ This event is available for the following issue types. ## closed -The issue or pull request was closed. When the `commit_id` is present, it identifies the commit that closed the issue using "closes / fixes" syntax. For more information about the syntax, see [AUTOTITLE](/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword). +The issue or pull request was closed. When the `commit_id` is present, it identifies the commit that closed the issue using "closes / fixes" syntax. For more information about the syntax, see [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword). This event is available for the following issue types. @@ -186,7 +186,7 @@ Name | Type | Description ## connected -The issue or pull request was linked to another issue or pull request. For more information, see [AUTOTITLE](/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue). +The issue or pull request was linked to another issue or pull request. For more information, see [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue). This event is available for the following issue types. @@ -327,7 +327,7 @@ This event is available for the following issue types. ## disconnected -The issue or pull request was unlinked from another issue or pull request. For more information, see [AUTOTITLE](/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue). +The issue or pull request was unlinked from another issue or pull request. For more information, see [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue). This event is available for the following issue types. diff --git a/content/rest/using-the-rest-api/rate-limits-for-the-rest-api.md b/content/rest/using-the-rest-api/rate-limits-for-the-rest-api.md index cc91141e7925..ea3aea138a5a 100644 --- a/content/rest/using-the-rest-api/rate-limits-for-the-rest-api.md +++ b/content/rest/using-the-rest-api/rate-limits-for-the-rest-api.md @@ -16,9 +16,9 @@ category: Rate limits are disabled by default for {% data variables.product.prodname_ghe_server %}. Contact your site administrator to confirm the rate limits for your instance. -If you are a site administrator, you can set rate limits, including secondary rate limits, for your instance. See [AUTOTITLE](/admin/configuration/configuring-user-applications-for-your-enterprise/configuring-rate-limits). +If you are a site administrator, you can set rate limits, including secondary rate limits, for your instance. See [AUTOTITLE](/admin/configuring-settings/configuring-user-applications-for-your-enterprise/configuring-rate-limits). -If you are developing an app for users or organizations outside of your instance, the standard {% data variables.product.github %} rate limits apply. See [AUTOTITLE](/free-pro-team@latest/rest/overview/rate-limits-for-the-rest-api) in the {% data variables.product.prodname_free_user %} documentation. +If you are developing an app for users or organizations outside of your instance, the standard {% data variables.product.github %} rate limits apply. See [AUTOTITLE](/free-pro-team@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api) in the {% data variables.product.prodname_free_user %} documentation. ## About secondary rate limits @@ -30,7 +30,7 @@ If you are developing an app for users or organizations outside of your instance {% data variables.product.company_short %} limits the number of REST API requests that you can make within a specific amount of time. This limit helps prevent abuse and denial-of-service attacks, and ensures that the API remains available for all users. -Some endpoints, like the search endpoints, have more restrictive limits. For more information about these endpoints, see [AUTOTITLE](/rest/rate-limit/rate-limit). The GraphQL API also has a separate primary rate limit. See [AUTOTITLE](/graphql/overview/resource-limitations). +Some endpoints, like the search endpoints, have more restrictive limits. For more information about these endpoints, see [AUTOTITLE](/rest/rate-limit/rate-limit). The GraphQL API also has a separate primary rate limit. See [AUTOTITLE](/graphql/overview/rate-limits-and-query-limits-for-the-graphql-api). {% data reusables.organizations.api-insights-learn-about %} @@ -76,7 +76,7 @@ curl -u YOUR_CLIENT_ID:YOUR_CLIENT_SECRET -I {% data variables.product.rest_url ### Primary rate limit for `GITHUB_TOKEN` in {% data variables.product.prodname_actions %} -You can use the built-in `GITHUB_TOKEN` to authenticate requests in {% data variables.product.prodname_actions %} workflows. See [AUTOTITLE](/actions/security-guides/automatic-token-authentication). +You can use the built-in `GITHUB_TOKEN` to authenticate requests in {% data variables.product.prodname_actions %} workflows. See [AUTOTITLE](/actions/tutorials/authenticate-with-github_token). {% data reusables.rest-api.primary-rate-limit-github-token-in-actions %} @@ -110,7 +110,7 @@ Continuing to make requests while you are rate limited may result in the banning ## Staying under the rate limit -You should follow best practices to help you stay under the rate limits. See [AUTOTITLE](/rest/guides/best-practices-for-using-the-rest-api). +You should follow best practices to help you stay under the rate limits. See [AUTOTITLE](/rest/using-the-rest-api/best-practices-for-using-the-rest-api). {% ifversion ghec or ghes %} diff --git a/content/rest/using-the-rest-api/troubleshooting-the-rest-api.md b/content/rest/using-the-rest-api/troubleshooting-the-rest-api.md index 6d9a8c4a68b9..23441fc7a896 100644 --- a/content/rest/using-the-rest-api/troubleshooting-the-rest-api.md +++ b/content/rest/using-the-rest-api/troubleshooting-the-rest-api.md @@ -16,7 +16,7 @@ category: ## Rate limit errors -{% data variables.product.company_short %} enforces rate limits to ensure that the API stays available for all users. For more information, see [AUTOTITLE](/rest/overview/rate-limits-for-the-rest-api). +{% data variables.product.company_short %} enforces rate limits to ensure that the API stays available for all users. For more information, see [AUTOTITLE](/rest/using-the-rest-api/rate-limits-for-the-rest-api). If you exceed your primary rate limit, you will receive a `403 Forbidden` or `429 Too Many Requests ` response, and the `x-ratelimit-remaining` header will be `0`. If you exceed a secondary rate limit, you will receive a `403 Forbidden` or `429 Too Many Requests ` response and an error message that indicates that you exceeded a secondary rate limit. @@ -30,7 +30,7 @@ Continuing to make requests while you are rate limited may result in the banning {% data reusables.organizations.api-insights-learn-about %} -For more information about how to avoid exceeding the rate limits, see [AUTOTITLE](/rest/guides/best-practices-for-using-the-rest-api). +For more information about how to avoid exceeding the rate limits, see [AUTOTITLE](/rest/using-the-rest-api/best-practices-for-using-the-rest-api). ## `404 Not Found` for an existing resource @@ -67,7 +67,7 @@ If you get a `404 Not Found` response when you know that the resource that you a * If you are using `GITHUB_TOKEN` in a {% data variables.product.prodname_actions %} workflow, you should ensure that: * The endpoint is only affecting resources owned by the repository where the workflow is running. If you need to access resources outside of that repository, such as resources owned by an organization or resources owned by another repository, you should use a {% data variables.product.pat_generic %} or an access token for a {% data variables.product.prodname_github_app %}. -For more information about authentication, see [AUTOTITLE](/rest/overview/authenticating-to-the-rest-api). +For more information about authentication, see [AUTOTITLE](/rest/authentication/authenticating-to-the-rest-api). You should also check for typos in your URL. For example, adding a trailing slash to the endpoint will result in a `404 Not Found`. You can refer to the reference documentation for the endpoint to confirm that you have the correct URL. @@ -75,7 +75,7 @@ Additionally, any path parameters must be URL encoded. For example, any slashes ## Missing results -Most endpoints that return a list of resources support pagination. For most of these endpoints, only the first 30 resources are returned by default. In order to see all of the resources, you need to paginate through the results. For more information, see [AUTOTITLE](/rest/guides/using-pagination-in-the-rest-api). +Most endpoints that return a list of resources support pagination. For most of these endpoints, only the first 30 resources are returned by default. In order to see all of the resources, you need to paginate through the results. For more information, see [AUTOTITLE](/rest/using-the-rest-api/using-pagination-in-the-rest-api). If you are using pagination correctly and still do not see all of the results that you expect, you should confirm that the authentication credentials that you used have access to all of the expected resources. For example, if you are using a {% data variables.product.prodname_github_app %} installation access token, if the installation was only granted access to a subset of repositories in an organization, any request for all repositories in that organization will return only the repositories that the app installation can access. @@ -83,7 +83,7 @@ If you are using pagination correctly and still do not see all of the results th ## Requires authentication when using basic authentication -Basic authentication with your username and password is not supported. Instead, you should use a {% data variables.product.pat_generic %} or an access token for a {% data variables.product.prodname_github_app %} or {% data variables.product.prodname_oauth_app %}. For more information, see [AUTOTITLE](/rest/overview/authenticating-to-the-rest-api). +Basic authentication with your username and password is not supported. Instead, you should use a {% data variables.product.pat_generic %} or an access token for a {% data variables.product.prodname_github_app %} or {% data variables.product.prodname_oauth_app %}. For more information, see [AUTOTITLE](/rest/authentication/authenticating-to-the-rest-api). {% endif %} @@ -144,7 +144,7 @@ curl {% data reusables.rest-api.version-header %} https://api.github.com/zen If you specify a version that does not exist, you will receive a `400 Bad Request` error and a message about the version not being supported. -For more information, see [AUTOTITLE](/rest/overview/api-versions). +For more information, see [AUTOTITLE](/rest/about-the-rest-api/api-versions). ## User agent required @@ -160,6 +160,6 @@ If you observe unexpected failures, you can use [githubstatus.com](https://www.g ## Further reading -* [AUTOTITLE](/rest/guides/best-practices-for-using-the-rest-api) +* [AUTOTITLE](/rest/using-the-rest-api/best-practices-for-using-the-rest-api) * [AUTOTITLE](/webhooks/testing-and-troubleshooting-webhooks/troubleshooting-webhooks) * [AUTOTITLE](/apps/creating-github-apps/about-creating-github-apps/best-practices-for-creating-a-github-app) diff --git a/content/rest/using-the-rest-api/using-pagination-in-the-rest-api.md b/content/rest/using-the-rest-api/using-pagination-in-the-rest-api.md index df6b508dfab2..aadf26371017 100644 --- a/content/rest/using-the-rest-api/using-pagination-in-the-rest-api.md +++ b/content/rest/using-the-rest-api/using-pagination-in-the-rest-api.md @@ -60,11 +60,11 @@ curl --include --request GET \ --header "Accept: application/vnd.github+json" ``` -The URLs in the `link` header use query parameters to indicate which page of results to return. The query parameters in the `link` URLs may differ between endpoints, however each paginated endpoint will use the `page`, `before`/`after`, or `since` query parameters. (Some endpoints use the `since` parameter for something other than pagination.) In all cases, you can use the URLs in the `link` header to fetch additional pages of results. For more information about query parameters see [AUTOTITLE](/rest/guides/getting-started-with-the-rest-api#using-query-parameters). +The URLs in the `link` header use query parameters to indicate which page of results to return. The query parameters in the `link` URLs may differ between endpoints, however each paginated endpoint will use the `page`, `before`/`after`, or `since` query parameters. (Some endpoints use the `since` parameter for something other than pagination.) In all cases, you can use the URLs in the `link` header to fetch additional pages of results. For more information about query parameters see [AUTOTITLE](/rest/using-the-rest-api/getting-started-with-the-rest-api#using-query-parameters). ## Changing the number of items per page -If an endpoint supports the `per_page` query parameter, then you can control how many results are returned on a page. For more information about query parameters see [AUTOTITLE](/rest/guides/getting-started-with-the-rest-api#using-query-parameters). +If an endpoint supports the `per_page` query parameter, then you can control how many results are returned on a page. For more information about query parameters see [AUTOTITLE](/rest/using-the-rest-api/getting-started-with-the-rest-api#using-query-parameters). For example, this request uses the `per_page` query parameter to return two items per page: @@ -84,7 +84,7 @@ link: ; re Instead of manually copying URLs from the `link` header, you can write a script to fetch multiple pages of results. -The following examples use JavaScript and {% data variables.product.company_short %}'s Octokit.js library. For more information about Octokit.js, see [AUTOTITLE](/rest/guides/getting-started-with-the-rest-api?tool=javascript) and [the Octokit.js README](https://github.com/octokit/octokit.js/#readme). +The following examples use JavaScript and {% data variables.product.company_short %}'s Octokit.js library. For more information about Octokit.js, see [AUTOTITLE](/rest/using-the-rest-api/getting-started-with-the-rest-api?tool=javascript) and [the Octokit.js README](https://github.com/octokit/octokit.js/#readme). ### Example using the Octokit.js pagination method From 564868161b9cd8bb75f789079690fb44a4a5149d Mon Sep 17 00:00:00 2001 From: Kevin Heis Date: Thu, 9 Jul 2026 09:26:03 -0700 Subject: [PATCH 06/15] Update redirected internal links in contributing (#62101) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../about-contributing-to-github-docs.md | 8 ++-- .../using-git-on-github-docs.md | 2 +- .../troubleshooting-your-environment.md | 2 +- .../working-on-github-docs-in-a-codespace.md | 2 +- .../about-combining-multiple-content-types.md | 6 +-- .../about-the-content-model.md | 6 +-- .../concepts-content-type.md | 6 +-- .../contents-of-a-github-docs-article.md | 10 ++-- .../how-to-content-type.md | 4 +- .../quickstart-content-type.md | 2 +- .../reference-content-type.md | 12 ++--- .../style-guide.md | 48 +++++++++---------- .../troubleshooting-content-type.md | 2 +- .../tutorial-content-type.md | 10 ++-- .../best-practices-for-github-docs.md | 4 +- .../creating-diagrams-for-github-docs.md | 4 +- .../creating-screenshots.md | 2 +- ...sing-markdown-and-liquid-in-github-docs.md | 14 +++--- .../using-yaml-frontmatter.md | 6 +-- 19 files changed, 75 insertions(+), 75 deletions(-) diff --git a/content/contributing/collaborating-on-github-docs/about-contributing-to-github-docs.md b/content/contributing/collaborating-on-github-docs/about-contributing-to-github-docs.md index 050ae2200f6d..47aa3ccb0746 100644 --- a/content/contributing/collaborating-on-github-docs/about-contributing-to-github-docs.md +++ b/content/contributing/collaborating-on-github-docs/about-contributing-to-github-docs.md @@ -16,7 +16,7 @@ The documentation repository is the place to discuss and collaborate on the docu ## Issues -[Issues](/github/managing-your-work-on-github/about-issues) are used to track tasks that contributors can help with. If an issue has a `triage` label, we haven't reviewed it yet, and you shouldn't begin work on it. +[Issues](/issues/tracking-your-work-with-issues/learning-about-issues/about-issues) are used to track tasks that contributors can help with. If an issue has a `triage` label, we haven't reviewed it yet, and you shouldn't begin work on it. If you've found something in the documentation content, or something about the docs.github.com website, that should be updated, search the open issues to see if someone else has reported the same thing. If it's something new, open an issue using a [template](https://github.com/github/docs/issues/new/choose). We'll use the issue to have a conversation about the problem you'd like to be fixed. @@ -25,9 +25,9 @@ If you've found something in the documentation content, or something about the d ## Pull requests -A [pull request](/github/collaborating-with-issues-and-pull-requests/about-pull-requests) is a way to suggest changes in our repository. When we merge those changes, they're deployed to the live site within 24 hours. +A [pull request](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) is a way to suggest changes in our repository. When we merge those changes, they're deployed to the live site within 24 hours. -We cannot accept contributions to the [REST API reference documentation](/rest/reference). If you spot an inaccuracy in the REST API reference documentation, open an issue in the [`rest-api-description`](https://github.com/github/rest-api-description/issues/new?template=schema-inaccuracy.md) repository. +We cannot accept contributions to the [REST API reference documentation](/rest). If you spot an inaccuracy in the REST API reference documentation, open an issue in the [`rest-api-description`](https://github.com/github/rest-api-description/issues/new?template=schema-inaccuracy.md) repository. We only document {% data variables.product.prodname_dotcom %} products, features, tools, and extensions. We may mention or link to third-party tools to demonstrate how a feature works, but we do not accept pull requests to document third-party tools or integrations unless they were codeveloped with {% data variables.product.company_short %}. @@ -41,7 +41,7 @@ For content changes, make sure that you: * Review the content for technical accuracy. * Check your changes for grammar, spelling, and adherence to the [AUTOTITLE](/contributing/style-guide-and-content-model/style-guide). * Make sure the text in your pull request will be easy to translate. For more information, see [AUTOTITLE](/contributing/writing-for-github-docs/writing-content-to-be-translated). -* Check new or updated Liquid statements to confirm that versioning is correct. For more information, see [AUTOTITLE](/contributing/syntax-and-versioning-for-github-docs/versioning-documentation). +* Check new or updated Liquid statements to confirm that versioning is correct. For more information, see [AUTOTITLE](/contributing/writing-for-github-docs/versioning-documentation). * Check the preview of any pages you have changed. A preview is automatically generated after you submit a pull request and links are added to the pull request. The preview sometimes takes several minutes before it is ready to view. Confirm that everything is rendering as expected. Checking the preview will help you identify problems such as typos, content that doesn't follow the style guide, or content that isn't rendering due to versioning problems. Make sure to check the rendered output for lists and tables, which can sometimes have problems that are difficult to identify in the Markdown. * If there are any failing checks in your pull request, troubleshoot them until they're all passing. diff --git a/content/contributing/collaborating-on-github-docs/using-git-on-github-docs.md b/content/contributing/collaborating-on-github-docs/using-git-on-github-docs.md index 6e08769174ef..0816ff6a4083 100644 --- a/content/contributing/collaborating-on-github-docs/using-git-on-github-docs.md +++ b/content/contributing/collaborating-on-github-docs/using-git-on-github-docs.md @@ -131,7 +131,7 @@ To keep your local branches in sync with their remotes and avoid merge conflicts * If a commit addresses an issue, you can reference the issue number in the commit, and a link to the commit will appear in the issue conversation timeline: "Addresses #1234 - adds steps for backing up the VM before upgrading." > [!NOTE] - > We generally don't close an issue via a commit. To close an issue, open a pull request and add "Closes #1234" to the description. The linked issue will be closed when the pull request is merged. For more information, see [AUTOTITLE](/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue). + > We generally don't close an issue via a commit. To close an issue, open a pull request and add "Closes #1234" to the description. The linked issue will be closed when the pull request is merged. For more information, see [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue). * Make commit messages clear, detailed, and imperative. For example: "Add conceptual article about 2FA," not "Add info." * Try not to leave uncommitted changes in your local branch when you finish working for the day. Get to a good stopping point and commit and push your changes so your work is backed up to the remote repository. diff --git a/content/contributing/setting-up-your-environment-to-work-on-github-docs/troubleshooting-your-environment.md b/content/contributing/setting-up-your-environment-to-work-on-github-docs/troubleshooting-your-environment.md index 1687db39a66c..41617b2ce795 100644 --- a/content/contributing/setting-up-your-environment-to-work-on-github-docs/troubleshooting-your-environment.md +++ b/content/contributing/setting-up-your-environment-to-work-on-github-docs/troubleshooting-your-environment.md @@ -60,7 +60,7 @@ npm start When the server is running, navigate to the problematic article on `https://localhost:4000` in your browser. The staging server will just show an "Oops" error, but the local server should show a stack trace for debugging. -If you see an error resembling the one below, make sure single quotes are properly escaped in the frontmatter. Also, check the formatting in `redirect_from` blocks. For more information, see [AUTOTITLE](/contributing/syntax-and-versioning-for-github-docs/using-yaml-frontmatter#escaping-single-quotes). +If you see an error resembling the one below, make sure single quotes are properly escaped in the frontmatter. Also, check the formatting in `redirect_from` blocks. For more information, see [AUTOTITLE](/contributing/writing-for-github-docs/using-yaml-frontmatter#escaping-single-quotes). ```text error parsing file: /Users/z/git/github/docs/content/dotcom/articles/troubleshooting-custom-domains-and-github-pages.md diff --git a/content/contributing/setting-up-your-environment-to-work-on-github-docs/working-on-github-docs-in-a-codespace.md b/content/contributing/setting-up-your-environment-to-work-on-github-docs/working-on-github-docs-in-a-codespace.md index 53e3e975a1fe..56e7d305c0db 100644 --- a/content/contributing/setting-up-your-environment-to-work-on-github-docs/working-on-github-docs-in-a-codespace.md +++ b/content/contributing/setting-up-your-environment-to-work-on-github-docs/working-on-github-docs-in-a-codespace.md @@ -18,7 +18,7 @@ For more information, see [AUTOTITLE](/free-pro-team@latest/codespaces/quickstar ## Working on documentation in a codespace -The following steps assume you have {% data variables.product.prodname_github_codespaces %} set up to edit files using {% data variables.product.prodname_vscode %} for Web. The steps are very similar if you have set a different editor. For more information, see [AUTOTITLE](/free-pro-team@latest/codespaces/customizing-your-codespace/setting-your-default-editor-for-codespaces). +The following steps assume you have {% data variables.product.prodname_github_codespaces %} set up to edit files using {% data variables.product.prodname_vscode %} for Web. The steps are very similar if you have set a different editor. For more information, see [AUTOTITLE](/free-pro-team@latest/codespaces/setting-your-user-preferences/setting-your-default-editor-for-github-codespaces). 1. Navigate to the open source repository for {% data variables.product.prodname_docs %}, [`github/docs`](https://github.com/github/docs). 1. If you're an open source contributor, create a fork of the repository, then follow the rest of the steps in this procedure from your fork. For more information, see [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo). diff --git a/content/contributing/style-guide-and-content-model/about-combining-multiple-content-types.md b/content/contributing/style-guide-and-content-model/about-combining-multiple-content-types.md index 0d38df9ed72f..def45bcea240 100644 --- a/content/contributing/style-guide-and-content-model/about-combining-multiple-content-types.md +++ b/content/contributing/style-guide-and-content-model/about-combining-multiple-content-types.md @@ -30,6 +30,6 @@ Often, it's helpful to group information in context to help people complete a co ## Examples of articles that combine multiple content types * [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility) -* [AUTOTITLE](/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise) -* [AUTOTITLE](/free-pro-team@latest/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription) -* [AUTOTITLE](/enterprise-server@latest/admin/configuration/enabling-and-scheduling-maintenance-mode) +* [AUTOTITLE](/enterprise-cloud@latest/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise) +* [AUTOTITLE](/free-pro-team@latest/billing/how-tos/manage-plan-and-licenses/upgrade-plan) +* [AUTOTITLE](/enterprise-server@latest/admin/administering-your-instance/configuring-maintenance-mode/enabling-and-scheduling-maintenance-mode) diff --git a/content/contributing/style-guide-and-content-model/about-the-content-model.md b/content/contributing/style-guide-and-content-model/about-the-content-model.md index e3826af47cb8..5b340b129ca2 100644 --- a/content/contributing/style-guide-and-content-model/about-the-content-model.md +++ b/content/contributing/style-guide-and-content-model/about-the-content-model.md @@ -76,7 +76,7 @@ Categories are organized around a feature or a discrete set of tasks within a to * General or high-level enough to scale with future product enhancements. * Category titles must be 67 characters or shorter and have a [`shortTitle`](https://github.com/github/docs/tree/main/content#shorttitle) less than 27 characters. * Examples - * [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github) + * [AUTOTITLE](/account-and-profile/how-tos) * [AUTOTITLE](/pull-requests/committing-changes-to-your-project) ### Intros for categories @@ -98,8 +98,8 @@ In general, avoid having a map topic within a map topic unless it is the best wa * General or high-level enough to scale with future additions to the product. * Map topic titles must be 63 characters or shorter and have a [`shortTitle`](https://github.com/github/docs/tree/main/content#shorttitle) less than 30 characters. * Examples - * [AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain) - * [AUTOTITLE](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise) + * [AUTOTITLE](/code-security/concepts/supply-chain-security) + * [AUTOTITLE](/enterprise-cloud@latest/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise) ### Intros for map topics diff --git a/content/contributing/style-guide-and-content-model/concepts-content-type.md b/content/contributing/style-guide-and-content-model/concepts-content-type.md index 9bca16672d17..d939ef673352 100644 --- a/content/contributing/style-guide-and-content-model/concepts-content-type.md +++ b/content/contributing/style-guide-and-content-model/concepts-content-type.md @@ -42,7 +42,7 @@ Headers of conceptual sections in articles start with "About [subject]”. * Conceptual articles * [About GitHub Sponsors](/free-pro-team@latest/sponsors/getting-started-with-github-sponsors/about-github-sponsors) - * [About Enterprise accounts](/enterprise-cloud@latest/admin/overview/about-enterprise-accounts) + * [About Enterprise accounts](/enterprise-cloud@latest/admin/concepts/enterprise-fundamentals/enterprise-accounts) * Conceptual sections within other articles - * "About security policies" in [AUTOTITLE](/code-security/getting-started/adding-a-security-policy-to-your-repository#about-security-policies) - * "About maintenance mode" in [AUTOTITLE](/enterprise-server@latest/admin/configuration/enabling-and-scheduling-maintenance-mode#about-maintenance-mode) + * "About security policies" in [AUTOTITLE](/code-security/how-tos/report-and-fix-vulnerabilities/configure-vulnerability-reporting/add-security-policy#about-security-policies) + * "About maintenance mode" in [AUTOTITLE](/enterprise-server@latest/admin/administering-your-instance/configuring-maintenance-mode/enabling-and-scheduling-maintenance-mode#about-maintenance-mode) 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 1605745ec623..3db9d545fed3 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 @@ -112,11 +112,11 @@ Tables of contents are automatically generated. For more information see [Autoge ## Conceptual content -Conceptual content helps people understand or learn about a topic. For more information, see [AUTOTITLE](/contributing/style-guide-and-content-model/conceptual-content-type) in the content model. +Conceptual content helps people understand or learn about a topic. For more information, see [AUTOTITLE](/contributing/style-guide-and-content-model/concepts-content-type) in the content model. ## Referential content -Referential content provides structured information related to actively using a product or feature. For more information, see [AUTOTITLE](/contributing/style-guide-and-content-model/referential-content-type) in the content model. +Referential content provides structured information related to actively using a product or feature. For more information, see [AUTOTITLE](/contributing/style-guide-and-content-model/reference-content-type) in the content model. ## Prerequisites @@ -137,8 +137,8 @@ Prerequisites are information that people need to know before proceeding with a ### Examples of articles with prerequisites sections -* [AUTOTITLE](/enterprise-server@latest/admin/installation/installing-github-enterprise-server-on-aws) -* [AUTOTITLE](/enterprise-server@latest/admin/configuration/enabling-subdomain-isolation) +* [AUTOTITLE](/enterprise-server@latest/admin/installing-your-enterprise-server/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-aws) +* [AUTOTITLE](/enterprise-server@latest/admin/configuring-settings/hardening-security-for-your-enterprise/enabling-subdomain-isolation) ## How-to content @@ -162,7 +162,7 @@ When an article describes one step in a larger process or has a logical next ste - {% data variables.product.company_short %} recommends that you review security considerations for self-hosted runner machines. See "Security hardening for {% data variables.product.prodname_actions %}." ``` -In this example from [AUTOTITLE](/enterprise-cloud@latest/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-self-hosted-runners-for-your-enterprise#next-steps), the next steps section includes links to procedures that someone will need to do after they start using the feature described in the article. +In this example from [AUTOTITLE](/enterprise-cloud@latest/admin/managing-github-actions-for-your-enterprise/getting-started-with-github-actions-for-your-enterprise/getting-started-with-self-hosted-runners-for-your-enterprise#next-steps), the next steps section includes links to procedures that someone will need to do after they start using the feature described in the article. ```markdown ## Next steps diff --git a/content/contributing/style-guide-and-content-model/how-to-content-type.md b/content/contributing/style-guide-and-content-model/how-to-content-type.md index 722ad951f5b7..6b04e56acd6f 100644 --- a/content/contributing/style-guide-and-content-model/how-to-content-type.md +++ b/content/contributing/style-guide-and-content-model/how-to-content-type.md @@ -44,5 +44,5 @@ For the how-to content template, see [AUTOTITLE](/contributing/writing-for-githu ## Examples of how-to content -{% ifversion fpt or ghec %}* [AUTOTITLE](/copilot/how-tos/provide-context/use-copilot-spaces/create-copilot-spaces){% endif %} -* [AUTOTITLE](/actions/using-workflows/using-starter-workflows) +{% ifversion fpt or ghec %}* [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/copilot-spaces/create-copilot-spaces){% endif %} +* [AUTOTITLE](/actions/how-tos/write-workflows/use-workflow-templates) diff --git a/content/contributing/style-guide-and-content-model/quickstart-content-type.md b/content/contributing/style-guide-and-content-model/quickstart-content-type.md index a3ff5925456a..9a10e81695f8 100644 --- a/content/contributing/style-guide-and-content-model/quickstart-content-type.md +++ b/content/contributing/style-guide-and-content-model/quickstart-content-type.md @@ -45,6 +45,6 @@ Contents of quickstarts: ## Examples of quickstarts -* [AUTOTITLE](/free-pro-team@latest/actions/quickstart) +* [AUTOTITLE](/free-pro-team@latest/actions/get-started/quickstart) * [AUTOTITLE](/free-pro-team@latest/discussions/quickstart) * [Quickstart for GitHub Educators](/free-pro-team@latest/education/quickstart) diff --git a/content/contributing/style-guide-and-content-model/reference-content-type.md b/content/contributing/style-guide-and-content-model/reference-content-type.md index b01a5d9df02a..1cd49045bb8d 100644 --- a/content/contributing/style-guide-and-content-model/reference-content-type.md +++ b/content/contributing/style-guide-and-content-model/reference-content-type.md @@ -25,13 +25,13 @@ For the reference content template, see [AUTOTITLE](/contributing/writing-for-gi * Write a sentence or an entire conceptual section to introduce the reference content. * Present the actual reference content clearly and consistently. * For subjects with a single element to explain, use a list. - * Example: [AUTOTITLE](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization#repository-roles-for-organizations) + * Example: [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization#repository-roles-for-organizations) * For subjects with multiple elements to explain, use a table. - * Example: [AUTOTITLE](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization#permissions-for-each-role) + * Example: [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization#permissions-for-each-role) * For longer referential content, such as YAML syntax for workflows, use headers consistently. * H2 headers for each distinct section. * H3 headers for subsections, such as examples. - * Example: [AUTOTITLE](/actions/reference/workflow-syntax-for-github-actions) + * Example: [AUTOTITLE](/actions/reference/workflows-and-actions/workflow-syntax) ## Titles for referential content @@ -44,9 +44,9 @@ For the reference content template, see [AUTOTITLE](/contributing/writing-for-gi * Reference articles * [AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/audit-log-events-for-your-organization) - * [AUTOTITLE](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise) - * [AUTOTITLE](/free-pro-team@latest/rest/reference/billing) in the REST API documentation + * [AUTOTITLE](/enterprise-cloud@latest/admin/managing-accounts-and-repositories/managing-roles-in-your-enterprise/abilities-of-roles) + * [AUTOTITLE](/rest/billing/billing) in the REST API documentation * [AUTOTITLE](/graphql/reference) in the GraphQL API documentation * Reference sections within other articles * "Supported languages" in [AUTOTITLE](/free-pro-team@latest/get-started/using-github/github-mobile#supported-languages-for-github-mobile) - * "Hardware considerations" in [AUTOTITLE](/enterprise-server@latest/admin/installation/installing-github-enterprise-server-on-aws#hardware-considerations) + * "Hardware considerations" in [AUTOTITLE](/enterprise-server@latest/admin/installing-your-enterprise-server/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-aws#hardware-considerations) diff --git a/content/contributing/style-guide-and-content-model/style-guide.md b/content/contributing/style-guide-and-content-model/style-guide.md index b78e06c49947..5196691b2fc3 100644 --- a/content/contributing/style-guide-and-content-model/style-guide.md +++ b/content/contributing/style-guide-and-content-model/style-guide.md @@ -16,7 +16,7 @@ A condensed version of this style guide is available at `.github/instructions/st --> > [!NOTE] -> These guidelines are specific to {% data variables.product.company_short %}'s documentation. For general style questions or guidance on topics not covered here, see the [Microsoft Style Guide](https://docs.microsoft.com/style-guide/welcome/). For markup specific to source content on docs.github.com, see [AUTOTITLE](/contributing/syntax-and-versioning-for-github-docs/using-markdown-and-liquid-in-github-docs). For any questions about the GitHub brand, see our [GitHub Brand Guide](https://brand.github.com). +> These guidelines are specific to {% data variables.product.company_short %}'s documentation. For general style questions or guidance on topics not covered here, see the [Microsoft Style Guide](https://docs.microsoft.com/style-guide/welcome/). For markup specific to source content on docs.github.com, see [AUTOTITLE](/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs). For any questions about the GitHub brand, see our [GitHub Brand Guide](https://brand.github.com). ## The {% data variables.product.prodname_docs %} approach to style @@ -62,7 +62,7 @@ Notes are particularly useful for communicating parenthetical information that i * Caveats that might affect the outcome of a process, such as specific user settings. * Products and features that are subject to changes in availability, such as those in {% data variables.release-phases.public_preview %} or {% data variables.release-phases.closing_down %}. -For example, [AUTOTITLE](/code-security/secret-scanning/managing-alerts-from-secret-scanning/evaluating-alerts#reviewing-github-token-metadata) uses a note to inform users that metadata for {% data variables.product.prodname_dotcom %} tokens is currently in {% data variables.release-phases.public_preview %}. +For example, [AUTOTITLE](/code-security/tutorials/remediate-leaked-secrets/evaluating-alerts#reviewing-github-token-metadata) uses a note to inform users that metadata for {% data variables.product.prodname_dotcom %} tokens is currently in {% data variables.release-phases.public_preview %}. > [!NOTE] > Metadata for {% data variables.product.prodname_dotcom %} tokens is currently in {% data variables.release-phases.public_preview %} and subject to change. @@ -71,7 +71,7 @@ For example, [AUTOTITLE](/code-security/secret-scanning/managing-alerts-from-sec Recommendations, best practices or product hints. Tips contain non-essential information that users can follow at their discretion. Particularly useful in articles aimed at new users. -For example, [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile) uses a tip alert to help users understand what to expect when they @mention an organization. +For example, [AUTOTITLE](/account-and-profile/tutorials/personalize-your-profile) uses a tip alert to help users understand what to expect when they @mention an organization. > [!TIP] > When you @mention an organization, only those that you're a member of will autocomplete. You can still @mention organizations that you're not a member of, like a previous employer, but the organization name won't autocomplete for you. @@ -81,7 +81,7 @@ For example, [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-githu Highlights key information users need to know to achieve their goal. > [!IMPORTANT] -> Runner Scale Sets do not support multiple labels, only the name of the runner can be used in place of a label. See [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/deploying-runner-scale-sets-with-actions-runner-controller). +> Runner Scale Sets do not support multiple labels, only the name of the runner can be used in place of a label. See [AUTOTITLE](/actions/how-tos/manage-runners/use-actions-runner-controller/deploy-runner-scale-sets). #### Warning @@ -136,7 +136,7 @@ Caution: Liquid syntax for alerts is still supported and may still appear in older articles, but should not be used for new alerts. -For more information on formatting alerts, see “Alerts” in [AUTOTITLE](/contributing/syntax-and-versioning-for-github-docs/using-markdown-and-liquid-in-github-docs#alerts). +For more information on formatting alerts, see “Alerts” in [AUTOTITLE](/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs#alerts). ## Call to action (CTA) @@ -184,7 +184,7 @@ https://github.com/account/enterprises/new?ref_product=ghec&ref_type=trial&ref_s ### Code blocks -Keep lines in code samples to about 60 characters, to avoid requiring readers to scroll horizontally in the code block. Locate explanatory text before the code block, rather than using comments inside the code block. See [AUTOTITLE](/contributing/syntax-and-versioning-for-github-docs/using-markdown-and-liquid-in-github-docs#code-sample-syntax-highlighting) for more information on the syntax and formatting of code blocks. +Keep lines in code samples to about 60 characters, to avoid requiring readers to scroll horizontally in the code block. Locate explanatory text before the code block, rather than using comments inside the code block. See [AUTOTITLE](/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs#code-sample-syntax-highlighting) for more information on the syntax and formatting of code blocks. Within code blocks: * Specify the language of the sample after the first code fence. For a list of all supported languages, see [Code languages](https://github.com/github/docs/blob/main/data/code-languages.yml) in the [`github/docs`](https://github.com/github/docs) repository. @@ -501,7 +501,7 @@ Use alt text to express the core idea of the image, without duplicating the webp > Diagram showing a five-step process by which a {% data variables.product.prodname_actions %} runner can be automatically added to named classes of runners and then requested by specific jobs. -For example, see [accompanying explanation of this diagram in the Actions documentation](/free-pro-team@latest/actions/using-github-hosted-runners/using-larger-runners/about-larger-runners#architectural-overview-of-larger-runners). +For example, see [accompanying explanation of this diagram in the Actions documentation](/free-pro-team@latest/actions/concepts/runners/larger-runners#architectural-overview-of-larger-runners). #### Alt text for images of command-line interfaces @@ -816,7 +816,7 @@ Together, permission statements and product callouts tell readers who can use th Consider what information belongs in a permission statement or a product callout. -For example, when creating permissions and product callouts for the article [AUTOTITLE](/free-pro-team@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-github-copilot-features-in-your-organization/managing-policies-for-copilot-in-your-organization), the permission statement would answer "What role can manage policies and features for {% data variables.product.prodname_copilot %} in an organization?" And the product callout would answer "What {% data variables.product.prodname_copilot_short %} subscriptions do users need to manage {% data variables.product.prodname_copilot_short %} policies and features for an organization?" +For example, when creating permissions and product callouts for the article [AUTOTITLE](/free-pro-team@latest/copilot/how-tos/administer-copilot/manage-for-organization/manage-policies), the permission statement would answer "What role can manage policies and features for {% data variables.product.prodname_copilot %} in an organization?" And the product callout would answer "What {% data variables.product.prodname_copilot_short %} subscriptions do users need to manage {% data variables.product.prodname_copilot_short %} policies and features for an organization?" #### Focus on key information, not explanations @@ -938,7 +938,7 @@ steps: ``` Examples: -* See the code block in [Publishing to package registries](/actions/guides/building-and-testing-python#publishing-to-package-registries) +* See the code block in [Publishing to package registries](/actions/tutorials/build-and-test-code/python#publishing-to-package-registries) #### Pinning version numbers to SHA @@ -956,7 +956,7 @@ steps: - uses: actions/javascript-action@main ``` -For more information, see [Using SHAs](/actions/learn-github-actions/finding-and-customizing-actions#using-shas) +For more information, see [Using SHAs](/actions/how-tos/write-workflows/choose-what-workflows-do/find-and-customize-actions#using-shas) ### {% data variables.product.prodname_codespaces %} @@ -991,7 +991,7 @@ You should use variables to refer to these types of tokens, as well as to {% dat * Use `{% raw %}{% data variables.product.pat_v2 %}{% endraw %}` or `{% raw %}{% data variables.product.pat_v2_caps %}{% endraw %}` to refer to {% data variables.product.pat_v2 %}s. * Use `{% raw %}{% data variables.product.pat_v1 %}{% endraw %}`, `{% raw %}{% data variables.product.pat_v1_plural %}{% endraw %}`, `{% raw %}{% data variables.product.pat_v1_caps %}{% endraw %}`, or `{% raw %}{% data variables.product.pat_v1_caps_plural %}{% endraw %}` to refer to {% data variables.product.pat_v1 %}. -For more information about {% data variables.product.prodname_dotcom %}'s {% data variables.product.pat_generic_plural %}, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#about-personal-access-tokens). +For more information about {% data variables.product.prodname_dotcom %}'s {% data variables.product.pat_generic_plural %}, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#about-personal-access-tokens). ## Punctuation @@ -1249,7 +1249,7 @@ Use reusable strings for individual nouns (e.g. product names) or for complete s If a section of an article uses `H3` or `H4` headers to further divide the content and only some of the content is relevant to a reader, you can use a sectional table of contents (TOC) to help readers identify and navigate to the information that is most relevant to them. For example, in [AUTOTITLE](/enterprise-cloud@latest/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise#setting-up-streaming-to-amazon-s3) people will probably only set up audit log streaming for one provider, so the sectional TOC in "Setting up audit log streaming" allows people to select their provider and navigate to the relevant content without reading the entire section. -Do not add a sectional TOC if `H3` or `H4` headers are used only to group content and all information could be of relevance to a reader. For example, in [AUTOTITLE](/enterprise-cloud@latest/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise#identifying-the-best-authentication-method-for-your-enterprise), people should read and consider each section as it relates to their enterprise. We do not include a sectional TOC in this article because people should be reading through each section, not picking and choosing between them. Adding a sectional TOC would also force people who use screenreaders or other adaptive technology to tab and scroll through more headers before finding what they need. +Do not add a sectional TOC if `H3` or `H4` headers are used only to group content and all information could be of relevance to a reader. For example, in [AUTOTITLE](/enterprise-cloud@latest/admin/concepts/identity-and-access-management/identity-and-access-management-fundamentals#identifying-the-best-authentication-method-for-your-enterprise), people should read and consider each section as it relates to their enterprise. We do not include a sectional TOC in this article because people should be reading through each section, not picking and choosing between them. Adding a sectional TOC would also force people who use screenreaders or other adaptive technology to tab and scroll through more headers before finding what they need. Format sectional TOCs as a list. Include all subsections in the order that they appear in the article and refer to them using the full header title. @@ -1307,7 +1307,7 @@ Tables work best for presenting tabular data, such as information that needs to A table’s data and why it is important should be clear from any preceding content, the column headers, and (if needed) the row headers. Avoid unneeded descriptions of the data in a table. If the data in a table is unclear without a lengthy description, consider if your table needs row headers or if the information would be better communicated in a different way. -For example, in [AUTOTITLE](/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners#recommended-autoscaling-solutions), a table comparing the features between two supported autoscaling solutions is introduced with the sentence `Each solution has certain specifics that may be important to consider.` The article does not describe any of the different features that are compared because that information is clearly communicated by the table. +For example, in [AUTOTITLE](/actions/reference/runners/self-hosted-runners#recommended-autoscaling-solutions), a table comparing the features between two supported autoscaling solutions is introduced with the sentence `Each solution has certain specifics that may be important to consider.` The article does not describe any of the different features that are compared because that information is clearly communicated by the table. * **Use:** "Different size limits per repository apply depending on your GHES version." * **Avoid:** "The first row of the table shows the information for GitHub Enterprise Cloud. The second row shows the information for GitHub Enterprise Server." @@ -1354,7 +1354,7 @@ For example in the following table, in order to make sense of the "Yes" and "No" -To add row headers for a Markdown table, wrap the table in the Liquid tags `{% raw %}{% rowheaders %} {% endrowheaders %}{% endraw %}`. For more information about using row headers, see [AUTOTITLE](/contributing/syntax-and-versioning-for-github-docs/using-markdown-and-liquid-in-github-docs#table-row-headers). +To add row headers for a Markdown table, wrap the table in the Liquid tags `{% raw %}{% rowheaders %} {% endrowheaders %}{% endraw %}`. For more information about using row headers, see [AUTOTITLE](/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs#table-row-headers). ### Include a value for every cell @@ -1362,14 +1362,14 @@ Every cell in a table must contain a value. For cells with no data, use "None" or "Not applicable". Do not use "NA" or "N/A". -For tables with row headers, the first cell (cell "A1") should describe the row headers to help people understand the whole table. However, if doing this would make the table less clear or add redundant information, you can leave this cell empty. For example, in the article [AUTOTITLE](/actions/automating-builds-and-tests/building-and-testing-powershell#powershell-module-locations), the first cell could be labeled as "Modules", but since each row header already includes the word "module", this header would repeat information that does not add descriptive value to understanding the table as a whole. +For tables with row headers, the first cell (cell "A1") should describe the row headers to help people understand the whole table. However, if doing this would make the table less clear or add redundant information, you can leave this cell empty. For example, in the article [AUTOTITLE](/actions/tutorials/build-and-test-code/powershell#powershell-module-locations), the first cell could be labeled as "Modules", but since each row header already includes the word "module", this header would repeat information that does not add descriptive value to understanding the table as a whole. ### Use clear, consistent symbols and labels For tables that use symbols: * Populate all cells. For example in a permissions table, do not mark only the cells for things that require a permission. -* Use octicons or SVG. Do not use emoji. For more information about octicons, see [AUTOTITLE](/contributing/syntax-and-versioning-for-github-docs/using-markdown-and-liquid-in-github-docs#octicons). +* Use octicons or SVG. Do not use emoji. For more information about octicons, see [AUTOTITLE](/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs#octicons). * Use a [check mark](https://primer.style/octicons/icon/check-16) for affirmative values ("Yes", "Required", "Supported") and a [cross](https://primer.style/octicons/icon/x-16) for negative values ("No", "Optional", "Unsupported"). * Use `aria-label` to describe the meaning of the symbol, not its visual characteristics. For example, "Required", not "Check mark icon". @@ -1385,7 +1385,7 @@ All columns in a table should be left-aligned, except for columns containing onl Table content is left-aligned by default. Use Markdown table formatting, colons (`:`) to either the right or left of the dashes in the header row, to specify the alignment of each column. Read [AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-tables#formatting-content-within-your-table) for more information. -The following example shows part of a table from [AUTOTITLE](/code-security/dependabot/working-with-dependabot/dependabot-options-reference). +The following example shows part of a table from [AUTOTITLE](/code-security/reference/supply-chain-security/dependabot-options-reference). @@ -1469,7 +1469,7 @@ We use short titles to populate the sidebar navigation. Since short titles appea * Short titles use the base form of verbs instead of gerunds. * **Use:** "Configure notifications" instead of "Configuring notifications." * Short titles for categories, map topics, and articles can omit product and feature names if it is clear what product or feature they relate to. - * **Use:** "Configure notifications" as the short title for [AUTOTITLE](/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts) since the article is in the "{% data variables.product.prodname_dependabot_alerts %}" map topic. + * **Use:** "Configure notifications" as the short title for [AUTOTITLE](/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/configure-dependabot-notifications) since the article is in the "{% data variables.product.prodname_dependabot_alerts %}" map topic. * Short titles do not introduce new words that are not in the full title. * Short titles should be parallel to short titles for similar content. * **Use:** "Organizations and teams" and "Enterprise accounts" @@ -1571,7 +1571,7 @@ Microsoft Style Guide: You may add videos to reinforce text-based information but videos should never replace written content. Videos are inaccessible to some users and are also difficult to find by searching. -Videos on the GitHub Docs website must be well-produced and contain fewer barriers for people with disabilities, and conform to our content model for videos. For more information, see [About using videos in GitHub Docs](/contributing/writing-for-github-docs/using-videos-in-github-docs). +Videos on the GitHub Docs website must be well-produced and contain fewer barriers for people with disabilities, and conform to our content model for videos. For more information, see [About using videos in GitHub Docs](/contributing/writing-for-github-docs). ## Voice and tone @@ -1624,8 +1624,8 @@ Unless the content is about administering an enterprise product, describe an ind With {% data variables.product.company_short %}'s enterprise products, administrators manage an enterprise account. An enterprise account can own multiple organizations, and people's user accounts can be members of the organizations. For more information, see the "Roles in an enterprise" article for each product. -* [{% data variables.product.prodname_ghe_cloud %}](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise) -* [{% data variables.product.prodname_ghe_server %}](/enterprise-server@latest/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise) +* [{% data variables.product.prodname_ghe_cloud %}](/enterprise-cloud@latest/admin/managing-accounts-and-repositories/managing-roles-in-your-enterprise/abilities-of-roles) +* [{% data variables.product.prodname_ghe_server %}](/enterprise-server@latest/admin/managing-accounts-and-repositories/managing-roles-in-your-enterprise/abilities-of-roles) If the reader manages an enterprise account, and you're describing the people's accounts that they manage, use "user account." This applies to the following products. @@ -1639,9 +1639,9 @@ If the reader manages an enterprise account, and you're describing the people's The following documentation should reference "user accounts." * The [AUTOTITLE](/enterprise-cloud@latest/admin) product -* Enterprise-specific billing documentation, like [AUTOTITLE](/enterprise-cloud@latest/billing/managing-your-github-billing-settings/about-billing-for-your-enterprise) -* Content within other products that's intended for an administrative audience, like [AUTOTITLE](/enterprise-cloud@latest/code-security/supply-chain-security/end-to-end-supply-chain/securing-accounts) in the "Secure coding" product or [AUTOTITLE](/enterprise-cloud@latest/admin/overview/setting-up-a-trial-of-github-enterprise-cloud) in the "Get started" product -* Enterprise-specific API content, like the [AUTOTITLE](/enterprise-cloud@latest/rest/reference/enterprise-admin) REST API reference documentation +* Enterprise-specific billing documentation, like [AUTOTITLE](/enterprise-cloud@latest/billing/concepts/enterprise-billing/billing-for-enterprises) +* Content within other products that's intended for an administrative audience, like [AUTOTITLE](/enterprise-cloud@latest/code-security/tutorials/implement-supply-chain-best-practices/securing-accounts) in the "Secure coding" product or [AUTOTITLE](/enterprise-cloud@latest/admin/overview/setting-up-a-trial-of-github-enterprise-cloud) in the "Get started" product +* Enterprise-specific API content, like the [AUTOTITLE](/enterprise-cloud@latest/rest/enterprise-admin) REST API reference documentation For enterprises on {% data variables.product.prodname_ghe_cloud %} that don't use {% data variables.product.prodname_emus %}, use "personal account" when describing members of organizations owned by the enterprise. diff --git a/content/contributing/style-guide-and-content-model/troubleshooting-content-type.md b/content/contributing/style-guide-and-content-model/troubleshooting-content-type.md index 7f0938e87369..c0b92c0df741 100644 --- a/content/contributing/style-guide-and-content-model/troubleshooting-content-type.md +++ b/content/contributing/style-guide-and-content-model/troubleshooting-content-type.md @@ -43,6 +43,6 @@ Use known issues to explain the following situations. ## Examples of troubleshooting content * [AUTOTITLE](/authentication/troubleshooting-ssh) -* [AUTOTITLE](/enterprise-server@latest/admin/configuration/configuring-network-settings/using-github-enterprise-server-with-a-load-balancer#troubleshooting-connectivity-through-a-load-balancer) +* [AUTOTITLE](/enterprise-server@latest/admin/configuring-settings/configuring-network-settings/using-github-enterprise-server-with-a-load-balancer#troubleshooting-connectivity-through-a-load-balancer) * [Known issues](/enterprise-server@3.7/admin/release-notes#3.7.8-known-issues) in the {% data variables.product.prodname_ghe_server %} release notes * [AUTOTITLE](/authentication/troubleshooting-ssh/error-were-doing-an-ssh-key-audit) diff --git a/content/contributing/style-guide-and-content-model/tutorial-content-type.md b/content/contributing/style-guide-and-content-model/tutorial-content-type.md index 390e2e094d0c..6fc315881073 100644 --- a/content/contributing/style-guide-and-content-model/tutorial-content-type.md +++ b/content/contributing/style-guide-and-content-model/tutorial-content-type.md @@ -53,10 +53,10 @@ Contents of tutorials: ## Examples of tutorials Tutorials: -* [AUTOTITLE](/actions/managing-issues-and-pull-requests/adding-labels-to-issues) -* [AUTOTITLE](/actions/deployment/deploying-xcode-applications/installing-an-apple-certificate-on-macos-runners-for-xcode-development) +* [AUTOTITLE](/actions/tutorials/manage-your-work/add-labels-to-issues) +* [AUTOTITLE](/actions/how-tos/deploy/deploy-to-third-party-platforms/sign-xcode-applications) Language and framework guides: -* [AUTOTITLE](/actions/automating-builds-and-tests/building-and-testing-nodejs) -* [AUTOTITLE](/actions/automating-builds-and-tests/building-and-testing-python) -* [AUTOTITLE](/actions/publishing-packages/publishing-java-packages-with-maven) +* [AUTOTITLE](/actions/tutorials/build-and-test-code/nodejs) +* [AUTOTITLE](/actions/tutorials/build-and-test-code/python) +* [AUTOTITLE](/actions/tutorials/publish-packages/publish-java-packages-with-maven) diff --git a/content/contributing/writing-for-github-docs/best-practices-for-github-docs.md b/content/contributing/writing-for-github-docs/best-practices-for-github-docs.md index 4707b88524bc..f9fb1d61bb09 100644 --- a/content/contributing/writing-for-github-docs/best-practices-for-github-docs.md +++ b/content/contributing/writing-for-github-docs/best-practices-for-github-docs.md @@ -47,8 +47,8 @@ Before you begin, it’s important to understand who you’re writing for, what Determine which type of content you will write, based on the intended audience and the core purpose of the content. {% data variables.product.prodname_docs %} use the following content types: -* [AUTOTITLE](/contributing/style-guide-and-content-model/conceptual-content-type) -* [AUTOTITLE](/contributing/style-guide-and-content-model/referential-content-type) +* [AUTOTITLE](/contributing/style-guide-and-content-model/concepts-content-type) +* [AUTOTITLE](/contributing/style-guide-and-content-model/reference-content-type) * [AUTOTITLE](/contributing/style-guide-and-content-model/how-to-content-type) * [AUTOTITLE](/contributing/style-guide-and-content-model/troubleshooting-content-type) * [AUTOTITLE](/contributing/style-guide-and-content-model/quickstart-content-type) diff --git a/content/contributing/writing-for-github-docs/creating-diagrams-for-github-docs.md b/content/contributing/writing-for-github-docs/creating-diagrams-for-github-docs.md index 230389084736..6ccfe8e99e24 100644 --- a/content/contributing/writing-for-github-docs/creating-diagrams-for-github-docs.md +++ b/content/contributing/writing-for-github-docs/creating-diagrams-for-github-docs.md @@ -203,7 +203,7 @@ The preferred colors for diagrams in {% data variables.product.prodname_docs %} * File size of 250 KB or less * Descriptive file names, such as `merge-conflict-diagram.png` instead of `diagram-02.png` -If you need to create a diagram that is difficult to view at small resolutions, include a link to a larger version of the diagram in a relevant repository or other appropriate location. See [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/about-actions-runner-controller) for an example. +If you need to create a diagram that is difficult to view at small resolutions, include a link to a larger version of the diagram in a relevant repository or other appropriate location. See [AUTOTITLE](/actions/concepts/runners/actions-runner-controller) for an example. ## Tools for creating diagrams @@ -215,7 +215,7 @@ Diagrams must have proper contrast and alt text. If you use colors defined in the Primer Design System, your diagram should have proper contrast. To check contrast on other background colors, use the [Color Contrast Analyzer](https://www.tpgi.com/color-contrast-checker/). -Write alt text for a diagram that describes what the diagram looks like and why it is included in the article. Do not try to explain everything the diagram conveys in the alt text since it could become too long to be useful. For more information on writing alt text, see [AUTOTITLE](/contributing/writing-for-github-docs/style-guide#alt-text). +Write alt text for a diagram that describes what the diagram looks like and why it is included in the article. Do not try to explain everything the diagram conveys in the alt text since it could become too long to be useful. For more information on writing alt text, see [AUTOTITLE](/contributing/style-guide-and-content-model/style-guide#alt-text). All information in diagrams must be also conveyed in text accompanying the diagrams. diff --git a/content/contributing/writing-for-github-docs/creating-screenshots.md b/content/contributing/writing-for-github-docs/creating-screenshots.md index b86d017f3d90..b3d0e8235182 100644 --- a/content/contributing/writing-for-github-docs/creating-screenshots.md +++ b/content/contributing/writing-for-github-docs/creating-screenshots.md @@ -114,7 +114,7 @@ To meet the needs of more users, screenshots must: * Show a UI element with just enough surrounding context to help people know where to find the element on their screen. * Reduce negative space by resizing your browser window until optimal. * Show interfaces in light theme wherever possible. - * For {% data variables.product.prodname_dotcom %}, select "Light default" in your appearance settings. For more information, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-your-theme-settings). + * For {% data variables.product.prodname_dotcom %}, select "Light default" in your appearance settings. For more information, see [AUTOTITLE](/get-started/accessibility/managing-your-theme-settings). * For VSCode, select "GitHub light default" in the free [GitHub Theme](https://marketplace.visualstudio.com/items?itemName=GitHub.github-vscode-theme) extension. * If the software you need to screenshot is available in dark mode only, it's fine to use dark mode. * If your username and avatar appear, replace them with @octocat's username and [avatar](https://avatars.githubusercontent.com/u/583231?v=4). Use the developer tools in your browser to replace your username with `@octocat` and to replace the URL of your avatar with `https://avatars.githubusercontent.com/u/583231?v=4`. diff --git a/content/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs.md b/content/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs.md index 739a52e112aa..4572b8c2d9b0 100644 --- a/content/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs.md +++ b/content/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs.md @@ -114,7 +114,7 @@ const copyMe = true Code sample annotations help explain longer code examples by rendering comments as annotations next to the sample code. This lets us write longer explanations of code without cluttering the code itself. Code samples with annotations are rendered in a two pane layout with the code sample on the left and the annotations on the right. The annotations are visually emphasized when someone hovers their cursor over the code example. -Code annotations only work in articles with the `layout: inline` frontmatter property. For more information on how to write and style code annotations, see [AUTOTITLE](/contributing/syntax-and-versioning-for-github-docs/annotating-code-examples). +Code annotations only work in articles with the `layout: inline` frontmatter property. For more information on how to write and style code annotations, see [AUTOTITLE](/contributing/writing-for-github-docs/annotating-code-examples). ### Example of an annotated code sample @@ -200,7 +200,7 @@ Improve the variable names in this function ``` ```` -There are many examples of prompt blocks with context in the {% data variables.product.prodname_copilot_short %} Cookbook. For example, see [AUTOTITLE](/free-pro-team@latest/copilot/tutorials/copilot-chat-cookbook/refactor-code/improve-code-readability). +There are many examples of prompt blocks with context in the {% data variables.product.prodname_copilot_short %} Cookbook. For example, see [AUTOTITLE](/free-pro-team@latest/copilot/tutorials/copilot-cookbook/refactor-code/improve-code-readability). ### Inline prompts @@ -267,7 +267,7 @@ These instructions are pertinent to Windows users. {% endwindows %}{% endraw %} ``` -You can define a default platform in an article's YAML frontmatter. For more information, see [AUTOTITLE](/contributing/syntax-and-versioning-for-github-docs/using-yaml-frontmatter#defaultplatform). +You can define a default platform in an article's YAML frontmatter. For more information, see [AUTOTITLE](/contributing/writing-for-github-docs/using-yaml-frontmatter#defaultplatform). ## Tool tags @@ -275,9 +275,9 @@ We occasionally need to write documentation that has different instructions for {% data variables.product.prodname_docs %} maintains tool tags for {% data variables.product.prodname_dotcom %} products and selected third-party extensions. See the [`all-tools.ts`](https://github.com/github/docs/blob/main/src/tools/lib/all-tools.ts) object in the `github/docs` repository for a list of all supported tools. -On rare occasions, we will add new tools. Before adding a new tool, read [AUTOTITLE](/contributing/syntax-and-versioning-for-github-docs/creating-tool-switchers-in-articles). To add a new tool, add an entry to the `allTools` object in [`lib/all-tools.ts`](https://github.com/github/docs/blob/main/src/tools/lib/all-tools.ts) as a key-value pair. The key is the tag you'll use to refer to the tool in the article, and the value is how the tool will be identified on the tool picker at the top of the article. +On rare occasions, we will add new tools. Before adding a new tool, read [AUTOTITLE](/contributing/writing-for-github-docs/creating-tool-switchers-in-articles). To add a new tool, add an entry to the `allTools` object in [`lib/all-tools.ts`](https://github.com/github/docs/blob/main/src/tools/lib/all-tools.ts) as a key-value pair. The key is the tag you'll use to refer to the tool in the article, and the value is how the tool will be identified on the tool picker at the top of the article. -You can define a default tool for an article in the YAML frontmatter. For more information, see [AUTOTITLE](/contributing/syntax-and-versioning-for-github-docs/using-yaml-frontmatter#defaulttool). +You can define a default tool for an article in the YAML frontmatter. For more information, see [AUTOTITLE](/contributing/writing-for-github-docs/using-yaml-frontmatter#defaulttool). ### Example usage of tool tags @@ -436,7 +436,7 @@ If this happens, add the following CSS style to the `
` HTML tag:
``` -For a current example of this usage, see [AUTOTITLE](/actions/examples). +For a current example of this usage, see [AUTOTITLE](/actions/tutorials/manage-your-work). ## Links @@ -468,7 +468,7 @@ For more information about links, see [AUTOTITLE](/contributing/style-guide-and- ### Permalinks -Because the site is dynamic, it does not build HTML files for each different version of an article. Instead it generates a "permalink" for every version of the article. It does this based on the article's [`versions` frontmatter](/contributing/syntax-and-versioning-for-github-docs/using-yaml-frontmatter#versions). +Because the site is dynamic, it does not build HTML files for each different version of an article. Instead it generates a "permalink" for every version of the article. It does this based on the article's [`versions` frontmatter](/contributing/writing-for-github-docs/using-yaml-frontmatter#versions). > [!NOTE] > As of early 2021, the `free-pro-team@latest` version is not included in URLs. A helper function called `lib/remove-fpt-from-path.ts` removes the version from URLs. diff --git a/content/contributing/writing-for-github-docs/using-yaml-frontmatter.md b/content/contributing/writing-for-github-docs/using-yaml-frontmatter.md index 12bb95fdc026..99df0bf7f367 100644 --- a/content/contributing/writing-for-github-docs/using-yaml-frontmatter.md +++ b/content/contributing/writing-for-github-docs/using-yaml-frontmatter.md @@ -48,7 +48,7 @@ For more information, see [`lib/frontmatter.ts`](https://github.com/github/docs/ ### `versions` * Purpose: Indicates the [versions](https://github.com/github/docs/blob/main/src/versions/lib/all-versions.ts) to which a page applies. -For more information about the different types of versioning, see [Versioning documentation](/contributing/syntax-and-versioning-for-github-docs/versioning-documentation). + For more information about the different types of versioning, see [Versioning documentation](/contributing/writing-for-github-docs/versioning-documentation). * Type: `Object`. Allowable keys map to product names and can be found in the `versions` object in [`lib/frontmatter.ts`](https://github.com/github/docs/blob/main/src/frame/lib/frontmatter.ts). * This frontmatter value is currently **required** for all pages. * The `*` is used to denote all releases for the version. @@ -97,7 +97,7 @@ redirect_from: - /articles/getting-started-with-github-for-windows ``` -For more information, see [AUTOTITLE](/contributing/syntax-and-versioning-for-github-docs/configuring-redirects). +For more information, see [AUTOTITLE](/contributing/writing-for-github-docs/configuring-redirects). ### `title` @@ -216,7 +216,7 @@ defaultPlatform: linux ### `defaultTool` -* Purpose: Override the initial tool selection for a page, where the tool refers to the application the reader is using to work with GitHub (such as GitHub.com's web UI, the GitHub CLI, or GitHub Desktop) or the GitHub APIs. For more information about the tool selector, see [AUTOTITLE](/contributing/syntax-and-versioning-for-github-docs/using-markdown-and-liquid-in-github-docs#tool-tags). If this frontmatter is omitted, then the tool-specific content matching the GitHub web UI is shown by default. If a user has indicated a tool preference (by clicking on a tool tab), then the user's preference will be applied instead of the default value. +* Purpose: Override the initial tool selection for a page, where the tool refers to the application the reader is using to work with GitHub (such as GitHub.com's web UI, the GitHub CLI, or GitHub Desktop) or the GitHub APIs. For more information about the tool selector, see [AUTOTITLE](/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs#tool-tags). If this frontmatter is omitted, then the tool-specific content matching the GitHub web UI is shown by default. If a user has indicated a tool preference (by clicking on a tool tab), then the user's preference will be applied instead of the default value. * Type: `String`, one of: `webui`, `cli`, `desktop`, `curl`, `codespaces`, `vscode`, `importer_cli`, `graphql`, `powershell`, `bash`, `javascript`. * Optional. From bcdb097644d5e432dcd448bb1bc56c8259dc7298 Mon Sep 17 00:00:00 2001 From: Sarah Schneider Date: Thu, 9 Jul 2026 13:15:31 -0400 Subject: [PATCH 07/15] Update GHES release note scripts (#62205) --- .github/workflows/notify-release-pms.yml | 12 + .../scripts/check-release-approvals.ts | 269 ------------------ .../scripts/notify-release-pms.ts | 58 ++-- src/ghes-releases/tests/notify-release-pms.ts | 18 +- 4 files changed, 41 insertions(+), 316 deletions(-) delete mode 100644 src/ghes-releases/scripts/check-release-approvals.ts diff --git a/.github/workflows/notify-release-pms.yml b/.github/workflows/notify-release-pms.yml index 2e6fa9972363..4dc122f42e47 100644 --- a/.github/workflows/notify-release-pms.yml +++ b/.github/workflows/notify-release-pms.yml @@ -36,6 +36,7 @@ on: permissions: contents: read + pull-requests: read jobs: notify: @@ -43,8 +44,19 @@ jobs: if: github.repository == 'github/docs-internal' runs-on: ubuntu-latest steps: + - name: Get PR head branch + id: pr-ref + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + PR_NUMBER: ${{ inputs.pr }} + run: | + ref=$(gh pr view "$PR_NUMBER" --repo github/docs-internal --json headRefName --jq '.headRefName') + echo "ref=$ref" >> "$GITHUB_OUTPUT" + - name: Checkout repository code uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 + with: + ref: ${{ steps.pr-ref.outputs.ref }} - uses: ./.github/actions/node-npm-setup diff --git a/src/ghes-releases/scripts/check-release-approvals.ts b/src/ghes-releases/scripts/check-release-approvals.ts deleted file mode 100644 index a4092c3b41ea..000000000000 --- a/src/ghes-releases/scripts/check-release-approvals.ts +++ /dev/null @@ -1,269 +0,0 @@ -/** - * @purpose Writer tool - * @description Check PM approval status for GHES release notes - * - * Scans release issues that were previously notified by `notify-release-pms` - * and checks for 🚀 reactions on the notification comments. - * - * Usage: - * npm run check-release-approvals -- --release 3.20 [--rc|--ga] - */ -import { Command } from 'commander' -import { execFileSync } from 'child_process' -import fs from 'fs' -import path from 'path' -import ora from 'ora' - -import { buildMarker } from '@/ghes-releases/scripts/notify-release-pms' - -// ─── Types ─────────────────────────────────────────────────────────────────── - -interface ApprovalStatus { - issueNumber: number - issueUrl: string - commentId: number | null - approved: boolean - rocketCount: number - rocketUsers: string[] - hasReplies: boolean -} - -// ─── Helpers ───────────────────────────────────────────────────────────────── - -/** - * Run `gh` CLI commands with native auth (no GITHUB_TOKEN interference) - */ -function gh(args: string[]): string { - const env = { ...process.env } - delete env.GITHUB_TOKEN - return execFileSync('gh', args, { - encoding: 'utf8', - stdio: ['pipe', 'pipe', 'pipe'], - env, - maxBuffer: 10 * 1024 * 1024, - }) -} - -/** - * Extract unique release issue numbers from a YAML file's source comments. - */ -function extractIssueNumbers(yamlPath: string): number[] { - const content = fs.readFileSync(yamlPath, 'utf8') - const numbers = new Set() - const regex = /^\s*#\s*https:\/\/github\.com\/github\/releases\/issues\/(\d+)/gm - let match - while ((match = regex.exec(content)) !== null) { - numbers.add(parseInt(match[1], 10)) - } - return [...numbers] -} - -/** - * Find our notification comment on an issue and check its reactions. - */ -function checkIssueApproval(issueNumber: number, marker: string): ApprovalStatus { - const issueUrl = `https://github.com/github/releases/issues/${issueNumber}` - const result: ApprovalStatus = { - issueNumber, - issueUrl, - commentId: null, - approved: false, - rocketCount: 0, - rocketUsers: [], - hasReplies: false, - } - - try { - // Fetch all comments on the issue - const commentsJson = gh([ - 'api', - `repos/github/releases/issues/${issueNumber}/comments`, - '--paginate', - ]) - const comments = JSON.parse(commentsJson) as Array<{ - id: number - body: string - created_at: string - }> - - // Find our notification comment (use findLast so re-runs pick up the latest) - const ourComment = comments.findLast((c) => c.body.includes(marker)) - if (!ourComment) { - return result - } - - result.commentId = ourComment.id - - // Check if there are replies after our comment (indicating feedback) - const ourCommentTime = new Date(ourComment.created_at).getTime() - result.hasReplies = comments.some( - (c) => c.id !== ourComment.id && new Date(c.created_at).getTime() > ourCommentTime, - ) - - // Fetch reactions on our comment - const reactionsJson = gh([ - 'api', - `repos/github/releases/issues/comments/${ourComment.id}/reactions`, - '--paginate', - ]) - const reactions = JSON.parse(reactionsJson) as Array<{ - content: string - user: { login: string } - }> - - const rockets = reactions.filter((r) => r.content === 'rocket') - result.rocketCount = rockets.length - result.rocketUsers = rockets.map((r) => r.user.login) - result.approved = rockets.length > 0 - } catch { - // API error — leave as unapproved - } - - return result -} - -// ─── CLI ───────────────────────────────────────────────────────────────────── - -const program = new Command() - -program - .name('check-release-approvals') - .description('Check PM approval status for generated GHES release notes') - .requiredOption('-r, --release ', 'GHES release number (e.g., 3.20)') - .option('--rc', 'Check the release candidate file') - .option('--ga', 'Check the GA release file') - .option('--json', 'Output results as JSON') - .action((options: { release: string; rc?: boolean; ga?: boolean; json?: boolean }) => { - const { release } = options - const spinner = ora() - - // Validate release version format - if (!/^\d+\.\d+$/.test(release)) { - console.error( - `Error: Invalid release version format "${release}". Expected: X.Y (e.g., 3.20)`, - ) - process.exit(1) - } - - // Determine which file to check - const dirName = release.replace('.', '-') - const rcPath = path.join( - process.cwd(), - 'data/release-notes/enterprise-server', - dirName, - '0-rc1.yml', - ) - const gaPath = path.join( - process.cwd(), - 'data/release-notes/enterprise-server', - dirName, - '0.yml', - ) - - let yamlPath: string - if (options.rc) { - yamlPath = rcPath - } else if (options.ga) { - yamlPath = gaPath - } else { - // Auto-detect: prefer GA if it exists, otherwise RC (consistent with generate-release-notes) - if (fs.existsSync(gaPath)) { - yamlPath = gaPath - } else if (fs.existsSync(rcPath)) { - yamlPath = rcPath - } else { - console.error(`Error: No release notes file found for ${release}.`) - process.exit(1) - } - } - - if (!fs.existsSync(yamlPath)) { - console.error(`Error: File not found: ${yamlPath}`) - process.exit(1) - } - - const relativeFilePath = path.relative(process.cwd(), yamlPath) - - // ── Step 1: Extract issue numbers ── - spinner.start('Parsing release notes file...') - const issueNumbers = extractIssueNumbers(yamlPath) - spinner.succeed(`Found ${issueNumbers.length} release issue(s) in ${relativeFilePath}`) - - if (issueNumbers.length === 0) { - console.log('No release issues found.') - process.exit(0) - } - - // ── Step 2: Check each issue ── - const isRc = yamlPath === rcPath - const releaseType = isRc ? 'rc' : 'ga' - const marker = buildMarker(release, releaseType) - const statuses: ApprovalStatus[] = [] - - for (let i = 0; i < issueNumbers.length; i++) { - const issueNumber = issueNumbers[i] - spinner.start(`[${i + 1}/${issueNumbers.length}] Checking #${issueNumber}...`) - const status = checkIssueApproval(issueNumber, marker) - statuses.push(status) - spinner.succeed( - `[${i + 1}/${issueNumbers.length}] #${issueNumber} — ${ - status.commentId === null - ? '⚪ Not notified' - : status.approved - ? `🚀 Approved (${status.rocketUsers.join(', ')})` - : status.hasReplies - ? '💬 Has replies (pending)' - : '⏳ Pending' - }`, - ) - } - - // ── Step 3: Output results ── - if (options.json) { - console.log(JSON.stringify(statuses, null, 2)) - return - } - - // Summary table - const approved = statuses.filter((s) => s.approved) - const pending = statuses.filter((s) => s.commentId !== null && !s.approved) - const notNotified = statuses.filter((s) => s.commentId === null) - const withReplies = pending.filter((s) => s.hasReplies) - - console.log(`\n${'═'.repeat(60)}`) - console.log(`GHES ${release} Release Note Approval Status`) - console.log(`${'═'.repeat(60)}`) - console.log(` 🚀 Approved: ${approved.length}/${statuses.length}`) - if (pending.length > 0) { - console.log(` ⏳ Pending: ${pending.length}`) - } - if (withReplies.length > 0) { - console.log(` 💬 Has replies: ${withReplies.length} (may have feedback)`) - } - if (notNotified.length > 0) { - console.log(` ⚪ Not notified: ${notNotified.length}`) - } - - // List pending issues for easy follow-up - if (pending.length > 0) { - console.log(`\nPending review:`) - for (const s of pending) { - const suffix = s.hasReplies ? ' 💬' : '' - console.log(` #${s.issueNumber} — ${s.issueUrl}${suffix}`) - } - } - - if (notNotified.length > 0) { - console.log(`\nNot yet notified (run notify-release-pms first):`) - for (const s of notNotified) { - console.log(` #${s.issueNumber} — ${s.issueUrl}`) - } - } - - // Exit code: 0 if all approved, 1 if any pending - if (approved.length < statuses.length) { - process.exit(1) - } - }) - -program.parse(process.argv) diff --git a/src/ghes-releases/scripts/notify-release-pms.ts b/src/ghes-releases/scripts/notify-release-pms.ts index f668bffa8c77..446de67a46af 100644 --- a/src/ghes-releases/scripts/notify-release-pms.ts +++ b/src/ghes-releases/scripts/notify-release-pms.ts @@ -113,19 +113,6 @@ function extractSourceNotes(yamlPath: string): SourceNote[] { return parseSourceNotes(content) } -/** - * Calculate the next weekday (Mon–Fri) at least `days` calendar days from now. - * If the resulting date lands on a weekend, it rolls forward to Monday. - */ -function getReviewDeadline(days: number): string { - const date = new Date() - date.setDate(date.getDate() + days) - const day = date.getDay() - if (day === 0) date.setDate(date.getDate() + 1) // Sunday → Monday - if (day === 6) date.setDate(date.getDate() + 2) // Saturday → Monday - return date.toLocaleDateString('en-US', { month: 'long', day: 'numeric', year: 'numeric' }) -} - /** * Build the comment body for a release issue notification. */ @@ -133,43 +120,30 @@ export function buildCommentBody( version: string, rc: boolean, prNumber: number, - relativeFilePath: string, - reviewDate?: string, + assignees: string[], ): string { const releaseType = rc ? 'RC' : 'GA' const prUrl = `https://github.com/github/docs-internal/pull/${prNumber}` const fileUrl = `${prUrl}/files` - const deadline = reviewDate - ? new Date(`${reviewDate}T00:00:00`).toLocaleDateString('en-US', { - month: 'long', - day: 'numeric', - year: 'numeric', - }) - : getReviewDeadline(10) - - // Use a marker so we can identify our comments later (for check-release-approvals). + + // Use a marker so we can identify our comments later (for duplicate-prevention). // Include releaseType so RC and GA comments are distinguishable. const marker = buildMarker(version, releaseType.toLowerCase() as 'rc' | 'ga') + const mentions = assignees.length > 0 ? `${assignees.map((a) => `@${a}`).join(' ')} ` : '' + return `${marker} ### GHES ${version} ${releaseType} release note review -Hello! A release note has been created for this feature by the Docs team assisted by Copilot. If you'd like to review it: - -1. [**Review the note in the PR**](${fileUrl}) (search for this issue's URL within \`${relativeFilePath}\`) -2. If the note looks good, **react to this comment with 🚀**. -3. If it needs changes, suggest edits directly in the PR, then **react with 🚀** to this comment when you're done. +👋 ${mentions}A Copilot-generated release note has been added in [docs-internal PR #${prNumber}](${fileUrl}). -We ask that you submit any changes by **${deadline}** to help ensure timely release notes. +You're welcome to edit it in the PR. If you do nothing, the note will be published after review from a Docs team member. -The 🚀 tells us you've completed your review. If we don't hear from you, we'll go ahead with this note. - -If you think this issue should **not** have a release note, please let us know in [#docs-ghes-releases](https://github-grid.enterprise.slack.com/archives/C0AQ37XBK7D).` +Any questions, ask in [#docs-ghes-releases](https://github-grid.enterprise.slack.com/archives/C0AQ37XBK7D).` } /** * Build the marker string used to identify notification comments. - * Must stay in sync with check-release-approvals. */ export function buildMarker(version: string, releaseType: 'rc' | 'ga'): string { return `` @@ -339,7 +313,21 @@ program for (let i = 0; i < toNotify.length; i++) { const note = toNotify[i] - const commentBody = buildCommentBody(release, rc, prNumber, relativeFilePath, reviewDate) + // Fetch assignees (or fall back to issue author) for the release issue + let assignees: string[] = [] + try { + const raw = ghRead(['api', `repos/github/releases/issues/${note.issueNumber}`]) + const issue = JSON.parse(raw) + assignees = (issue.assignees || []).map((a: { login: string }) => a.login) + // Fall back to the issue author unless they're a bot + if (assignees.length === 0 && issue.user?.login && issue.user.type !== 'Bot') { + assignees = [issue.user.login] + } + } catch { + // If we can't fetch the issue, post without mentions + } + + const commentBody = buildCommentBody(release, rc, prNumber, assignees) const label = `[${i + 1}/${toNotify.length}] #${note.issueNumber}` diff --git a/src/ghes-releases/tests/notify-release-pms.ts b/src/ghes-releases/tests/notify-release-pms.ts index cc7a8d1d0112..affefe38c49d 100644 --- a/src/ghes-releases/tests/notify-release-pms.ts +++ b/src/ghes-releases/tests/notify-release-pms.ts @@ -87,26 +87,20 @@ describe('buildMarker', () => { describe('buildCommentBody', () => { test('includes the marker in the comment body', () => { - const body = buildCommentBody( - '3.21', - true, - 100, - 'data/release-notes/enterprise-server/3-21/0-rc1.yml', - '2026-05-01', - ) + const body = buildCommentBody('3.21', true, 100, ['octocat']) const marker = buildMarker('3.21', 'rc') expect(body).toContain(marker) }) test('RC and GA comments have different markers', () => { - const rcBody = buildCommentBody('3.21', true, 100, 'file.yml', '2026-05-01') - const gaBody = buildCommentBody('3.21', false, 100, 'file.yml', '2026-05-01') + const rcBody = buildCommentBody('3.21', true, 100, ['octocat']) + const gaBody = buildCommentBody('3.21', false, 100, ['octocat']) expect(rcBody).toContain('3.21-rc') expect(gaBody).toContain('3.21-ga') }) test('includes the PR files link', () => { - const body = buildCommentBody('3.21', true, 12345, 'file.yml', '2026-05-01') + const body = buildCommentBody('3.21', true, 12345, ['octocat']) expect(body).toContain('https://github.com/github/docs-internal/pull/12345/files') }) }) @@ -145,7 +139,7 @@ describe('duplicate-prevention filtering', () => { test('marker is detected within a comment body', () => { const marker = buildMarker('3.21', 'rc') - const commentBody = buildCommentBody('3.21', true, 100, 'file.yml', '2026-05-01') + const commentBody = buildCommentBody('3.21', true, 100, ['octocat']) // Simulates the duplicate-check logic: comments.includes(marker) expect(commentBody.includes(marker)).toBe(true) @@ -153,7 +147,7 @@ describe('duplicate-prevention filtering', () => { test('GA marker is not detected in an RC comment', () => { const gaMarker = buildMarker('3.21', 'ga') - const rcCommentBody = buildCommentBody('3.21', true, 100, 'file.yml', '2026-05-01') + const rcCommentBody = buildCommentBody('3.21', true, 100, ['octocat']) expect(rcCommentBody.includes(gaMarker)).toBe(false) }) From ca521508ca420ea5fff1c52a927fd0f6ee5aff65 Mon Sep 17 00:00:00 2001 From: Sunbrye Ly <56200261+sunbrye@users.noreply.github.com> Date: Thu, 9 Jul 2026 11:28:52 -0700 Subject: [PATCH 08/15] Tented model 0036: GPT-5.6 Sol, Terra, and Luna (#62199) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../reference/ai-models/model-hosting.md | 3 + .../reference/ai-models/supported-models.md | 6 ++ .../copilot-cloud-agent-non-auto-models.md | 3 + data/tables/copilot/model-comparison.yml | 21 ++++++- data/tables/copilot/model-release-status.yml | 12 ++++ .../copilot/model-supported-clients.yml | 27 +++++++++ data/tables/copilot/model-supported-plans.yml | 21 +++++++ data/tables/copilot/models-and-pricing.yml | 60 +++++++++++++++++++ data/variables/copilot.yml | 3 + 9 files changed, 153 insertions(+), 3 deletions(-) diff --git a/content/copilot/reference/ai-models/model-hosting.md b/content/copilot/reference/ai-models/model-hosting.md index 46dcb5a598f1..1f448ea09635 100644 --- a/content/copilot/reference/ai-models/model-hosting.md +++ b/content/copilot/reference/ai-models/model-hosting.md @@ -26,6 +26,9 @@ Used for: * {% data variables.copilot.copilot_gpt_54_mini %} * {% data variables.copilot.copilot_gpt_54_nano %} * {% data variables.copilot.copilot_gpt_55 %} +* {% data variables.copilot.copilot_gpt_56_luna %} +* {% data variables.copilot.copilot_gpt_56_sol %} +* {% data variables.copilot.copilot_gpt_56_terra %} These models are hosted by OpenAI and {% data variables.product.github %}'s Azure infrastructure. diff --git a/content/copilot/reference/ai-models/supported-models.md b/content/copilot/reference/ai-models/supported-models.md index 7d776333fce1..6f8a713cbf04 100644 --- a/content/copilot/reference/ai-models/supported-models.md +++ b/content/copilot/reference/ai-models/supported-models.md @@ -87,6 +87,9 @@ Choosing a larger context window or higher reasoning will impact {% data variabl | {% data variables.copilot.copilot_gpt_53_codex %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | | {% data variables.copilot.copilot_gpt_54 %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | | {% data variables.copilot.copilot_gpt_55 %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | +| {% data variables.copilot.copilot_gpt_56_luna %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | +| {% data variables.copilot.copilot_gpt_56_sol %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | +| {% data variables.copilot.copilot_gpt_56_terra %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% endrowheaders %} @@ -137,6 +140,9 @@ Some {% data variables.product.prodname_copilot_short %} models require minimum | {% data variables.copilot.copilot_gpt_54 %} | `v1.104.1` and later | `17.14.19` and later | `1.5.66` and later | `0.47.0` and later | `0.15.0` and later | | {% data variables.copilot.copilot_gpt_54_mini %} | `v1.104.1` and later | `17.14.19` and later | `1.5.66` and later | `0.47.0` and later | `0.15.0` and later | | {% data variables.copilot.copilot_gpt_55 %} | `v1.117` and later | `17.14.19` and later | `1.5.66` and later | `0.47.0` and later | `0.15.0` and later | +| {% data variables.copilot.copilot_gpt_56_luna %} | `1.128.0` | TBD | TBD | TBD | TBD | +| {% data variables.copilot.copilot_gpt_56_sol %} | `1.128.0` | TBD | TBD | TBD | TBD | +| {% data variables.copilot.copilot_gpt_56_terra %} | `1.128.0` | TBD | TBD | TBD | TBD | | {% data variables.copilot.copilot_claude_opus_48 %} | `v1.118` and later | `17.14.6` and later | TBD | TBD | TBD | | {% data variables.copilot.copilot_claude_sonnet_5 %} | `v1.124` and later | `17.14.6` and later | TBD | TBD | TBD | | {% data variables.copilot.copilot_claude_fable_5 %} | `v1.124` and later | `17.14.6` and later | TBD | TBD | TBD | diff --git a/data/reusables/copilot/copilot-cloud-agent-non-auto-models.md b/data/reusables/copilot/copilot-cloud-agent-non-auto-models.md index 7b9e6f6732cf..5e4197ff227b 100644 --- a/data/reusables/copilot/copilot-cloud-agent-non-auto-models.md +++ b/data/reusables/copilot/copilot-cloud-agent-non-auto-models.md @@ -3,4 +3,7 @@ * {% data variables.copilot.copilot_gemini_31_pro %} * {% data variables.copilot.copilot_gemini_35_flash %} * {% data variables.copilot.copilot_gpt_54_mini %} +* {% data variables.copilot.copilot_gpt_56_luna %} +* {% data variables.copilot.copilot_gpt_56_sol %} +* {% data variables.copilot.copilot_gpt_56_terra %} * {% data variables.copilot.copilot_mai_code_1_flash %} diff --git a/data/tables/copilot/model-comparison.yml b/data/tables/copilot/model-comparison.yml index 62124128e55e..119d861b8808 100644 --- a/data/tables/copilot/model-comparison.yml +++ b/data/tables/copilot/model-comparison.yml @@ -32,6 +32,21 @@ excels_at: Multi-step problem solving and architecture-level code analysis further_reading: '[GPT-5.5 model card](https://deploymentsafety.openai.com/gpt-5-5/gpt-5-5.pdf)' +- name: GPT-5.6 Luna + task_area: Fast help with simple or repetitive tasks + excels_at: Quick, cost-efficient responses for smaller, faster coding tasks + further_reading: 'Not available' + +- name: GPT-5.6 Sol + task_area: Deep reasoning and debugging + excels_at: Complex reasoning over large codebases and long-running agentic work + further_reading: 'Not available' + +- name: GPT-5.6 Terra + task_area: General-purpose coding and agent tasks + excels_at: Balanced everyday interactive and agentic coding + further_reading: 'Not available' + # Anthropic - name: Claude Fable 5 task_area: Long-horizon, autonomous coding and knowledge-work @@ -51,12 +66,12 @@ - name: Claude Opus 4.8 task_area: Deep reasoning and debugging excels_at: Complex problem-solving challenges, sophisticated reasoning - further_reading: 'Not available' + further_reading: '[Claude Opus 4.8 model card](https://www-cdn.anthropic.com/0b4915911bb0d19eca5b5ee635c80fef830a37ea.pdf)' - name: Claude Opus 4.8 (fast mode) (preview) task_area: Deep reasoning and debugging excels_at: Complex problem-solving challenges, sophisticated reasoning - further_reading: 'Not available' + further_reading: '[Claude Opus 4.8 model card](https://www-cdn.anthropic.com/0b4915911bb0d19eca5b5ee635c80fef830a37ea.pdf)' - name: Claude Sonnet 4.5 task_area: General-purpose coding and agent tasks @@ -71,7 +86,7 @@ - name: Claude Sonnet 5 task_area: General-purpose coding and agent tasks excels_at: Complex problem-solving challenges, sophisticated reasoning - further_reading: 'Not available' + further_reading: '[Claude Sonnet 5 model card](https://www-cdn.anthropic.com/9e6a1044980d8c4ed85669faf9c2a8342e2e9f1e/Claude%20Sonnet%205%20System%20Card.pdf)' # Google - name: Gemini 2.5 Pro diff --git a/data/tables/copilot/model-release-status.yml b/data/tables/copilot/model-release-status.yml index cd2a185b5739..be46ccda434b 100644 --- a/data/tables/copilot/model-release-status.yml +++ b/data/tables/copilot/model-release-status.yml @@ -39,6 +39,18 @@ provider: 'OpenAI' release_status: 'GA' +- name: 'GPT-5.6 Luna' + provider: 'OpenAI' + release_status: 'GA' + +- name: 'GPT-5.6 Sol' + provider: 'OpenAI' + release_status: 'GA' + +- name: 'GPT-5.6 Terra' + provider: 'OpenAI' + release_status: 'GA' + # Anthropic models - name: 'Claude Fable 5' diff --git a/data/tables/copilot/model-supported-clients.yml b/data/tables/copilot/model-supported-clients.yml index a8755d060b9e..a205ac36032f 100644 --- a/data/tables/copilot/model-supported-clients.yml +++ b/data/tables/copilot/model-supported-clients.yml @@ -203,6 +203,33 @@ xcode: true jetbrains: true +- name: GPT-5.6 Luna + dotcom: true + cli: true + vscode: true + vs: true + eclipse: false + xcode: false + jetbrains: false + +- name: GPT-5.6 Sol + dotcom: true + cli: true + vscode: true + vs: true + eclipse: false + xcode: false + jetbrains: false + +- name: GPT-5.6 Terra + dotcom: true + cli: true + vscode: true + vs: true + eclipse: false + xcode: false + jetbrains: false + - name: Kimi-K2.7-Code dotcom: true cli: true diff --git a/data/tables/copilot/model-supported-plans.yml b/data/tables/copilot/model-supported-plans.yml index 5ac9cb743af1..bafa9fa622b8 100644 --- a/data/tables/copilot/model-supported-plans.yml +++ b/data/tables/copilot/model-supported-plans.yml @@ -152,6 +152,27 @@ business: true enterprise: true +- name: GPT-5.6 Luna + pro: true + pro_plus: true + max: true + business: true + enterprise: true + +- name: GPT-5.6 Sol + pro: false + pro_plus: true + max: true + business: true + enterprise: true + +- name: GPT-5.6 Terra + pro: true + pro_plus: true + max: true + business: true + enterprise: true + - name: MAI-Code-1-Flash pro: true pro_plus: true diff --git a/data/tables/copilot/models-and-pricing.yml b/data/tables/copilot/models-and-pricing.yml index bd4f0c4d447d..59b7aeab368e 100644 --- a/data/tables/copilot/models-and-pricing.yml +++ b/data/tables/copilot/models-and-pricing.yml @@ -98,6 +98,66 @@ cached_input: $1.00 output: $45.00 +- model: GPT-5.6 Luna + provider: openai + release_status: GA + category: Lightweight + threshold: '≤ 200K' + tier: Default + input: $1.00 + cached_input: $0.10 + output: $6.00 + +- model: GPT-5.6 Luna + provider: openai + release_status: GA + category: Lightweight + threshold: '> 200K' + tier: 'Long context' + input: $2.00 + cached_input: $0.20 + output: $9.00 + +- model: GPT-5.6 Sol + provider: openai + release_status: GA + category: Powerful + threshold: '≤ 272K' + tier: Default + input: $5.00 + cached_input: $0.50 + output: $30.00 + +- model: GPT-5.6 Sol + provider: openai + release_status: GA + category: Powerful + threshold: '> 272K' + tier: 'Long context' + input: $10.00 + cached_input: $1.00 + output: $45.00 + +- model: GPT-5.6 Terra + provider: openai + release_status: GA + category: Versatile + threshold: '≤ 272K' + tier: Default + input: $2.50 + cached_input: $0.25 + output: $15.00 + +- model: GPT-5.6 Terra + provider: openai + release_status: GA + category: Versatile + threshold: '> 272K' + tier: 'Long context' + input: $5.00 + cached_input: $0.50 + output: $22.50 + # Anthropic - model: Claude Haiku 4.5 provider: anthropic diff --git a/data/variables/copilot.yml b/data/variables/copilot.yml index 805182602e31..8fafc44eff7c 100644 --- a/data/variables/copilot.yml +++ b/data/variables/copilot.yml @@ -229,6 +229,9 @@ copilot_gpt_54: 'GPT-5.4' copilot_gpt_54_mini: 'GPT-5.4 mini' copilot_gpt_54_nano: 'GPT-5.4 nano' copilot_gpt_55: 'GPT-5.5' +copilot_gpt_56_luna: 'GPT-5.6 Luna' +copilot_gpt_56_sol: 'GPT-5.6 Sol' +copilot_gpt_56_terra: 'GPT-5.6 Terra' # OpenAI 'o' series: copilot_o3: 'o3' copilot_o4_mini: 'o4-mini' From 04ae9e57a602a4791d057430e02eabafd14bf292 Mon Sep 17 00:00:00 2001 From: Kevin Heis Date: Thu, 9 Jul 2026 11:28:57 -0700 Subject: [PATCH 09/15] Update redirected internal links in copilot (tutorials) (#62165) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../tutorials/cloud-agent/build-guardrails.md | 8 +++--- .../cloud-agent/get-the-best-results.md | 16 +++++------ .../cloud-agent/give-access-to-resources.md | 2 +- .../cloud-agent/improve-a-project.md | 2 +- .../cloud-agent/pilot-cloud-agent.md | 6 ++-- .../copilot/tutorials/compare-ai-models.md | 6 ++-- .../copilot/tutorials/copilot-cli-hooks.md | 2 +- .../analyze-security/find-vulnerabilities.md | 4 +-- .../manage-dependency-updates.md | 4 +-- .../creating-diagrams.md | 2 +- .../generating-tables.md | 2 +- .../refactor-code/improve-code-readability.md | 2 +- .../refactor-code/translate-code.md | 2 +- .../accessibility-auditor.md | 2 +- .../github-actions-helper.md | 2 +- .../custom-instructions/testing-automation.md | 2 +- .../tutorials/customize-code-review.md | 4 +-- .../tutorials/enhance-agent-mode-with-mcp.md | 10 +++---- .../copilot/tutorials/explore-a-codebase.md | 2 +- .../explore-issues-and-discussions.md | 2 +- .../tutorials/explore-pull-requests.md | 2 +- .../copilot/tutorials/learn-a-new-language.md | 4 +-- .../copilot/tutorials/migrate-a-project.md | 6 ++-- .../tutorials/modernize-legacy-code.md | 2 +- .../tutorials/optimize-code-reviews.md | 2 +- .../tutorials/reduce-technical-debt.md | 8 +++--- .../tutorials/review-ai-generated-code.md | 16 +++++------ .../assign-licenses/remind-inactive-users.md | 16 +++++------ .../set-up-self-serve-licenses.md | 10 +++---- .../accelerate-pull-requests.md | 10 +++---- .../achieve-company-goals.md | 6 ++-- .../increase-test-coverage.md | 12 ++++---- .../reduce-security-debt.md | 6 ++-- .../enable-developers/drive-adoption.md | 28 +++++++++---------- .../govern-at-scale/govern-for-adoption.md | 2 +- .../maintain-codebase-standards.md | 8 +++--- .../tutorials/spark/build-apps-with-spark.md | 6 ++-- .../tutorials/spark/deploy-from-cli.md | 2 +- .../tutorials/spark/your-first-spark.md | 4 +-- .../tutorials/speed-up-development-work.md | 2 +- content/copilot/tutorials/use-an-ai-sme.md | 2 +- content/copilot/tutorials/vibe-coding.md | 2 +- content/copilot/tutorials/write-tests.md | 6 ++-- 43 files changed, 122 insertions(+), 122 deletions(-) diff --git a/content/copilot/tutorials/cloud-agent/build-guardrails.md b/content/copilot/tutorials/cloud-agent/build-guardrails.md index 6b6290c5026c..7a45219133c8 100644 --- a/content/copilot/tutorials/cloud-agent/build-guardrails.md +++ b/content/copilot/tutorials/cloud-agent/build-guardrails.md @@ -14,7 +14,7 @@ Before you enable {% data variables.copilot.copilot_cloud_agent %}, it is good p ## Learn about built-in protections -{% data variables.copilot.copilot_cloud_agent %} has a strong base of built-in security protections designed to protect against common risk points of AI agents. See [AUTOTITLE](/copilot/concepts/agents/coding-agent/risks-and-mitigations). +{% data variables.copilot.copilot_cloud_agent %} has a strong base of built-in security protections designed to protect against common risk points of AI agents. See [AUTOTITLE](/copilot/concepts/agents/cloud-agent/risks-and-mitigations). ## Plan policy settings @@ -22,8 +22,8 @@ Plan your policies for {% data variables.copilot.copilot_cloud_agent %} in advan Some questions to ask are: -* Which organizations and repositories will {% data variables.copilot.copilot_cloud_agent %} be enabled in? See [AUTOTITLE](/copilot/concepts/agents/coding-agent/access-management). -* Which MCP servers will you configure to give {% data variables.copilot.copilot_cloud_agent %} access to external tools? See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/extend-cloud-agent-with-mcp). +* Which organizations and repositories will {% data variables.copilot.copilot_cloud_agent %} be enabled in? See [AUTOTITLE](/copilot/concepts/agents/cloud-agent/access-management). +* Which MCP servers will you configure to give {% data variables.copilot.copilot_cloud_agent %} access to external tools? See [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/configure-mcp-servers). ### Which policies don't apply? @@ -61,7 +61,7 @@ Organization owners can restrict the {% data variables.copilot.copilot_cloud_age ### Configure workflow policies -Decide whether **{% data variables.product.prodname_actions %} workflows should be blocked from running** in pull requests that {% data variables.copilot.copilot_cloud_agent %} creates. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/configuring-agent-settings#allowing-github-actions-workflows-to-run-automatically-when-copilot-pushes). +Decide whether **{% data variables.product.prodname_actions %} workflows should be blocked from running** in pull requests that {% data variables.copilot.copilot_cloud_agent %} creates. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/configuring-agent-settings#allowing-github-actions-workflows-to-run-automatically-when-copilot-pushes). By default, workflows are blocked from running until someone with write access approves them. Repository administrators will be able to disable this feature, so communicate with them in advance about your preferred setting. diff --git a/content/copilot/tutorials/cloud-agent/get-the-best-results.md b/content/copilot/tutorials/cloud-agent/get-the-best-results.md index e43ef133027d..4df27b75c7f5 100644 --- a/content/copilot/tutorials/cloud-agent/get-the-best-results.md +++ b/content/copilot/tutorials/cloud-agent/get-the-best-results.md @@ -71,7 +71,7 @@ This workflow is useful when you want to: * Agree on an approach with {% data variables.product.prodname_copilot_short %} before any code is written. * Review and iterate on changes before opening a pull request for review. -See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/research-plan-iterate). +See [AUTOTITLE](/copilot/how-tos/copilot-on-github/use-copilot-agents/research-plan-iterate). ## Using comments to iterate on a pull request @@ -79,7 +79,7 @@ Working with {% data variables.product.prodname_copilot_short %} on a pull reque Additionally, you can: * Mention `@copilot` in comments on the pull request, explaining what you think is incorrect, or could be improved, and {% data variables.product.prodname_copilot_short %} will push commits directly to the pull request's branch. -* Ask {% data variables.product.prodname_copilot_short %} to resolve merge conflicts on the pull request. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/make-changes-to-an-existing-pr#resolving-merge-conflicts). +* Ask {% data variables.product.prodname_copilot_short %} to resolve merge conflicts on the pull request. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/use-cloud-agent-on-github#resolving-merge-conflicts). * Work on the feature branch yourself and push changes to the pull request. After a user with write access mentions `@copilot` in a comment, {% data variables.product.prodname_copilot_short %} will start to make any required changes, and will update the pull request when it's done. Because {% data variables.product.prodname_copilot_short %} starts looking at comments as soon as they are submitted, if you are likely to make multiple comments on a pull request it's best to batch them by clicking **Start a review**, rather than clicking **Add single comment**. You can then submit all of your comments at once, triggering {% data variables.product.prodname_copilot_short %} to work on your entire review, rather than working on individual comments separately. @@ -103,13 +103,13 @@ If {% data variables.product.prodname_copilot_short %} is able to build, test an * `/CLAUDE.md` * `/GEMINI.md` -For more information, see [AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot?tool=webui). +For more information, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-repository-instructions?tool=webui). ### Repository-wide instructions To add instructions that apply to all tasks assigned to {% data variables.product.prodname_copilot_short %} in your repository, create a `.github/copilot-instructions.md` file in the root of your repository. This file should contain information about your project, such as how to build and test it, and any coding standards or conventions you want {% data variables.product.prodname_copilot_short %} to follow. Note that the instructions will also apply to {% data variables.copilot.copilot_chat_short %} and {% data variables.copilot.copilot_code-review_short %}. -The first time you ask {% data variables.product.prodname_copilot_short %} to create a pull request in a given repository, {% data variables.product.prodname_copilot_short %} will leave a comment with a link to automatically generate custom instructions. You can also ask {% data variables.product.prodname_copilot_short %} to generate custom instructions for you at any time using our recommended prompt. See [AUTOTITLE](/copilot/how-tos/configure-custom-instructions/add-repository-instructions?tool=webui#asking-copilot-cloud-agent-to-generate-a-copilot-instructionsmd-file). +The first time you ask {% data variables.product.prodname_copilot_short %} to create a pull request in a given repository, {% data variables.product.prodname_copilot_short %} will leave a comment with a link to automatically generate custom instructions. You can also ask {% data variables.product.prodname_copilot_short %} to generate custom instructions for you at any time using our recommended prompt. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-repository-instructions?tool=webui#asking-copilot-cloud-agent-to-generate-a-copilot-instructionsmd-file). You can also choose to write your own custom instructions at any time. Here is an example of an effective `copilot-instructions.md` file: @@ -176,11 +176,11 @@ When writing Playwright tests, please follow these guidelines to ensure consiste ## Organization-wide custom instructions -{% data variables.copilot.copilot_cloud_agent %} leverages your organization's custom instructions as part of its work. {% data variables.copilot.copilot_cloud_agent %} first prioritizes repository-wide custom instructions. For more information on how to configure organization custom instructions, see [AUTOTITLE](/copilot/how-tos/configure-custom-instructions/add-organization-instructions). +{% data variables.copilot.copilot_cloud_agent %} leverages your organization's custom instructions as part of its work. {% data variables.copilot.copilot_cloud_agent %} first prioritizes repository-wide custom instructions. For more information on how to configure organization custom instructions, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-organization-instructions). ## Using the Model Context Protocol (MCP) -You can extend the capabilities of {% data variables.copilot.copilot_cloud_agent %} by using MCP. This allows {% data variables.copilot.copilot_cloud_agent %} to use tools provided by local and remote MCP servers. The {% data variables.product.github %} MCP server and [Playwright MCP server](https://github.com/microsoft/playwright-mcp) are enabled by default. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/extend-cloud-agent-with-mcp). +You can extend the capabilities of {% data variables.copilot.copilot_cloud_agent %} by using MCP. This allows {% data variables.copilot.copilot_cloud_agent %} to use tools provided by local and remote MCP servers. The {% data variables.product.github %} MCP server and [Playwright MCP server](https://github.com/microsoft/playwright-mcp) are enabled by default. For more information, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/configure-mcp-servers). ## Creating {% data variables.copilot.custom_agents_short %} @@ -194,7 +194,7 @@ By default, {% data variables.copilot.custom_agents_short %} inherit any MCP ser You can use {% data variables.copilot.custom_agents_short %} anywhere you use {% data variables.copilot.copilot_cloud_agent %}, including when assigning an issue or prompting with a task. -For more information on creating and configuring {% data variables.copilot.custom_agents_short %}, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-custom-agents). +For more information on creating and configuring {% data variables.copilot.custom_agents_short %}, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/create-custom-agents). ## Pre-installing dependencies in {% data variables.product.prodname_copilot %}'s environment @@ -204,4 +204,4 @@ If {% data variables.product.prodname_copilot_short %} is able to build, test an To do that, it will need your project's dependencies. {% data variables.product.prodname_copilot_short %} can discover and install these dependencies itself via a process of trial and error - but this can be slow and unreliable, given the non-deterministic nature of large language models (LLMs). -You can configure a `copilot-setup-steps.yml` file to pre-install these dependencies before the agent starts working so it can hit the ground running. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-environment#preinstalling-tools-or-dependencies-in-copilots-environment). +You can configure a `copilot-setup-steps.yml` file to pre-install these dependencies before the agent starts working so it can hit the ground running. For more information, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/customize-the-agent-environment#preinstalling-tools-or-dependencies-in-copilots-environment). diff --git a/content/copilot/tutorials/cloud-agent/give-access-to-resources.md b/content/copilot/tutorials/cloud-agent/give-access-to-resources.md index 4b08beb92a82..2e8dfef52329 100644 --- a/content/copilot/tutorials/cloud-agent/give-access-to-resources.md +++ b/content/copilot/tutorials/cloud-agent/give-access-to-resources.md @@ -100,4 +100,4 @@ Now you have seen how access to resources is controlled at the repository and or 1. **Choose which repositories have access** to {% data variables.copilot.copilot_cloud_agent %}. If you're concerned about a specific repository, you can block it for all users. 1. **Consider who gets admin access** to these repositories. You can control this at the organization level by creating a team with the **All-repository admin** custom role. These users will be able to manage configuration _settings_, such as MCP configuration and Agents secrets and variables, in every repository. 1. **Use rulesets and CODEOWNERS files** to control edits of configuration _files_, such as `copilot-setup-steps.yml`, which anyone with write access can edit by default. -1. **Review the default firewall**. The firewall doesn't affect connections to MCP servers or setup steps in `copilot-setup-steps.yml`, but it does limit {% data variables.product.prodname_copilot_short %}'s access to the Internet during task execution. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-firewall). +1. **Review the default firewall**. The firewall doesn't affect connections to MCP servers or setup steps in `copilot-setup-steps.yml`, but it does limit {% data variables.product.prodname_copilot_short %}'s access to the Internet during task execution. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/customize-the-agent-firewall). diff --git a/content/copilot/tutorials/cloud-agent/improve-a-project.md b/content/copilot/tutorials/cloud-agent/improve-a-project.md index c7570b8d9ae2..a2b0415e805a 100644 --- a/content/copilot/tutorials/cloud-agent/improve-a-project.md +++ b/content/copilot/tutorials/cloud-agent/improve-a-project.md @@ -44,7 +44,7 @@ In the following sections we'll: For more information, see the section "Writing effective custom instructions" in [AUTOTITLE](/copilot/concepts/prompting/response-customization?tool=webui#writing-effective-custom-instructions), and the library of examples at [AUTOTITLE](/copilot/tutorials/customization-library/custom-instructions). -1. If there are no custom instructions files in the repository, use {% data variables.copilot.copilot_cloud_agent %} to create a `.github/copilot-instructions.md` file, by following the instructions in [AUTOTITLE](/copilot/how-tos/configure-custom-instructions/add-repository-instructions#asking-copilot-cloud-agent-to-generate-a-copilot-instructionsmd-file). +1. If there are no custom instructions files in the repository, use {% data variables.copilot.copilot_cloud_agent %} to create a `.github/copilot-instructions.md` file, by following the instructions in [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-repository-instructions#asking-copilot-cloud-agent-to-generate-a-copilot-instructionsmd-file). 1. Review the pull request that {% data variables.copilot.copilot_cloud_agent %} creates. Check that the `.github/copilot-instructions.md` file provides {% data variables.product.prodname_copilot_short %} with all of the information it needs to know to work on this project. The file should include: diff --git a/content/copilot/tutorials/cloud-agent/pilot-cloud-agent.md b/content/copilot/tutorials/cloud-agent/pilot-cloud-agent.md index 195027021d06..d310cdda54f6 100644 --- a/content/copilot/tutorials/cloud-agent/pilot-cloud-agent.md +++ b/content/copilot/tutorials/cloud-agent/pilot-cloud-agent.md @@ -32,7 +32,7 @@ Before enabling {% data variables.copilot.copilot_cloud_agent %} for members, un 1. Learn about {% data variables.copilot.copilot_cloud_agent %}, including the costs and how it differs from other AI tools your developers may be used to. See [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-cloud-agent). 1. Learn about the tasks that {% data variables.copilot.copilot_cloud_agent %} is best suited for. These are generally well-defined and scoped issues, such as increasing test coverage, fixing bugs or flaky tests, or updating config files or documentation. See [AUTOTITLE](/copilot/tutorials/cloud-agent/get-the-best-results). -1. Consider how {% data variables.copilot.copilot_cloud_agent %} fits alongside other tools in your organization's workflows. For an example scenario that walks through how to use {% data variables.copilot.copilot_cloud_agent %} alongside other AI features on {% data variables.product.github %}, see [AUTOTITLE](/copilot/rolling-out-github-copilot-at-scale/enabling-developers/integrating-agentic-ai). +1. Consider how {% data variables.copilot.copilot_cloud_agent %} fits alongside other tools in your organization's workflows. For an example scenario that walks through how to use {% data variables.copilot.copilot_cloud_agent %} alongside other AI features on {% data variables.product.github %}, see [AUTOTITLE](/copilot/tutorials/roll-out-at-scale/enable-developers/integrate-ai-agents). ## 2. Secure @@ -49,7 +49,7 @@ As with any other change to working practices, it's important to run a trial to 1. Gather a cross-functional team for the trial to bring different roles, backgrounds, and perspectives to the project. This will make it easier to ensure that you explore a broad range of ways to define issues, assign work to {% data variables.product.prodname_copilot_short %}, and give clear review feedback. 1. Choose an isolated or low-risk repository, for example, one that contains documentation or internal tools. You could create a fresh repository to use as a playground, but {% data variables.product.prodname_copilot_short %} needs context to be successful, so you would need to add a lot of context, including team processes, development environment, and common dependencies. 1. Enable {% data variables.copilot.copilot_cloud_agent %} in the repository and optionally enable third-party MCP servers for enhanced context sharing. See [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/add-copilot-cloud-agent). -1. Create repository instructions and pre-install any tools required in the development environment {% data variables.product.prodname_copilot_short %} uses. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-environment). +1. Create repository instructions and pre-install any tools required in the development environment {% data variables.product.prodname_copilot_short %} uses. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/customize-the-agent-environment). 1. Identify a few compelling use cases for your organization, for example: test coverage or improving accessibility. See [Choose the right type of tasks to give to Copilot](/copilot/tutorials/cloud-agent/get-the-best-results#choosing-the-right-type-of-tasks-to-give-to-copilot) in the best practice guide. 1. Use best practice to create or refine issues for {% data variables.product.prodname_copilot_short %} in your pilot repository. 1. Assign issues to {% data variables.product.prodname_copilot_short %} and prepare team members to review its work. @@ -70,7 +70,7 @@ You can extend the information available to {% data variables.copilot.copilot_cl * **Project planning tools**: Allow {% data variables.product.prodname_copilot_short %} direct access to private planning documents that are stored outside {% data variables.product.github %} in tools like Notion or Figma. * **Augment training data**: Each LLM contains training data up to a specific cut-off date. If you're working with fast moving tools, {% data variables.product.prodname_copilot_short %} may not have access to information on new features. You can fill this knowledge gap by making the tool's MCP server available. For example, adding the Terraform MCP server will give {% data variables.product.prodname_copilot_short %} access to the most recently supported Terraform providers. -For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/extend-cloud-agent-with-mcp). +For more information, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/configure-mcp-servers). ## Next steps diff --git a/content/copilot/tutorials/compare-ai-models.md b/content/copilot/tutorials/compare-ai-models.md index 9165873a889a..3b0759fc01ea 100644 --- a/content/copilot/tutorials/compare-ai-models.md +++ b/content/copilot/tutorials/compare-ai-models.md @@ -183,7 +183,7 @@ class Cart: Consider a scenario where you are implementing both unit tests and integration tests for an application. You want to ensure that the tests are comprehensive and cover any edge cases that you may and may not have thought of. -For a complete walkthrough of the scenario, see [AUTOTITLE](/copilot/tutorials/writing-tests-with-github-copilot). +For a complete walkthrough of the scenario, see [AUTOTITLE](/copilot/tutorials/write-tests). ### Why {% data variables.copilot.copilot_claude_haiku_45 %} is a good fit @@ -198,7 +198,7 @@ For a complete walkthrough of the scenario, see [AUTOTITLE](/copilot/tutorials/w Consider a scenario where you're modernizing a legacy COBOL application by rewriting it in Node.js. The project involves understanding unfamiliar source code, converting logic across languages, iteratively building the replacement, and verifying correctness through a test suite. -For a complete walkthrough of the scenario, see [AUTOTITLE](/copilot/tutorials/modernizing-legacy-code-with-github-copilot). +For a complete walkthrough of the scenario, see [AUTOTITLE](/copilot/tutorials/modernize-legacy-code). ### Why {% data variables.copilot.copilot_claude_sonnet_45 %} is a good fit @@ -208,4 +208,4 @@ For a complete walkthrough of the scenario, see [AUTOTITLE](/copilot/tutorials/m ## Further reading * [AUTOTITLE](/copilot/reference/ai-models/model-comparison) -* [AUTOTITLE](/copilot/copilot-chat-cookbook) +* [AUTOTITLE](/copilot/tutorials/copilot-cookbook) diff --git a/content/copilot/tutorials/copilot-cli-hooks.md b/content/copilot/tutorials/copilot-cli-hooks.md index 6269541d41f2..1230fbdad344 100644 --- a/content/copilot/tutorials/copilot-cli-hooks.md +++ b/content/copilot/tutorials/copilot-cli-hooks.md @@ -699,4 +699,4 @@ Some teams (for example, infrastructure or platform teams) may require broader p ## Further reading -For troubleshooting hooks, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/use-hooks#troubleshooting). +For troubleshooting hooks, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/use-hooks#troubleshooting). diff --git a/content/copilot/tutorials/copilot-cookbook/analyze-security/find-vulnerabilities.md b/content/copilot/tutorials/copilot-cookbook/analyze-security/find-vulnerabilities.md index 4722ee948ed1..61e933c1e9db 100644 --- a/content/copilot/tutorials/copilot-cookbook/analyze-security/find-vulnerabilities.md +++ b/content/copilot/tutorials/copilot-cookbook/analyze-security/find-vulnerabilities.md @@ -22,7 +22,7 @@ contentType: tutorials While they may be considered "common knowledge" by many developers, the vast majority of newly introduced security weaknesses are due to vulnerabilities like cross-site scripting (XSS), SQL injection, and cross-site request forgery (CSRF). These vulnerabilities can be mitigated by following secure coding practices, such as using parameterized queries, input validation, and avoiding hard-coded sensitive data. GitHub Copilot can help detect and resolve these issues. -> [!NOTE] While {% data variables.copilot.copilot_chat_short %} can help find some common security vulnerabilities and help you fix them, you should not rely on {% data variables.product.prodname_copilot_short %} for a comprehensive security analysis. Using {% data variables.product.prodname_code_scanning %} will more thoroughly ensure your code is secure. For more information on setting up {% data variables.product.prodname_code_scanning %}, see [AUTOTITLE](/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning). +> [!NOTE] While {% data variables.copilot.copilot_chat_short %} can help find some common security vulnerabilities and help you fix them, you should not rely on {% data variables.product.prodname_copilot_short %} for a comprehensive security analysis. Using {% data variables.product.prodname_code_scanning %} will more thoroughly ensure your code is secure. For more information on setting up {% data variables.product.prodname_code_scanning %}, see [AUTOTITLE](/code-security/how-tos/find-and-fix-code-vulnerabilities/configure-code-scanning/configure-code-scanning). ## Example scenario @@ -59,4 +59,4 @@ function displayName(name) { ## Further reading {% data reusables.copilot.example-prompts.further-reading-items %} -* [AUTOTITLE](/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning) +* [AUTOTITLE](/code-security/concepts/code-scanning/code-scanning) diff --git a/content/copilot/tutorials/copilot-cookbook/analyze-security/manage-dependency-updates.md b/content/copilot/tutorials/copilot-cookbook/analyze-security/manage-dependency-updates.md index 0f241248470c..7737f1e042f7 100644 --- a/content/copilot/tutorials/copilot-cookbook/analyze-security/manage-dependency-updates.md +++ b/content/copilot/tutorials/copilot-cookbook/analyze-security/manage-dependency-updates.md @@ -24,7 +24,7 @@ contentType: tutorials Let's say your project depends on numerous libraries and packages. Vulnerable or outdated dependencies create security risks that can affect your project and others that rely on it. -{% data variables.copilot.copilot_chat_short %} can help you get set up with {% data variables.product.prodname_dependabot %} security and version updates, so that your dependencies always remain on the most secure, and up-to-date versions. See [AUTOTITLE](/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates) and [AUTOTITLE](/code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates). +{% data variables.copilot.copilot_chat_short %} can help you get set up with {% data variables.product.prodname_dependabot %} security and version updates, so that your dependencies always remain on the most secure, and up-to-date versions. See [AUTOTITLE](/code-security/concepts/supply-chain-security/dependabot-security-updates) and [AUTOTITLE](/code-security/concepts/supply-chain-security/dependabot-version-updates). Before you begin, ensure that {% data variables.product.prodname_dependabot %} is fully enabled under your repository's "Settings." 1. Under your "Code security" settings, ensure **{% data variables.product.prodname_dependabot_alerts %}** and **{% data variables.product.prodname_dependabot_security_updates %}** are both set to "Enabled." @@ -115,7 +115,7 @@ Draft an update to the dependabot.yml file in my repository that specifies these ``` > [!TIP] -> * There are many customization options to explore. For more information, see [AUTOTITLE](/code-security/dependabot/dependabot-security-updates/customizing-dependabot-security-prs) and [AUTOTITLE](/code-security/dependabot/dependabot-version-updates/customizing-dependabot-prs). +> * There are many customization options to explore. For more information, see [AUTOTITLE](/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/customizing-dependabot-security-prs) and [AUTOTITLE](/code-security/tutorials/secure-your-dependencies/customizing-dependabot-prs). > * You can specify different customizations per package ecosystem. ### Example output diff --git a/content/copilot/tutorials/copilot-cookbook/communicate-effectively/creating-diagrams.md b/content/copilot/tutorials/copilot-cookbook/communicate-effectively/creating-diagrams.md index 7e600a646932..162cd624d2dd 100644 --- a/content/copilot/tutorials/copilot-cookbook/communicate-effectively/creating-diagrams.md +++ b/content/copilot/tutorials/copilot-cookbook/communicate-effectively/creating-diagrams.md @@ -68,4 +68,4 @@ This Mermaid code would generate the following diagram: ## Further reading * [Mermaid documentation](https://mermaid-js.github.io/mermaid/#/) -* [GitHub Copilot Chat documentation](/copilot/how-tos/use-chat) +* [GitHub Copilot Chat documentation](/copilot/how-tos/chat-with-copilot) diff --git a/content/copilot/tutorials/copilot-cookbook/communicate-effectively/generating-tables.md b/content/copilot/tutorials/copilot-cookbook/communicate-effectively/generating-tables.md index 69e4add696dd..8c3339b539c8 100644 --- a/content/copilot/tutorials/copilot-cookbook/communicate-effectively/generating-tables.md +++ b/content/copilot/tutorials/copilot-cookbook/communicate-effectively/generating-tables.md @@ -104,7 +104,7 @@ Availability: Mon-Thu, 10am-6pm ## Next steps -You can experiment with different types of visualizations and data to see how {% data variables.copilot.copilot_chat_short %} can help you create organized and easy-to-read information. For example, you could ask {% data variables.copilot.copilot_chat_short %} to use the `Timezone` and `Availability` columns to create a Mermaid graph that shows overlapping working hours for team members in different time zones. See [AUTOTITLE](/copilot/tutorials/copilot-chat-cookbook/communicate-effectively/creating-diagrams) for more information. +You can experiment with different types of visualizations and data to see how {% data variables.copilot.copilot_chat_short %} can help you create organized and easy-to-read information. For example, you could ask {% data variables.copilot.copilot_chat_short %} to use the `Timezone` and `Availability` columns to create a Mermaid graph that shows overlapping working hours for team members in different time zones. See [AUTOTITLE](/copilot/tutorials/copilot-cookbook/communicate-effectively/creating-diagrams) for more information. ## Further reading diff --git a/content/copilot/tutorials/copilot-cookbook/refactor-code/improve-code-readability.md b/content/copilot/tutorials/copilot-cookbook/refactor-code/improve-code-readability.md index 31e09aa1c9d7..369c4bd3f406 100644 --- a/content/copilot/tutorials/copilot-cookbook/refactor-code/improve-code-readability.md +++ b/content/copilot/tutorials/copilot-cookbook/refactor-code/improve-code-readability.md @@ -27,7 +27,7 @@ Code with poor readability is difficult for other developers to maintain and ext * [Reducing nested logic](#reducing-nested-logic) * [Splitting large methods into smaller, more readable ones](#splitting-up-large-methods) -Documenting your code is another way to improve the maintainability of your code. For information about using {% data variables.copilot.copilot_chat_short %} to help you add useful comments to your code, see the example prompts in [Documenting code](/copilot/copilot-chat-cookbook/documenting-code). +Documenting your code is another way to improve the maintainability of your code. For information about using {% data variables.copilot.copilot_chat_short %} to help you add useful comments to your code, see the example prompts in [Documenting code](/copilot/tutorials/copilot-cookbook/document-code). > [!NOTE] The responses shown in this article are examples. {% data variables.copilot.copilot_chat_short %} responses are non-deterministic, so you may get different responses from the ones shown here. diff --git a/content/copilot/tutorials/copilot-cookbook/refactor-code/translate-code.md b/content/copilot/tutorials/copilot-cookbook/refactor-code/translate-code.md index e5da7a7a0ee6..a89e02439cd0 100644 --- a/content/copilot/tutorials/copilot-cookbook/refactor-code/translate-code.md +++ b/content/copilot/tutorials/copilot-cookbook/refactor-code/translate-code.md @@ -25,7 +25,7 @@ For ease of maintaining code, you might want to move code to a language that is {% data variables.product.prodname_copilot_short %} can help you translate code from one language to another. Translating a standalone file, such as a script, is straightforward. This process is described in this article. -Translating a project containing multiple files is a more complex process, and is described in [AUTOTITLE](/copilot/tutorials/using-copilot-to-migrate-a-project). +Translating a project containing multiple files is a more complex process, and is described in [AUTOTITLE](/copilot/tutorials/migrate-a-project). ## Example scenario diff --git a/content/copilot/tutorials/customization-library/custom-instructions/accessibility-auditor.md b/content/copilot/tutorials/customization-library/custom-instructions/accessibility-auditor.md index e85a6d009d5b..4f0b8359fbeb 100644 --- a/content/copilot/tutorials/customization-library/custom-instructions/accessibility-auditor.md +++ b/content/copilot/tutorials/customization-library/custom-instructions/accessibility-auditor.md @@ -18,7 +18,7 @@ contentType: tutorials {% data reusables.copilot.customization-examples-note %} -The following example shows a path-specific `accessibility.instructions.md` file that applies only to HTML files in your repository, and guides {% data variables.product.prodname_copilot %} to generate accessible, inclusive HTML that follows WCAG guidelines. For more information about path-specific instructions files, see [AUTOTITLE](/copilot/how-tos/configure-custom-instructions/add-repository-instructions#using-one-or-more-instructionsmd-files). +The following example shows a path-specific `accessibility.instructions.md` file that applies only to HTML files in your repository, and guides {% data variables.product.prodname_copilot %} to generate accessible, inclusive HTML that follows WCAG guidelines. For more information about path-specific instructions files, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-repository-instructions#using-one-or-more-instructionsmd-files). ````text copy --- diff --git a/content/copilot/tutorials/customization-library/custom-instructions/github-actions-helper.md b/content/copilot/tutorials/customization-library/custom-instructions/github-actions-helper.md index 46e8563e5939..b7c2eea50345 100644 --- a/content/copilot/tutorials/customization-library/custom-instructions/github-actions-helper.md +++ b/content/copilot/tutorials/customization-library/custom-instructions/github-actions-helper.md @@ -18,7 +18,7 @@ contentType: tutorials {% data reusables.copilot.customization-examples-note %} -The following example shows a path-specific `actions.instructions.md` file that applies only to {% data variables.product.prodname_actions %} workflow files in your repository, using the `applyTo` field. For more information about path-specific instructions files, see [AUTOTITLE](/copilot/how-tos/configure-custom-instructions/add-repository-instructions#using-one-or-more-instructionsmd-files). +The following example shows a path-specific `actions.instructions.md` file that applies only to {% data variables.product.prodname_actions %} workflow files in your repository, using the `applyTo` field. For more information about path-specific instructions files, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-repository-instructions#using-one-or-more-instructionsmd-files). ````text copy --- diff --git a/content/copilot/tutorials/customization-library/custom-instructions/testing-automation.md b/content/copilot/tutorials/customization-library/custom-instructions/testing-automation.md index b06304bd74a3..93ec9c6c8cd8 100644 --- a/content/copilot/tutorials/customization-library/custom-instructions/testing-automation.md +++ b/content/copilot/tutorials/customization-library/custom-instructions/testing-automation.md @@ -18,7 +18,7 @@ contentType: tutorials {% data reusables.copilot.customization-examples-note %} -This example shows a path-specifc `python-tests.instructions.md` file that applies only to Python test files in your repository, using the `applyTo` field. For more information about path-specific instructions files, see [AUTOTITLE](/copilot/how-tos/configure-custom-instructions/add-repository-instructions#using-one-or-more-instructionsmd-files). +This example shows a path-specific `python-tests.instructions.md` file that applies only to Python test files in your repository, using the `applyTo` field. For more information about path-specific instructions files, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-repository-instructions#using-one-or-more-instructionsmd-files). ````text copy --- diff --git a/content/copilot/tutorials/customize-code-review.md b/content/copilot/tutorials/customize-code-review.md index a1cf10f84fcf..d08cf0da7399 100644 --- a/content/copilot/tutorials/customize-code-review.md +++ b/content/copilot/tutorials/customize-code-review.md @@ -19,7 +19,7 @@ redirect_from: In this tutorial, you'll learn how to write clear, effective custom instructions that help {% data variables.product.prodname_copilot_short %} provide more relevant code reviews. You'll discover best practices for structuring your instructions, common pitfalls to avoid, and strategies for organizing instructions across different files. -This tutorial is about using custom instructions for {% data variables.copilot.copilot_code-review_short %}. For a more general introduction to using custom instructions, see [AUTOTITLE](/copilot/how-tos/configure-custom-instructions). +This tutorial is about using custom instructions for {% data variables.copilot.copilot_code-review_short %}. For a more general introduction to using custom instructions, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions). ### What you'll learn @@ -510,4 +510,4 @@ Remember that creating effective instructions is an iterative process. Start wit * Take a look at some of the [example custom instructions](https://github.com/github/awesome-copilot/tree/main/instructions) in the Awesome {% data variables.product.prodname_copilot %} repository for inspiration. * Read [AUTOTITLE](/copilot/concepts/prompting/response-customization) to learn about the full range of customization options. -* Explore [AUTOTITLE](/copilot/how-tos/configure-custom-instructions) for technical details on setting up instruction files. +* Explore [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions) for technical details on setting up instruction files. diff --git a/content/copilot/tutorials/enhance-agent-mode-with-mcp.md b/content/copilot/tutorials/enhance-agent-mode-with-mcp.md index 44c9b3a725dc..53bb70e707a2 100644 --- a/content/copilot/tutorials/enhance-agent-mode-with-mcp.md +++ b/content/copilot/tutorials/enhance-agent-mode-with-mcp.md @@ -41,7 +41,7 @@ Follow these best practices to get the most out of combining MCP servers with ag * **Provide context**: Include relevant background information about your project and requirements, including links to external resources that {% data variables.product.prodname_copilot_short %} can access. * **Set boundaries**: Specify any constraints or limitations for the task. For example, if you want {% data variables.product.prodname_copilot_short %} to only plan a new feature and not make any changes yet, specify that. You can also limit which MCP tools are enabled. * **Request confirmations**: Ask {% data variables.product.prodname_copilot_short %} to confirm its understanding before proceeding with significant changes. -* **Use prompt files or custom instructions**: You can create prompt files or custom instructions files to guide {% data variables.product.prodname_copilot_short %} on how to behave for different MCP servers. See [AUTOTITLE](/copilot/concepts/about-customizing-github-copilot-chat-responses). +* **Use prompt files or custom instructions**: You can create prompt files or custom instructions files to guide {% data variables.product.prodname_copilot_short %} on how to behave for different MCP servers. See [AUTOTITLE](/copilot/concepts/prompting/response-customization). ### MCP server use @@ -51,11 +51,11 @@ Follow these best practices to get the most out of combining MCP servers with ag ### Security considerations -* **Use OAuth when available**: For MCP servers like {% data variables.product.prodname_dotcom %} MCP, prefer OAuth authentication over {% data variables.product.pat_generic_plural %}. See [AUTOTITLE](/copilot/customizing-copilot/using-model-context-protocol/using-the-github-mcp-server#remote-mcp-server-configuration-with-oauth). +* **Use OAuth when available**: For MCP servers like {% data variables.product.prodname_dotcom %} MCP, prefer OAuth authentication over {% data variables.product.pat_generic_plural %}. See [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp-in-your-ide/use-the-github-mcp-server#remote-mcp-server-configuration-with-oauth). * **Limit permissions**: Only grant MCP servers the minimum permissions necessary for your tasks. * **Review connections**: Regularly audit which MCP servers have access to your development environment. * **Monitor activity**: Keep track of what actions {% data variables.product.prodname_copilot_short %} performs through MCP servers. -* **Prevent secret leaks**: Push protection blocks secrets from being included in AI-generated responses and prevents you from exposing secrets through any actions you perform using the {% data variables.product.github %} MCP server. This is currently available for public repositories only. See [AUTOTITLE](/code-security/secret-scanning/introduction/about-push-protection). +* **Prevent secret leaks**: Push protection blocks secrets from being included in AI-generated responses and prevents you from exposing secrets through any actions you perform using the {% data variables.product.github %} MCP server. This is currently available for public repositories only. See [AUTOTITLE](/code-security/concepts/secret-security/push-protection). ## Example scenario: Implementing accessibility compliance @@ -91,7 +91,7 @@ Before using agent mode with MCP, ensure you have: First, you need to configure the MCP servers that you anticipate {% data variables.product.prodname_copilot_short %} will need. For this example scenario, we'll use: -* **{% data variables.product.github %} MCP server**: Configure the {% data variables.product.github %} MCP server to enable {% data variables.product.prodname_copilot_short %} to access your repository, examine your codebase, research existing issues, create branches, and manage pull requests. See [AUTOTITLE](/copilot/customizing-copilot/using-model-context-protocol/using-the-github-mcp-server). +* **{% data variables.product.github %} MCP server**: Configure the {% data variables.product.github %} MCP server to enable {% data variables.product.prodname_copilot_short %} to access your repository, examine your codebase, research existing issues, create branches, and manage pull requests. See [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp-in-your-ide/use-the-github-mcp-server). * **Figma MCP server**: Configure the Figma MCP server to allow {% data variables.product.prodname_copilot_short %} to access design files that include accessibility specifications, such as color contrast requirements, focus states, and interaction patterns. See [Figma-Context-MCP](https://github.com/GLips/Figma-Context-MCP) or try out the [Dev Mode MCP server](https://help.figma.com/hc/en-us/articles/32132100833559-Guide-to-the-Dev-Mode-MCP-Server). @@ -225,5 +225,5 @@ In this exercise, you will learn how to: ## Further reading -* **MCP fundamentals**: For more information about setting up and configuring MCP servers, see [AUTOTITLE](/copilot/customizing-copilot/using-model-context-protocol/extending-copilot-chat-with-mcp). +* **MCP fundamentals**: For more information about setting up and configuring MCP servers, see [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp-in-your-ide/extend-copilot-chat-with-mcp). * **Using MCP servers**: For additional ideas on integrating MCP with {% data variables.product.prodname_copilot %}, see [5 ways to transform your workflow using GitHub Copilot and MCP](https://github.blog/ai-and-ml/github-copilot/5-ways-to-transform-your-workflow-using-github-copilot-and-mcp/) on the {% data variables.product.prodname_blog %}. diff --git a/content/copilot/tutorials/explore-a-codebase.md b/content/copilot/tutorials/explore-a-codebase.md index 78c5a17cee55..1a76426f1a51 100644 --- a/content/copilot/tutorials/explore-a-codebase.md +++ b/content/copilot/tutorials/explore-a-codebase.md @@ -151,4 +151,4 @@ For more information, see [AUTOTITLE](/repositories/viewing-activity-and-data-fo ## Further reading -* [AUTOTITLE](/copilot/using-github-copilot/copilot-chat/asking-github-copilot-questions-in-github) +* [AUTOTITLE](/copilot/how-tos/copilot-on-github/chat-with-copilot/chat-in-github) diff --git a/content/copilot/tutorials/explore-issues-and-discussions.md b/content/copilot/tutorials/explore-issues-and-discussions.md index ee03ff004211..65dbc74805f1 100644 --- a/content/copilot/tutorials/explore-issues-and-discussions.md +++ b/content/copilot/tutorials/explore-issues-and-discussions.md @@ -49,4 +49,4 @@ The following prompts are examples of the kind of questions you can ask {% data ## Further reading -* [AUTOTITLE](/copilot/tutorials/using-copilot-to-explore-a-codebase#further-reading) +* [AUTOTITLE](/copilot/tutorials/explore-a-codebase#further-reading) diff --git a/content/copilot/tutorials/explore-pull-requests.md b/content/copilot/tutorials/explore-pull-requests.md index 47afb3e2c7ea..9faa8f4b45f1 100644 --- a/content/copilot/tutorials/explore-pull-requests.md +++ b/content/copilot/tutorials/explore-pull-requests.md @@ -109,5 +109,5 @@ When you view a pull request created by {% data variables.copilot.copilot_cloud_ ## Further reading -* [AUTOTITLE](/copilot/tutorials/using-copilot-to-explore-a-codebase) +* [AUTOTITLE](/copilot/tutorials/explore-a-codebase) * [AUTOTITLE](/copilot/tutorials/roll-out-at-scale/drive-downstream-impact/accelerate-pull-requests) diff --git a/content/copilot/tutorials/learn-a-new-language.md b/content/copilot/tutorials/learn-a-new-language.md index 26ee9c4b0326..232f02bc218f 100644 --- a/content/copilot/tutorials/learn-a-new-language.md +++ b/content/copilot/tutorials/learn-a-new-language.md @@ -18,7 +18,7 @@ category: ### Prerequisites -This guide assumes that you know how to use {% data variables.copilot.copilot_chat_short %} and {% data variables.product.prodname_copilot_short %} inline suggestions in your IDE. See [AUTOTITLE](/copilot/using-github-copilot/copilot-chat/asking-github-copilot-questions-in-your-ide) and [AUTOTITLE](/copilot/using-github-copilot/getting-code-suggestions-in-your-ide-with-github-copilot). +This guide assumes that you know how to use {% data variables.copilot.copilot_chat_short %} and {% data variables.product.prodname_copilot_short %} inline suggestions in your IDE. See [AUTOTITLE](/copilot/how-tos/chat-with-copilot/chat-in-ide) and [AUTOTITLE](/copilot/how-tos/get-code-suggestions/get-ide-code-suggestions). ## Start with the basics @@ -173,7 +173,7 @@ If you think {% data variables.product.prodname_copilot_short %} has not suggest If you run the code and it generates an error, give {% data variables.product.prodname_copilot_short %} the details of the error and ask it to fix the code. -You should also check that {% data variables.product.prodname_copilot_short %} is following your coding style guidelines. If it is not, you can alter the repository's custom instructions to prompt {% data variables.product.prodname_copilot_short %} to adhere to your guidelines in future. See [AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot). +You should also check that {% data variables.product.prodname_copilot_short %} is following your coding style guidelines. If it is not, you can alter the repository's custom instructions to prompt {% data variables.product.prodname_copilot_short %} to adhere to your guidelines in future. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-repository-instructions). ### Example prompts: checking your work diff --git a/content/copilot/tutorials/migrate-a-project.md b/content/copilot/tutorials/migrate-a-project.md index e0815c7b2a25..1d4f87f0b61c 100644 --- a/content/copilot/tutorials/migrate-a-project.md +++ b/content/copilot/tutorials/migrate-a-project.md @@ -32,7 +32,7 @@ Consider the points before you start a migration process: * **Use AI to help you** - If you don't understand a particular part of the code you are about to translate, use {% data variables.product.prodname_copilot_short %}'s "explain" feature, either on the whole file, or a selected portion of the code within a file. See [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide). + If you don't understand a particular part of the code you are about to translate, use {% data variables.product.prodname_copilot_short %}'s "explain" feature, either on the whole file, or a selected portion of the code within a file. See [AUTOTITLE](/copilot/how-tos/chat-with-copilot/chat-in-ide). * **Schedule time to complete the migration** @@ -54,7 +54,7 @@ Consider the points before you start a migration process: Assuming you've already familiarized yourself with the existing project, a good way to start a migration is to open a branch of the repository in your editor and ask {% data variables.product.prodname_copilot_short %} for help. -1. In your editor, open the {% data variables.copilot.copilot_chat_short %} panel. See [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide). +1. In your editor, open the {% data variables.copilot.copilot_chat_short %} panel. See [AUTOTITLE](/copilot/how-tos/chat-with-copilot/chat-in-ide). 1. Ask {% data variables.product.prodname_copilot_short %} to outline the steps you need to take to migrate the project to the new language. For example, for a migration from PHP to Python, you could ask: @@ -76,7 +76,7 @@ Assuming you've already familiarized yourself with the existing project, a good If you think a change suggested by {% data variables.product.prodname_copilot_short %} is not right in some way, ask for an alternative suggestion. 1. As soon as you've migrated a component to a state that you can run, check that it works as expected. If it generates an error, copy the error into the {% data variables.copilot.copilot_chat_short %} view, and ask {% data variables.product.prodname_copilot_short %} to help you fix it. -1. After you've completed the initial conversion, use {% data variables.product.prodname_copilot_short %} to help you refactor the code in the new language. For more information, see [AUTOTITLE](/copilot/tutorials/refactoring-code-with-github-copilot). +1. After you've completed the initial conversion, use {% data variables.product.prodname_copilot_short %} to help you refactor the code in the new language. For more information, see [AUTOTITLE](/copilot/tutorials/refactor-code). ## Example: migrating a PHP project to Python diff --git a/content/copilot/tutorials/modernize-legacy-code.md b/content/copilot/tutorials/modernize-legacy-code.md index 69c74e800bc9..64427d4e16fb 100644 --- a/content/copilot/tutorials/modernize-legacy-code.md +++ b/content/copilot/tutorials/modernize-legacy-code.md @@ -418,5 +418,5 @@ In this exercise, you will learn how to: ## Further reading -* [AUTOTITLE](/copilot/copilot-chat-cookbook/documenting-code/documenting-legacy-code) +* [AUTOTITLE](/copilot/tutorials/copilot-cookbook/document-code/document-legacy-code) * [Modernizing legacy code with {% data variables.product.prodname_copilot %}: Tips and examples](https://github.blog/ai-and-ml/github-copilot/modernizing-legacy-code-with-github-copilot-tips-and-examples/) on the {% data variables.product.github %} Blog diff --git a/content/copilot/tutorials/optimize-code-reviews.md b/content/copilot/tutorials/optimize-code-reviews.md index 11c52578e97d..f64f9e6f1ac2 100644 --- a/content/copilot/tutorials/optimize-code-reviews.md +++ b/content/copilot/tutorials/optimize-code-reviews.md @@ -220,7 +220,7 @@ To make your reviews more efficient and effective using {% data variables.produc 1. Create custom instructions specific to your project and repository. Write your own, or take inspiration from our library of examples. See [AUTOTITLE](/copilot/tutorials/customization-library/custom-instructions). 1. To enable automatic {% data variables.copilot.copilot_code-review_short %} for your repository, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/set-up-copilot/configure-automatic-review). -1. To configure {% data variables.copilot.copilot_autofix_short %} for your repo you'll need to enable {% data variables.product.prodname_code_scanning %}. Once {% data variables.product.prodname_code_scanning %} with {% data variables.product.prodname_codeql %} analysis is enabled, {% data variables.copilot.copilot_autofix_short %} is enabled by default. For the easiest setup, see [AUTOTITLE](/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning). +1. To configure {% data variables.copilot.copilot_autofix_short %} for your repo you'll need to enable {% data variables.product.prodname_code_scanning %}. Once {% data variables.product.prodname_code_scanning %} with {% data variables.product.prodname_codeql %} analysis is enabled, {% data variables.copilot.copilot_autofix_short %} is enabled by default. For the easiest setup, see [AUTOTITLE](/code-security/how-tos/find-and-fix-code-vulnerabilities/configure-code-scanning/configure-code-scanning). ## Further reading diff --git a/content/copilot/tutorials/reduce-technical-debt.md b/content/copilot/tutorials/reduce-technical-debt.md index 0ec89422c572..b8528a0d0548 100644 --- a/content/copilot/tutorials/reduce-technical-debt.md +++ b/content/copilot/tutorials/reduce-technical-debt.md @@ -109,7 +109,7 @@ try { By adopting the in-the-moment fix approach, you help to ensure that substandard code does not get added to your codebase, and you avoid the creation of a backlog issue that may never be addressed. -For more details on using {% data variables.product.prodname_copilot_short %} in your IDE, see [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide). +For more details on using {% data variables.product.prodname_copilot_short %} in your IDE, see [AUTOTITLE](/copilot/how-tos/chat-with-copilot/chat-in-ide). ## Using {% data variables.copilot.copilot_cloud_agent %} for large-scale refactoring @@ -166,7 +166,7 @@ Examples include: 1. Iterate in this way until the work is completed correctly. 1. Approve and merge the pull request. -For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/start-copilot-sessions#assigning-an-issue-to-copilot) and [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/review-copilot-prs). +For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/start-copilot-sessions#assigning-an-issue-to-copilot) and [AUTOTITLE](/copilot/how-tos/copilot-on-github/use-copilot-agents/review-copilot-output). ### Safety guardrails @@ -217,7 +217,7 @@ Here's an example of effective custom instructions: - Test both success and failure paths ``` -For detailed guidance on writing custom instructions, see [AUTOTITLE](/copilot/customizing-copilot/adding-custom-instructions-for-github-copilot). +For detailed guidance on writing custom instructions, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-repository-instructions). ### Benefits of custom instructions @@ -374,6 +374,6 @@ After reading this tutorial, do you feel confident you can use {% data variables ## Further reading * [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent) -* [AUTOTITLE](/copilot/tutorials/refactoring-code-with-github-copilot) +* [AUTOTITLE](/copilot/tutorials/refactor-code) * [How to use GitHub Copilot in your IDE: Tips, tricks, and best practices](https://github.blog/developer-skills/github/how-to-use-github-copilot-in-your-ide-tips-tricks-and-best-practices/) in the {% data variables.product.company_short %} blog * [5 ways to integrate GitHub {% data variables.copilot.copilot_cloud_agent %} into your workflow](https://github.blog/ai-and-ml/github-copilot/5-ways-to-integrate-github-copilot-cloud-agent-into-your-workflow/) in the {% data variables.product.company_short %} blog diff --git a/content/copilot/tutorials/review-ai-generated-code.md b/content/copilot/tutorials/review-ai-generated-code.md index a20e7120ebe8..7d45f7c0c289 100644 --- a/content/copilot/tutorials/review-ai-generated-code.md +++ b/content/copilot/tutorials/review-ai-generated-code.md @@ -21,8 +21,8 @@ With {% data variables.product.prodname_copilot_short %}, you can streamline you Always run automated tests and static analysis tools first. * Make sure the code compiles and all tests pass. Check for any new warnings or errors. -* Use tools like [{% data variables.product.prodname_codeql %}](https://codeql.github.com/) and [{% data variables.product.prodname_dependabot %}](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically) to catch vulnerabilities and dependency issues. -* See [AUTOTITLE](/copilot/tutorials/copilot-chat-cookbook/testing-code/generate-unit-tests) and [AUTOTITLE](/copilot/tutorials/copilot-chat-cookbook/testing-code/create-end-to-end-tests) for examples of verifying code with {% data variables.product.prodname_copilot_short %}. +* Use tools like [{% data variables.product.prodname_codeql %}](https://codeql.github.com/) and [{% data variables.product.prodname_dependabot %}](/code-security/concepts/supply-chain-security/dependabot-version-updates) to catch vulnerabilities and dependency issues. +* See [AUTOTITLE](/copilot/tutorials/copilot-cookbook/testing-code/generate-unit-tests) and [AUTOTITLE](/copilot/tutorials/copilot-cookbook/testing-code/create-end-to-end-tests) for examples of verifying code with {% data variables.product.prodname_copilot_short %}. ### Example prompts @@ -36,7 +36,7 @@ Check that the AI-generated code fits the purpose and architecture of your proje * Review the AI output for alignment with your requirements and design patterns. * Ask yourself: “Does this code solve the right problem? Does it follow our conventions?” * Use your README, docs, and recent pull requests as a starting point for context for AI. Tell AI what sources to trust, what not to use, and give it good examples to work with. -* Try [AUTOTITLE](/copilot/tutorials/copilot-chat-cookbook/communicate-effectively/synthesizing-research) to see how {% data variables.product.prodname_copilot_short %} uses documentation and research to inform code generation. +* Try [AUTOTITLE](/copilot/tutorials/copilot-cookbook/communicate-effectively/synthesizing-research) to see how {% data variables.product.prodname_copilot_short %} uses documentation and research to inform code generation. * When asking AI to perform research and planning tasks, consider distilling the AI output into structured artifacts to then become context for future AI tasks such as code generation. ### Example prompts @@ -53,7 +53,7 @@ Human standards still matter. * Look for readability, maintainability, and clear naming. * Avoid accepting code that is hard to follow or would take longer to refactor than to rewrite. * Prefer code that is well-documented and includes clear comments. -* Check [AUTOTITLE](/copilot/tutorials/copilot-chat-cookbook/refactor-code/improve-code-readability) for prompts and tips on reviewing and refactoring generated code. +* Check [AUTOTITLE](/copilot/tutorials/copilot-cookbook/refactor-code/improve-code-readability) for prompts and tips on reviewing and refactoring generated code. ### Example prompts @@ -68,7 +68,7 @@ Be vigilant with new packages and libraries. * Check if suggested dependencies exist and are actively maintained. Consider the origins and contributors of new dependencies to ensure they come from reputable, non-competing sources. * Review licensing. Avoid introducing code or dependencies that are incompatible with your project’s license (for example, AGPL-3.0 in a MIT licensed project, or dependencies with no declared license). * Watch out for hallucinated or suspicious packages (such as packages that don't actually exist), or slopsquatting (a theoretical attack on LLMs using fake or malicious packages). -* [AUTOTITLE](/copilot/tutorials/copilot-chat-cookbook/communicate-effectively/creating-templates) demonstrates how {% data variables.product.prodname_copilot_short %} can assist with dependency setup, however it is good practice to always verify suggested packages yourself. +* [AUTOTITLE](/copilot/tutorials/copilot-cookbook/communicate-effectively/creating-templates) demonstrates how {% data variables.product.prodname_copilot_short %} can assist with dependency setup, however it is good practice to always verify suggested packages yourself. * Use [AUTOTITLE](/copilot/concepts/completions/code-referencing) to review matches with publicly available code. ### Example prompts @@ -83,7 +83,7 @@ AI tools can make unique mistakes. * Look for hallucinated APIs, ignored constraints, or incorrect logic. * Watch for tests that are deleted or skipped, instead of fixed. * Be skeptical of code that “looks right” but doesn’t match your intent. -* See [AUTOTITLE](/copilot/tutorials/copilot-chat-cookbook/debug-errors/debug-invalid-json) as an example of catching subtle errors and debugging with {% data variables.product.prodname_copilot_short %}. +* See [AUTOTITLE](/copilot/tutorials/copilot-cookbook/debug-errors/debug-invalid-json) as an example of catching subtle errors and debugging with {% data variables.product.prodname_copilot_short %}. ### Example prompts @@ -98,7 +98,7 @@ Pairing and team input helps catch subtle issues. * Ask teammates to review complex or sensitive changes. * Use checklists to ensure all key review points (functionality, security, maintainability) are covered. * Share successful prompts and patterns for AI use across your team. -* See [AUTOTITLE](/copilot/tutorials/copilot-chat-cookbook/communicate-effectively) for examples of how to work with {% data variables.product.prodname_copilot_short %} collaboratively and document findings. +* See [AUTOTITLE](/copilot/tutorials/copilot-cookbook/communicate-effectively) for examples of how to work with {% data variables.product.prodname_copilot_short %} collaboratively and document findings. ## 7. Automate what you can @@ -117,7 +117,7 @@ Embracing new AI tools and techniques can make your workflow even more effective * Document your best practices for reviewing AI-generated code. * Encourage “AI champions” on your team to share tips and workflows. * Update your onboarding and contribution guides to include your AI review techniques and resources. Use a `CONTRIBUTING.md` file in your repository to document your expectations for AI-generated source code and content, see [AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors). -* Reference [AUTOTITLE](/copilot/tutorials/copilot-chat-cookbook) for inspiration and share useful recipes in your team docs. +* Reference [AUTOTITLE](/copilot/tutorials/copilot-cookbook) for inspiration and share useful recipes in your team docs. ## Further reading diff --git a/content/copilot/tutorials/roll-out-at-scale/assign-licenses/remind-inactive-users.md b/content/copilot/tutorials/roll-out-at-scale/assign-licenses/remind-inactive-users.md index e251d68cc9a6..3572d969fe08 100644 --- a/content/copilot/tutorials/roll-out-at-scale/assign-licenses/remind-inactive-users.md +++ b/content/copilot/tutorials/roll-out-at-scale/assign-licenses/remind-inactive-users.md @@ -42,9 +42,9 @@ In the next section, we'll use this message in an automation that creates an iss > We noticed you haven't used your assigned license for {% data variables.product.prodname_copilot %} in 30 days. Here are some resources that might help you get started: > -> * If you haven't yet set up {% data variables.product.prodname_copilot_short %} in your environment, see [AUTOTITLE](/copilot/setting-up-github-copilot/setting-up-github-copilot-for-yourself) or [AUTOTITLE](/copilot/troubleshooting-github-copilot/troubleshooting-common-issues-with-github-copilot). -> * For best practices and advice on getting started, see [AUTOTITLE](/copilot/using-github-copilot/best-practices-for-using-github-copilot) or [AUTOTITLE](/copilot/using-github-copilot/copilot-chat/prompt-engineering-for-copilot-chat). -> * For examples related to specific tasks, see [AUTOTITLE](/copilot/example-prompts-for-github-copilot-chat). +> * If you haven't yet set up {% data variables.product.prodname_copilot_short %} in your environment, see [AUTOTITLE](/copilot/how-tos/set-up/set-up-for-self) or [AUTOTITLE](/copilot/how-tos/troubleshoot-copilot/troubleshoot-common-issues). +> * For best practices and advice on getting started, see [AUTOTITLE](/copilot/get-started/best-practices) or [AUTOTITLE](/copilot/concepts/prompting/prompt-engineering). +> * For examples related to specific tasks, see [AUTOTITLE](/copilot/tutorials/copilot-cookbook). > > If you no longer need access to {% data variables.product.prodname_copilot_short %}, please let us know in this issue. If your license remains inactive for a further 30 days, we'll revoke it to free up access for another user. @@ -75,7 +75,7 @@ To use this workflow: To create a label, see [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/managing-labels#creating-a-label). 1. Save your reminder message, such as the one provided in [Example reminder in Markdown](#example-reminder-in-markdown), as an {% data variables.product.prodname_actions %} variable in your repository or organization. Call the variable `COPILOT_REMINDER_MESSAGE`. - To create a variable, see [AUTOTITLE](/actions/writing-workflows/choosing-what-your-workflow-does/store-information-in-variables#creating-configuration-variables-for-a-repository). + To create a variable, see [AUTOTITLE](/actions/how-tos/write-workflows/choose-what-workflows-do/use-variables#creating-configuration-variables-for-a-repository). 1. Create a {% data variables.product.pat_generic %} with permission to call the [List all Copilot seat assignments for an organization](/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization) API endpoint. For example, create a fine-grained token with the following details: * **Resource owner**: The organization where you're looking for inactive users. * **Organization permissions**: {% data variables.copilot.copilot_for_business %} (read-only). @@ -83,10 +83,10 @@ To use this workflow: To create a token, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token). 1. Save the access token as a {% data variables.product.prodname_actions %} secret in your repository or organization. Call the secret `COPILOT_LICENSE_READ`. - To create a secret, see [AUTOTITLE](/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository). + To create a secret, see [AUTOTITLE](/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets#creating-secrets-for-a-repository). 1. Using the example below, create the workflow in the repository where you want the reminder issues to be created. - If you're new to {% data variables.product.prodname_actions %}, see [AUTOTITLE](/actions/writing-workflows/quickstart). + If you're new to {% data variables.product.prodname_actions %}, see [AUTOTITLE](/actions/get-started/quickstart). 1. If you want to create the issues in a repository other than the one in which the workflow is located, replace `{% raw %}${{ github.repository }}{% endraw %}` in the `gh` commands with the name of the repository where you want the reminder issues to be created. For example: `octo-org/octo-repo`. ### Example workflow @@ -164,5 +164,5 @@ jobs: ## Further reading * [AUTOTITLE](/copilot/reference/metrics-data#last_activity_at) -* [AUTOTITLE](/copilot/rolling-out-github-copilot-at-scale/driving-copilot-adoption-in-your-company) -* [AUTOTITLE](/copilot/rolling-out-github-copilot-at-scale/analyzing-usage-over-time-with-the-copilot-metrics-api) +* [AUTOTITLE](/copilot/tutorials/roll-out-at-scale/enable-developers/drive-adoption) +* [AUTOTITLE](/copilot/tutorials/roll-out-at-scale/assign-licenses/track-usage-and-adoption) diff --git a/content/copilot/tutorials/roll-out-at-scale/assign-licenses/set-up-self-serve-licenses.md b/content/copilot/tutorials/roll-out-at-scale/assign-licenses/set-up-self-serve-licenses.md index 2a1c216e957e..6f3f9af4423f 100644 --- a/content/copilot/tutorials/roll-out-at-scale/assign-licenses/set-up-self-serve-licenses.md +++ b/content/copilot/tutorials/roll-out-at-scale/assign-licenses/set-up-self-serve-licenses.md @@ -33,7 +33,7 @@ The process, which you should **communicate with users**, is as follows. 1. An organization or enterprise owner ensures {% data variables.copilot.copilot_business_short %} is enabled in the organization where you want to manage access. 1. Members of the organization go to their personal settings page at https://github.com/settings/copilot and click **Ask admin for access**. -1. An organization owner reviews and approves requests on the "Requests from members" page in the organization. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/managing-requests-for-copilot-business-in-your-organization). +1. An organization owner reviews and approves requests on the "Requests from members" page in the organization. See [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/manage-access/manage-requests-for-access). You should set up a process where requests are reviewed regularly, so that interested users can get access to {% data variables.product.prodname_copilot_short %} quickly. @@ -69,7 +69,7 @@ const response = await octokit.request('POST /orgs/{org}/copilot/billing/selecte ## Further reading -* [AUTOTITLE](/copilot/rolling-out-github-copilot-at-scale/driving-copilot-adoption-in-your-company) -* [AUTOTITLE](/copilot/rolling-out-github-copilot-at-scale/reminding-inactive-users) -* [AUTOTITLE](/copilot/rolling-out-github-copilot-at-scale/analyzing-usage-over-time-with-the-copilot-metrics-api) -* [AUTOTITLE](/enterprise-cloud@latest/admin/managing-accounts-and-repositories/managing-organizations-in-your-enterprise/managing-requests-for-copilot-business-from-organizations-in-your-enterprise){% ifversion fpt %} in the {% data variables.product.prodname_ghe_cloud %} documentation{% endif %} +* [AUTOTITLE](/copilot/tutorials/roll-out-at-scale/enable-developers/drive-adoption) +* [AUTOTITLE](/copilot/tutorials/roll-out-at-scale/assign-licenses/remind-inactive-users) +* [AUTOTITLE](/copilot/tutorials/roll-out-at-scale/assign-licenses/track-usage-and-adoption) +* [AUTOTITLE](/enterprise-cloud@latest/admin/managing-accounts-and-repositories/managing-organizations-in-your-enterprise/managing-requests-for-copilot-business){% ifversion fpt %} in the {% data variables.product.prodname_ghe_cloud %} documentation{% endif %} diff --git a/content/copilot/tutorials/roll-out-at-scale/drive-downstream-impact/accelerate-pull-requests.md b/content/copilot/tutorials/roll-out-at-scale/drive-downstream-impact/accelerate-pull-requests.md index d6318cd0de4b..089e3148898d 100644 --- a/content/copilot/tutorials/roll-out-at-scale/drive-downstream-impact/accelerate-pull-requests.md +++ b/content/copilot/tutorials/roll-out-at-scale/drive-downstream-impact/accelerate-pull-requests.md @@ -155,11 +155,11 @@ Developers **should not**: ### Resources -* [AUTOTITLE](/copilot/using-github-copilot/using-github-copilot-for-pull-requests/creating-a-pull-request-summary-with-github-copilot) -* [AUTOTITLE](/copilot/using-github-copilot/code-review/using-copilot-code-review?tool=vscode#reviewing-changes) -* [AUTOTITLE](/copilot/how-tos/configure-custom-instructions/add-repository-instructions) -* [AUTOTITLE](/copilot/how-tos/agents/copilot-code-review/automatic-code-review) -* [AUTOTITLE](/copilot/customizing-copilot/adding-organization-custom-instructions-for-github-copilot) +* [AUTOTITLE](/copilot/how-tos/copilot-on-github/copilot-for-github-tasks/create-a-pr-summary) +* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/request-a-code-review/use-code-review?tool=vscode#reviewing-changes) +* [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-repository-instructions) +* [AUTOTITLE](/copilot/how-tos/copilot-on-github/set-up-copilot/configure-automatic-review) +* [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-organization-instructions) ## Metrics to watch diff --git a/content/copilot/tutorials/roll-out-at-scale/drive-downstream-impact/achieve-company-goals.md b/content/copilot/tutorials/roll-out-at-scale/drive-downstream-impact/achieve-company-goals.md index 545fd020aa06..a01a1b2c74bd 100644 --- a/content/copilot/tutorials/roll-out-at-scale/drive-downstream-impact/achieve-company-goals.md +++ b/content/copilot/tutorials/roll-out-at-scale/drive-downstream-impact/achieve-company-goals.md @@ -27,6 +27,6 @@ Based on the recommendations of the ESSP, the following guides show how {% data We recommend defining your goals and planning your rollout accordingly. You should communicate your goals to staff and organize training to enable everyone to contribute. -* [AUTOTITLE](/copilot/tutorials/rolling-out-github-copilot-at-scale/driving-downstream-impact/increase-test-coverage) -* [AUTOTITLE](/copilot/tutorials/rolling-out-github-copilot-at-scale/driving-downstream-impact/accelerate-pull-requests) -* [AUTOTITLE](/copilot/tutorials/rolling-out-github-copilot-at-scale/driving-downstream-impact/reduce-security-debt) +* [AUTOTITLE](/copilot/tutorials/roll-out-at-scale/drive-downstream-impact/increase-test-coverage) +* [AUTOTITLE](/copilot/tutorials/roll-out-at-scale/drive-downstream-impact/accelerate-pull-requests) +* [AUTOTITLE](/copilot/tutorials/roll-out-at-scale/drive-downstream-impact/reduce-security-debt) diff --git a/content/copilot/tutorials/roll-out-at-scale/drive-downstream-impact/increase-test-coverage.md b/content/copilot/tutorials/roll-out-at-scale/drive-downstream-impact/increase-test-coverage.md index 2c690673dc23..50c5b790cefe 100644 --- a/content/copilot/tutorials/roll-out-at-scale/drive-downstream-impact/increase-test-coverage.md +++ b/content/copilot/tutorials/roll-out-at-scale/drive-downstream-impact/increase-test-coverage.md @@ -124,17 +124,17 @@ Developers **should not**: ### Resources for developers -* [AUTOTITLE](/copilot/using-github-copilot/guides-on-using-github-copilot/writing-tests-with-github-copilot) +* [AUTOTITLE](/copilot/tutorials/write-tests) * [How to generate unit tests with {% data variables.product.prodname_copilot %}: Tips and examples](https://github.blog/ai-and-ml/github-copilot/how-to-generate-unit-tests-with-github-copilot-tips-and-examples/) * [{% data variables.product.prodname_copilot %} is EVERYWHERE in Visual Studio](https://learn.microsoft.com/en-us/shows/github-copilot-for-visual-studio/github-copilot-is-everywhere-in-visual-studio-miniseries) (video content with a section on testing) -* [AUTOTITLE](/copilot/using-github-copilot/copilot-chat/prompt-engineering-for-copilot-chat) -* [AUTOTITLE](/copilot/using-github-copilot/ai-models/changing-the-ai-model-for-copilot-chat) +* [AUTOTITLE](/copilot/concepts/prompting/prompt-engineering) +* [AUTOTITLE](/copilot/how-tos/use-ai-models/change-the-chat-model) ### Recommended features -* [{% data variables.copilot.copilot_chat_dotcom_short %}](/copilot/using-github-copilot/copilot-chat/asking-github-copilot-questions-in-github) -* [{% data variables.product.prodname_copilot_short %} inline suggestions](/copilot/using-github-copilot/getting-code-suggestions-in-your-ide-with-github-copilot) -* [{% data variables.copilot.copilot_chat_short %} in the IDE](/copilot/using-github-copilot/copilot-chat/asking-github-copilot-questions-in-your-ide) +* [{% data variables.copilot.copilot_chat_dotcom_short %}](/copilot/how-tos/copilot-on-github/chat-with-copilot/chat-in-github) +* [{% data variables.product.prodname_copilot_short %} inline suggestions](/copilot/how-tos/get-code-suggestions/get-ide-code-suggestions) +* [{% data variables.copilot.copilot_chat_short %} in the IDE](/copilot/how-tos/chat-with-copilot/chat-in-ide) * [{% data variables.copilot.copilot_cloud_agent %}](/copilot/concepts/agents/cloud-agent/about-cloud-agent) ## Metrics to watch diff --git a/content/copilot/tutorials/roll-out-at-scale/drive-downstream-impact/reduce-security-debt.md b/content/copilot/tutorials/roll-out-at-scale/drive-downstream-impact/reduce-security-debt.md index c6ec0061c4f9..bcd55f354728 100644 --- a/content/copilot/tutorials/roll-out-at-scale/drive-downstream-impact/reduce-security-debt.md +++ b/content/copilot/tutorials/roll-out-at-scale/drive-downstream-impact/reduce-security-debt.md @@ -122,8 +122,8 @@ Developers **should not**: ### Resources for developers -* [{% data variables.copilot.copilot_chat_dotcom_short %}](/copilot/using-github-copilot/copilot-chat/asking-github-copilot-questions-in-github) -* [AUTOTITLE](/copilot/copilot-chat-cookbook/security-analysis/finding-existing-vulnerabilities-in-code) +* [{% data variables.copilot.copilot_chat_dotcom_short %}](/copilot/how-tos/copilot-on-github/chat-with-copilot/chat-in-github) +* [AUTOTITLE](/copilot/tutorials/copilot-cookbook/analyze-security/find-vulnerabilities) * [{% data variables.product.prodname_learning %} - Getting Started with {% data variables.product.prodname_copilot %}](https://github.com/skills/getting-started-with-github-copilot) ## Metrics to watch @@ -133,4 +133,4 @@ Developers **should not**: * **Security debt ratio**. Use security overview to see if the number of alerts falls over time. * **Time to remediate security issues**. Use security overview to see if the time to remediate security issues falls over time. -See [AUTOTITLE](/code-security/security-overview/assessing-code-security-risk). +See [AUTOTITLE](/code-security/how-tos/view-and-interpret-data/analyze-organization-data/assessing-code-security-risk). diff --git a/content/copilot/tutorials/roll-out-at-scale/enable-developers/drive-adoption.md b/content/copilot/tutorials/roll-out-at-scale/enable-developers/drive-adoption.md index 7cb292239f07..100e40df15cf 100644 --- a/content/copilot/tutorials/roll-out-at-scale/enable-developers/drive-adoption.md +++ b/content/copilot/tutorials/roll-out-at-scale/enable-developers/drive-adoption.md @@ -28,7 +28,7 @@ The {% data variables.product.prodname_copilot %} enablement process can be brok ## Prerequisites -* {% data variables.product.prodname_copilot %} must be set up in your {% ifversion ghec %}enterprise and {% endif %}organization. For more information, see {% ifversion ghec %}[AUTOTITLE](/copilot/setting-up-github-copilot/setting-up-github-copilot-for-your-enterprise) and {% endif %}[AUTOTITLE](/copilot/setting-up-github-copilot/setting-up-github-copilot-for-your-organization). +* {% data variables.product.prodname_copilot %} must be set up in your {% ifversion ghec %}enterprise and {% endif %}organization. For more information, see {% ifversion ghec %}[AUTOTITLE](/copilot/how-tos/copilot-on-github/set-up-copilot/enable-copilot/set-up-for-enterprise) and {% endif %}[AUTOTITLE](/copilot/how-tos/copilot-on-github/set-up-copilot/enable-copilot/set-up-for-organization). ## Example rollout timeline @@ -42,7 +42,7 @@ For optimal {% data variables.product.prodname_copilot_short %} adoption, tailor ## Granting licenses -Before you can drive adoption of {% data variables.product.prodname_copilot %}, you need to ensure that your teams have access to the product. For more information, 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). +Before you can drive adoption of {% data variables.product.prodname_copilot %}, you need to ensure that your teams have access to the product. For more information, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/manage-access/grant-access). Depending on the size of your organization, you may want to start with a small pilot program. This will allow you to test your enablement process and make any necessary adjustments before rolling it out to the rest of your organization. @@ -52,12 +52,12 @@ You can start by identifying a small number of teams that are interested in usin ## Supporting users setting up their environment -Once your teams have access to {% data variables.product.prodname_copilot %}, ensure they're confident with setting up their environment. {% data variables.product.github %} provides comprehensive documentation to help users set up their environment and resolve common issues. See [AUTOTITLE](/copilot/setting-up-github-copilot/setting-up-github-copilot-for-yourself) and [AUTOTITLE](/copilot/troubleshooting-github-copilot). +Once your teams have access to {% data variables.product.prodname_copilot %}, ensure they're confident with setting up their environment. {% data variables.product.github %} provides comprehensive documentation to help users set up their environment and resolve common issues. See [AUTOTITLE](/copilot/how-tos/set-up/set-up-for-self) and [AUTOTITLE](/copilot/how-tos/troubleshoot-copilot). If your company uses a corporate proxy or firewall, there are additional steps for ensuring users can connect to {% data variables.product.prodname_copilot %}: -* Ensure that key URLs are added to the allowlist for the proxy server or firewall. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/configuring-your-proxy-server-or-firewall-for-copilot). -* Provide guidance for your users to set up their environment to connect via your proxy. You may also need to install custom SSL certificates on your users' machines. See [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/configuring-network-settings-for-github-copilot). +* Ensure that key URLs are added to the allowlist for the proxy server or firewall. See [AUTOTITLE](/copilot/reference/copilot-allowlist-reference). +* Provide guidance for your users to set up their environment to connect via your proxy. You may also need to install custom SSL certificates on your users' machines. See [AUTOTITLE](/copilot/how-tos/configure-personal-settings/configure-network-settings). For more complex issues, you may also choose to designate an internal point of contact to help users resolve issues, or escalate them to {% data variables.contact.github_support %}. You should choose a point of contact who is confident troubleshooting firewall and network configuration issues. @@ -65,7 +65,7 @@ For more complex issues, you may also choose to designate an internal point of c This section offers examples of how you can support effective use of {% data variables.product.prodname_copilot_short %}. You can use these examples as a starting point and adapt them to meet your organization's needs and goals. -To drive and measure downstream impact of {% data variables.product.prodname_copilot_short %}, {% data variables.product.company_short %} recommends leading your rollout with specific engineering goals in mind. You should communicate your goals to staff and organize training accordingly. See [AUTOTITLE](/copilot/get-started/achieve-engineering-goals). +To drive and measure downstream impact of {% data variables.product.prodname_copilot_short %}, {% data variables.product.company_short %} recommends leading your rollout with specific engineering goals in mind. You should communicate your goals to staff and organize training accordingly. See [AUTOTITLE](/copilot/tutorials/roll-out-at-scale/drive-downstream-impact/achieve-company-goals). ### Creating onboarding resources @@ -73,10 +73,10 @@ You may choose to create internal onboarding materials to help teams get started {% data variables.product.github %} documentation that you may want to feature in your onboarding materials includes: -* [AUTOTITLE](/copilot/using-github-copilot/best-practices-for-using-github-copilot) -* [AUTOTITLE](/copilot/using-github-copilot/copilot-chat/prompt-engineering-for-copilot-chat) -* [AUTOTITLE](/copilot/using-github-copilot/getting-code-suggestions-in-your-ide-with-github-copilot) -* [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide) +* [AUTOTITLE](/copilot/get-started/best-practices) +* [AUTOTITLE](/copilot/concepts/prompting/prompt-engineering) +* [AUTOTITLE](/copilot/how-tos/get-code-suggestions/get-ide-code-suggestions) +* [AUTOTITLE](/copilot/how-tos/chat-with-copilot/chat-in-ide) You can also create a {% data variables.product.github %} repository to store these materials, and encourage teams to contribute their own resources and best practices. This can help foster a sense of community among teams that are using {% data variables.product.prodname_copilot_short %}, and make it easier for new teams to get started. @@ -117,20 +117,20 @@ The following sections provide practical examples for helping teams to start usi ### Providing learning resources -In addition to your onboarding resources, you may want to provide a library of learning resources to help teams advance their skills with {% data variables.product.prodname_copilot_short %}. The {% data variables.copilot.copilot_chat_short %} Cookbook is a great place to start. The Cookbook is a collection of example prompts that you can use to learn how to ask {% data variables.product.prodname_copilot_short %} for help with a wide range of tasks. See [AUTOTITLE](/copilot/copilot-chat-cookbook). +In addition to your onboarding resources, you may want to provide a library of learning resources to help teams advance their skills with {% data variables.product.prodname_copilot_short %}. The {% data variables.copilot.copilot_chat_short %} Cookbook is a great place to start. The Cookbook is a collection of example prompts that you can use to learn how to ask {% data variables.product.prodname_copilot_short %} for help with a wide range of tasks. See [AUTOTITLE](/copilot/tutorials/copilot-cookbook). ### Communicating expectations If your organization has specific {% data variables.product.prodname_copilot_short %} usage guidelines, these should be clearly communicated in onboarding materials and anywhere else that teams might look for information. For example, if you plan to revoke access to {% data variables.product.prodname_copilot_short %} for users who have not used it in a certain period of time, ensure that your users are aware of this policy. -Many users may not be aware of all of {% data variables.product.prodname_copilot_short %}'s capabilities. You should offer guidance on how you expect the different features to fit into your organization's workflows, and provide training to support this. For an end-to-end example, see [AUTOTITLE](/copilot/rolling-out-github-copilot-at-scale/enabling-developers/integrating-agentic-ai). +Many users may not be aware of all of {% data variables.product.prodname_copilot_short %}'s capabilities. You should offer guidance on how you expect the different features to fit into your organization's workflows, and provide training to support this. For an end-to-end example, see [AUTOTITLE](/copilot/tutorials/roll-out-at-scale/enable-developers/integrate-ai-agents). ### Ongoing analysis and optimization Once you have implemented your {% data variables.product.prodname_copilot_short %} enablement process, you should regularly review and optimize it to ensure it continues to meet your organization's needs. Some ways you can do this are: -* Monitoring usage data to identify trends and patterns. See [AUTOTITLE](/copilot/rolling-out-github-copilot-at-scale/analyzing-usage-over-time-with-the-copilot-metrics-api). -* Following up with users who haven't been using their assigned license. You can use the API to see the latest activity date for each assigned seat. See [AUTOTITLE](/copilot/rolling-out-github-copilot-at-scale/reminding-inactive-users). +* Monitoring usage data to identify trends and patterns. See [AUTOTITLE](/copilot/tutorials/roll-out-at-scale/assign-licenses/track-usage-and-adoption). +* Following up with users who haven't been using their assigned license. You can use the API to see the latest activity date for each assigned seat. See [AUTOTITLE](/copilot/tutorials/roll-out-at-scale/assign-licenses/remind-inactive-users). * Gathering feedback from teams to understand what is working well and what could be improved. * Reviewing {% data variables.product.prodname_discussions %} and other communication channels to identify common issues and questions. * Iterating on your enablement process based on lessons learned. diff --git a/content/copilot/tutorials/roll-out-at-scale/govern-at-scale/govern-for-adoption.md b/content/copilot/tutorials/roll-out-at-scale/govern-at-scale/govern-for-adoption.md index 860c467e535a..5e5849d860f2 100644 --- a/content/copilot/tutorials/roll-out-at-scale/govern-at-scale/govern-for-adoption.md +++ b/content/copilot/tutorials/roll-out-at-scale/govern-at-scale/govern-for-adoption.md @@ -23,7 +23,7 @@ Policy decisions work best when they're informed by practical experience with AI This approach reduces bottlenecks and helps ensure that the people setting policies understand how developers actually work with {% data variables.product.prodname_copilot_short %}. -For step-by-step instructions on creating an AI manager role, see [AUTOTITLE](/copilot/tutorials/roll-out-at-scale/establish-ai-managers). +For step-by-step instructions on creating an AI manager role, see [AUTOTITLE](/copilot/tutorials/roll-out-at-scale/govern-at-scale/establish-ai-managers). ## Review and enable features promptly diff --git a/content/copilot/tutorials/roll-out-at-scale/govern-at-scale/maintain-codebase-standards.md b/content/copilot/tutorials/roll-out-at-scale/govern-at-scale/maintain-codebase-standards.md index d1659673632d..b561b05e5c9a 100644 --- a/content/copilot/tutorials/roll-out-at-scale/govern-at-scale/maintain-codebase-standards.md +++ b/content/copilot/tutorials/roll-out-at-scale/govern-at-scale/maintain-codebase-standards.md @@ -54,7 +54,7 @@ Good DevOps practices ensure that your code is automatically tested before being However, it is good practice to regularly scan all code for vulnerabilities and secrets, and to prevent developers from introducing vulnerabilities in the first place. -1. As a starting point, apply and enforce a basic **security configuration** on your organizations. This is a collection of enablement settings for security features. We recommend including {% data variables.product.prodname_code_scanning %}, {% data variables.product.prodname_secret_scanning %}, and secrets push protection. See [AUTOTITLE](/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/creating-a-custom-security-configuration#creating-a-secret-protection-and-code-security-configuration). +1. As a starting point, apply and enforce a basic **security configuration** on your organizations. This is a collection of enablement settings for security features. We recommend including {% data variables.product.prodname_code_scanning %}, {% data variables.product.prodname_secret_scanning %}, and secrets push protection. See [AUTOTITLE](/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/create-custom-configuration#creating-a-secret-protection-and-code-security-configuration). 1. As you learn more about your needs, create additional custom configurations or apply granular settings at the repository level. 1. To enforce {% data variables.product.prodname_code_scanning %} on pull requests, go back to your ruleset and enable the **Require {% data variables.product.prodname_code_scanning %} results** rule. @@ -62,15 +62,15 @@ However, it is good practice to regularly scan all code for vulnerabilities and To improve the quality of {% data variables.product.prodname_copilot_short %}'s suggestions in the first place, you should create custom instructions. These instructions add context to all prompts that tells {% data variables.product.prodname_copilot_short %} to follow your company's coding standards. -1. To establish a good baseline, create **custom instructions at the organization level**. These can be high-level standards that are likely to apply to any repository. However, note that these instructions only apply on the {% data variables.product.github %} website. See [AUTOTITLE](/copilot/how-tos/configure-custom-instructions/add-organization-instructions). -1. For more complete coverage, encourage developers and repository administrators to **write custom instructions for specific repositories**. These apply in more places than organization instructions, and can go into more detail about each project and its requirements. See [AUTOTITLE](/copilot/how-tos/configure-custom-instructions/add-repository-instructions). +1. To establish a good baseline, create **custom instructions at the organization level**. These can be high-level standards that are likely to apply to any repository. However, note that these instructions only apply on the {% data variables.product.github %} website. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-organization-instructions). +1. For more complete coverage, encourage developers and repository administrators to **write custom instructions for specific repositories**. These apply in more places than organization instructions, and can go into more detail about each project and its requirements. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-repository-instructions). ## 5. Encourage best practices With strong guardrails in place, developers should already be enabled to use AI effectively. However, it is important to provide training on AI tools and create a culture where best practices are encouraged, rather than just enforced. 1. Communicate your governance settings and your company's expectations for how developers should use {% data variables.product.prodname_copilot_short %}. For example, if all agent work should be thoroughly reviewed, ensure this process is established and communicated. -1. Create onboarding resources such as internal documentation or videos. For a starting point, share existing resources like [AUTOTITLE](/copilot/using-github-copilot/best-practices-for-using-github-copilot) and [AUTOTITLE](/copilot/copilot-chat-cookbook). +1. Create onboarding resources such as internal documentation or videos. For a starting point, share existing resources like [AUTOTITLE](/copilot/get-started/best-practices) and [AUTOTITLE](/copilot/tutorials/copilot-cookbook). 1. Offer ongoing training and support, such as workshops. In successful rollouts, many companies identify "champions" who can train others on how to use {% data variables.product.prodname_copilot_short %} effectively. ## 6. Plan for the worst diff --git a/content/copilot/tutorials/spark/build-apps-with-spark.md b/content/copilot/tutorials/spark/build-apps-with-spark.md index 113b79c11ba0..00daa3a41ff8 100644 --- a/content/copilot/tutorials/spark/build-apps-with-spark.md +++ b/content/copilot/tutorials/spark/build-apps-with-spark.md @@ -17,7 +17,7 @@ category: > [!NOTE] > * {% data reusables.spark.preview-note-spark %} -> * The {% data variables.product.prodname_copilot %} setting that blocks suggestions matching public code may not work as intended when using {% data variables.product.prodname_spark_short %}. See [AUTOTITLE](/copilot/how-tos/manage-your-account/managing-copilot-policies-as-an-individual-subscriber#enabling-or-disabling-suggestions-matching-public-code). +> * The {% data variables.product.prodname_copilot %} setting that blocks suggestions matching public code may not work as intended when using {% data variables.product.prodname_spark_short %}. See [AUTOTITLE](/copilot/how-tos/manage-your-account/manage-policies#enabling-or-disabling-suggestions-matching-public-code). ## Introduction @@ -185,6 +185,6 @@ Explore more ideas you can build with {% data variables.product.prodname_spark_s ## Further reading -* [AUTOTITLE](/copilot/responsible-use-of-github-copilot-features/responsible-use-of-github-spark) -* [AUTOTITLE](/copilot/concepts/copilot-billing/about-billing-for-github-spark) +* [AUTOTITLE](/copilot/responsible-use/agents) +* [AUTOTITLE](/billing/concepts/product-billing/github-spark) * [AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-pre-release-license-terms) diff --git a/content/copilot/tutorials/spark/deploy-from-cli.md b/content/copilot/tutorials/spark/deploy-from-cli.md index ff92e7d08cef..f5924fd3bfc7 100644 --- a/content/copilot/tutorials/spark/deploy-from-cli.md +++ b/content/copilot/tutorials/spark/deploy-from-cli.md @@ -18,7 +18,7 @@ If you’re developing your spark further in a {% data variables.product.github ### Prerequisites -* **Access to {% data variables.product.prodname_copilot %}**. You need a {% data variables.copilot.copilot_pro_plus_short %}, {% data variables.copilot.copilot_max_short %}, or {% data variables.copilot.copilot_enterprise_short %} license to use {% data variables.product.prodname_spark_short %}. See [AUTOTITLE](/copilot/about-github-copilot/what-is-github-copilot#getting-access-to-copilot). +* **Access to {% data variables.product.prodname_copilot %}**. You need a {% data variables.copilot.copilot_pro_plus_short %}, {% data variables.copilot.copilot_max_short %}, or {% data variables.copilot.copilot_enterprise_short %} license to use {% data variables.product.prodname_spark_short %}. See [AUTOTITLE](/copilot/get-started/what-is-github-copilot#getting-access-to-copilot). * You must have **built a {% data variables.product.prodname_spark_short %} app** (a "spark"). To start building, navigate to [{% data variables.product.prodname_spark_short %}](https://github.com/spark). * You have **created a repository** for your spark on {% data variables.product.github %}. For instructions, see [AUTOTITLE](/copilot/tutorials/spark/build-apps-with-spark#step-8-invite-collaborators-with-a-repository). diff --git a/content/copilot/tutorials/spark/your-first-spark.md b/content/copilot/tutorials/spark/your-first-spark.md index 9c079f23b594..3c3baa42a636 100644 --- a/content/copilot/tutorials/spark/your-first-spark.md +++ b/content/copilot/tutorials/spark/your-first-spark.md @@ -89,5 +89,5 @@ We just created a word search app, but {% data variables.product.prodname_spark_ ## Further reading -* [AUTOTITLE](/copilot/responsible-use-of-github-copilot-features/responsible-use-of-github-spark) -* [AUTOTITLE](/copilot/concepts/copilot-billing/about-billing-for-github-spark) +* [AUTOTITLE](/copilot/responsible-use/agents) +* [AUTOTITLE](/billing/concepts/product-billing/github-spark) diff --git a/content/copilot/tutorials/speed-up-development-work.md b/content/copilot/tutorials/speed-up-development-work.md index 674eebb98e4d..8a8fa0cb4a49 100644 --- a/content/copilot/tutorials/speed-up-development-work.md +++ b/content/copilot/tutorials/speed-up-development-work.md @@ -91,4 +91,4 @@ Try the [Scale institutional knowledge using Copilot Spaces](https://github.com/ ## Next steps -After you create a space to help with development tasks, consider sharing it with your team to reduce handoffs and repeated questions. See [AUTOTITLE](/copilot/using-github-copilot/copilot-spaces/collaborating-with-your-team-using-copilot-spaces). +After you create a space to help with development tasks, consider sharing it with your team to reduce handoffs and repeated questions. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/copilot-spaces/collaborate-with-others). diff --git a/content/copilot/tutorials/use-an-ai-sme.md b/content/copilot/tutorials/use-an-ai-sme.md index 0ce79949340b..cdbe4a557123 100644 --- a/content/copilot/tutorials/use-an-ai-sme.md +++ b/content/copilot/tutorials/use-an-ai-sme.md @@ -34,7 +34,7 @@ The tutorial assumes you're comfortable working in a terminal and reading code i Before you start, make sure you have: -* A {% data variables.product.prodname_copilot %} subscription. See [AUTOTITLE](/copilot/about-github-copilot/subscription-plans-for-github-copilot). +* A {% data variables.product.prodname_copilot %} subscription. See [AUTOTITLE](/copilot/get-started/plans). * {% data variables.copilot.copilot_cli_short %} installed and authenticated. See [AUTOTITLE](/copilot/how-tos/copilot-cli/cli-getting-started). * A local clone of the repository you want to explore. See [AUTOTITLE](/repositories/creating-and-managing-repositories/cloning-a-repository?tool=webui). diff --git a/content/copilot/tutorials/vibe-coding.md b/content/copilot/tutorials/vibe-coding.md index 28d1188dec28..86ba18cef3c7 100644 --- a/content/copilot/tutorials/vibe-coding.md +++ b/content/copilot/tutorials/vibe-coding.md @@ -36,7 +36,7 @@ There are many variables that may affect how long you might take to complete thi ## Prerequisites Before getting started you must have the following: -* A [{% data variables.product.prodname_copilot %} subscription plan](/copilot/about-github-copilot/subscription-plans-for-github-copilot). +* A [{% data variables.product.prodname_copilot %} subscription plan](/copilot/get-started/plans). * One of these IDEs: * {% data variables.product.prodname_vscode %} * Any JetBrains IDE that supports {% data variables.product.prodname_copilot_short %}, with the {% data variables.product.prodname_copilot %} extension for JetBrains installed. See [AUTOTITLE](/copilot/how-tos/set-up/install-copilot-extension?tool=jetbrains). diff --git a/content/copilot/tutorials/write-tests.md b/content/copilot/tutorials/write-tests.md index 930f391af18f..6c95402cee8d 100644 --- a/content/copilot/tutorials/write-tests.md +++ b/content/copilot/tutorials/write-tests.md @@ -21,9 +21,9 @@ category: ## Prerequisites Before getting started you must have the following: -* A [{% data variables.product.prodname_copilot %} subscription plan](/copilot/about-github-copilot/subscription-plans-for-github-copilot). +* A [{% data variables.product.prodname_copilot %} subscription plan](/copilot/get-started/plans). * {% data variables.product.prodname_vs %}, {% data variables.product.prodname_vscode %}, or any JetBrains IDE. -* The [{% data variables.product.prodname_copilot %} extension](/copilot/managing-copilot/configure-personal-settings/installing-the-github-copilot-extension-in-your-environment) installed in your IDE. +* The [{% data variables.product.prodname_copilot %} extension](/copilot/how-tos/set-up/install-copilot-extension) installed in your IDE. ## Writing unit tests with {% data variables.copilot.copilot_chat_short %} @@ -337,4 +337,4 @@ Or: > Write a unit test for the refund logic in `refund.js`, following the structure in the existing test suite. -For more information about using {% data variables.copilot.copilot_spaces %}, see [AUTOTITLE](/copilot/using-github-copilot/copilot-spaces/about-organizing-and-sharing-context-with-copilot-spaces). +For more information about using {% data variables.copilot.copilot_spaces %}, see [AUTOTITLE](/copilot/concepts/context/spaces). From 17ce5013e1c2fc297d83bfc79f26fe6b59156fcc Mon Sep 17 00:00:00 2001 From: Kevin Heis Date: Thu, 9 Jul 2026 11:30:12 -0700 Subject: [PATCH 10/15] Update redirected internal links in copilot (how-tos (part 3)) (#62163) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../copilot/how-tos/set-up/set-up-for-self.md | 24 +++++++++---------- .../troubleshoot-common-issues.md | 14 +++++------ .../troubleshoot-firewall-settings.md | 2 +- .../troubleshoot-network-errors.md | 16 ++++++------- .../how-tos/troubleshoot-copilot/view-logs.md | 6 ++--- .../use-ai-models/change-the-chat-model.md | 6 ++--- ...integrate-cloud-agent-with-azure-boards.md | 2 +- .../integrate-cloud-agent-with-jira.md | 6 ++--- .../integrate-cloud-agent-with-linear.md | 2 +- .../integrate-cloud-agent-with-slack.md | 2 +- .../integrate-cloud-agent-with-teams.md | 2 +- .../cloud-agent/troubleshoot-cloud-agent.md | 10 ++++---- .../cloud-agent/use-cloud-agent-on-github.md | 2 +- .../cloud-agent/use-cloud-agent-with-mcp.md | 2 +- .../request-a-code-review/use-code-review.md | 4 ++-- .../use-copilot-in-the-cli.md | 2 +- 16 files changed, 51 insertions(+), 51 deletions(-) diff --git a/content/copilot/how-tos/set-up/set-up-for-self.md b/content/copilot/how-tos/set-up/set-up-for-self.md index cc388a04c2a0..2e337d0f5fe8 100644 --- a/content/copilot/how-tos/set-up/set-up-for-self.md +++ b/content/copilot/how-tos/set-up/set-up-for-self.md @@ -18,7 +18,7 @@ category: There are a few ways that you can get access to {% data variables.product.prodname_copilot %}: -* **Use {% data variables.copilot.copilot_free_short %}**. Get a limited experience of {% data variables.product.prodname_copilot_short %} with up to 2,000 inline suggestion requests and limited chat and agent usage-no paid plan required. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/about-github-copilot-free). +* **Use {% data variables.copilot.copilot_free_short %}**. Get a limited experience of {% data variables.product.prodname_copilot_short %} with up to 2,000 inline suggestion requests and limited chat and agent usage-no paid plan required. See [AUTOTITLE](/copilot/concepts/billing/individual-plans). * **Sign up for a paid plan**. You can subscribe to one of these plans: @@ -30,38 +30,38 @@ There are a few ways that you can get access to {% data variables.product.prodna * **Verified students** can sign up to {% data variables.copilot.copilot_student_short %} to access {% data variables.product.prodname_copilot_short %} for free. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/set-up-copilot/enable-copilot/set-up-for-students). -* **Verified teachers or open source maintainers** may be eligible to use {% data variables.product.prodname_copilot_short %} for free. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/getting-free-access-to-copilot-as-a-student-teacher-or-maintainer). +* **Verified teachers or open source maintainers** may be eligible to use {% data variables.product.prodname_copilot_short %} for free. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/set-up-copilot/enable-copilot/set-up-for-teachers-and-os-maintainers). ## 2. Install the {% data variables.product.prodname_copilot_short %} extension for your IDE -If you want to use {% data variables.product.prodname_copilot_short %} in your IDE, install the {% data variables.product.prodname_copilot_short %} extension for your IDE. See [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/installing-the-github-copilot-extension-in-your-environment). +If you want to use {% data variables.product.prodname_copilot_short %} in your IDE, install the {% data variables.product.prodname_copilot_short %} extension for your IDE. See [AUTOTITLE](/copilot/how-tos/set-up/install-copilot-extension). ## 3. Install the {% data variables.product.prodname_copilot_short %} extension for the command line -If you want to use {% data variables.product.prodname_copilot_short %} in the command line, install the {% data variables.product.prodname_copilot_short %} extension for the {% data variables.product.prodname_cli %}. See [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/installing-github-copilot-in-the-cli). +If you want to use {% data variables.product.prodname_copilot_short %} in the command line, install the {% data variables.product.prodname_copilot_short %} extension for the {% data variables.product.prodname_cli %}. See [AUTOTITLE](/copilot/how-tos/copilot-cli/set-up-copilot-cli/install-copilot-cli). ## 4. Use {% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_windows_terminal %} -If you want to chat with {% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_windows_terminal %}, connect {% data variables.product.prodname_copilot_short %} with Terminal Chat in {% data variables.product.prodname_windows_terminal %} Canary. See [AUTOTITLE](/copilot/quickstart?tool=windowsterminal). +If you want to chat with {% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_windows_terminal %}, connect {% data variables.product.prodname_copilot_short %} with Terminal Chat in {% data variables.product.prodname_windows_terminal %} Canary. See [AUTOTITLE](/copilot/get-started/quickstart?tool=windowsterminal). ## 5. Set up networking (if necessary) -If you connect through an HTTP proxy server or firewall, ensure that key URLs are added to the allowlist for the proxy server or firewall. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/configuring-your-proxy-server-or-firewall-for-copilot). +If you connect through an HTTP proxy server or firewall, ensure that key URLs are added to the allowlist for the proxy server or firewall. See [AUTOTITLE](/copilot/reference/copilot-allowlist-reference). -You may also need to install a custom SSL certificate on your machine. See [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/configuring-network-settings-for-github-copilot#installing-custom-certificates). +You may also need to install a custom SSL certificate on your machine. See [AUTOTITLE](/copilot/how-tos/configure-personal-settings/configure-network-settings#installing-custom-certificates). ## 6. Configure settings (optional) -All users can configure {% data variables.product.prodname_copilot_short %} settings in their IDE. See [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/configuring-github-copilot-in-your-environment). +All users can configure {% data variables.product.prodname_copilot_short %} settings in their IDE. See [AUTOTITLE](/copilot/how-tos/configure-personal-settings/configure-in-ide). If you have your own {% data variables.product.prodname_copilot_short %} plan (instead of using your organization or enterprise's plan), you can: -* **Install Model Context Protocol (MCP) servers** to integrate with {% data variables.copilot.copilot_chat_short %}. See [AUTOTITLE](/copilot/how-tos/context/model-context-protocol/extending-copilot-chat-with-mcp). -* **Manage policies**. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-copilot-policies-as-an-individual-subscriber). +* **Install Model Context Protocol (MCP) servers** to integrate with {% data variables.copilot.copilot_chat_short %}. See [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp-in-your-ide/extend-copilot-chat-with-mcp). +* **Manage policies**. See [AUTOTITLE](/copilot/how-tos/manage-your-account/manage-policies). * **Enable {% data variables.copilot.copilot_memory %}**, which allows {% data variables.product.prodname_copilot_short %} to generate and store useful information about your repositories. See [AUTOTITLE](/copilot/concepts/agents/copilot-memory). ## 7. Start using {% data variables.product.prodname_copilot_short %} -Start using {% data variables.product.prodname_copilot_short %} to help you write code faster and more efficiently. For all the ways you can use {% data variables.product.prodname_copilot_short %}, see [AUTOTITLE](/copilot/using-github-copilot). {% data variables.product.prodname_copilot_short %} code suggestions, {% data variables.copilot.copilot_chat_dotcom_short %}, and {% data variables.copilot.copilot_chat_short %} in your IDE are a great place to start. +Start using {% data variables.product.prodname_copilot_short %} to help you write code faster and more efficiently. For all the ways you can use {% data variables.product.prodname_copilot_short %}, see [AUTOTITLE](/copilot/how-tos). {% data variables.product.prodname_copilot_short %} code suggestions, {% data variables.copilot.copilot_chat_dotcom_short %}, and {% data variables.copilot.copilot_chat_short %} in your IDE are a great place to start. -To learn how to best use {% data variables.product.prodname_copilot_short %}, see [AUTOTITLE](/copilot/using-github-copilot/best-practices-for-using-github-copilot) and [AUTOTITLE](/copilot/using-github-copilot/copilot-chat/prompt-engineering-for-copilot-chat). +To learn how to best use {% data variables.product.prodname_copilot_short %}, see [AUTOTITLE](/copilot/get-started/best-practices) and [AUTOTITLE](/copilot/concepts/prompting/prompt-engineering). diff --git a/content/copilot/how-tos/troubleshoot-copilot/troubleshoot-common-issues.md b/content/copilot/how-tos/troubleshoot-copilot/troubleshoot-common-issues.md index 49d21694d432..9ff7d1461170 100644 --- a/content/copilot/how-tos/troubleshoot-copilot/troubleshoot-common-issues.md +++ b/content/copilot/how-tos/troubleshoot-copilot/troubleshoot-common-issues.md @@ -24,13 +24,13 @@ If {% data variables.product.prodname_copilot %} stops working, check {% data va ## Unable to use the {% data variables.product.prodname_copilot %} extension in the IDE -We recommend you follow the quickstart guide for {% data variables.product.prodname_copilot %} while setting up {% data variables.product.prodname_copilot %} on your machine. For more information, see [AUTOTITLE](/copilot/quickstart). +We recommend you follow the quickstart guide for {% data variables.product.prodname_copilot %} while setting up {% data variables.product.prodname_copilot %} on your machine. For more information, see [AUTOTITLE](/copilot/get-started/quickstart). The {% data variables.product.prodname_copilot %} extension is frequently updated to fix bugs and add new features. It's important to keep your extension up to date because older clients cannot communicate with the {% data variables.product.prodname_copilot %} servers. Update your {% data variables.product.prodname_copilot %} extension on all the machines you have it installed. -{% data reusables.copilot.sign-in-ghecom %} See [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/using-github-copilot-with-an-account-on-ghecom). +{% data reusables.copilot.sign-in-ghecom %} See [AUTOTITLE](/copilot/how-tos/configure-personal-settings/authenticate-to-ghecom). -For more information about configuring {% data variables.product.prodname_copilot %} in a supported IDE, see [AUTOTITLE](/copilot/configuring-github-copilot/configuring-github-copilot-in-your-environment). +For more information about configuring {% data variables.product.prodname_copilot %} in a supported IDE, see [AUTOTITLE](/copilot/how-tos/configure-personal-settings/configure-in-ide). ## {% data variables.product.prodname_copilot %} not working in some files @@ -46,7 +46,7 @@ Content exclusion can be configured at the repository{% ifversion ghec %}, organ {% data reusables.copilot.content-exclusions-scope %} -{% data reusables.copilot.content-exclusions-delay %} For more information, see [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-github-copilot-features-in-your-organization/testing-changes-to-content-exclusions-in-your-ide#propagating-content-exclusion-changes-to-your-ide). +{% data reusables.copilot.content-exclusions-delay %} For more information, see [AUTOTITLE](/copilot/how-tos/configure-content-exclusion/exclude-content-from-copilot#propagate-content-exclusion-changes-to-your-ide). > [!NOTE] > {% data reusables.copilot.content-exclusion-limitations %} @@ -57,7 +57,7 @@ This error indicates that you do not have a {% data variables.product.prodname_c To request another token from api.github.com, try signing in and out of {% data variables.product.prodname_copilot_short %} from your IDE. Once you've logged out, {% data variables.product.prodname_copilot_short %} will prompt you to sign back in. -If you cannot connect to the server, you can create a discussion in our [discussion forum](https://github.com/orgs/community/discussions/categories/copilot). You can include log files from your IDE to help us troubleshoot the issue. For more information on obtaining log files from your specific IDE, see [AUTOTITLE](/copilot/troubleshooting-github-copilot/viewing-logs-for-github-copilot-in-your-environment). +If you cannot connect to the server, you can create a discussion in our [discussion forum](https://github.com/orgs/community/discussions/categories/copilot). You can include log files from your IDE to help us troubleshoot the issue. For more information on obtaining log files from your specific IDE, see [AUTOTITLE](/copilot/how-tos/troubleshoot-copilot/view-logs). ## {% data variables.product.prodname_copilot_short %} not suggesting multiple lines of code @@ -77,7 +77,7 @@ In case you experience repeated rate limiting in {% data variables.product.prodn ## Can't find {% data variables.copilot.copilot_chat_short %} in my IDE -If you can't find {% data variables.copilot.copilot_chat_short %} in your editor, make sure you have checked the "Prerequisites" section of [AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-ides/using-github-copilot-chat-in-your-ide). +If you can't find {% data variables.copilot.copilot_chat_short %} in your editor, make sure you have checked the "Prerequisites" section of [AUTOTITLE](/copilot/how-tos/chat-with-copilot/chat-in-ide). > [!NOTE] > The linked article has tabs for various IDEs. @@ -90,7 +90,7 @@ To use {% data variables.copilot.copilot_chat_short %}, make sure you are using ## Authentication problems with {% data variables.enterprise.prodname_managed_user %} accounts -{% data reusables.copilot.sign-in-ghecom %} See [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/using-github-copilot-with-an-account-on-ghecom). +{% data reusables.copilot.sign-in-ghecom %} See [AUTOTITLE](/copilot/how-tos/configure-personal-settings/authenticate-to-ghecom). ## Authentication problems in {% data variables.product.prodname_vscode %} diff --git a/content/copilot/how-tos/troubleshoot-copilot/troubleshoot-firewall-settings.md b/content/copilot/how-tos/troubleshoot-copilot/troubleshoot-firewall-settings.md index 16774c0933cc..7ec63c639ac7 100644 --- a/content/copilot/how-tos/troubleshoot-copilot/troubleshoot-firewall-settings.md +++ b/content/copilot/how-tos/troubleshoot-copilot/troubleshoot-firewall-settings.md @@ -19,4 +19,4 @@ If you or your company uses a firewall, {% data variables.product.prodname_copil ## Solving the problem -For an optimal {% data variables.product.prodname_copilot_short %} experience, you should create an "allowlist" that lets certain URLs, ports, and protocols through your firewall. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/configuring-your-proxy-server-or-firewall-for-copilot). +For an optimal {% data variables.product.prodname_copilot_short %} experience, you should create an "allowlist" that lets certain URLs, ports, and protocols through your firewall. See [AUTOTITLE](/copilot/reference/copilot-allowlist-reference). diff --git a/content/copilot/how-tos/troubleshoot-copilot/troubleshoot-network-errors.md b/content/copilot/how-tos/troubleshoot-copilot/troubleshoot-network-errors.md index 820f2995e8bf..4f6bb55c0613 100644 --- a/content/copilot/how-tos/troubleshoot-copilot/troubleshoot-network-errors.md +++ b/content/copilot/how-tos/troubleshoot-copilot/troubleshoot-network-errors.md @@ -14,9 +14,9 @@ category: - Troubleshooting Copilot --- -If you're working on company equipment and connecting to a corporate network, you may be connecting to the Internet via a VPN or an HTTP proxy server. In some cases, these types of network setups may prevent {% data variables.product.prodname_copilot %} from connecting to {% data variables.product.prodname_dotcom %}'s server. For more information about the options for setting up proxies with {% data variables.product.prodname_copilot %}, see [AUTOTITLE](/copilot/configuring-github-copilot/configuring-network-settings-for-github-copilot). +If you're working on company equipment and connecting to a corporate network, you may be connecting to the Internet via a VPN or an HTTP proxy server. In some cases, these types of network setups may prevent {% data variables.product.prodname_copilot %} from connecting to {% data variables.product.prodname_dotcom %}'s server. For more information about the options for setting up proxies with {% data variables.product.prodname_copilot %}, see [AUTOTITLE](/copilot/how-tos/configure-personal-settings/configure-network-settings). -This article provides guidance for common issues related to HTTP proxies and custom certificates. If you use a firewall, this may also interfere with {% data variables.product.prodname_copilot %}'s connection. For more information, see [AUTOTITLE](/copilot/troubleshooting-github-copilot/troubleshooting-firewall-settings-for-github-copilot). +This article provides guidance for common issues related to HTTP proxies and custom certificates. If you use a firewall, this may also interfere with {% data variables.product.prodname_copilot %}'s connection. For more information, see [AUTOTITLE](/copilot/how-tos/troubleshoot-copilot/troubleshoot-firewall-settings). ## Diagnosing network issues @@ -40,20 +40,20 @@ If you receive an error related to "revocation for the certificate," you can try If you're specifically having difficulty with {% data variables.copilot.copilot_chat_short %} in your editor, run the above `curl` commands but use `https://api.githubcopilot.com/_ping` instead of `https://copilot-proxy.githubusercontent.com/_ping`. -If you're unable to connect and the `curl` requests don't help to identify the error, it may help to collect detailed diagnostic logs in your editor. If you're working with your company's IT department or {% data variables.contact.contact_support_page %}, sharing these diagnostics may help to resolve the error. Enabling debug logging in your editor will help you to share more specific information. For more information, see [AUTOTITLE](/copilot/troubleshooting-github-copilot/viewing-logs-for-github-copilot-in-your-environment). +If you're unable to connect and the `curl` requests don't help to identify the error, it may help to collect detailed diagnostic logs in your editor. If you're working with your company's IT department or {% data variables.contact.contact_support_page %}, sharing these diagnostics may help to resolve the error. Enabling debug logging in your editor will help you to share more specific information. For more information, see [AUTOTITLE](/copilot/how-tos/troubleshoot-copilot/view-logs). ## Troubleshooting proxy errors If there is a problem with your proxy setup, you may see the following error: `{% data variables.product.prodname_copilot %} could not connect to server. Extension activation failed: "read ETIMEDOUT" or "read ECONNRESET"`. This error can be caused by a range of network issues. -If you know you are connecting via a proxy, make sure the proxy is configured correctly in your environment. For more information, see [AUTOTITLE](/copilot/configuring-github-copilot/configuring-network-settings-for-github-copilot#configuring-proxy-settings-for-github-copilot). +If you know you are connecting via a proxy, make sure the proxy is configured correctly in your environment. For more information, see [AUTOTITLE](/copilot/how-tos/configure-personal-settings/configure-network-settings#configuring-proxy-settings-for-copilot). -> [!NOTE] If you are an employee of a company with a proxy server, your company must also configure proxy settings for {% data variables.product.prodname_copilot_short %} at the company level. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/configuring-your-proxy-server-or-firewall-for-copilot). +> [!NOTE] If you are an employee of a company with a proxy server, your company must also configure proxy settings for {% data variables.product.prodname_copilot_short %} at the company level. See [AUTOTITLE](/copilot/reference/copilot-allowlist-reference). {% data variables.product.prodname_copilot %} uses custom code to connect to proxies. This means a proxy setup supported by your editor is not necessarily supported by {% data variables.product.prodname_copilot %}. Some common causes for errors related to proxies are: * If your proxy's URL starts `https://`, it is not currently supported by {% data variables.product.prodname_copilot %}. -* You may need to authenticate to the proxy. {% data variables.product.prodname_copilot %} supports basic authentication or authentication with Kerberos. If you are using Kerberos, ensure you have a valid ticket for the proxy service and that you are using the correct service principal name for the service. For more information, see [AUTOTITLE](/copilot/configuring-github-copilot/configuring-network-settings-for-github-copilot#authentication-with-kerberos). +* You may need to authenticate to the proxy. {% data variables.product.prodname_copilot %} supports basic authentication or authentication with Kerberos. If you are using Kerberos, ensure you have a valid ticket for the proxy service and that you are using the correct service principal name for the service. For more information, see [AUTOTITLE](/copilot/how-tos/configure-personal-settings/configure-network-settings). * {% data variables.product.prodname_copilot %} may reject custom certificates. For more information, see [Troubleshooting certificate-related errors](#troubleshooting-certificate-related-errors). ## Troubleshooting certificate-related errors @@ -63,11 +63,11 @@ Depending on your proxy setup, you may encounter errors like "certificate signat Some possible ways to resolve certificate-related errors are: * Configure a different proxy that does not intercept secure connections. * If you are using a corporate proxy, contact your IT department to see if they can configure the proxy to not intercept secure connections. -* Ensure the custom certificates are properly installed in your operating system's trust store. For more information, see [AUTOTITLE](/copilot/configuring-github-copilot/configuring-network-settings-for-github-copilot#allowing-github-copilot-to-use-custom-certificates). If the certificates are installed on your machine but {% data variables.product.prodname_copilot %} isn't detecting them, it may help you to know the mechanisms that {% data variables.product.prodname_copilot %} uses to find certificates. +* Ensure the custom certificates are properly installed in your operating system's trust store. For more information, see [AUTOTITLE](/copilot/how-tos/configure-personal-settings/configure-network-settings#installing-custom-certificates). If the certificates are installed on your machine but {% data variables.product.prodname_copilot %} isn't detecting them, it may help you to know the mechanisms that {% data variables.product.prodname_copilot %} uses to find certificates. * On Windows, {% data variables.product.prodname_copilot_short %} uses the [win-ca package](https://www.npmjs.com/package/win-ca). * On macOS, {% data variables.product.prodname_copilot_short %} uses the [mac-ca package](https://www.npmjs.com/package/mac-ca). * On Linux, {% data variables.product.prodname_copilot_short %} checks the standard OpenSSL files `/etc/ssl/certs/ca-certificates.crt` and `/etc/ssl/certs/ca-bundle.crt`. -* Configure {% data variables.product.prodname_copilot %} to ignore certificate errors. In your proxy settings, you can deselect **Proxy Strict SSL** in {% data variables.product.prodname_vscode %}, or select **Accept non-trusted certificates automatically** in a JetBrains IDE. For more information, see [AUTOTITLE](/copilot/configuring-github-copilot/configuring-network-settings-for-github-copilot#configuring-proxy-settings-for-github-copilot). +* Configure {% data variables.product.prodname_copilot %} to ignore certificate errors. In your proxy settings, you can deselect **Proxy Strict SSL** in {% data variables.product.prodname_vscode %}, or select **Accept non-trusted certificates automatically** in a JetBrains IDE. For more information, see [AUTOTITLE](/copilot/how-tos/configure-personal-settings/configure-network-settings#configuring-proxy-settings-for-copilot). > [!WARNING] Ignoring certificate errors can cause security issues and is not recommended. diff --git a/content/copilot/how-tos/troubleshoot-copilot/view-logs.md b/content/copilot/how-tos/troubleshoot-copilot/view-logs.md index 8cec7d50235d..a9a9d4fe282b 100644 --- a/content/copilot/how-tos/troubleshoot-copilot/view-logs.md +++ b/content/copilot/how-tos/troubleshoot-copilot/view-logs.md @@ -22,7 +22,7 @@ category: ## Collecting log files -The location of the log files depends on the JetBrains IDE you are using. For more information, see [AUTOTITLE](/copilot/configuring-github-copilot/configuring-github-copilot-in-your-environment?tool=jetbrains). +The location of the log files depends on the JetBrains IDE you are using. For more information, see [AUTOTITLE](/copilot/how-tos/configure-personal-settings/configure-in-ide?tool=jetbrains). These steps describe how to view and collect the log files for the following JetBrains IDEs: @@ -92,7 +92,7 @@ If you encounter problems connecting to {% data variables.product.prodname_copil ## Troubleshooting certificate-related errors -If you're using a custom certificate, ensure the certificate is installed correctly in the operating system, see [AUTOTITLE](/copilot/troubleshooting-github-copilot/troubleshooting-network-errors-for-github-copilot). Then use the following troubleshooting steps. +If you're using a custom certificate, ensure the certificate is installed correctly in the operating system, see [AUTOTITLE](/copilot/how-tos/troubleshoot-copilot/troubleshoot-network-errors). Then use the following troubleshooting steps. 1. In the menu bar, click **Tools**, select **{% data variables.product.prodname_copilot %}**, and click **Log CA Certificates**. 1. The `idea.log` file should open in the JetBrains IDE with the trusted CA certificates logged in PEM format. You may need to refresh the `idea.log` file to view all of the output. Alternatively, you can open the `idea.log` file in your preferred editor. @@ -177,7 +177,7 @@ In rare cases, errors might not be propagated to the corresponding error handler ## Further reading -* [AUTOTITLE](/copilot/troubleshooting-github-copilot/troubleshooting-network-errors-for-github-copilot) +* [AUTOTITLE](/copilot/how-tos/troubleshoot-copilot/troubleshoot-network-errors) * [Network Connections in {% data variables.product.prodname_vscode %}](https://code.visualstudio.com/docs/setup/network) in the {% data variables.product.prodname_vscode %} documentation {% endvscode %} diff --git a/content/copilot/how-tos/use-ai-models/change-the-chat-model.md b/content/copilot/how-tos/use-ai-models/change-the-chat-model.md index 4ad9a3d2f18b..349ff59381b8 100644 --- a/content/copilot/how-tos/use-ai-models/change-the-chat-model.md +++ b/content/copilot/how-tos/use-ai-models/change-the-chat-model.md @@ -15,7 +15,7 @@ category: Choose from a selection of models, each with its own particular strengths. You may have a favorite model that you like to use, or you might prefer to use a particular model for inquiring about a specific subject. -To view the available models per client, see [AUTOTITLE](/copilot/using-github-copilot/ai-models/supported-ai-models-in-copilot#supported-models-per-client). +To view the available models per client, see [AUTOTITLE](/copilot/reference/ai-models/supported-models#supported-ai-models-per-client). > [!NOTE] Different models consume {% data variables.product.prodname_ai_credits_short %} at different rates based on their token pricing. For details, see [AUTOTITLE](/copilot/reference/copilot-billing/models-and-pricing). @@ -29,7 +29,7 @@ Changing the model used by {% data variables.copilot.copilot_chat_short %} does ### Limitations of AI models for {% data variables.copilot.copilot_chat_short %} -Experimental pre-release versions of the models may not interact with all filters correctly, including the setting to block suggestions matching public code (see [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-copilot-plan/managing-copilot-policies-as-an-individual-subscriber#enabling-or-disabling-suggestions-matching-public-code)). +Experimental pre-release versions of the models may not interact with all filters correctly, including the setting to block suggestions matching public code (see [AUTOTITLE](/copilot/how-tos/manage-your-account/manage-policies#enabling-or-disabling-suggestions-matching-public-code)). ## Changing the AI model @@ -169,7 +169,7 @@ These instructions are for the Eclipse IDE. For instructions on different client These instructions are for Xcode. For instructions on different clients, click the appropriate tab at the top of this page. -To use multi-model {% data variables.copilot.copilot_chat_short %}, you must install the {% data variables.product.prodname_copilot %} for Xcode extension. See [AUTOTITLE](/copilot/configuring-github-copilot/installing-the-github-copilot-extension-in-your-environment). +To use multi-model {% data variables.copilot.copilot_chat_short %}, you must install the {% data variables.product.prodname_copilot %} for Xcode extension. See [AUTOTITLE](/copilot/how-tos/set-up/install-copilot-extension). {% data reusables.copilot.chat-model-limitations-ide %} diff --git a/content/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-azure-boards.md b/content/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-azure-boards.md index ca0d6ff88586..e88d57420a62 100644 --- a/content/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-azure-boards.md +++ b/content/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-azure-boards.md @@ -18,7 +18,7 @@ The Azure Boards {% data variables.product.github %} integration allows you to i For information about additional {% data variables.product.prodname_copilot_short %} integrations, see [AUTOTITLE](/copilot/concepts/tools/about-copilot-integrations). > [!NOTE] -> * {% data variables.product.prodname_copilot %} uses AI. Check for mistakes. See [AUTOTITLE](/copilot/responsible-use/copilot-cloud-agent). +> * {% data variables.product.prodname_copilot %} uses AI. Check for mistakes. See [AUTOTITLE](/copilot/responsible-use/agents). > * When you send a work item to {% data variables.copilot.copilot_cloud_agent %}, the agent will capture content from text fields (such as the description and reproduction steps), along with the last 50 comments. This context is stored in the pull request, and is visible to anyone with access to the repository. ## Prerequisites diff --git a/content/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-jira.md b/content/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-jira.md index ffd8da81a2b4..93c862da02b2 100644 --- a/content/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-jira.md +++ b/content/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-jira.md @@ -15,7 +15,7 @@ category: --- > [!NOTE] -> {% data variables.product.prodname_copilot %} uses AI. Check for mistakes. See [AUTOTITLE](/copilot/responsible-use/copilot-cloud-agent). +> {% data variables.product.prodname_copilot %} uses AI. Check for mistakes. See [AUTOTITLE](/copilot/responsible-use/agents). The {% data variables.product.prodname_copilot %} integration in Jira allows you to invoke {% data variables.copilot.copilot_cloud_agent %} without leaving your Jira workspace. From within Jira you can initiate {% data variables.copilot.copilot_cloud_agent_short %} sessions and open pull requests, using the context of the work item's title, description, labels, comments, and any Atlassian custom fields such as acceptance criteria. @@ -129,7 +129,7 @@ Specify a model when you want a task to run on a specific model rather than the ### Specifying a custom agent -Specify a custom agent to tailor {% data variables.copilot.copilot_cloud_agent_short %}'s behavior to a particular workflow or repository. You can specify a custom agent from your {% data variables.product.github %} repository directly in the Jira ticket. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-custom-agents). +Specify a custom agent to tailor {% data variables.copilot.copilot_cloud_agent_short %}'s behavior to a particular workflow or repository. You can specify a custom agent from your {% data variables.product.github %} repository directly in the Jira ticket. For more information, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/create-custom-agents). ### Using custom instructions @@ -200,5 +200,5 @@ To resolve this issue, follow these steps to start a new active SSO session for * [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-cloud-agent) * [AUTOTITLE](/copilot/concepts/agents/cloud-agent/access-management) -* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/extend-cloud-agent-with-mcp#example-atlassian) +* [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/configure-mcp-servers#example-atlassian) * [Collaborate on work items with AI agents](https://support.atlassian.com/jira-software-cloud/docs/collaborate-on-work-items-with-ai-agents/) in the Atlassian documentation diff --git a/content/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-linear.md b/content/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-linear.md index 659f82030af8..38ae6dff66f5 100644 --- a/content/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-linear.md +++ b/content/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-linear.md @@ -15,7 +15,7 @@ redirect_from: > [!NOTE] > * This feature is currently in {% data variables.release-phases.public_preview %} and subject to change. -> * {% data variables.product.prodname_copilot %} uses AI. Check for mistakes. See [AUTOTITLE](/copilot/responsible-use/copilot-cloud-agent). +> * {% data variables.product.prodname_copilot %} uses AI. Check for mistakes. See [AUTOTITLE](/copilot/responsible-use/agents). The {% data variables.product.prodname_copilot_short %} integration in Linear allows you to invoke {% data variables.copilot.copilot_cloud_agent %} without leaving your Linear workspace. From within a Linear issue you can initiate {% data variables.copilot.copilot_cloud_agent_short %} sessions and open pull requests, using the context of your issue description and comments. diff --git a/content/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-slack.md b/content/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-slack.md index 2990158efe9a..99fd255a2ef1 100644 --- a/content/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-slack.md +++ b/content/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-slack.md @@ -15,7 +15,7 @@ redirect_from: > [!NOTE] > * This feature is in {% data variables.release-phases.public_preview %} and subject to change. -> * {% data variables.product.prodname_copilot %} uses AI. Check for mistakes. See [AUTOTITLE](/copilot/responsible-use/copilot-cloud-agent) +> * {% data variables.product.prodname_copilot %} uses AI. Check for mistakes. See [AUTOTITLE](/copilot/responsible-use/agents). ## Introduction diff --git a/content/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-teams.md b/content/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-teams.md index 1b2e36461d40..45674bcabf36 100644 --- a/content/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-teams.md +++ b/content/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-teams.md @@ -15,7 +15,7 @@ redirect_from: > [!NOTE] > * This feature is currently in {% data variables.release-phases.public_preview %} and subject to change. -> * {% data variables.product.prodname_copilot %} uses AI. Check for mistakes. See [AUTOTITLE](/copilot/responsible-use/copilot-cloud-agent). +> * {% data variables.product.prodname_copilot %} uses AI. Check for mistakes. See [AUTOTITLE](/copilot/responsible-use/agents). The {% data variables.product.github %} integration in Microsoft Teams allows you to interact with {% data variables.copilot.copilot_cloud_agent %} all from within your Teams channels. From within a Teams thread you can initiate {% data variables.copilot.copilot_cloud_agent_short %} sessions and open pull requests, using the context of your conversation. diff --git a/content/copilot/how-tos/use-copilot-agents/cloud-agent/troubleshoot-cloud-agent.md b/content/copilot/how-tos/use-copilot-agents/cloud-agent/troubleshoot-cloud-agent.md index 40461a50a48a..8a6bd4110ae8 100644 --- a/content/copilot/how-tos/use-copilot-agents/cloud-agent/troubleshoot-cloud-agent.md +++ b/content/copilot/how-tos/use-copilot-agents/cloud-agent/troubleshoot-cloud-agent.md @@ -31,13 +31,13 @@ If you _do_ have a paid {% data variables.product.prodname_copilot_short %} plan {% ifversion ghec %} -* If you are on the {% data variables.copilot.copilot_for_business %} or {% data variables.copilot.copilot_enterprise_short %} plan, your ability to use {% data variables.copilot.copilot_cloud_agent %} is controlled by your enterprise and/or organization administrator. See [AUTOTITLE](/enterprise-cloud@latest/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/manage-copilot-cloud-agent). +* If you are on the {% data variables.copilot.copilot_for_business %} or {% data variables.copilot.copilot_enterprise_short %} plan, your ability to use {% data variables.copilot.copilot_cloud_agent %} is controlled by your enterprise and/or organization administrator. See [AUTOTITLE](/enterprise-cloud@latest/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/enable-copilot-cloud-agent). {% endif %} * For organization-owned repositories, the availability of {% data variables.copilot.copilot_cloud_agent %} in the repository is managed by the organization and/or enterprise administrators. See [AUTOTITLE](/enterprise-cloud@latest/copilot/how-tos/administer-copilot/manage-for-organization/add-copilot-cloud-agent). -* For personal repositories, the availability of {% data variables.copilot.copilot_cloud_agent %} in the repository is configured in your account settings. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-copilot-plan/managing-copilot-policies-as-an-individual-subscriber#enabling-or-disabling-copilot-cloud-agent). +* For personal repositories, the availability of {% data variables.copilot.copilot_cloud_agent %} in the repository is configured in your account settings. See [AUTOTITLE](/copilot/how-tos/manage-your-account/manage-policies#disabling-or-enabling-copilot-cloud-agent-in-your-repositories). > [!NOTE] > You can check whether {% data variables.copilot.copilot_cloud_agent %} has been enabled for you in the features page of your {% data variables.product.prodname_copilot_short %} settings: [github.com/settings/copilot/features](https://github.com/settings/copilot/features). @@ -85,7 +85,7 @@ If {% data variables.product.prodname_copilot_short %} got stuck while respondin {% data variables.product.prodname_actions %} workflows will not run automatically when {% data variables.product.prodname_copilot_short %} pushes changes to a pull request. -To allow {% data variables.product.prodname_actions %} workflows to run, click the **Approve and run workflows** button in the pull request's merge box. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/review-copilot-prs). +To allow {% data variables.product.prodname_actions %} workflows to run, click the **Approve and run workflows** button in the pull request's merge box. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/use-copilot-agents/review-copilot-output). ## {% data variables.product.prodname_copilot_short %} is pushing changes which don't pass my CI checks @@ -103,7 +103,7 @@ If {% data variables.product.prodname_copilot_short %} tries to make a request w ![Screenshot of a warning from {% data variables.product.prodname_copilot_short %} about being blocked by the firewall.](/assets/images/help/copilot/cloud-agent/firewall-warning.png) -For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-firewall). +For more information, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/customize-the-agent-firewall). ## {% data variables.product.prodname_copilot_short %} is not picking up attached screenshots @@ -112,4 +112,4 @@ The maximum image size allowed by {% data variables.copilot.copilot_cloud_agent ## Further reading * [AUTOTITLE](/copilot/tutorials/cloud-agent/get-the-best-results) -* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-environment) +* [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/customize-the-agent-environment) diff --git a/content/copilot/how-tos/use-copilot-agents/cloud-agent/use-cloud-agent-on-github.md b/content/copilot/how-tos/use-copilot-agents/cloud-agent/use-cloud-agent-on-github.md index 168f4071f52e..dd6f4579c433 100644 --- a/content/copilot/how-tos/use-copilot-agents/cloud-agent/use-cloud-agent-on-github.md +++ b/content/copilot/how-tos/use-copilot-agents/cloud-agent/use-cloud-agent-on-github.md @@ -93,7 +93,7 @@ You can ask {% data variables.product.prodname_copilot_short %} to start working For example, you might include instructions about specific coding patterns or frameworks to use, testing requirements, code style preferences, files or directories that should or shouldn't be modified. - In addition to the details you supply here, {% data variables.product.prodname_copilot_short %} will use any custom instructions that have been configured for the target repository. See [AUTOTITLE](/copilot/how-tos/configure-custom-instructions/add-repository-instructions). + In addition to the details you supply here, {% data variables.product.prodname_copilot_short %} will use any custom instructions that have been configured for the target repository. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-repository-instructions). 1. You can use the dropdown menus in the dialog to change the repository that {% data variables.product.prodname_copilot_short %} will work in and the branch that it will branch off from. diff --git a/content/copilot/how-tos/use-copilot-agents/cloud-agent/use-cloud-agent-with-mcp.md b/content/copilot/how-tos/use-copilot-agents/cloud-agent/use-cloud-agent-with-mcp.md index c0c4830316de..26b97da35e71 100644 --- a/content/copilot/how-tos/use-copilot-agents/cloud-agent/use-cloud-agent-with-mcp.md +++ b/content/copilot/how-tos/use-copilot-agents/cloud-agent/use-cloud-agent-with-mcp.md @@ -16,7 +16,7 @@ category: ## Starting a session -1. Install the {% data variables.product.github %} MCP Server in your preferred IDE or agentic coding tool. See [AUTOTITLE](/copilot/how-tos/context/model-context-protocol/using-the-github-mcp-server). +1. Install the {% data variables.product.github %} MCP Server in your preferred IDE or agentic coding tool. See [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp-in-your-ide/use-the-github-mcp-server). 1. Ensure the `create_pull_request_with_copilot` tool is enabled. diff --git a/content/copilot/how-tos/use-copilot-agents/request-a-code-review/use-code-review.md b/content/copilot/how-tos/use-copilot-agents/request-a-code-review/use-code-review.md index 8aee0aef0c74..6b7e3ec50fbf 100644 --- a/content/copilot/how-tos/use-copilot-agents/request-a-code-review/use-code-review.md +++ b/content/copilot/how-tos/use-copilot-agents/request-a-code-review/use-code-review.md @@ -22,7 +22,7 @@ category: {% data variables.product.prodname_copilot %} can review your code and provide feedback. Where possible, {% data variables.product.prodname_copilot_short %}'s feedback includes suggested changes which you can apply with a couple of clicks. -For a full introduction to {% data variables.copilot.copilot_code-review %}, see [AUTOTITLE](/copilot/concepts/code-review). +For a full introduction to {% data variables.copilot.copilot_code-review %}, see [AUTOTITLE](/copilot/concepts/agents/code-review). {% webui %} @@ -53,7 +53,7 @@ You can also request a review from {% data variables.product.prodname_copilot_sh ## Enabling automatic reviews -By default, you manually request a review from {% data variables.product.prodname_copilot_short %} on each pull request, in the same way you would request a review from a human. However, you can set up {% data variables.product.prodname_copilot_short %} to automatically review all pull requests. See [AUTOTITLE](/copilot/how-tos/agents/copilot-code-review/automatic-code-review). +By default, you manually request a review from {% data variables.product.prodname_copilot_short %} on each pull request, in the same way you would request a review from a human. However, you can set up {% data variables.product.prodname_copilot_short %} to automatically review all pull requests. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/set-up-copilot/configure-automatic-review). ## Working with suggested changes provided by {% data variables.product.prodname_copilot_short %} diff --git a/content/copilot/how-tos/use-copilot-for-common-tasks/use-copilot-in-the-cli.md b/content/copilot/how-tos/use-copilot-for-common-tasks/use-copilot-in-the-cli.md index 2b0eecaf4014..0a08e41047f1 100644 --- a/content/copilot/how-tos/use-copilot-for-common-tasks/use-copilot-in-the-cli.md +++ b/content/copilot/how-tos/use-copilot-for-common-tasks/use-copilot-in-the-cli.md @@ -21,4 +21,4 @@ category: # Replacing the {% data variables.release-phases.retired %} {% data variables.product.prodname_copilot_short %} extension -The {% data variables.product.prodname_copilot %} extension for {% data variables.product.prodname_cli %} is {% data variables.release-phases.retired %}. It has been replaced by the new {% data variables.copilot.copilot_cli %}. See [AUTOTITLE](/copilot/concepts/agents/about-copilot-cli). +The {% data variables.product.prodname_copilot %} extension for {% data variables.product.prodname_cli %} is {% data variables.release-phases.retired %}. It has been replaced by the new {% data variables.copilot.copilot_cli %}. See [AUTOTITLE](/copilot/concepts/agents/copilot-cli/about-copilot-cli). From dee90801dc076f82209ee753336420aadb249bfd Mon Sep 17 00:00:00 2001 From: Kevin Heis Date: Thu, 9 Jul 2026 11:30:15 -0700 Subject: [PATCH 11/15] Update redirected internal links in data/reusables (advanced-formatting+advanced-security+apps+audit_log+billing+branches+code-scanning+codeql-cli+codespaces+command_line) (#62170) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../administrator-must-enable-mapping.md | 2 +- .../check-for-ghas-license.md | 2 +- .../control-use-cost-links.md | 4 +-- .../reusables/advanced-security/ghas-trial.md | 4 +-- .../advanced-security/purchase-ghas.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 +- .../deprecating_auth_with_query_parameters.md | 2 +- data/reusables/apps/github-app-managers.md | 2 +- data/reusables/apps/install-vs-authorize.md | 2 +- .../apps/repo-admin-install-restriction.md | 2 +- .../audit_log/audit-log-action-categories.md | 32 +++++++++---------- .../audit_log/users-agree-to-ip-collection.md | 2 +- data/reusables/billing/billing-info.md | 2 +- .../billing/default-over-quota-behavior.md | 2 +- ...nced-billing-platform-personal-accounts.md | 2 +- data/reusables/branches/set-default-branch.md | 2 +- .../about-multiple-configurations-link.md | 2 +- .../alerts-found-in-generated-code.md | 4 +-- .../audit-code-scanning-events.md | 2 +- data/reusables/code-scanning/billing.md | 2 +- .../codeql-action-version-ghes.md | 2 +- .../code-scanning/codeql-query-suites.md | 2 +- .../codeql-version-info.md | 2 +- .../links-to-all-tables.md | 20 ++++++------ .../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 +-- ...eroperable-with-tools-that-output-sarif.md | 2 +- .../code-scanning/max-paths-setting.md | 2 +- .../code-scanning/run-additional-queries.md | 2 +- .../code-scanning/sarif-upload-retry.md | 2 +- ...ty-configuration-enforcement-edge-cases.md | 2 +- .../code-scanning/track-alert-in-issue.md | 2 +- ...troubleshooting-multiple-configurations.md | 2 +- .../code-scanning/upload-sarif-alert-limit.md | 2 +- .../using-security-overview-coverage.md | 4 +-- .../using-security-overview-risk.md | 2 +- .../codeql-cli/advanced-query-execution.md | 6 ++-- data/reusables/codeql-cli/launch-codeql.md | 2 +- .../codespaces/about-changing-storage-size.md | 2 +- .../codespaces-continue-by-paying.md | 2 +- .../codespaces/codespaces-machine-types.md | 2 +- .../codespaces-spending-limit-requirement.md | 2 +- .../codespaces-unavailable-for-emus.md | 2 +- .../committing-link-to-procedure.md | 2 +- .../connect-to-codespace-from-vscode.md | 2 +- .../codespaces/devcontainer-properties-1.md | 2 +- .../codespaces/developing-in-vscode.md | 4 +-- .../codespaces/emus-create-codespaces.md | 2 +- .../forwarded-ports-environment-variable.md | 2 +- data/reusables/codespaces/full-rebuild-tip.md | 2 +- .../codespaces/gpg-in-active-codespaces.md | 2 +- .../codespaces/links-to-get-started.md | 2 +- .../next-steps-adding-devcontainer.md | 2 +- data/reusables/codespaces/secrets-on-start.md | 2 +- .../codespaces/settings-sync-and-gpg.md | 2 +- data/reusables/codespaces/source-control.md | 2 +- .../codespaces/stopping-a-codespace.md | 2 +- .../template-codespaces-default-editor.md | 2 +- .../codespaces/trusted-repos-step.md | 2 +- .../command_line/provide-an-access-token.md | 2 +- 67 files changed, 101 insertions(+), 101 deletions(-) diff --git a/data/reusables/advanced-formatting/administrator-must-enable-mapping.md b/data/reusables/advanced-formatting/administrator-must-enable-mapping.md index 3d8697c34877..bd94ad057875 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 ghes %} -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/configuring-settings/configuring-user-applications-for-your-enterprise/configuring-interactive-maps). {% endif %} diff --git a/data/reusables/advanced-security/check-for-ghas-license.md b/data/reusables/advanced-security/check-for-ghas-license.md index 227004203022..e72220ceddd6 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 license for {% data variables.product.prodname_AS %} products 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 license for {% data variables.product.prodname_AS %} products by reviewing your enterprise settings. For more information, see [AUTOTITLE](/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/enabling-github-advanced-security-for-your-enterprise#checking-whether-your-license-includes-github-advanced-security). diff --git a/data/reusables/advanced-security/control-use-cost-links.md b/data/reusables/advanced-security/control-use-cost-links.md index 313c33f67d2f..b20788e064b4 100644 --- a/data/reusables/advanced-security/control-use-cost-links.md +++ b/data/reusables/advanced-security/control-use-cost-links.md @@ -1,3 +1,3 @@ -{% ifversion fpt or ghec %}[AUTOTITLE](/billing/managing-your-billing/using-budgets-control-spending){% ifversion ghec %} and [AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-advanced-security-in-your-enterprise){% endif %} -{% elsif ghes %}[AUTOTITLE](/enterprise-cloud@latest/billing/managing-your-billing/using-budgets-control-spending) in the {% data variables.product.prodname_ghe_cloud %} docs +{% ifversion fpt or ghec %}[AUTOTITLE](/billing/how-tos/set-up-budgets){% ifversion ghec %} and [AUTOTITLE](/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise){% endif %} +{% elsif ghes %}[AUTOTITLE](/enterprise-cloud@latest/billing/how-tos/set-up-budgets) in the {% data variables.product.prodname_ghe_cloud %} docs {% endif %} diff --git a/data/reusables/advanced-security/ghas-trial.md b/data/reusables/advanced-security/ghas-trial.md index fa0636691d02..05e94c13fb94 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_GHAS %} 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_GHAS %} 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_GHAS %} for free, see [AUTOTITLE](/code-security/tutorials/trialing-github-advanced-security/trial-advanced-security). +{% elsif fpt %}For information about how you can try {% data variables.product.prodname_enterprise %} with {% data variables.product.prodname_GHAS %} for free, see [AUTOTITLE](/enterprise-cloud@latest/admin/overview/setting-up-a-trial-of-github-enterprise-cloud) and [AUTOTITLE](/enterprise-cloud@latest/code-security/tutorials/trialing-github-advanced-security/trial-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/purchase-ghas.md b/data/reusables/advanced-security/purchase-ghas.md index 3732a0541960..44d93d641e35 100644 --- a/data/reusables/advanced-security/purchase-ghas.md +++ b/data/reusables/advanced-security/purchase-ghas.md @@ -5,4 +5,4 @@ > [!TIP] > If you pay for {% data variables.product.github %} using volume/subscription billing, you will also need define how many licenses to purchase. -> * Under "How many committers do you want to include?", enter the number of committers you want to purchase licenses for. See [Active committers and unique committers](/billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security#active-committers-and-unique-committers). +> * Under "How many committers do you want to include?", enter the number of committers you want to purchase licenses for. See [Active committers and unique committers](/billing/concepts/product-billing/github-advanced-security#active-committers-and-unique-committers). 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 b316774406c6..ba349267fc98 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/concepts/secret-security/push-protection). > * 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 a8061a473eb8..982706ff96c8 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/how-tos/secure-your-secrets/customize-leak-detection/define-custom-patterns#defining-a-custom-pattern-for-a-repository) or [Defining a custom pattern for an organization](/code-security/how-tos/secure-your-secrets/customize-leak-detection/define-custom-patterns#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 3a80de37d534..99151ff306b9 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 resources, you must install the app on your{% ifversion enterprise-installed-apps %} enterprise,{% endif %} 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 {% ifversion enterprise-installed-apps %}enterprise or {% endif %}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 {% ifversion enterprise-installed-apps %}enterprise or {% endif %}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/authentication/permissions-required-for-github-apps). When you install an app that requests repository permissions, 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/authentication/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 2fd643670003..5fe56c10bbf3 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/concepts/code-scanning/code-scanning) and [AUTOTITLE](/code-security/concepts/secret-security/secret-scanning). diff --git a/data/reusables/apps/deprecating_auth_with_query_parameters.md b/data/reusables/apps/deprecating_auth_with_query_parameters.md index 0cfe35b1b941..a478f134af0d 100644 --- a/data/reusables/apps/deprecating_auth_with_query_parameters.md +++ b/data/reusables/apps/deprecating_auth_with_query_parameters.md @@ -1,5 +1,5 @@ > [!WARNING] -> **{% data variables.release-phases.retired_caps %} Notice:** Authenticating to the {% data variables.product.prodname_dotcom %} API is no longer accessible using query parameters. Authenticating to the API should be done with [HTTP basic authentication](/rest/overview/authenticating-to-the-rest-api#using-basic-authentication). For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-10-deprecating-auth-through-query-param/). +> **{% data variables.release-phases.retired_caps %} Notice:** Authenticating to the {% data variables.product.prodname_dotcom %} API is no longer accessible using query parameters. Authenticating to the API should be done with [HTTP basic authentication](/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication). For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-10-deprecating-auth-through-query-param/). {% ifversion ghes %}> > Authentication to the API using query parameters while available is no longer supported due to security concerns. Instead we recommend integrators move their access token, `client_id`, or `client_secret` in the header. {% data variables.product.prodname_dotcom %} will announce the removal of authentication by query parameters with advanced notice. {% endif %} diff --git a/data/reusables/apps/github-app-managers.md b/data/reusables/apps/github-app-managers.md index 7d85e1d738a1..a9e8a414c00a 100644 --- a/data/reusables/apps/github-app-managers.md +++ b/data/reusables/apps/github-app-managers.md @@ -1 +1 @@ -Organization{% ifversion enterprise-app-manager %} and enterprise{% endif %} owners can designate other users{% ifversion org-app-manager-teams %} or organization teams{% endif %} 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 account. The {% data variables.product.prodname_github_app %} manager role does not grant recipients access to install and uninstall {% data variables.product.prodname_github_apps %} on an organization{% ifversion enterprise-app-manager %} or enterprise{% endif %}.{% ifversion fpt or ghec %} For organization-owned apps, the role also does not grant permission to list apps in {% data variables.product.prodname_marketplace %}. Only organization owners can list apps in {% data variables.product.prodname_marketplace %}.{% endif %} For more information about the specific app settings that {% data variables.product.prodname_github_app %} managers can control, see [AUTOTITLE](/apps/maintaining-github-apps/modifying-a-github-app). +Organization{% ifversion enterprise-app-manager %} and enterprise{% endif %} owners can designate other users{% ifversion org-app-manager-teams %} or organization teams{% endif %} 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 account. The {% data variables.product.prodname_github_app %} manager role does not grant recipients access to install and uninstall {% data variables.product.prodname_github_apps %} on an organization{% ifversion enterprise-app-manager %} or enterprise{% endif %}.{% ifversion fpt or ghec %} For organization-owned apps, the role also does not grant permission to list apps in {% data variables.product.prodname_marketplace %}. Only organization owners can list apps in {% data variables.product.prodname_marketplace %}.{% endif %} For more information about the specific app settings that {% data variables.product.prodname_github_app %} managers can control, see [AUTOTITLE](/apps/maintaining-github-apps/modifying-a-github-app-registration). diff --git a/data/reusables/apps/install-vs-authorize.md b/data/reusables/apps/install-vs-authorize.md index 540564126313..fe9308fc6cbe 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/registering-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/repo-admin-install-restriction.md b/data/reusables/apps/repo-admin-install-restriction.md index ae7d071eae5f..799a30e3954a 100644 --- a/data/reusables/apps/repo-admin-install-restriction.md +++ b/data/reusables/apps/repo-admin-install-restriction.md @@ -1 +1 @@ -Repository admins can install {% data variables.product.prodname_github_apps %} in the organization that owns the repository if the app does not request any organization permissions nor the "repository administration" permission. When doing so, they can only install the app with access to the repositories that they admin. {% ifversion fpt or ghec or ghes > 3.19 %}Organization owners can restrict {% data variables.product.prodname_github_app %} installation by repository admins. When this restriction is enabled, repository admins cannot install {% data variables.product.prodname_github_apps %} and must instead request that organization owners install the desired app. For more information, see [AUTOTITLE](/organizations/managing-programmatic-access-to-your-organization/limiting-oauth-app-and-github-app-access-requests).{% endif %} \ No newline at end of file +Repository admins can install {% data variables.product.prodname_github_apps %} in the organization that owns the repository if the app does not request any organization permissions nor the "repository administration" permission. When doing so, they can only install the app with access to the repositories that they admin. {% ifversion fpt or ghec or ghes > 3.19 %}Organization owners can restrict {% data variables.product.prodname_github_app %} installation by repository admins. When this restriction is enabled, repository admins cannot install {% data variables.product.prodname_github_apps %} and must instead request that organization owners install the desired app. For more information, see [AUTOTITLE](/organizations/managing-programmatic-access-to-your-organization/limiting-oauth-app-and-github-app-access-requests-and-installations).{% endif %} diff --git a/data/reusables/audit_log/audit-log-action-categories.md b/data/reusables/audit_log/audit-log-action-categories.md index 1fcaf564f1be..8a4b06aa1748 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/concepts/vulnerability-reporting-and-management/repository-security-advisories). | | {% endif %} | | `artifact` | Contains activities related to {% data variables.product.prodname_actions %} workflow run artifacts. | | `audit_log_streaming` | Contains activities related to streaming audit logs for organizations in an enterprise account. | @@ -16,7 +16,7 @@ | `business_secret_scanning` | Contains activities related to {% data variables.product.prodname_secret_scanning %} in an enterprise. | | `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. | | `business_secret_scanning_custom_pattern` | Contains activities related to custom patterns for {% data variables.product.prodname_secret_scanning %} in an enterprise. | -| `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/how-tos/secure-your-secrets/customize-leak-detection/define-custom-patterns#defining-a-custom-pattern-for-an-enterprise-account). | | `business_secret_scanning_push_protection` | Contains activities related to the push protection feature of {% data variables.product.prodname_secret_scanning %} in an enterprise. | | `business_secret_scanning_push_protection_custom_message` | Contains activities related to the custom message displayed when push protection is triggered in an enterprise. | | `checks` | Contains activities related to check suites and runs. | @@ -27,12 +27,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/concepts/supply-chain-security/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/how-tos/secure-your-supply-chain/secure-your-dependencies/configure-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/concepts/supply-chain-security/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 %}. | @@ -80,7 +80,7 @@ | `org_credential_authorization` | Contains activities related to authorizing credentials for use with SAML single sign-on. | | {% endif %} | | `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_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/how-tos/secure-your-secrets/customize-leak-detection/define-custom-patterns). | | `organization_default_label` | Contains activities related to default labels for repositories in an organization. | | `organization_domain` | Contains activities related to verified organization domains. | | `organization_projects_change` | Contains activities related to organization-wide {% data variables.projects.projects_v2_and_v1 %} in an enterprise. | @@ -110,22 +110,22 @@ | `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_advisory` | Contains repository-level activities related to security advisories in the {% data variables.product.prodname_advisory_database %}. For more information, see [AUTOTITLE](/code-security/concepts/vulnerability-reporting-and-management/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 private repository. For more information, see [AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph). | +| `repository_dependency_graph` | Contains repository-level activities related to enabling or disabling the dependency graph for a private repository. For more information, see [AUTOTITLE](/code-security/concepts/supply-chain-security/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. | -| `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_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_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_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_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` | Contains repository-level activities related to {% data variables.product.prodname_secret_scanning %}. For more information, see [AUTOTITLE](/code-security/concepts/secret-security/secret-scanning). | +| `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/how-tos/secure-your-secrets/detect-secret-leaks/enable-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/how-tos/secure-your-secrets/customize-leak-detection/define-custom-patterns). | +| `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/how-tos/secure-your-secrets/customize-leak-detection/define-custom-patterns#defining-a-custom-pattern-for-a-repository). | +| `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/concepts/secret-security/push-protection). | | {% ifversion fpt or ghec %} | | `repository_visibility_change` | Contains activities related to allowing organization members to change repository visibilities for the organization. | | {% endif %} | -| `repository_vulnerability_alert` | Contains activities related to [{% data variables.product.prodname_dependabot_alerts %}](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts). | +| `repository_vulnerability_alert` | Contains activities related to [{% data variables.product.prodname_dependabot_alerts %}](/code-security/concepts/supply-chain-security/dependabot-alerts). | | {% ifversion fpt or ghec %} | | `repository_vulnerability_alerts` | Contains repository-level configuration activities for {% data variables.product.prodname_dependabot_alerts %}. | | `required_status_check` | Contains activities related to required status checks for protected branches. | @@ -136,7 +136,7 @@ | {% ifversion ghec or ghes %} | | `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 %} | -| `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/concepts/secret-security/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. | | {% ifversion ghec or ghes %} | | `security_key` | Contains activities related to security keys registration and removal. | @@ -149,7 +149,7 @@ | `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/enforcing-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. 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 5b667342445e..60a21f6d5764 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-general-privacy-statement#usage-information). diff --git a/data/reusables/billing/billing-info.md b/data/reusables/billing/billing-info.md index 2885676f8eaf..a6577ff4e39c 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-billing). +For more information about billing in general, like adding a payment method or viewing your payment history, see [AUTOTITLE](/billing/get-started). diff --git a/data/reusables/billing/default-over-quota-behavior.md b/data/reusables/billing/default-over-quota-behavior.md index 65ad13891e80..19bfda439b83 100644 --- a/data/reusables/billing/default-over-quota-behavior.md +++ b/data/reusables/billing/default-over-quota-behavior.md @@ -1,3 +1,3 @@ If your account does not have a valid payment method on file, usage is blocked once you use up your quota. -If you have a valid payment method on file, spending may be limited by one or more budgets. Check the budgets set for your account to ensure they are appropriate for your usage needs. See [AUTOTITLE](/billing/managing-your-billing/using-budgets-control-spending). +If you have a valid payment method on file, spending may be limited by one or more budgets. Check the budgets set for your account to ensure they are appropriate for your usage needs. See [AUTOTITLE](/billing/how-tos/set-up-budgets). diff --git a/data/reusables/billing/enhanced-billing-platform-personal-accounts.md b/data/reusables/billing/enhanced-billing-platform-personal-accounts.md index 31907795a5ba..08312a21495f 100644 --- a/data/reusables/billing/enhanced-billing-platform-personal-accounts.md +++ b/data/reusables/billing/enhanced-billing-platform-personal-accounts.md @@ -1 +1 @@ ->[!NOTE] If you created a personal account after February 13, 2025, your billing experience may differ from the information in this article. You can manage your plan and view billing details in the new billing platform. See [AUTOTITLE](/billing/managing-your-billing). +> [!NOTE] If you created a personal account after February 13, 2025, your billing experience may differ from the information in this article. You can manage your plan and view billing details in the new billing platform. See [AUTOTITLE](/billing/get-started). diff --git a/data/reusables/branches/set-default-branch.md b/data/reusables/branches/set-default-branch.md index 7e5c55f0eb6b..8916a14e9baf 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](/repositories/managing-your-repositorys-settings-and-features/managing-repository-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/enforcing-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/code-scanning/about-multiple-configurations-link.md b/data/reusables/code-scanning/about-multiple-configurations-link.md index 397b0e5b2257..79fb867cbe8a 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/concepts/code-scanning/code-scanning-alerts#about-analysis-origins). 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 cd216e608db2..95917cea7614 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 @@ -When using `build-mode: autobuild` or `build-mode: manual`, 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). +When using `build-mode: autobuild` or `build-mode: manual`, 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/reference/workflows-and-actions/workflow-syntax#onpushpull_requestpull_request_targetpathspaths-ignore). -For languages like JavaScript, Python, and TypeScript, that {% data variables.product.prodname_codeql %} analyzes without compiling the source code, or for a compiled language using `build-mode: none`, 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, or for a compiled language using `build-mode: none`, you can specify additional configuration options to limit the amount of code to analyze. For more information, see [AUTOTITLE](/code-security/reference/code-scanning/workflow-configuration-options#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 815bc09a264d..e4da32112d7f 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/concepts/security-at-scale/audit-security-alerts). diff --git a/data/reusables/code-scanning/billing.md b/data/reusables/code-scanning/billing.md index 96f529454515..2ffa243f64df 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/concepts/product-billing/github-actions).{% endif %} diff --git a/data/reusables/code-scanning/codeql-action-version-ghes.md b/data/reusables/code-scanning/codeql-action-version-ghes.md index b40e52eaf688..31bbcba41aa4 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.prodname_ghe_server %}. 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](/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/configuring-code-scanning-for-your-appliance#configuring-codeql-analysis-on-a-server-without-internet-access). {% endif %} diff --git a/data/reusables/code-scanning/codeql-query-suites.md b/data/reusables/code-scanning/codeql-query-suites.md index e27e4bacf26a..bab02ced7e84 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/concepts/code-scanning/codeql/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 67bc4dd21ecc..c38b9187630e 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.prodname_ghe_server %} {{ 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.prodname_ghe_server %} {{ 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](/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/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 896c581f0d1c..c10bc2bd4023 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,12 +1,12 @@ {% ifversion code-scanning-actions-language %} -* [AUTOTITLE](/code-security/code-scanning/reference/code-ql-built-in-queries/actions-built-in-queries) +* [AUTOTITLE](/code-security/reference/code-scanning/codeql/codeql-queries/actions-built-in-queries) {% endif %} -* [AUTOTITLE](/code-security/code-scanning/reference/code-ql-built-in-queries/c-cpp-built-in-queries) -* [AUTOTITLE](/code-security/code-scanning/reference/code-ql-built-in-queries/csharp-built-in-queries) -* [AUTOTITLE](/code-security/code-scanning/reference/code-ql-built-in-queries/go-built-in-queries) -* [AUTOTITLE](/code-security/code-scanning/reference/code-ql-built-in-queries/java-kotlin-built-in-queries) -* [AUTOTITLE](/code-security/code-scanning/reference/code-ql-built-in-queries/javascript-typescript-built-in-queries) -* [AUTOTITLE](/code-security/code-scanning/reference/code-ql-built-in-queries/python-built-in-queries) -* [AUTOTITLE](/code-security/code-scanning/reference/code-ql-built-in-queries/ruby-built-in-queries) -* [AUTOTITLE](/code-security/code-scanning/reference/code-ql-built-in-queries/rust-built-in-queries) -* [AUTOTITLE](/code-security/code-scanning/reference/code-ql-built-in-queries/swift-built-in-queries) +* [AUTOTITLE](/code-security/reference/code-scanning/codeql/codeql-queries/c-cpp-built-in-queries) +* [AUTOTITLE](/code-security/reference/code-scanning/codeql/codeql-queries/csharp-built-in-queries) +* [AUTOTITLE](/code-security/reference/code-scanning/codeql/codeql-queries/go-built-in-queries) +* [AUTOTITLE](/code-security/reference/code-scanning/codeql/codeql-queries/java-kotlin-built-in-queries) +* [AUTOTITLE](/code-security/reference/code-scanning/codeql/codeql-queries/javascript-typescript-built-in-queries) +* [AUTOTITLE](/code-security/reference/code-scanning/codeql/codeql-queries/python-built-in-queries) +* [AUTOTITLE](/code-security/reference/code-scanning/codeql/codeql-queries/ruby-built-in-queries) +* [AUTOTITLE](/code-security/reference/code-scanning/codeql/codeql-queries/rust-built-in-queries) +* [AUTOTITLE](/code-security/reference/code-scanning/codeql/codeql-queries/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 9eae39607864..032c795b04d1 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/concepts/code-scanning/codeql/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 0210e6484e00..7d70f9d7c5bc 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's default branch, 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's default branch, 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/concepts/code-scanning/codeql/codeql-code-scanning#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 c6ffd787a2a6..1e5cbf22b4bb 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/concepts/runners/actions-runner-controller). diff --git a/data/reusables/code-scanning/enabling-options.md b/data/reusables/code-scanning/enabling-options.md index 23b5a7652448..d58a0f99c22f 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.github %} (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/how-tos/find-and-fix-code-vulnerabilities/configure-code-scanning/configure-code-scanning)) or advanced setup (see [AUTOTITLE](/code-security/how-tos/find-and-fix-code-vulnerabilities/configure-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/how-tos/find-and-fix-code-vulnerabilities/integrate-with-existing-tools/use-with-existing-ci-system)). +* **Third‑party:** Uses {% data variables.product.prodname_actions %} {% ifversion fpt or ghec %}(see [AUTOTITLE](/code-security/how-tos/find-and-fix-code-vulnerabilities/configure-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.github %} (see [AUTOTITLE](/code-security/how-tos/find-and-fix-code-vulnerabilities/integrate-with-existing-tools/upload-sarif-file)). 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 06a225011957..01b33b052500 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](/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/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 9fd69f367533..3e3dfe3d42e4 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](/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/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_code_security %} 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_code_security %} policy at the enterprise level. For more information, see [AUTOTITLE](/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise). {% endif %} 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 0a436d919992..955af1892e09 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/reference/code-scanning/sarif-files/sarif-support). diff --git a/data/reusables/code-scanning/max-paths-setting.md b/data/reusables/code-scanning/max-paths-setting.md index a7d87935f787..39baf14f73d1 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/reference/code-scanning/codeql/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/run-additional-queries.md b/data/reusables/code-scanning/run-additional-queries.md index 2e4c04f2ec34..bc1670915e2f 100644 --- a/data/reusables/code-scanning/run-additional-queries.md +++ b/data/reusables/code-scanning/run-additional-queries.md @@ -3,7 +3,7 @@ When you use {% data variables.product.prodname_codeql %} to scan code, the {% d > [!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 [Custom configuration files](#custom-configuration-files) 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/concepts/code-scanning/codeql/codeql-code-scanning#about-codeql-queries). The options available to specify the additional queries you want to run are: diff --git a/data/reusables/code-scanning/sarif-upload-retry.md b/data/reusables/code-scanning/sarif-upload-retry.md index 9d42e5c1a477..e5a23ab42e09 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/reference/code-scanning/sarif-files/sarif-support). diff --git a/data/reusables/code-scanning/security-configuration-enforcement-edge-cases.md b/data/reusables/code-scanning/security-configuration-enforcement-edge-cases.md index 49d48b4c62d0..70571370f2cd 100644 --- a/data/reusables/code-scanning/security-configuration-enforcement-edge-cases.md +++ b/data/reusables/code-scanning/security-configuration-enforcement-edge-cases.md @@ -1 +1 @@ -> [!NOTE] Some situations can break the enforcement of {% data variables.product.prodname_security_configurations %}. See [AUTOTITLE](/code-security/reference/security-at-scale/security-configuration-enforcement). +> [!NOTE] Some situations can break the enforcement of {% data variables.product.prodname_security_configurations %}. See [AUTOTITLE](/code-security/reference/security-at-scale/configuration-enforcement). diff --git a/data/reusables/code-scanning/track-alert-in-issue.md b/data/reusables/code-scanning/track-alert-in-issue.md index 15d95017fb23..9c2d9a4abb8f 100644 --- a/data/reusables/code-scanning/track-alert-in-issue.md +++ b/data/reusables/code-scanning/track-alert-in-issue.md @@ -1,5 +1,5 @@ {% ifversion code-scanning-link-alert-to-issue %} -To track remediation work in your team's workflow without leaving {% data variables.product.github %}, you can link alerts to issues. See [AUTOTITLE](/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/linking-code-scanning-alerts-to-github-issues). +To track remediation work in your team's workflow without leaving {% data variables.product.github %}, you can link alerts to issues. See [AUTOTITLE](/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/track-alerts-in-issues). {% endif %} diff --git a/data/reusables/code-scanning/troubleshooting-multiple-configurations.md b/data/reusables/code-scanning/troubleshooting-multiple-configurations.md index 567b71805d83..84737fafb708 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/concepts/code-scanning/code-scanning-alerts#about-alerts-from-multiple-configurations) and [AUTOTITLE](/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/resolve-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 53bea374c676..06a42cf05d64 100644 --- a/data/reusables/code-scanning/upload-sarif-alert-limit.md +++ b/data/reusables/code-scanning/upload-sarif-alert-limit.md @@ -1 +1 @@ -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#file-compatibility). +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/reference/code-scanning/sarif-files/sarif-support#file-compatibility). diff --git a/data/reusables/code-scanning/using-security-overview-coverage.md b/data/reusables/code-scanning/using-security-overview-coverage.md index 66564b12f11e..a54fffd76746 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/how-tos/manage-security-alerts/remediate-alerts-at-scale/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-repository-roles/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 f59f4af96bd6..51adec5de82a 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/how-tos/manage-security-alerts/remediate-alerts-at-scale/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/advanced-query-execution.md b/data/reusables/codeql-cli/advanced-query-execution.md index 68fe27c84636..2d020443e104 100644 --- a/data/reusables/codeql-cli/advanced-query-execution.md +++ b/data/reusables/codeql-cli/advanced-query-execution.md @@ -1,7 +1,7 @@ > [!NOTE] > Queries run with `database analyze` have strict [metadata requirements](https://codeql.github.com/docs/codeql-cli/using-custom-queries-with-the-codeql-cli/#including-query-metadata). You can also execute queries using the following plumbing-level subcommands: > -> * [AUTOTITLE](/code-security/codeql-cli/codeql-cli-manual/database-run-queries), which outputs non-interpreted results in an intermediate binary format called [BQRS](https://codeql.github.com/docs/codeql-overview/codeql-glossary/#bqrs-file). -> * [AUTOTITLE](/code-security/codeql-cli/codeql-cli-manual/query-run), which will output BQRS files, or print results tables directly to the command line. Viewing results directly in the command line may be useful for iterative query development using the CLI. +> * [AUTOTITLE](/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-run-queries), which outputs non-interpreted results in an intermediate binary format called [BQRS](https://codeql.github.com/docs/codeql-overview/codeql-glossary/#bqrs-file). +> * [AUTOTITLE](/code-security/reference/code-scanning/codeql/codeql-cli-manual/query-run), which will output BQRS files, or print results tables directly to the command line. Viewing results directly in the command line may be useful for iterative query development using the CLI. > -> Queries run with these commands don’t have the same metadata requirements. However, to save human-readable data you have to process each BQRS results file using the [AUTOTITLE](/code-security/codeql-cli/codeql-cli-manual/bqrs-decode) plumbing subcommand. Therefore, for most use cases it’s easiest to use database analyze to directly generate interpreted results. +> Queries run with these commands don’t have the same metadata requirements. However, to save human-readable data you have to process each BQRS results file using the [AUTOTITLE](/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-decode) plumbing subcommand. Therefore, for most use cases it’s easiest to use database analyze to directly generate interpreted results. diff --git a/data/reusables/codeql-cli/launch-codeql.md b/data/reusables/codeql-cli/launch-codeql.md index b490ebda9fb9..e021acdcd250 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/reference/code-scanning/codeql/codeql-cli-manual). diff --git a/data/reusables/codespaces/about-changing-storage-size.md b/data/reusables/codespaces/about-changing-storage-size.md index c2d9154af467..23e785b2a105 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-a-codespace/stopping-and-starting-a-codespace#restarting-a-codespace). diff --git a/data/reusables/codespaces/codespaces-continue-by-paying.md b/data/reusables/codespaces/codespaces-continue-by-paying.md index 51b33755c5c2..da8038f5b5f0 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/concepts/product-billing/github-codespaces). diff --git a/data/reusables/codespaces/codespaces-machine-types.md b/data/reusables/codespaces/codespaces-machine-types.md index 41636c6b1804..e56bfae79326 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/concepts/product-billing/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-spending-limit-requirement.md b/data/reusables/codespaces/codespaces-spending-limit-requirement.md index aafcb78e7aa9..69a0e364a40e 100644 --- a/data/reusables/codespaces/codespaces-spending-limit-requirement.md +++ b/data/reusables/codespaces/codespaces-spending-limit-requirement.md @@ -1 +1 @@ -Accounts may have spending limits that prevent new codespaces being created, or existing codespaces being opened, if doing so would incur a billable cost to your personal, organization, or enterprise account. Check your account's budgets to ensure they are appropriate for your usage needs. See [AUTOTITLE](/billing/managing-your-billing/using-budgets-control-spending). +Accounts may have spending limits that prevent new codespaces being created, or existing codespaces being opened, if doing so would incur a billable cost to your personal, organization, or enterprise account. Check your account's budgets to ensure they are appropriate for your usage needs. See [AUTOTITLE](/billing/how-tos/set-up-budgets). diff --git a/data/reusables/codespaces/codespaces-unavailable-for-emus.md b/data/reusables/codespaces/codespaces-unavailable-for-emus.md index b0cb3a7a85dc..b545c76f509a 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/concepts/identity-and-access-management/enterprise-managed-users). diff --git a/data/reusables/codespaces/committing-link-to-procedure.md b/data/reusables/codespaces/committing-link-to-procedure.md index d636dcfd1172..3551abf6c0e4 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-a-codespace/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 cadfb904a5a8..491ede5c2d4a 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-a-codespace/using-github-codespaces-in-visual-studio-code). diff --git a/data/reusables/codespaces/devcontainer-properties-1.md b/data/reusables/codespaces/devcontainer-properties-1.md index 0c9e7862e9df..23b006cd6441 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). +* **forwardPorts:** Any ports listed here will be forwarded automatically. For more information, see [AUTOTITLE](/codespaces/developing-in-a-codespace/forwarding-ports-in-your-codespace). diff --git a/data/reusables/codespaces/developing-in-vscode.md b/data/reusables/codespaces/developing-in-vscode.md index 543ba1a6b75d..cbbec68e431e 100644 --- a/data/reusables/codespaces/developing-in-vscode.md +++ b/data/reusables/codespaces/developing-in-vscode.md @@ -8,7 +8,7 @@ You can use a [dotfiles](https://dotfiles.github.io/tutorials/) repository and [ ### 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-a-codespace/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/reference/using-the-vs-code-command-palette-in-codespaces). diff --git a/data/reusables/codespaces/emus-create-codespaces.md b/data/reusables/codespaces/emus-create-codespaces.md index 4dc9baf9c00c..052ad6ce0960 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/concepts/identity-and-access-management/enterprise-managed-users#abilities-and-restrictions-of-managed-user-accounts). diff --git a/data/reusables/codespaces/forwarded-ports-environment-variable.md b/data/reusables/codespaces/forwarded-ports-environment-variable.md index 5c42a06a132c..0fe025cafb99 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-a-codespace/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 78dc2262a089..a3600b736f73 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-a-codespace/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 dd8fbb6a65f0..48bf2c732580 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-a-codespace/stopping-and-starting-a-codespace). diff --git a/data/reusables/codespaces/links-to-get-started.md b/data/reusables/codespaces/links-to-get-started.md index f1c62d27bf16..ce2401f8cf04 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/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/about-codespaces/deep-dive). +To get started with {% data variables.product.prodname_github_codespaces %}, see [AUTOTITLE](/codespaces/quickstart). For more information on creating a codespace, see [AUTOTITLE](/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository) or [AUTOTITLE](/codespaces/developing-in-a-codespace/creating-a-codespace-from-a-template). If you want to return to a codespace you've already created, see [AUTOTITLE](/codespaces/developing-in-a-codespace/opening-an-existing-codespace). To learn more about how {% data variables.product.prodname_github_codespaces %} works, see [AUTOTITLE](/codespaces/about-codespaces/deep-dive). diff --git a/data/reusables/codespaces/next-steps-adding-devcontainer.md b/data/reusables/codespaces/next-steps-adding-devcontainer.md index a44c08bc3a7b..bec7c0dcae05 100644 --- a/data/reusables/codespaces/next-steps-adding-devcontainer.md +++ b/data/reusables/codespaces/next-steps-adding-devcontainer.md @@ -3,4 +3,4 @@ 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/developing-in-a-codespace/forwarding-ports-in-your-codespace) diff --git a/data/reusables/codespaces/secrets-on-start.md b/data/reusables/codespaces/secrets-on-start.md index 2f2284a3ea48..53b6d5c2f292 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/reference/using-the-vs-code-command-palette-in-codespaces#suspending-or-stopping-a-codespace). diff --git a/data/reusables/codespaces/settings-sync-and-gpg.md b/data/reusables/codespaces/settings-sync-and-gpg.md index 92893c4e15eb..5cac33eb7966 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/reference/security-in-github-codespaces#using-settings-sync). diff --git a/data/reusables/codespaces/source-control.md b/data/reusables/codespaces/source-control.md index f30abcdcc9cb..50560bd6f6cd 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-a-codespace/creating-a-codespace-from-a-template#publishing-to-a-repository-on-github). {% data reusables.codespaces.publishing-template-codespaces %} diff --git a/data/reusables/codespaces/stopping-a-codespace.md b/data/reusables/codespaces/stopping-a-codespace.md index a128992f835b..2f26e7ddaa1e 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/about-codespaces/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/about-codespaces/understanding-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 54194d0a1b0c..9f8278fc5c2e 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-a-codespace/opening-an-existing-codespace). diff --git a/data/reusables/codespaces/trusted-repos-step.md b/data/reusables/codespaces/trusted-repos-step.md index baa96fd78421..bff09fef910d 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/reference/security-in-github-codespaces#using-settings-sync). diff --git a/data/reusables/command_line/provide-an-access-token.md b/data/reusables/command_line/provide-an-access-token.md index 6b0d2b16b0f7..58d332856d26 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 and you are using a {% data variables.product.pat_v1 %}, 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 and you are using a {% data variables.product.pat_v1 %}, 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-single-sign-on/about-authentication-with-single-sign-on) and [AUTOTITLE](/authentication/authenticating-with-single-sign-on/authorizing-a-personal-access-token-for-use-with-single-sign-on).{% endif %} From 8c0c8abc960db90102916d8e0cee8f82e8480d87 Mon Sep 17 00:00:00 2001 From: Kevin Heis Date: Thu, 9 Jul 2026 11:30:19 -0700 Subject: [PATCH 12/15] Update redirected internal links in data/reusables (actions (part 2)) (#62169) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- data/reusables/actions/viewing-actions-metrics.md | 4 ++-- .../actions/workflow-basic-example-and-explanation.md | 2 +- data/reusables/actions/workflow-dispatch-inputs.md | 2 +- data/reusables/actions/workflow-permissions-intro.md | 2 +- data/reusables/actions/workflow-permissions-modifying.md | 2 +- data/reusables/actions/workflow-run-approve-link.md | 2 +- data/reusables/actions/workflow-run-approve-public-fork.md | 4 ++-- data/reusables/actions/workflow-runs-dependabot-note.md | 2 +- data/reusables/actions/workflow-templates-categories.md | 6 +++--- .../actions/workflow-templates-for-more-information.md | 2 +- .../reusables/actions/workflows-from-public-fork-setting.md | 2 +- .../actions/workflows/run-on-specific-branches-or-tags1.md | 4 ++-- .../actions/workflows/section-specifying-branches.md | 2 +- .../workflows/section-triggering-a-workflow-types.md | 2 +- .../actions/workflows/section-triggering-a-workflow.md | 2 +- .../actions/workflows/triggering-a-workflow-paths1.md | 2 +- .../actions/workflows/triggering-a-workflow-paths2.md | 2 +- .../actions/workflows/triggering-workflow-branches1.md | 4 ++-- .../actions/workflows/triggering-workflow-branches2.md | 2 +- 19 files changed, 25 insertions(+), 25 deletions(-) diff --git a/data/reusables/actions/viewing-actions-metrics.md b/data/reusables/actions/viewing-actions-metrics.md index b09b151a5937..485a65bcb2fd 100644 --- a/data/reusables/actions/viewing-actions-metrics.md +++ b/data/reusables/actions/viewing-actions-metrics.md @@ -1,6 +1,6 @@ 1. In the "Insights" navigation menu, click **Actions Usage Metrics** or click **Actions Performance Metrics**. -1. Optionally, to select a time period to view usage metrics for, choose an option from the **Period** drop down menu at the top right of the page. For more information, see [AUTOTITLE](/actions/how-tos/administering-github-actions/viewing-github-actions-metrics#understanding-github-actions-metrics-aggregation). -1. Click on the tab that contains the metrics you would like to view. For more information, see [AUTOTITLE](/actions/concepts/about-github-actions-metrics). +1. Optionally, to select a time period to view usage metrics for, choose an option from the **Period** drop down menu at the top right of the page. For more information, see [AUTOTITLE](/actions/how-tos/administer/view-metrics#understanding-github-actions-metrics-aggregation). +1. Click on the tab that contains the metrics you would like to view. For more information, see [AUTOTITLE](/actions/concepts/metrics). 1. Optionally, to filter the data displayed in a tab, create a filter. 1. Click on the **{% octicon "filter" aria-hidden="true" aria-label="filter" %} Filter** button. 1. Click **{% octicon "plus" aria-hidden="true" aria-label="plus" %} Add a filter**. diff --git a/data/reusables/actions/workflow-basic-example-and-explanation.md b/data/reusables/actions/workflow-basic-example-and-explanation.md index 4372751002c4..1bc1348ed6a5 100644 --- a/data/reusables/actions/workflow-basic-example-and-explanation.md +++ b/data/reusables/actions/workflow-basic-example-and-explanation.md @@ -70,7 +70,7 @@ jobs: ### Visualizing the workflow file -In this diagram, you can see the workflow file you just created and how the {% data variables.product.prodname_actions %} components are organized in a hierarchy. Each step executes a single action or shell script. Steps 1 and 2 run actions, while steps 3 and 4 run shell scripts. To find more prebuilt actions for your workflows, see [AUTOTITLE](/actions/learn-github-actions/finding-and-customizing-actions). +In this diagram, you can see the workflow file you just created and how the {% data variables.product.prodname_actions %} components are organized in a hierarchy. Each step executes a single action or shell script. Steps 1 and 2 run actions, while steps 3 and 4 run shell scripts. To find more prebuilt actions for your workflows, see [AUTOTITLE](/actions/how-tos/write-workflows/choose-what-workflows-do/find-and-customize-actions). ![Diagram showing the trigger, runner, and job of a workflow. The job is broken into 4 steps.](/assets/images/help/actions/overview-actions-event.png) diff --git a/data/reusables/actions/workflow-dispatch-inputs.md b/data/reusables/actions/workflow-dispatch-inputs.md index 204a6e805377..292ffd8ae1b6 100644 --- a/data/reusables/actions/workflow-dispatch-inputs.md +++ b/data/reusables/actions/workflow-dispatch-inputs.md @@ -1,3 +1,3 @@ -The triggered workflow receives the inputs in the `inputs` context. For more information, see [Contexts](/actions/learn-github-actions/contexts#inputs-context). +The triggered workflow receives the inputs in the `inputs` context. For more information, see [Contexts](/actions/reference/workflows-and-actions/contexts#inputs-context). {% data reusables.actions.inputs-vs-github-event-inputs %} diff --git a/data/reusables/actions/workflow-permissions-intro.md b/data/reusables/actions/workflow-permissions-intro.md index 5ded31dd0706..40b0da0b0632 100644 --- a/data/reusables/actions/workflow-permissions-intro.md +++ b/data/reusables/actions/workflow-permissions-intro.md @@ -1 +1 @@ -You can set the default permissions granted to the `GITHUB_TOKEN`. For more information about the `GITHUB_TOKEN`, see [AUTOTITLE](/actions/security-guides/automatic-token-authentication). You can choose a restricted set of permissions as the default, or apply permissive settings. +You can set the default permissions granted to the `GITHUB_TOKEN`. For more information about the `GITHUB_TOKEN`, see [AUTOTITLE](/actions/tutorials/authenticate-with-github_token). You can choose a restricted set of permissions as the default, or apply permissive settings. diff --git a/data/reusables/actions/workflow-permissions-modifying.md b/data/reusables/actions/workflow-permissions-modifying.md index 22d44c41e720..2e0e145ece8d 100644 --- a/data/reusables/actions/workflow-permissions-modifying.md +++ b/data/reusables/actions/workflow-permissions-modifying.md @@ -1 +1 @@ -Anyone with write access to a repository can modify the permissions granted to the `GITHUB_TOKEN`, adding or removing access as required, by editing the `permissions` key in the workflow file. For more information, see [`permissions`](/actions/using-workflows/workflow-syntax-for-github-actions#permissions). +Anyone with write access to a repository can modify the permissions granted to the `GITHUB_TOKEN`, adding or removing access as required, by editing the `permissions` key in the workflow file. For more information, see [`permissions`](/actions/reference/workflows-and-actions/workflow-syntax#permissions). diff --git a/data/reusables/actions/workflow-run-approve-link.md b/data/reusables/actions/workflow-run-approve-link.md index 5682f2e1c5c6..a5e50818cd61 100644 --- a/data/reusables/actions/workflow-run-approve-link.md +++ b/data/reusables/actions/workflow-run-approve-link.md @@ -1 +1 @@ -For more information about approving workflow runs that this policy applies to, see [AUTOTITLE](/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks). +For more information about approving workflow runs that this policy applies to, see [AUTOTITLE](/actions/how-tos/manage-workflow-runs/approve-runs-from-forks). diff --git a/data/reusables/actions/workflow-run-approve-public-fork.md b/data/reusables/actions/workflow-run-approve-public-fork.md index e18d1c990a16..a0de9ac76a7a 100644 --- a/data/reusables/actions/workflow-run-approve-public-fork.md +++ b/data/reusables/actions/workflow-run-approve-public-fork.md @@ -7,6 +7,6 @@ To help prevent this, workflows on pull requests to public repositories from som By default, all first-time contributors require approval to run workflows. -Workflows triggered by `pull_request_target` events are run in the context of the base branch. Since the base branch is considered trusted, workflows triggered by these events will always run, regardless of approval settings. For more information about the `pull_request_target` event, see [AUTOTITLE](/actions/using-workflows/events-that-trigger-workflows#pull_request_target). +Workflows triggered by `pull_request_target` events are run in the context of the base branch. Since the base branch is considered trusted, workflows triggered by these events will always run, regardless of approval settings. For more information about the `pull_request_target` event, see [AUTOTITLE](/actions/reference/workflows-and-actions/events-that-trigger-workflows#pull_request_target). ->[!WARNING] These workflow approval policies are intended to restrict the set of users that can execute workflows in {% data variables.product.prodname_actions %} runners that could lead to unexpected resource and compute consumption when using {% data variables.product.prodname_dotcom %}-hosted runners. If you are using self-hosted runners, potentially malicious user-controlled workflow code will execute automatically if the user is allowed to bypass approval in the set approval policy or if the pull request is approved. You must consider the risk of executing this code in your infrastructure and should review and follow the self-hosted runner security recommendations regardless of the approval settings utilized. See [AUTOTITLE](/actions/security-for-github-actions/security-guides/security-hardening-for-github-actions#hardening-for-self-hosted-runners). +> [!WARNING] These workflow approval policies are intended to restrict the set of users that can execute workflows in {% data variables.product.prodname_actions %} runners that could lead to unexpected resource and compute consumption when using {% data variables.product.prodname_dotcom %}-hosted runners. If you are using self-hosted runners, potentially malicious user-controlled workflow code will execute automatically if the user is allowed to bypass approval in the set approval policy or if the pull request is approved. You must consider the risk of executing this code in your infrastructure and should review and follow the self-hosted runner security recommendations regardless of the approval settings utilized. See [AUTOTITLE](/actions/reference/security/secure-use#hardening-for-self-hosted-runners). diff --git a/data/reusables/actions/workflow-runs-dependabot-note.md b/data/reusables/actions/workflow-runs-dependabot-note.md index 1adde2b7df61..be4c9ebfdf8e 100644 --- a/data/reusables/actions/workflow-runs-dependabot-note.md +++ b/data/reusables/actions/workflow-runs-dependabot-note.md @@ -1 +1 @@ -Workflow runs triggered by {% data variables.product.prodname_dependabot %} pull requests run as if they are from a forked repository, and therefore use a read-only `GITHUB_TOKEN`. These workflow runs cannot access any secrets. For information about strategies to keep these workflows secure, see [AUTOTITLE](/actions/security-guides/security-hardening-for-github-actions). +Workflow runs triggered by {% data variables.product.prodname_dependabot %} pull requests run as if they are from a forked repository, and therefore use a read-only `GITHUB_TOKEN`. These workflow runs cannot access any secrets. For information about strategies to keep these workflows secure, see [AUTOTITLE](/actions/reference/security/secure-use). diff --git a/data/reusables/actions/workflow-templates-categories.md b/data/reusables/actions/workflow-templates-categories.md index 7a558345d300..1b038ca73447 100644 --- a/data/reusables/actions/workflow-templates-categories.md +++ b/data/reusables/actions/workflow-templates-categories.md @@ -1,5 +1,5 @@ {% data variables.product.prodname_dotcom %} provides ready-to-use workflow templates for the following high level categories: -* **Deployment (CD)**. For more information, see [AUTOTITLE](/actions/deployment/about-deployments/about-continuous-deployment). -{% ifversion fpt or ghec %}- **Security**. For more information, 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-actions).{% endif %} -* **Continuous Integration (CI)**. For more information, see [AUTOTITLE](/actions/automating-builds-and-tests/about-continuous-integration). +* **Deployment (CD)**. For more information, see [AUTOTITLE](/actions/get-started/continuous-deployment). +{% ifversion fpt or ghec %}* **Security**. For more information, see [AUTOTITLE](/code-security/how-tos/find-and-fix-code-vulnerabilities/configure-code-scanning/configuring-advanced-setup-for-code-scanning#configuring-code-scanning-using-third-party-actions).{% endif %} +* **Continuous Integration (CI)**. For more information, see [AUTOTITLE](/actions/get-started/continuous-integration). * **Automation**. Automation workflow templates offer solutions for automating workflows, such as triaging pull requests and applying a label based on the paths that are modified in the pull request, or greeting users who are first time contributors to the repository. diff --git a/data/reusables/actions/workflow-templates-for-more-information.md b/data/reusables/actions/workflow-templates-for-more-information.md index 73a952076334..2d312e8e7785 100644 --- a/data/reusables/actions/workflow-templates-for-more-information.md +++ b/data/reusables/actions/workflow-templates-for-more-information.md @@ -1 +1 @@ -To get started with preconfigured workflows, browse through the list of templates in the [actions/starter-workflows](https://github.com/actions/starter-workflows) repository. For more information, see [AUTOTITLE](/actions/writing-workflows/using-starter-workflows). +To get started with preconfigured workflows, browse through the list of templates in the [actions/starter-workflows](https://github.com/actions/starter-workflows) repository. For more information, see [AUTOTITLE](/actions/how-tos/write-workflows/use-workflow-templates). diff --git a/data/reusables/actions/workflows-from-public-fork-setting.md b/data/reusables/actions/workflows-from-public-fork-setting.md index 23cbb867a379..b7dbc0f95a33 100644 --- a/data/reusables/actions/workflows-from-public-fork-setting.md +++ b/data/reusables/actions/workflows-from-public-fork-setting.md @@ -1,4 +1,4 @@ -1. Under **Approval for running fork pull request workflows from contributors**, choose which subset of users will require approval before running workflows on their pull requests. Both the pull request author and the actor of the pull request event triggering the workflow will be checked to determine if approval is required. If approval is required, a user with write access to the repository must approve the pull request workflow to be run. See [AUTOTITLE](/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/approving-workflow-runs-from-public-forks). +1. Under **Approval for running fork pull request workflows from contributors**, choose which subset of users will require approval before running workflows on their pull requests. Both the pull request author and the actor of the pull request event triggering the workflow will be checked to determine if approval is required. If approval is required, a user with write access to the repository must approve the pull request workflow to be run. See [AUTOTITLE](/actions/how-tos/manage-workflow-runs/approve-runs-from-forks). >[!WARNING] When requiring approvals only for first-time contributors (the first two settings), a user that has had any commit or pull request merged into the repository will not require approval. A malicious user could meet this requirement by getting a simple typo or other innocuous change accepted by a maintainer, either as part of a pull request they have authored or as part of another user's pull request. diff --git a/data/reusables/actions/workflows/run-on-specific-branches-or-tags1.md b/data/reusables/actions/workflows/run-on-specific-branches-or-tags1.md index d08d59adf887..47503d024b6f 100644 --- a/data/reusables/actions/workflows/run-on-specific-branches-or-tags1.md +++ b/data/reusables/actions/workflows/run-on-specific-branches-or-tags1.md @@ -5,6 +5,6 @@ Use the `branches` filter when you want to include branch name patterns or when Use the `tags` filter when you want to include tag name patterns or when you want to both include and exclude tag names patterns. Use the `tags-ignore` filter when you only want to exclude tag name patterns. You cannot use both the `tags` and `tags-ignore` filters for the same event in a workflow. -If you define only `tags`/`tags-ignore` or only `branches`/`branches-ignore`, the workflow won't run for events affecting the undefined Git ref. If you define neither `tags`/`tags-ignore` or `branches`/`branches-ignore`, the workflow will run for events affecting either branches or tags. If you define both `branches`/`branches-ignore` and [`paths`/`paths-ignore`](/actions/using-workflows/workflow-syntax-for-github-actions#onpushpull_requestpull_request_targetpathspaths-ignore), the workflow will only run when both filters are satisfied. +If you define only `tags`/`tags-ignore` or only `branches`/`branches-ignore`, the workflow won't run for events affecting the undefined Git ref. If you define neither `tags`/`tags-ignore` or `branches`/`branches-ignore`, the workflow will run for events affecting either branches or tags. If you define both `branches`/`branches-ignore` and [`paths`/`paths-ignore`](/actions/reference/workflows-and-actions/workflow-syntax#onpushpull_requestpull_request_targetpathspaths-ignore), the workflow will only run when both filters are satisfied. -The `branches`, `branches-ignore`, `tags`, and `tags-ignore` keywords accept glob patterns that use characters like `*`, `**`, `+`, `?`, `!` and others to match more than one branch or tag name. If a name contains any of these characters and you want a literal match, you need to _escape_ each of these special characters with `\`. For more information about glob patterns, see the [AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet). +The `branches`, `branches-ignore`, `tags`, and `tags-ignore` keywords accept glob patterns that use characters like `*`, `**`, `+`, `?`, `!` and others to match more than one branch or tag name. If a name contains any of these characters and you want a literal match, you need to _escape_ each of these special characters with `\`. For more information about glob patterns, see the [AUTOTITLE](/actions/reference/workflows-and-actions/workflow-syntax#filter-pattern-cheat-sheet). diff --git a/data/reusables/actions/workflows/section-specifying-branches.md b/data/reusables/actions/workflows/section-specifying-branches.md index baa7a1aae482..7d7e404910cf 100644 --- a/data/reusables/actions/workflows/section-specifying-branches.md +++ b/data/reusables/actions/workflows/section-specifying-branches.md @@ -1,7 +1,7 @@ When using the `workflow_run` event, you can specify what branches the triggering workflow must run on in order to trigger your workflow. -The `branches` and `branches-ignore` filters accept glob patterns that use characters like `*`, `**`, `+`, `?`, `!` and others to match more than one branch name. If a name contains any of these characters and you want a literal match, you need to _escape_ each of these special characters with `\`. For more information about glob patterns, see the [AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet). +The `branches` and `branches-ignore` filters accept glob patterns that use characters like `*`, `**`, `+`, `?`, `!` and others to match more than one branch name. If a name contains any of these characters and you want a literal match, you need to _escape_ each of these special characters with `\`. For more information about glob patterns, see the [AUTOTITLE](/actions/reference/workflows-and-actions/workflow-syntax#filter-pattern-cheat-sheet). For example, a workflow with the following trigger will only run when the workflow named `Build` runs on a branch whose name starts with `releases/`: diff --git a/data/reusables/actions/workflows/section-triggering-a-workflow-types.md b/data/reusables/actions/workflows/section-triggering-a-workflow-types.md index 2b3e57fcd1d8..15130ad4f750 100644 --- a/data/reusables/actions/workflows/section-triggering-a-workflow-types.md +++ b/data/reusables/actions/workflows/section-triggering-a-workflow-types.md @@ -1,6 +1,6 @@ Use `on..types` to define the type of activity that will trigger a workflow run. Most GitHub events are triggered by more than one type of activity. For example, the `label` is triggered when a label is `created`, `edited`, or `deleted`. The `types` keyword enables you to narrow down activity that causes the workflow to run. When only one activity type triggers a webhook event, the `types` keyword is unnecessary. -You can use an array of event `types`. For more information about each event and their activity types, see [AUTOTITLE](/actions/using-workflows/events-that-trigger-workflows#available-events). +You can use an array of event `types`. For more information about each event and their activity types, see [AUTOTITLE](/actions/reference/workflows-and-actions/events-that-trigger-workflows#available-events). ```yaml on: diff --git a/data/reusables/actions/workflows/section-triggering-a-workflow.md b/data/reusables/actions/workflows/section-triggering-a-workflow.md index 6e9a613a8f1c..e050213db2f9 100644 --- a/data/reusables/actions/workflows/section-triggering-a-workflow.md +++ b/data/reusables/actions/workflows/section-triggering-a-workflow.md @@ -1,5 +1,5 @@ -To automatically trigger a workflow, use `on` to define which events can cause the workflow to run. For a list of available events, see [AUTOTITLE](/actions/using-workflows/events-that-trigger-workflows). +To automatically trigger a workflow, use `on` to define which events can cause the workflow to run. For a list of available events, see [AUTOTITLE](/actions/reference/workflows-and-actions/events-that-trigger-workflows). You can define single or multiple events that can trigger a workflow, or set a time schedule. You can also restrict the execution of a workflow to only occur for specific files, tags, or branch changes. These options are described in the following sections. diff --git a/data/reusables/actions/workflows/triggering-a-workflow-paths1.md b/data/reusables/actions/workflows/triggering-a-workflow-paths1.md index 6fc9ec1cca2a..36e054aa659f 100644 --- a/data/reusables/actions/workflows/triggering-a-workflow-paths1.md +++ b/data/reusables/actions/workflows/triggering-a-workflow-paths1.md @@ -10,4 +10,4 @@ Use the `paths` filter when you want to include file path patterns or when you w If you define both `branches`/`branches-ignore` and `paths`/`paths-ignore`, the workflow will only run when both filters are satisfied. -The `paths` and `paths-ignore` keywords accept glob patterns that use the `*` and `**` wildcard characters to match more than one path name. For more information, see the [AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet). +The `paths` and `paths-ignore` keywords accept glob patterns that use the `*` and `**` wildcard characters to match more than one path name. For more information, see the [AUTOTITLE](/actions/reference/workflows-and-actions/workflow-syntax#filter-pattern-cheat-sheet). diff --git a/data/reusables/actions/workflows/triggering-a-workflow-paths2.md b/data/reusables/actions/workflows/triggering-a-workflow-paths2.md index 77a69daf43c8..a2220738b7cc 100644 --- a/data/reusables/actions/workflows/triggering-a-workflow-paths2.md +++ b/data/reusables/actions/workflows/triggering-a-workflow-paths2.md @@ -9,4 +9,4 @@ on: {% data reusables.pull_requests.path-filtering-required-workflows %} -If a workflow is skipped due to path filtering, [branch filtering](/actions/using-workflows/workflow-syntax-for-github-actions#onpull_requestpull_request_targetbranchesbranches-ignore), or a [commit message](/actions/managing-workflow-runs/skipping-workflow-runs), then checks associated with that workflow will remain in a "Pending" state. A pull request that requires those checks to be successful will be blocked from merging. +If a workflow is skipped due to path filtering, [branch filtering](/actions/reference/workflows-and-actions/workflow-syntax#onpull_requestpull_request_targetbranchesbranches-ignore), or a [commit message](/actions/how-tos/manage-workflow-runs/skip-workflow-runs), then checks associated with that workflow will remain in a "Pending" state. A pull request that requires those checks to be successful will be blocked from merging. diff --git a/data/reusables/actions/workflows/triggering-workflow-branches1.md b/data/reusables/actions/workflows/triggering-workflow-branches1.md index 83fabf7a068a..366671b58173 100644 --- a/data/reusables/actions/workflows/triggering-workflow-branches1.md +++ b/data/reusables/actions/workflows/triggering-workflow-branches1.md @@ -2,6 +2,6 @@ When using the `pull_request` and `pull_request_target` events, you can configur Use the `branches` filter when you want to include branch name patterns or when you want to both include and exclude branch names patterns. Use the `branches-ignore` filter when you only want to exclude branch name patterns. You cannot use both the `branches` and `branches-ignore` filters for the same event in a workflow. -If you define both `branches`/`branches-ignore` and [`paths`/`paths-ignore`](/actions/using-workflows/workflow-syntax-for-github-actions#onpushpull_requestpull_request_targetpathspaths-ignore), the workflow will only run when both filters are satisfied. +If you define both `branches`/`branches-ignore` and [`paths`/`paths-ignore`](/actions/reference/workflows-and-actions/workflow-syntax#onpushpull_requestpull_request_targetpathspaths-ignore), the workflow will only run when both filters are satisfied. -The `branches` and `branches-ignore` keywords accept glob patterns that use characters like `*`, `**`, `+`, `?`, `!` and others to match more than one branch name. If a name contains any of these characters and you want a literal match, you need to escape each of these special characters with `\`. For more information about glob patterns, see the [AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet). +The `branches` and `branches-ignore` keywords accept glob patterns that use characters like `*`, `**`, `+`, `?`, `!` and others to match more than one branch name. If a name contains any of these characters and you want a literal match, you need to escape each of these special characters with `\`. For more information about glob patterns, see the [AUTOTITLE](/actions/reference/workflows-and-actions/workflow-syntax#filter-pattern-cheat-sheet). diff --git a/data/reusables/actions/workflows/triggering-workflow-branches2.md b/data/reusables/actions/workflows/triggering-workflow-branches2.md index 0ad8c1a9bf3f..94121241da27 100644 --- a/data/reusables/actions/workflows/triggering-workflow-branches2.md +++ b/data/reusables/actions/workflows/triggering-workflow-branches2.md @@ -16,4 +16,4 @@ on: {% data reusables.pull_requests.path-filtering-required-workflows %} -If a workflow is skipped due to branch filtering, [path filtering](/actions/using-workflows/workflow-syntax-for-github-actions#onpushpull_requestpull_request_targetpathspaths-ignore), or a [commit message](/actions/managing-workflow-runs/skipping-workflow-runs), then checks associated with that workflow will remain in a "Pending" state. A pull request that requires those checks to be successful will be blocked from merging. +If a workflow is skipped due to branch filtering, [path filtering](/actions/reference/workflows-and-actions/workflow-syntax#onpushpull_requestpull_request_targetpathspaths-ignore), or a [commit message](/actions/how-tos/manage-workflow-runs/skip-workflow-runs), then checks associated with that workflow will remain in a "Pending" state. A pull request that requires those checks to be successful will be blocked from merging. From daeca22ac07ae6508cac178358e872747378da19 Mon Sep 17 00:00:00 2001 From: Kevin Heis Date: Thu, 9 Jul 2026 11:30:21 -0700 Subject: [PATCH 13/15] Update redirected internal links in data/reusables (actions (part 1)) (#62168) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../actions/about-artifact-attestations.md | 2 +- data/reusables/actions/about-environments.md | 2 +- .../reusables/actions/about-larger-runners.md | 2 +- .../actions/about-oidc-short-overview.md | 2 +- .../about-security-hardening-for-worklows.md | 2 +- data/reusables/actions/about-triggers.md | 4 +-- .../actions/action-bundled-actions.md | 2 +- .../actions/actions-activity-types.md | 2 +- data/reusables/actions/actions-billing.md | 2 +- .../actions-runner-controller-about-arc.md | 2 +- ...er-controller-unsupported-customization.md | 2 +- ...ons-secrets-variables-repository-access.md | 2 +- .../actions/actions-tab-new-runners-note.md | 4 +-- .../actions/add-hosted-runner-overview.md | 2 +- .../actions/allow-specific-actions-intro.md | 8 +++--- .../actions/arc-runners-namespace.md | 2 +- .../artifact-attestations-step-explanation.md | 2 +- .../artifact-log-retention-statement.md | 2 +- .../artifacts-from-deleted-workflow-runs.md | 2 +- .../azure-vnet-about-larger-runners.md | 4 +-- .../azure-vnet-configuring-overview.md | 2 +- ...-creating-network-configuration-prereqs.md | 4 +-- .../actions/azure-vnet-enterprise-policy.md | 2 +- .../actions/azure-vnet-intro-capabilities.md | 2 +- .../actions/azure-vnet-next-steps-links.md | 2 +- .../reusables/actions/cd-templates-actions.md | 2 +- .../actions/context-injection-warning.md | 2 +- .../actions/create-azure-publish-profile.md | 2 +- ...ting-a-runner-group-for-an-organization.md | 4 +-- ...endabot-version-updates-actions-caveats.md | 2 +- .../dependabot-version-updates-for-actions.md | 2 +- .../disable-selfhosted-runners-crossrefs.md | 4 +-- .../actions/enabling-actions-metrics.md | 2 +- .../actions/enterprise-common-prereqs.md | 4 +-- .../actions/enterprise-http-proxy.md | 2 +- .../actions/enterprise-limit-actions-use.md | 2 +- .../actions/enterprise-marketplace-actions.md | 2 +- .../enterprise-postinstall-nextsteps.md | 2 +- .../actions/enterprise-setup-prereq.md | 2 +- .../actions/enterprise-storage-about.md | 2 +- .../actions/gai-custom-transformers-rec.md | 2 +- data/reusables/actions/gai-inspect-audit.md | 2 +- .../actions/general-security-hardening.md | 2 +- ...github-hosted-runners-check-concurrency.md | 2 +- .../actions/github-token-permissions.md | 2 +- .../github-token-scope-descriptions.md | 26 +++++++++---------- .../actions/github_sha_description.md | 2 +- .../actions/github_token-input-example.md | 2 +- .../actions/if-supported-contexts.md | 2 +- .../actions/internal-actions-summary.md | 2 +- .../actions/introducing-enterprise.md | 2 +- .../ip-allow-list-self-hosted-runners.md | 2 +- .../jobs/choosing-runner-github-hosted.md | 6 ++--- .../actions/jobs/choosing-runner-group.md | 2 +- .../actions/jobs/choosing-runner-overview.md | 2 +- .../jobs/choosing-runner-self-hosted.md | 2 +- ...-assigning-permissions-to-jobs-specific.md | 4 +-- .../section-assigning-permissions-to-jobs.md | 8 +++--- .../jobs/section-defining-outputs-for-jobs.md | 6 ++--- .../section-running-jobs-in-a-container.md | 2 +- .../jobs/section-using-concurrency-jobs.md | 4 +-- .../actions/jobs/section-using-concurrency.md | 4 +-- ...ing-conditions-to-control-job-execution.md | 4 +-- .../section-using-environments-for-jobs.md | 6 ++--- .../section-using-jobs-in-a-workflow-needs.md | 2 +- .../jobs/section-using-jobs-in-a-workflow.md | 2 +- ...efault-values-for-jobs-defaults-job-run.md | 2 +- ...ng-default-values-for-jobs-defaults-job.md | 2 +- ...ng-default-values-for-jobs-defaults-run.md | 2 +- ...etting-default-values-for-jobs-defaults.md | 2 +- .../actions/larger-runner-name-note.md | 2 +- .../reusables/actions/migrating-enterprise.md | 2 +- .../actions/more-resources-for-ghes.md | 2 +- .../oidc-deployment-protection-rules.md | 2 +- .../reusables/actions/oidc-further-reading.md | 4 +-- data/reusables/actions/oidc-link-to-intro.md | 2 +- data/reusables/actions/oidc-on-ghecom.md | 2 +- .../actions/oidc-permissions-token.md | 4 +-- .../reusables/actions/oidc-security-notice.md | 2 +- .../actions/onboarding-next-steps.md | 12 ++++----- .../org-access-to-github-hosted-runners.md | 2 +- .../actions/partial-reruns-with-reusable.md | 6 ++--- ...ment-secrets-and-variables-organization.md | 2 +- ...rmissions-statement-secrets-environment.md | 2 +- data/reusables/actions/reusable-keyword.md | 2 +- .../reusable-workflow-calling-syntax.md | 2 +- .../actions/runner-debug-description.md | 2 +- .../actions/runner-tool-cache-description.md | 2 +- .../secrets-and-variables-org-permissions.md | 2 +- .../actions/self-hosted-runner-configure.md | 2 +- ...self-hosted-runner-networking-to-dotcom.md | 2 +- .../self-hosted-runner-ports-protocols.md | 2 +- .../self-hosted-runner-public-repo-access.md | 2 +- .../actions/self-hosted-runner-reqs-docker.md | 2 +- .../self-hosted-runner-security-admonition.md | 2 +- .../self-hosted-runners-prerequisites.md | 2 +- .../actions/service-container-prereqs.md | 2 +- .../settings-actions-pages-custom-workflow.md | 2 +- .../actions/supported-github-runners.md | 2 +- data/reusables/actions/third-party-actions.md | 2 +- 100 files changed, 144 insertions(+), 144 deletions(-) diff --git a/data/reusables/actions/about-artifact-attestations.md b/data/reusables/actions/about-artifact-attestations.md index 4280121a911a..82717e990655 100644 --- a/data/reusables/actions/about-artifact-attestations.md +++ b/data/reusables/actions/about-artifact-attestations.md @@ -4,6 +4,6 @@ When you generate artifact attestations with your software, you create cryptogra * A link to the workflow associated with the artifact * The repository, organization, environment, commit SHA, and triggering event for the artifact -* Other information from the OIDC token used to establish provenance. For more information, see [AUTOTITLE](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect). +* Other information from the OIDC token used to establish provenance. For more information, see [AUTOTITLE](/actions/concepts/security/openid-connect). You can also generate artifact attestations that include an associated software bill of materials (SBOM). Associating your builds with a list of the open source dependencies used in them provides transparency and enables consumers to comply with data protection standards. diff --git a/data/reusables/actions/about-environments.md b/data/reusables/actions/about-environments.md index cb97e67f34c1..69def3fda42a 100644 --- a/data/reusables/actions/about-environments.md +++ b/data/reusables/actions/about-environments.md @@ -1 +1 @@ -Environments are used to describe a general deployment target like `production`, `staging`, or `development`. When a {% data variables.product.prodname_actions %} workflow deploys to an environment, the environment is displayed on the main page of the repository. You can use environments to require approval for a job to proceed, restrict which branches can trigger a workflow, gate deployments with custom deployment protection rules, or limit access to secrets. For more information about creating environments, see [AUTOTITLE](/actions/deployment/targeting-different-environments/managing-environments-for-deployment). +Environments are used to describe a general deployment target like `production`, `staging`, or `development`. When a {% data variables.product.prodname_actions %} workflow deploys to an environment, the environment is displayed on the main page of the repository. You can use environments to require approval for a job to proceed, restrict which branches can trigger a workflow, gate deployments with custom deployment protection rules, or limit access to secrets. For more information about creating environments, see [AUTOTITLE](/actions/how-tos/deploy/configure-and-manage-deployments/manage-environments). diff --git a/data/reusables/actions/about-larger-runners.md b/data/reusables/actions/about-larger-runners.md index 91aa083872e7..39607f4783c5 100644 --- a/data/reusables/actions/about-larger-runners.md +++ b/data/reusables/actions/about-larger-runners.md @@ -1,4 +1,4 @@ -{% data variables.actions.hosted_runner_caps %}s are managed virtual machines with more resources than [standard {% data variables.product.prodname_dotcom %}-hosted runners](/actions/how-tos/using-github-hosted-runners/using-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources). They offer the following advanced features: +{% data variables.actions.hosted_runner_caps %}s are managed virtual machines with more resources than [standard {% data variables.product.prodname_dotcom %}-hosted runners](/actions/concepts/runners/github-hosted-runners#supported-runners-and-hardware-resources). They offer the following advanced features: * More RAM, CPU, and disk space * Static IP addresses diff --git a/data/reusables/actions/about-oidc-short-overview.md b/data/reusables/actions/about-oidc-short-overview.md index 7232f31662e8..1555e96ca2ee 100644 --- a/data/reusables/actions/about-oidc-short-overview.md +++ b/data/reusables/actions/about-oidc-short-overview.md @@ -1,2 +1,2 @@ -If your {% data variables.product.prodname_actions %} workflows need to access resources from a cloud provider that supports OpenID Connect (OIDC), you can configure your workflows to authenticate directly to the cloud provider. This will let you stop storing these credentials as long-lived secrets and provide other security benefits. For more information, see [AUTOTITLE](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect). +If your {% data variables.product.prodname_actions %} workflows need to access resources from a cloud provider that supports OpenID Connect (OIDC), you can configure your workflows to authenticate directly to the cloud provider. This will let you stop storing these credentials as long-lived secrets and provide other security benefits. For more information, see [AUTOTITLE](/actions/concepts/security/openid-connect). diff --git a/data/reusables/actions/about-security-hardening-for-worklows.md b/data/reusables/actions/about-security-hardening-for-worklows.md index f8e7011b1ed6..3c08cc727ad2 100644 --- a/data/reusables/actions/about-security-hardening-for-worklows.md +++ b/data/reusables/actions/about-security-hardening-for-worklows.md @@ -1 +1 @@ -{% data variables.product.prodname_dotcom %} provides security features that you can use to increase the security of your workflows. You can use {% data variables.product.prodname_dotcom %}'s built-in features to ensure you are notified about vulnerabilities in the actions you consume, or to automate the process of keeping the actions in your workflows up to date. For more information, see [AUTOTITLE](/actions/security-guides/using-githubs-security-features-to-secure-your-use-of-github-actions). +{% data variables.product.prodname_dotcom %} provides security features that you can use to increase the security of your workflows. You can use {% data variables.product.prodname_dotcom %}'s built-in features to ensure you are notified about vulnerabilities in the actions you consume, or to automate the process of keeping the actions in your workflows up to date. For more information, see [AUTOTITLE](/actions/reference/security/secure-use). diff --git a/data/reusables/actions/about-triggers.md b/data/reusables/actions/about-triggers.md index 8cff08eae938..716c80b0aa81 100644 --- a/data/reusables/actions/about-triggers.md +++ b/data/reusables/actions/about-triggers.md @@ -7,7 +7,7 @@ Workflow triggers are events that cause a workflow to run. These events can be: For example, you can configure your workflow to run when a push is made to the default branch of your repository, when a release is created, or when an issue is opened. -Workflow triggers are defined with the `on` key. For more information, see [AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#on). +Workflow triggers are defined with the `on` key. For more information, see [AUTOTITLE](/actions/reference/workflows-and-actions/workflow-syntax#on). The following steps occur to trigger a workflow run: @@ -15,4 +15,4 @@ The following steps occur to trigger a workflow run: 1. {% data variables.product.github %} searches the `.github/workflows` directory in the root of your repository for workflow files that are present in the associated commit SHA or Git ref of the event. 1. A workflow run is triggered for any workflows that have `on:` values that match the triggering event. Some events also require the workflow file to be present on the default branch of the repository in order to run. -Each workflow run will use the version of the workflow that is present in the associated commit SHA or Git ref of the event. When a workflow runs, {% data variables.product.github %} sets the `GITHUB_SHA` (commit SHA) and `GITHUB_REF` (Git ref) environment variables in the runner environment. For more information, see [AUTOTITLE](/actions/learn-github-actions/variables). +Each workflow run will use the version of the workflow that is present in the associated commit SHA or Git ref of the event. When a workflow runs, {% data variables.product.github %} sets the `GITHUB_SHA` (commit SHA) and `GITHUB_REF` (Git ref) environment variables in the runner environment. For more information, see [AUTOTITLE](/actions/how-tos/write-workflows/choose-what-workflows-do/use-variables). diff --git a/data/reusables/actions/action-bundled-actions.md b/data/reusables/actions/action-bundled-actions.md index 90d8c73fabcf..86459971a489 100644 --- a/data/reusables/actions/action-bundled-actions.md +++ b/data/reusables/actions/action-bundled-actions.md @@ -1 +1 @@ -For more information about the action, and for instructions about how to download the most recent version, see [AUTOTITLE](/admin/github-actions/managing-access-to-actions-from-githubcom/using-the-latest-version-of-the-official-bundled-actions). +For more information about the action, and for instructions about how to download the most recent version, see [AUTOTITLE](/admin/managing-github-actions-for-your-enterprise/managing-access-to-actions-from-githubcom/using-the-latest-version-of-the-official-bundled-actions). diff --git a/data/reusables/actions/actions-activity-types.md b/data/reusables/actions/actions-activity-types.md index fc71bab10683..04129361765b 100644 --- a/data/reusables/actions/actions-activity-types.md +++ b/data/reusables/actions/actions-activity-types.md @@ -19,4 +19,4 @@ on: - labeled ``` -For more information about each event and their activity types, see [AUTOTITLE](/actions/using-workflows/events-that-trigger-workflows). +For more information about each event and their activity types, see [AUTOTITLE](/actions/reference/workflows-and-actions/events-that-trigger-workflows). diff --git a/data/reusables/actions/actions-billing.md b/data/reusables/actions/actions-billing.md index d77925c3e9b5..3a09579be4bb 100644 --- a/data/reusables/actions/actions-billing.md +++ b/data/reusables/actions/actions-billing.md @@ -1 +1 @@ -{% data variables.product.prodname_actions %} usage is free for standard {% data variables.product.prodname_dotcom %}-hosted runners in public repositories, and for self-hosted runners. See [AUTOTITLE](/actions/writing-workflows/choosing-where-your-workflow-runs/choosing-the-runner-for-a-job#standard-github-hosted-runners-for-public-repositories). For private repositories, each {% data variables.product.prodname_dotcom %} account receives a quota of free minutes and storage for use with {% data variables.product.prodname_dotcom %}-hosted runners, depending on the account's plan. Any usage beyond the included amounts is billed to your account. \ No newline at end of file +{% data variables.product.prodname_actions %} usage is free for standard {% data variables.product.prodname_dotcom %}-hosted runners in public repositories, and for self-hosted runners. See [AUTOTITLE](/actions/how-tos/write-workflows/choose-where-workflows-run/choose-the-runner-for-a-job#standard-github-hosted-runners-for-public-repositories). For private repositories, each {% data variables.product.prodname_dotcom %} account receives a quota of free minutes and storage for use with {% data variables.product.prodname_dotcom %}-hosted runners, depending on the account's plan. Any usage beyond the included amounts is billed to your account. diff --git a/data/reusables/actions/actions-runner-controller-about-arc.md b/data/reusables/actions/actions-runner-controller-about-arc.md index 6ba8ea90df37..b1e9327a4f39 100644 --- a/data/reusables/actions/actions-runner-controller-about-arc.md +++ b/data/reusables/actions/actions-runner-controller-about-arc.md @@ -1,3 +1,3 @@ {% data variables.product.prodname_actions_runner_controller %} (ARC) is a Kubernetes operator that orchestrates and scales self-hosted runners for {% data variables.product.prodname_actions %}. For more information, see [Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) in the Kubernetes documentation. -With ARC, you can create runner scale sets that automatically scale based on the number of workflows running in your repository, organization, or enterprise. Because controlled runners can be ephemeral and based on containers, new runner instances can scale up or down rapidly and cleanly. For more information about autoscaling, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/autoscaling-with-self-hosted-runners). +With ARC, you can create runner scale sets that automatically scale based on the number of workflows running in your repository, organization, or enterprise. Because controlled runners can be ephemeral and based on containers, new runner instances can scale up or down rapidly and cleanly. For more information about autoscaling, see [AUTOTITLE](/actions/reference/runners/self-hosted-runners). diff --git a/data/reusables/actions/actions-runner-controller-unsupported-customization.md b/data/reusables/actions/actions-runner-controller-unsupported-customization.md index c8dc2c6da78e..57b5f63e06fd 100644 --- a/data/reusables/actions/actions-runner-controller-unsupported-customization.md +++ b/data/reusables/actions/actions-runner-controller-unsupported-customization.md @@ -1,4 +1,4 @@ > [!WARNING] > This {% data variables.product.prodname_actions_runner_controller %} customization option may be outside the scope of what {% data variables.contact.github_support %} can assist with and may cause unexpected behavior when configured incorrectly. > -> For more information about what {% data variables.contact.github_support %} can assist with, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/about-support-for-actions-runner-controller). +> For more information about what {% data variables.contact.github_support %} can assist with, see [AUTOTITLE](/actions/concepts/runners/support-for-arc). diff --git a/data/reusables/actions/actions-secrets-variables-repository-access.md b/data/reusables/actions/actions-secrets-variables-repository-access.md index 86800fda2e21..ac4d0b9779b0 100644 --- a/data/reusables/actions/actions-secrets-variables-repository-access.md +++ b/data/reusables/actions/actions-secrets-variables-repository-access.md @@ -2,7 +2,7 @@ {% ifversion fpt %} > [!NOTE] -> Organization-level secrets and variables are not accessible by private repositories for {% data variables.product.prodname_free_user %}. For more information about upgrading your {% data variables.product.company_short %} subscription, see [AUTOTITLE](/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription). +> Organization-level secrets and variables are not accessible by private repositories for {% data variables.product.prodname_free_user %}. For more information about upgrading your {% data variables.product.company_short %} subscription, see [AUTOTITLE](/billing/how-tos/manage-plan-and-licenses/upgrade-plan). {% endif %} diff --git a/data/reusables/actions/actions-tab-new-runners-note.md b/data/reusables/actions/actions-tab-new-runners-note.md index 7fe033d8b901..a76543826227 100644 --- a/data/reusables/actions/actions-tab-new-runners-note.md +++ b/data/reusables/actions/actions-tab-new-runners-note.md @@ -1,7 +1,7 @@ > [!NOTE] > Enterprise and organization owners{% ifversion custom-org-roles %} and users with the "Manage organization runners and runner groups" permission{% endif %} can create runners from this page. To create a new runner, click **New runner** at the top right of the list of runners to add runners to the repository. > -> For more information, see {% ifversion actions-hosted-runners %}[AUTOTITLE](/actions/using-github-hosted-runners/managing-larger-runners) and {% endif %}[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners). +> For more information, see {% ifversion actions-hosted-runners %}[AUTOTITLE](/actions/how-tos/manage-runners/larger-runners/manage-larger-runners) and {% endif %}[AUTOTITLE](/actions/how-tos/manage-runners/self-hosted-runners/add-runners). {% 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). +> For more information about custom organization roles, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles). {% endif %} diff --git a/data/reusables/actions/add-hosted-runner-overview.md b/data/reusables/actions/add-hosted-runner-overview.md index 7a3194dcfd9b..cb345e9699de 100644 --- a/data/reusables/actions/add-hosted-runner-overview.md +++ b/data/reusables/actions/add-hosted-runner-overview.md @@ -1,3 +1,3 @@ You can choose an operating system and a hardware configuration from the list of available options. When new instances of this runner are deployed through autoscaling, they'll use the same operating system and hardware configuration you've defined here. -New runners are automatically assigned to the default group, or you can choose which group the runners must join during the runner creation process. In addition, you can modify the runner's group membership after you've registered the runner. For more information, see [AUTOTITLE](/actions/using-github-hosted-runners/controlling-access-to-larger-runners). +New runners are automatically assigned to the default group, or you can choose which group the runners must join during the runner creation process. In addition, you can modify the runner's group membership after you've registered the runner. For more information, see [AUTOTITLE](/actions/how-tos/manage-runners/larger-runners/control-access). diff --git a/data/reusables/actions/allow-specific-actions-intro.md b/data/reusables/actions/allow-specific-actions-intro.md index d3848577fa6a..471201231554 100644 --- a/data/reusables/actions/allow-specific-actions-intro.md +++ b/data/reusables/actions/allow-specific-actions-intro.md @@ -8,17 +8,17 @@ When you choose {% data reusables.actions.policy-label-for-select-actions-workfl {% data reusables.repositories.settings-permissions-org-policy-note %} * **Allow actions created by {% data variables.product.prodname_dotcom %}:** You can allow all actions created by {% data variables.product.prodname_dotcom %} to be used by workflows. Actions created by {% data variables.product.prodname_dotcom %} are located in the `actions` and `github` organizations. For more information, see the [`actions`](https://github.com/actions) and [`github`](https://github.com/github) organizations. -* **Allow Marketplace actions by verified creators:** {% ifversion ghes %}This option is available if you have {% data variables.product.prodname_github_connect %} enabled and configured with {% data variables.product.prodname_actions %}. For more information, see [AUTOTITLE](/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect).{% endif %} You can allow all {% data variables.product.prodname_marketplace %} actions created by verified creators to be used by workflows. When GitHub has verified the creator of the action as a partner organization, the {% octicon "verified" aria-label="The verified badge" %} badge is displayed next to the action in {% data variables.product.prodname_marketplace %}. +* **Allow Marketplace actions by verified creators:** {% ifversion ghes %}This option is available if you have {% data variables.product.prodname_github_connect %} enabled and configured with {% data variables.product.prodname_actions %}. For more information, see [AUTOTITLE](/admin/managing-github-actions-for-your-enterprise/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect).{% endif %} You can allow all {% data variables.product.prodname_marketplace %} actions created by verified creators to be used by workflows. When GitHub has verified the creator of the action as a partner organization, the {% octicon "verified" aria-label="The verified badge" %} badge is displayed next to the action in {% data variables.product.prodname_marketplace %}. * **Allow{% ifversion actions-blocklist-sha-pinning %} or block{% endif %} specified actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %}:** You can restrict workflows to use actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %} in specific organizations and repositories. Specified actions cannot be set to more than 1000. To restrict access to specific tags or commit SHAs of an action{% ifversion actions-workflow-policy %} or reusable workflow{% endif %}, use the same syntax used in the workflow to select the action{% ifversion actions-workflow-policy %} or reusable workflow{% endif %}. - * For an action, the syntax is `OWNER/REPOSITORY@TAG-OR-SHA`. For example, use `actions/javascript-action@v1.0.1` to select a tag or `actions/javascript-action@a824008085750b8e136effc585c3cd6082bd575f` to select a SHA. For more information, see [AUTOTITLE](/actions/learn-github-actions/finding-and-customizing-actions#using-release-management-for-your-custom-actions). + * For an action, the syntax is `OWNER/REPOSITORY@TAG-OR-SHA`. For example, use `actions/javascript-action@v1.0.1` to select a tag or `actions/javascript-action@a824008085750b8e136effc585c3cd6082bd575f` to select a SHA. For more information, see [AUTOTITLE](/actions/how-tos/write-workflows/choose-what-workflows-do/find-and-customize-actions#using-release-management-for-your-custom-actions). {%- ifversion actions-workflow-policy %} - * For a reusable workflow, the syntax is `OWNER/REPOSITORY/PATH/FILENAME@TAG-OR-SHA`. For example, `octo-org/another-repo/.github/workflows/workflow.yml@v1`. For more information, see [AUTOTITLE](/actions/using-workflows/reusing-workflows#calling-a-reusable-workflow). + * For a reusable workflow, the syntax is `OWNER/REPOSITORY/PATH/FILENAME@TAG-OR-SHA`. For example, `octo-org/another-repo/.github/workflows/workflow.yml@v1`. For more information, see [AUTOTITLE](/actions/how-tos/reuse-automations/reuse-workflows#calling-a-reusable-workflow). {%- endif %} - You can use the `*` wildcard character to match patterns. For example, to allow all actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %} in organizations that start with `space-org`, you can specify `space-org*/*`. To allow all actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %} in repositories that start with octocat, you can use `*/octocat**@*`. For more information about using the `*` wildcard, see [AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet). + You can use the `*` wildcard character to match patterns. For example, to allow all actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %} in organizations that start with `space-org`, you can specify `space-org*/*`. To allow all actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %} in repositories that start with octocat, you can use `*/octocat**@*`. For more information about using the `*` wildcard, see [AUTOTITLE](/actions/reference/workflows-and-actions/workflow-syntax#filter-pattern-cheat-sheet). Use `,` to separate patterns. For example, to allow all actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %} from the `octocat` and `octokit` organizations, you can specify `octocat/*, octokit/*`. diff --git a/data/reusables/actions/arc-runners-namespace.md b/data/reusables/actions/arc-runners-namespace.md index a65e73e57896..f090e706fb60 100644 --- a/data/reusables/actions/arc-runners-namespace.md +++ b/data/reusables/actions/arc-runners-namespace.md @@ -1,2 +1,2 @@ > [!NOTE] -> Create the secret in the same namespace where the `gha-runner-scale-set` chart is installed. In this example, the namespace is `arc-runners` to match the quickstart documentation. For more information, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/quickstart-for-actions-runner-controller#configuring-a-runner-scale-set). +> Create the secret in the same namespace where the `gha-runner-scale-set` chart is installed. In this example, the namespace is `arc-runners` to match the quickstart documentation. For more information, see [AUTOTITLE](/actions/tutorials/use-actions-runner-controller/get-started#configuring-a-runner-scale-set). diff --git a/data/reusables/actions/artifact-attestations-step-explanation.md b/data/reusables/actions/artifact-attestations-step-explanation.md index bb07276e1764..42bf27f4b0f8 100644 --- a/data/reusables/actions/artifact-attestations-step-explanation.md +++ b/data/reusables/actions/artifact-attestations-step-explanation.md @@ -1 +1 @@ -In the last step, it generates an artifact attestation for the image, which increases supply chain security. For more information, see [AUTOTITLE](/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). +In the last step, it generates an artifact attestation for the image, which increases supply chain security. For more information, see [AUTOTITLE](/actions/how-tos/secure-your-work/use-artifact-attestations/use-artifact-attestations). diff --git a/data/reusables/actions/artifact-log-retention-statement.md b/data/reusables/actions/artifact-log-retention-statement.md index 7e960b3939da..808168aaee5d 100644 --- a/data/reusables/actions/artifact-log-retention-statement.md +++ b/data/reusables/actions/artifact-log-retention-statement.md @@ -1 +1 @@ -By default, {% data variables.product.github %} stores build logs and artifacts for 90 days, and this retention period can be customized. For more information, see [AUTOTITLE](/actions/learn-github-actions/usage-limits-billing-and-administration#artifact-and-log-retention-policy). +By default, {% data variables.product.github %} stores build logs and artifacts for 90 days, and this retention period can be customized. For more information, see [AUTOTITLE](/actions/concepts/billing-and-usage#artifact-and-log-retention-policy). diff --git a/data/reusables/actions/artifacts/artifacts-from-deleted-workflow-runs.md b/data/reusables/actions/artifacts/artifacts-from-deleted-workflow-runs.md index 5d34822d8c91..02582db48273 100644 --- a/data/reusables/actions/artifacts/artifacts-from-deleted-workflow-runs.md +++ b/data/reusables/actions/artifacts/artifacts-from-deleted-workflow-runs.md @@ -1,3 +1,3 @@ ## Artifacts from deleted workflow runs -When a workflow run is deleted all artifacts associated with the run are also deleted from storage. You can delete a workflow run using the GitHub Actions UI, the REST API, or using the GitHub CLI, see: [AUTOTITLE](/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/deleting-a-workflow-run), [Delete a workflow run](/rest/actions/workflow-runs?apiVersion=2022-11-28#delete-a-workflow-run), or [gh run delete](https://cli.github.com/manual/gh_run_delete). +When a workflow run is deleted all artifacts associated with the run are also deleted from storage. You can delete a workflow run using the GitHub Actions UI, the REST API, or using the GitHub CLI, see: [AUTOTITLE](/actions/how-tos/manage-workflow-runs/delete-a-workflow-run), [Delete a workflow run](/rest/actions/workflow-runs?apiVersion=2022-11-28#delete-a-workflow-run), or [gh run delete](https://cli.github.com/manual/gh_run_delete). diff --git a/data/reusables/actions/azure-vnet-about-larger-runners.md b/data/reusables/actions/azure-vnet-about-larger-runners.md index 1bcc96606ea1..e13c7355211f 100644 --- a/data/reusables/actions/azure-vnet-about-larger-runners.md +++ b/data/reusables/actions/azure-vnet-about-larger-runners.md @@ -1,3 +1,3 @@ -2-64 vCPU Ubuntu and Windows runners are supported with Azure VNET. For more information on these runner types, see [AUTOTITLE](/actions/using-github-hosted-runners/about-larger-runners/about-larger-runners#about-ubuntu-and-windows-larger-runners). +2-64 vCPU Ubuntu and Windows runners are supported with Azure VNET. For more information on these runner types, see [AUTOTITLE](/actions/concepts/runners/larger-runners#about-ubuntu-and-windows-larger-runners). -{% data reusables.actions.static-ip-limitation-vnet %} You must use dynamic IP addresses, which is the default configuration for larger runners. For more information about networking for larger runners, see [AUTOTITLE](/actions/using-github-hosted-runners/about-larger-runners/about-larger-runners#networking-for-larger-runners). +{% data reusables.actions.static-ip-limitation-vnet %} You must use dynamic IP addresses, which is the default configuration for larger runners. For more information about networking for larger runners, see [AUTOTITLE](/actions/concepts/runners/larger-runners#networking-for-larger-runners). diff --git a/data/reusables/actions/azure-vnet-configuring-overview.md b/data/reusables/actions/azure-vnet-configuring-overview.md index 5a69640a9153..01ace7dc6bb1 100644 --- a/data/reusables/actions/azure-vnet-configuring-overview.md +++ b/data/reusables/actions/azure-vnet-configuring-overview.md @@ -2,4 +2,4 @@ To use {% data variables.product.company_short %}-hosted runners with Azure VNET The following procedures will lead you through both steps. -For more information about troubleshooting common issues with using {% data variables.product.company_short %}-hosted runners with Azure VNET, see {% ifversion ghec %}[AUTOTITLE](/admin/configuration/configuring-private-networking-for-hosted-compute-products/troubleshooting-azure-private-network-configurations-for-github-hosted-runners-in-your-enterprise).{% else %}[AUTOTITLE](/organizations/managing-organization-settings/troubleshooting-azure-private-network-configurations-for-github-hosted-runners-in-your-organization).{% endif %} +For more information about troubleshooting common issues with using {% data variables.product.company_short %}-hosted runners with Azure VNET, see {% ifversion ghec %}[AUTOTITLE](/admin/configuring-settings/configuring-private-networking-for-hosted-compute-products/troubleshooting-azure-private-network-configurations-for-github-hosted-runners-in-your-enterprise).{% else %}[AUTOTITLE](/organizations/managing-organization-settings/troubleshooting-azure-private-network-configurations-for-github-hosted-runners-in-your-organization).{% endif %} diff --git a/data/reusables/actions/azure-vnet-creating-network-configuration-prereqs.md b/data/reusables/actions/azure-vnet-creating-network-configuration-prereqs.md index c3bb6a265d74..639e732d8f28 100644 --- a/data/reusables/actions/azure-vnet-creating-network-configuration-prereqs.md +++ b/data/reusables/actions/azure-vnet-creating-network-configuration-prereqs.md @@ -2,7 +2,7 @@ After configuring your Azure resources, you can use an Azure Virtual Network (VN {% ifversion ghec %} -Please note that initial setup must be at the enterprise level when creating the network settings configured with Azure. This is why, when obtaining the `databaseId`, the steps require you to configure the enterprise slug. Organizations are only allowed to create their own network configurations once the enterprise has been established and enabled through enterprise policy for hosted compute networking. For more information about runner groups, see [AUTOTITLE](/actions/using-github-hosted-runners/about-larger-runners/controlling-access-to-larger-runners). +Please note that initial setup must be at the enterprise level when creating the network settings configured with Azure. This is why, when obtaining the `databaseId`, the steps require you to configure the enterprise slug. Organizations are only allowed to create their own network configurations once the enterprise has been established and enabled through enterprise policy for hosted compute networking. For more information about runner groups, see [AUTOTITLE](/actions/how-tos/manage-runners/larger-runners/control-access). {% endif %} @@ -10,4 +10,4 @@ Once the network configuration is associated with a runner group, all runners in ### Prerequisites -Ensure your Azure resources have been configured _before_ adding a network configuration in {% data variables.product.company_short %}. For more information, see {% ifversion ghec %}[AUTOTITLE](/admin/configuration/configuring-private-networking-for-hosted-compute-products/configuring-private-networking-for-github-hosted-runners#configuring-your-azure-resources).{% else %}[AUTOTITLE](/organizations/managing-organization-settings/configuring-private-networking-for-github-hosted-runners-in-your-organization#configuring-your-azure-resources).{% endif %} +Ensure your Azure resources have been configured _before_ adding a network configuration in {% data variables.product.company_short %}. For more information, see {% ifversion ghec %}[AUTOTITLE](/admin/configuring-settings/configuring-private-networking-for-hosted-compute-products/configuring-private-networking-for-github-hosted-runners-in-your-enterprise#configuring-your-azure-resources).{% else %}[AUTOTITLE](/organizations/managing-organization-settings/configuring-private-networking-for-github-hosted-runners-in-your-organization#configuring-your-azure-resources).{% endif %} diff --git a/data/reusables/actions/azure-vnet-enterprise-policy.md b/data/reusables/actions/azure-vnet-enterprise-policy.md index 13975ddc3644..8707248ed881 100644 --- a/data/reusables/actions/azure-vnet-enterprise-policy.md +++ b/data/reusables/actions/azure-vnet-enterprise-policy.md @@ -1 +1 @@ -By default, organizations in an enterprise cannot create new network configurations and only inherit enterprise-level network configurations. Enterprise owners can set a policy that allows organizations in the enterprise to create network configurations that are independent of the enterprise. For more information, see [AUTOTITLE](/admin/configuration/configuring-private-networking-for-hosted-compute-products/configuring-private-networking-for-github-hosted-runners-in-your-enterprise#enabling-creation-of-network-configurations-for-organizations). +By default, organizations in an enterprise cannot create new network configurations and only inherit enterprise-level network configurations. Enterprise owners can set a policy that allows organizations in the enterprise to create network configurations that are independent of the enterprise. For more information, see [AUTOTITLE](/admin/configuring-settings/configuring-private-networking-for-hosted-compute-products/configuring-private-networking-for-github-hosted-runners-in-your-enterprise#enabling-creation-of-network-configurations-for-organizations). diff --git a/data/reusables/actions/azure-vnet-intro-capabilities.md b/data/reusables/actions/azure-vnet-intro-capabilities.md index bc7deaab9a62..c81b175d1859 100644 --- a/data/reusables/actions/azure-vnet-intro-capabilities.md +++ b/data/reusables/actions/azure-vnet-intro-capabilities.md @@ -1,4 +1,4 @@ -You can connect multiple VNET subnets to {% data variables.product.github %} and manage private resource access for your runners via runner groups. For more information about runner groups, see [AUTOTITLE](/actions/using-github-hosted-runners/about-larger-runners/controlling-access-to-larger-runners). +You can connect multiple VNET subnets to {% data variables.product.github %} and manage private resource access for your runners via runner groups. For more information about runner groups, see [AUTOTITLE](/actions/how-tos/manage-runners/larger-runners/control-access). Using {% data variables.product.company_short %}-hosted runners within Azure VNET allows you to perform the following actions. * Privately connect a runner to resources inside an Azure VNET without opening internet ports, including on-premises resources accessible from the Azure VNET. diff --git a/data/reusables/actions/azure-vnet-next-steps-links.md b/data/reusables/actions/azure-vnet-next-steps-links.md index 38834b4c658c..fdb0dd58bb8b 100644 --- a/data/reusables/actions/azure-vnet-next-steps-links.md +++ b/data/reusables/actions/azure-vnet-next-steps-links.md @@ -10,7 +10,7 @@ For procedures to configure Azure private networking at the organization level, {% data reusables.actions.azure-vnet-enterprise-policy %} -For procedures to configure Azure private networking at the enterprise level, see [AUTOTITLE](/admin/configuration/configuring-private-networking-for-hosted-compute-products/configuring-private-networking-for-github-hosted-runners-in-your-enterprise). +For procedures to configure Azure private networking at the enterprise level, see [AUTOTITLE](/admin/configuring-settings/configuring-private-networking-for-hosted-compute-products/configuring-private-networking-for-github-hosted-runners-in-your-enterprise). For procedures to configure Azure private networking at the organization level, see [AUTOTITLE](/organizations/managing-organization-settings/configuring-private-networking-for-github-hosted-runners-in-your-organization). diff --git a/data/reusables/actions/cd-templates-actions.md b/data/reusables/actions/cd-templates-actions.md index 3d87171dcaa9..281743ffc97c 100644 --- a/data/reusables/actions/cd-templates-actions.md +++ b/data/reusables/actions/cd-templates-actions.md @@ -1,3 +1,3 @@ -{% data variables.product.github %} offers deployment workflow templates for several popular services, such as Azure Web App. To learn how to get started using a workflow template, see [AUTOTITLE](/actions/learn-github-actions/using-starter-workflows) or [browse the full list of deployment workflow templates](https://github.com/actions/starter-workflows/tree/main/deployments). You can also check out our more detailed guides for specific deployment workflows, such as [AUTOTITLE](/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-nodejs-to-azure-app-service). +{% data variables.product.github %} offers deployment workflow templates for several popular services, such as Azure Web App. To learn how to get started using a workflow template, see [AUTOTITLE](/actions/how-tos/write-workflows/use-workflow-templates) or [browse the full list of deployment workflow templates](https://github.com/actions/starter-workflows/tree/main/deployments). You can also check out our more detailed guides for specific deployment workflows, such as [AUTOTITLE](/actions/how-tos/deploy/deploy-to-third-party-platforms/nodejs-to-azure-app-service). Many service providers also offer actions on {% data variables.product.prodname_marketplace %} for deploying to their service. For the full list, see [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace?category=deployment&type=actions). diff --git a/data/reusables/actions/context-injection-warning.md b/data/reusables/actions/context-injection-warning.md index 1d2958cbd3a9..b3472e8520ab 100644 --- a/data/reusables/actions/context-injection-warning.md +++ b/data/reusables/actions/context-injection-warning.md @@ -1,2 +1,2 @@ > [!WARNING] -> When creating workflows and actions, you should always consider whether your code might execute untrusted input from possible attackers. Certain contexts should be treated as untrusted input, as an attacker could insert their own malicious content. For more information, see [AUTOTITLE](/actions/security-guides/security-hardening-for-github-actions#understanding-the-risk-of-script-injections). +> When creating workflows and actions, you should always consider whether your code might execute untrusted input from possible attackers. Certain contexts should be treated as untrusted input, as an attacker could insert their own malicious content. For more information, see [AUTOTITLE](/actions/reference/security/secure-use#understanding-the-risk-of-script-injections). diff --git a/data/reusables/actions/create-azure-publish-profile.md b/data/reusables/actions/create-azure-publish-profile.md index a476d06f89fc..1eb66c1413ce 100644 --- a/data/reusables/actions/create-azure-publish-profile.md +++ b/data/reusables/actions/create-azure-publish-profile.md @@ -2,4 +2,4 @@ Generate your Azure deployment credentials using a publish profile. For more information, see [Generate deployment credentials](https://docs.microsoft.com/azure/app-service/deploy-github-actions?tabs=applevel#generate-deployment-credentials) in the Azure documentation. - In your {% data variables.product.prodname_dotcom %} repository, create a secret named `AZURE_WEBAPP_PUBLISH_PROFILE` that contains the contents of the publish profile. For more information on creating secrets, see [AUTOTITLE](/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository). + In your {% data variables.product.prodname_dotcom %} repository, create a secret named `AZURE_WEBAPP_PUBLISH_PROFILE` that contains the contents of the publish profile. For more information on creating secrets, see [AUTOTITLE](/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets#creating-secrets-for-a-repository). diff --git a/data/reusables/actions/creating-a-runner-group-for-an-organization.md b/data/reusables/actions/creating-a-runner-group-for-an-organization.md index 8afc91dcf13a..62b3602203bc 100644 --- a/data/reusables/actions/creating-a-runner-group-for-an-organization.md +++ b/data/reusables/actions/creating-a-runner-group-for-an-organization.md @@ -8,9 +8,9 @@ Always include a security admonition above this procedure. This is either one of {% endcomment %} > [!NOTE] -> When creating a runner group, you must choose a policy that defines which repositories{% ifversion ghec or ghes %} and workflows{% endif %} have access to the runner group. To change which repositories and workflows can access the runner group, organization owners{% ifversion custom-org-roles %} and users with the “Manage organization runners and runner groups” permission{% endif %} can set a policy for the organization. For more information, see [AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#disabling-repository-level-self-hosted-runners). +> When creating a runner group, you must choose a policy that defines which repositories{% ifversion ghec or ghes %} and workflows{% endif %} have access to the runner group. To change which repositories and workflows can access the runner group, organization owners{% ifversion custom-org-roles %} and users with the “Manage organization runners and runner groups” permission{% endif %} can set a policy for the organization. For more information, see [AUTOTITLE](/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#disabling-repository-level-self-hosted-runners). -All organizations have a single default runner group. {% ifversion fpt %}Organization owners using the {% data variables.product.prodname_team %} plan{% else %}Organization owners{% ifversion custom-org-roles %} and users with the "Manage organization runners and runner groups" permission{% endif %}{% endif %} can create additional organization-level runner groups. {% 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 %} +All organizations have a single default runner group. {% ifversion fpt %}Organization owners using the {% data variables.product.prodname_team %} plan{% else %}Organization owners{% ifversion custom-org-roles %} and users with the "Manage organization runners and runner groups" permission{% endif %}{% endif %} can create additional organization-level runner groups. {% ifversion custom-org-roles %}For more information about custom organization roles, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles).{% endif %} If no group is specified during the registration process, runners are automatically added to the default group. You can later move the runner from the default group to a custom group. diff --git a/data/reusables/actions/dependabot-version-updates-actions-caveats.md b/data/reusables/actions/dependabot-version-updates-actions-caveats.md index 4587964a6080..2fea0b34938c 100644 --- a/data/reusables/actions/dependabot-version-updates-actions-caveats.md +++ b/data/reusables/actions/dependabot-version-updates-actions-caveats.md @@ -2,4 +2,4 @@ * {% data variables.product.prodname_dependabot %} updates the version documentation of {% data variables.product.prodname_actions %} when the comment is on the same line, such as `actions/checkout@ #` or `actions/checkout@ #`. * If the commit you use is not associated with any tag, {% data variables.product.prodname_dependabot %} will update the {% data variables.product.prodname_actions %} to the latest commit (which might differ from the latest release). * Docker Hub and {% data variables.product.prodname_registry %} {% data variables.product.prodname_container_registry %} URLs are currently not supported. For example, references to Docker container actions using `docker://` syntax aren't supported. -* {% data variables.product.prodname_dependabot %} supports both public and private repositories for {% data variables.product.prodname_actions %}. For private registry configuration options, see "`git`" in [AUTOTITLE](/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#git). +* {% data variables.product.prodname_dependabot %} supports both public and private repositories for {% data variables.product.prodname_actions %}. For private registry configuration options, see "`git`" in [AUTOTITLE](/code-security/reference/supply-chain-security/dependabot-options-reference#git). diff --git a/data/reusables/actions/dependabot-version-updates-for-actions.md b/data/reusables/actions/dependabot-version-updates-for-actions.md index 3ee2df44ccba..eb34ce8357d3 100644 --- a/data/reusables/actions/dependabot-version-updates-for-actions.md +++ b/data/reusables/actions/dependabot-version-updates-for-actions.md @@ -1 +1 @@ -You can use {% data variables.product.prodname_dependabot %} to ensure that references to actions and reusable workflows used in your repository are kept up to date. Actions are often updated with bug fixes and new features to make automated processes faster, safer, and more reliable. {% data variables.product.prodname_dependabot %} takes the effort out of maintaining your dependencies as it does this automatically for you. For more information, see [AUTOTITLE](/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot) and [AUTOTITLE](/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates). +You can use {% data variables.product.prodname_dependabot %} to ensure that references to actions and reusable workflows used in your repository are kept up to date. Actions are often updated with bug fixes and new features to make automated processes faster, safer, and more reliable. {% data variables.product.prodname_dependabot %} takes the effort out of maintaining your dependencies as it does this automatically for you. For more information, see [AUTOTITLE](/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/auto-update-actions) and [AUTOTITLE](/code-security/concepts/supply-chain-security/dependabot-security-updates). diff --git a/data/reusables/actions/disable-selfhosted-runners-crossrefs.md b/data/reusables/actions/disable-selfhosted-runners-crossrefs.md index d275c5ae2767..6020906b99a5 100644 --- a/data/reusables/actions/disable-selfhosted-runners-crossrefs.md +++ b/data/reusables/actions/disable-selfhosted-runners-crossrefs.md @@ -1,5 +1,5 @@ {% 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 %} +{% ifversion custom-org-roles %}For more information about custom organization roles, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles).{% endif %} -For more information, see {% ifversion ghec or ghes %}[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#disabling-repository-level-self-hosted-runners) and {% endif %}[AUTOTITLE](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#limiting-the-use-of-self-hosted-runners). +For more information, see {% ifversion ghec or ghes %}[AUTOTITLE](/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#disabling-repository-level-self-hosted-runners) and {% endif %}[AUTOTITLE](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#limiting-the-use-of-self-hosted-runners). diff --git a/data/reusables/actions/enabling-actions-metrics.md b/data/reusables/actions/enabling-actions-metrics.md index 81f2b62b1824..6e039a6179b3 100644 --- a/data/reusables/actions/enabling-actions-metrics.md +++ b/data/reusables/actions/enabling-actions-metrics.md @@ -1,3 +1,3 @@ ## Enabling access to {% data variables.product.prodname_actions %} metrics -Organization owners can create custom organization roles to allow people to view {% data variables.product.prodname_actions %} usage metrics for their organization. To provide users with access, select the "View organization Actions metrics" role when creating a custom organization role. For more information, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles). +Organization owners can create custom organization roles to allow people to view {% data variables.product.prodname_actions %} usage metrics for their organization. To provide users with access, select the "View organization Actions metrics" role when creating a custom organization role. For more information, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles). diff --git a/data/reusables/actions/enterprise-common-prereqs.md b/data/reusables/actions/enterprise-common-prereqs.md index b394ba8eebc3..c60237a47603 100644 --- a/data/reusables/actions/enterprise-common-prereqs.md +++ b/data/reusables/actions/enterprise-common-prereqs.md @@ -1,5 +1,5 @@ -* Review the hardware requirements for {% 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#review-hardware-considerations). -* TLS must be configured for {% data variables.product.prodname_ghe_server %}'s domain. For more information, see [AUTOTITLE](/admin/configuration/configuring-network-settings/configuring-tls). +* Review the hardware requirements for {% data variables.product.prodname_actions %}. For more information, see [AUTOTITLE](/admin/managing-github-actions-for-your-enterprise/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server#review-hardware-considerations). +* TLS must be configured for {% data variables.product.prodname_ghe_server %}'s domain. For more information, see [AUTOTITLE](/admin/configuring-settings/hardening-security-for-your-enterprise/configuring-tls). > [!NOTE] > {% data reusables.actions.enterprise-self-signed-cert %} diff --git a/data/reusables/actions/enterprise-http-proxy.md b/data/reusables/actions/enterprise-http-proxy.md index e9d722a9b92b..6e9cb6b00918 100644 --- a/data/reusables/actions/enterprise-http-proxy.md +++ b/data/reusables/actions/enterprise-http-proxy.md @@ -3,4 +3,4 @@ If you have an **HTTP Proxy Server** configured on {% data variables.product.git * You must add `.localhost`, `127.0.0.1`, and `::1` to the **HTTP Proxy Exclusion** list (in this order). * If your external storage location is not routable, then you must also add your external storage URL to the exclusion list. -For more information on changing your proxy settings, see [AUTOTITLE](/admin/configuration/configuring-network-settings/configuring-an-outbound-web-proxy-server). +For more information on changing your proxy settings, see [AUTOTITLE](/admin/configuring-settings/configuring-network-settings/configuring-an-outbound-web-proxy-server). diff --git a/data/reusables/actions/enterprise-limit-actions-use.md b/data/reusables/actions/enterprise-limit-actions-use.md index f49aed364610..361ae69490fa 100644 --- a/data/reusables/actions/enterprise-limit-actions-use.md +++ b/data/reusables/actions/enterprise-limit-actions-use.md @@ -1 +1 @@ -After you enable {% data variables.product.prodname_github_connect %}, you can use policies to restrict which public actions can be used in repositories in your enterprise. For more information, see [AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise). +After you enable {% data variables.product.prodname_github_connect %}, you can use policies to restrict which public actions can be used in repositories in your enterprise. For more information, see [AUTOTITLE](/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise). diff --git a/data/reusables/actions/enterprise-marketplace-actions.md b/data/reusables/actions/enterprise-marketplace-actions.md index 07b6b0b83270..4ae1dc78ab03 100644 --- a/data/reusables/actions/enterprise-marketplace-actions.md +++ b/data/reusables/actions/enterprise-marketplace-actions.md @@ -1,6 +1,6 @@ {% ifversion ghes %} > [!NOTE] -> {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %} may have limited access to actions on {% data variables.product.prodname_dotcom_the_website %} or {% data variables.product.prodname_marketplace %}. For more information, see [AUTOTITLE](/admin/github-actions/managing-access-to-actions-from-githubcom) and contact your {% data variables.product.prodname_enterprise %} site administrator. +> {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %} may have limited access to actions on {% data variables.product.prodname_dotcom_the_website %} or {% data variables.product.prodname_marketplace %}. For more information, see [AUTOTITLE](/admin/managing-github-actions-for-your-enterprise/managing-access-to-actions-from-githubcom) and contact your {% data variables.product.prodname_enterprise %} site administrator. {% endif %} diff --git a/data/reusables/actions/enterprise-postinstall-nextsteps.md b/data/reusables/actions/enterprise-postinstall-nextsteps.md index 382cb4f67df2..08728051813e 100644 --- a/data/reusables/actions/enterprise-postinstall-nextsteps.md +++ b/data/reusables/actions/enterprise-postinstall-nextsteps.md @@ -1,3 +1,3 @@ ## Next steps -After the configuration run has successfully completed, {% data variables.product.prodname_actions %} will be enabled on {% data variables.product.github %}. For your next steps, such as managing {% data variables.product.prodname_actions %} access permissions and adding self-hosted runners, return to [AUTOTITLE](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server#enabling-github-actions-with-your-storage-provider). +After the configuration run has successfully completed, {% data variables.product.prodname_actions %} will be enabled on {% data variables.product.github %}. For your next steps, such as managing {% data variables.product.prodname_actions %} access permissions and adding self-hosted runners, return to [AUTOTITLE](/admin/managing-github-actions-for-your-enterprise/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server#enabling-github-actions-with-your-storage-provider). diff --git a/data/reusables/actions/enterprise-setup-prereq.md b/data/reusables/actions/enterprise-setup-prereq.md index 50f8d63ce73c..af57ceeb4b39 100644 --- a/data/reusables/actions/enterprise-setup-prereq.md +++ b/data/reusables/actions/enterprise-setup-prereq.md @@ -2,6 +2,6 @@ ### Using self-hosted runners on {% data variables.product.prodname_ghe_server %} -When using setup actions (such as `actions/setup-LANGUAGE`) on {% data variables.product.prodname_ghe_server %} 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). +When using setup actions (such as `actions/setup-LANGUAGE`) on {% data variables.product.prodname_ghe_server %} 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/managing-github-actions-for-your-enterprise/managing-access-to-actions-from-githubcom/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access). {% endif %} diff --git a/data/reusables/actions/enterprise-storage-about.md b/data/reusables/actions/enterprise-storage-about.md index c914cda08b66..07bf7a510f03 100644 --- a/data/reusables/actions/enterprise-storage-about.md +++ b/data/reusables/actions/enterprise-storage-about.md @@ -1,3 +1,3 @@ ## About external storage for {% data variables.product.prodname_actions %} -{% data reusables.actions.enterprise-storage-contents %} 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#external-storage-requirements). +{% data reusables.actions.enterprise-storage-contents %} For more information, see [AUTOTITLE](/admin/managing-github-actions-for-your-enterprise/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server#external-storage-requirements). diff --git a/data/reusables/actions/gai-custom-transformers-rec.md b/data/reusables/actions/gai-custom-transformers-rec.md index 54f3d3bec34c..7dc0d07bef2a 100644 --- a/data/reusables/actions/gai-custom-transformers-rec.md +++ b/data/reusables/actions/gai-custom-transformers-rec.md @@ -1 +1 @@ -If there is anything that {% data variables.product.prodname_actions_importer %} was not able to convert automatically, such as unknown build steps or a partially successful pipeline, you might want to create custom transformers to further customize the conversion process. For more information, see [AUTOTITLE](/actions/migrating-to-github-actions/automated-migrations/extending-github-actions-importer-with-custom-transformers). +If there is anything that {% data variables.product.prodname_actions_importer %} was not able to convert automatically, such as unknown build steps or a partially successful pipeline, you might want to create custom transformers to further customize the conversion process. For more information, see [AUTOTITLE](/actions/reference/github-actions-importer/custom-transformers). diff --git a/data/reusables/actions/gai-inspect-audit.md b/data/reusables/actions/gai-inspect-audit.md index b08333fef458..c021e8a57d8f 100644 --- a/data/reusables/actions/gai-inspect-audit.md +++ b/data/reusables/actions/gai-inspect-audit.md @@ -37,7 +37,7 @@ The "Manual tasks" section contains an overview of tasks that {% data variables. Listed below are some key terms that can appear in the "Manual tasks" section: -* A **secret** is a repository or organization-level secret that is used in the converted pipelines. These secrets must be created manually in {% data variables.product.prodname_actions %} for these pipelines to function properly. For more information, see [AUTOTITLE](/actions/security-guides/using-secrets-in-github-actions). +* A **secret** is a repository or organization-level secret that is used in the converted pipelines. These secrets must be created manually in {% data variables.product.prodname_actions %} for these pipelines to function properly. For more information, see [AUTOTITLE](/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets). * A **self-hosted runner** refers to a label of a runner that is referenced in a converted pipeline that is not a {% data variables.product.prodname_dotcom %}-hosted runner. You will need to manually define these runners for these pipelines to function properly. #### Files diff --git a/data/reusables/actions/general-security-hardening.md b/data/reusables/actions/general-security-hardening.md index b9d9a85bc65b..ef72fc991db0 100644 --- a/data/reusables/actions/general-security-hardening.md +++ b/data/reusables/actions/general-security-hardening.md @@ -1,3 +1,3 @@ ## General security hardening for {% data variables.product.prodname_actions %} -If you want to learn more about security practices for {% data variables.product.prodname_actions %}, see [AUTOTITLE](/actions/security-guides/security-hardening-for-github-actions). +If you want to learn more about security practices for {% data variables.product.prodname_actions %}, see [AUTOTITLE](/actions/reference/security/secure-use). diff --git a/data/reusables/actions/github-hosted-runners-check-concurrency.md b/data/reusables/actions/github-hosted-runners-check-concurrency.md index ecb3f5854348..1fc95f919ae0 100644 --- a/data/reusables/actions/github-hosted-runners-check-concurrency.md +++ b/data/reusables/actions/github-hosted-runners-check-concurrency.md @@ -1 +1 @@ -To identify any constraints with concurrency or queuing, you can check how many jobs are currently being processed on the {% data variables.product.prodname_dotcom %}-hosted runners in your organization or enterprise. For more information, see [AUTOTITLE](/actions/using-github-hosted-runners/monitoring-your-current-jobs). +To identify any constraints with concurrency or queuing, you can check how many jobs are currently being processed on the {% data variables.product.prodname_dotcom %}-hosted runners in your organization or enterprise. For more information, see [AUTOTITLE](/actions/how-tos/manage-runners/github-hosted-runners/view-current-jobs). diff --git a/data/reusables/actions/github-token-permissions.md b/data/reusables/actions/github-token-permissions.md index 46f61bc10bed..d723ea390ec1 100644 --- a/data/reusables/actions/github-token-permissions.md +++ b/data/reusables/actions/github-token-permissions.md @@ -1 +1 @@ -The `GITHUB_TOKEN` secret is set to an access token for the repository each time a job in a workflow begins. You should set the permissions for this access token in the workflow file to grant read access for the `contents` permission and write access for the `packages` permission. For more information, see [AUTOTITLE](/actions/security-guides/automatic-token-authentication). +The `GITHUB_TOKEN` secret is set to an access token for the repository each time a job in a workflow begins. You should set the permissions for this access token in the workflow file to grant read access for the `contents` permission and write access for the `packages` permission. For more information, see [AUTOTITLE](/actions/tutorials/authenticate-with-github_token). diff --git a/data/reusables/actions/github-token-scope-descriptions.md b/data/reusables/actions/github-token-scope-descriptions.md index 66d3c8da68de..8be5e87337bd 100644 --- a/data/reusables/actions/github-token-scope-descriptions.md +++ b/data/reusables/actions/github-token-scope-descriptions.md @@ -4,32 +4,32 @@ Available permissions and details of what each allows an action to do: | Permission | Allows an action using `GITHUB_TOKEN` to | | --- | --- | -| `actions` | Work with GitHub Actions. For example, `actions: write` permits an action to cancel a workflow run. For more information, see [AUTOTITLE](/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-actions). | +| `actions` | Work with GitHub Actions. For example, `actions: write` permits an action to cancel a workflow run. For more information, see [AUTOTITLE](/rest/authentication/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-actions). | | {% ifversion artifact-metadata %} | | `artifact-metadata` | Work with artifact metadata. For example, `artifact-metadata: write` permits an action to create storage records on behalf of a build artifact. For more information, see [AUTOTITLE](/rest/orgs/artifact-metadata?apiVersion=2022-11-28). | | {% endif %} | | {% ifversion artifact-attestations %} | -| `attestations` | Work with artifact attestations. For example, `attestations: write` permits an action to generate an artifact attestation for a build. For more information, see [AUTOTITLE](/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds) | +| `attestations` | Work with artifact attestations. For example, `attestations: write` permits an action to generate an artifact attestation for a build. For more information, see [AUTOTITLE](/actions/how-tos/secure-your-work/use-artifact-attestations/use-artifact-attestations) | | {% endif %} | -| `checks` | Work with check runs and check suites. For example, `checks: write` permits an action to create a check run. For more information, see [AUTOTITLE](/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-checks). | +| `checks` | Work with check runs and check suites. For example, `checks: write` permits an action to create a check run. For more information, see [AUTOTITLE](/rest/authentication/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-checks). | | {% ifversion code-quality %} | | `code-quality` | Work with code quality. For example, `code-quality: write` permits an action to upload code coverage reports. For more information, see [AUTOTITLE](/code-security/concepts/about-code-quality). | | {% endif %} | -| `contents` | Work with the contents of the repository. For example, `contents: read` permits an action to list the commits, and `contents: write` allows the action to create a release. For more information, see [AUTOTITLE](/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-contents). | -| `deployments` | Work with deployments. For example, `deployments: write` permits an action to create a new deployment. For more information, see [AUTOTITLE](/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-deployments). | +| `contents` | Work with the contents of the repository. For example, `contents: read` permits an action to list the commits, and `contents: write` allows the action to create a release. For more information, see [AUTOTITLE](/rest/authentication/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-contents). | +| `deployments` | Work with deployments. For example, `deployments: write` permits an action to create a new deployment. For more information, see [AUTOTITLE](/rest/authentication/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-deployments). | | `discussions` | Work with GitHub Discussions. For example, `discussions: write` permits an action to close or delete a discussion. For more information, see [AUTOTITLE](/graphql/guides/using-the-graphql-api-for-discussions). | | {% ifversion fpt or ghec %} | -| `id-token` | Fetch an OpenID Connect (OIDC) token. This requires `id-token: write`. For more information, see [AUTOTITLE](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#updating-your-actions-for-oidc) | +| `id-token` | Fetch an OpenID Connect (OIDC) token. This requires `id-token: write`. For more information, see [AUTOTITLE](/actions/concepts/security/openid-connect#updating-your-actions-for-oidc) | | {% endif %} | -| `issues` | Work with issues. For example, `issues: write` permits an action to add a comment to an issue. For more information, see [AUTOTITLE](/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-issues). | +| `issues` | Work with issues. For example, `issues: write` permits an action to add a comment to an issue. For more information, see [AUTOTITLE](/rest/authentication/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-issues). | | {% ifversion not ghes %} | -| `models` | Generate AI inference responses with {% data variables.product.prodname_github_models %}. For example, `models: read` permits an action to use the {% data variables.product.prodname_github_models %} inference API. See [AUTOTITLE](/github-models/prototyping-with-ai-models). | +| `models` | Generate AI inference responses with {% data variables.product.prodname_github_models %}. For example, `models: read` permits an action to use the {% data variables.product.prodname_github_models %} inference API. See [AUTOTITLE](/github-models/use-github-models/prototyping-with-ai-models). | | {% endif %} | | `packages` | Work with GitHub Packages. For example, `packages: write` permits an action to upload and publish packages on GitHub Packages. For more information, see [AUTOTITLE](/packages/learn-github-packages/about-permissions-for-github-packages#about-scopes-and-permissions-for-package-registries). | -| `pages` | Work with GitHub Pages. For example, `pages: write` permits an action to request a GitHub Pages build. For more information, see [AUTOTITLE](/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-pages). | -| `pull-requests` | Work with pull requests. For example, `pull-requests: write` permits an action to add a label to a pull request. For more information, see [AUTOTITLE](/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-pull-requests). | -| `security-events` | Work with GitHub code scanning alerts. For example, `security-events: read` permits an action to list the code scanning alerts for the repository, and `security-events: write` allows an action to update the status of a code scanning alert. For more information, see [Repository permissions for "Code scanning alerts"](/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-code-scanning-alerts).

{% ifversion vulnerability-alerts-permission %}For Dependabot alerts, use the `vulnerability-alerts` permission. Secret scanning alerts cannot be read with this permission and require a GitHub App or a {% data variables.product.pat_generic %}. For more information, see [Repository permissions for "Secret scanning alerts"](/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-secret-scanning-alerts) in "Permissions required for GitHub Apps."{% else %}Dependabot and secret scanning alerts cannot be read with this permission and require a GitHub App or a {% data variables.product.pat_generic %}. For more information, see [Repository permissions for "Dependabot alerts"](/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-dependabot-alerts) and [Repository permissions for "Secret scanning alerts"](/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-secret-scanning-alerts) in "Permissions required for GitHub Apps."{% endif %} | -| `statuses` | Work with commit statuses. For example, `statuses:read` permits an action to list the commit statuses for a given reference. For more information, see [AUTOTITLE](/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-commit-statuses). | +| `pages` | Work with GitHub Pages. For example, `pages: write` permits an action to request a GitHub Pages build. For more information, see [AUTOTITLE](/rest/authentication/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-pages). | +| `pull-requests` | Work with pull requests. For example, `pull-requests: write` permits an action to add a label to a pull request. For more information, see [AUTOTITLE](/rest/authentication/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-pull-requests). | +| `security-events` | Work with GitHub code scanning alerts. For example, `security-events: read` permits an action to list the code scanning alerts for the repository, and `security-events: write` allows an action to update the status of a code scanning alert. For more information, see [Repository permissions for "Code scanning alerts"](/rest/authentication/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-code-scanning-alerts).

{% ifversion vulnerability-alerts-permission %}For Dependabot alerts, use the `vulnerability-alerts` permission. Secret scanning alerts cannot be read with this permission and require a GitHub App or a {% data variables.product.pat_generic %}. For more information, see [Repository permissions for "Secret scanning alerts"](/rest/authentication/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-secret-scanning-alerts) in "Permissions required for GitHub Apps."{% else %}Dependabot and secret scanning alerts cannot be read with this permission and require a GitHub App or a {% data variables.product.pat_generic %}. For more information, see [Repository permissions for "Dependabot alerts"](/rest/authentication/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-dependabot-alerts) and [Repository permissions for "Secret scanning alerts"](/rest/authentication/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-secret-scanning-alerts) in "Permissions required for GitHub Apps."{% endif %} | +| `statuses` | Work with commit statuses. For example, `statuses:read` permits an action to list the commit statuses for a given reference. For more information, see [AUTOTITLE](/rest/authentication/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-commit-statuses). | | {% ifversion vulnerability-alerts-permission %} | -| `vulnerability-alerts` | Read Dependabot alerts. For example, `vulnerability-alerts: read` permits an action to list Dependabot alerts for the repository. Only `read` and `none` are supported; `write` is not valid. When `write-all` or `read-all` is used, `vulnerability-alerts` is automatically included as `read`. For more information, see [Repository permissions for "Dependabot alerts"](/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-dependabot-alerts). | +| `vulnerability-alerts` | Read Dependabot alerts. For example, `vulnerability-alerts: read` permits an action to list Dependabot alerts for the repository. Only `read` and `none` are supported; `write` is not valid. When `write-all` or `read-all` is used, `vulnerability-alerts` is automatically included as `read`. For more information, see [Repository permissions for "Dependabot alerts"](/rest/authentication/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-dependabot-alerts). | | {% endif %} | diff --git a/data/reusables/actions/github_sha_description.md b/data/reusables/actions/github_sha_description.md index e12ca87925e4..217670ebd909 100644 --- a/data/reusables/actions/github_sha_description.md +++ b/data/reusables/actions/github_sha_description.md @@ -1 +1 @@ -The commit SHA that triggered the workflow. The value of this commit SHA depends on the event that triggered the workflow. For more information, see [AUTOTITLE](/actions/using-workflows/events-that-trigger-workflows). For example, `ffac537e6cbbf934b08745a378932722df287a53`. +The commit SHA that triggered the workflow. The value of this commit SHA depends on the event that triggered the workflow. For more information, see [AUTOTITLE](/actions/reference/workflows-and-actions/events-that-trigger-workflows). For example, `ffac537e6cbbf934b08745a378932722df287a53`. diff --git a/data/reusables/actions/github_token-input-example.md b/data/reusables/actions/github_token-input-example.md index eaa824a10b71..44f97d225a05 100644 --- a/data/reusables/actions/github_token-input-example.md +++ b/data/reusables/actions/github_token-input-example.md @@ -1,4 +1,4 @@ -This example workflow uses the [GitHub CLI](/actions/using-workflows/using-github-cli-in-workflows), which requires the `GITHUB_TOKEN` as the value for the `GH_TOKEN` input parameter: +This example workflow uses the [GitHub CLI](/actions/how-tos/write-workflows/choose-what-workflows-do/use-github-cli), which requires the `GITHUB_TOKEN` as the value for the `GH_TOKEN` input parameter: ```yaml copy name: Open new issue diff --git a/data/reusables/actions/if-supported-contexts.md b/data/reusables/actions/if-supported-contexts.md index a804cb5a23fd..7846b9f6bc0f 100644 --- a/data/reusables/actions/if-supported-contexts.md +++ b/data/reusables/actions/if-supported-contexts.md @@ -1 +1 @@ -You can use any supported context and expression to create a conditional. For more information on which contexts are supported in this key, see [AUTOTITLE](/actions/learn-github-actions/contexts#context-availability). +You can use any supported context and expression to create a conditional. For more information on which contexts are supported in this key, see [AUTOTITLE](/actions/reference/workflows-and-actions/contexts#context-availability). diff --git a/data/reusables/actions/internal-actions-summary.md b/data/reusables/actions/internal-actions-summary.md index 7a28a150627b..96b7861cfcc3 100644 --- a/data/reusables/actions/internal-actions-summary.md +++ b/data/reusables/actions/internal-actions-summary.md @@ -1,3 +1,3 @@ {% ifversion internal-actions %} -To share actions across your enterprise without publishing the actions publicly, you can store the actions in an internal repository, then configure the repository to allow access to {% data variables.product.prodname_actions %} workflows in other repositories owned by the same organization or by any organization in the enterprise. For more information, see [AUTOTITLE](/actions/creating-actions/sharing-actions-and-workflows-with-your-enterprise). +To share actions across your enterprise without publishing the actions publicly, you can store the actions in an internal repository, then configure the repository to allow access to {% data variables.product.prodname_actions %} workflows in other repositories owned by the same organization or by any organization in the enterprise. For more information, see [AUTOTITLE](/actions/how-tos/reuse-automations/share-with-your-enterprise). {% endif %} diff --git a/data/reusables/actions/introducing-enterprise.md b/data/reusables/actions/introducing-enterprise.md index ff371e61719a..afb9334648f5 100644 --- a/data/reusables/actions/introducing-enterprise.md +++ b/data/reusables/actions/introducing-enterprise.md @@ -1 +1 @@ -Before you get started, you should make a plan for how you'll introduce {% data variables.product.prodname_actions %} to your enterprise. For more information, see [AUTOTITLE](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise). +Before you get started, you should make a plan for how you'll introduce {% data variables.product.prodname_actions %} to your enterprise. For more information, see [AUTOTITLE](/admin/managing-github-actions-for-your-enterprise/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise). diff --git a/data/reusables/actions/ip-allow-list-self-hosted-runners.md b/data/reusables/actions/ip-allow-list-self-hosted-runners.md index 89fb185a43be..82f32d0c0470 100644 --- a/data/reusables/actions/ip-allow-list-self-hosted-runners.md +++ b/data/reusables/actions/ip-allow-list-self-hosted-runners.md @@ -1,4 +1,4 @@ > [!WARNING] -> If you use an IP allow list and would also like to use {% data variables.product.prodname_actions %}, you must use self-hosted runners{% ifversion actions-hosted-runners %} or {% data variables.product.prodname_dotcom %}-hosted larger runners with static IP address ranges{% endif %}. When using [Azure private networking](/admin/configuration/configuring-private-networking-for-hosted-compute-products/about-azure-private-networking-for-github-hosted-runners-in-your-enterprise), IPs from your Azure subnet must be used. To reduce the number of required IPs, we recommend creating a load balancer to provide a single IP range for the GitHub allow list. For more information, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/communicating-with-self-hosted-runners) {% ifversion actions-hosted-runners %} or [AUTOTITLE](/actions/using-github-hosted-runners/using-larger-runners/about-larger-runners){% endif %}. +> If you use an IP allow list and would also like to use {% data variables.product.prodname_actions %}, you must use self-hosted runners{% ifversion actions-hosted-runners %} or {% data variables.product.prodname_dotcom %}-hosted larger runners with static IP address ranges{% endif %}. When using [Azure private networking](/admin/configuring-settings/configuring-private-networking-for-hosted-compute-products/about-azure-private-networking-for-github-hosted-runners-in-your-enterprise), IPs from your Azure subnet must be used. To reduce the number of required IPs, we recommend creating a load balancer to provide a single IP range for the GitHub allow list. For more information, see [AUTOTITLE](/actions/reference/runners/self-hosted-runners) {% ifversion actions-hosted-runners %} or [AUTOTITLE](/actions/concepts/runners/larger-runners){% endif %}. To allow your self-hosted {% ifversion actions-hosted-runners %}or larger hosted{% endif %} runners to communicate with {% data variables.product.prodname_dotcom %}, add the IP address or IP address range of your runners to the IP allow list that you have configured for your enterprise. diff --git a/data/reusables/actions/jobs/choosing-runner-github-hosted.md b/data/reusables/actions/jobs/choosing-runner-github-hosted.md index be5eeb029d50..172d72a05aa8 100644 --- a/data/reusables/actions/jobs/choosing-runner-github-hosted.md +++ b/data/reusables/actions/jobs/choosing-runner-github-hosted.md @@ -6,11 +6,11 @@ If you use a {% data variables.product.prodname_dotcom %}-hosted runner, each jo The value for runs-on, when you are using a {% data variables.product.prodname_dotcom %}-hosted runner, is a workflow label or the name of a runner group. The labels for the standard {% data variables.product.prodname_dotcom %}-hosted runners are shown in the following tables. -For more information, see [AUTOTITLE](/actions/using-github-hosted-runners/about-github-hosted-runners/about-github-hosted-runners). +For more information, see [AUTOTITLE](/actions/concepts/runners/github-hosted-runners). {% data reusables.actions.supported-github-runners %} -In addition to the standard {% data variables.product.prodname_dotcom %}-hosted runners, {% data variables.product.prodname_dotcom %} offers customers on {% data variables.product.prodname_team %} and {% data variables.product.prodname_ghe_cloud %} plans a range of managed virtual machines with advanced features - for example, more cores and disk space, GPU-powered machines, and ARM-powered machines. For more information, see [AUTOTITLE](/actions/using-github-hosted-runners/about-larger-runners/about-larger-runners). +In addition to the standard {% data variables.product.prodname_dotcom %}-hosted runners, {% data variables.product.prodname_dotcom %} offers customers on {% data variables.product.prodname_team %} and {% data variables.product.prodname_ghe_cloud %} plans a range of managed virtual machines with advanced features - for example, more cores and disk space, GPU-powered machines, and ARM-powered machines. For more information, see [AUTOTITLE](/actions/concepts/runners/larger-runners). > [!NOTE] > The `-latest` runner images are the latest stable images that {% data variables.product.prodname_dotcom %} provides, and might not be the most recent version of the operating system available from the operating system vendor. @@ -24,6 +24,6 @@ In addition to the standard {% data variables.product.prodname_dotcom %}-hosted runs-on: ubuntu-latest ``` -For more information, see [AUTOTITLE](/actions/using-github-hosted-runners/about-github-hosted-runners). +For more information, see [AUTOTITLE](/actions/concepts/runners/github-hosted-runners). {% endif %} diff --git a/data/reusables/actions/jobs/choosing-runner-group.md b/data/reusables/actions/jobs/choosing-runner-group.md index 26d548f65ffc..713cfeddaa65 100644 --- a/data/reusables/actions/jobs/choosing-runner-group.md +++ b/data/reusables/actions/jobs/choosing-runner-group.md @@ -2,7 +2,7 @@ You can use `runs-on` to target runner groups, so that the job will execute on a {% ifversion fpt or ghec %} -Runner groups can only have [{% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/using-larger-runners/about-larger-runners) or [self-hosted runners](/actions/how-tos/managing-self-hosted-runners) as members. +Runner groups can only have [{% data variables.actions.hosted_runner %}s](/actions/concepts/runners/larger-runners) or [self-hosted runners](/actions/how-tos/manage-runners/self-hosted-runners) as members. {% endif %} diff --git a/data/reusables/actions/jobs/choosing-runner-overview.md b/data/reusables/actions/jobs/choosing-runner-overview.md index dbf1c015d59b..c9dc60f3dd44 100644 --- a/data/reusables/actions/jobs/choosing-runner-overview.md +++ b/data/reusables/actions/jobs/choosing-runner-overview.md @@ -38,7 +38,7 @@ Use `jobs..runs-on` to define the type of machine to run the job on. {% endraw %} -* If you would like to run your workflow on multiple machines, use [`jobs..strategy`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstrategy). +* If you would like to run your workflow on multiple machines, use [`jobs..strategy`](/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idstrategy). > [!NOTE] > Quotation marks are not required around simple strings like `self-hosted`, but they are required for expressions like {% raw %} `"${{ inputs.chosen-os }}"`{% endraw %}. diff --git a/data/reusables/actions/jobs/choosing-runner-self-hosted.md b/data/reusables/actions/jobs/choosing-runner-self-hosted.md index 6632240cf0c6..f075ba7dadb3 100644 --- a/data/reusables/actions/jobs/choosing-runner-self-hosted.md +++ b/data/reusables/actions/jobs/choosing-runner-self-hosted.md @@ -6,4 +6,4 @@ runs-on: [self-hosted, linux] ``` -For more information, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners) and [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/using-self-hosted-runners-in-a-workflow). +For more information, see [AUTOTITLE](/actions/concepts/runners/self-hosted-runners) and [AUTOTITLE](/actions/how-tos/manage-runners/self-hosted-runners/use-in-a-workflow). diff --git a/data/reusables/actions/jobs/section-assigning-permissions-to-jobs-specific.md b/data/reusables/actions/jobs/section-assigning-permissions-to-jobs-specific.md index 8c52067c3f30..7c037887fdf7 100644 --- a/data/reusables/actions/jobs/section-assigning-permissions-to-jobs-specific.md +++ b/data/reusables/actions/jobs/section-assigning-permissions-to-jobs-specific.md @@ -1,3 +1,3 @@ -For a specific job, you can use `jobs..permissions` to modify the default permissions granted to the `GITHUB_TOKEN`, adding or removing access as required, so that you only allow the minimum required access. For more information, see [AUTOTITLE](/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token). +For a specific job, you can use `jobs..permissions` to modify the default permissions granted to the `GITHUB_TOKEN`, adding or removing access as required, so that you only allow the minimum required access. For more information, see [AUTOTITLE](/actions/tutorials/authenticate-with-github_token#modifying-the-permissions-for-the-github_token). -By specifying the permission within a job definition, you can configure a different set of permissions for the `GITHUB_TOKEN` for each job, if required. Alternatively, you can specify the permissions for all jobs in the workflow. For information on defining permissions at the workflow level, see [`permissions`](/actions/using-workflows/workflow-syntax-for-github-actions#permissions). +By specifying the permission within a job definition, you can configure a different set of permissions for the `GITHUB_TOKEN` for each job, if required. Alternatively, you can specify the permissions for all jobs in the workflow. For information on defining permissions at the workflow level, see [`permissions`](/actions/reference/workflows-and-actions/workflow-syntax#permissions). diff --git a/data/reusables/actions/jobs/section-assigning-permissions-to-jobs.md b/data/reusables/actions/jobs/section-assigning-permissions-to-jobs.md index 6bd56f4d4409..824a4d9f0ecb 100644 --- a/data/reusables/actions/jobs/section-assigning-permissions-to-jobs.md +++ b/data/reusables/actions/jobs/section-assigning-permissions-to-jobs.md @@ -1,9 +1,9 @@ -You can use `permissions` to modify the default permissions granted to the `GITHUB_TOKEN`, adding or removing access as required, so that you only allow the minimum required access. For more information, see [AUTOTITLE](/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token). +You can use `permissions` to modify the default permissions granted to the `GITHUB_TOKEN`, adding or removing access as required, so that you only allow the minimum required access. For more information, see [AUTOTITLE](/actions/tutorials/authenticate-with-github_token#modifying-the-permissions-for-the-github_token). -You can use `permissions` either as a top-level key, to apply to all jobs in the workflow, or within specific jobs. When you add the `permissions` key within a specific job, all actions and run commands within that job that use the `GITHUB_TOKEN` gain the access rights you specify. For more information, see [`jobs..permissions`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idpermissions). +You can use `permissions` either as a top-level key, to apply to all jobs in the workflow, or within specific jobs. When you add the `permissions` key within a specific job, all actions and run commands within that job that use the `GITHUB_TOKEN` gain the access rights you specify. For more information, see [`jobs..permissions`](/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idpermissions). -Owners of an organization{% ifversion not fpt %} or enterprise{% endif %} can restrict write access for the `GITHUB_TOKEN` at the repository level. For more information, see [AUTOTITLE](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization){% ifversion not fpt %} and [AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise).{% else %}.{% endif %} +Owners of an organization{% ifversion not fpt %} or enterprise{% endif %} can restrict write access for the `GITHUB_TOKEN` at the repository level. For more information, see [AUTOTITLE](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization){% ifversion not fpt %} and [AUTOTITLE](/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise).{% else %}.{% endif %} -When a workflow is triggered by the [`pull_request_target`](/actions/using-workflows/events-that-trigger-workflows#pull_request_target) event, the `GITHUB_TOKEN` is granted read/write repository permission, even when it is triggered from a public fork. For more information, see [AUTOTITLE](/actions/using-workflows/events-that-trigger-workflows#pull_request_target). +When a workflow is triggered by the [`pull_request_target`](/actions/reference/workflows-and-actions/events-that-trigger-workflows#pull_request_target) event, the `GITHUB_TOKEN` is granted read/write repository permission, even when it is triggered from a public fork. For more information, see [AUTOTITLE](/actions/reference/workflows-and-actions/events-that-trigger-workflows#pull_request_target). {% data reusables.actions.github-token-scope-descriptions %} diff --git a/data/reusables/actions/jobs/section-defining-outputs-for-jobs.md b/data/reusables/actions/jobs/section-defining-outputs-for-jobs.md index 114ef1a9d0b4..918dcd08f2f1 100644 --- a/data/reusables/actions/jobs/section-defining-outputs-for-jobs.md +++ b/data/reusables/actions/jobs/section-defining-outputs-for-jobs.md @@ -1,12 +1,12 @@ -You can use `jobs..outputs` to create a `map` of outputs for a job. Job outputs are available to all downstream jobs that depend on this job. For more information on defining job dependencies, see [`jobs..needs`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idneeds). +You can use `jobs..outputs` to create a `map` of outputs for a job. Job outputs are available to all downstream jobs that depend on this job. For more information on defining job dependencies, see [`jobs..needs`](/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idneeds). {% data reusables.actions.output-limitations %} Job outputs containing expressions are evaluated on the runner at the end of each job. Outputs containing secrets are redacted on the runner and not sent to {% data variables.product.prodname_actions %}. -If an output is skipped because it may contain a secret, you will see the following warning message: "Skip output `{output.Key}` since it may contain secret." For more information on how to handle secrets, please refer to the [Example: Masking and passing a secret between jobs or workflows](/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#example-masking-and-passing-a-secret-between-jobs-or-workflows). +If an output is skipped because it may contain a secret, you will see the following warning message: "Skip output `{output.Key}` since it may contain secret." For more information on how to handle secrets, please refer to the [Example: Masking and passing a secret between jobs or workflows](/actions/reference/workflows-and-actions/workflow-commands#example-masking-and-passing-a-secret-between-jobs-or-workflows). -To use job outputs in a dependent job, you can use the `needs` context. For more information, see [AUTOTITLE](/actions/learn-github-actions/contexts#needs-context). +To use job outputs in a dependent job, you can use the `needs` context. For more information, see [AUTOTITLE](/actions/reference/workflows-and-actions/contexts#needs-context). ### Example: Defining outputs for a job diff --git a/data/reusables/actions/jobs/section-running-jobs-in-a-container.md b/data/reusables/actions/jobs/section-running-jobs-in-a-container.md index c88b784576d4..a9a2852f83de 100644 --- a/data/reusables/actions/jobs/section-running-jobs-in-a-container.md +++ b/data/reusables/actions/jobs/section-running-jobs-in-a-container.md @@ -3,7 +3,7 @@ Use `jobs..container` to create a container to run any steps in a job th If you do not set a `container`, all steps will run directly on the host specified by `runs-on` unless a step refers to an action configured to run in a container. > [!NOTE] -> The default shell for `run` steps inside a container is `sh` instead of `bash`. This can be overridden with [`jobs..defaults.run`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_iddefaultsrun) or [`jobs..steps[*].shell`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsshell). +> The default shell for `run` steps inside a container is `sh` instead of `bash`. This can be overridden with [`jobs..defaults.run`](/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_iddefaultsrun) or [`jobs..steps[*].shell`](/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idstepsshell). ### Example: Running a job within a container diff --git a/data/reusables/actions/jobs/section-using-concurrency-jobs.md b/data/reusables/actions/jobs/section-using-concurrency-jobs.md index 71620124d1a9..e0e9985b9fd3 100644 --- a/data/reusables/actions/jobs/section-using-concurrency-jobs.md +++ b/data/reusables/actions/jobs/section-using-concurrency-jobs.md @@ -1,5 +1,5 @@ -You can use `jobs..concurrency` to ensure that only a single job or workflow using the same concurrency group will run at a time. A concurrency group can be any string or expression. Allowed expression contexts: [`github`](/actions/learn-github-actions/contexts#github-context), [`inputs`](/actions/learn-github-actions/contexts#inputs-context), [`vars`](/actions/learn-github-actions/contexts#vars-context), [`needs`](/actions/learn-github-actions/contexts#needs-context), [`strategy`](/actions/learn-github-actions/contexts#strategy-context), and [`matrix`](/actions/learn-github-actions/contexts#matrix-context). For more information about expressions, see [AUTOTITLE](/actions/learn-github-actions/expressions). +You can use `jobs..concurrency` to ensure that only a single job or workflow using the same concurrency group will run at a time. A concurrency group can be any string or expression. Allowed expression contexts: [`github`](/actions/reference/workflows-and-actions/contexts#github-context), [`inputs`](/actions/reference/workflows-and-actions/contexts#inputs-context), [`vars`](/actions/reference/workflows-and-actions/contexts#vars-context), [`needs`](/actions/reference/workflows-and-actions/contexts#needs-context), [`strategy`](/actions/reference/workflows-and-actions/contexts#strategy-context), and [`matrix`](/actions/reference/workflows-and-actions/contexts#matrix-context). For more information about expressions, see [AUTOTITLE](/actions/reference/workflows-and-actions/expressions). -You can also specify `concurrency` at the workflow level. For more information, see [`concurrency`](/actions/using-workflows/workflow-syntax-for-github-actions#concurrency). +You can also specify `concurrency` at the workflow level. For more information, see [`concurrency`](/actions/reference/workflows-and-actions/workflow-syntax#concurrency). {% data reusables.actions.actions-group-concurrency %} diff --git a/data/reusables/actions/jobs/section-using-concurrency.md b/data/reusables/actions/jobs/section-using-concurrency.md index f700f04430c7..381d3509682a 100644 --- a/data/reusables/actions/jobs/section-using-concurrency.md +++ b/data/reusables/actions/jobs/section-using-concurrency.md @@ -1,5 +1,5 @@ -Use `concurrency` to ensure that only a single job or workflow using the same concurrency group will run at a time. A concurrency group can be any string or expression. The expression can only use [`github`](/actions/learn-github-actions/contexts#github-context), [`inputs`](/actions/learn-github-actions/contexts#inputs-context) and [`vars`](/actions/learn-github-actions/contexts#vars-context) contexts. For more information about expressions, see [AUTOTITLE](/actions/learn-github-actions/expressions). +Use `concurrency` to ensure that only a single job or workflow using the same concurrency group will run at a time. A concurrency group can be any string or expression. The expression can only use [`github`](/actions/reference/workflows-and-actions/contexts#github-context), [`inputs`](/actions/reference/workflows-and-actions/contexts#inputs-context) and [`vars`](/actions/reference/workflows-and-actions/contexts#vars-context) contexts. For more information about expressions, see [AUTOTITLE](/actions/reference/workflows-and-actions/expressions). -You can also specify `concurrency` at the job level. For more information, see [`jobs..concurrency`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idconcurrency). +You can also specify `concurrency` at the job level. For more information, see [`jobs..concurrency`](/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idconcurrency). {% data reusables.actions.actions-group-concurrency %} diff --git a/data/reusables/actions/jobs/section-using-conditions-to-control-job-execution.md b/data/reusables/actions/jobs/section-using-conditions-to-control-job-execution.md index 277f46b94620..440b93e40a28 100644 --- a/data/reusables/actions/jobs/section-using-conditions-to-control-job-execution.md +++ b/data/reusables/actions/jobs/section-using-conditions-to-control-job-execution.md @@ -1,9 +1,9 @@ You can use the `jobs..if` conditional to prevent a job from running unless a condition is met. {% data reusables.actions.if-supported-contexts %} > [!NOTE] -> The `jobs..if` condition is evaluated before [`jobs..strategy.matrix`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix) is applied. +> The `jobs..if` condition is evaluated before [`jobs..strategy.matrix`](/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idstrategymatrix) is applied. -{% data reusables.actions.expression-syntax-if %} For more information, see [AUTOTITLE](/actions/learn-github-actions/expressions). +{% data reusables.actions.expression-syntax-if %} For more information, see [AUTOTITLE](/actions/reference/workflows-and-actions/expressions). ### Example: Only run job for specific repository diff --git a/data/reusables/actions/jobs/section-using-environments-for-jobs.md b/data/reusables/actions/jobs/section-using-environments-for-jobs.md index f0615bed9f52..c43ab034e357 100644 --- a/data/reusables/actions/jobs/section-using-environments-for-jobs.md +++ b/data/reusables/actions/jobs/section-using-environments-for-jobs.md @@ -3,7 +3,7 @@ Use `jobs..environment` to define the environment that the job reference You can provide the environment as only the environment `name`, or as an environment object with the `name` and `url`. The URL maps to `environment_url` in the deployments API. For more information about the deployments API, see [AUTOTITLE](/rest/repos#deployments). > [!NOTE] -> All deployment protection rules must pass before a job referencing the environment is sent to a runner. For more information, see [AUTOTITLE](/actions/deployment/targeting-different-environments/managing-environments-for-deployment). +> All deployment protection rules must pass before a job referencing the environment is sent to a runner. For more information, see [AUTOTITLE](/actions/how-tos/deploy/configure-and-manage-deployments/manage-environments). ### Example: Using a single environment name @@ -23,7 +23,7 @@ environment: url: https://github.com ``` -The value of `url` can be an expression. Allowed expression contexts: [`github`](/actions/learn-github-actions/contexts#github-context), [`inputs`](/actions/learn-github-actions/contexts#inputs-context), [`vars`](/actions/learn-github-actions/contexts#vars-context), [`needs`](/actions/learn-github-actions/contexts#needs-context), [`strategy`](/actions/learn-github-actions/contexts#strategy-context), [`matrix`](/actions/learn-github-actions/contexts#matrix-context), [`job`](/actions/learn-github-actions/contexts#job-context), [`runner`](/actions/learn-github-actions/contexts#runner-context), [`env`](/actions/learn-github-actions/contexts#env-context), and [`steps`](/actions/learn-github-actions/contexts#steps-context). For more information about expressions, see [AUTOTITLE](/actions/learn-github-actions/expressions). +The value of `url` can be an expression. Allowed expression contexts: [`github`](/actions/reference/workflows-and-actions/contexts#github-context), [`inputs`](/actions/reference/workflows-and-actions/contexts#inputs-context), [`vars`](/actions/reference/workflows-and-actions/contexts#vars-context), [`needs`](/actions/reference/workflows-and-actions/contexts#needs-context), [`strategy`](/actions/reference/workflows-and-actions/contexts#strategy-context), [`matrix`](/actions/reference/workflows-and-actions/contexts#matrix-context), [`job`](/actions/reference/workflows-and-actions/contexts#job-context), [`runner`](/actions/reference/workflows-and-actions/contexts#runner-context), [`env`](/actions/reference/workflows-and-actions/contexts#env-context), and [`steps`](/actions/reference/workflows-and-actions/contexts#steps-context). For more information about expressions, see [AUTOTITLE](/actions/reference/workflows-and-actions/expressions). ### Example: Using output as URL @@ -37,7 +37,7 @@ environment: {% endraw %} -The value of `name` can be an expression. Allowed expression contexts: [`github`](/actions/learn-github-actions/contexts#github-context), [`inputs`](/actions/learn-github-actions/contexts#inputs-context), [`vars`](/actions/learn-github-actions/contexts#vars-context), [`needs`](/actions/learn-github-actions/contexts#needs-context), [`strategy`](/actions/learn-github-actions/contexts#strategy-context), and [`matrix`](/actions/learn-github-actions/contexts#matrix-context). For more information about expressions, see [AUTOTITLE](/actions/learn-github-actions/expressions). +The value of `name` can be an expression. Allowed expression contexts: [`github`](/actions/reference/workflows-and-actions/contexts#github-context), [`inputs`](/actions/reference/workflows-and-actions/contexts#inputs-context), [`vars`](/actions/reference/workflows-and-actions/contexts#vars-context), [`needs`](/actions/reference/workflows-and-actions/contexts#needs-context), [`strategy`](/actions/reference/workflows-and-actions/contexts#strategy-context), and [`matrix`](/actions/reference/workflows-and-actions/contexts#matrix-context). For more information about expressions, see [AUTOTITLE](/actions/reference/workflows-and-actions/expressions). ### Example: Using an expression as environment name diff --git a/data/reusables/actions/jobs/section-using-jobs-in-a-workflow-needs.md b/data/reusables/actions/jobs/section-using-jobs-in-a-workflow-needs.md index f18cc1d3e831..5cab7d88f39e 100644 --- a/data/reusables/actions/jobs/section-using-jobs-in-a-workflow-needs.md +++ b/data/reusables/actions/jobs/section-using-jobs-in-a-workflow-needs.md @@ -31,4 +31,4 @@ jobs: needs: [job1, job2] ``` -In this example, `job3` uses the `always()` conditional expression so that it always runs after `job1` and `job2` have completed, regardless of whether they were successful. For more information, see [AUTOTITLE](/actions/learn-github-actions/expressions#status-check-functions). +In this example, `job3` uses the `always()` conditional expression so that it always runs after `job1` and `job2` have completed, regardless of whether they were successful. For more information, see [AUTOTITLE](/actions/reference/workflows-and-actions/expressions#status-check-functions). diff --git a/data/reusables/actions/jobs/section-using-jobs-in-a-workflow.md b/data/reusables/actions/jobs/section-using-jobs-in-a-workflow.md index 3a6b60c53126..40c7309b4dde 100644 --- a/data/reusables/actions/jobs/section-using-jobs-in-a-workflow.md +++ b/data/reusables/actions/jobs/section-using-jobs-in-a-workflow.md @@ -2,6 +2,6 @@ A workflow run is made up of one or more `jobs`, which run in parallel by defaul Each job runs in a runner environment specified by `runs-on`. -You can run an unlimited number of jobs as long as you are within the workflow usage limits. For more information, see [AUTOTITLE](/actions/learn-github-actions/usage-limits-billing-and-administration) for {% data variables.product.prodname_dotcom %}-hosted runners and [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/usage-limits-for-self-hosted-runners) for self-hosted runner usage limits. +You can run an unlimited number of jobs as long as you are within the workflow usage limits. For more information, see [AUTOTITLE](/actions/concepts/billing-and-usage) for {% data variables.product.prodname_dotcom %}-hosted runners and [AUTOTITLE](/actions/reference/limits) for self-hosted runner usage limits. If you need to find the unique identifier of a job running in a workflow run, you can use the {% data variables.product.github %} API. For more information, see [AUTOTITLE](/rest/actions#workflow-jobs). diff --git a/data/reusables/actions/jobs/setting-default-values-for-jobs-defaults-job-run.md b/data/reusables/actions/jobs/setting-default-values-for-jobs-defaults-job-run.md index 27807758a31a..54e9439a013b 100644 --- a/data/reusables/actions/jobs/setting-default-values-for-jobs-defaults-job-run.md +++ b/data/reusables/actions/jobs/setting-default-values-for-jobs-defaults-job-run.md @@ -1,6 +1,6 @@ Use `jobs..defaults.run` to provide default `shell` and `working-directory` to all `run` steps in the job. -You can provide default `shell` and `working-directory` options for all [`run`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun) steps in a job. You can also set default settings for `run` for the entire workflow. For more information, see [`defaults.run`](/actions/using-workflows/workflow-syntax-for-github-actions#defaultsrun). +You can provide default `shell` and `working-directory` options for all [`run`](/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idstepsrun) steps in a job. You can also set default settings for `run` for the entire workflow. For more information, see [`defaults.run`](/actions/reference/workflows-and-actions/workflow-syntax#defaultsrun). These can be overridden at the `jobs..defaults.run` and `jobs..steps[*].run` levels. diff --git a/data/reusables/actions/jobs/setting-default-values-for-jobs-defaults-job.md b/data/reusables/actions/jobs/setting-default-values-for-jobs-defaults-job.md index 4f1120ad8d4e..df4cc8d1dff9 100644 --- a/data/reusables/actions/jobs/setting-default-values-for-jobs-defaults-job.md +++ b/data/reusables/actions/jobs/setting-default-values-for-jobs-defaults-job.md @@ -1,3 +1,3 @@ -Use `jobs..defaults` to create a `map` of default settings that will apply to all steps in the job. You can also set default settings for the entire workflow. For more information, see [`defaults`](/actions/using-workflows/workflow-syntax-for-github-actions#defaults). +Use `jobs..defaults` to create a `map` of default settings that will apply to all steps in the job. You can also set default settings for the entire workflow. For more information, see [`defaults`](/actions/reference/workflows-and-actions/workflow-syntax#defaults). {% data reusables.actions.defaults-override %} diff --git a/data/reusables/actions/jobs/setting-default-values-for-jobs-defaults-run.md b/data/reusables/actions/jobs/setting-default-values-for-jobs-defaults-run.md index 0a047c6b4ecf..b5b4c62b11ca 100644 --- a/data/reusables/actions/jobs/setting-default-values-for-jobs-defaults-run.md +++ b/data/reusables/actions/jobs/setting-default-values-for-jobs-defaults-run.md @@ -1,4 +1,4 @@ -You can use `defaults.run` to provide default `shell` and `working-directory` options for all [`run`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun) steps in a workflow. You can also set default settings for `run` that are only available to a job. For more information, see [`jobs..defaults.run`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_iddefaultsrun). You cannot use contexts or expressions in this keyword. +You can use `defaults.run` to provide default `shell` and `working-directory` options for all [`run`](/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idstepsrun) steps in a workflow. You can also set default settings for `run` that are only available to a job. For more information, see [`jobs..defaults.run`](/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_iddefaultsrun). You cannot use contexts or expressions in this keyword. {% data reusables.actions.defaults-override %} diff --git a/data/reusables/actions/jobs/setting-default-values-for-jobs-defaults.md b/data/reusables/actions/jobs/setting-default-values-for-jobs-defaults.md index e915af489602..93c4cb65ea1b 100644 --- a/data/reusables/actions/jobs/setting-default-values-for-jobs-defaults.md +++ b/data/reusables/actions/jobs/setting-default-values-for-jobs-defaults.md @@ -1,3 +1,3 @@ -Use `defaults` to create a `map` of default settings that will apply to all jobs in the workflow. You can also set default settings that are only available to a job. For more information, see [`jobs..defaults`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_iddefaults). +Use `defaults` to create a `map` of default settings that will apply to all jobs in the workflow. You can also set default settings that are only available to a job. For more information, see [`jobs..defaults`](/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_iddefaults). {% data reusables.actions.defaults-override %} diff --git a/data/reusables/actions/larger-runner-name-note.md b/data/reusables/actions/larger-runner-name-note.md index 6a310f9b0581..ee4dcf77b0f0 100644 --- a/data/reusables/actions/larger-runner-name-note.md +++ b/data/reusables/actions/larger-runner-name-note.md @@ -1,2 +1,2 @@ > [!NOTE] -> The names of {% data variables.actions.hosted_runners %} can dictate their functionality. For example, to use a {% data variables.actions.hosted_runner %} for {% data variables.product.prodname_code_scanning %} default setup, the runner must be named `code-scanning`. For more information on {% data variables.product.prodname_code_scanning %} with {% data variables.actions.hosted_runners %}, see [AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/configuring-larger-runners-for-default-setup). +> The names of {% data variables.actions.hosted_runners %} can dictate their functionality. For example, to use a {% data variables.actions.hosted_runner %} for {% data variables.product.prodname_code_scanning %} default setup, the runner must be named `code-scanning`. For more information on {% data variables.product.prodname_code_scanning %} with {% data variables.actions.hosted_runners %}, see [AUTOTITLE](/code-security/how-tos/find-and-fix-code-vulnerabilities/manage-your-configuration/configure-larger-runners). diff --git a/data/reusables/actions/migrating-enterprise.md b/data/reusables/actions/migrating-enterprise.md index 94f5e5c2f666..b36be9e8555a 100644 --- a/data/reusables/actions/migrating-enterprise.md +++ b/data/reusables/actions/migrating-enterprise.md @@ -1 +1 @@ -If you're migrating your enterprise to {% data variables.product.prodname_actions %} from another provider, there are additional considerations. For more information, see [AUTOTITLE](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/migrating-your-enterprise-to-github-actions). +If you're migrating your enterprise to {% data variables.product.prodname_actions %} from another provider, there are additional considerations. For more information, see [AUTOTITLE](/admin/managing-github-actions-for-your-enterprise/getting-started-with-github-actions-for-your-enterprise/migrating-your-enterprise-to-github-actions). diff --git a/data/reusables/actions/more-resources-for-ghes.md b/data/reusables/actions/more-resources-for-ghes.md index d709421d58ad..839dd140a3e7 100644 --- a/data/reusables/actions/more-resources-for-ghes.md +++ b/data/reusables/actions/more-resources-for-ghes.md @@ -5,4 +5,4 @@ If you plan to enable {% data variables.product.prodname_actions %} or {% data v These adjustments should be applied to the base requirements for each user tier. We recommend monitoring all changes to your resources, as further increases may be needed. -For more information about these requirements, see [AUTOTITLE](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server#review-hardware-considerations). +For more information about these requirements, see [AUTOTITLE](/admin/managing-github-actions-for-your-enterprise/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server#review-hardware-considerations). diff --git a/data/reusables/actions/oidc-deployment-protection-rules.md b/data/reusables/actions/oidc-deployment-protection-rules.md index f49b4e575133..d455c17a2546 100644 --- a/data/reusables/actions/oidc-deployment-protection-rules.md +++ b/data/reusables/actions/oidc-deployment-protection-rules.md @@ -1,2 +1,2 @@ > [!NOTE] -> When environments are used in workflows or in OIDC policies, we recommend adding protection rules to the environment for additional security. For example, you can configure deployment rules on an environment to restrict which branches and tags can deploy to the environment or access environment secrets. For more information, see [AUTOTITLE](/actions/deployment/targeting-different-environments/managing-environments-for-deployment#deployment-protection-rules). +> When environments are used in workflows or in OIDC policies, we recommend adding protection rules to the environment for additional security. For example, you can configure deployment rules on an environment to restrict which branches and tags can deploy to the environment or access environment secrets. For more information, see [AUTOTITLE](/actions/how-tos/deploy/configure-and-manage-deployments/manage-environments#deployment-protection-rules). diff --git a/data/reusables/actions/oidc-further-reading.md b/data/reusables/actions/oidc-further-reading.md index fa07e5ddba85..acfc9d7db3bb 100644 --- a/data/reusables/actions/oidc-further-reading.md +++ b/data/reusables/actions/oidc-further-reading.md @@ -1,2 +1,2 @@ -* [AUTOTITLE](/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows) -* [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/communicating-with-self-hosted-runners) +* [AUTOTITLE](/actions/how-tos/secure-your-work/security-harden-deployments/oidc-with-reusable-workflows) +* [AUTOTITLE](/actions/reference/runners/self-hosted-runners) diff --git a/data/reusables/actions/oidc-link-to-intro.md b/data/reusables/actions/oidc-link-to-intro.md index ce45cea7412c..049baa96e231 100644 --- a/data/reusables/actions/oidc-link-to-intro.md +++ b/data/reusables/actions/oidc-link-to-intro.md @@ -1 +1 @@ -* To learn the basic concepts of how {% data variables.product.prodname_dotcom %} uses OpenID Connect (OIDC), and its architecture and benefits, see [AUTOTITLE](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect). +* To learn the basic concepts of how {% data variables.product.prodname_dotcom %} uses OpenID Connect (OIDC), and its architecture and benefits, see [AUTOTITLE](/actions/concepts/security/openid-connect). diff --git a/data/reusables/actions/oidc-on-ghecom.md b/data/reusables/actions/oidc-on-ghecom.md index 5a6a175a8526..f131dca6eef6 100644 --- a/data/reusables/actions/oidc-on-ghecom.md +++ b/data/reusables/actions/oidc-on-ghecom.md @@ -1,3 +1,3 @@ {%- ifversion ghec %} -* If you're following this guide on {% data variables.enterprise.data_residency_site %}, understand that you must substitute certain values in the following documentation. See [AUTOTITLE](/actions/security-for-github-actions/security-hardening-your-deployments/about-security-hardening-with-openid-connect#following-these-guides-on-ghecom). +* If you're following this guide on {% data variables.enterprise.data_residency_site %}, understand that you must substitute certain values in the following documentation. See [AUTOTITLE](/actions/concepts/security/openid-connect#following-these-guides-on-ghecom). {%- endif %} diff --git a/data/reusables/actions/oidc-permissions-token.md b/data/reusables/actions/oidc-permissions-token.md index 690efbc27dbf..303465a8a285 100644 --- a/data/reusables/actions/oidc-permissions-token.md +++ b/data/reusables/actions/oidc-permissions-token.md @@ -1,5 +1,5 @@ -The job or workflow run requires a `permissions` setting with [`id-token: write`](/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token) to allow {% data variables.product.github %}'s OIDC provider to create a JSON Web Token for every run. +The job or workflow run requires a `permissions` setting with [`id-token: write`](/actions/tutorials/authenticate-with-github_token#modifying-the-permissions-for-the-github_token) to allow {% data variables.product.github %}'s OIDC provider to create a JSON Web Token for every run. > [!NOTE] Setting `id-token: write` in the workflow’s permissions does not give the workflow permission to modify or write to any resources. Instead, it only allows the workflow to request (fetch) and use (set) an OIDC token for an action or step. This token is then used to authenticate with external services using a short-lived access token. -For detailed information on required permissions, configuration examples, and advanced scenarios, see [AUTOTITLE](/actions/reference/openid-connect-reference##workflow-permissions-for-the-requesting-the-oidc-token). +For detailed information on required permissions, configuration examples, and advanced scenarios, see [AUTOTITLE](/actions/reference/security/oidc#workflow-permissions-for-the-requesting-the-oidc-token). diff --git a/data/reusables/actions/oidc-security-notice.md b/data/reusables/actions/oidc-security-notice.md index 0c591bb12f88..87ddb0fbba53 100644 --- a/data/reusables/actions/oidc-security-notice.md +++ b/data/reusables/actions/oidc-security-notice.md @@ -1 +1 @@ -* Before proceeding, you must plan your security strategy to ensure that access tokens are only allocated in a predictable way. To control how your cloud provider issues access tokens, you **must** define at least one condition, so that untrusted repositories can’t request access tokens for your cloud resources. For more information, see [AUTOTITLE](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#configuring-the-oidc-trust-with-the-cloud). +* Before proceeding, you must plan your security strategy to ensure that access tokens are only allocated in a predictable way. To control how your cloud provider issues access tokens, you **must** define at least one condition, so that untrusted repositories can’t request access tokens for your cloud resources. For more information, see [AUTOTITLE](/actions/concepts/security/openid-connect#configuring-the-oidc-trust-with-the-cloud). diff --git a/data/reusables/actions/onboarding-next-steps.md b/data/reusables/actions/onboarding-next-steps.md index b360e8842329..c45f9fbda245 100644 --- a/data/reusables/actions/onboarding-next-steps.md +++ b/data/reusables/actions/onboarding-next-steps.md @@ -1,9 +1,9 @@ {% data variables.product.prodname_actions %} can help you automate nearly every aspect of your application development processes. Ready to get started? Here are some helpful resources for taking your next steps with {% data variables.product.prodname_actions %}: -* To create a {% data variables.product.prodname_actions %} workflow, see [AUTOTITLE](/actions/learn-github-actions/using-starter-workflows). -* For continuous integration (CI) workflows, see [AUTOTITLE](/actions/automating-builds-and-tests). -* For building and publishing packages, see [AUTOTITLE](/actions/publishing-packages). -* For deploying projects, see [AUTOTITLE](/actions/deployment). -* For automating tasks and processes on {% data variables.product.prodname_dotcom %}, see [AUTOTITLE](/actions/managing-issues-and-pull-requests). -* For examples that demonstrate more complex features of {% data variables.product.prodname_actions %}, see [AUTOTITLE](/actions/examples). These detailed examples explain how to test your code on a runner, access the {% data variables.product.prodname_dotcom %} CLI, and use advanced features such as concurrency and test matrices.{% ifversion github-certification %} +* To create a {% data variables.product.prodname_actions %} workflow, see [AUTOTITLE](/actions/how-tos/write-workflows/use-workflow-templates). +* For continuous integration (CI) workflows, see [AUTOTITLE](/actions/tutorials/build-and-test-code). +* For building and publishing packages, see [AUTOTITLE](/actions/tutorials/publish-packages). +* For deploying projects, see [AUTOTITLE](/actions/how-tos/deploy/deploy-to-third-party-platforms). +* For automating tasks and processes on {% data variables.product.prodname_dotcom %}, see [AUTOTITLE](/actions/tutorials/manage-your-work). +* For examples that demonstrate more complex features of {% data variables.product.prodname_actions %}, see [AUTOTITLE](/actions/how-tos/write-workflows/choose-what-workflows-do). These detailed examples explain how to test your code on a runner, access the {% data variables.product.prodname_dotcom %} CLI, and use advanced features such as concurrency and test matrices.{% ifversion github-certification %} * To certify your proficiency in automating workflows and accelerating development with {% data variables.product.prodname_actions %}, earn a {% data variables.product.prodname_actions %} certificate with {% data variables.product.prodname_certifications %}. For more information, see [AUTOTITLE](/get-started/showcase-your-expertise-with-github-certifications/about-github-certifications).{% endif %} diff --git a/data/reusables/actions/org-access-to-github-hosted-runners.md b/data/reusables/actions/org-access-to-github-hosted-runners.md index a0faf838a7cc..7a50ed5eb12f 100644 --- a/data/reusables/actions/org-access-to-github-hosted-runners.md +++ b/data/reusables/actions/org-access-to-github-hosted-runners.md @@ -1 +1 @@ -1. To allow organizations to access your {% data variables.actions.hosted_runner %}, specify which organizations can use the runner group the runner is assigned to. For more information, see [AUTOTITLE](/actions/using-github-hosted-runners/about-larger-runners/controlling-access-to-larger-runners#changing-which-organizations-can-access-a-runner-group). +1. To allow organizations to access your {% data variables.actions.hosted_runner %}, specify which organizations can use the runner group the runner is assigned to. For more information, see [AUTOTITLE](/actions/how-tos/manage-runners/larger-runners/control-access#changing-which-organizations-can-access-a-runner-group). diff --git a/data/reusables/actions/partial-reruns-with-reusable.md b/data/reusables/actions/partial-reruns-with-reusable.md index 1fba9efa3f0d..f7c0e23e18bb 100644 --- a/data/reusables/actions/partial-reruns-with-reusable.md +++ b/data/reusables/actions/partial-reruns-with-reusable.md @@ -1,6 +1,6 @@ -Reusable workflows from public repositories can be referenced using a SHA, a release tag, or a branch name. For more information, see [AUTOTITLE](/actions/using-workflows/reusing-workflows#calling-a-reusable-workflow). +Reusable workflows from public repositories can be referenced using a SHA, a release tag, or a branch name. For more information, see [AUTOTITLE](/actions/how-tos/reuse-automations/reuse-workflows#calling-a-reusable-workflow). When you re-run a workflow that uses a reusable workflow and the reference is not a SHA, there are some behaviors to be aware of: -* Re-running all jobs in a workflow will use the reusable workflow from the specified reference. For more information about re-running all jobs in a workflow, see [AUTOTITLE](/actions/managing-workflow-runs/re-running-workflows-and-jobs#re-running-all-the-jobs-in-a-workflow). -* Re-running failed jobs or a specific job in a workflow will use the reusable workflow from the same commit SHA of the first attempt. For more information about re-running failed jobs in a workflow, see [AUTOTITLE](/actions/managing-workflow-runs/re-running-workflows-and-jobs#re-running-failed-jobs-in-a-workflow). For more information about re-running a specific job in a workflow, see [AUTOTITLE](/actions/managing-workflow-runs/re-running-workflows-and-jobs#re-running-a-specific-job-in-a-workflow). +* Re-running all jobs in a workflow will use the reusable workflow from the specified reference. For more information about re-running all jobs in a workflow, see [AUTOTITLE](/actions/how-tos/manage-workflow-runs/re-run-workflows-and-jobs#re-running-all-the-jobs-in-a-workflow). +* Re-running failed jobs or a specific job in a workflow will use the reusable workflow from the same commit SHA of the first attempt. For more information about re-running failed jobs in a workflow, see [AUTOTITLE](/actions/how-tos/manage-workflow-runs/re-run-workflows-and-jobs#re-running-failed-jobs-in-a-workflow). For more information about re-running a specific job in a workflow, see [AUTOTITLE](/actions/how-tos/manage-workflow-runs/re-run-workflows-and-jobs#re-running-a-specific-job-in-a-workflow). diff --git a/data/reusables/actions/permissions-statement-secrets-and-variables-organization.md b/data/reusables/actions/permissions-statement-secrets-and-variables-organization.md index 930527c4ba55..e3543fb57f15 100644 --- a/data/reusables/actions/permissions-statement-secrets-and-variables-organization.md +++ b/data/reusables/actions/permissions-statement-secrets-and-variables-organization.md @@ -1,3 +1,3 @@ Organization owners{% ifversion custom-org-roles %} and users with the "Manage organization Actions variables" or "Manage organization Actions secrets" permissions{% endif %} can create secrets or variables at the organization level.{% ifversion custom-org-roles %} -For more information, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).{% endif %} +For more information, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles).{% endif %} diff --git a/data/reusables/actions/permissions-statement-secrets-environment.md b/data/reusables/actions/permissions-statement-secrets-environment.md index 720019e740cb..8761f01f1cbc 100644 --- a/data/reusables/actions/permissions-statement-secrets-environment.md +++ b/data/reusables/actions/permissions-statement-secrets-environment.md @@ -1 +1 @@ -To create secrets or variables for an environment in a personal account repository, you must be the repository owner. To create secrets or variables for an environment in an organization repository, you must have `admin` access. For more information on environments, see [AUTOTITLE](/actions/deployment/targeting-different-environments/managing-environments-for-deployment). +To create secrets or variables for an environment in a personal account repository, you must be the repository owner. To create secrets or variables for an environment in an organization repository, you must have `admin` access. For more information on environments, see [AUTOTITLE](/actions/how-tos/deploy/configure-and-manage-deployments/manage-environments). diff --git a/data/reusables/actions/reusable-keyword.md b/data/reusables/actions/reusable-keyword.md index c60145126799..e375354e6ee1 100644 --- a/data/reusables/actions/reusable-keyword.md +++ b/data/reusables/actions/reusable-keyword.md @@ -1 +1 @@ -This keyword can reference several contexts. For more information, see [Contexts](/actions/learn-github-actions/contexts#context-availability). +This keyword can reference several contexts. For more information, see [Contexts](/actions/reference/workflows-and-actions/contexts#context-availability). diff --git a/data/reusables/actions/reusable-workflow-calling-syntax.md b/data/reusables/actions/reusable-workflow-calling-syntax.md index 5dea4b4fc63f..15dc11ce6f60 100644 --- a/data/reusables/actions/reusable-workflow-calling-syntax.md +++ b/data/reusables/actions/reusable-workflow-calling-syntax.md @@ -1,6 +1,6 @@ * `{owner}/{repo}/.github/workflows/{filename}@{ref}` for reusable workflows in {% ifversion fpt %}public and private{% elsif ghec or ghes %}public, internal and private{% endif %} repositories. * `./.github/workflows/{filename}` for reusable workflows in the same repository. -In the first option, `{ref}` can be a SHA, a release tag, or a branch name. If a release tag and a branch have the same name, the release tag takes precedence over the branch name. Using the commit SHA is the safest option for stability and security. For more information, see [AUTOTITLE](/actions/security-guides/security-hardening-for-github-actions#reusing-third-party-workflows). +In the first option, `{ref}` can be a SHA, a release tag, or a branch name. If a release tag and a branch have the same name, the release tag takes precedence over the branch name. Using the commit SHA is the safest option for stability and security. For more information, see [AUTOTITLE](/actions/reference/security/secure-use#reusing-third-party-workflows). If you use the second syntax option (without `{owner}/{repo}` and `@{ref}`) the called workflow is from the same commit as the caller workflow. Ref prefixes such as `refs/heads` and `refs/tags` are not allowed. You cannot use contexts or expressions in this keyword. diff --git a/data/reusables/actions/runner-debug-description.md b/data/reusables/actions/runner-debug-description.md index b90948ae47fd..169ad9ec56fa 100644 --- a/data/reusables/actions/runner-debug-description.md +++ b/data/reusables/actions/runner-debug-description.md @@ -1 +1 @@ -This is set only if [debug logging](/actions/monitoring-and-troubleshooting-workflows/enabling-debug-logging) is enabled, and always has the value of `1`. It can be useful as an indicator to enable additional debugging or verbose logging in your own job steps. +This is set only if [debug logging](/actions/how-tos/monitor-workflows/enable-debug-logging) is enabled, and always has the value of `1`. It can be useful as an indicator to enable additional debugging or verbose logging in your own job steps. diff --git a/data/reusables/actions/runner-tool-cache-description.md b/data/reusables/actions/runner-tool-cache-description.md index b63c9cd7a5ef..d9319653f93a 100644 --- a/data/reusables/actions/runner-tool-cache-description.md +++ b/data/reusables/actions/runner-tool-cache-description.md @@ -1 +1 @@ -The path to the directory containing preinstalled tools for {% data variables.product.prodname_dotcom %}-hosted runners. For more information, see [AUTOTITLE](/actions/using-github-hosted-runners/about-github-hosted-runners#supported-software). +The path to the directory containing preinstalled tools for {% data variables.product.prodname_dotcom %}-hosted runners. For more information, see [AUTOTITLE](/actions/concepts/runners/github-hosted-runners#supported-software). diff --git a/data/reusables/actions/secrets-and-variables-org-permissions.md b/data/reusables/actions/secrets-and-variables-org-permissions.md index 9e5731c29bc0..396132509436 100644 --- a/data/reusables/actions/secrets-and-variables-org-permissions.md +++ b/data/reusables/actions/secrets-and-variables-org-permissions.md @@ -1,6 +1,6 @@ {% ifversion custom-org-roles %} > [!NOTE] -> The "Actions secrets and variables" page may not show distinct tabs for secrets and variables depending on your permissions. Organization owners and users with both the "Manage organization Actions variables" and "Manage organization Actions secrets" permissions will see the **Variables** and **Secrets** tabs. For more information, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles). +> The "Actions secrets and variables" page may not show distinct tabs for secrets and variables depending on your permissions. Organization owners and users with both the "Manage organization Actions variables" and "Manage organization Actions secrets" permissions will see the **Variables** and **Secrets** tabs. For more information, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles). {% endif %} diff --git a/data/reusables/actions/self-hosted-runner-configure.md b/data/reusables/actions/self-hosted-runner-configure.md index d85e538e8189..73675b8b8631 100644 --- a/data/reusables/actions/self-hosted-runner-configure.md +++ b/data/reusables/actions/self-hosted-runner-configure.md @@ -12,5 +12,5 @@ The instructions walk you through completing these tasks: * Downloading and extracting the self-hosted runner application. * Running the `config` script to configure the self-hosted runner application and register it with {% data variables.product.prodname_actions %}. The `config` script requires the destination URL and an automatically-generated time-limited token to authenticate the request. The token expires after one hour. - * On Windows, the `config` script also asks if you would like to install the self-hosted runner application as a service. For Linux and macOS, you can install a service after you finish adding the runner. For more information, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/configuring-the-self-hosted-runner-application-as-a-service). + * On Windows, the `config` script also asks if you would like to install the self-hosted runner application as a service. For Linux and macOS, you can install a service after you finish adding the runner. For more information, see [AUTOTITLE](/actions/how-tos/manage-runners/self-hosted-runners/configure-the-application). * Running the self-hosted runner application to connect the machine to {% data variables.product.prodname_actions %}. diff --git a/data/reusables/actions/self-hosted-runner-networking-to-dotcom.md b/data/reusables/actions/self-hosted-runner-networking-to-dotcom.md index 0c376649cd72..8952e6528930 100644 --- a/data/reusables/actions/self-hosted-runner-networking-to-dotcom.md +++ b/data/reusables/actions/self-hosted-runner-networking-to-dotcom.md @@ -1 +1 @@ -To use actions from {% data variables.product.prodname_dotcom_the_website %},{% ifversion ghes %} both {% data variables.product.prodname_ghe_server %} and{% endif %} your self-hosted runners must be able to make outbound connections to {% data variables.product.prodname_dotcom_the_website %}. No inbound connections from {% data variables.product.prodname_dotcom_the_website %} are required. For more information. For more information, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/communicating-with-self-hosted-runners#communication-between-self-hosted-runners-and-githubcom). +To use actions from {% data variables.product.prodname_dotcom_the_website %},{% ifversion ghes %} both {% data variables.product.prodname_ghe_server %} and{% endif %} your self-hosted runners must be able to make outbound connections to {% data variables.product.prodname_dotcom_the_website %}. No inbound connections from {% data variables.product.prodname_dotcom_the_website %} are required. For more information, see [AUTOTITLE](/actions/reference/runners/self-hosted-runners#communication-between-self-hosted-runners-and-githubcom). diff --git a/data/reusables/actions/self-hosted-runner-ports-protocols.md b/data/reusables/actions/self-hosted-runner-ports-protocols.md index cc3e336f1572..983cee4b84da 100644 --- a/data/reusables/actions/self-hosted-runner-ports-protocols.md +++ b/data/reusables/actions/self-hosted-runner-ports-protocols.md @@ -1 +1 @@ -The connection between self-hosted runners and {% data variables.product.github %} is over {% ifversion ghes %}HTTP (port 80) or {% endif %}HTTPS (port 443). {% ifversion ghes %}To ensure connectivity over HTTPS, configure TLS for {% data variables.product.prodname_ghe_server %}. For more information, see [AUTOTITLE](/admin/configuration/hardening-security-for-your-enterprise/configuring-tls).{% endif %} +The connection between self-hosted runners and {% data variables.product.github %} is over {% ifversion ghes %}HTTP (port 80) or {% endif %}HTTPS (port 443). {% ifversion ghes %}To ensure connectivity over HTTPS, configure TLS for {% data variables.product.prodname_ghe_server %}. For more information, see [AUTOTITLE](/admin/configuring-settings/hardening-security-for-your-enterprise/configuring-tls).{% endif %} diff --git a/data/reusables/actions/self-hosted-runner-public-repo-access.md b/data/reusables/actions/self-hosted-runner-public-repo-access.md index 86af4df0e63d..38d8de217c20 100644 --- a/data/reusables/actions/self-hosted-runner-public-repo-access.md +++ b/data/reusables/actions/self-hosted-runner-public-repo-access.md @@ -1,2 +1,2 @@ > [!NOTE] -> For security reasons, public repositories can't use runners in a runner group by default, but you can override this in the runner group's settings. For more information, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group). +> For security reasons, public repositories can't use runners in a runner group by default, but you can override this in the runner group's settings. For more information, see [AUTOTITLE](/actions/how-tos/manage-runners/self-hosted-runners/manage-access#changing-the-access-policy-of-a-self-hosted-runner-group). diff --git a/data/reusables/actions/self-hosted-runner-reqs-docker.md b/data/reusables/actions/self-hosted-runner-reqs-docker.md index d8c8a0a90696..f7e9c1ece491 100644 --- a/data/reusables/actions/self-hosted-runner-reqs-docker.md +++ b/data/reusables/actions/self-hosted-runner-reqs-docker.md @@ -1 +1 @@ -Self-hosted runners must use a Linux operating system and have Docker installed to run Docker container actions. For more information about the requirements of self-hosted runners, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#requirements-for-self-hosted-runner-machines). +Self-hosted runners must use a Linux operating system and have Docker installed to run Docker container actions. For more information about the requirements of self-hosted runners, see [AUTOTITLE](/actions/concepts/runners/self-hosted-runners#requirements-for-self-hosted-runner-machines). diff --git a/data/reusables/actions/self-hosted-runner-security-admonition.md b/data/reusables/actions/self-hosted-runner-security-admonition.md index 234b0b521227..57387a74588b 100644 --- a/data/reusables/actions/self-hosted-runner-security-admonition.md +++ b/data/reusables/actions/self-hosted-runner-security-admonition.md @@ -1,4 +1,4 @@ > [!WARNING] > {% data reusables.actions.self-hosted-runner-security %} > -> For more information, see [AUTOTITLE](/actions/security-for-github-actions/security-guides/security-hardening-for-github-actions). +> For more information, see [AUTOTITLE](/actions/reference/security/secure-use). diff --git a/data/reusables/actions/self-hosted-runners-prerequisites.md b/data/reusables/actions/self-hosted-runners-prerequisites.md index 4c8d5270839b..589f06ae4d9f 100644 --- a/data/reusables/actions/self-hosted-runners-prerequisites.md +++ b/data/reusables/actions/self-hosted-runners-prerequisites.md @@ -1,5 +1,5 @@ {%- ifversion ghes %} -* {% data variables.product.prodname_actions %} must be enabled for {% data variables.product.prodname_ghe_server %}. A site administrator can enable and configure {% data variables.product.prodname_actions %} for your instance. 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). +* {% data variables.product.prodname_actions %} must be enabled for {% data variables.product.prodname_ghe_server %}. A site administrator can enable and configure {% data variables.product.prodname_actions %} for your instance. For more information, see [AUTOTITLE](/admin/managing-github-actions-for-your-enterprise/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server). {%- endif %} * You must have access to the machine you will use as a self-hosted runner in your environment. diff --git a/data/reusables/actions/service-container-prereqs.md b/data/reusables/actions/service-container-prereqs.md index 244a3e6a0452..b81576f7f7f9 100644 --- a/data/reusables/actions/service-container-prereqs.md +++ b/data/reusables/actions/service-container-prereqs.md @@ -1 +1 @@ -You should be familiar with how service containers work with {% data variables.product.prodname_actions %} and the networking differences between running jobs directly on the runner or in a container. For more information, see [AUTOTITLE](/actions/using-containerized-services/about-service-containers). +You should be familiar with how service containers work with {% data variables.product.prodname_actions %} and the networking differences between running jobs directly on the runner or in a container. For more information, see [AUTOTITLE](/actions/tutorials/use-containerized-services/use-docker-service-containers). diff --git a/data/reusables/actions/settings-ui/settings-actions-pages-custom-workflow.md b/data/reusables/actions/settings-ui/settings-actions-pages-custom-workflow.md index 3e39e360fded..507c12737fdc 100644 --- a/data/reusables/actions/settings-ui/settings-actions-pages-custom-workflow.md +++ b/data/reusables/actions/settings-ui/settings-actions-pages-custom-workflow.md @@ -1 +1 @@ -{% ifversion ghes %}To use {% data variables.product.prodname_actions %} as a publishing source for {% data variables.product.prodname_pages %}, a site administrator must enable {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_server %}. For more information, see [AUTOTITLE](/admin/github-actions/enabling-github-actions-for-github-enterprise-server).{% endif %} +{% ifversion ghes %}To use {% data variables.product.prodname_actions %} as a publishing source for {% data variables.product.prodname_pages %}, a site administrator must enable {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_server %}. For more information, see [AUTOTITLE](/admin/managing-github-actions-for-your-enterprise/enabling-github-actions-for-github-enterprise-server).{% endif %} diff --git a/data/reusables/actions/supported-github-runners.md b/data/reusables/actions/supported-github-runners.md index 4041204de88f..f4935d53b5bd 100644 --- a/data/reusables/actions/supported-github-runners.md +++ b/data/reusables/actions/supported-github-runners.md @@ -94,7 +94,7 @@ For public repositories, jobs using the workflow labels shown in the table below ### Standard {% data variables.product.prodname_dotcom %}-hosted runners for {% ifversion ghec %}internal and{% endif %} private repositories -For {% ifversion ghec %}internal and{% endif %} private repositories, jobs using the workflow labels shown in the table below will run on virtual machines with the associated specifications. These runners use your {% data variables.product.prodname_dotcom %} account's allotment of free minutes, and are then charged at the per minute rates. See [AUTOTITLE](/billing/reference/actions-minute-multipliers). +For {% ifversion ghec %}internal and{% endif %} private repositories, jobs using the workflow labels shown in the table below will run on virtual machines with the associated specifications. These runners use your {% data variables.product.prodname_dotcom %} account's allotment of free minutes, and are then charged at the per minute rates. See [AUTOTITLE](/billing/reference/actions-runner-pricing).
diff --git a/data/reusables/actions/third-party-actions.md b/data/reusables/actions/third-party-actions.md index 607d37b529b4..4b6f733c675c 100644 --- a/data/reusables/actions/third-party-actions.md +++ b/data/reusables/actions/third-party-actions.md @@ -1,3 +1,3 @@ > [!NOTE] > * This workflow template contains an action that is not certified by {% data variables.product.prodname_dotcom %}. Actions provided by third parties are governed by separate terms of service, privacy policy, and support documentation. -> * If you use actions from third parties you should use a version specified by a commit SHA. If the action is revised and you want to use the newer version, you will need to update the SHA. You can specify a version by referencing a tag or a branch, however the action may change without warning. For more information, see [AUTOTITLE](/actions/security-guides/security-hardening-for-github-actions#using-third-party-actions). +> * If you use actions from third parties you should use a version specified by a commit SHA. If the action is revised and you want to use the newer version, you will need to update the SHA. You can specify a version by referencing a tag or a branch, however the action may change without warning. For more information, see [AUTOTITLE](/actions/reference/security/secure-use#using-third-party-actions). From 737839c43420d4f4988a4c6fba4d368b95483748 Mon Sep 17 00:00:00 2001 From: Kevin Heis Date: Thu, 9 Jul 2026 11:30:25 -0700 Subject: [PATCH 14/15] Update redirected internal links in copilot (reference+responsible-use) (#62164) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../reference/ai-models/model-comparison.md | 10 +++---- .../reference/ai-models/supported-models.md | 8 +++--- content/copilot/reference/chat-cheat-sheet.md | 14 +++++----- .../reference/copilot-allowlist-reference.md | 6 ++-- .../copilot-billing/azure-billing.md | 2 +- .../copilot-billing/models-and-pricing.md | 2 +- .../copilot-requests.md | 20 ++++++------- .../github-copilot-premium-requests.md | 8 +++--- .../model-multipliers-for-annual-plans.md | 2 +- .../monitor-premium-requests.md | 2 +- .../copilot-billing/seat-assignment.md | 2 +- .../cli-command-reference.md | 14 +++++----- .../cli-config-dir-reference.md | 2 +- .../copilot-usage-metrics.md | 2 +- .../lines-of-code-metrics.md | 2 +- .../reference/custom-agents-configuration.md | 2 +- .../reference/custom-instructions-support.md | 6 ++-- content/copilot/reference/hooks-reference.md | 4 +-- content/copilot/reference/metrics-data.md | 2 +- content/copilot/reference/policy-conflicts.md | 28 +++++++++---------- content/copilot/responsible-use/agents.md | 22 +++++++-------- content/copilot/responsible-use/chat.md | 17 ++++++----- .../responsible-use/inline-suggestions.md | 2 +- 23 files changed, 89 insertions(+), 90 deletions(-) diff --git a/content/copilot/reference/ai-models/model-comparison.md b/content/copilot/reference/ai-models/model-comparison.md index 6839d29a5342..c254bad3b219 100644 --- a/content/copilot/reference/ai-models/model-comparison.md +++ b/content/copilot/reference/ai-models/model-comparison.md @@ -19,7 +19,7 @@ contentType: reference > [!NOTE] > * Different models consume {% data variables.product.prodname_ai_credits_short %} at different rates based on their token pricing. For details, see [AUTOTITLE](/copilot/reference/copilot-billing/models-and-pricing). -> * Choosing the **Auto** option when selecting a model automatically selects the optimum model for your task, based on model availability and task complexity. If you are on a paid {% data variables.product.prodname_copilot_short %} plan, you qualify for a discount on model costs when you use the **Auto** option. See [AUTOTITLE](/copilot/concepts/auto-model-selection). +> * Choosing the **Auto** option when selecting a model automatically selects the optimum model for your task, based on model availability and task complexity. If you are on a paid {% data variables.product.prodname_copilot_short %} plan, you qualify for a discount on model costs when you use the **Auto** option. See [AUTOTITLE](/copilot/concepts/models/auto-model-selection). ### Recommended models by task @@ -128,7 +128,7 @@ Use one of these models if you want to: * Understand front-end behavior from visual context. > [!TIP] -> If you're using a model in a context that doesn’t support image input (like a code editor), you won’t see visual reasoning benefits. You may be able to use an MCP server to get access to visual input indirectly. See [AUTOTITLE](/copilot/customizing-copilot/using-model-context-protocol/extending-copilot-chat-with-mcp). +> If you're using a model in a context that doesn’t support image input (like a code editor), you won’t see visual reasoning benefits. You may be able to use an MCP server to get access to visual input indirectly. See [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp-in-your-ide/extend-copilot-chat-with-mcp). ### When to use a different model @@ -140,7 +140,7 @@ If your task involves deep reasoning or large-scale refactoring, consider a mode Choosing the right model helps you get the most out of {% data variables.product.prodname_copilot_short %}. If you're not sure which model to use, start with a general-purpose option like {% data variables.copilot.copilot_gpt_5_mini %}, then adjust based on your needs. -* For detailed model specs and pricing, see [AUTOTITLE](/copilot/using-github-copilot/ai-models/supported-ai-models-in-copilot). -* For more examples of how to use different models, see [AUTOTITLE](/copilot/using-github-copilot/ai-models/comparing-ai-models-using-different-tasks). -* To switch between models, refer to [AUTOTITLE](/copilot/using-github-copilot/ai-models/changing-the-ai-model-for-copilot-chat) or [AUTOTITLE](/copilot/how-tos/use-ai-models/change-the-completion-model). +* For detailed model specs and pricing, see [AUTOTITLE](/copilot/reference/ai-models/supported-models). +* For more examples of how to use different models, see [AUTOTITLE](/copilot/tutorials/compare-ai-models). +* To switch between models, refer to [AUTOTITLE](/copilot/how-tos/use-ai-models/change-the-chat-model) or [AUTOTITLE](/copilot/how-tos/use-ai-models/change-the-completion-model). * To learn how {% data variables.copilot.copilot_chat_short %} serves different AI models, see [AUTOTITLE](/copilot/reference/ai-models/model-hosting). diff --git a/content/copilot/reference/ai-models/supported-models.md b/content/copilot/reference/ai-models/supported-models.md index 6f8a713cbf04..f0d9f65f8c41 100644 --- a/content/copilot/reference/ai-models/supported-models.md +++ b/content/copilot/reference/ai-models/supported-models.md @@ -48,7 +48,7 @@ This table lists the AI models available in {% data variables.product.prodname_c ## Supported AI models in {% data variables.copilot.copilot_auto_model_selection_short_cap_a %} -This table lists the supported AI models for {% data variables.copilot.copilot_auto_model_selection_short_cap_a %}. Available models may be limited by model policies. See [AUTOTITLE](/copilot/concepts/auto-model-selection). +This table lists the supported AI models for {% data variables.copilot.copilot_auto_model_selection_short_cap_a %}. Available models may be limited by model policies. See [AUTOTITLE](/copilot/concepts/models/auto-model-selection). {% rowheaders %} @@ -158,7 +158,7 @@ Some {% data variables.product.prodname_copilot_short %} models require minimum ## Supported AI models per {% data variables.product.prodname_copilot_short %} plan -The following table shows which AI models are available in each {% data variables.product.prodname_copilot_short %} plan. For more information about the plans, see [AUTOTITLE](/copilot/about-github-copilot/plans-for-github-copilot). +The following table shows which AI models are available in each {% data variables.product.prodname_copilot_short %} plan. For more information about the plans, see [AUTOTITLE](/copilot/get-started/plans). {% data reusables.copilot.available-models-per-plan %} @@ -167,7 +167,7 @@ The following table shows which AI models are available in each {% data variable ## Fallback and long-term support (LTS) models -For more information about fallback and LTS models, see [AUTOTITLE](/copilot/concepts/fallback-and-lts-models). +For more information about fallback and LTS models, see [AUTOTITLE](/copilot/concepts/models/fallback-and-lts-models). ## Evaluation models @@ -199,4 +199,4 @@ Utility models power background features across surfaces, and cannot be disabled * To get up and running with {% data variables.product.prodname_copilot_short %}, see [AUTOTITLE](/copilot/get-started/quickstart). * To configure which models are available to you, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/set-up-copilot/configure-access-to-ai-models). -* To learn more about Responsible Use and Responsible AI, see [{% data variables.product.prodname_copilot_short %} Trust Center](https://copilot.github.trust.page/) and [AUTOTITLE](/copilot/responsible-use-of-github-copilot-features). +* To learn more about Responsible Use and Responsible AI, see [{% data variables.product.prodname_copilot_short %} Trust Center](https://copilot.github.trust.page/) and [AUTOTITLE](/copilot/responsible-use). diff --git a/content/copilot/reference/chat-cheat-sheet.md b/content/copilot/reference/chat-cheat-sheet.md index 04946a44f74e..dcc88cd43793 100644 --- a/content/copilot/reference/chat-cheat-sheet.md +++ b/content/copilot/reference/chat-cheat-sheet.md @@ -20,7 +20,7 @@ This version of this article is for {% data variables.product.prodname_copilot_s {% data reusables.copilot.about-copilot-enhancements %} -For information about how to get started with {% data variables.copilot.copilot_chat_short %} in the {% data variables.product.github %} website, see [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-github). +For information about how to get started with {% data variables.copilot.copilot_chat_short %} in the {% data variables.product.github %} website, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/chat-with-copilot/chat-in-github). ## Mentions @@ -59,7 +59,7 @@ Below is a list of the MCP skills that are currently available in {% data variab | `get_me` | Tell me about myself. | | `search_users` | Search for users with the name "Mona Octocat" | -For more information about using MCP skills in {% data variables.copilot.copilot_chat_short %}, see [AUTOTITLE](/copilot/how-tos/context/model-context-protocol/using-the-github-mcp-server). +For more information about using MCP skills in {% data variables.copilot.copilot_chat_short %}, see [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp-in-your-ide/use-the-github-mcp-server). {% endwebui %} @@ -69,7 +69,7 @@ This version of this article is for {% data variables.product.prodname_copilot_s {% data reusables.copilot.about-copilot-enhancements %} -For information about how to get started with {% data variables.copilot.copilot_chat_short %} in {% data variables.product.prodname_vscode %}, see [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide). +For information about how to get started with {% data variables.copilot.copilot_chat_short %} in {% data variables.product.prodname_vscode %}, see [AUTOTITLE](/copilot/how-tos/chat-with-copilot/chat-in-ide). ## Slash commands @@ -113,7 +113,7 @@ Below is a list of some of the most common chat participants for using {% data v | Variable | Description | |--------------|----------------------------------------------------------------------------------------------| | `@azure` | Has context about Azure services and how to use, deploy and manage them. Use `@azure` when you want help with Azure. The `@azure` chat participant is currently in {% data variables.release-phases.public_preview %} and is subject to change. | -| `@github` | Allows you to use {% data variables.product.github %}-specific {% data variables.product.prodname_copilot_short %} skills. See [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide#using-github-skills-for-copilot). | +| `@github` | Allows you to use {% data variables.product.github %}-specific {% data variables.product.prodname_copilot_short %} skills. See [AUTOTITLE](/copilot/how-tos/chat-with-copilot/chat-in-ide#using-github-skills-for-copilot). | | `@terminal` | Has context about the {% data variables.product.prodname_vscode %} terminal shell and its contents. Use `@terminal` when you want help creating or debugging terminal commands. | | `@vscode` | Has context about {% data variables.product.prodname_vscode %} commands and features. Use `@vscode` when you want help with {% data variables.product.prodname_vscode %}. | | `@workspace` | Has context about the code in your workspace. Use `@workspace` when you want {% data variables.product.prodname_copilot_short %} to consider the structure of your project, how different parts of your code interact, or design patterns in your project. | @@ -126,7 +126,7 @@ This version of this article is for {% data variables.product.prodname_copilot_s {% data reusables.copilot.about-copilot-enhancements %} -For information about how to get started with {% data variables.copilot.copilot_chat_short %} in {% data variables.product.prodname_vs %}, see [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide). +For information about how to get started with {% data variables.copilot.copilot_chat_short %} in {% data variables.product.prodname_vs %}, see [AUTOTITLE](/copilot/how-tos/chat-with-copilot/chat-in-ide). ## Slash commands @@ -162,7 +162,7 @@ This version of this article is for {% data variables.product.prodname_copilot_s {% data reusables.copilot.about-copilot-enhancements %} -For information about how to get started with {% data variables.copilot.copilot_chat_short %} in JetBrains, see [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide). +For information about how to get started with {% data variables.copilot.copilot_chat_short %} in JetBrains, see [AUTOTITLE](/copilot/how-tos/chat-with-copilot/chat-in-ide). ## Slash commands @@ -190,7 +190,7 @@ This version of this article is for {% data variables.product.prodname_copilot_s {% data reusables.copilot.about-copilot-enhancements %} -For information about how to get started with {% data variables.copilot.copilot_chat_short %} in Xcode, see [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide). +For information about how to get started with {% data variables.copilot.copilot_chat_short %} in Xcode, see [AUTOTITLE](/copilot/how-tos/chat-with-copilot/chat-in-ide). ## Slash commands diff --git a/content/copilot/reference/copilot-allowlist-reference.md b/content/copilot/reference/copilot-allowlist-reference.md index 224e4899fcce..312a3690ab08 100644 --- a/content/copilot/reference/copilot-allowlist-reference.md +++ b/content/copilot/reference/copilot-allowlist-reference.md @@ -42,7 +42,7 @@ If your company employs security measures like a firewall or proxy server, you s Depending on the security policies and editors your organization uses, you may need to allowlist additional domains and URLs. For more information on specific editors, see [Further reading](#further-reading). -Every user of the proxy server or firewall also needs to configure their own environment to connect to {% data variables.product.prodname_copilot_short %}. See [AUTOTITLE](/copilot/configuring-github-copilot/configuring-network-settings-for-github-copilot). +Every user of the proxy server or firewall also needs to configure their own environment to connect to {% data variables.product.prodname_copilot_short %}. See [AUTOTITLE](/copilot/how-tos/configure-personal-settings/configure-network-settings). ## {% data variables.product.prodname_copilot_short %} voice features @@ -65,7 +65,7 @@ The {% data variables.copilot.copilot_cloud_agent %} includes a built-in firewal * Common certificate authorities (to allow SSL certificates to be validated). * Hosts used to download web browsers for the Playwright MCP server. -For more information about configuring the {% data variables.copilot.copilot_cloud_agent %} firewall, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-firewall). +For more information about configuring the {% data variables.copilot.copilot_cloud_agent %} firewall, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/customize-the-agent-firewall). The allowlist allows access to the following hosts: @@ -407,7 +407,7 @@ The allowlist allows access to the following hosts: * [Network Connections in {% data variables.product.prodname_vscode %}](https://code.visualstudio.com/docs/setup/network) in the {% data variables.product.prodname_vs %} documentation * [Install and use {% data variables.product.prodname_vs %} and Azure Services behind a firewall or proxy server](https://learn.microsoft.com/en-us/visualstudio/install/install-and-use-visual-studio-behind-a-firewall-or-proxy-server) in the Microsoft documentation -[^1]: Allows access to authorized users regardless of {% data variables.product.prodname_copilot_short %} plan. Do not add this URL to your allowlist if you are using subscription-based network routing. For more information on subscription-based network routing, see [AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise/managing-github-copilot-access-to-your-enterprises-network). +[^1]: Allows access to authorized users regardless of {% data variables.product.prodname_copilot_short %} plan. Do not add this URL to your allowlist if you are using subscription-based network routing. For more information on subscription-based network routing, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-access/manage-network-access). [^2]: Allows access to authorized users via a {% data variables.copilot.copilot_individuals_short %} plan. Do not add this URL to your allowlist if you are using subscription-based network routing. [^3]: Allows access to authorized users via a {% data variables.copilot.copilot_business_short %} plan. Do not add this URL to your allowlist if you want to use subscription-based network routing to block users from using {% data variables.copilot.copilot_business_short %} on your network. [^4]: Allows access to authorized users via a {% data variables.copilot.copilot_enterprise_short %} plan. Do not add this URL to your allowlist if you want to use subscription-based network routing to block users from using {% data variables.copilot.copilot_enterprise_short %} on your network. diff --git a/content/copilot/reference/copilot-billing/azure-billing.md b/content/copilot/reference/copilot-billing/azure-billing.md index 5a0f61f1c8ba..b9fc35fd8a76 100644 --- a/content/copilot/reference/copilot-billing/azure-billing.md +++ b/content/copilot/reference/copilot-billing/azure-billing.md @@ -21,4 +21,4 @@ You can connect an Azure subscription to your organization or enterprise account * Usage data is sent daily to Azure. * Charges for the calendar month appear on your Azure invoice at the start of the next month. -To connect your Azure subscription, see [AUTOTITLE](/billing/managing-the-plan-for-your-github-account/connecting-an-azure-subscription). +To connect your Azure subscription, see [AUTOTITLE](/billing/how-tos/set-up-payment/connect-azure-sub). diff --git a/content/copilot/reference/copilot-billing/models-and-pricing.md b/content/copilot/reference/copilot-billing/models-and-pricing.md index a6fbba3b8f06..34d56d0530e6 100644 --- a/content/copilot/reference/copilot-billing/models-and-pricing.md +++ b/content/copilot/reference/copilot-billing/models-and-pricing.md @@ -102,6 +102,6 @@ You can view your current {% data variables.product.prodname_actions %} usage fo ## Model multipliers for annual {% data variables.copilot.copilot_pro_short %} and {% data variables.copilot.copilot_pro_plus_short %} subscribers -{% data variables.copilot.copilot_pro_short %} and {% data variables.copilot.copilot_pro_plus_short %} subscribers on **existing annual billing plans** using the **request-based billing** model have different model multipliers. See [AUTOTITLE](/copilot/reference/copilot-billing/model-multipliers-for-annual-plans). +{% data variables.copilot.copilot_pro_short %} and {% data variables.copilot.copilot_pro_plus_short %} subscribers on **existing annual billing plans** using the **request-based billing** model have different model multipliers. See [AUTOTITLE](/copilot/reference/copilot-billing/request-based-billing-legacy/model-multipliers-for-annual-plans). [^sonnet-5-promo]: {% data variables.copilot.copilot_claude_sonnet_5 %} is available at the promotional pricing of $2.00 per 1M input tokens, $0.20 per 1M cached input tokens, $2.50 per 1M cache write tokens, and $10.00 per 1M output tokens through August 31, 2026. diff --git a/content/copilot/reference/copilot-billing/request-based-billing-legacy/copilot-requests.md b/content/copilot/reference/copilot-billing/request-based-billing-legacy/copilot-requests.md index dca5e98652b8..ccc7b894753d 100644 --- a/content/copilot/reference/copilot-billing/request-based-billing-legacy/copilot-requests.md +++ b/content/copilot/reference/copilot-billing/request-based-billing-legacy/copilot-requests.md @@ -40,12 +40,12 @@ The following {% data variables.product.prodname_copilot_short %} features can u | Feature | Premium request consumption | SKU Attribution | | ------- | ----------- | ----------- | -| [{% data variables.copilot.copilot_chat_short %}](/copilot/using-github-copilot/copilot-chat) | {% data variables.copilot.copilot_chat_short %} uses **one premium request** per user prompt, multiplied by the model's rate. This includes ask, edit, agent, and plan modes in {% data variables.copilot.copilot_chat_short %} in an IDE. | {% data variables.product.prodname_copilot_short %} premium requests | -| [{% data variables.copilot.copilot_cli_short %}](/copilot/concepts/agents/about-copilot-cli) | Each prompt to {% data variables.copilot.copilot_cli_short %} uses **one premium request** with the default model. For other models, this is multiplied by the model's rate. | {% data variables.product.prodname_copilot_short %} premium requests | -| [{% data variables.product.prodname_copilot_short %} code review](/copilot/using-github-copilot/code-review/using-copilot-code-review) | Each time {% data variables.product.prodname_copilot_short %} reviews a pull request (when assigned as a reviewer) or reviews code in your IDE, **13 premium requests** are consumed. | {% data variables.product.prodname_copilot_short %} premium requests | +| [{% data variables.copilot.copilot_chat_short %}](/copilot/how-tos/chat-with-copilot) | {% data variables.copilot.copilot_chat_short %} uses **one premium request** per user prompt, multiplied by the model's rate. This includes ask, edit, agent, and plan modes in {% data variables.copilot.copilot_chat_short %} in an IDE. | {% data variables.product.prodname_copilot_short %} premium requests | +| [{% data variables.copilot.copilot_cli_short %}](/copilot/concepts/agents/copilot-cli/about-copilot-cli) | Each prompt to {% data variables.copilot.copilot_cli_short %} uses **one premium request** with the default model. For other models, this is multiplied by the model's rate. | {% data variables.product.prodname_copilot_short %} premium requests | +| [{% data variables.product.prodname_copilot_short %} code review](/copilot/how-tos/use-copilot-agents/request-a-code-review/use-code-review) | Each time {% data variables.product.prodname_copilot_short %} reviews a pull request (when assigned as a reviewer) or reviews code in your IDE, **13 premium requests** are consumed. | {% data variables.product.prodname_copilot_short %} premium requests | | [{% data variables.copilot.copilot_cloud_agent %}](/copilot/concepts/agents/cloud-agent/about-cloud-agent) | {% data variables.copilot.copilot_cloud_agent %} uses **one premium request** per session, multiplied by the model's rate. A session begins when you prompt {% data variables.product.prodname_copilot_short %} to undertake a task. In addition, each real-time steering comment made during an active session uses **one premium request** per session, multiplied by the model's rate. | {% data variables.copilot.copilot_cloud_agent %} premium requests | -| [{% data variables.copilot.copilot_spaces %}](/copilot/using-github-copilot/copilot-spaces/about-organizing-and-sharing-context-with-copilot-spaces) | {% data variables.copilot.copilot_spaces %} uses **one premium request** per user prompt, multiplied by the model's rate. | {% data variables.product.prodname_copilot_short %} premium requests | -| [{% data variables.product.prodname_spark_short %}](/copilot/tutorials/building-ai-app-prototypes) | Each prompt to {% data variables.product.prodname_spark_short %} uses a fixed rate of **four premium requests**. | {% data variables.product.prodname_spark_short %} premium requests | +| [{% data variables.copilot.copilot_spaces %}](/copilot/concepts/context/spaces) | {% data variables.copilot.copilot_spaces %} uses **one premium request** per user prompt, multiplied by the model's rate. | {% data variables.product.prodname_copilot_short %} premium requests | +| [{% data variables.product.prodname_spark_short %}](/copilot/tutorials/spark/build-apps-with-spark) | Each prompt to {% data variables.product.prodname_spark_short %} uses a fixed rate of **four premium requests**. | {% data variables.product.prodname_spark_short %} premium requests | | [{% data variables.product.prodname_openai_codex %} {% data variables.product.prodname_vscode %} integration](/copilot/concepts/agents/openai-codex) | While in preview, each prompt to {% data variables.product.prodname_openai_codex %} uses **one premium request** multiplied by the model multiplier rates. | {% data variables.product.prodname_copilot_short %} premium requests | | [Third-party coding agents](/free-pro-team@latest/copilot/concepts/agents/about-third-party-coding-agents) | While in preview, each prompt to a third-party coding agent uses **one premium request**, multiplied by the model's rate. | {% data variables.product.prodname_copilot_short %} premium requests | @@ -55,14 +55,14 @@ The following {% data variables.product.prodname_copilot_short %} features can u > {% data reusables.billing.pru-sku-split-notice %} > [!TIP] -> For instructions on viewing how many premium requests you have used and advice on how to optimize usage, see [AUTOTITLE](/copilot/how-tos/manage-and-track-spending/monitor-premium-requests). +> For instructions on viewing how many premium requests you have used and advice on how to optimize usage, see [AUTOTITLE](/copilot/reference/copilot-billing/request-based-billing-legacy/monitor-premium-requests). ## How do request allowances work per plan? > [!NOTE] > Billing for premium requests began on June 18, 2025, for all paid {% data variables.product.prodname_copilot_short %} plans on {% data variables.product.prodname_dotcom_the_website %}, and on August 1, 2025, on {% data variables.enterprise.data_residency_site %}. The request counters were only set to zero for paid plans. -If you're on a **paid plan**, you get unlimited inline suggestions. Rate limiting is in place to accommodate for high demand. See [AUTOTITLE](/copilot/concepts/rate-limits). +If you're on a **paid plan**, you get unlimited inline suggestions. Rate limiting is in place to accommodate for high demand. See [AUTOTITLE](/copilot/concepts/usage-limits). Paid plans also receive a monthly allowance of premium requests, which can be used for advanced chat interactions, inline suggestions using premium models, and other premium features. @@ -78,7 +78,7 @@ Paid plans also receive a monthly allowance of premium requests, which can be us ## What happens to unused requests at the end of the month? -Unused requests for the previous month do not carry over to the following month. Premium request counters reset on the 1st of each month at 00:00:00 UTC. See [AUTOTITLE](/copilot/managing-copilot/understanding-and-managing-copilot-usage/monitoring-your-copilot-usage-and-entitlements). +Unused requests for the previous month do not carry over to the following month. Premium request counters reset on the 1st of each month at 00:00:00 UTC. See [AUTOTITLE](/copilot/reference/copilot-billing/request-based-billing-legacy/monitor-premium-requests). ## What if I run out of premium requests? @@ -87,9 +87,9 @@ Unused requests for the previous month do not carry over to the following month. > > * Users who subscribe, or have subscribed, to {% data variables.copilot.copilot_pro_short %} or {% data variables.copilot.copilot_pro_plus_short %} through {% data variables.product.prodname_mobile %} on iOS or Android. -If you use all of your premium requests, you can still use {% data variables.product.prodname_copilot_short %} with one of the included models for the rest of the month. This is subject to change. Response times for the included models may vary during periods of high usage. Requests to the included models may be subject to rate limiting. See [AUTOTITLE](/copilot/concepts/rate-limits). +If you use all of your premium requests, you can still use {% data variables.product.prodname_copilot_short %} with one of the included models for the rest of the month. This is subject to change. Response times for the included models may vary during periods of high usage. Requests to the included models may be subject to rate limiting. See [AUTOTITLE](/copilot/concepts/usage-limits). -If you need more premium requests beyond your monthly allowance set a budget for additional premium requests or upgrade to a higher plan. See [AUTOTITLE](/billing/managing-your-billing/using-budgets-control-spending). +If you need more premium requests beyond your monthly allowance set a budget for additional premium requests or upgrade to a higher plan. See [AUTOTITLE](/billing/how-tos/set-up-budgets). ## Model multipliers diff --git a/content/copilot/reference/copilot-billing/request-based-billing-legacy/github-copilot-premium-requests.md b/content/copilot/reference/copilot-billing/request-based-billing-legacy/github-copilot-premium-requests.md index bd9c6b94f928..0497a9f5da86 100644 --- a/content/copilot/reference/copilot-billing/request-based-billing-legacy/github-copilot-premium-requests.md +++ b/content/copilot/reference/copilot-billing/request-based-billing-legacy/github-copilot-premium-requests.md @@ -34,7 +34,7 @@ Each product's premium request usage is attributed to a premium request SKU: * **{% data variables.product.prodname_spark_short %} premium requests** - {% data variables.product.prodname_spark_short %} app creation * **{% data variables.copilot.copilot_cloud_agent %} premium requests** - {% data variables.copilot.copilot_cloud_agent %} sessions -See [AUTOTITLE](/copilot/concepts/billing/copilot-requests) for details on which models and features consume premium requests and their SKU attribution. +See [AUTOTITLE](/copilot/reference/copilot-billing/request-based-billing-legacy/copilot-requests) for details on which models and features consume premium requests and their SKU attribution. > [!NOTE] > {% data reusables.billing.pru-sku-split-notice %} @@ -60,7 +60,7 @@ Usage of premium requests is tracked monthly and is based on the following facto When you use {% data variables.copilot.copilot_cloud_agent %}, including any {% data variables.copilot.copilot_custom_agents %}, both **{% data variables.product.prodname_actions %} minutes** and **premium requests** are consumed: -* **{% data variables.product.prodname_actions %} minutes** come from your account’s monthly allowance of free minutes for {% data variables.product.github %}-hosted runners. This allowance is shared with all {% data variables.product.prodname_actions %} workflows. See [AUTOTITLE](/billing/managing-billing-for-github-actions/about-billing-for-github-actions#included-storage-and-minutes). +* **{% data variables.product.prodname_actions %} minutes** come from your account’s monthly allowance of free minutes for {% data variables.product.github %}-hosted runners. This allowance is shared with all {% data variables.product.prodname_actions %} workflows. See [AUTOTITLE](/billing/concepts/product-billing/github-actions#included-storage-and-minutes). * **Premium requests** come from the monthly allowance associated with your {% data variables.product.prodname_copilot_short %} license. This allowance is shared with other features, such as {% data variables.copilot.copilot_chat_short %}. Each cloud agent **session** consumes one premium request. A session begins when you: @@ -82,7 +82,7 @@ If you exceed your allowance, set a budget for additional premium requests or up Additional usage is charged to the payment method configured for your {% data variables.product.github %} account. -If you are billed through Azure, premium request usage appears on your Azure invoice. See [AUTOTITLE](/billing/managing-the-plan-for-your-github-account/connecting-an-azure-subscription). +If you are billed through Azure, premium request usage appears on your Azure invoice. See [AUTOTITLE](/billing/how-tos/set-up-payment/connect-azure-sub). ## Managing your budget for premium requests @@ -97,4 +97,4 @@ You can set a budget in your personal billing settings to receive alerts when yo * Usage reports show all premium requests, both within and beyond the allowance, and can be used to identify high-usage users. * Premium request analytics display usage by dedicated SKUs, providing detailed insights into which AI products consume your allowance. -For more information about monitoring your usage, see [AUTOTITLE](/copilot/how-tos/manage-and-track-spending/monitor-premium-requests). +For more information about monitoring your usage, see [AUTOTITLE](/copilot/reference/copilot-billing/request-based-billing-legacy/monitor-premium-requests). diff --git a/content/copilot/reference/copilot-billing/request-based-billing-legacy/model-multipliers-for-annual-plans.md b/content/copilot/reference/copilot-billing/request-based-billing-legacy/model-multipliers-for-annual-plans.md index 10882bd0168e..d19fb18537df 100644 --- a/content/copilot/reference/copilot-billing/request-based-billing-legacy/model-multipliers-for-annual-plans.md +++ b/content/copilot/reference/copilot-billing/request-based-billing-legacy/model-multipliers-for-annual-plans.md @@ -51,5 +51,5 @@ The following table shows the model multipliers per supported model. ## Further reading -* To learn more about premium requests, see [AUTOTITLE](/copilot/managing-copilot/monitoring-usage-and-entitlements/about-premium-requests). +* To learn more about premium requests, see [AUTOTITLE](/copilot/reference/copilot-billing/request-based-billing-legacy/copilot-requests). * To understand more about how the new usage-based billing model works, see [AUTOTITLE](/copilot/concepts/billing/usage-based-billing-for-individuals). diff --git a/content/copilot/reference/copilot-billing/request-based-billing-legacy/monitor-premium-requests.md b/content/copilot/reference/copilot-billing/request-based-billing-legacy/monitor-premium-requests.md index 1f026425596e..8292fdf133fd 100644 --- a/content/copilot/reference/copilot-billing/request-based-billing-legacy/monitor-premium-requests.md +++ b/content/copilot/reference/copilot-billing/request-based-billing-legacy/monitor-premium-requests.md @@ -73,7 +73,7 @@ You can use the following strategies to maximize the value of your premium reque * **Choose the right model for the task**. Some models are better suited to different tasks. If you're using a premium request, you can strategically choose which model you use to get the best result from {% data variables.product.prodname_copilot_short %}. See [AUTOTITLE](/copilot/reference/ai-models/model-comparison). -* **Setting a budget**. Set a budget to track your overages and receive alerts when you reach 75%, 90%, or 100% of your budget. See [AUTOTITLE](/billing/managing-your-billing/preventing-overspending#managing-budgets-for-your-personal-account). +* **Setting a budget**. Set a budget to track your overages and receive alerts when you reach 75%, 90%, or 100% of your budget. See [AUTOTITLE](/billing/how-tos/set-up-budgets#managing-budgets-for-your-personal-account). * **Monitor your usage regularly**. Check your usage in your {% data variables.product.github %} account settings to see how many premium requests you’ve used. This helps you plan how much you can use for the rest of the month. diff --git a/content/copilot/reference/copilot-billing/seat-assignment.md b/content/copilot/reference/copilot-billing/seat-assignment.md index 5c1df5764447..610a21224a74 100644 --- a/content/copilot/reference/copilot-billing/seat-assignment.md +++ b/content/copilot/reference/copilot-billing/seat-assignment.md @@ -19,7 +19,7 @@ Users must be assigned a seat to access {% data variables.product.prodname_copil ## Seat assignment management -* **Who assigns seats:** Organization owners. Seats are assigned to specific user accounts. See [AUTOTITLE](/copilot/how-tos/administer/organizations/managing-access-to-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization). +* **Who assigns seats:** Organization owners. Seats are assigned to specific user accounts. See [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/manage-access/grant-access). * **Where:** Seat assignment can be managed in the {% data variables.product.github %} organization settings or via the REST API. * **If all assigned seats are removed, the organization's {% data variables.product.prodname_copilot_short %} plan is canceled.** * **If a user with an active {% data variables.copilot.copilot_pro_short %}, {% data variables.copilot.copilot_pro_plus_short %}, or {% data variables.copilot.copilot_max_short %} plan is assigned a seat in a {% data variables.copilot.copilot_business_short %} or {% data variables.copilot.copilot_enterprise_short %} plan**, their personal plan is automatically canceled, and a prorated refund for any remaining portion of their personal billing cycle is issued. The user will now use {% data variables.product.prodname_copilot_short %} under the organization's policies. diff --git a/content/copilot/reference/copilot-cli-reference/cli-command-reference.md b/content/copilot/reference/copilot-cli-reference/cli-command-reference.md index c5437c5418c0..c6c8f8e33ba1 100644 --- a/content/copilot/reference/copilot-cli-reference/cli-command-reference.md +++ b/content/copilot/reference/copilot-cli-reference/cli-command-reference.md @@ -229,7 +229,7 @@ When diff mode is open (entered via `/diff`): | `/logout` | Log out of {% data variables.product.prodname_copilot_short %}. | | `/lsp [show\|test\|reload\|help] [SERVER-NAME]` | Manage the language server configuration. | | `/mcp [show\|add\|edit\|delete\|disable\|enable\|auth\|reload\|search] [SERVER-NAME]` | Manage the MCP server configuration. See [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-copilot/add-mcp-servers#managing-mcp-servers). | -| `/model`, `/models [MODEL]` | Select the AI model you want to use, or choose **Auto**. See [AUTOTITLE](/copilot/concepts/auto-model-selection). | +| `/model`, `/models [MODEL]` | Select the AI model you want to use, or choose **Auto**. See [AUTOTITLE](/copilot/concepts/models/auto-model-selection). | | `/permissions [show\|reset]` | View or clear in-memory tool and path approvals for the current session. | | `/plan [PROMPT]` | Create an implementation plan before coding. | | `/plugin [marketplace\|install\|uninstall\|update\|list] [ARGS...]` | Manage plugins and plugin marketplaces. See [AUTOTITLE](/copilot/concepts/agents/about-plugins). | @@ -248,7 +248,7 @@ When diff mode is open (entered via `/diff`): | `/session [info\|checkpoints [n]\|files\|plan\|rename [NAME]\|cleanup\|prune\|delete [ID]\|delete-all]`, `/sessions [info\|checkpoints [n]\|files\|plan\|rename [NAME]\|cleanup\|prune\|delete [ID]\|delete-all]` | Show session information and manage sessions. The `info` subcommand shows session details including the session link (when available). Subcommands: `info`, `checkpoints`, `files`, `plan`, `rename`, `cleanup`, `prune`, `delete`, `delete-all`. | | `/settings [show KEY\|KEY\|KEY VALUE]`,
`/config [show KEY\|KEY\|KEY VALUE]` | Open the settings editor, open it focused on a specific setting (`KEY`), set a setting inline (`KEY VALUE`), or display a setting's current value (`show KEY`). See [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-copilot/change-settings). | | `/share [file\|html\|gist] [session\|research] [PATH]`, `/export [file\|html\|gist] [session\|research] [PATH]` | Share the session to a Markdown file, interactive HTML file, or {% data variables.product.github %} gist. | -| `/skills [list\|info\|add\|remove\|reload] [ARGS...]` | Manage skills for enhanced capabilities. See [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-copilot/create-skills). | +| `/skills [list\|info\|add\|remove\|reload] [ARGS...]` | Manage skills for enhanced capabilities. See [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-copilot/add-skills). | | `/statusline`, `/footer` | Configure which items appear in the status line. | | `/subagents`, `/agents` | Configure default and per-agent subagent models. See [AUTOTITLE](/copilot/reference/copilot-cli-reference/cli-config-dir-reference#configuration-file-settings). | | `/tasks` | View and manage tasks (subagents and shell commands). | @@ -279,12 +279,12 @@ For a complete list of available slash commands enter `/help` in the CLI's inter | `--allow-all-paths` | Disable file path verification and allow access to any path. | | `--allow-all-tools` | Allow all tools to run automatically without confirmation. Required when using the CLI programmatically (env: `COPILOT_ALLOW_ALL`). | | `--allow-all-urls` | Allow access to all URLs without confirmation. | -| `--allow-tool=TOOL ...` | Tools the CLI has permission to use. Will not prompt for permission. For multiple tools, use a quoted, comma-separated list. See [AUTOTITLE](/copilot/how-tos/copilot-cli/allowing-tools#allowing-or-denying-permission-for-specific-tools). | +| `--allow-tool=TOOL ...` | Tools the CLI has permission to use. Will not prompt for permission. For multiple tools, use a quoted, comma-separated list. See [AUTOTITLE](/copilot/how-tos/copilot-cli/use-copilot-cli/allowing-tools#allowing-or-denying-permission-for-specific-tools). | | `--allow-url=URL ...` | Allow access to specific URLs or domains. For multiple URLs, use a quoted, comma-separated list. | | `--acp` | Start as Agent Client Protocol server. | | `--attachment PATH` | Attach a file to the initial prompt (can be used multiple times). Image files are accepted, but sending them successfully requires the selected model and organization policy to allow vision input. | | `--autopilot` | Enable autopilot continuation—the agent keeps working until `task_complete` is called, then returns to interactive mode. See [AUTOTITLE](/copilot/concepts/agents/copilot-cli/autopilot). | -| `--available-tools=TOOL ...` | Only these tools will be available to the model. For multiple tools, use a quoted, comma-separated list. See [AUTOTITLE](/copilot/how-tos/copilot-cli/allowing-tools). | +| `--available-tools=TOOL ...` | Only these tools will be available to the model. For multiple tools, use a quoted, comma-separated list. See [AUTOTITLE](/copilot/how-tos/copilot-cli/use-copilot-cli/allowing-tools). | | `--banner`, `--no-banner` | Show or hide the startup banner. | | `--bash-env` | Enable `BASH_ENV` support for bash shells. | | `-C DIRECTORY` | Change working directory before doing anything else. | @@ -311,7 +311,7 @@ For a complete list of available slash commands enter `/help` in the CLI's inter | `--log-level=LEVEL` | Set the log level (choices: `none`, `error`, `warning`, `info`, `debug`, `all`, `default`). | | `--max-autopilot-continues=COUNT` | Maximum number of continuation messages in autopilot mode (default: unlimited). See [AUTOTITLE](/copilot/concepts/agents/copilot-cli/autopilot). | | `--mode=MODE` | Set the initial agent mode (choices: `interactive`, `plan`, `autopilot`). Cannot be combined with `--autopilot` or `--plan`. | -| `--model=MODEL` | Set the AI model you want to use. Pass `auto` as the value to let {% data variables.product.prodname_copilot_short %} pick the best available model automatically. See [AUTOTITLE](/copilot/concepts/auto-model-selection). | +| `--model=MODEL` | Set the AI model you want to use. Pass `auto` as the value to let {% data variables.product.prodname_copilot_short %} pick the best available model automatically. See [AUTOTITLE](/copilot/concepts/models/auto-model-selection). | | `--mouse[=VALUE]` | Enable or disable mouse support in the interactive interface. VALUE can be `on` (default) or `off`. When enabled, the CLI captures mouse events—scroll wheel, clicks, and so on—to navigate its own interface, such as scrolling the timeline or clicking tabs. When disabled, the terminal's native mouse behavior, such as text selection and scrollback, is preserved. When you set this option explicitly, the value is persisted to your configuration file. | | `-n NAME`, `--name=NAME` | Set a name for the new session. Used by `--resume` and `/resume` to find sessions by name. | | `--no-ask-user` | Disable the `ask_user` tool (the agent works autonomously without asking questions). | @@ -504,7 +504,7 @@ The CLI looks for the `copilot-instructions.md` file on startup, and if it's mis If you don't want to create this file, you can permanently hide this startup message for the current repository by using the `/init suppress` slash command. -For more information, see [AUTOTITLE](/copilot/how-tos/configure-custom-instructions/add-repository-instructions). +For more information, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-repository-instructions). ## Hooks reference @@ -699,7 +699,7 @@ MCP servers from different sources are merged in priority order (highest first). 1. `~/.copilot/mcp-config.json` (lowest) > [!NOTE] -> Workspace MCP servers (`.mcp.json` and `.github/mcp.json`) are loaded in both interactive and SDK server-mode sessions, provided the working directory is trusted. For more information about folder trust, see [AUTOTITLE](/copilot/how-tos/copilot-cli/allowing-tools). +> Workspace MCP servers (`.mcp.json` and `.github/mcp.json`) are loaded in both interactive and SDK server-mode sessions, provided the working directory is trusted. For more information about folder trust, see [AUTOTITLE](/copilot/how-tos/copilot-cli/use-copilot-cli/allowing-tools). ### Enterprise MCP allowlist diff --git a/content/copilot/reference/copilot-cli-reference/cli-config-dir-reference.md b/content/copilot/reference/copilot-cli-reference/cli-config-dir-reference.md index 1cde94f48e13..cf1e4090b0fc 100644 --- a/content/copilot/reference/copilot-cli-reference/cli-config-dir-reference.md +++ b/content/copilot/reference/copilot-cli-reference/cli-config-dir-reference.md @@ -69,7 +69,7 @@ For the full list of settings and how they interact with repository-level config Personal custom instructions that apply to all your sessions, regardless of which project you're working in. This file works the same way as a repository-level `copilot-instructions.md` but applies globally. -For more information, see [AUTOTITLE](/copilot/how-tos/configure-custom-instructions/add-repository-instructions). +For more information, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-repository-instructions). ### `instructions/` diff --git a/content/copilot/reference/copilot-usage-metrics/copilot-usage-metrics.md b/content/copilot/reference/copilot-usage-metrics/copilot-usage-metrics.md index 1c374907edf8..112c0bfcb2ba 100644 --- a/content/copilot/reference/copilot-usage-metrics/copilot-usage-metrics.md +++ b/content/copilot/reference/copilot-usage-metrics/copilot-usage-metrics.md @@ -20,7 +20,7 @@ The {% data variables.product.prodname_copilot_short %} usage metrics dashboard * The {% data variables.product.prodname_copilot_short %} usage metrics APIs return reports scoped to the **enterprise**, **organization**, or **individual user** level, in different shapes depending on scope and granularity. * Team-level metrics are not pre-aggregated; you construct them by joining the user-teams report with the per-user usage metrics report. See [AUTOTITLE](/copilot/reference/copilot-usage-metrics/team-level-metrics). -For guidance on how to read and interpret these metrics, see [AUTOTITLE](/copilot/concepts/copilot-metrics). +For guidance on how to read and interpret these metrics, see [AUTOTITLE](/copilot/concepts/copilot-usage-metrics/copilot-metrics). ## {% data variables.product.prodname_copilot_short %} usage dashboard metrics diff --git a/content/copilot/reference/copilot-usage-metrics/lines-of-code-metrics.md b/content/copilot/reference/copilot-usage-metrics/lines-of-code-metrics.md index 9ded9e5a833b..a77135f33297 100644 --- a/content/copilot/reference/copilot-usage-metrics/lines-of-code-metrics.md +++ b/content/copilot/reference/copilot-usage-metrics/lines-of-code-metrics.md @@ -22,7 +22,7 @@ Lines of Code (LoC) metrics provide a directional measure of {% data variables.p You may encounter LoC metrics in: -* **Code generation dashboard (enterprise and organization level)** — visualizes LoC-based user and agent activity. See [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/view-code-generation). +* **Code generation dashboard (enterprise and organization level)** — visualizes LoC-based user and agent activity. See [AUTOTITLE](/copilot/how-tos/administer-copilot/view-code-generation). * **Exports and APIs (enterprise, organization, and user level)** — expose LoC fields such as `loc_suggested_to_add_sum`, `loc_added_sum`, and `loc_deleted_sum`. See [AUTOTITLE](/rest/copilot/copilot-usage-metrics). * **"Data available in {% data variables.product.prodname_copilot_short %} usage metrics" reference** — lists all dashboard and API fields derived from LoC. See [AUTOTITLE](/copilot/reference/copilot-usage-metrics/copilot-usage-metrics). diff --git a/content/copilot/reference/custom-agents-configuration.md b/content/copilot/reference/custom-agents-configuration.md index cd15b620b03e..227af01494eb 100644 --- a/content/copilot/reference/custom-agents-configuration.md +++ b/content/copilot/reference/custom-agents-configuration.md @@ -9,7 +9,7 @@ category: - Configure Copilot --- -This reference article provides detailed configuration information for {% data variables.copilot.custom_agents_short %}. For general information about creating {% data variables.copilot.custom_agents_short %}, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-custom-agents). +This reference article provides detailed configuration information for {% data variables.copilot.custom_agents_short %}. For general information about creating {% data variables.copilot.custom_agents_short %}, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/create-custom-agents). {% data reusables.copilot.custom-agents-ide-preview %} diff --git a/content/copilot/reference/custom-instructions-support.md b/content/copilot/reference/custom-instructions-support.md index d6fc2908f876..33a2d9896054 100644 --- a/content/copilot/reference/custom-instructions-support.md +++ b/content/copilot/reference/custom-instructions-support.md @@ -268,6 +268,6 @@ The editor lets you work with workspace customizations for the current project o ## Further reading -* [AUTOTITLE](/copilot/how-tos/configure-custom-instructions/add-repository-instructions) -* [AUTOTITLE](/copilot/how-tos/configure-custom-instructions/add-personal-instructions) -* [AUTOTITLE](/copilot/how-tos/configure-custom-instructions/add-organization-instructions) +* [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-repository-instructions) +* [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-personal-instructions) +* [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-organization-instructions) diff --git a/content/copilot/reference/hooks-reference.md b/content/copilot/reference/hooks-reference.md index 9089411e6dbc..d6c9ee922ca2 100644 --- a/content/copilot/reference/hooks-reference.md +++ b/content/copilot/reference/hooks-reference.md @@ -761,7 +761,7 @@ Behavior depends on where you set the flag: ## Further reading -* [AUTOTITLE](/copilot/how-tos/copilot-cli/use-hooks) -* [AUTOTITLE](/copilot/reference/hooks-configuration) +* [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-copilot/use-hooks) +* [AUTOTITLE](/copilot/reference/hooks-reference) * [AUTOTITLE](/copilot/reference/copilot-cli-reference/cli-command-reference) * [AUTOTITLE](/copilot/concepts/agents/cloud-agent) diff --git a/content/copilot/reference/metrics-data.md b/content/copilot/reference/metrics-data.md index 9943a3b092f7..2b2feba2a652 100644 --- a/content/copilot/reference/metrics-data.md +++ b/content/copilot/reference/metrics-data.md @@ -20,7 +20,7 @@ The timestamp of a user's most recent interaction with {% data variables.product This property is consistent across the following surfaces: -* The CSV report downloaded from the "Access management" page (see [AUTOTITLE](/copilot/how-tos/administer/organizations/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)) +* The CSV report downloaded from the "Access management" page (see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/review-activity/review-user-activity-data)) * The [AUTOTITLE](/rest/copilot/copilot-user-management) ### Calculation diff --git a/content/copilot/reference/policy-conflicts.md b/content/copilot/reference/policy-conflicts.md index a4bd3d98a11e..5928f9f2fb39 100644 --- a/content/copilot/reference/policy-conflicts.md +++ b/content/copilot/reference/policy-conflicts.md @@ -37,21 +37,21 @@ Feature, model, and privacy settings for users are set according to the **least | {% data variables.product.prodname_copilot_short %} Metrics API | Most restrictive organization | {% ifversion ghec %}[AUTOTITLE](/rest/copilot/copilot-usage-metrics){% else %}Not applicable{% endif %} | | Semantic indexing for non-GitHub repositories | Most restrictive organization (only available when all organizations explicitly set **Enabled**; **Unconfigured** behaves as disabled) | [AUTOTITLE](/copilot/concepts/context/repository-indexing) | | Suggestions matching public code (privacy policy) | Most restrictive organization | [AUTOTITLE](/copilot/concepts/completions/code-suggestions) | -| Allow members without a {% data variables.product.prodname_copilot_short %} license to use {% data variables.copilot.copilot_code-review_short %} in {% data variables.product.prodname_dotcom_the_website %} | Most restrictive organization | [AUTOTITLE](/copilot/responsible-use/code-review) | -| {% data variables.product.prodname_copilot_short %} can search the web | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use/chat-in-github#leveraging-a-web-search-to-answer-a-question) | -| {% data variables.copilot.copilot_mobile_short %} | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use/chat-in-github-mobile) | -| {% data variables.copilot.copilot_chat_short %} in the IDE | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use/chat-in-your-ide) | -| {% data variables.copilot.copilot_chat_short %} agent mode in the IDE | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use/chat-in-your-ide) | -| {% data variables.copilot.copilot_code-review_short %} | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use/code-review) | -| {% data variables.copilot.copilot_cloud_agent %} | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use/copilot-cloud-agent) | -| {% data variables.product.prodname_spark_short %} | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use/spark) | -| {% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_dotcom_the_website %} | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use/chat-in-github) | -| {% data variables.copilot.copilot_desktop_short %} | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use/copilot-in-github-desktop) | -| {% data variables.copilot.copilot_cli_short %} | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use/copilot-cli) | +| Allow members without a {% data variables.product.prodname_copilot_short %} license to use {% data variables.copilot.copilot_code-review_short %} in {% data variables.product.prodname_dotcom_the_website %} | Most restrictive organization | [AUTOTITLE](/copilot/responsible-use/agents) | +| {% data variables.product.prodname_copilot_short %} can search the web | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use/chat#leveraging-a-web-search-to-answer-a-question) | +| {% data variables.copilot.copilot_mobile_short %} | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use/chat) | +| {% data variables.copilot.copilot_chat_short %} in the IDE | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use/chat) | +| {% data variables.copilot.copilot_chat_short %} agent mode in the IDE | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use/chat) | +| {% data variables.copilot.copilot_code-review_short %} | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use/agents) | +| {% data variables.copilot.copilot_cloud_agent %} | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use/agents) | +| {% data variables.product.prodname_spark_short %} | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use/agents) | +| {% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_dotcom_the_website %} | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use/chat) | +| {% data variables.copilot.copilot_desktop_short %} | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use/chat) | +| {% data variables.copilot.copilot_cli_short %} | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use/agents) | | Editor preview features | Least restrictive organization | [AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-pre-release-license-terms) | | {% data variables.product.prodname_github_models %}, one policy per model | Least restrictive organization | [AUTOTITLE](/github-models/github-models-at-scale/manage-models-at-scale) | | MCP servers in {% data variables.product.prodname_copilot_short %} | Least restrictive organization | [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/configure-mcp-servers) | -| {% data variables.product.prodname_copilot_short %}-generated commit messages | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use/copilot-commit-message-generation) | +| {% data variables.product.prodname_copilot_short %}-generated commit messages | Least restrictive organization | [AUTOTITLE](/copilot/responsible-use/chat) | ## Availability for members with {% data variables.product.prodname_copilot_short %} from multiple enterprises @@ -62,5 +62,5 @@ If a user receives a license from multiple different enterprises, the **most res ## Next steps -* [AUTOTITLE](/copilot/how-tos/administer/organizations/managing-policies-for-copilot-in-your-organization) -* [AUTOTITLE](/copilot/how-tos/administer/enterprises/managing-policies-and-features-for-copilot-in-your-enterprise) +* [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/manage-policies) +* [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-enterprise-policies) diff --git a/content/copilot/responsible-use/agents.md b/content/copilot/responsible-use/agents.md index 49cb31a485f7..f2bef535f42e 100644 --- a/content/copilot/responsible-use/agents.md +++ b/content/copilot/responsible-use/agents.md @@ -247,7 +247,7 @@ Copilot agentic features have been subject to RAI red teaming to identify and ad * **Permission prompts for file modifications**: Copilot CLI asks for permission before modifying files. You should ensure it is modifying the correct files before granting permission. * **Permission prompts for command execution**: Copilot CLI asks for permission before executing commands that may be dangerous. You should review these commands carefully before giving permission to run. * **Configurable permissions**: You can grant Copilot CLI specific permissions, or all permissions, by using the various command line options: for example, `--allow-tool=[TOOLS...]`, `--allow-all-tools`, `--allow-all` (or its slash command equivalent `/allow-all` for use in an interactive session). For more information, see [AUTOTITLE](/copilot/reference/copilot-cli-reference/cli-command-reference#command-line-options). Typically, when you use Copilot CLI in autopilot mode, you will grant it full permissions to allow it to complete a task autonomously, without requiring you to approve activity as it works on the task. For more information, see [AUTOTITLE](/copilot/concepts/agents/copilot-cli/autopilot). -* **Security considerations**: For more information about security practices while using Copilot CLI, see [AUTOTITLE](/copilot/concepts/agents/about-copilot-cli#security-considerations). +* **Security considerations**: For more information about security practices while using Copilot CLI, see [AUTOTITLE](/copilot/concepts/agents/copilot-cli/about-copilot-cli#security-considerations). ### Copilot SDK @@ -337,18 +337,18 @@ Responsible AI is a shared commitment between GitHub and its customers. While Gi For additional guidance on the responsible use of Copilot agentic features, we recommend reviewing the following documentation: -* [AUTOTITLE](/copilot/using-github-copilot/code-review/using-copilot-code-review) -* [AUTOTITLE](/copilot/tutorials/coding-agent/best-practices) -* [AUTOTITLE](/copilot/customizing-copilot/customizing-the-development-environment-for-copilot-coding-agent) -* [AUTOTITLE](/copilot/customizing-copilot/customizing-or-disabling-the-firewall-for-copilot-coding-agent) -* [AUTOTITLE](/copilot/how-tos/copilot-sdk/sdk-getting-started) -* [AUTOTITLE](/copilot/using-github-copilot/coding-agent/extending-copilot-coding-agent-with-mcp) -* [AUTOTITLE](/copilot/concepts/agents/about-copilot-cli) +* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/request-a-code-review/use-code-review) +* [AUTOTITLE](/copilot/tutorials/cloud-agent/get-the-best-results) +* [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/customize-the-agent-environment) +* [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/customize-the-agent-firewall) +* [AUTOTITLE](/copilot/how-tos/copilot-sdk/getting-started) +* [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/configure-mcp-servers) +* [AUTOTITLE](/copilot/concepts/agents/copilot-cli/about-copilot-cli) * [AUTOTITLE](/copilot/concepts/agents/github-copilot-app) {% ifversion spark %} -* [AUTOTITLE](/copilot/tutorials/building-your-first-app-in-minutes-with-github-spark) -* [AUTOTITLE](/copilot/tutorials/building-ai-app-prototypes) -* [AUTOTITLE](/copilot/concepts/copilot-billing/about-billing-for-github-spark) +* [AUTOTITLE](/copilot/tutorials/spark/your-first-spark) +* [AUTOTITLE](/copilot/tutorials/spark/build-apps-with-spark) +* [AUTOTITLE](/billing/concepts/product-billing/github-spark) * [AUTOTITLE](/github-models/responsible-use-of-github-models) * [AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-pre-release-license-terms) {% endif %} diff --git a/content/copilot/responsible-use/chat.md b/content/copilot/responsible-use/chat.md index fa9e098ccfe7..7539d22996a7 100644 --- a/content/copilot/responsible-use/chat.md +++ b/content/copilot/responsible-use/chat.md @@ -152,7 +152,7 @@ Understanding GitHub Copilot Chat's limitations is crucial to determine if it is * **Limited scope**: GitHub Copilot Chat has been trained on a large body of code but may not be able to handle more complex code structures or obscure programming languages. For each language, the quality of suggestions depends on the volume and diversity of training data. For example, JavaScript is well-represented and well-supported, while less common languages may yield lower-quality results. * **Potential biases**: Training data drawn from existing code repositories may contain biases and errors that can be perpetuated by the tool. GitHub Copilot Chat may also be biased towards certain programming languages or coding styles, which can lead to suboptimal or incomplete code suggestions. * **Security risks**: Generated code can potentially expose sensitive information or vulnerabilities if not reviewed carefully. Always review and test generated code thoroughly, especially for security-sensitive applications. -* **Matches with public code**: While the probability is low, GitHub Copilot Chat may produce code that matches code in the training set. You should take the same precautions as you would with any code that uses material you did not independently originate including rigorous testing, IP scanning, and checking for security vulnerabilities. For more information, see [AUTOTITLE](/copilot/using-github-copilot/finding-public-code-that-matches-github-copilot-suggestions). +* **Matches with public code**: While the probability is low, GitHub Copilot Chat may produce code that matches code in the training set. You should take the same precautions as you would with any code that uses material you did not independently originate including rigorous testing, IP scanning, and checking for security vulnerabilities. For more information, see [AUTOTITLE](/copilot/how-tos/get-code-suggestions/find-matching-code). * **Inaccurate code**: GitHub Copilot Chat may generate code that appears valid but is not semantically or syntactically correct, or does not accurately reflect the intent of the developer. Carefully review and test generated code, particularly for critical or sensitive applications. * **Inaccurate responses to non-coding topics**: GitHub Copilot Chat is not designed to answer non-coding questions, and its responses in those contexts may be irrelevant or nonsensical. * **Risk of destructive commands (Windows Terminal)**: Copilot may suggest commands that could be destructive—such as deleting content or formatting a hard drive—that may be necessary in certain scenarios but can cause problems if used incorrectly. You are ultimately responsible for any commands you choose to execute. Despite the presence of fail-safes and safety mechanisms, executing commands carries inherent risks. @@ -165,7 +165,7 @@ Understanding GitHub Copilot Chat's limitations is crucial to determine if it is * **Interpretation of user intent (Spaces)**: Spaces help ground GitHub Copilot Chat's responses in curated context, but the system may still misunderstand your intent. Always review output to confirm it reflects your goals. * **Context limits (Spaces)**: Spaces have defined size limits, and GitHub Copilot Chat only processes a portion of the content you include. Not every file, document, or note in a space will be used in a response. Being selective about what you add helps ensure the most relevant context is used. * **Differing performance based on natural language**: GitHub Copilot Chat has been optimized primarily for English. You may notice differing performance with prompts in other languages. -* **Leveraging web search**: On GitHub.com and when using the GitHub chat participant in supported IDEs, GitHub Copilot Chat can optionally use a Bing search to help answer your question—for example, queries about recent events, new technologies, or highly specific subjects. Your enterprise administrator can enable or disable Bing for your organization. When web search is used, the content of your prompt, along with additional context, is used to generate a Bing search query on your behalf. The search query sent to Bing is governed by [Microsoft's Privacy Statement](https://privacy.microsoft.com/en-us/privacystatement). For more information, see [AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise). +* **Leveraging web search**: On GitHub.com and when using the GitHub chat participant in supported IDEs, GitHub Copilot Chat can optionally use a Bing search to help answer your question—for example, queries about recent events, new technologies, or highly specific subjects. Your enterprise administrator can enable or disable Bing for your organization. When web search is used, the content of your prompt, along with additional context, is used to generate a Bing search query on your behalf. The search query sent to Bing is governed by [Microsoft's Privacy Statement](https://privacy.microsoft.com/en-us/privacystatement). For more information, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-enterprise-policies). ## 8. Evaluations @@ -194,7 +194,7 @@ As part of our product development process, we undertake red teaming to understa ## 9. Safety components and mitigations * **Content filtering**: When enabled, the content filtering system detects and prevents the output of harmful content. If you encounter offensive content, report it to `copilot-safety@github.com`. -* **Public code matching**: Depending on your settings, GitHub Copilot Chat may have the duplicate detection filter turned on or off. If on, GitHub Copilot Chat either blocks suggestions that match public code or annotates them with links to the source repositories and any license details. In VS Code, if you have enabled suggestions that match public code, GitHub Copilot Chat displays a message with a link to show the matched code and any license details in the editor. In Visual Studio, JetBrains, Eclipse, and GitHub Mobile, GitHub Copilot Chat uses filters that block matches with public code. Regardless of settings, you should take the same precautions as with any code that uses material you did not independently originate—including rigorous testing, IP scanning, and checking for security vulnerabilities. For more information, see [AUTOTITLE](/copilot/using-github-copilot/finding-public-code-that-matches-github-copilot-suggestions). +* **Public code matching**: Depending on your settings, GitHub Copilot Chat may have the duplicate detection filter turned on or off. If on, GitHub Copilot Chat either blocks suggestions that match public code or annotates them with links to the source repositories and any license details. In VS Code, if you have enabled suggestions that match public code, GitHub Copilot Chat displays a message with a link to show the matched code and any license details in the editor. In Visual Studio, JetBrains, Eclipse, and GitHub Mobile, GitHub Copilot Chat uses filters that block matches with public code. Regardless of settings, you should take the same precautions as with any code that uses material you did not independently originate—including rigorous testing, IP scanning, and checking for security vulnerabilities. For more information, see [AUTOTITLE](/copilot/how-tos/get-code-suggestions/find-matching-code). ## 10. Best practices for deploying and adopting GitHub Copilot Chat @@ -215,19 +215,18 @@ Responsible AI is a shared commitment between GitHub and its customers. While Gi * **Anchor chat in a space (Spaces)**: Starting conversations from within a space ensures continuity and relevance, keeping responses aligned with the context you've set up. * **Review PR summaries before publishing (GitHub.com)**: Pull request summaries are intended to supplement—not replace—your own context about the changes. Always review and assess the accuracy of a generated summary before saving or publishing your pull request. * **Review commit messages before committing (GitHub.com and GitHub Desktop)**: Commit message generation is intended to supplement—not replace—your own descriptions of the changes. Always review and edit the suggested title and description before committing. In GitHub Desktop, selecting specific lines of code or files can improve accuracy. You can opt out of commit message generation via the Copilot [settings page](https://github.com/settings/copilot/features) on GitHub.com. -* **Provide feedback**: If you encounter any issues or limitations, provide feedback through the thumbs up/down buttons below each chat response. The ability to provide feedback about pull request summaries is dependent on your enterprise settings. For more information, see [AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise). For commit message generation, you can share feedback via the [community discussion](https://github.com/orgs/community/discussions/categories/copilot-news-and-announcements) or by [opening an issue in the GitHub Desktop repository](https://github.com/desktop/desktop/issues). This helps improve the tool and address concerns. +* **Provide feedback**: If you encounter any issues or limitations, provide feedback through the thumbs up/down buttons below each chat response. The ability to provide feedback about pull request summaries is dependent on your enterprise settings. For more information, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-enterprise-policies). For commit message generation, you can share feedback via the [community discussion](https://github.com/orgs/community/discussions/categories/copilot-news-and-announcements) or by [opening an issue in the GitHub Desktop repository](https://github.com/desktop/desktop/issues). This helps improve the tool and address concerns. * **Stay up to date**: GitHub Copilot Chat is evolving. Stay current with updates, new security risks, and best practices. ## 11. Learn more about GitHub Copilot Chat For additional guidance on the responsible use of GitHub Copilot Chat, we recommend reviewing the following documentation: -* [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide) -* [AUTOTITLE](/enterprise-cloud@latest/copilot/github-copilot-enterprise/copilot-pull-request-summaries/creating-a-pull-request-summary-with-github-copilot) -* [AUTOTITLE](/enterprise-cloud@latest/copilot/github-copilot-chat/copilot-chat-in-github/using-github-copilot-chat-in-githubcom) -* [AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-ides/using-github-copilot-chat-in-your-ide) +* [AUTOTITLE](/copilot/how-tos/chat-with-copilot/chat-in-ide) +* [AUTOTITLE](/enterprise-cloud@latest/copilot/how-tos/copilot-on-github/copilot-for-github-tasks/create-a-pr-summary) +* [AUTOTITLE](/enterprise-cloud@latest/copilot/how-tos/copilot-on-github/chat-with-copilot/chat-in-github) * [Terminal Chat](https://learn.microsoft.com/windows/terminal/terminal-chat) -* [AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-copilot-pre-release-terms) +* [AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-pre-release-license-terms) * [AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-terms-for-additional-products-and-features#github-copilot) * [GitHub Copilot Trust Center](https://copilot.github.trust.page/) diff --git a/content/copilot/responsible-use/inline-suggestions.md b/content/copilot/responsible-use/inline-suggestions.md index 47e29a978382..2d25fca05bf1 100644 --- a/content/copilot/responsible-use/inline-suggestions.md +++ b/content/copilot/responsible-use/inline-suggestions.md @@ -174,7 +174,7 @@ Responsible AI is a shared commitment between GitHub and its customers. While Gi For additional guidance on the responsible use of Copilot inline suggestions, we recommend reviewing the following documentation: -* [AUTOTITLE](/copilot/using-github-copilot/getting-code-suggestions-in-your-ide-with-github-copilot) +* [AUTOTITLE](/copilot/how-tos/get-code-suggestions/get-ide-code-suggestions) * [AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-terms-for-additional-products-and-features#github-copilot) * [Copilot Trust Center](https://copilot.github.trust.page/) From 14f20d62de43eed77ea6cacad8745c06995d40da Mon Sep 17 00:00:00 2001 From: Kevin Heis Date: Thu, 9 Jul 2026 13:20:32 -0700 Subject: [PATCH 15/15] Throttle post-deploy Fastly URL purges to avoid 429s (#62200) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- src/workflows/purge-fastly-changed-content.ts | 116 ++++++++++++++++-- .../tests/purge-fastly-changed-content.ts | 104 ++++++++++++++++ 2 files changed, 207 insertions(+), 13 deletions(-) diff --git a/src/workflows/purge-fastly-changed-content.ts b/src/workflows/purge-fastly-changed-content.ts index 3c1e6e2509e9..2486ed64965c 100644 --- a/src/workflows/purge-fastly-changed-content.ts +++ b/src/workflows/purge-fastly-changed-content.ts @@ -37,8 +37,66 @@ const MAX_URLS = 1000 // than paginate through a huge change set. const COMPARE_FILE_LIMIT = 300 -// How many purge requests to keep in flight at once. -const PURGE_CONCURRENCY = 10 +// How many purge requests to keep in flight at once. Fastly rate-limits URL +// purges (documented average: 100,000/customer/hour ~= 27/sec, with a stricter +// undocumented burst limit). Keep this low and pair it with per-worker spacing +// below so we stay well under the burst ceiling and stop tripping HTTP 429s. +const PURGE_CONCURRENCY = 3 + +// Minimum spacing between consecutive purge requests within a single worker. +// With PURGE_CONCURRENCY workers this caps the steady-state rate at roughly +// (concurrency / spacing) req/sec: 3 / 0.15s ~= 20/sec, comfortably under the +// documented 27/sec average. +const PURGE_THROTTLE_MS = 150 + +// When Fastly still rate-limits us (HTTP 429), retry the individual URL this +// many times before giving up on it. +const PURGE_MAX_RATE_LIMIT_RETRIES = 5 + +// Backoff bounds used when a 429 response carries no usable Retry-After / +// Fastly-RateLimit-Reset hint. Exponential from BASE, capped at MAX. MAX also +// caps any server-provided delay so a worker can't hang for the full rate-limit +// window (up to an hour) on a single URL. +const PURGE_RATE_LIMIT_BASE_DELAY_MS = 1000 +const PURGE_RATE_LIMIT_MAX_DELAY_MS = 30_000 + +// A wall-clock ceiling for the whole targeted-purge phase. If Fastly is +// rate-limiting us systemically (not just a one-off burst), the per-URL 429 +// retries above could otherwise stretch this non-blocking job out for hours. +// Once we pass this deadline we stop starting new purges and fail loudly, so +// the workflow's failure alerting fires and the routine soft-purge-all (which +// always runs) remains the backstop for cache freshness. +const PURGE_TIME_BUDGET_MS = 5 * 60_000 + +function sleep(ms: number): Promise { + return new Promise((resolve) => setTimeout(resolve, ms)) +} + +// How long to wait before retrying a rate-limited (429) purge. Prefers Fastly's +// own hints (Retry-After in seconds or as an HTTP date; else Fastly-RateLimit- +// Reset as a Unix timestamp), falling back to exponential backoff with jitter. +// The result is clamped to [0, PURGE_RATE_LIMIT_MAX_DELAY_MS]. +export function rateLimitDelayMs(response: Response, attempt: number): number { + const clamp = (ms: number) => Math.min(Math.max(0, ms), PURGE_RATE_LIMIT_MAX_DELAY_MS) + + const retryAfter = response.headers.get('retry-after') + if (retryAfter) { + const seconds = Number(retryAfter) + if (Number.isFinite(seconds)) return clamp(seconds * 1000) + const dateMs = Date.parse(retryAfter) + if (!Number.isNaN(dateMs)) return clamp(dateMs - Date.now()) + } + + const reset = response.headers.get('fastly-ratelimit-reset') + if (reset) { + const resetSeconds = Number(reset) + if (Number.isFinite(resetSeconds)) return clamp(resetSeconds * 1000 - Date.now()) + } + + const backoff = PURGE_RATE_LIMIT_BASE_DELAY_MS * 2 ** attempt + const jitter = Math.floor(Math.random() * PURGE_THROTTLE_MS) + return clamp(backoff + jitter) +} type ChangedFile = { filename: string @@ -162,18 +220,33 @@ async function loadEnglishPermalinkIndex(): Promise> { // https://www.fastly.com/documentation/reference/api/purging/#purge-a-url async function hardPurgeUrl(url: string, fastlyToken: string): Promise { const withoutScheme = url.replace(/^https?:\/\//, '') - const response = await fetchWithRetry( - `https://api.fastly.com/purge/${withoutScheme}`, - { - method: 'POST', - headers: { - 'fastly-key': fastlyToken, - accept: 'application/json', + for (let attempt = 0; ; attempt++) { + const response = await fetchWithRetry( + `https://api.fastly.com/purge/${withoutScheme}`, + { + method: 'POST', + headers: { + 'fastly-key': fastlyToken, + accept: 'application/json', + }, }, - }, - { retries: 3, timeout: 30_000, throwHttpErrors: false }, - ) - if (!response.ok) { + { retries: 3, timeout: 30_000, throwHttpErrors: false }, + ) + if (response.ok) return + + // Fastly rate limit. fetchWithRetry doesn't retry 429 when throwHttpErrors + // is false, so back off and retry the URL ourselves, honoring Fastly's hint. + if (response.status === 429 && attempt < PURGE_MAX_RATE_LIMIT_RETRIES) { + const waitMs = rateLimitDelayMs(response, attempt) + console.warn( + `Fastly rate-limited purge of ${url}; retrying in ${waitMs}ms (attempt ${ + attempt + 1 + }/${PURGE_MAX_RATE_LIMIT_RETRIES})`, + ) + await sleep(waitMs) + continue + } + let body = '' try { body = await response.text() @@ -195,12 +268,24 @@ export async function hardPurgeUrls( urls: string[], fastlyToken: string, concurrency = PURGE_CONCURRENCY, + throttleMs = PURGE_THROTTLE_MS, + budgetMs = PURGE_TIME_BUDGET_MS, ): Promise { const queue = [...urls] const errors: Error[] = [] + const deadline = Date.now() + budgetMs async function worker() { + let first = true while (queue.length) { + // Space out requests within a worker so concurrency * (1/spacing) stays + // under Fastly's burst limit. Skip the wait before the first request. + if (!first && throttleMs > 0) await sleep(throttleMs) + first = false + // Re-check the budget *after* the throttle sleep so the sleep can't push a + // purge past the deadline; stop starting new purges once we're out of time + // (see PURGE_TIME_BUDGET_MS). Anything left in the queue is reported below. + if (Date.now() > deadline) break const url = queue.shift() if (!url) break try { @@ -215,6 +300,11 @@ export async function hardPurgeUrls( await Promise.all(Array.from({ length: Math.min(concurrency, urls.length) }, worker)) + // Anything still queued means we hit the time budget before draining it. + for (const url of queue) { + errors.push(new Error(`Fastly URL purge skipped (time budget exceeded) for ${url}`)) + } + if (errors.length) { throw new Error(`${errors.length} of ${urls.length} URL purge(s) failed`) } diff --git a/src/workflows/tests/purge-fastly-changed-content.ts b/src/workflows/tests/purge-fastly-changed-content.ts index 8c14cf74b8b9..55c493fbdf60 100644 --- a/src/workflows/tests/purge-fastly-changed-content.ts +++ b/src/workflows/tests/purge-fastly-changed-content.ts @@ -14,6 +14,7 @@ const { getChangedContentFiles, contentFilesToEnglishUrls, hardPurgeUrls, + rateLimitDelayMs, } = await import('../purge-fastly-changed-content') afterEach(() => { @@ -150,6 +151,22 @@ describe('contentFilesToEnglishUrls', () => { }) describe('hardPurgeUrls', () => { + // A minimal stand-in for a fetch Response, with a case-insensitive headers.get. + function fakeResponse( + status: number, + { headers = {}, ok = false }: { headers?: Record; ok?: boolean } = {}, + ) { + const lower: Record = {} + for (const [k, v] of Object.entries(headers)) lower[k.toLowerCase()] = v + return { + ok, + status, + statusText: 'rate limited', + headers: { get: (name: string) => lower[name.toLowerCase()] ?? null }, + text: async () => '', + } + } + test('issues a hard URL purge per URL (no soft-purge header)', async () => { fetchWithRetry.mockResolvedValue({ ok: true }) await hardPurgeUrls( @@ -177,4 +194,91 @@ describe('hardPurgeUrls', () => { ).rejects.toThrow(/1 of 2 URL purge\(s\) failed/) expect(fetchWithRetry).toHaveBeenCalledTimes(2) }) + + test('retries a 429, honoring the hint, then succeeds', async () => { + fetchWithRetry + .mockResolvedValueOnce(fakeResponse(429, { headers: { 'retry-after': '0' } })) + .mockResolvedValueOnce(fakeResponse(200, { ok: true })) + await hardPurgeUrls(['https://docs.github.com/en/foo'], 'tok', 1, 0) + expect(fetchWithRetry).toHaveBeenCalledTimes(2) + }) + + test('gives up after the retry budget and reports the URL as failed', async () => { + fetchWithRetry.mockResolvedValue(fakeResponse(429, { headers: { 'retry-after': '0' } })) + await expect(hardPurgeUrls(['https://docs.github.com/en/foo'], 'tok', 1, 0)).rejects.toThrow( + /1 of 1 URL purge\(s\) failed/, + ) + // Initial attempt + 5 retries. + expect(fetchWithRetry).toHaveBeenCalledTimes(6) + }) + + test('stops starting purges once the time budget is exceeded', async () => { + fetchWithRetry.mockResolvedValue(fakeResponse(200, { ok: true })) + // Budget below zero: the deadline is already in the past on the first loop + // check, so no purge is attempted and every URL is reported as skipped. + await expect( + hardPurgeUrls( + ['https://docs.github.com/en/foo', 'https://docs.github.com/en/bar'], + 'tok', + 1, + 0, + -1, + ), + ).rejects.toThrow(/2 of 2 URL purge\(s\) failed/) + expect(fetchWithRetry).not.toHaveBeenCalled() + }) +}) + +describe('rateLimitDelayMs', () => { + function fakeResponse(headers: Record): Response { + const lower: Record = {} + for (const [k, v] of Object.entries(headers)) lower[k.toLowerCase()] = v + return { + headers: { get: (name: string) => lower[name.toLowerCase()] ?? null }, + } as unknown as Response + } + + afterEach(() => { + vi.useRealTimers() + vi.restoreAllMocks() + }) + + test('honors Retry-After given in seconds', () => { + expect(rateLimitDelayMs(fakeResponse({ 'retry-after': '5' }), 0)).toBe(5000) + }) + + test('honors Retry-After given as an HTTP date', () => { + vi.useFakeTimers() + const now = new Date('2026-01-01T00:00:00Z') + vi.setSystemTime(now) + const when = new Date(now.getTime() + 3000).toUTCString() + expect(rateLimitDelayMs(fakeResponse({ 'retry-after': when }), 0)).toBe(3000) + }) + + test('honors Fastly-RateLimit-Reset as a Unix timestamp', () => { + vi.useFakeTimers() + const now = new Date('2026-01-01T00:00:00Z') + vi.setSystemTime(now) + const reset = String(Math.floor(now.getTime() / 1000) + 7) + expect(rateLimitDelayMs(fakeResponse({ 'fastly-ratelimit-reset': reset }), 0)).toBe(7000) + }) + + test('falls back to exponential backoff when no hint is present', () => { + vi.spyOn(Math, 'random').mockReturnValue(0) + expect(rateLimitDelayMs(fakeResponse({}), 0)).toBe(1000) + expect(rateLimitDelayMs(fakeResponse({}), 2)).toBe(4000) + }) + + test('clamps any delay to the maximum', () => { + vi.spyOn(Math, 'random').mockReturnValue(0) + // 1000 * 2^10 would be ~1,000,000ms; clamped to 30,000. + expect(rateLimitDelayMs(fakeResponse({}), 10)).toBe(30_000) + // A far-future server hint is likewise capped. + expect(rateLimitDelayMs(fakeResponse({ 'retry-after': '99999' }), 0)).toBe(30_000) + }) + + test('never returns a negative delay for a stale hint', () => { + expect(rateLimitDelayMs(fakeResponse({ 'retry-after': '-5' }), 0)).toBe(0) + expect(rateLimitDelayMs(fakeResponse({ 'fastly-ratelimit-reset': '1' }), 0)).toBe(0) + }) })