1
0
mirror of synced 2025-12-25 11:03:37 -05:00

Compare commits

..

160 Commits

Author SHA1 Message Date
Sharra-writes
bc3601d5e5 Update stale.yml
Updating permissions. Not sure how this is being used elsewhere without those permissions.
2025-06-05 12:23:53 -07:00
Sharra-writes
61aa524f60 Merge branch 'main' into Sharra-writes-stale-testing 2025-06-05 12:04:26 -07:00
docs-bot
f271710646 Merge pull request #38768 from github/repo-sync
Repo sync
2025-06-05 12:03:37 -07:00
Sharra-writes
155f45fc00 Update .github/workflows/stale.yml 2025-06-05 11:07:07 -07:00
Sharra-writes
3e5e096d61 Update .github/workflows/stale.yml 2025-06-05 11:06:17 -07:00
Sharra-writes
9a9ec96a2a Update .github/workflows/stale.yml
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-06-05 10:35:43 -07:00
Sharra-writes
f800736152 Update stale.yml
Trying the stale workflow from desktop/desktop to make sure it's a script problem not a yaml problem.
2025-06-05 10:31:03 -07:00
hubwriter
080588f909 Delete .github/ISSUE_TEMPLATE/for-docs-team-use-only.md 2025-06-05 16:43:01 +01:00
hubwriter
7cd099c425 Delete .github/ISSUE_TEMPLATE/for-docs-team-use-only.md 2025-06-05 16:42:37 +01:00
docs-bot
6a79da037c Merge pull request #38758 from github/repo-sync
Repo sync
2025-06-05 05:37:54 -07:00
Josh Feng
fd1a891eea Update GEI IPs in GHEC with DR (AU Stamp) (#55763) 2025-06-05 11:07:02 +00:00
docs-bot
7df2d3fefe Merge pull request #38756 from github/repo-sync
Repo sync
2025-06-05 02:35:55 -07:00
Felicity Chapman
4878085e76 Billing UI updates for user feedback: viewing-your-github-advanced-security-usage.md (#55938) 2025-06-05 09:21:27 +00:00
Lérè
8ad7018c8d Correct docs on project item limits for GHES <3.18 (#55953) 2025-06-05 09:16:20 +00:00
docs-bot
f35cd0d5ba Update audit log event data (#55945)
Co-authored-by: Felicity Chapman <felicitymay@github.com>
2025-06-05 09:09:23 +00:00
hubwriter
e2701f824a Note about content exclusion in VS Code (#55943) 2025-06-05 09:04:35 +00:00
docs-bot
cc53e2a2a3 Update OpenAPI Description (#55946)
Co-authored-by: Felicity Chapman <felicitymay@github.com>
2025-06-05 09:04:19 +00:00
Isaac Brown
c47793d93d Add Copilot Spaces to agentic AI Drivers guide (#55936) 2025-06-05 08:26:22 +00:00
docs-bot
da48bda45d Sync secret scanning data (#55944)
Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com>
2025-06-05 06:41:42 +00:00
docs-bot
0f1512f704 Merge pull request #38747 from github/repo-sync
Repo sync
2025-06-04 20:45:06 -07:00
Paul Wideman
0fb7bb75b2 Update DR GitHub Connect limitations to match the GHES docs (#55941)
Co-authored-by: Vanessa <vgrl@github.com>
2025-06-05 02:10:17 +00:00
Jaryl
5fde626ade Added DeepSeek-R1-0528 to GitHub Models rate limits (#55949) 2025-06-05 00:55:43 +00:00
docs-bot
505046274a Merge pull request #38745 from github/repo-sync
Repo sync
2025-06-04 14:30:15 -07:00
docs-bot
e540b7c0f2 Merge pull request #55951 from github/repo-sync
Repo sync
2025-06-04 14:30:09 -07:00
Rachael Rose Renk
f225b6c08d Copilot Annual Recurring Revenue Recapture (#55349)
Co-authored-by: Navya Canumalla <navyasric@github.com>
Co-authored-by: Felicity Chapman <felicitymay@github.com>
2025-06-04 20:34:37 +00:00
Evan Bonsignori
1340b9d27e assign the aria-controls id to the top-level actionlist (#55950) 2025-06-04 20:27:52 +00:00
Evan Bonsignori
8d77a9f386 better aria labels (#55929) 2025-06-04 20:24:51 +00:00
docs-bot
eb19c00a3d Merge pull request #38742 from github/repo-sync
Repo sync
2025-06-04 11:36:50 -07:00
docs-bot
794cdc0a7a Merge pull request #55947 from github/repo-sync
Repo sync
2025-06-04 11:35:21 -07:00
Rahul Lashkari
12d3f550f9 docs: fixes in Actions runner documentation (#38685)
Co-authored-by: Sharra-writes <sharra-writes@github.com>
2025-06-04 18:14:52 +00:00
Kevin Heis
092c008490 Truncate link checker comment (#55942) 2025-06-04 16:36:44 +00:00
Sarita Iyer
531340eb7f Update docs to add build-mode: none analysis for C/C++ (#55889) 2025-06-04 15:47:28 +00:00
docs-bot
3a07501fba Merge pull request #38740 from github/repo-sync
Repo sync
2025-06-04 08:39:50 -07:00
Paul Loeb
f8d318afc4 update model availability docs (#55934)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-06-04 15:34:03 +00:00
Robert Sese
b26048e5e5 remove aria scrollbar role for REST code blocks (#55933) 2025-06-04 15:05:02 +00:00
docs-bot
6098529456 Merge pull request #38739 from github/repo-sync
Repo sync
2025-06-04 05:37:50 -07:00
Tadas Labudis
eb0bb8fc23 Update configuring-notifications.md (#55918)
Co-authored-by: Anne-Marie <102995847+am-stead@users.noreply.github.com>
2025-06-04 11:01:23 +00:00
Phan Thai Duong
14ce4f0d40 Update upgrading-java-projects-with-github-copilot.md (#55935)
Co-authored-by: Felix Guntrip <stevecat@github.com>
2025-06-04 10:00:07 +00:00
docs-bot
45cabe25e5 Merge pull request #38738 from github/repo-sync
Repo sync
2025-06-04 02:35:57 -07:00
Anne-Marie
7e5043d66b [Improvement]: Pull Requests are a type of issues #16150 (#55851) 2025-06-04 08:19:42 +00:00
docs-bot
bf0ee396d3 Merge pull request #38730 from github/repo-sync
Repo sync
2025-06-03 20:44:02 -07:00
docs-bot
609f43632c Merge pull request #55932 from github/repo-sync
Repo sync
2025-06-03 17:46:26 -07:00
docs-bot
d3ffd7f541 Merge pull request #38725 from github/repo-sync
Repo sync
2025-06-03 17:45:48 -07:00
Evan Bonsignori
864ceb439c fix remaining a11y issues (#55930) 2025-06-04 00:34:08 +00:00
Evan Bonsignori
ad636dc6b0 Copilot Search a11y: use div instead of header for overlay (#55924) 2025-06-03 21:44:22 +00:00
Evan Bonsignori
12eb5e7c73 Copilot Search a11y: replace overlay footer with div (#55925) 2025-06-03 21:44:17 +00:00
docs-bot
732e2b5ad8 Merge pull request #38723 from github/repo-sync
Repo sync
2025-06-03 14:43:00 -07:00
docs-bot
d3d9d5431d Merge pull request #55928 from github/repo-sync
Repo sync
2025-06-03 14:32:21 -07:00
Kevin Heis
fab07f48b9 Update typescript, consistent import path format for ts/tsx files (#55922) 2025-06-03 19:36:19 +00:00
docs-bot
2f968d9edd Update OpenAPI Description (#55923)
Co-authored-by: Felicity Chapman <felicitymay@github.com>
2025-06-03 19:02:56 +00:00
Illia Polovynko
98eb7dc4f9 docs: Fix typo in evaluate expressions in workflows doc (#38714) 2025-06-03 18:47:28 +00:00
docs-bot
2a5d3ec904 Merge pull request #38718 from github/repo-sync
Repo sync
2025-06-03 11:37:31 -07:00
Sophie
029eaf9cb7 GHES 3.17 release candidate > GA (#55830) 2025-06-03 18:35:51 +00:00
docs-bot
70e258d2f2 Update OpenAPI Description (#55882)
Co-authored-by: Felicity Chapman <felicitymay@github.com>
2025-06-03 17:24:41 +00:00
Jim Boyle
75d53ed833 Update documentation to reflect increases in GEI's repository size limits and the impacted reusable docs elements (#55883)
Co-authored-by: Felicity Chapman <felicitymay@github.com>
2025-06-03 17:39:14 +00:00
Kevin Heis
1601b7d335 Only show footer copilot search experiment when enabled (#55919) 2025-06-03 15:30:43 +00:00
Robert Sese
641c4f7bcd Merge remote-tracking branch 'public/main' 2025-06-03 10:35:09 -05:00
Manuel Bergler
0ad5a89912 Ensure loopback address is correct for metrics verification (#55903)
Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com>
2025-06-03 15:01:29 +00:00
Felicity Chapman
07eaf1182c Update excluded-links.yml to include https://developer.anthology.com/portal/applications (#55913) 2025-06-03 14:59:53 +00:00
Courtney Claessens
1c1d94b2c9 Secret scanning - update non-provider passwords table (#55916)
Co-authored-by: Felicity Chapman <felicitymay@github.com>
2025-06-03 14:29:30 +00:00
Michael B. Gale
3862fdf9db Make wording for "default setup access to private registries" more general (#55899) 2025-06-03 14:05:04 +00:00
Copilot
214ba4a09a Clarify Copilot Chat usage for Coding Agent in 'About assigning tasks to Copilot' (#38713)
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: hubwriter <54933897+hubwriter@users.noreply.github.com>
2025-06-03 13:59:01 +00:00
John Clement
6d21508566 Add documentation for disabling persistent commit verification on GHES 3.17+ (#55727)
Co-authored-by: Isaac Brown <101839405+isaacmbrown@users.noreply.github.com>
2025-06-03 13:06:27 +00:00
Copilot
b630e0a10c Fix markdown lint errors in billing and education documentation (#55911)
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: felicitymay <1877141+felicitymay@users.noreply.github.com>
Co-authored-by: Felicity Chapman <felicitymay@github.com>
2025-06-03 12:02:47 +00:00
hubwriter
f401a50f2f Update copilot-instructions.md 2025-06-03 12:12:04 +01:00
Rob Aiken
f950caa30b Dependabot Supportes PNPM 10 (#55900) 2025-06-03 09:59:56 +00:00
Indigo
017fca36b0 Revert "Include public repositories in cost note (#55667)" (#55898) 2025-06-03 09:50:35 +00:00
DocToon
ed4a4ac82c fix: add missing "to" in bullet point (#38702) 2025-06-03 03:09:00 +00:00
Hirsch Singhal
81898af3b3 Repo collaborators GA updates (#55893) 2025-06-03 00:50:26 +00:00
Pallavi
78c89d9b78 GHES 3.17: Database transitions concurrently (#55524)
Co-authored-by: Sophie <29382425+sophietheking@users.noreply.github.com>
Co-authored-by: vgrl <vgrl@github.com>
2025-06-02 23:35:45 +00:00
Justin Alex
d95a3c8ed1 [Improvement]: Remove Confusing Statement about 2FA Codes for EMU Setup User (#55873)
Co-authored-by: Joe Clark <31087804+jc-clark@users.noreply.github.com>
2025-06-02 22:30:58 +00:00
Justin Alex
6d89bb94c4 [Improvement]: Add Base URL on EMU SCIM with Okta article, for customers using GitHub Cloud with Data Residency (#55872) 2025-06-02 22:17:12 +00:00
Rahul Lashkari
1a1a2a3846 docs: fixes in Actions security hardening guide (#38686) 2025-06-02 21:32:57 +00:00
Evan Bonsignori
b11e6edb5c Attempt index fix round 3 (#55901) 2025-06-02 21:01:24 +00:00
Evan Bonsignori
9d735706ac update CTA and add it to footer (#55865)
Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com>
2025-06-02 20:59:16 +00:00
docs-bot
5c7d605f1a Merge pull request #38698 from github/repo-sync
Repo sync
2025-06-02 11:36:58 -07:00
docs-bot
eeeabea9d2 Merge pull request #55897 from github/repo-sync
Repo sync
2025-06-02 11:35:03 -07:00
Copilot
f8fcee0c3d Convert all JavaScript files to TypeScript in src/automated-pipelines directory (#55861)
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: heiskr <1221423+heiskr@users.noreply.github.com>
Co-authored-by: Ebonsignori <17055832+Ebonsignori@users.noreply.github.com>
Co-authored-by: Evan Bonsignori <ebonsignori@github.com>
2025-06-02 17:50:10 +00:00
docs-bot
40551f3718 Update audit log event data (#55894)
Co-authored-by: Felicity Chapman <felicitymay@github.com>
2025-06-02 17:43:22 +00:00
docs-bot
caf8f12363 Delete orphaned files (2025-06-02-16-37) (#55895) 2025-06-02 17:40:14 +00:00
Evan Bonsignori
f504deeadd try to use built in ES helper to bulk index records into ES (#55888) 2025-06-02 17:06:06 +00:00
hubwriter
3f9ee67da5 Update README.md 2025-06-02 16:59:43 +01:00
Copilot
75bf566d03 Update GitHub language support article with footnotes and improved note formatting (#38633)
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: hubwriter <54933897+hubwriter@users.noreply.github.com>
Co-authored-by: hubwriter <hubwriter@github.com>
2025-06-02 15:56:53 +00:00
docs-bot
cc77b3d6af Merge pull request #38694 from github/repo-sync
Repo sync
2025-06-02 08:35:45 -07:00
Kevin Heis
e3588f9d4a A11y: update roles for picker menus (#55885) 2025-06-02 15:32:59 +00:00
Copilot
0c69d86c3a Fix Marketplace App requirement contradiction for app listings (#55881)
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: hubwriter <54933897+hubwriter@users.noreply.github.com>
Co-authored-by: hubwriter <hubwriter@github.com>
2025-06-02 15:16:50 +01:00
docs-bot
eea297fcac Merge pull request #38688 from github/repo-sync
Repo sync
2025-06-02 05:37:46 -07:00
Copilot
ec7bb4d9bb Move Copilot variables from product.yml to copilot.yml (#55832)
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: hubwriter <54933897+hubwriter@users.noreply.github.com>
Co-authored-by: hubwriter <hubwriter@github.com>
Co-authored-by: felicitymay <1877141+felicitymay@users.noreply.github.com>
Co-authored-by: Felix Guntrip <stevecat@github.com>
Co-authored-by: Joe Clark <31087804+jc-clark@users.noreply.github.com>
Co-authored-by: Ebonsignori <17055832+Ebonsignori@users.noreply.github.com>
2025-06-02 11:35:54 +01:00
docs-bot
bda76e771e Merge pull request #38687 from github/repo-sync
Repo sync
2025-06-02 02:36:14 -07:00
Jules
82ad892a34 Update issue templates 2025-06-02 10:28:48 +02:00
Kensuke Nagae
1c1dc89408 Update scope of support regarding technical preview features (#55792)
Co-authored-by: Jules <19994093+jules-p@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-06-02 07:51:45 +00:00
docs-bot
3a563dc58c Merge pull request #38681 from github/repo-sync
Repo sync
2025-06-01 17:47:43 -07:00
gitulisca
598eeb100b Add Hypervisor issues to out of Support Scope (#55871)
Co-authored-by: Justin Alex <1155821+jusuchin85@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Vanessa <vgrl@github.com>
2025-06-01 23:31:22 +00:00
Kevin Glowacz
ac13aeac01 Clarification about GHE license status of GHAS comitter (#55858)
Co-authored-by: Vanessa <vgrl@github.com>
2025-06-01 22:36:35 +00:00
docs-bot
272838a3f0 Merge pull request #38635 from github/repo-sync
Repo sync
2025-05-30 14:31:35 -07:00
docs-bot
343c70fb4b Merge pull request #55887 from github/repo-sync
Repo sync
2025-05-30 14:31:29 -07:00
Adrien Poupa
b7aa14a6eb fix(cache): Add write permissions to clear cache workflow (#37953)
Co-authored-by: Sharra-writes <sharra-writes@github.com>
2025-05-30 19:57:04 +00:00
docs-bot
369f302c0a Merge pull request #38634 from github/repo-sync
Repo sync
2025-05-30 11:42:55 -07:00
docs-bot
776d82e376 Merge pull request #55884 from github/repo-sync
Repo sync
2025-05-30 11:35:43 -07:00
dependabot[bot]
e85bba39cb Bump @octokit/rest from 21.0.2 to 22.0.0 (#55816)
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-05-30 17:55:43 +00:00
dependabot[bot]
a839eca40d Bump file-type from 20.0.1 to 21.0.0 (#55815)
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-05-30 17:55:14 +00:00
dependabot[bot]
1497b84188 Bump github/gh-base-image/gh-base-noble from 20250522-041000-g9c0993b27 to 20250529-200944-g9be5a274f in the baseimages group (#55869)
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-05-30 17:54:09 +00:00
Yaakov
8d487f535b Fix probable typo in JSON example (#38624)
Co-authored-by: Sharra-writes <sharra-writes@github.com>
2025-05-30 16:52:03 +00:00
Akhilesh Tiwari
f2869102a5 Update evaluate-expressions-in-workflows-and-actions.md (#38230)
Co-authored-by: Sharra-writes <sharra-writes@github.com>
2025-05-30 16:14:30 +00:00
docs-bot
e7aec5ef3d Merge pull request #38632 from github/repo-sync
Repo sync
2025-05-30 08:34:07 -07:00
Tim Rogers
773552f533 Document that Copilot coding agent is not available in Proxima (#55803)
Co-authored-by: Sophie <29382425+sophietheking@users.noreply.github.com>
2025-05-30 15:24:57 +00:00
Copilot
9777e406cf Fix step order in merging multiple personal accounts documentation (#55877)
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: hubwriter <54933897+hubwriter@users.noreply.github.com>
2025-05-30 14:02:26 +00:00
Copilot
021683e5f9 Update terminology from "Required reviews" to "Required approvals" (#55878)
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: hubwriter <54933897+hubwriter@users.noreply.github.com>
2025-05-30 13:40:57 +00:00
docs-bot
8cba934858 Merge pull request #38631 from github/repo-sync
Repo sync
2025-05-30 05:38:22 -07:00
docs-bot
88471cadf4 Merge pull request #38628 from github/repo-sync
Repo sync
2025-05-30 02:34:43 -07:00
Copilot
3af7ba9ef0 Add warning about impacts of removing team members (#55853)
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: hubwriter <54933897+hubwriter@users.noreply.github.com>
Co-authored-by: hubwriter <hubwriter@github.com>
2025-05-30 09:29:22 +00:00
docs-bot
67d15da00c Update audit log event data (#55856)
Co-authored-by: Ben Ahmady <32935794+subatoi@users.noreply.github.com>
2025-05-30 07:35:48 +00:00
docs-bot
ba5b4e90e1 Update OpenAPI Description (#55840)
Co-authored-by: Ben Ahmady <32935794+subatoi@users.noreply.github.com>
2025-05-30 07:27:11 +00:00
docs-bot
9159fb547c Merge pull request #55870 from github/repo-sync
Repo sync
2025-05-29 17:45:15 -07:00
docs-bot
246fc30598 Merge pull request #38625 from github/repo-sync
Repo sync
2025-05-29 17:44:41 -07:00
Siara
773a325ff7 Fix Copilot Spaces instructions (#55867) 2025-05-29 22:17:59 +00:00
docs-bot
e2264900e5 Merge pull request #55866 from github/repo-sync
Repo sync
2025-05-29 14:32:17 -07:00
docs-bot
892c4b7150 Merge pull request #38621 from github/repo-sync
Repo sync
2025-05-29 14:32:05 -07:00
Giovani Moutinho
8c20421d95 Fix model name not found with gh models commands (#38607) 2025-05-29 20:18:18 +00:00
Kevin Heis
de2b0f3404 A11y: set sidebar headers to h2 (#55859) 2025-05-29 18:38:33 +00:00
docs-bot
fb5eb8ad21 Merge pull request #38610 from github/repo-sync
Repo sync
2025-05-29 11:36:23 -07:00
docs-bot
ddf0b11d1e Merge pull request #55862 from github/repo-sync
Repo sync
2025-05-29 11:34:56 -07:00
Evan Bonsignori
5a54e0dcf9 Add copilot as a valid Docs team actor (#55857) 2025-05-29 17:27:44 +00:00
Sophie
ea5846a92b Copilot Spaces [Public Preview] (#55770)
Co-authored-by: Isaac Brown <101839405+isaacmbrown@users.noreply.github.com>
Co-authored-by: Kelly Henckel <7854726+khenckel@users.noreply.github.com>
Co-authored-by: Siara <108543037+SiaraMist@users.noreply.github.com>
Co-authored-by: SiaraMist <siaramist@github.com>
2025-05-29 17:14:07 +00:00
hubwriter
d9acbd8949 Create copilot-instructions.md file (#55839) 2025-05-29 15:41:28 +00:00
Copilot
574274f4f4 Add missing sort options to sorting search results documentation (#38603)
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: hubwriter <54933897+hubwriter@users.noreply.github.com>
2025-05-29 15:33:37 +00:00
docs-bot
defc4bc1df Merge pull request #38605 from github/repo-sync
Repo sync
2025-05-29 08:35:12 -07:00
Daniel Garman
f32fc8c442 Add token callout to top level inference routes (#55842)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Ben Ahmady <32935794+subatoi@users.noreply.github.com>
2025-05-29 14:30:23 +00:00
docs-bot
f323e8963e Update CodeQL query tables (#55836)
Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com>
2025-05-29 13:38:08 +00:00
Carlin Cherry
facc7976fe Update setting-dependabot-to-run-on-self-hosted-runners-using-arc.md (#55813)
Co-authored-by: Sophie <29382425+sophietheking@users.noreply.github.com>
Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com>
2025-05-29 12:54:25 +00:00
docs-bot
f71be9b242 Merge pull request #55848 from github/repo-sync
Repo sync
2025-05-28 20:42:40 -07:00
Morgan Ersery
081e5afc7e Create terms-for-student-benefits.md (#38458)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Sharra-writes <sharra-writes@github.com>
2025-05-29 03:16:14 +00:00
docs-bot
ff3678c74f Merge pull request #55846 from github/repo-sync
Repo sync
2025-05-28 17:45:45 -07:00
docs-bot
3cfa2ff48e Merge pull request #38572 from github/repo-sync
Repo sync
2025-05-28 17:45:16 -07:00
docs-bot
6ada1f43f6 Merge pull request #38571 from github/repo-sync
Repo sync
2025-05-28 14:32:21 -07:00
docs-bot
034b77f760 Merge pull request #55845 from github/repo-sync
Repo sync
2025-05-28 14:31:58 -07:00
apc-sh-tanaka
6e19bb86b1 Fix about-github-advanced-security.md (#38563)
Co-authored-by: Sharra-writes <sharra-writes@github.com>
2025-05-28 21:14:05 +00:00
John Clement
d06e5f9216 Update the Contributing to projects article (#55584)
Co-authored-by: Isaac Brown <101839405+isaacmbrown@users.noreply.github.com>
2025-05-28 21:05:43 +00:00
Kevin Heis
844b71f36b A11y: Set survey email bg to transparent (#55844) 2025-05-28 13:43:23 -07:00
docs-bot
7cf4dc250b Merge pull request #38567 from github/repo-sync
Repo sync
2025-05-28 11:36:23 -07:00
docs-bot
5cf1d2776a Merge pull request #55843 from github/repo-sync
Repo sync
2025-05-28 11:34:54 -07:00
hubwriter
8812d983e1 [2025-05-28] Document individual automatic CCR setting (#55804)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Sunbrye Ly <56200261+sunbrye@users.noreply.github.com>
2025-05-28 17:51:29 +00:00
scollovati
f921b4255e [education] add documentation for configuring Blackboard LMS (#35028)
Co-authored-by: Joe Clark <31087804+jc-clark@users.noreply.github.com>
2025-05-28 17:31:26 +00:00
docs-bot
55564dabab Merge pull request #38565 from github/repo-sync
Repo sync
2025-05-28 08:35:41 -07:00
Copilot
bc945902ce Update the authentication issues sentence in Copilot Chat troubleshooting documentation (#55837)
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: hubwriter <54933897+hubwriter@users.noreply.github.com>
Co-authored-by: hubwriter <hubwriter@github.com>
2025-05-28 13:36:00 +00:00
Ben Ahmady
63d10c7005 Add some JSON as a reusable as a bug workaround (#55829) 2025-05-28 13:13:36 +00:00
Copilot
0d5ebb626e Remove duplicate sentence in Copilot Chat model documentation (#55751)
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jules-p <19994093+jules-p@users.noreply.github.com>
2025-05-28 13:09:52 +00:00
Copilot
f1e5c4fce1 Update short titles in Copilot docs to use base verbs instead of gerunds (#55823)
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jules-p <19994093+jules-p@users.noreply.github.com>
2025-05-28 11:24:59 +00:00
Bob
90d2ec44bf Update github-marketplace-developer-agreement.md (#55820) 2025-05-28 11:18:00 +00:00
Copilot
46606fd63e Update Copilot docs to clarify budget setting availability date (#55827)
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jules-p <19994093+jules-p@users.noreply.github.com>
2025-05-28 11:16:32 +00:00
Paul Loeb
2c3f6286ef update subprocessor gcp singapore (#55817) 2025-05-28 11:11:20 +00:00
Paul Loeb
602ac6d92b revise claude hosting (#55811) 2025-05-28 11:05:56 +00:00
Carlin Cherry
d411ddc156 Update setting-dependabot-to-run-on-github-hosted-runners-using-vnet.md (#55812)
Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com>
2025-05-28 10:37:06 +00:00
Copilot
5e44c80b81 Update scope of support for technical previews (#55825)
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jules-p <19994093+jules-p@users.noreply.github.com>
2025-05-28 10:12:55 +00:00
Jules
3362ff2304 Update issue templates 2025-05-28 12:16:56 +02:00
docs-bot
032824b650 Merge pull request #38561 from github/repo-sync
Repo sync
2025-05-28 02:37:47 -07:00
docs-bot
392b8deb34 Update OpenAPI Description (#55809)
Co-authored-by: Ben Ahmady <32935794+subatoi@users.noreply.github.com>
2025-05-28 07:19:14 +00:00
Deborah D
e0e569dc9b Add redirect_from to integrating-ai-models doc (#55810) 2025-05-28 07:07:30 +00:00
Copilot
06e6b364b9 Update documentation: Clarify GitHub Copilot Pro access for students and teachers (#55805)
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jules-p <19994093+jules-p@users.noreply.github.com>
2025-05-28 06:48:39 +00:00
docs-bot
404a0bc839 Merge pull request #55819 from github/repo-sync
Repo sync
2025-05-27 20:41:38 -07:00
704 changed files with 9551 additions and 23127 deletions

View File

@@ -4,9 +4,9 @@ import coreLib from '@actions/core'
import { type Octokit } from '@octokit/rest'
import { CoreInject } from '@/links/scripts/action-injections'
import github from '#src/workflows/github.ts'
import { getActionContext } from '#src/workflows/action-context.ts'
import { boolEnvVar } from '#src/workflows/get-env-inputs.ts'
import github from '@/workflows/github'
import { getActionContext } from '@/workflows/action-context'
import { boolEnvVar } from '@/workflows/get-env-inputs'
type Options = {
addLabels?: string[]

25
.github/copilot-instructions.md vendored Normal file
View File

@@ -0,0 +1,25 @@
This documentation repository consists mainly of content written in Markdown format. These files are converted into HTML for displaying on a website. Most Markdown files become a single article on the documentation site. Other files contain reusable content which is inserted into multiple articles. The repository also contains YAML files (e.g. for variable text), image files, JavaScript/TypeScript files, etc.
### Using variables
Within Markdown files, with the exception of the `title` field in the metadata at the start of a file, always use the Liquid syntax variables rather than text if a variable has been defined for that text. For example:
| Use this variable | Don't use this text | File where variable is defined |
| --- | --- | --- |
| `{% data variables.product.prodname_dotcom %}` | GitHub | data/variables/product.yml |
| `{% data variables.product.prodname_ghe_server %}` | GitHub Enterprise Server | data/variables/product.yml |
| `{% data variables.product.prodname_copilot_short %}` | Copilot | data/variables/product.yml |
| `{% data variables.product.prodname_copilot %}` | GitHub Copilot | data/variables/product.yml |
| `{% data variables.copilot.copilot_code-review_short %}` | Copilot code review | data/variables/copilot.yml |
| `{% data variables.enterprise.prodname_managed_user %}` | managed user account | data/variables/enterprise.yml |
| `{% data variables.code-scanning.codeql_workflow %}` | CodeQL analysis workflow | data/variables/code-scanning.yml |
There are many more variables. These are stored in various YAML files within the `data/variables` directory.
### Links to other articles
`[AUTOTITLE]` is the correct way to specify the title of a linked article, when that article is another page on the docs.github.com site. Do not suggest replacing the placeholder link text `[AUTOTITLE]` with the actual page title or using the `{% link %}` Liquid tag.
### Creating a pull request
When creating a pull request as a result of a request to do so in Copilot Chat, the first line of the PR description should always be the following (in italics): `_This pull request was created as a result of the following prompt in Copilot Chat._` Then, within a collapsed section, quote the original prompt from Copilot Chat.

View File

@@ -1,9 +1,47 @@
name: Stale
#name: Stale
# **What it does**: Close issues and pull requests after no updates for 365 days.
# **Why we have it**: We want to manage our queue of issues and pull requests.
# **Who does it impact**: Everyone that works on docs or docs-internal.
#on:
#schedule:
# - cron: '20 16 * * *' # Run every day at 16:20 UTC / 8:20 PST
#permissions:
#contents: read
#issues: write
#pull-requests: write
#jobs:
#stale:
#if: github.repository == 'github/docs-internal' || github.repository == 'github/docs'
#runs-on: ubuntu-latest
#steps:
#- uses: actions/stale@28ca1036281a5e5922ead5184a1bbf96e5fc984e # v9.0.0
#with:
#repo-token: ${{ secrets.GITHUB_TOKEN }}
#stale-issue-message: 'This issue is stale because there have been no updates in 365 days.'
#stale-pr-message: 'This PR is stale because there have been no updates in 365 days.'
#days-before-stale: 365
#days-before-close: 0
#stale-issue-label: 'stale'
#stale-pr-label: 'stale'
#exempt-pr-labels: 'never-stale,waiting for review'
#exempt-issue-labels: 'never-stale,help wanted,waiting for review'
#operations-per-run: 1000
#close-issue-reason: not_planned
#- name: Check out repo
#if: ${{ failure() }}
#uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
#- uses: ./.github/actions/slack-alert
#if: ${{ failure() }}
#with:
#slack_channel_id: ${{ secrets.DOCS_ALERTS_SLACK_CHANNEL_ID }}
#slack_token: ${{ secrets.SLACK_DOCS_BOT_TOKEN }}
name: 'Marks stale issues and PRs'
on:
schedule:
- cron: '20 16 * * *' # Run every day at 16:20 UTC / 8:20 PST
@@ -11,32 +49,16 @@ on:
permissions:
contents: read
issues: write
pull-requests: write
jobs:
stale:
if: github.repository == 'github/docs-internal' || github.repository == 'github/docs'
runs-on: ubuntu-latest
steps:
- uses: actions/stale@28ca1036281a5e5922ead5184a1bbf96e5fc984e # v9.0.0
- uses: actions/stale@v9
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
stale-issue-message: 'This issue is stale because there have been no updates in 365 days.'
stale-pr-message: 'This PR is stale because there have been no updates in 365 days.'
stale-issue-label: 'stale, triage' # The label that will be added to the issues when automatically marked as stale
start-date: '2024-11-25T00:00:00Z' # Skip stale action for issues/PRs created before it
days-before-stale: 365
days-before-close: 0
stale-issue-label: 'stale'
stale-pr-label: 'stale'
exempt-pr-labels: 'never-stale,waiting for review'
exempt-issue-labels: 'never-stale,help wanted,waiting for review'
operations-per-run: 1000
close-issue-reason: not_planned
- name: Check out repo
if: ${{ failure() }}
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
- uses: ./.github/actions/slack-alert
if: ${{ failure() }}
with:
slack_channel_id: ${{ secrets.DOCS_ALERTS_SLACK_CHANNEL_ID }}
slack_token: ${{ secrets.SLACK_DOCS_BOT_TOKEN }}
days-before-close: -1 # If -1, the issues nor pull requests will never be closed automatically.
days-before-pr-stale: -1 # If -1, no pull requests will be marked as stale automatically.
exempt-issue-labels: 'never-stale, help wanted' # issues labeled as such will be excluded them from being marked as stale

View File

@@ -8,7 +8,7 @@
# ---------------------------------------------------------------
# To update the sha:
# https://github.com/github/gh-base-image/pkgs/container/gh-base-image%2Fgh-base-noble
FROM ghcr.io/github/gh-base-image/gh-base-noble:20250522-041000-g9c0993b27 AS base
FROM ghcr.io/github/gh-base-image/gh-base-noble:20250529-200944-g9be5a274f AS base
# Install curl for Node install and determining the early access branch
# Install git for cloning docs-early-access & translations repos

View File

@@ -19,7 +19,7 @@ You can also contribute by creating a local environment or opening a Codespace.
<img alt="Contribution call-to-action" src="./contributing/images/contribution_cta.png" width="400">
For more complex contributions, please open an issue using the most appropriate [issue template](https://github.com/github/docs/issues/new/choose) to describe the changes you'd like to see.
For more complex contributions, please [open an issue in the docs-content repo](https://github.com/github/docs-content/issues/new/choose) describing the changes you'd like to see.
If you're looking for a way to contribute, you can scan through our [help wanted board](https://github.com/github/docs/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) to find open issues already approved for work.

Binary file not shown.

After

Width:  |  Height:  |  Size: 85 KiB

View File

@@ -65,6 +65,13 @@ To see repositories that you're watching, go to your [watching page](https://git
You can configure notifications for a repository on the repository page, or on your watching page.
{% ifversion fpt or ghec %}
> [!NOTE]
> You can watch a maximum of 10,000 repositories.
{% endif %}
### About custom notifications
You can customize notifications for a repository. For example, you can choose to only be notified when updates to one or more types of events ({% data reusables.notifications-v2.custom-notification-types %}) happen within a repository, or ignore all notifications for a repository. For more information, see [Configuring your watch settings for an individual repository](#configuring-your-watch-settings-for-an-individual-repository) below.

View File

@@ -55,7 +55,7 @@ Hiring managers usually consider many applicants for each role. Expect that they
### Write a helpful README
The README for your project's repository is a perfect space to give a concise project overview. Use [{% data variables.product.prodname_copilot_chat_short %}](https://github.com/copilot) to help write your README, with a prompt like this:
The README for your project's repository is a perfect space to give a concise project overview. Use [{% data variables.copilot.copilot_chat_short %}](https://github.com/copilot) to help write your README, with a prompt like this:
>Write a README for my lottery-number-generator repository.

View File

@@ -37,8 +37,8 @@ shortTitle: Merge multiple accounts
1. [Transfer any repositories](/repositories/creating-and-managing-repositories/transferring-a-repository) from the account you want to delete to the account you want to keep. Issues, pull requests, and wikis are transferred as well. Verify the repositories exist on the account you want to keep.
1. [Update the remote URLs](/get-started/git-basics/managing-remote-repositories) in any local clones of the repositories that were moved.
1. To attribute past commits to the new account, add the email address you used to author the commits to the account you're keeping. For more information, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile#your-local-git-commit-email-isnt-connected-to-your-account)
1. [Delete the account](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/deleting-your-personal-account) you no longer want to use.
1. To attribute past commits to the new account, add the email address you used to author the commits to the account you're keeping. For more information, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile#your-local-git-commit-email-isnt-connected-to-your-account)
## Further reading

View File

@@ -18,7 +18,7 @@ topics:
{% data reusables.actions.actions-runner-controller-about-arc %}
The following diagram illustrates the architecture of ARC's autoscaling runner scaleset mode.
The following diagram illustrates the architecture of ARC's autoscaling runner scale set mode.
> [!NOTE]
> To view the following diagram in a larger size, see the [Autoscaling Runner Scale Sets mode](https://github.com/actions/actions-runner-controller/blob/master/docs/gha-runner-scale-set-controller/README.md#how-it-works) documentation in the Actions Runner Controller repository.
@@ -30,7 +30,7 @@ The following diagram illustrates the architecture of ARC's autoscaling runner s
1. {% data variables.product.prodname_actions_runner_controller %} is installed using the supplied Helm charts, and the controller manager pod is deployed in the specified namespace. A new AutoScalingRunnerSet resource is deployed via the supplied Helm charts or a customized manifest file. The AutoScalingRunnerSet Controller calls GitHub's APIs to fetch the runner group ID that the runner scale set will belong to.
1. The AutoScalingRunnerSet Controller calls the APIs one more time to either fetch or create a runner scale set in the {% data variables.product.prodname_actions %} service before creating the Runner ScaleSet Listener resource.
1. A Runner ScaleSet Listener pod is deployed by the AutoScalingListener Controller. In this pod, the listener application connects to the {% data variables.product.prodname_actions %} Service to authenticate and establish an HTTPS long poll connection. The listener stays idle until it receives a `Job Available` message from the {% data variables.product.prodname_actions %} Service.
1. When a workflow run is triggered from a repository, the {% data variables.product.prodname_actions %} Service dispatches individual job runs to the runners or runner scalesets where the `runs-on` key matches the name of the runner scaleset or labels of self-hosted runners.
1. When a workflow run is triggered from a repository, the {% data variables.product.prodname_actions %} Service dispatches individual job runs to the runners or runner scale sets where the `runs-on` key matches the name of the runner scale set or labels of self-hosted runners.
1. When the Runner ScaleSet Listener receives the `Job Available` message, it checks whether it can scale up to the desired count. If it can, the Runner ScaleSet Listener acknowledges the message.
1. The Runner ScaleSet Listener uses a Service Account and a Role bound to that account to make an HTTPS call through the Kubernetes APIs to patch the Ephemeral RunnerSet resource with the number of desired replicas count.
1. The Ephemeral RunnerSet attempts to create new runners and the EphemeralRunner Controller requests a Just-in-Time (JIT) configuration token to register these runners. The controller attempts to create runner pods. If the pod's status is `failed`, the controller retries up to 5 times. After 24 hours the {% data variables.product.prodname_actions %} Service unassigns the job if no runner accepts it.

View File

@@ -490,7 +490,7 @@ No output is expected for `run_script_step`.
npm install && npm run bootstrap && npm run build-all
```
When the resulting `index.js` is triggered by {% data variables.product.prodname_actions %}, it will run the customization commands defined in the JSON files. To trigger the `index.js`, you will need to add it your `ACTIONS_RUNNER_REQUIRE_JOB_CONTAINER` environment variable, as described in the next section.
When the resulting `index.js` is triggered by {% data variables.product.prodname_actions %}, it will run the customization commands defined in the JSON files. To trigger the `index.js`, you will need to add it to your `ACTIONS_RUNNER_REQUIRE_JOB_CONTAINER` environment variable, as described in the next section.
## Triggering the customization script

View File

@@ -16,4 +16,4 @@ To open a chat about a failed workflow run, you can either:
This opens a chat window with {% data variables.product.prodname_copilot %}, where it will provide instructions to resolve the issue.
>[!NOTE] If you are on a {% data variables.product.prodname_copilot_free %} subscription, this will count towards your monthly chat message limit.
>[!NOTE] If you are on a {% data variables.copilot.copilot_free %} subscription, this will count towards your monthly chat message limit.

View File

@@ -348,7 +348,7 @@ You should also consider the environment of the self-hosted runner machines:
* What sensitive information resides on the machine configured as a self-hosted runner? For example, private SSH keys, API access tokens, among others.
* Does the machine have network access to sensitive services? For example, Azure or AWS metadata services. The amount of sensitive information in this environment should be kept to a minimum, and you should always be mindful that any user capable of invoking workflows has access to this environment.
Some customers might attempt to partially mitigate these risks by implementing systems that automatically destroy the self-hosted runner after each job execution. However, this approach might not be as effective as intended, as there is no way to guarantee that a self-hosted runner only runs one job. Some jobs will use secrets as command-line arguments which can be seen by another job running on the same runner, such as `ps x -w`. This can lead to secret leakages.
Some customers might attempt to partially mitigate these risks by implementing systems that automatically destroy the self-hosted runner after each job execution. However, this approach might not be as effective as intended, as there is no way to guarantee that a self-hosted runner only runs one job. Some jobs will use secrets as command-line arguments which can be seen by another job running on the same runner, such as `ps x -w`. This can lead to secret leaks.
### Using just-in-time runners
@@ -379,7 +379,7 @@ A self-hosted runner can be added to various levels in your {% data variables.pr
### Authenticating to your cloud provider
If you are using {% data variables.product.prodname_actions %} to deploy to a cloud provider, or intend to use HashiCorp Vault for secret management, then its recommended that you consider using OpenID Connect to create short-lived, well-scoped access tokens for your workflow runs. For more information, see [AUTOTITLE](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect).
If you are using {% data variables.product.prodname_actions %} to deploy to a cloud provider, or intend to use HashiCorp Vault for secret management, then it's recommended that you consider using OpenID Connect to create short-lived, well-scoped access tokens for your workflow runs. For more information, see [AUTOTITLE](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect).
## Auditing {% data variables.product.prodname_actions %} events

View File

@@ -35,12 +35,7 @@ For an example {% data variables.product.prodname_actions %} workflow using the
For example, you can set `iss` to `https://token.actions.githubusercontent.com`, and the `repository` to something like "octo-org/octo-repo"`. This will ensure only Actions workflows from the specified repository will have access to your JFrog platform. The following is an example Claims JSON when configuring identity mappings.
```json copy
{
"iss": "https://token.actions.githubusercontent.com",
"repository": "octo-org/octo-repo"
}
```
{% data reusables.actions.jfrog-json-configuring-identity-mappings %}
## Adding the identity provider to JFrog

View File

@@ -342,6 +342,8 @@ on:
jobs:
cleanup:
runs-on: ubuntu-latest
permissions:
actions: write
steps:
- name: Cleanup
run: |

View File

@@ -109,21 +109,7 @@ env:
* {% data variables.product.prodname_dotcom %} ignores case when comparing strings.
* Objects and arrays are only considered equal when they are the same instance.
{% data variables.product.prodname_dotcom %} offers ternary operator like behaviour that you can use in expressions. By using a ternary operator in this way, you can dynamically set the value of an environment variable based on a condition, without having to write separate if-else blocks for each possible option.
### Example
{% raw %}
```yaml
env:
MY_ENV_VAR: ${{ github.ref == 'refs/heads/main' && 'value_for_main_branch' || 'value_for_other_branches' }}
```
{% endraw %}
In this example, we're using a ternary operator to set the value of the `MY_ENV_VAR` environment variable based on whether the {% data variables.product.prodname_dotcom %} reference is set to `refs/heads/main` or not. If it is, the variable is set to `value_for_main_branch`. Otherwise, it is set to `value_for_other_branches`.
It is important to note that the first value after the `&&` must be truthy. Otherwise, the value after the `||` will always be returned.
{% data variables.product.prodname_dotcom %} provides a way to create conditional logic in expressions using binary logical operators (`&&` and `||`). This pattern can be used to achieve similar functionality to the ternary operator (`?:`) found in many programming languages, while actually using only binary operators.
## Functions

View File

@@ -23,6 +23,18 @@ If you enable web commit signing, {% data variables.product.prodname_ghe_server
You can enable web commit signing, rotate the private key used for web commit signing, and disable web commit signing.
{% ifversion ghes > 3.16 %}
### About persistent commit signature verification
Persistent commit signature verification is related but separate from web commit signing. This feature ensures that the verified status of commits is retained, even if signing keys are changed or revoked.
Persistent commit signature verification helps maintain long-term integrity and trust in your repositorys commit history. However, you may choose to disable it in environments where minimizing disk usage is a priority, especially for large installations with a high number of verified commits.
For information about disabling persistent commit signature verification, see [AUTOTITLE](/admin/configuring-settings/configuring-user-applications-for-your-enterprise/disabling-persistent-commit-verification).
{% endif %}
## Enabling web commit signing
{% data reusables.enterprise_site_admin_settings.create-pgp-key-web-commit-signing %}

View File

@@ -0,0 +1,55 @@
---
title: Disabling persistent commit verification
shortTitle: Disable persistent commit verification
intro: 'You can disable persistent commit verification on {% data variables.product.prodname_ghe_server %} to reduce disk usage.'
versions:
ghes: '>=3.17'
type: how_to
topics:
- Access management
- Enterprise
- Fundamentals
- Identity
- Security
permissions: 'Site administrators'
---
## About persistent commit verification
When persistent commit verification is enabled, {% data variables.product.prodname_ghe_server %} stores a verification record alongside each commit when its signature is verified. This record ensures that verified commits maintain their verification status even if signing keys are later rotated, expired, or revoked. For more information about persistent commit verification, see [AUTOTITLE](/authentication/managing-commit-signature-verification/about-commit-signature-verification#persistent-commit-signature-verification).
By default, persistent commit verification is enabled on {% data variables.product.prodname_ghe_server %} 3.17 and later.
Each verified commit requires approximately 80 bytes of storage. For large installations with a large number of verified commits (e.g., hundreds of thousands or more), you may want to disable this feature to limit data growth.
## Disabling persistent commit verification
You can disable persistent commit verification for {% data variables.location.product_location %}.
1. In the administrative shell, run the following command.
```bash copy
ghe-config app.persist-commit-signature-verification.enabled false
```
1. Apply the configuration.
```bash copy
ghe-config-apply
```
## Enabling persistent commit verification
If you previously disabled persistent commit verification, you can re-enable it.
1. In the administrative shell, run the following command.
```bash copy
ghe-config app.persist-commit-signature-verification.enabled true
```
1. Apply the configuration.
```bash copy
ghe-config-apply
```

View File

@@ -16,6 +16,7 @@ children:
- /configuring-interactive-maps
- /managing-github-mobile-for-your-enterprise
- /verifying-or-approving-a-domain-for-your-enterprise
- /disabling-persistent-commit-verification
redirect_from:
- /admin/configuration/configuring-user-applications-for-your-enterprise
---

View File

@@ -1,6 +1,6 @@
---
title: About enterprise accounts for Copilot Business
intro: 'Learn about the options for creating an enterprise account to manage {% data variables.product.prodname_copilot_business_short %} licenses, without adopting {% data variables.product.prodname_enterprise %}.'
intro: 'Learn about the options for creating an enterprise account to manage {% data variables.copilot.copilot_business_short %} licenses, without adopting {% data variables.product.prodname_enterprise %}.'
versions:
ghec: '*'
topics:
@@ -12,15 +12,15 @@ redirect_from:
- /early-access/copilot/managing-copilot-business-licenses-with-an-enterprise-account
---
You can use an enterprise account to manage licenses for {% data variables.product.prodname_copilot_for_business %}, without adopting {% data variables.product.prodname_enterprise %}.
You can use an enterprise account to manage licenses for {% data variables.copilot.copilot_for_business %}, without adopting {% data variables.product.prodname_enterprise %}.
>[!NOTE] Access to this feature is currently managed by {% data variables.contact.contact_enterprise_sales %}.
## What is an enterprise account for {% data variables.product.prodname_copilot_business_short %}?
## What is an enterprise account for {% data variables.copilot.copilot_business_short %}?
To use {% data variables.product.prodname_copilot %}, a user must authenticate to an account on {% data variables.product.prodname_dotcom %} that has a license for {% data variables.product.prodname_copilot_short %}. Organizations and enterprises on {% data variables.product.prodname_dotcom %} can manage members' access to {% data variables.product.prodname_copilot_short %} through a {% data variables.product.prodname_copilot_business_short %} subscription.
To use {% data variables.product.prodname_copilot %}, a user must authenticate to an account on {% data variables.product.prodname_dotcom %} that has a license for {% data variables.product.prodname_copilot_short %}. Organizations and enterprises on {% data variables.product.prodname_dotcom %} can manage members' access to {% data variables.product.prodname_copilot_short %} through a {% data variables.copilot.copilot_business_short %} subscription.
If you don't already manage users through an organization or enterprise, you can create an enterprise account specifically for allocating {% data variables.product.prodname_copilot_business_short %} licenses.
If you don't already manage users through an organization or enterprise, you can create an enterprise account specifically for allocating {% data variables.copilot.copilot_business_short %} licenses.
* You'll only pay for the {% data variables.product.prodname_copilot_short %} licenses you assign. For pricing, see [AUTOTITLE](/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business).
* You won't pay for {% data variables.product.prodname_enterprise %} seats.
@@ -37,7 +37,7 @@ How you will add users to your enterprise and manage license assignment depends
If you request an enterprise with personal accounts:
* You'll **add users** to the enterprise by sending an invitation to their personal {% data variables.product.prodname_dotcom %} account.
* You'll **create teams** in the enterprise to manage which users receive {% data variables.product.prodname_copilot_business_short %} licenses. You can manage membership of the teams on {% data variables.product.prodname_dotcom %} or with the REST API.
* You'll **create teams** in the enterprise to manage which users receive {% data variables.copilot.copilot_business_short %} licenses. You can manage membership of the teams on {% data variables.product.prodname_dotcom %} or with the REST API.
* When users receive a license, they can authenticate to {% data variables.product.prodname_dotcom %} from their development environment and **gain access** to {% data variables.product.prodname_copilot_short %}.
* Optionally, you can configure **SAML single sign-on** (SSO), so that users must authenticate to an external identity system in addition to their personal account.
@@ -46,7 +46,7 @@ If you request an enterprise with personal accounts:
If you request an {% data variables.enterprise.prodname_emu_enterprise %}:
* You'll **add users** to the enterprise by provisioning {% data variables.enterprise.prodname_managed_users %} from an identity provider (IdP), using SCIM.
* You'll **create teams** in the enterprise to manage which users receive {% data variables.product.prodname_copilot_business_short %} licenses. You can manage membership of the teams from your IdP, on {% data variables.product.prodname_dotcom %}, or with the REST API.
* You'll **create teams** in the enterprise to manage which users receive {% data variables.copilot.copilot_business_short %} licenses. You can manage membership of the teams from your IdP, on {% data variables.product.prodname_dotcom %}, or with the REST API.
* When users receive a license, they can use single sign-on to authenticate to their {% data variables.product.prodname_dotcom %} account from their development environment and **gain access** to {% data variables.product.prodname_copilot_short %}.
## Limitations
@@ -60,7 +60,7 @@ If you request an {% data variables.enterprise.prodname_emu_enterprise %}:
## Getting started
To get started, you will work with {% data variables.contact.contact_enterprise_sales %} to create an enterprise account, then add users to your enterprise and assign {% data variables.product.prodname_copilot_business_short %} licenses.
To get started, you will work with {% data variables.contact.contact_enterprise_sales %} to create an enterprise account, then add users to your enterprise and assign {% data variables.copilot.copilot_business_short %} licenses.
See the setup guide for your chosen type of enterprise.

View File

@@ -1,6 +1,6 @@
---
title: Using a dedicated enterprise account for Copilot Business
intro: Get started with an enterprise account for managing {% data variables.product.prodname_copilot_business_short %} licenses.
intro: Get started with an enterprise account for managing {% data variables.copilot.copilot_business_short %} licenses.
versions:
ghec: '*'
children:

View File

@@ -14,7 +14,7 @@ redirect_from:
---
You can use an enterprise account to manage licenses for {% data variables.product.prodname_copilot_for_business %}, without adopting {% data variables.product.prodname_enterprise %}.
You can use an enterprise account to manage licenses for {% data variables.copilot.copilot_for_business %}, without adopting {% data variables.product.prodname_enterprise %}.
This article describes the setup for an **enterprise with managed users**. If you haven't chosen an enterprise type, see [AUTOTITLE](/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business).

View File

@@ -12,7 +12,7 @@ redirect_from:
- /early-access/copilot/using-copilot-business-without-github-enterprise-personal-accounts
---
You can use an enterprise account to manage licenses for {% data variables.product.prodname_copilot_for_business %}, without adopting {% data variables.product.prodname_enterprise %}.
You can use an enterprise account to manage licenses for {% data variables.copilot.copilot_for_business %}, without adopting {% data variables.product.prodname_enterprise %}.
This article describes the setup for an **enterprise with personal accounts**. If you haven't chosen an enterprise type, see [AUTOTITLE](/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business).

View File

@@ -92,7 +92,7 @@ Rate limits apply for requests to the REST API. See [AUTOTITLE](/rest/overview/r
### {% data variables.product.prodname_copilot %}
Your developers can access {% data variables.product.prodname_copilot %} if you grant them access to a {% data variables.product.prodname_copilot_business_short %} or {% data variables.product.prodname_copilot_enterprise_short %} subscription. {% data variables.enterprise.prodname_managed_users_caps %} cannot sign up for {% data variables.product.prodname_copilot_individuals_short %}.
Your developers can access {% data variables.product.prodname_copilot %} if you grant them access to a {% data variables.copilot.copilot_business_short %} or {% data variables.copilot.copilot_enterprise_short %} subscription. {% data variables.enterprise.prodname_managed_users_caps %} cannot sign up for {% data variables.copilot.copilot_individuals_short %}.
* Users must perform some additional setup to authenticate to their account from their development environment. See [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/using-github-copilot-with-an-account-on-ghecom).
* Certain {% data variables.product.prodname_copilot %} features are currently unavailable on {% data variables.enterprise.data_residency_site %}. See [AUTOTITLE](/admin/data-residency/feature-overview-for-github-enterprise-cloud-with-data-residency#currently-unavailable-features).

View File

@@ -26,8 +26,9 @@ The following features are currently unavailable on {% data variables.enterprise
| Maven and Gradle support for {% data variables.product.prodname_registry %} | Currently unavailable. | [AUTOTITLE](/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry) |
| {% data variables.product.prodname_importer %} (the "Import repository" button on {% data variables.product.prodname_dotcom_the_website %}) | Instead, the **{% data variables.product.prodname_importer_proper_name %}** is available to migrate data. See [AUTOTITLE](/migrations/using-github-enterprise-importer/understanding-github-enterprise-importer/about-github-enterprise-importer). | [AUTOTITLE](/migrations/importing-source-code/using-github-importer/about-github-importer) |
| {% data variables.product.prodname_copilot %} Workspaces | Currently unavailable | N/A |
| {% data variables.product.prodname_copilot_extensions %} | Currently unavailable | [AUTOTITLE](/copilot/using-github-copilot/using-extensions-to-integrate-external-tools-with-copilot-chat) |
| {% data variables.copilot.copilot_extensions %} | Currently unavailable | [AUTOTITLE](/copilot/using-github-copilot/using-extensions-to-integrate-external-tools-with-copilot-chat) |
| {% data variables.product.prodname_copilot_short %} Metrics API | Currently unavailable | [AUTOTITLE](/rest/copilot/copilot-metrics) |
| {% data variables.copilot.copilot_coding_agent %} | Currently unavailable | [AUTOTITLE](/copilot/using-github-copilot/coding-agent/about-assigning-tasks-to-copilot) |
| Restricting {% data variables.product.prodname_actions %} policies to verified creators | Currently unavailable | [AUTOTITLE](/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#allow-enterprise-and-select-non-enterprise-actions-and-reusable-workflows) |
| Some features currently in {% data variables.release-phases.public_preview %} or {% data variables.release-phases.private_preview %} | Certain features that are in a preview phase on {% data variables.product.prodname_dotcom_the_website %} may not be available on {% data variables.enterprise.data_residency_site %} | |
@@ -81,6 +82,7 @@ To allow people to use namespaces that match actions you have used from {% data
You can use {% data variables.product.prodname_github_connect %} to connect to {% data variables.enterprise.data_residency_site %} from {% data variables.product.prodname_ghe_server %}.
* {% data variables.product.prodname_server_statistics %} is not available.
* {% data variables.product.prodname_dotcom_the_website %} actions are not available.
* Automatic user license sync requires {% data variables.product.prodname_ghe_server %} version 3.15 or later.
To enable {% data variables.product.prodname_github_connect %}, you must configure your {% data variables.product.prodname_ghe_server %} instance to connect to your {% data variables.enterprise.data_residency_site %} subdomain. See [AUTOTITLE](/enterprise-server@latest/admin/configuring-settings/configuring-github-connect/enabling-github-connect-for-ghecom).

View File

@@ -130,8 +130,6 @@ You must allow:
### Required in Australia
* 20.213.236.72/29
* 20.53.178.216/29
* 20.213.241.72/29
* 20.11.90.48/29
* 20.5.34.240/28

View File

@@ -128,13 +128,13 @@ Across all of your enterprise's organizations, you can allow or disallow people
{% ifversion code-scanning-autofix %}
## Enforcing a policy to manage the use of {% data variables.product.prodname_copilot_autofix_short %} in your enterprise's repositories
## Enforcing a policy to manage the use of {% data variables.copilot.copilot_autofix_short %} in your enterprise's repositories
Across all of your enterprise's organizations, you can allow or disallow people with admin access to repositories to manage where {% data variables.product.prodname_copilot_autofix_short %} is enabled. {% data variables.product.prodname_GH_code_security %} must be enabled for the organization for this policy to take effect.
Across all of your enterprise's organizations, you can allow or disallow people with admin access to repositories to manage where {% data variables.copilot.copilot_autofix_short %} is enabled. {% data variables.product.prodname_GH_code_security %} must be enabled for the organization for this policy to take effect.
{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.policies-tab %}
{% data reusables.enterprise-accounts.code-security-and-analysis-policies %}
1. In the "Policies" section, under "{% data variables.product.prodname_copilot_autofix_short %}", select the dropdown menu and click a policy.
1. In the "Policies" section, under "{% data variables.copilot.copilot_autofix_short %}", select the dropdown menu and click a policy.
{% endif %}

View File

@@ -2,7 +2,7 @@
title: Managing requests for Copilot Business from organizations in your enterprise
intro: Learn how to view and satisfy requests to access Copilot from organizations owned by your enterprise.
permissions: Enterprise owners
product: Enterprise accounts with a subscription to {% data variables.product.prodname_copilot_for_business %}.
product: Enterprise accounts with a subscription to {% data variables.copilot.copilot_for_business %}.
versions:
ghec: '*'
type: how_to
@@ -13,13 +13,13 @@ topics:
shortTitle: Manage requests for Copilot
---
Organization owners might not have the necessary permissions to satisfy requests from members. For example, if an organization owner is not an enterprise owner, and {% data variables.product.prodname_copilot_for_business %} is not enabled for that organization, they will not have the permissions to approve requests for {% data variables.product.prodname_copilot_for_business %}.
Organization owners might not have the necessary permissions to satisfy requests from members. For example, if an organization owner is not an enterprise owner, and {% data variables.copilot.copilot_for_business %} is not enabled for that organization, they will not have the permissions to approve requests for {% data variables.copilot.copilot_for_business %}.
In these cases, when an organization member requests access to {% data variables.product.prodname_copilot_for_business %}, the organization owner will be prompted to ask the enterprise owners to enable {% data variables.product.prodname_copilot_short %} for the organization.
In these cases, when an organization member requests access to {% data variables.copilot.copilot_for_business %}, the organization owner will be prompted to ask the enterprise owners to enable {% data variables.product.prodname_copilot_short %} for the organization.
As an enterprise owner, you can view or dismiss these requests from your notifications page. You can approve the request by enabling {% data variables.product.prodname_copilot_short %} for the organization.
## Approving requests for {% data variables.product.prodname_copilot_for_business %}
## Approving requests for {% data variables.copilot.copilot_for_business %}
{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.policies-tab %}

View File

@@ -120,7 +120,16 @@ Before starting this section, ensure you have followed steps **1 to 4** in [AUTO
1. Click **Configure API integration**.
1. In the "API Token" field, enter the {% data variables.product.pat_v1 %} belonging to the setup user.
{% data reusables.scim.import-groups-unsupported %}
{% data reusables.scim.import-groups-unsupported %}
{% ifversion ghec %}
> [!IMPORTANT]
> For an enterprise on {% data variables.enterprise.data_residency %} (GHE.com), please enter the following URL in the **Base URL** field: {% raw %}`https://api.{subdomain}.ghe.com/scim/v2/enterprises/{subdomain}`{% endraw %} (ensuring to replace {% raw %}`{subdomain}`{% endraw %} with your enterprise's subdomain).
>
> **For example**: if your enterprise's subdomain is {% raw %}`acme`{% endraw %}, the base URL would be {% raw %}`https://api.acme.ghe.com/scim/v2/enterprises/acme`{% endraw %}.
{% endif %}
1. Click **Test API Credentials**. If the test is successful, a verification message will appear at the top of the screen.
1. To save the token, click **Save**.

View File

@@ -50,7 +50,7 @@ With {% data variables.product.prodname_emus %}, you can control the user accoun
## {% data variables.product.prodname_copilot %}
* {% data variables.enterprise.prodname_managed_users_caps %} cannot sign up for {% data variables.product.prodname_copilot_pro %} or {% data variables.product.prodname_copilot_free %}. To allow a managed user to use {% data variables.product.prodname_copilot_short %}, you must grant the user access to a {% data variables.product.prodname_copilot_business_short %} or {% data variables.product.prodname_copilot_enterprise_short %} subscription. See [AUTOTITLE](/copilot/about-github-copilot/what-is-github-copilot#getting-access-to-copilot).
* {% data variables.enterprise.prodname_managed_users_caps %} cannot sign up for {% data variables.copilot.copilot_pro %} or {% data variables.copilot.copilot_free %}. To allow a managed user to use {% data variables.product.prodname_copilot_short %}, you must grant the user access to a {% data variables.copilot.copilot_business_short %} or {% data variables.copilot.copilot_enterprise_short %} subscription. See [AUTOTITLE](/copilot/about-github-copilot/what-is-github-copilot#getting-access-to-copilot).
## {% data variables.product.prodname_pages %}

View File

@@ -39,7 +39,10 @@ Using an **incognito or private browsing window**:
1. Enable two-factor authentication (2FA), and save the recovery codes. See [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication).
> [!WARNING]
> All subsequent login attempts for the setup user account will require a successful 2FA challenge response or the use of an enterprise recovery code to complete authentication. To avoid being locked out of your account, after enabling single sign-on, save your enterprise recovery codes. See [AUTOTITLE](/admin/managing-iam/managing-recovery-codes-for-your-enterprise/downloading-your-enterprise-accounts-single-sign-on-recovery-codes#downloading-codes-for-an-enterprise-with-enterprise-managed-users).
> All subsequent login attempts for the setup user account will require a successful 2FA challenge response.
> [!IMPORTANT]
> If the enterprise account has enabled single sign-on and the setup user hasnt enabled 2FA, they must use an enterprise recovery code to authenticate. To avoid being locked out of your account, after enabling single sign-on, save your enterprise recovery codes. For more information, see [AUTOTITLE](/admin/managing-iam/managing-recovery-codes-for-your-enterprise/downloading-your-enterprise-accounts-single-sign-on-recovery-codes#downloading-codes-for-an-enterprise-with-enterprise-managed-users) and the related [changelog in our {% data variables.product.prodname_blog %}](https://github.blog/changelog/2025-01-17-setup-user-for-emu-enterprises-requires-2fa-or-use-of-a-recovery-code/).
{% data reusables.enterprise-accounts.emu-password-reset-session %}

View File

@@ -41,7 +41,7 @@ Administrators for the enterprise account can:
* Configure security, such as single sign-on, IP allow lists, SSH certificate authorities, and two-factor authentication
* Stream audit and Git events data
* Use internal repositories
* Access features like {% data variables.product.prodname_copilot_enterprise %} and {% data variables.product.prodname_AS %}{% ifversion ghas-products %} products{% endif %}
* Access features like {% data variables.copilot.copilot_enterprise %} and {% data variables.product.prodname_AS %}{% ifversion ghas-products %} products{% endif %}
* Enforce policies. See [AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/about-enterprise-policies).
{% ifversion ghec %}

View File

@@ -38,7 +38,7 @@ You'll **need help** creating an enterprise account if you require:
* {% data variables.product.prodname_ghe_server %}
* {% data variables.enterprise.data_residency %}
* Invoicing
* A dedicated enterprise for managing {% data variables.product.prodname_copilot_for_business %} licenses without adopting {% data variables.product.prodname_enterprise %}
* A dedicated enterprise for managing {% data variables.copilot.copilot_for_business %} licenses without adopting {% data variables.product.prodname_enterprise %}
In these cases, contact {% data variables.contact.contact_enterprise_sales %}.

View File

@@ -53,7 +53,7 @@ curl -L -H "Content-Type: application/json" -X PUT -u "api_key:xxxxxxx" https://
To verify that the Prometheus metrics exporter is enabled, use `curl` to query the `/metrics` endpoint on port 9103. For more information about the administrative ports, see [AUTOTITLE](/admin/configuring-settings/configuring-network-settings/network-ports#administrative-ports).
```shell
curl localhost:9103/metrics
curl 127.0.0.1:9103/metrics
```
If successful, the response will include metrics with the `collectd_` prefix.

View File

@@ -64,7 +64,7 @@ Your business can:
* Additional features such as SAML authentication and internal repositories. For a detailed list, see {% data variables.product.pricing_link %}.
* Extra allowances for usage-based products such as {% data variables.product.prodname_actions %}.
* An enterprise account, which provides a single place to manage billing and settings, enforce policies, and audit the people with access to your enterprise.
* The option to add {% ifversion ghas-products %}<!-- Enterprise is no longer a pre-requisite with the GHAS products release -->{% else %}{% data variables.product.prodname_GHAS %}, {% endif %}{% data variables.contact.premium_support %}, and {% data variables.product.prodname_copilot_enterprise %}.
* The option to add {% ifversion ghas-products %}<!-- Enterprise is no longer a pre-requisite with the GHAS products release -->{% else %}{% data variables.product.prodname_GHAS %}, {% endif %}{% data variables.contact.premium_support %}, and {% data variables.copilot.copilot_enterprise %}.
When businesses adopt {% data variables.product.prodname_enterprise %}, their return on investment (ROI) is high. For example, their developers **save 45 minutes per day**, and onboarding and **training time is reduced by 40%**. See [The Total Economic Impact of {% data variables.product.prodname_enterprise %}](https://resources.github.com/forrester/).

View File

@@ -29,7 +29,7 @@ To set up a trial, you must be signed in to a personal account. If you don't hav
The trial lasts for **{% data reusables.enterprise.ghec-trial-length %} days** and includes the following features.
* Access to **most** {% data variables.product.prodname_ghe_cloud %} features.
* {% data variables.product.prodname_copilot_for_business %} ({% data variables.product.prodname_dotcom_the_website %} trials only)
* {% data variables.copilot.copilot_for_business %} ({% data variables.product.prodname_dotcom_the_website %} trials only)
* {% data variables.product.prodname_GH_cs_and_sp %} ({% data variables.product.prodname_dotcom_the_website %} trials only)
* Access to the **new billing platform**.{% ifversion enhanced-billing-platform %} See [AUTOTITLE](/billing/using-the-new-billing-platform/about-the-new-billing-platform-for-enterprises).{% endif %}
* An **enterprise account**, which allows you to manage multiple organizations. See [AUTOTITLE](/enterprise-cloud@latest/get-started/learning-about-github/types-of-github-accounts).
@@ -40,7 +40,7 @@ Your trial **won't** include access to {% data variables.product.prodname_ghe_se
## Features not included in the trial
* {% data variables.product.prodname_github_codespaces %}
* {% data variables.product.prodname_copilot_enterprise %}
* {% data variables.copilot.copilot_enterprise %}
* {% data variables.product.prodname_sponsors %}
* Paid {% data variables.product.prodname_marketplace %} apps
* {% data variables.product.prodname_github_connect %}
@@ -51,7 +51,7 @@ If you invite an existing organization into your trial enterprise, **all of thes
## Do I need to provide a payment method?
You do not need to provide a payment method to start a trial. If you want to use {% data variables.product.prodname_copilot_business_short %} during the trial, you need to provide a credit card. You **won't** be charged for using {% data variables.product.prodname_copilot_business_short %} during the trial.
You do not need to provide a payment method to start a trial. If you want to use {% data variables.copilot.copilot_business_short %} during the trial, you need to provide a credit card. You **won't** be charged for using {% data variables.copilot.copilot_business_short %} during the trial.
## During the trial

View File

@@ -80,7 +80,7 @@ Check if you need to upgrade the following applications:
> [!NOTE]
> Hotpatches require a configuration run, which can cause a brief period of errors or unresponsiveness for some or all services on {% data variables.location.product_location %}. You are not required to enable maintenance mode during installation of a hotpatch, but doing so will guarantee that users see a maintenance page instead of errors or timeouts. See [AUTOTITLE](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode).
* Patch releases using an upgrade package typically require less than five minutes of downtime.
* Upgrading to a new feature release that include data migrations may cause a few hours of downtime, depending on storage performance and the amount of data that is migrated. During this time none of your users will be able to use the enterprise.
* Upgrading to a new feature release that includes data migrations may cause a few hours of downtime, depending on storage performance and the amount of data that is migrated. During this time none of your users will be able to use the enterprise.{% ifversion ghes > 3.16 %} You may notice that upgrades to a new feature release take less time. This is because selective database transitions will now run concurrently, with the number of concurrent workers defaulting to the number of CPU cores, up to a maximum of 16.{% endif %}
## Communicating your upgrade

View File

@@ -38,7 +38,7 @@ All listings should meet the following requirements, regardless of whether they
* Listings must have a relevant description of the application.
* Listings must specify a pricing plan.
* Apps must provide value to customers and integrate with the platform in some way beyond authentication.
* Apps must be publicly available in {% data variables.product.prodname_marketplace %} and cannot be in {% data variables.release-phases.public_preview %} or available by invite only, with the exception of {% data variables.product.prodname_copilot_extensions_short %}.
* Apps must be publicly available in {% data variables.product.prodname_marketplace %} and cannot be in {% data variables.release-phases.public_preview %} or available by invite only, with the exception of {% data variables.copilot.copilot_extensions_short %}.
* Apps must have webhook events set up to notify the publisher of any plan changes or cancellations using the {% data variables.product.prodname_marketplace %} API. For more information, see [AUTOTITLE](/apps/github-marketplace/using-the-github-marketplace-api-in-your-app).
For more information on providing a good customer experience, see [AUTOTITLE](/apps/github-marketplace/creating-apps-for-github-marketplace/customer-experience-best-practices-for-apps).
@@ -55,13 +55,13 @@ To protect your customers, we recommend that you also follow security best pract
{% data reusables.marketplace.free-apps-encouraged %}
## Requirements for {% data variables.product.prodname_copilot_extensions %}
## Requirements for {% data variables.copilot.copilot_extensions %}
{% data variables.product.prodname_copilot_extensions_short %} are essentially {% data variables.product.prodname_github_apps %} with additional read access to {% data variables.product.prodname_copilot_chat_short %}, integration with the {% data variables.product.prodname_copilot_short %} API, and optional integration into other LLMs.
{% data variables.copilot.copilot_extensions_short %} are essentially {% data variables.product.prodname_github_apps %} with additional read access to {% data variables.copilot.copilot_chat_short %}, integration with the {% data variables.product.prodname_copilot_short %} API, and optional integration into other LLMs.
To publish an extension, it must be owned by an organization account with Verified Creator status. For more information about the verification process or transferring ownership of your app, see [AUTOTITLE](/apps/github-marketplace/github-marketplace-overview/applying-for-publisher-verification-for-your-organization).
The requirements to publish a {% data variables.product.prodname_copilot_extension_short %} are the same as the requirements for free apps, with the following exceptions:
The requirements to publish a {% data variables.copilot.copilot_extension_short %} are the same as the requirements for free apps, with the following exceptions:
* Your extension must provide a clear and descriptive response to a prompt like "What can you do?" or "List your capabilities".
* Your extension can be in {% data variables.release-phases.public_preview %} as long as that is clearly communicated in the listing description. If you are using a waitlist, you must also include a link to sign up at the top of the description. Someone from the {% data variables.product.github %} review team will join the waitlist and email your technical lead requesting access for testing.
* You must include links to two videos that demonstrate the following:

View File

@@ -44,11 +44,11 @@ If you're interested in creating an app for {% data variables.product.prodname_m
{% data reusables.marketplace.github_apps_preferred %}, although you can list both OAuth and {% data variables.product.prodname_github_apps %} in {% data variables.product.prodname_marketplace %}. For more information, see [AUTOTITLE](/apps/oauth-apps/building-oauth-apps/differences-between-github-apps-and-oauth-apps) and [AUTOTITLE](/apps/creating-github-apps/about-creating-github-apps/migrating-oauth-apps-to-github-apps).
### {% data variables.product.prodname_copilot_extensions %}
### {% data variables.copilot.copilot_extensions %}
{% data reusables.copilot.copilot-extensions.copilot-extensions-intro %}
To learn more about {% data variables.product.prodname_copilot_extensions_short %}, see [AUTOTITLE](/copilot/github-copilot-chat/github-copilot-extensions/using-github-copilot-extensions).
To learn more about {% data variables.copilot.copilot_extensions_short %}, see [AUTOTITLE](/copilot/github-copilot-chat/github-copilot-extensions/using-github-copilot-extensions).
## Publishing an app to {% data variables.product.prodname_marketplace %} overview

View File

@@ -35,7 +35,7 @@ The events listed in your security log are triggered by your actions. Actions ar
| {% ifversion fpt or ghec %} |
| `billing` | Contains all activities related to your billing information. |
| `codespaces` | Contains all activities related to {% data variables.product.prodname_github_codespaces %}. For more information, see [AUTOTITLE](/codespaces/quickstart). |
| `copilot` | Contains all activities related to {% data variables.product.prodname_copilot_business_short %}. For more information, see [AUTOTITLE](/copilot/about-github-copilot/what-is-github-copilot). |
| `copilot` | Contains all activities related to {% data variables.copilot.copilot_business_short %}. For more information, see [AUTOTITLE](/copilot/about-github-copilot/what-is-github-copilot). |
| `marketplace_agreement_signature` | Contains all activities related to signing the {% data variables.product.prodname_marketplace %} Developer Agreement. |
| `marketplace_listing`| Contains all activities related to listing apps in {% data variables.product.prodname_marketplace %}. |
| {% endif %} |

View File

@@ -42,6 +42,10 @@ Signing commits differs from signing off on a commit. For more information about
| **Unverified** | The commit is signed but the signature could not be verified.
| No verification status | The commit is not signed.
{% endif %}
{% ifversion fpt or ghec or ghes > 3.16 %}
### Persistent commit signature verification
Regardless of the signature choice - GPG, SSH, or S/MIME - once a commit signature is verified, it remains verified within its repository's network. See [AUTOTITLE](/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories).
@@ -52,6 +56,12 @@ The verification record includes a timestamp marking when the verification was c
Persistent commit signature verification applies to new commits pushed to {% data variables.product.github %}. For any commits that predate this feature, a persistent record will be created the next time the commit's signature is verified on {% data variables.product.github %}, helping ensure that verified statuses remain stable and reliable across the repository's history.
{% ifversion ghes %}
For information about disabling persistent commit signature verification, see [AUTOTITLE](/admin/configuring-settings/configuring-user-applications-for-your-enterprise/disabling-persistent-commit-verification).
{% endif %}
#### Records persist even after revocation and expiration
Persistent commit signature verification reflects the verified state of a commit at the time of verification. This means that if a signing key is later revoked, expired, or otherwise altered, previously verified commits retain their verified status based on the record created during the initial verification. {% data variables.product.github %} will not re-verify previously signed commits or retroactively adjust their verification status in response to changes in the key's state. Organizations may need to manage key states directly to align with their security policies, especially if frequent key rotation or revocation is planned.

View File

@@ -141,7 +141,7 @@ The following example timeline demonstrates how the active committer count for {
| Date | Events during the month | Total committers | Effect on usage-based billing |
| :- | :- | -: | :- |
| <span style="white-space: nowrap;">April 15</span> | A member of your enterprise enables {% data variables.product.prodname_GH_cs_and_sp %} for repository **X**. Repository **X** has 50 committers over the past 90 days. | **50** | Billing begins for 50 committers. |
| <span style="white-space: nowrap;">May 1</span> | Developer **A** leaves the team working on repository **X**. Developer **A**'s contributions continue to count for 90 days. | **50** | No immediate change. Developer **A** continues to be billed until their contributions are inactive for 90 days. |
| <span style="white-space: nowrap;">May 1</span> | Developer **A** switches teams and stops committing to repository **X**. Developer **A**'s contributions continue to count for 90 days. | **50** | No immediate change. Developer **A** continues to be billed until their contributions are inactive for 90 days. |
| <span style="white-space: nowrap;">August 1</span> | Developer **A**'s contributions no longer count towards the licenses required, because 90 days have passed. | 50 - 1 =<br>**49** | Developer **A** is removed from the billing count, reducing the billable committers to 49. |
| <span style="white-space: nowrap;">August 15</span> | A member of your enterprise enables {% data variables.product.prodname_GH_cs_and_sp %} for a second repository, repository **Y**. In the last 90 days, a total of 20 developers contributed to that repository. Of those 20 developers, 10 also recently worked on repo **X** and do not require additional licenses. | 49 + 10 =<br>**59** | Billing increases to 59 committers, accounting for the 10 additional unique contributors. |
| <span style="white-space: nowrap;">August 16</span> | A member of your enterprise disables {% data variables.product.prodname_GH_cs_and_sp %} for repository **X**. Of the 49 developers who were working on repository **X**, 10 still also work on repository **Y**, which has a total of 20 developers contributing in the last 90 days. | 49 - 29 =<br>**20** | Billing for repository **X** continues until the end of the monthly billing cycle, but the overall billing count decreases to 20 committers for the next cycle. |

View File

@@ -18,13 +18,11 @@ shortTitle: Migrating to new GHAS SKUs
## New SKUs for {% data variables.product.prodname_AS %} features
<!-- expires 2025-05-31 -->
<!-- expires 2025-09-30 -->
<!-- On expiry, check with the stakeholder. If nothing else, remove the date from the start of this paragraph and check the information for Metered-billing users is still appropriate. Possibly the whole article can be deleted. Reference: release 5202 -->
{% data variables.product.prodname_AS %} features are also available under two separate stock keeping units (SKUs) for {% data variables.product.prodname_team %} and {% data variables.product.prodname_ghe_cloud %} users. {% data variables.product.prodname_ghe_server %} users can use the two new SKUs when upgrading to version 3.17.
From April 1, 2025, {% data variables.product.prodname_AS %} features are also available under two separate stock keeping units (SKUs) for {% data variables.product.prodname_team %} and {% data variables.product.prodname_ghe_cloud %} users. {% data variables.product.prodname_ghe_server %} users can use the two new SKUs when upgrading to version 3.17.
<!-- end expires 2025-05-31 -->
<!-- end expires 2025-09-30 -->
{% data reusables.advanced-security.ghas-products-bullets %}

View File

@@ -36,9 +36,9 @@ You can view the current license limits and usage for your enterprise.
* If you have a volume/subscription license, the number of licenses **available** to use is also displayed.
* If you run out of licenses, for volume/subscription only, the section is red and reports "Limit exceeded." You should either reduce your use or purchase more licenses.
1. Optionally, to see a detailed breakdown of usage per organization{% ifversion secret-scanning-user-owned-repos %} and user namespace when using {% data variables.product.prodname_emus %}{% endif %}, in the "{% data variables.product.prodname_GHAS %}" section click **More details**.
1. Optionally, to see a detailed breakdown of usage per organization{% ifversion secret-scanning-user-owned-repos %} and user namespace when using {% data variables.product.prodname_emus %}{% endif %}, in the "{% data variables.product.prodname_AS %}" section click **More details**.
In the "{% data variables.product.prodname_GHAS %}" section, you can see a summary of your current license usage, as well as the number of committers and unique committers for each organization{% ifversion secret-scanning-user-owned-repos %} and user namespace when using {% data variables.product.prodname_emus %}{% endif %}. The organizations{% ifversion secret-scanning-user-owned-repos %} and user namespaces{% endif %} in the billing table are sorted by the highest number of unique committers in descending order.
In the "{% data variables.product.prodname_AS %}" section, you can see a summary of your current license usage, as well as the number of committers and unique committers for each organization{% ifversion secret-scanning-user-owned-repos %} and user namespace when using {% data variables.product.prodname_emus %}{% endif %}. The organizations{% ifversion secret-scanning-user-owned-repos %} and user namespaces{% endif %} in the billing table are sorted by the highest number of unique committers in descending order.
1. Optionally, to see a detailed breakdown of usage by repositories within an organization, click an organization name to display the "Global code security settings" for the organization.
@@ -77,7 +77,7 @@ You can view the organization account's current license limits and usage.
{% data reusables.profile.org_settings %}
{% data reusables.organizations.billing_plans_or_licensing %}
The "{% data variables.product.prodname_GHAS %}" section shows details of the current usage.
The "{% data variables.product.prodname_AS %}" section shows details of the current usage.
{% endif %}
@@ -88,14 +88,14 @@ You can view the organization account's current license limits and usage.
## Downloading {% data variables.product.prodname_AS %} license usage information
You can download a CSV file with {% data variables.product.prodname_GHAS %} license usage information at both the {% data variables.enterprise.enterprise_and_org %} level. The CSV file contains information about each {% data variables.product.prodname_AS %} license that is in use, including:
You can download a CSV file with details of paid use of {% data variables.product.prodname_GHAS %} products at both the {% data variables.enterprise.enterprise_and_org %} level. The CSV file contains information about each {% data variables.product.prodname_AS %} license that is in use, including:
* The username of the person using the {% data variables.product.prodname_GHAS_cs_or_sp %} license
* The {% data variables.product.prodname_GH_cs_and_sp %}-enabled repositories where commits were made
* The organizations{% ifversion secret-scanning-user-owned-repos %}{% ifversion ghec %} and user namespaces for {% data variables.product.prodname_emus %}{% endif %}{% endif %} that people using licenses belong to
* The most recent commit dates and associated email addresses
You can use this information for insights into your {% data variables.product.prodname_AS %} usage, such as which members of your enterprise are using a license or how licenses are being consumed across your organizations.
You can use this information for insights into your paid use of {% data variables.product.prodname_AS %}, such as which members of your enterprise are using a license or how licenses are being consumed across your organizations.
You can download a CSV report of license usage through the {% data variables.product.github %} user interface or the REST API.
@@ -160,7 +160,7 @@ You can download a CSV report of license usage through the {% data variables.pro
## Using the REST API to download license and metered usage
You can retrieve {% data variables.product.prodname_AS %} usage information via the billing API.
You can retrieve information on paid use of {% data variables.product.prodname_AS %} with the billing API.
{% ifversion fpt or ghec %}

View File

@@ -12,24 +12,24 @@ redirect_from:
## {% data variables.product.prodname_copilot %} in your enterprise
Enterprises on {% data variables.product.prodname_ghe_cloud %} can subscribe to either {% data variables.product.prodname_copilot_for_business %} or {% data variables.product.prodname_copilot_enterprise %}, or a mixture of both across different organizations within an enterprise. Both plans are available on a monthly cycle, and pricing varies. For more information, see [AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-the-copilot-subscription-for-your-enterprise/about-billing-for-github-copilot-in-your-enterprise).
Enterprises on {% data variables.product.prodname_ghe_cloud %} can subscribe to either {% data variables.copilot.copilot_for_business %} or {% data variables.copilot.copilot_enterprise %}, or a mixture of both across different organizations within an enterprise. Both plans are available on a monthly cycle, and pricing varies. For more information, see [AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-the-copilot-subscription-for-your-enterprise/about-billing-for-github-copilot-in-your-enterprise).
## {% data variables.product.prodname_copilot %} in your organization
{% data variables.product.github %} bills {% data variables.product.prodname_copilot_business_short %} on a monthly cycle, for {% data variables.copilot.cfb_price_per_month %} per user per month. For more information, see [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).
{% data variables.product.github %} bills {% data variables.copilot.copilot_business_short %} on a monthly cycle, for {% data variables.copilot.cfb_price_per_month %} per user per month. For more information, see [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).
## {% data variables.product.prodname_copilot %} as an individual
{% data variables.product.prodname_copilot_pro %} and {% data variables.product.prodname_copilot_pro_plus %} plans are available on a monthly or yearly cycle:
{% data variables.copilot.copilot_pro %} and {% data variables.copilot.copilot_pro_plus %} plans are available on a monthly or yearly cycle:
* **{% data variables.product.prodname_copilot_pro_short %}**: {% data variables.copilot.cfi_price_per_month %} per calendar month or {% data variables.copilot.cfi_price_per_year %} per year.
* **{% data variables.product.prodname_copilot_pro_plus_short %}**: {% data variables.copilot.cpp_price_per_month %} per calendar month or {% data variables.copilot.cpp_price_per_year %} per year.
* **{% data variables.copilot.copilot_pro_short %}**: {% data variables.copilot.cfi_price_per_month %} per calendar month or {% data variables.copilot.cfi_price_per_year %} per year.
* **{% data variables.copilot.copilot_pro_plus_short %}**: {% data variables.copilot.cpp_price_per_month %} per calendar month or {% data variables.copilot.cpp_price_per_year %} per year.
See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-copilot-subscription/about-billing-for-github-copilot-individual).
> [!NOTE] {% data reusables.copilot.copilot-one-account %}
If you want to try {% data variables.product.prodname_copilot_short %} before subscribing, you can use {% data variables.product.prodname_copilot_free %} for a limited experience. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/about-github-copilot-free).
If you want to try {% data variables.product.prodname_copilot_short %} before subscribing, you can use {% data variables.copilot.copilot_free %} for a limited experience. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/about-github-copilot-free).
## Migrating between {% data variables.product.prodname_copilot_short %} plans
@@ -45,7 +45,7 @@ Some migrations cannot be completed through self-service options.
* **Non-enterprise to enterprise environment migrations**: When moving from standalone {% data variables.product.prodname_copilot_short %} plans to a {% data variables.product.prodname_enterprise %} environment, contact {% data variables.contact.contact_support_page %} or your account manager for assistance to avoid service interruption.
* **Changing between {% data variables.product.prodname_copilot_business_short %} and {% data variables.product.prodname_copilot_enterprise_short %}**: If you need to migrate between these plans within your enterprise and the option isn't available in your "Billing & Licensing" settings, contact {% data variables.contact.contact_support_page %} or your account manager for assistance.
* **Changing between {% data variables.copilot.copilot_business_short %} and {% data variables.copilot.copilot_enterprise_short %}**: If you need to migrate between these plans within your enterprise and the option isn't available in your "Billing & Licensing" settings, contact {% data variables.contact.contact_support_page %} or your account manager for assistance.
## Allowance usage for {% data variables.copilot.copilot_coding_agent %}
@@ -63,7 +63,7 @@ When {% data variables.product.prodname_copilot_short %} works on coding tasks,
* **Premium requests** from your account's monthly allowance of premium {% data variables.product.prodname_copilot_short %} requests.
This allowance of free premium requests is shared with other {% data variables.product.prodname_copilot_short %} features, such as {% data variables.product.prodname_copilot_chat_short %}.
This allowance of free premium requests is shared with other {% data variables.product.prodname_copilot_short %} features, such as {% data variables.copilot.copilot_chat_short %}.
When you use {% data variables.copilot.copilot_coding_agent %}, {% data variables.product.prodname_copilot_short %} may make multiple premium requests to complete a single task. This includes both user-initiated prompts and follow-up actions {% data variables.product.prodname_copilot_short %} takes on your behalf. The total premium requests used will depend on the complexity of the task and the number of steps involved. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/monitoring-usage-and-entitlements/avoiding-unexpected-copilot-costs).

View File

@@ -1,7 +1,7 @@
---
title: Managing billing for GitHub Copilot
shortTitle: GitHub Copilot
intro: '{% ifversion fpt %}You can set up a {% data variables.product.prodname_copilot %} subscription through your personal or organization account. You can modify or cancel your subscription at any time.{% endif %}{% ifversion ghec %}You can view your usage of {% data variables.product.prodname_copilot_for_business %}, and learn about how the costs are calculated.{% endif %}'
intro: '{% ifversion fpt %}You can set up a {% data variables.product.prodname_copilot %} subscription through your personal or organization account. You can modify or cancel your subscription at any time.{% endif %}{% ifversion ghec %}You can view your usage of {% data variables.copilot.copilot_for_business %}, and learn about how the costs are calculated.{% endif %}'
versions:
feature: copilot
redirect_from:

View File

@@ -40,7 +40,7 @@ If you use {% data variables.product.prodname_ghe_cloud %} through a Microsoft E
| {% data variables.product.prodname_github_codespaces %} usage | [AUTOTITLE](/billing/managing-billing-for-your-products/managing-billing-for-github-codespaces/about-billing-for-github-codespaces) | [AUTOTITLE](/billing/managing-billing-for-your-products/managing-billing-for-github-codespaces/about-billing-for-github-codespaces) |
| {% data variables.product.prodname_actions %} usage beyond the amounts included with your plan | [AUTOTITLE](/billing/managing-billing-for-github-actions/about-billing-for-github-actions) | [AUTOTITLE](/billing/managing-billing-for-github-actions/about-billing-for-github-actions#about-spending-limits) |
| {% data variables.product.prodname_registry %} usage beyond the amounts included with your plan | [AUTOTITLE](/billing/managing-billing-for-github-packages/about-billing-for-github-packages) | [AUTOTITLE](/billing/managing-billing-for-github-packages/about-billing-for-github-packages#about-spending-limits) |
| {% data variables.product.prodname_copilot_business_short %} usage | [AUTOTITLE](/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot-business-and-github-copilot-enterprise) | N/A |
| {% data variables.copilot.copilot_business_short %} usage | [AUTOTITLE](/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot-business-and-github-copilot-enterprise) | N/A |
| {% data variables.product.prodname_AS %} usage (only available with a trial of {% data variables.product.prodname_ghe_cloud %}) | [AUTOTITLE](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security#usage-based-billing-for-github-advanced-security) | N/A |
| {% data variables.product.prodname_enterprise %} usage | [AUTOTITLE](/billing/managing-your-billing/about-billing-for-your-enterprise) | N/A |
@@ -50,7 +50,7 @@ If you use {% data variables.product.prodname_ghe_cloud %} through a Microsoft E
If you link your {% data variables.product.company_short %} account to Azure, any usage-based costs starting from that point will be billed through Azure and charged on the 1st of each month. However, remaining {% data variables.product.company_short %} charges, for example charges for your {% data variables.product.prodname_dotcom %} plan, will still be billed on your usual billing date.
For example, you link your Azure subscription to your organization {% ifversion ghec %}or enterprise{% endif %} account on June 16th and you also have a {% data variables.product.prodname_copilot_for_business %} subscription. From that date onwards, any usage costs for {% data variables.product.prodname_copilot_business_short %} will be included in your Azure bill and charged on July 1st. However, any charges incurred before June 16th for {% data variables.product.prodname_copilot_business_short %} will be billed separately through {% data variables.product.company_short %} on your account's usual billing date.
For example, you link your Azure subscription to your organization {% ifversion ghec %}or enterprise{% endif %} account on June 16th and you also have a {% data variables.copilot.copilot_for_business %} subscription. From that date onwards, any usage costs for {% data variables.copilot.copilot_business_short %} will be included in your Azure bill and charged on July 1st. However, any charges incurred before June 16th for {% data variables.copilot.copilot_business_short %} will be billed separately through {% data variables.product.company_short %} on your account's usual billing date.
## Prerequisites

View File

@@ -43,7 +43,7 @@ For {% data variables.product.prodname_code_scanning %} alerts from {% data vari
{% ifversion copilot-chat-ghas-alerts %}
With a {% data variables.product.prodname_copilot_enterprise %} license, you can also ask {% data variables.product.prodname_copilot_chat %} for help to better understand {% data variables.product.prodname_code_scanning %} alerts in repositories in your organization. For more information, see [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-githubcom#asking-questions-about-alerts-from-github-advanced-security-features).
With a {% data variables.copilot.copilot_enterprise %} license, you can also ask {% data variables.copilot.copilot_chat %} for help to better understand {% data variables.product.prodname_code_scanning %} alerts in repositories in your organization. For more information, see [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-githubcom#asking-questions-about-alerts-from-github-advanced-security-features).
{% endif %}

View File

@@ -27,7 +27,7 @@ This article explains a high-level process focusing on enabling {% data variable
{% ifversion copilot-chat-ghas-alerts %}
With a {% data variables.product.prodname_copilot_enterprise %} license, you can also ask {% data variables.product.prodname_copilot_chat %} for help to better understand {% data variables.product.prodname_secret_scanning %} alerts in repositories in your organization. For more information, see [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-githubcom#asking-questions-about-alerts-from-github-advanced-security-features).
With a {% data variables.copilot.copilot_enterprise %} license, you can also ask {% data variables.copilot.copilot_chat %} for help to better understand {% data variables.product.prodname_secret_scanning %} alerts in repositories in your organization. For more information, see [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-githubcom#asking-questions-about-alerts-from-github-advanced-security-features).
{% endif %}

View File

@@ -308,7 +308,15 @@ If you added manual build steps for compiled languages and {% data variables.pro
## Building C/C++
{% ifversion codeql-no-build %}{% data variables.product.prodname_codeql %} supports build modes `autobuild` or `manual` for C/C++ code.
{% ifversion codeql-no-build %}{% data variables.product.prodname_codeql %} supports build modes {% ifversion codeql-no-build-c-cpp %}`none`, {% endif %}`autobuild` or `manual` for C/C++ code.
{% ifversion codeql-no-build-c-cpp %}
When you enable default setup for a repository that contains C/C++ code, the build mode is set to `none` automatically.
>[!NOTE] Support of build mode `none` for C/C++ codebases is currently in {% data variables.release-phases.public_preview %} and subject to change.
{% endif %}
### Autobuild summary for C/C++{% endif %}

View File

@@ -29,7 +29,7 @@ If {% data variables.product.prodname_code_scanning %} finds a potential vulnera
{% ifversion code-scanning-autofix %}
{% data variables.product.prodname_copilot_autofix %} will suggest fixes for alerts from {% data variables.product.prodname_code_scanning %} analysis in private repositories, allowing developers to prevent and reduce vulnerabilities with less effort. For more information, see [AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/responsible-use-autofix-code-scanning).
{% data variables.copilot.copilot_autofix %} will suggest fixes for alerts from {% data variables.product.prodname_code_scanning %} analysis in private repositories, allowing developers to prevent and reduce vulnerabilities with less effort. For more information, see [AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/responsible-use-autofix-code-scanning).
{% endif %}

View File

@@ -26,13 +26,13 @@ By default, {% data variables.product.prodname_code_scanning %} analyzes your co
{% ifversion code-scanning-autofix %}
You can use {% data variables.product.prodname_copilot_autofix %} to generate fixes automatically for {% data variables.product.prodname_code_scanning %} alerts, including {% data variables.product.prodname_codeql %} alerts. For more information, see [AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/resolving-code-scanning-alerts#generating-suggested-fixes-for-code-scanning-alerts).
You can use {% data variables.copilot.copilot_autofix %} to generate fixes automatically for {% data variables.product.prodname_code_scanning %} alerts, including {% data variables.product.prodname_codeql %} alerts. For more information, see [AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/resolving-code-scanning-alerts#generating-suggested-fixes-for-code-scanning-alerts).
{% endif %}
{% ifversion copilot-chat-ghas-alerts %}
With a {% data variables.product.prodname_copilot_enterprise %} license, you can also ask {% data variables.product.prodname_copilot_chat %} for help to better understand {% data variables.product.prodname_code_scanning %} alerts in repositories in your organization. For more information, see [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-githubcom#asking-questions-about-alerts-from-github-advanced-security-features).
With a {% data variables.copilot.copilot_enterprise %} license, you can also ask {% data variables.copilot.copilot_chat %} for help to better understand {% data variables.product.prodname_code_scanning %} alerts in repositories in your organization. For more information, see [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-githubcom#asking-questions-about-alerts-from-github-advanced-security-features).
{% endif %}

View File

@@ -45,9 +45,9 @@ For more information, see [AUTOTITLE](/code-security/code-scanning/managing-code
{% ifversion copilot-chat-ghas-alerts %}
## Asking {% data variables.product.prodname_copilot_chat %} about {% data variables.product.prodname_code_scanning %} alerts
## Asking {% data variables.copilot.copilot_chat %} about {% data variables.product.prodname_code_scanning %} alerts
With a {% data variables.product.prodname_copilot_enterprise %} license, you can ask {% data variables.product.prodname_copilot_chat_short %} for help to better understand security alerts, including {% data variables.product.prodname_code_scanning %} alerts, in repositories in your organization. For more information, see [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-githubcom#asking-questions-about-alerts-from-github-advanced-security-features).
With a {% data variables.copilot.copilot_enterprise %} license, you can ask {% data variables.copilot.copilot_chat_short %} for help to better understand security alerts, including {% data variables.product.prodname_code_scanning %} alerts, in repositories in your organization. For more information, see [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-githubcom#asking-questions-about-alerts-from-github-advanced-security-features).
{% endif %}

View File

@@ -28,8 +28,8 @@ In addition to the benefit of removing an important security problem from your o
* You have a campaign manager on the security team to collaborate with and a specific contact link for discussing campaign activities.
* You know that you are fixing a security alert that is important to the company.
* Potentially, you may have access to targeted training materials.{% ifversion security-campaigns-autofix %}
* You don't need to request a {% data variables.product.prodname_copilot_autofix %} suggestion, it is already available as a starting point.{% endif %}{% ifversion copilot %}
* If you have access to {% data variables.product.prodname_copilot_chat %}, you can ask questions about the alert and the suggested fix.{% endif %}
* You don't need to request a {% data variables.copilot.copilot_autofix %} suggestion, it is already available as a starting point.{% endif %}{% ifversion copilot %}
* If you have access to {% data variables.copilot.copilot_chat %}, you can ask questions about the alert and the suggested fix.{% endif %}
* You are improving and demonstrating your knowledge of secure coding.
Adopting a few key best practices can help you participate successfully in a campaign.
@@ -82,17 +82,17 @@ When fixing security alerts as part of a campaign, it may be helpful to group an
{% ifversion code-scanning-autofix %}
### {% data variables.product.prodname_copilot_autofix_short %}
### {% data variables.copilot.copilot_autofix_short %}
{% data variables.product.prodname_copilot_autofix_short %} is automatically triggered for alerts that are included in a campaign, meaning that where possible, fixes are automatically generated for you. You can commit the suggested fix to resolve the alert and then verify that continuous integration testing (CI) for the codebase is still passing. See [AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/fixing-alerts-in-security-campaign).
{% data variables.copilot.copilot_autofix_short %} is automatically triggered for alerts that are included in a campaign, meaning that where possible, fixes are automatically generated for you. You can commit the suggested fix to resolve the alert and then verify that continuous integration testing (CI) for the codebase is still passing. See [AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/fixing-alerts-in-security-campaign).
### {% data variables.product.prodname_copilot_chat_short %}
### {% data variables.copilot.copilot_chat_short %}
{% endif %}
You can ask {% data variables.product.prodname_copilot_chat_short %} for help in understanding the vulnerability, the suggested fix, and how to test that the fix is comprehensive. To access {% data variables.product.prodname_copilot_chat_short %}, navigate to https://github.com/copilot.
You can ask {% data variables.copilot.copilot_chat_short %} for help in understanding the vulnerability, the suggested fix, and how to test that the fix is comprehensive. To access {% data variables.copilot.copilot_chat_short %}, navigate to https://github.com/copilot.
Alternatively, when viewing a specific alert, in the top right corner of the page, click the {% data variables.product.prodname_copilot_chat_short %} icon ({% octicon "copilot" aria-hidden="true" aria-label="copilot" %}) to open a chat window, and ask {% data variables.product.prodname_copilot_short %} questions about the alert.
Alternatively, when viewing a specific alert, in the top right corner of the page, click the {% data variables.copilot.copilot_chat_short %} icon ({% octicon "copilot" aria-hidden="true" aria-label="copilot" %}) to open a chat window, and ask {% data variables.product.prodname_copilot_short %} questions about the alert.
For example:
@@ -102,7 +102,7 @@ For example:
```
If you don't already have access to {% data variables.product.prodname_copilot_chat_short %} through your organization{% ifversion ghec %} or enterprise{% endif %}, you can sign up to {% data variables.product.prodname_copilot_free %}. For more information, see [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-copilot-free/accessing-github-copilot-free).
If you don't already have access to {% data variables.copilot.copilot_chat_short %} through your organization{% ifversion ghec %} or enterprise{% endif %}, you can sign up to {% data variables.copilot.copilot_free %}. For more information, see [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-copilot-free/accessing-github-copilot-free).
{% endif %}

View File

@@ -2,7 +2,7 @@
title: Disabling Copilot Autofix for code scanning
shortTitle: Disable Copilot Autofix
allowTitleToDifferFromFilename: true
intro: You can choose to disallow {% data variables.product.prodname_copilot_autofix %} for an enterprise or disable {% data variables.product.prodname_copilot_autofix %} at the organization and repository level.
intro: You can choose to disallow {% data variables.copilot.copilot_autofix %} for an enterprise or disable {% data variables.copilot.copilot_autofix %} at the organization and repository level.
product: '{% data reusables.rai.code-scanning.gated-feature-autofix %}'
versions:
feature: code-scanning-autofix
@@ -14,47 +14,47 @@ topics:
- AI
---
## About disabling {% data variables.product.prodname_copilot_autofix_short %} for {% data variables.product.prodname_code_scanning %}
## About disabling {% data variables.copilot.copilot_autofix_short %} for {% data variables.product.prodname_code_scanning %}
{% data variables.product.prodname_copilot_autofix %} is a {% data variables.product.prodname_copilot %}-powered expansion of {% data variables.product.prodname_code_scanning %}. It provides users with targeted recommendations to help them fix {% data variables.product.prodname_code_scanning %} alerts (including {% data variables.product.prodname_codeql %} alerts) so they can avoid introducing new security vulnerabilities. To learn more about {% data variables.product.prodname_copilot_autofix_short %} for {% data variables.product.prodname_code_scanning %}, see [AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/responsible-use-autofix-code-scanning).
{% data variables.copilot.copilot_autofix %} is a {% data variables.product.prodname_copilot %}-powered expansion of {% data variables.product.prodname_code_scanning %}. It provides users with targeted recommendations to help them fix {% data variables.product.prodname_code_scanning %} alerts (including {% data variables.product.prodname_codeql %} alerts) so they can avoid introducing new security vulnerabilities. To learn more about {% data variables.copilot.copilot_autofix_short %} for {% data variables.product.prodname_code_scanning %}, see [AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/responsible-use-autofix-code-scanning).
{% data reusables.rai.code-scanning.copilot-autofix-note %}
{% data variables.product.prodname_copilot_autofix_short %} is allowed by default and enabled for every repository that uses {% data variables.product.prodname_codeql %}, regardless of whether it uses default or advanced setup for {% data variables.product.prodname_code_scanning %}. Administrators at the enterprise, organization and repository levels can choose to opt out and disable {% data variables.product.prodname_copilot_autofix_short %}.
{% data variables.copilot.copilot_autofix_short %} is allowed by default and enabled for every repository that uses {% data variables.product.prodname_codeql %}, regardless of whether it uses default or advanced setup for {% data variables.product.prodname_code_scanning %}. Administrators at the enterprise, organization and repository levels can choose to opt out and disable {% data variables.copilot.copilot_autofix_short %}.
Note that disabling {% data variables.product.prodname_copilot_autofix_short %} at any level will close all open {% data variables.product.prodname_copilot_autofix_short %} comments. If {% data variables.product.prodname_copilot_autofix_short %} is disabled and then subsequently enabled, {% data variables.product.prodname_copilot_autofix_short %} won't automatically suggest fixes for any pull requests that are already open. The suggestions will only be generated for any pull requests that are opened after {% data variables.product.prodname_copilot_autofix_short %} is enabled, or after re-running {% data variables.product.prodname_code_scanning %} analysis on existing pull requests.
Note that disabling {% data variables.copilot.copilot_autofix_short %} at any level will close all open {% data variables.copilot.copilot_autofix_short %} comments. If {% data variables.copilot.copilot_autofix_short %} is disabled and then subsequently enabled, {% data variables.copilot.copilot_autofix_short %} won't automatically suggest fixes for any pull requests that are already open. The suggestions will only be generated for any pull requests that are opened after {% data variables.copilot.copilot_autofix_short %} is enabled, or after re-running {% data variables.product.prodname_code_scanning %} analysis on existing pull requests.
## Blocking use of {% data variables.product.prodname_copilot_autofix_short %} for an enterprise
## Blocking use of {% data variables.copilot.copilot_autofix_short %} for an enterprise
Enterprise administrators can disallow {% data variables.product.prodname_copilot_autofix_short %} for their enterprise. If you disallow {% data variables.product.prodname_copilot_autofix_short %} for an enterprise, {% data variables.product.prodname_copilot_autofix_short %} cannot be enabled for any organizations or repositories within the enterprise.
Enterprise administrators can disallow {% data variables.copilot.copilot_autofix_short %} for their enterprise. If you disallow {% data variables.copilot.copilot_autofix_short %} for an enterprise, {% data variables.copilot.copilot_autofix_short %} cannot be enabled for any organizations or repositories within the enterprise.
Note that allowing {% data variables.product.prodname_copilot_autofix_short %} for an enterprise does not enforce enablement of {% data variables.product.prodname_copilot_autofix_short %}, but means that organization and repository administrators will have the option to enable or disable {% data variables.product.prodname_copilot_autofix_short %}.
Note that allowing {% data variables.copilot.copilot_autofix_short %} for an enterprise does not enforce enablement of {% data variables.copilot.copilot_autofix_short %}, but means that organization and repository administrators will have the option to enable or disable {% data variables.copilot.copilot_autofix_short %}.
Disallowing {% data variables.product.prodname_copilot_autofix_short %} at the enterprise level will remove all open {% data variables.product.prodname_copilot_autofix_short %} comments across all repositories of all organizations within the enterprise.
Disallowing {% data variables.copilot.copilot_autofix_short %} at the enterprise level will remove all open {% data variables.copilot.copilot_autofix_short %} comments across all repositories of all organizations within the enterprise.
{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.policies-tab %}
{% data reusables.enterprise-accounts.code-security-and-analysis-policies %}
1. Under "{% data variables.product.prodname_copilot_autofix_short %}", use the dropdown menu to choose "Not allowed."
1. Under "{% data variables.copilot.copilot_autofix_short %}", use the dropdown menu to choose "Not allowed."
## Disabling {% data variables.product.prodname_copilot_autofix_short %} for an organization
## Disabling {% data variables.copilot.copilot_autofix_short %} for an organization
If {% data variables.product.prodname_copilot_autofix_short %} is allowed at the enterprise level, organization administrators have the option to disable {% data variables.product.prodname_copilot_autofix_short %} for an organization. If you disable {% data variables.product.prodname_copilot_autofix_short %} for an organization, {% data variables.product.prodname_copilot_autofix_short %} cannot be enabled for any repositories within the organization.
If {% data variables.copilot.copilot_autofix_short %} is allowed at the enterprise level, organization administrators have the option to disable {% data variables.copilot.copilot_autofix_short %} for an organization. If you disable {% data variables.copilot.copilot_autofix_short %} for an organization, {% data variables.copilot.copilot_autofix_short %} cannot be enabled for any repositories within the organization.
Note that disabling {% data variables.product.prodname_copilot_autofix_short %} at the organization level will remove all open {% data variables.product.prodname_copilot_autofix_short %} comments across all repositories in the organization.
Note that disabling {% data variables.copilot.copilot_autofix_short %} at the organization level will remove all open {% data variables.copilot.copilot_autofix_short %} comments across all repositories in the organization.
{% data reusables.profile.access_org %}
{% data reusables.profile.org_settings %}
{% data reusables.security-configurations.display-global-settings %}
1. Under the "{% data variables.product.prodname_code_scanning_caps %}" section, deselect **{% data variables.product.prodname_copilot_autofix_short %}** or **{% data variables.product.prodname_copilot_autofix_short %} for third-party tools**.
1. Under the "{% data variables.product.prodname_code_scanning_caps %}" section, deselect **{% data variables.copilot.copilot_autofix_short %}** or **{% data variables.copilot.copilot_autofix_short %} for third-party tools**.
For more information about configuring global {% data variables.product.prodname_code_scanning %} settings, see [AUTOTITLE](/code-security/securing-your-organization/enabling-security-features-in-your-organization/configuring-global-security-settings-for-your-organization#configuring-global-code-scanning-settings).
## Disabling {% data variables.product.prodname_copilot_autofix_short %} for a repository
## Disabling {% data variables.copilot.copilot_autofix_short %} for a repository
If {% data variables.product.prodname_copilot_autofix_short %} is allowed at the enterprise level and enabled at the organization level, repository administrators have the option to disable {% data variables.product.prodname_copilot_autofix_short %} for a repository. Disabling {% data variables.product.prodname_copilot_autofix_short %} at the repository level will remove all open {% data variables.product.prodname_copilot_autofix_short %} comments across the repository.
If {% data variables.copilot.copilot_autofix_short %} is allowed at the enterprise level and enabled at the organization level, repository administrators have the option to disable {% data variables.copilot.copilot_autofix_short %} for a repository. Disabling {% data variables.copilot.copilot_autofix_short %} at the repository level will remove all open {% data variables.copilot.copilot_autofix_short %} comments across the repository.
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-settings %}
{% data reusables.repositories.navigate-to-code-security-and-analysis %}
1. In the "{% data variables.product.UI_code_security_scanning %}" section, deselect **{% data variables.product.prodname_copilot_autofix_short %}** or **{% data variables.product.prodname_copilot_autofix_short %} for third-party tools**.
1. In the "{% data variables.product.UI_code_security_scanning %}" section, deselect **{% data variables.copilot.copilot_autofix_short %}** or **{% data variables.copilot.copilot_autofix_short %} for third-party tools**.

View File

@@ -47,9 +47,9 @@ If you want to see the code that triggered the security alert and the suggested
{% ifversion copilot %}
## Using {% data variables.product.prodname_copilot_chat %} for secure coding
## Using {% data variables.copilot.copilot_chat %} for secure coding
If you have access to {% data variables.product.prodname_copilot_chat_short %} then you can ask the AI questions about the vulnerability, the suggested fix, and how to test that the fix is comprehensive.
If you have access to {% data variables.copilot.copilot_chat_short %} then you can ask the AI questions about the vulnerability, the suggested fix, and how to test that the fix is comprehensive.
> [!TIP]
> {% data reusables.copilot.semantic-index-info %}

View File

@@ -26,9 +26,9 @@ topics:
{% ifversion copilot-chat-ghas-alerts %}
## Asking {% data variables.product.prodname_copilot_chat %} about {% data variables.product.prodname_code_scanning %} alerts
## Asking {% data variables.copilot.copilot_chat %} about {% data variables.product.prodname_code_scanning %} alerts
With a {% data variables.product.prodname_copilot_enterprise %} license, you can ask {% data variables.product.prodname_copilot_chat_short %} for help to better understand security alerts, including {% data variables.product.prodname_code_scanning %} alerts, in repositories in your organization. For more information, see [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-githubcom#asking-questions-about-alerts-from-github-advanced-security-features).
With a {% data variables.copilot.copilot_enterprise %} license, you can ask {% data variables.copilot.copilot_chat_short %} for help to better understand security alerts, including {% data variables.product.prodname_code_scanning %} alerts, in repositories in your organization. For more information, see [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-githubcom#asking-questions-about-alerts-from-github-advanced-security-features).
{% endif %}
@@ -36,7 +36,7 @@ With a {% data variables.product.prodname_copilot_enterprise %} license, you can
## Generating suggested fixes for {% data variables.product.prodname_code_scanning %} alerts
{% data variables.product.prodname_copilot_autofix %} can generate fixes for alerts identified by {% data variables.product.prodname_code_scanning %} analysis. Most {% data variables.product.prodname_codeql %} alert types are supported and also some alerts from third-party tools. For more information, see [AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/responsible-use-autofix-code-scanning).
{% data variables.copilot.copilot_autofix %} can generate fixes for alerts identified by {% data variables.product.prodname_code_scanning %} analysis. Most {% data variables.product.prodname_codeql %} alert types are supported and also some alerts from third-party tools. For more information, see [AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/responsible-use-autofix-code-scanning).
{% data reusables.rai.code-scanning.copilot-autofix-note %}
@@ -44,7 +44,7 @@ With a {% data variables.product.prodname_copilot_enterprise %} license, you can
{% data reusables.repositories.sidebar-security %}
{% data reusables.repositories.sidebar-code-scanning-alerts %}
1. Click the name of an alert.
1. If {% data variables.product.prodname_copilot_autofix_short %} can suggest a fix, at the top of the page, click **{% octicon "shield-check" aria-hidden="true" aria-label="shield-check" %} Generate fix**.
1. If {% data variables.copilot.copilot_autofix_short %} can suggest a fix, at the top of the page, click **{% octicon "shield-check" aria-hidden="true" aria-label="shield-check" %} Generate fix**.
1. Once the suggested fix has been generated, at the bottom of the page, you can click **Create PR with fix** to automatically generate a pull request with the suggested fix.
A new branch is created from the default branch, the generated fix is committed and a draft pull request is created. You can test and edit the suggested fix as you would with any other fix.

View File

@@ -16,15 +16,15 @@ redirect_from:
- /code-security/code-scanning/managing-code-scanning-alerts/about-autofix-for-codeql-code-scanning
---
## About {% data variables.product.prodname_copilot_autofix_short %} for {% data variables.product.prodname_code_scanning %}
## About {% data variables.copilot.copilot_autofix_short %} for {% data variables.product.prodname_code_scanning %}
{% data variables.product.prodname_copilot_autofix %} is an expansion of {% data variables.product.prodname_code_scanning %} that provides users with targeted recommendations to help them fix {% data variables.product.prodname_code_scanning %} alerts so they can avoid introducing new security vulnerabilities. The potential fixes are generated automatically by large language models (LLMs) using data from the codebase and from {% data variables.product.prodname_code_scanning %} analysis. {% data variables.product.prodname_copilot_autofix %} is available for {% data variables.product.prodname_codeql %} analysis, and supports the third-party tool ESLint (third-party support is in {% data variables.release-phases.public_preview %} and subject to change).
{% data variables.copilot.copilot_autofix %} is an expansion of {% data variables.product.prodname_code_scanning %} that provides users with targeted recommendations to help them fix {% data variables.product.prodname_code_scanning %} alerts so they can avoid introducing new security vulnerabilities. The potential fixes are generated automatically by large language models (LLMs) using data from the codebase and from {% data variables.product.prodname_code_scanning %} analysis. {% data variables.copilot.copilot_autofix %} is available for {% data variables.product.prodname_codeql %} analysis, and supports the third-party tool ESLint (third-party support is in {% data variables.release-phases.public_preview %} and subject to change).
{% data reusables.rai.code-scanning.copilot-autofix-note %}
{% data variables.product.prodname_copilot_autofix_short %} generates potential fixes that are relevant to the existing source code and translates the description and location of an alert into code changes that may fix the alert. {% data variables.product.prodname_copilot_autofix_short %} uses internal {% data variables.product.prodname_copilot %} APIs interfacing with the large language model {% data variables.copilot.copilot_gpt_4o %} from OpenAI, which has sufficient generative capabilities to produce both suggested fixes in code and explanatory text for those fixes.
{% data variables.copilot.copilot_autofix_short %} generates potential fixes that are relevant to the existing source code and translates the description and location of an alert into code changes that may fix the alert. {% data variables.copilot.copilot_autofix_short %} uses internal {% data variables.product.prodname_copilot %} APIs interfacing with the large language model {% data variables.copilot.copilot_gpt_4o %} from OpenAI, which has sufficient generative capabilities to produce both suggested fixes in code and explanatory text for those fixes.
{% data variables.product.prodname_copilot_autofix_short %} is allowed by default and enabled for every repository using {% data variables.product.prodname_codeql %}, but you can choose to opt out and disable {% data variables.product.prodname_copilot_autofix_short %}. To learn how to disable {% data variables.product.prodname_copilot_autofix_short %} at the enterprise, organization and repository levels, see [AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/disabling-autofix-for-code-scanning).
{% data variables.copilot.copilot_autofix_short %} is allowed by default and enabled for every repository using {% data variables.product.prodname_codeql %}, but you can choose to opt out and disable {% data variables.copilot.copilot_autofix_short %}. To learn how to disable {% data variables.copilot.copilot_autofix_short %} at the enterprise, organization and repository levels, see [AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/disabling-autofix-for-code-scanning).
In an organization's security overview dashboard, you can view the total number of code suggestions generated on open and closed pull requests in the organization for a given time period. For more information, see [AUTOTITLE](/code-security/security-overview/viewing-security-insights#autofix-suggestions).
@@ -32,17 +32,17 @@ In an organization's security overview dashboard, you can view the total number
{% data variables.product.prodname_code_scanning_caps %} users can already see security alerts to analyze their pull requests. However, developers often have little training in secure coding so fixing these alerts requires substantial effort. They must first read and understand the alert location and description, and then use that understanding to edit the source code to fix the vulnerability.
{% data variables.product.prodname_copilot_autofix_short %} lowers the barrier of entry to developers by combining information on best practices with details of the codebase and alert to suggest a potential fix to the developer. Instead of starting with a search for information about the vulnerability, the developer starts with a code suggestion that demonstrates a potential solution for their codebase. The developer evaluates the potential fix to determine whether it is the best solution for their codebase and to ensure that it maintains the intended behavior.
{% data variables.copilot.copilot_autofix_short %} lowers the barrier of entry to developers by combining information on best practices with details of the codebase and alert to suggest a potential fix to the developer. Instead of starting with a search for information about the vulnerability, the developer starts with a code suggestion that demonstrates a potential solution for their codebase. The developer evaluates the potential fix to determine whether it is the best solution for their codebase and to ensure that it maintains the intended behavior.
After committing a suggested fix or modified fix, the developer should always verify that continuous integration testing (CI) for the codebase continues to pass and that the alert is shown as resolved before they merge their pull request.
## Supported languages for {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %}
{% data variables.product.prodname_copilot_autofix_short %} supports fix generation for a subset of queries included in the default and security-extended {% data variables.product.prodname_codeql %} query suites for {% data variables.code-scanning.codeql_autofix_languages %}. For more information on these query suites, see [AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/codeql-query-suites#built-in-codeql-query-suites).
{% data variables.copilot.copilot_autofix_short %} supports fix generation for a subset of queries included in the default and security-extended {% data variables.product.prodname_codeql %} query suites for {% data variables.code-scanning.codeql_autofix_languages %}. For more information on these query suites, see [AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/codeql-query-suites#built-in-codeql-query-suites).
## Suggestion generation process
When {% data variables.product.prodname_copilot_autofix_short %} is enabled for a repository, {% data variables.product.prodname_code_scanning %} alerts that are identified send input to the LLM. If the LLM can generate a potential fix, the fix is shown as a suggestion.
When {% data variables.copilot.copilot_autofix_short %} is enabled for a repository, {% data variables.product.prodname_code_scanning %} alerts that are identified send input to the LLM. If the LLM can generate a potential fix, the fix is shown as a suggestion.
{% data variables.product.prodname_dotcom %} sends the LLM a variety of data from the {% data variables.product.prodname_code_scanning %} analysis. For example:
@@ -52,13 +52,13 @@ When {% data variables.product.prodname_copilot_autofix_short %} is enabled for
* First ~10 lines from each file involved in any of those locations.
* Help text for the {% data variables.product.prodname_codeql %} query that identified the problem. For examples, see “[{% data variables.product.prodname_codeql %} query help](https://codeql.github.com/codeql-query-help/).”
Any {% data variables.product.prodname_copilot_autofix_short %} suggestions are generated and stored within the {% data variables.product.prodname_code_scanning %} backend. They are displayed as suggestions. No user interaction is needed beyond enabling {% data variables.product.prodname_code_scanning %} on the codebase and creating a pull request.
Any {% data variables.copilot.copilot_autofix_short %} suggestions are generated and stored within the {% data variables.product.prodname_code_scanning %} backend. They are displayed as suggestions. No user interaction is needed beyond enabling {% data variables.product.prodname_code_scanning %} on the codebase and creating a pull request.
The process of generating fixes does not gather or utilize any customer data beyond the scope outlined above. Therefore, the use of this feature is governed by the existing terms and conditions associated with {% data variables.product.prodname_AS %}. Moreover, data handled by {% data variables.product.prodname_copilot_autofix_short %} is strictly not employed for LLM training purposes. For more information on {% data variables.product.prodname_AS %} terms and conditions, see [AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-terms-for-additional-products-and-features#advanced-security){% ifversion fpt %}.{% else %} in the Free, Pro, & Team documentation.{% endif %}
The process of generating fixes does not gather or utilize any customer data beyond the scope outlined above. Therefore, the use of this feature is governed by the existing terms and conditions associated with {% data variables.product.prodname_AS %}. Moreover, data handled by {% data variables.copilot.copilot_autofix_short %} is strictly not employed for LLM training purposes. For more information on {% data variables.product.prodname_AS %} terms and conditions, see [AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-terms-for-additional-products-and-features#advanced-security){% ifversion fpt %}.{% else %} in the Free, Pro, & Team documentation.{% endif %}
## Quality of suggestions
{% data variables.product.prodname_dotcom %} uses an automated test harness to continuously monitor the quality of suggestions from {% data variables.product.prodname_copilot_autofix_short %}. This allows us to understand how the suggestions generated by the LLM change as the model develops.
{% data variables.product.prodname_dotcom %} uses an automated test harness to continuously monitor the quality of suggestions from {% data variables.copilot.copilot_autofix_short %}. This allows us to understand how the suggestions generated by the LLM change as the model develops.
The test harness includes a set of over 2,300 alerts from a diverse set of public repositories where the highlighted code has test coverage. Suggestions for these alerts are tested to see how good they are, that is, how much a developer would need to edit them before committing them to the codebase. For many of the test alerts, suggestions generated by the LLM could be committed as-is to fix the alert while continuing to successfully pass all the existing CI tests.
@@ -77,20 +77,20 @@ In addition, we spot check many of the successful suggestions and verify that th
### Effectiveness on other projects
The test set contains a broad range of different types of projects and alerts. We predict that suggestions for other projects using languages supported by {% data variables.product.prodname_copilot_autofix_short %} should follow a similar pattern.
The test set contains a broad range of different types of projects and alerts. We predict that suggestions for other projects using languages supported by {% data variables.copilot.copilot_autofix_short %} should follow a similar pattern.
* {% data variables.product.prodname_copilot_autofix_short %} is likely to add a code suggestion to the majority of alerts.
* {% data variables.copilot.copilot_autofix_short %} is likely to add a code suggestion to the majority of alerts.
* When developers evaluate the suggestions we expect that the majority of fixes can be committed without editing or with minor updates to reflect the wider context of the code.
* A small percentage of suggested fixes will reflect a significant misunderstanding of the codebase or the vulnerability.
However, each project and codebase is unique, so developers may need to edit a larger percentage of suggested fixes before committing them. {% data variables.product.prodname_copilot_autofix_short %} provides valuable information to help you resolve {% data variables.product.prodname_code_scanning %} alerts, but ultimately it remains your responsibility to evaluate the proposed change and ensure the security and accuracy of your code.
However, each project and codebase is unique, so developers may need to edit a larger percentage of suggested fixes before committing them. {% data variables.copilot.copilot_autofix_short %} provides valuable information to help you resolve {% data variables.product.prodname_code_scanning %} alerts, but ultimately it remains your responsibility to evaluate the proposed change and ensure the security and accuracy of your code.
> [!NOTE]
> Fix generation for supported languages is subject to LLM operational capacity. In addition, each suggested fix is tested before it is added to a pull request. If no suggestion is available, or if the suggested fix fails internal testing, then no suggestion is displayed.
## Limitations of suggestions
When you review a suggestion from {% data variables.product.prodname_copilot_autofix_short %}, you must always consider the limitations of AI and edit the changes as needed before you accept the changes. You should also consider updating the CI testing and dependency management for a repository before enabling {% data variables.product.prodname_copilot_autofix_short %} for {% data variables.product.prodname_code_scanning %}. For more information, see [Mitigating the limitations of suggestions](#mitigating-the-limitations-of-suggestions).
When you review a suggestion from {% data variables.copilot.copilot_autofix_short %}, you must always consider the limitations of AI and edit the changes as needed before you accept the changes. You should also consider updating the CI testing and dependency management for a repository before enabling {% data variables.copilot.copilot_autofix_short %} for {% data variables.product.prodname_code_scanning %}. For more information, see [Mitigating the limitations of suggestions](#mitigating-the-limitations-of-suggestions).
### Limitations of code suggestions
@@ -111,7 +111,7 @@ Sometimes a suggested fix includes a change in the dependencies of the codebase.
## Mitigating the limitations of suggestions
The best way to mitigate the limitations of suggestions from {% data variables.product.prodname_copilot_autofix_short %} is to follow best practices. For example, using CI testing of pull requests to verify functional requirements are unaffected and using dependency management solutions, such as the dependency review API and action. For more information, see “[AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review).”
The best way to mitigate the limitations of suggestions from {% data variables.copilot.copilot_autofix_short %} is to follow best practices. For example, using CI testing of pull requests to verify functional requirements are unaffected and using dependency management solutions, such as the dependency review API and action. For more information, see “[AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review).”
It is important to remember that the author of a pull request retains responsibility for how they respond to review comments and suggested code changes, whether proposed by colleagues or automated tools. Developers should always look at suggestions for code changes critically. If needed, they should edit the suggested changes to ensure that the resulting code and application are correct, secure, meet performance criteria, and satisfy all other functional and non-functional requirements for the application.

View File

@@ -38,7 +38,7 @@ If the lines of code changed in the pull request generate {% data variables.prod
{% ifversion code-scanning-autofix %}
{% data variables.product.prodname_copilot_autofix %} will suggest fixes for alerts from {% data variables.product.prodname_code_scanning %} analysis (including {% data variables.product.prodname_codeql %} analysis) in private repositories. For more information on working with suggestions from {% data variables.product.prodname_copilot_autofix_short %} in pull requests, see [Working with {% data variables.product.prodname_copilot_autofix_short %} suggestions for alerts on a pull request](#working-with-copilot-autofix-suggestions-for-alerts-on-a-pull-request).
{% data variables.copilot.copilot_autofix %} will suggest fixes for alerts from {% data variables.product.prodname_code_scanning %} analysis (including {% data variables.product.prodname_codeql %} analysis) in private repositories. For more information on working with suggestions from {% data variables.copilot.copilot_autofix_short %} in pull requests, see [Working with {% data variables.copilot.copilot_autofix_short %} suggestions for alerts on a pull request](#working-with-copilot-autofix-suggestions-for-alerts-on-a-pull-request).
{% endif %}
@@ -50,7 +50,7 @@ If your pull request targets a protected branch that uses {% data variables.prod
{% ifversion copilot-chat-ghas-alerts %}
With a {% data variables.product.prodname_copilot_enterprise %} license, you can also ask {% data variables.product.prodname_copilot_chat %} for help to better understand {% data variables.product.prodname_code_scanning %} alerts in repositories in your organization. For more information, see [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-githubcom#asking-questions-about-alerts-from-github-advanced-security-features).
With a {% data variables.copilot.copilot_enterprise %} license, you can also ask {% data variables.copilot.copilot_chat %} for help to better understand {% data variables.product.prodname_code_scanning %} alerts in repositories in your organization. For more information, see [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-githubcom#asking-questions-about-alerts-from-github-advanced-security-features).
{% endif %}
@@ -114,30 +114,30 @@ Anyone with push access to a pull request can fix a {% data variables.product.pr
{% ifversion code-scanning-autofix %}
## Working with {% data variables.product.prodname_copilot_autofix_short %} suggestions for alerts on a pull request
## Working with {% data variables.copilot.copilot_autofix_short %} suggestions for alerts on a pull request
{% data variables.product.prodname_copilot_autofix %} is an expansion of {% data variables.product.prodname_code_scanning %} that provides you with targeted recommendations to help you fix {% data variables.product.prodname_code_scanning %} alerts (including {% data variables.product.prodname_codeql %} alerts) in pull requests. The potential fixes are generated automatically by large language models (LLMs) using data from the codebase, the pull request, and from {% data variables.product.prodname_code_scanning %} analysis.
{% data variables.copilot.copilot_autofix %} is an expansion of {% data variables.product.prodname_code_scanning %} that provides you with targeted recommendations to help you fix {% data variables.product.prodname_code_scanning %} alerts (including {% data variables.product.prodname_codeql %} alerts) in pull requests. The potential fixes are generated automatically by large language models (LLMs) using data from the codebase, the pull request, and from {% data variables.product.prodname_code_scanning %} analysis.
{% data reusables.rai.code-scanning.copilot-autofix-note %}
![Screenshot of the check failure for a {% data variables.product.prodname_code_scanning %} alert in a pull request. Part of the "autofix" suggestion is outlined in dark orange.](/assets/images/help/code-scanning/alert+autofix.png)
### Generating {% data variables.product.prodname_copilot_autofix_short %} suggestions and publishing to a pull request
### Generating {% data variables.copilot.copilot_autofix_short %} suggestions and publishing to a pull request
When {% data variables.product.prodname_copilot_autofix_short %} is enabled for a repository, alerts are displayed in pull requests as normal and information from any alerts found by {% data variables.product.prodname_code_scanning %} is automatically sent to the LLM for processing. When LLM analysis is complete, any results are published as comments on relevant alerts. For more information, see [AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/responsible-use-autofix-code-scanning).
When {% data variables.copilot.copilot_autofix_short %} is enabled for a repository, alerts are displayed in pull requests as normal and information from any alerts found by {% data variables.product.prodname_code_scanning %} is automatically sent to the LLM for processing. When LLM analysis is complete, any results are published as comments on relevant alerts. For more information, see [AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/responsible-use-autofix-code-scanning).
> [!NOTE]
> * {% data variables.product.prodname_copilot_autofix_short %} supports a subset of {% data variables.product.prodname_codeql %} queries. For information about the availability of {% data variables.product.prodname_copilot_autofix_short %}, see the query tables linked from [AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/codeql-query-suites#query-lists-for-the-default-query-suites).
> * When analysis is complete, all relevant results are published to the pull request at once. If at least one alert in your pull request has an {% data variables.product.prodname_copilot_autofix_short %} suggestion, you should assume that the LLM has finished identifying potential fixes for your code.
> * On alerts generated from queries that are not supported by {% data variables.product.prodname_copilot_autofix_short %}, you will see a note telling you that the query is not supported. If a suggestion for a supported query fails to generate, you will see a note on the alert prompting you to try pushing another commit or to contact support.
> * {% data variables.copilot.copilot_autofix_short %} supports a subset of {% data variables.product.prodname_codeql %} queries. For information about the availability of {% data variables.copilot.copilot_autofix_short %}, see the query tables linked from [AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/codeql-query-suites#query-lists-for-the-default-query-suites).
> * When analysis is complete, all relevant results are published to the pull request at once. If at least one alert in your pull request has an {% data variables.copilot.copilot_autofix_short %} suggestion, you should assume that the LLM has finished identifying potential fixes for your code.
> * On alerts generated from queries that are not supported by {% data variables.copilot.copilot_autofix_short %}, you will see a note telling you that the query is not supported. If a suggestion for a supported query fails to generate, you will see a note on the alert prompting you to try pushing another commit or to contact support.
Usually, when you suggest changes to a pull request, your comment contains changes for a single file that is changed in the pull request. The following screenshot shows an {% data variables.product.prodname_copilot_autofix_short %} comment that suggests changes to the `index.js` file where the alert is displayed. Since the potential fix requires a new dependency on `escape-html`, the comment also suggests adding this dependency to the `package.json` file, even though the original pull request makes no changes to this file.
Usually, when you suggest changes to a pull request, your comment contains changes for a single file that is changed in the pull request. The following screenshot shows an {% data variables.copilot.copilot_autofix_short %} comment that suggests changes to the `index.js` file where the alert is displayed. Since the potential fix requires a new dependency on `escape-html`, the comment also suggests adding this dependency to the `package.json` file, even though the original pull request makes no changes to this file.
![Screenshot of {% data variables.product.prodname_copilot_autofix_short %} suggestion to edit the current file. A suggested change in "package.json" is outlined in dark orange.](/assets/images/help/code-scanning/autofix-example.png)
![Screenshot of {% data variables.copilot.copilot_autofix_short %} suggestion to edit the current file. A suggested change in "package.json" is outlined in dark orange.](/assets/images/help/code-scanning/autofix-example.png)
### Assessing and committing an {% data variables.product.prodname_copilot_autofix_short %} suggestion
### Assessing and committing an {% data variables.copilot.copilot_autofix_short %} suggestion
Each {% data variables.product.prodname_copilot_autofix_short %} suggestion demonstrates a potential solution for a {% data variables.product.prodname_code_scanning %} alert in your codebase. You must assess the suggested changes to determine whether they are a good solution for your codebase and to ensure that they maintain the intended behavior. For information about the limitations of {% data variables.product.prodname_copilot_autofix_short %} suggestions, see [Limitations of suggestions](/code-security/code-scanning/managing-code-scanning-alerts/responsible-use-autofix-code-scanning#limitations-of-suggestions) and [Mitigating the limitations of suggestions](/code-security/code-scanning/managing-code-scanning-alerts/responsible-use-autofix-code-scanning#mitigating-the-limitations-of-suggestions) in "Responsible use of {% data variables.product.prodname_copilot_autofix_short %} for {% data variables.product.prodname_code_scanning %}."
Each {% data variables.copilot.copilot_autofix_short %} suggestion demonstrates a potential solution for a {% data variables.product.prodname_code_scanning %} alert in your codebase. You must assess the suggested changes to determine whether they are a good solution for your codebase and to ensure that they maintain the intended behavior. For information about the limitations of {% data variables.copilot.copilot_autofix_short %} suggestions, see [Limitations of suggestions](/code-security/code-scanning/managing-code-scanning-alerts/responsible-use-autofix-code-scanning#limitations-of-suggestions) and [Mitigating the limitations of suggestions](/code-security/code-scanning/managing-code-scanning-alerts/responsible-use-autofix-code-scanning#mitigating-the-limitations-of-suggestions) in "Responsible use of {% data variables.copilot.copilot_autofix_short %} for {% data variables.product.prodname_code_scanning %}."
1. Click **Edit** to display the editing options and select your preferred method.
* Under **Edit with {% data variables.product.prodname_cli %}**, follow the instructions for checking out the pull request locally and applying the suggested fix.
@@ -152,9 +152,9 @@ Each {% data variables.product.prodname_copilot_autofix_short %} suggestion demo
1. When you have finished testing your changes, commit the changes, and push them to your branch.
1. Pushing the changes to your branch will trigger all the usual tests for your pull request. Confirm that your unit tests still pass and that the {% data variables.product.prodname_code_scanning %} alert is now fixed.
### Dismissing a {% data variables.product.prodname_copilot_autofix_short %} suggestion
### Dismissing a {% data variables.copilot.copilot_autofix_short %} suggestion
If you decide to reject a {% data variables.product.prodname_copilot_autofix_short %} suggestion, click **Dismiss suggestion** in the comment to dismiss the suggested fix.
If you decide to reject a {% data variables.copilot.copilot_autofix_short %} suggestion, click **Dismiss suggestion** in the comment to dismiss the suggested fix.
{% endif %}

View File

@@ -45,7 +45,7 @@ The built-in {% data variables.product.prodname_codeql %} query suites, `default
## Query lists for the default query suites
For each language, the following article lists which queries are included in the `default` and the `security-extended` suites. {% ifversion code-scanning-autofix %}Where {% data variables.product.prodname_copilot_autofix_short %} is available for a language, details of which queries are supported are also included.{% endif %}
For each language, the following article lists which queries are included in the `default` and the `security-extended` suites. {% ifversion code-scanning-autofix %}Where {% data variables.copilot.copilot_autofix_short %} is available for a language, details of which queries are supported are also included.{% endif %}
{% data reusables.code-scanning.codeql-query-tables.links-to-all-tables %}

View File

@@ -201,10 +201,10 @@ In addition, for {% data variables.code-scanning.no_build_support %}, there is a
The {% data variables.product.prodname_codeql_cli %} includes autobuilders for {% data variables.code-scanning.compiled_languages %} code. {% data variables.product.prodname_codeql %} autobuilders allow you to build projects for compiled languages without specifying any build commands. When an autobuilder is invoked, {% data variables.product.prodname_codeql %} examines the source for evidence of a build system and attempts to run the optimal set of commands required to extract a database. For more information, see [AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages#about-autobuild).
An autobuilder is invoked automatically when you execute `codeql database create` for a compiled language if you dont include a
`--command` option{% ifversion codeql-no-build %} or set `--build-mode none`{% endif %}. For example, for a C/C++ codebase, you could simply run:
`--command` option{% ifversion codeql-no-build %} or set `--build-mode none`{% endif %}. For example, for a Swift codebase, you could simply run:
```shell
codeql database create --language=cpp <output-folder>/cpp-database
codeql database create --language=swift <output-folder>/swift-database
```
If a codebase uses a standard build system, relying on an autobuilder is often the simplest way to create a database. For sources that require non-standard build steps, you may need to explicitly define each step in the command line.

View File

@@ -93,9 +93,9 @@ You can also see all the {% data variables.product.prodname_dependabot_alerts %}
{% ifversion copilot-chat-ghas-alerts %}
## Asking {% data variables.product.prodname_copilot_chat %} about {% data variables.product.prodname_dependabot_alerts %}
## Asking {% data variables.copilot.copilot_chat %} about {% data variables.product.prodname_dependabot_alerts %}
With a {% data variables.product.prodname_copilot_enterprise %} license, you can ask {% data variables.product.prodname_copilot_chat_short %} for help to better understand security alerts, including {% data variables.product.prodname_dependabot_alerts %}, in repositories in your organization. For more information, see [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-githubcom#asking-questions-about-alerts-from-github-advanced-security-features).
With a {% data variables.copilot.copilot_enterprise %} license, you can ask {% data variables.copilot.copilot_chat_short %} for help to better understand security alerts, including {% data variables.product.prodname_dependabot_alerts %}, in repositories in your organization. For more information, see [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-githubcom#asking-questions-about-alerts-from-github-advanced-security-features).
{% endif %}

View File

@@ -94,7 +94,7 @@ In cases where a patched version is not available, or you cant update to the
{% ifversion copilot-chat-ghas-alerts %}
With a {% data variables.product.prodname_copilot_enterprise %} license, you can also ask {% data variables.product.prodname_copilot_chat %} for help to better understand {% data variables.product.prodname_dependabot_alerts %} in repositories in your organization. For more information, see [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-githubcom#asking-questions-about-alerts-from-github-advanced-security-features).
With a {% data variables.copilot.copilot_enterprise %} license, you can also ask {% data variables.copilot.copilot_chat %} for help to better understand {% data variables.product.prodname_dependabot_alerts %} in repositories in your organization. For more information, see [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-githubcom#asking-questions-about-alerts-from-github-advanced-security-features).
{% endif %}

View File

@@ -395,7 +395,7 @@ Package manager | YAML value | Supported versions |
| pip| `pip` | v21.1.2 |
| pip-compile | `pip` | 6.1.0 |
| pipenv | `pip` | <= 2021-05-29 |
| pnpm | `npm` | v7, v8 <br>v9 (version updates only) |
| pnpm | `npm` | v7, v8 <br>v9, v10 (version updates only) |
| poetry | `pip` | v2 |
| pub | `pub` | v2 |
| Swift | `swift` | v5 |

View File

@@ -17,8 +17,6 @@ shortTitle: Configure VNET
## Configuring VNET for {% data variables.product.prodname_dependabot_updates %}
{% data reusables.dependabot.vnet-support-private-preview-note %}
This article provides step-by-step instructions for running {% data variables.product.prodname_dependabot %} on {% data variables.product.company_short %}-hosted runners configured with VNET. The article explains:
* How to create runner groups for your enterprise or organization with a VNET configuration.

View File

@@ -17,8 +17,6 @@ shortTitle: Configure ARC
## Working with the {% data variables.product.prodname_actions_runner_controller %} (ARC)
{% data reusables.dependabot.arc-support-private-preview-note %}
This article provides step-by-step instructions for setting up ARC on a Kubernetes cluster and configuring {% data variables.product.prodname_dependabot %} to run on self-hosted action runners. The article:
* Contains an overview of the ARC and {% data variables.product.prodname_dependabot %} integration.

View File

@@ -210,7 +210,7 @@ Run {% data variables.product.prodname_codeql %} processes locally on software p
{% ifversion code-scanning-autofix %}
### {% data variables.product.prodname_copilot_autofix_short %}
### {% data variables.copilot.copilot_autofix_short %}
Get automatically generated fixes for {% data variables.product.prodname_code_scanning %} alerts. For more information, see [AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/responsible-use-autofix-code-scanning).
@@ -242,9 +242,9 @@ Security overview allows you to review the overall security landscape of your or
{% ifversion copilot-chat-ghas-alerts %}
## Leveraging {% data variables.product.prodname_copilot_chat %} to understand security alerts
## Leveraging {% data variables.copilot.copilot_chat %} to understand security alerts
With a {% data variables.product.prodname_copilot_enterprise %} license, you can also ask {% data variables.product.prodname_copilot_chat %} for help to better understand security alerts in repositories in your organization from {% data variables.product.prodname_GHAS %} features ({% data variables.product.prodname_code_scanning %}, {% data variables.product.prodname_secret_scanning %}, and {% data variables.product.prodname_dependabot_alerts %}). For more information, see [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-githubcom#asking-questions-about-alerts-from-github-advanced-security-features).
With a {% data variables.copilot.copilot_enterprise %} license, you can also ask {% data variables.copilot.copilot_chat %} for help to better understand security alerts in repositories in your organization from {% data variables.product.prodname_GHAS %} features ({% data variables.product.prodname_code_scanning %}, {% data variables.product.prodname_secret_scanning %}, and {% data variables.product.prodname_dependabot_alerts %}). For more information, see [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-githubcom#asking-questions-about-alerts-from-github-advanced-security-features).
{% endif %}

View File

@@ -116,7 +116,7 @@ To enable {% data variables.product.prodname_dependabot_version_updates %}, you
> {% data variables.product.prodname_code_security %} features are available for all public repositories, and for private repositories owned by organizations that are part of a team or an enterprise that uses {% data variables.product.prodname_GH_code_security %} or {% data variables.product.prodname_GHAS %}.
{% endif %}
{% ifversion ghas-products %}{% data variables.product.prodname_GH_code_security %} includes {% data variables.product.prodname_code_scanning %}, {% data variables.product.prodname_codeql_cli %} and {% data variables.product.prodname_copilot_autofix_short %}, as well as other features that find and fix vulnerabilities in your codebase.{% endif %}
{% ifversion ghas-products %}{% data variables.product.prodname_GH_code_security %} includes {% data variables.product.prodname_code_scanning %}, {% data variables.product.prodname_codeql_cli %} and {% data variables.copilot.copilot_autofix_short %}, as well as other features that find and fix vulnerabilities in your codebase.{% endif %}
You can configure {% data variables.product.prodname_code_scanning %} to automatically identify vulnerabilities and errors in the code stored in your repository by using a {% data variables.code-scanning.codeql_workflow %} or third-party tool. Depending on the programming languages in your repository, you can configure {% data variables.product.prodname_code_scanning %} with {% data variables.product.prodname_codeql %} using default setup, in which {% data variables.product.github %} automatically determines the languages to scan, query suites to run, and events that will trigger a new scan. For more information, see [AUTOTITLE](/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning).
@@ -126,7 +126,7 @@ You can configure {% data variables.product.prodname_code_scanning %} to automat
1. To the right of "CodeQL analysis", select **Set up** {% octicon "triangle-down" aria-hidden="true" aria-label="triangle-down" %}, then click **Default**.{% else %}
1. In the "{% data variables.product.prodname_code_scanning_caps %}" section, select **Set up** {% octicon "triangle-down" aria-hidden="true" aria-label="triangle-down" %}, then click **Default**.{% endif %}
1. In the pop-up window that appears, review the default configuration settings for your repository, then click **Enable {% data variables.product.prodname_codeql %}**.{% ifversion code-scanning-autofix %}
1. Choose whether you want to enable addition features, such as {% data variables.product.prodname_copilot_autofix_short %}.{% endif %}
1. Choose whether you want to enable addition features, such as {% data variables.copilot.copilot_autofix_short %}.{% endif %}
As an alternative to default setup, you can use advanced setup, which generates a workflow file you can edit to customize your {% data variables.product.prodname_code_scanning %} with {% data variables.product.prodname_codeql %}. For more information, 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).

View File

@@ -51,9 +51,12 @@ This table lists the secrets supported by {% data variables.product.prodname_sec
{% data reusables.secret-scanning.non-provider-patterns-beta %}
{% ifversion secret-scanning-ai-generic-secret-detection %}
In addition to these generic non-provider patterns, {% data variables.product.prodname_secret_scanning %} uses {% data variables.product.prodname_copilot_short %} to detect generic passwords. For more information, see [AUTOTITLE](/code-security/secret-scanning/copilot-secret-scanning/responsible-ai-generic-secrets).
{% endif %}
| Provider | Token |
|----------|:--------------------|
| Generic | password |
| Generic | http_basic_authentication_header |
| Generic | http_bearer_authentication_header |
| Generic | mongodb_connection_string |

View File

@@ -47,9 +47,9 @@ You can use the REST API to retrieve a list of the most recent validation status
{% ifversion copilot-chat-ghas-alerts %}
## Asking {% data variables.product.prodname_copilot_chat %} about {% data variables.product.prodname_secret_scanning %} alerts
## Asking {% data variables.copilot.copilot_chat %} about {% data variables.product.prodname_secret_scanning %} alerts
With a {% data variables.product.prodname_copilot_enterprise %} license, you can ask {% data variables.product.prodname_copilot_chat_short %} for help to better understand security alerts, including {% data variables.product.prodname_secret_scanning %} alerts, in repositories in your organization. For more information, see [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-githubcom#asking-questions-about-alerts-from-github-advanced-security-features).
With a {% data variables.copilot.copilot_enterprise %} license, you can ask {% data variables.copilot.copilot_chat_short %} for help to better understand security alerts, including {% data variables.product.prodname_secret_scanning %} alerts, in repositories in your organization. For more information, see [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-githubcom#asking-questions-about-alerts-from-github-advanced-security-features).
{% endif %}

View File

@@ -17,7 +17,7 @@ topics:
The {% data variables.product.prodname_github_security_configuration %} is a collection of enablement settings for {% data variables.product.company_short %}'s security features that is created and maintained by subject matter experts at {% data variables.product.company_short %}. The {% data variables.product.prodname_github_security_configuration %} is designed to successfully reduce the security risks for low- and high-impact repositories. We recommend you apply this configuration to all the repositories in your organization.
> [!NOTE]
> The {% data variables.product.prodname_github_security_configuration %} includes {% data variables.product.prodname_GH_code_security %} and {% data variables.product.prodname_GH_secret_protection %} features. Applying the configuration to repositories in your organization will incur usage costs or require licenses.
> The {% data variables.product.prodname_github_security_configuration %} includes {% data variables.product.prodname_GH_code_security %} and {% data variables.product.prodname_GH_secret_protection %} features. Applying the configuration to private and internal repositories in your organization will incur usage costs or require licenses.
## Applying the {% data variables.product.prodname_github_security_configuration %} to all repositories in your organization

View File

@@ -75,8 +75,8 @@ To update private dependencies of repositories in your organization, {% data var
You can customize several {% data variables.product.prodname_global_settings %} for {% data variables.product.prodname_code_scanning %}:
{% ifversion code-scanning-autofix %}
* [Enabling {% data variables.product.prodname_copilot_autofix_short %} for {% data variables.product.prodname_codeql %}](#enabling-copilot-autofix-for-codeql)
* [Enabling {% data variables.product.prodname_copilot_autofix_short %} for third-party {% data variables.product.prodname_code_scanning %} tools](#enabling-copilot-autofix-for-third-party-code-scanning-tools) {% endif %}
* [Enabling {% data variables.copilot.copilot_autofix_short %} for {% data variables.product.prodname_codeql %}](#enabling-copilot-autofix-for-codeql)
* [Enabling {% data variables.copilot.copilot_autofix_short %} for third-party {% data variables.product.prodname_code_scanning %} tools](#enabling-copilot-autofix-for-third-party-code-scanning-tools) {% endif %}
* [Recommending the extended query suite for default setup](#recommending-the-extended-query-suite-for-default-setup){% ifversion ghes < 3.17 %}
* [Setting a failure threshold for {% data variables.product.prodname_code_scanning %} checks in pull requests](#setting-a-failure-threshold-for-code-scanning-checks-in-pull-requests){% endif %}
@@ -88,16 +88,16 @@ You can customize several {% data variables.product.prodname_global_settings %}
{% ifversion code-scanning-autofix %}
### Enabling {% data variables.product.prodname_copilot_autofix_short %} for {% data variables.product.prodname_codeql %}
### Enabling {% data variables.copilot.copilot_autofix_short %} for {% data variables.product.prodname_codeql %}
You can select **{% data variables.product.prodname_copilot_autofix_short %}** to enable {% data variables.product.prodname_copilot_autofix_short %} for all the repositories in your organization that use {% data variables.product.prodname_codeql %} default setup or {% data variables.product.prodname_codeql %} advanced setup. {% data variables.product.prodname_copilot_autofix_short %} is an expansion of {% data variables.product.prodname_code_scanning %} that suggests fixes for {% data variables.product.prodname_code_scanning %} alerts. For more information, see [AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/responsible-use-autofix-code-scanning).
You can select **{% data variables.copilot.copilot_autofix_short %}** to enable {% data variables.copilot.copilot_autofix_short %} for all the repositories in your organization that use {% data variables.product.prodname_codeql %} default setup or {% data variables.product.prodname_codeql %} advanced setup. {% data variables.copilot.copilot_autofix_short %} is an expansion of {% data variables.product.prodname_code_scanning %} that suggests fixes for {% data variables.product.prodname_code_scanning %} alerts. For more information, see [AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/responsible-use-autofix-code-scanning).
### Enabling {% data variables.product.prodname_copilot_autofix_short %} for third-party {% data variables.product.prodname_code_scanning %} tools
### Enabling {% data variables.copilot.copilot_autofix_short %} for third-party {% data variables.product.prodname_code_scanning %} tools
>[!NOTE]
> Third-party {% data variables.product.prodname_code_scanning %} tool support is in {% data variables.release-phases.public_preview %}, and subject to change. Currently, the third-party tool ESLint is supported. For more information, see [AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/responsible-use-autofix-code-scanning).
You can select **{% data variables.product.prodname_copilot_autofix_short %} for third-party tools** to enable {% data variables.product.prodname_copilot_autofix_short %} for all the repositories in your organization that use third-party tools. {% data variables.product.prodname_copilot_autofix_short %} is an expansion of {% data variables.product.prodname_code_scanning %} that suggests fixes for {% data variables.product.prodname_code_scanning %} alerts.
You can select **{% data variables.copilot.copilot_autofix_short %} for third-party tools** to enable {% data variables.copilot.copilot_autofix_short %} for all the repositories in your organization that use third-party tools. {% data variables.copilot.copilot_autofix_short %} is an expansion of {% data variables.product.prodname_code_scanning %} that suggests fixes for {% data variables.product.prodname_code_scanning %} alerts.
{% endif %}

View File

@@ -17,12 +17,12 @@ When a repository uses code stored in a private registry, some security features
## {% data variables.product.prodname_code_scanning_caps %} default setup access to private registries
{% data variables.product.prodname_code_scanning_caps %} default setup analyzes {% data variables.code-scanning.no_build_support %} code without building it. If you do not define access to the private registries your organization uses, then {% data variables.product.prodname_code_scanning %} will only gather necessary data from dependencies available in public registries. Most times, this is enough for surfacing most of the vulnerabilities. However, in some cases the lack of access can lead to false negative results, that is, {% data variables.product.prodname_code_scanning %} is unable to detect a vulnerability in the code because it does not have all the information it needs to analyze the code. For example, some of the data flow paths may not be detected because steps are defined in dependencies that are not accessible and {% data variables.product.prodname_code_scanning %} does not know how to interpret them.
If you do not define access to the private registries your organization uses, then {% data variables.product.prodname_code_scanning %} will only gather necessary data from dependencies available in public registries. Most times, this is enough for surfacing most of the vulnerabilities. However, in some cases the lack of access can lead to false negative results, that is, {% data variables.product.prodname_code_scanning %} is unable to detect a vulnerability in the code because it does not have all the information it needs to analyze the code. For example, some of the data flow paths may not be detected because steps are defined in dependencies that are not accessible and {% data variables.product.prodname_code_scanning %} does not know how to interpret them.
When you configure access to the private registries used in your organization, {% data variables.product.prodname_code_scanning %} has access to all the information it needs and is much less likely to miss a vulnerability.
> [!TIP]
> You can define one private Maven registry and one private NuGet feed for each organization. If the codebases in your organization use more than one registry or feed, you should define access to the most important registry for the codebases in that organization.
> You can define one of each type of registry for each organization. If the codebases in your organization use more than one registry of a given type, you should define access to the most important registry for the codebases in that organization.
### Defining registry access for {% data variables.product.prodname_code_scanning %} default setup

View File

@@ -31,7 +31,7 @@ A security campaign has many benefits over other ways of encouraging developers
* Developers are notified about any security campaigns taking place in repositories they work in or subscribe to by email.
* Developers can see the alerts you've highlighted for remediation without leaving their normal workflows.
* Each campaign has a named point of contact for questions, reviews, and collaboration. {% ifversion security-campaigns-autofix %}
* {% data variables.product.prodname_copilot_autofix %} is automatically triggered to suggest a resolution for each security alert. {% endif %}
* {% data variables.copilot.copilot_autofix %} is automatically triggered to suggest a resolution for each security alert. {% endif %}
You can use one of the templates to select a group of closely related alerts for a campaign. This allows developers to build on the knowledge gained by resolving one alert and use it to fix several more, providing them with an incentive to fix multiple alerts.

View File

@@ -18,10 +18,10 @@ topics:
Successful security campaigns to fix alerts at scale have many features in common, including:
* Selecting a related group of security alerts for remediation.
* Using {% data variables.product.prodname_copilot_autofix_short %} suggestions where possible to help developers remediate alerts faster and more effectively.
* Using {% data variables.copilot.copilot_autofix_short %} suggestions where possible to help developers remediate alerts faster and more effectively.
* Making sure that the campaign managers are available for collaboration, reviews, and questions about fixes.
* Providing access to educational information about the type of alerts included in the campaign.{% ifversion ghec %}
* Making {% data variables.product.prodname_copilot_chat %} available for developers to use to learn about the vulnerabilities highlighted by the security alerts in the campaign. {% endif %}
* Making {% data variables.copilot.copilot_chat %} available for developers to use to learn about the vulnerabilities highlighted by the security alerts in the campaign. {% endif %}
* Defining a realistic deadline for campaign, bearing in mind the number of alerts you aim to fix.
* Publicizing the collaboration to developer teams and identifying the best way to engage them for your organization.
@@ -38,9 +38,9 @@ For example, if you have many alerts for cross-site scripting vulnerabilities, y
* Hold a training session or other event to highlight this opportunity to gain confidence in secure coding while fixing real bugs.
* Make sure that the security team members assigned to manage the campaign are available to review the pull requests created to fix the campaign alerts, collaborating as needed.
### Using {% data variables.product.prodname_copilot_autofix_short %} to help remediate security alerts
### Using {% data variables.copilot.copilot_autofix_short %} to help remediate security alerts
{% data variables.product.prodname_copilot_autofix %} is an expansion of {% data variables.product.prodname_code_scanning %} that provides users with targeted recommendations to help fix {% data variables.product.prodname_code_scanning %} alerts. When you select alerts to include in a security campaign, you can preferentially include alerts that are eligible to be fixed with the help of {% data variables.product.prodname_copilot_autofix %} using the `autofix:supported` filter.
{% data variables.copilot.copilot_autofix %} is an expansion of {% data variables.product.prodname_code_scanning %} that provides users with targeted recommendations to help fix {% data variables.product.prodname_code_scanning %} alerts. When you select alerts to include in a security campaign, you can preferentially include alerts that are eligible to be fixed with the help of {% data variables.copilot.copilot_autofix %} using the `autofix:supported` filter.
### Campaign filter templates
@@ -85,7 +85,7 @@ The OWASP Foundation provides many resources for learning about the most common
## Providing AI support for learning about security vulnerabilities
{% data variables.product.prodname_copilot_autofix %} is automatically triggered to suggest a resolution for each security alert. However, developers will often want more information about why the original code is insecure and how to test that the fix is correct and doesn't break other components.
{% data variables.copilot.copilot_autofix %} is automatically triggered to suggest a resolution for each security alert. However, developers will often want more information about why the original code is insecure and how to test that the fix is correct and doesn't break other components.
{% data variables.product.prodname_copilot %} is an important tool for developers who have questions about secure coding, how to fix security alerts, and test their fix. Check that all developers in your organization have access to {% data variables.product.prodname_copilot_short %} in both their IDE and {% data variables.product.github %}, 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).

View File

@@ -22,7 +22,7 @@ Security campaigns are created and managed from the **Security** tab for your or
You choose the alerts that you want to include in the campaign by using either:
* **Campaign templates**: Campaign templates contain filters for the most common alert selections. {% ifversion security-campaigns-autofix %}They also all include the requirement that {% data variables.product.prodname_copilot_autofix %} is supported for all the alert types included (that is, `autofix:supported`).{% endif %}
* **Campaign templates**: Campaign templates contain filters for the most common alert selections. {% ifversion security-campaigns-autofix %}They also all include the requirement that {% data variables.copilot.copilot_autofix %} is supported for all the alert types included (that is, `autofix:supported`).{% endif %}
* **Custom filters**: Creating a campaign using custom filters lets you define your own criteria for selecting alerts for the campaign, and lets you tailor your campaign to your organization's specific needs.
{% data reusables.code-scanning.campaigns-api %}
@@ -70,7 +70,7 @@ All the template filters include the following useful filters:
* `is:open` includes only alerts that are open in the default branch.
* `autofilter:true` includes only alerts that appear to be in application code. {% ifversion security-campaigns-autofix %}
* `autofix:supported` includes only alerts that are for rules that are supported for {% data variables.product.prodname_copilot_autofix %}.{% endif %}
* `autofix:supported` includes only alerts that are for rules that are supported for {% data variables.copilot.copilot_autofix %}.{% endif %}
Once you include these core filters, you will usually want to add a filter to limit results to a specific rule name, severity, or tag. For example:
@@ -88,7 +88,7 @@ For more information about filtering alerts, see [AUTOTITLE](/code-security/secu
{% ifversion security-campaigns-autofix %}
When you create a campaign, all the alerts are automatically submitted to {% data variables.product.prodname_copilot_autofix %} to be processed as capacity allows. This ensures that suggestions for alerts found in pull requests aren't delayed by a new campaign. In most cases, you should find that all suggestions that can be created are ready within an hour. At busy times of day, or for particularly complex alerts, it will take longer.
When you create a campaign, all the alerts are automatically submitted to {% data variables.copilot.copilot_autofix %} to be processed as capacity allows. This ensures that suggestions for alerts found in pull requests aren't delayed by a new campaign. In most cases, you should find that all suggestions that can be created are ready within an hour. At busy times of day, or for particularly complex alerts, it will take longer.
{% endif %}

View File

@@ -46,7 +46,7 @@ The tracking view shows you a summary of:
* **Campaign progress**: how many alerts are closed (fixed or dismissed), in progress, or still left to review.
* **Status**: how the campaign is progressing towards its due date.
* **{% data variables.product.prodname_copilot_autofix_short %}**: number of alerts where {% data variables.product.prodname_copilot_autofix_short %} can generate a fix to resolve the alert.
* **{% data variables.copilot.copilot_autofix_short %}**: number of alerts where {% data variables.copilot.copilot_autofix_short %} can generate a fix to resolve the alert.
You can also explore the campaign repositories and alerts to see where teams are engaging in the campaign, and where teams might need some extra encouragement to take part.

View File

@@ -31,7 +31,7 @@ The {% data variables.product.prodname_github_security_configuration %} offers a
* It is the quickest {% data variables.product.prodname_security_configuration %} to apply to all repositories in your organization.
* It is designed to effectively secure both low- and high-impact repositories.
The {% data variables.product.prodname_github_security_configuration %} includes {% data variables.product.prodname_GH_code_security %} and {% data variables.product.prodname_GH_secret_protection %} features. Applying the configuration to repositories in your organization will incur usage costs or require licenses.
The {% data variables.product.prodname_github_security_configuration %} includes {% data variables.product.prodname_GH_code_security %} and {% data variables.product.prodname_GH_secret_protection %} features. Applying the configuration to private and internal repositories in your organization will incur usage costs or require licenses.
To start securing repositories in your organization with the {% data variables.product.prodname_github_security_configuration %}, see [AUTOTITLE](/code-security/securing-your-organization/enabling-security-features-in-your-organization/applying-the-github-recommended-security-configuration-in-your-organization).

View File

@@ -23,7 +23,7 @@ The metrics overview for {% data variables.product.prodname_codeql %} pull reque
The overview shows you a summary of how many vulnerabilities prevented by {% data variables.product.prodname_codeql %} have been caught in pull requests. The metrics are only tracked for pull requests that have been merged into the default branches of repositories in your organizations.
You can also find more granular metrics, such as how many alerts were fixed{% ifversion code-scanning-autofix %} with and without {% data variables.product.prodname_copilot_autofix_short %} suggestions{% endif %}, how many were unresolved and merged, and how many were dismissed as false positive or as risk accepted.
You can also find more granular metrics, such as how many alerts were fixed{% ifversion code-scanning-autofix %} with and without {% data variables.copilot.copilot_autofix_short %} suggestions{% endif %}, how many were unresolved and merged, and how many were dismissed as false positive or as risk accepted.
You can also view:
@@ -32,17 +32,17 @@ You can also view:
* The number of alerts that were merged into the default branch without resolution, and the number of alerts dismissed as an acceptable risk.
{% ifversion code-scanning-autofix %}
* The number of alerts that were fixed with an accepted {% data variables.product.prodname_copilot_autofix_short %} suggestion, displayed as a fraction of how many total {% data variables.product.prodname_copilot_autofix_short %} suggestions were available.
* The number of alerts that were fixed with an accepted {% data variables.copilot.copilot_autofix_short %} suggestion, displayed as a fraction of how many total {% data variables.copilot.copilot_autofix_short %} suggestions were available.
* Remediation rates, in a graph showing the percentage of alerts that were remediated with an available {% data variables.product.prodname_copilot_autofix_short %} suggestion, and the percentage of alerts that were remediated without a {% data variables.product.prodname_copilot_autofix_short %} suggestion.
* Remediation rates, in a graph showing the percentage of alerts that were remediated with an available {% data variables.copilot.copilot_autofix_short %} suggestion, and the percentage of alerts that were remediated without a {% data variables.copilot.copilot_autofix_short %} suggestion.
{% endif %}
You can apply filters to the data. The metrics are based on activity from the default period or your selected period.
{% ifversion code-scanning-autofix %}
> [!NOTE] Metrics for {% data variables.product.prodname_copilot_autofix_short %} will be shown only for repositories where {% data variables.product.prodname_copilot_autofix_short %} is enabled.
> [!NOTE] Metrics for {% data variables.copilot.copilot_autofix_short %} will be shown only for repositories where {% data variables.copilot.copilot_autofix_short %} is enabled.
{% else %}
> [!NOTE] Metrics for {% data variables.product.prodname_copilot_autofix_short %} are omitted because {% data variables.product.prodname_copilot_autofix_short %} is available only on {% data variables.product.github %} cloud platforms.
> [!NOTE] Metrics for {% data variables.copilot.copilot_autofix_short %} are omitted because {% data variables.copilot.copilot_autofix_short %} is available only on {% data variables.product.github %} cloud platforms.
{% endif %}
## Viewing {% data variables.product.prodname_codeql %} pull request alerts metrics for an organization

View File

@@ -198,7 +198,7 @@ Green bars represent the number of new alerts created during the segmented time
* [Introduced versus prevented](#introduced-versus-prevented)
* [Vulnerabilities fixed in pull requests](#vulnerabilities-fixed-in-pull-requests){% ifversion code-scanning-autofix %}
* [{% data variables.product.prodname_copilot_autofix_short %} suggestions](##pull-request-alerts-fixed-with-copilot-autofix-suggestions){% endif %}
* [{% data variables.copilot.copilot_autofix_short %} suggestions](##pull-request-alerts-fixed-with-copilot-autofix-suggestions){% endif %}
#### Introduced versus prevented
@@ -212,11 +212,11 @@ The "Vulnerabilities fixed in pull requests" metric shows the count of pull requ
{% ifversion code-scanning-autofix %}
#### Pull request alerts fixed with {% data variables.product.prodname_copilot_autofix_short %} suggestions
#### Pull request alerts fixed with {% data variables.copilot.copilot_autofix_short %} suggestions
{% data variables.product.prodname_copilot_autofix %} for {% data variables.product.prodname_code_scanning %} is an expansion of {% data variables.product.prodname_code_scanning %} that provides you with targeted recommendations to help you fix {% data variables.product.prodname_code_scanning %} alerts. For more information, see [AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/responsible-use-autofix-code-scanning).
{% data variables.copilot.copilot_autofix %} for {% data variables.product.prodname_code_scanning %} is an expansion of {% data variables.product.prodname_code_scanning %} that provides you with targeted recommendations to help you fix {% data variables.product.prodname_code_scanning %} alerts. For more information, see [AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/responsible-use-autofix-code-scanning).
The "Pull request alerts fixed with autofix suggestions" metric shows the ratio of accepted {% data variables.product.prodname_copilot_autofix_short %} suggestions to the total number of {% data variables.product.prodname_copilot_autofix_short %} suggestions on pull request alerts detected by {% data variables.product.prodname_code_scanning %}.
The "Pull request alerts fixed with autofix suggestions" metric shows the ratio of accepted {% data variables.copilot.copilot_autofix_short %} suggestions to the total number of {% data variables.copilot.copilot_autofix_short %} suggestions on pull request alerts detected by {% data variables.product.prodname_code_scanning %}.
{% endif %}
@@ -287,11 +287,11 @@ Alerts that are reopened and re-closed during the chosen time period are ignored
{% ifversion code-scanning-autofix %}
### {% data variables.product.prodname_copilot_autofix_short %} suggestions
### {% data variables.copilot.copilot_autofix_short %} suggestions
{% data variables.product.prodname_copilot_autofix %} is an expansion of {% data variables.product.prodname_code_scanning %} that provides you with targeted recommendations to help you fix {% data variables.product.prodname_code_scanning %} alerts (including {% data variables.product.prodname_codeql %} alerts). For more information, see [AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/responsible-use-autofix-code-scanning).
{% data variables.copilot.copilot_autofix %} is an expansion of {% data variables.product.prodname_code_scanning %} that provides you with targeted recommendations to help you fix {% data variables.product.prodname_code_scanning %} alerts (including {% data variables.product.prodname_codeql %} alerts). For more information, see [AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/responsible-use-autofix-code-scanning).
The "{% data variables.product.prodname_copilot_autofix_short %} suggestions" metric is the total number of {% data variables.product.prodname_copilot_autofix_short %} suggestions generated in open and closed pull requests during the chosen time period.
The "{% data variables.copilot.copilot_autofix_short %} suggestions" metric is the total number of {% data variables.copilot.copilot_autofix_short %} suggestions generated in open and closed pull requests during the chosen time period.
{% endif %}

View File

@@ -49,14 +49,14 @@ If the extended suite still fails to find the results you expect, you may need t
There are three different types of automated analysis of pull requests built into {% data variables.product.github %}:
* **{% data variables.product.prodname_code_scanning_caps %} analysis** uses queries to highlight known bad coding patterns and security vulnerabilities. {% data variables.product.prodname_copilot_autofix_short %} suggests fixes to problems identified by {% data variables.product.prodname_code_scanning %}.
* **{% data variables.product.prodname_code_scanning_caps %} analysis** uses queries to highlight known bad coding patterns and security vulnerabilities. {% data variables.copilot.copilot_autofix_short %} suggests fixes to problems identified by {% data variables.product.prodname_code_scanning %}.
* **Dependency review** summarizes the dependency changes made by the pull request and highlights any dependencies with known vulnerabilities or that do not meet your development standards.
* **{% data variables.product.prodname_copilot_short %} code review** uses AI to provide feedback on your changes with suggested fixes where possible.
These automated reviews are a valuable extension to self-review and make it easier for developers to present a more complete and secure pull request for peer review. In addition, {% data variables.product.prodname_code_scanning %} and dependency reviews can be enforced to protect the security and compliance of your code.
> [!NOTE]
> {% data variables.product.prodname_copilot_autofix %} is included in the license for {% data variables.product.prodname_GH_code_security %}. {% data variables.product.prodname_copilot_short %} code review requires a paid {% data variables.product.prodname_copilot_short %} plan.
> {% data variables.copilot.copilot_autofix %} is included in the license for {% data variables.product.prodname_GH_code_security %}. {% data variables.product.prodname_copilot_short %} code review requires a paid {% data variables.product.prodname_copilot_short %} plan.
### {% data variables.product.prodname_code_scanning_caps %} analysis
@@ -92,14 +92,14 @@ By default, users request a review from {% data variables.product.prodname_copil
{% data variables.product.prodname_copilot_short %} leaves a review comment on each pull request it reviews, without approving the pull request or requesting changes. This ensures that its review is advisory and will not block development work. Similarly, you should not enforce the resolution of suggestions made by {% data variables.product.prodname_copilot_short %} because AI suggestions have known limitations, see [AUTOTITLE](/copilot/responsible-use-of-github-copilot-features/responsible-use-of-github-copilot-code-review#limitations-of-github-copilot-code-review).
## Define where {% data variables.product.prodname_copilot_autofix_short %} is allowed and enabled
## Define where {% data variables.copilot.copilot_autofix_short %} is allowed and enabled
{% data variables.product.prodname_copilot_autofix_short %} helps developers understand and fix {% data variables.product.prodname_code_scanning %} alerts found in their pull requests. We recommend that you enable this feature for all repositories with {% data variables.product.prodname_code_security %} enabled to help developers resolve alerts efficiently and increase their understanding of secure coding.
{% data variables.copilot.copilot_autofix_short %} helps developers understand and fix {% data variables.product.prodname_code_scanning %} alerts found in their pull requests. We recommend that you enable this feature for all repositories with {% data variables.product.prodname_code_security %} enabled to help developers resolve alerts efficiently and increase their understanding of secure coding.
There are two levels of control:
* Enterprises can allow or block use of {% data variables.product.prodname_copilot_autofix_short %} throughout the enterprise using an "{% ifversion ghas-products %}{% data variables.product.prodname_AS %}{% else %}Code security{% endif %}" policy, see: [AUTOTITLE](/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise).
* Organizations can enable or disable {% data variables.product.prodname_copilot_autofix_short %} for all organization-owned repositories in the "Global settings" for the organization, see [AUTOTITLE](/code-security/securing-your-organization/enabling-security-features-in-your-organization/configuring-global-security-settings-for-your-organization).
* Enterprises can allow or block use of {% data variables.copilot.copilot_autofix_short %} throughout the enterprise using an "{% ifversion ghas-products %}{% data variables.product.prodname_AS %}{% else %}Code security{% endif %}" policy, see: [AUTOTITLE](/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise).
* Organizations can enable or disable {% data variables.copilot.copilot_autofix_short %} for all organization-owned repositories in the "Global settings" for the organization, see [AUTOTITLE](/code-security/securing-your-organization/enabling-security-features-in-your-organization/configuring-global-security-settings-for-your-organization).
## Engage developers in security remediation

View File

@@ -788,7 +788,7 @@ When introducing a list, avoid short, nonspecific sentences using terms like “
Use permission statements and product callouts to communicate tasks that require specific roles or products to complete.
* [**Permissions statements**](/contributing/style-guide-and-content-model/contents-of-a-github-docs-article#permissions-statements): The role required to take an action or do a task described in the article. Example: "Enterprise owners."
* [**Product callout**](/contributing/style-guide-and-content-model/contents-of-a-github-docs-article#product-callout): The product or products required to take an action or do a task described in the article. Example: "Organization and enterprise accounts with a subscription to {% data variables.product.prodname_copilot_business_short %}."
* [**Product callout**](/contributing/style-guide-and-content-model/contents-of-a-github-docs-article#product-callout): The product or products required to take an action or do a task described in the article. Example: "Organization and enterprise accounts with a subscription to {% data variables.copilot.copilot_business_short %}."
Together, permission statements and product callouts tell readers who can use the feature being described in an article.

View File

@@ -20,15 +20,15 @@ Autocomplete-style suggestions from {% data variables.product.prodname_copilot_s
If you use {% data variables.product.prodname_vscode_shortname %}, 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.product.prodname_copilot_chat_short %}
### {% data variables.copilot.copilot_chat_short %}
A chat interface that lets you ask coding-related questions. {% data variables.product.prodname_copilot_chat %} is available on the {% data variables.product.github %} website, in {% data variables.product.prodname_mobile %}, in supported IDEs _({% data variables.product.prodname_vscode %}, {% data variables.product.prodname_vs %}, JetBrains IDEs, Eclipse IDE, and Xcode)_, and in {% data variables.product.prodname_windows_terminal %}. Users can also use skills with {% data variables.product.prodname_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 _({% data variables.product.prodname_vscode %}, {% data variables.product.prodname_vs %}, JetBrains IDEs, Eclipse IDE, and Xcode)_, 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).
### {% data variables.copilot.copilot_coding_agent %} ({% data variables.release-phases.public_preview %})
An autonomous AI agent that can make code changes for you. You can assign a {% data variables.product.github %} issue to {% data variables.product.prodname_copilot_short %} and the agent will work on making the required changes, and will create a pull request for you to review. You can also ask {% data variables.product.prodname_copilot_short %} to create a pull request from {% data variables.product.prodname_copilot_chat_short %}. See [AUTOTITLE](/copilot/using-github-copilot/coding-agent).
An autonomous AI agent that can make code changes for you. You can assign a {% data variables.product.github %} issue to {% data variables.product.prodname_copilot_short %} and the agent will work on making the required changes, and will create a pull request for you to review. You can also ask {% data variables.product.prodname_copilot_short %} to create a pull request from {% data variables.copilot.copilot_chat_short %}. See [AUTOTITLE](/copilot/using-github-copilot/coding-agent).
### {% data variables.product.prodname_copilot_cli_short %}
### {% data variables.copilot.copilot_cli_short %}
A chat-like interface in the terminal, where you can ask questions about the command line. You can ask {% data variables.product.prodname_copilot_short %} to provide command suggestions or explanations of commands. Users can also integrate {% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_windows_terminal %} Canary. See [AUTOTITLE](/copilot/using-github-copilot/using-github-copilot-in-the-command-line).
@@ -36,19 +36,19 @@ A chat-like interface in the terminal, where you can ask questions about the com
AI-generated code review suggestions to help you write better code. See [AUTOTITLE](/copilot/using-github-copilot/code-review/using-copilot-code-review).
### {% data variables.product.prodname_copilot_for_prs %}
### {% 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/using-github-copilot-for-pull-requests/creating-a-pull-request-summary-with-github-copilot).
### {% data variables.product.prodname_copilot_workspace %} ({% data variables.release-phases.public_preview %})
### {% data variables.copilot.copilot_workspace %} ({% data variables.release-phases.public_preview %})
A {% data variables.product.prodname_copilot_short %}-enabled environment for refining your pull requests, validating changes, and integrating suggestions from reviewers. See [AUTOTITLE](/copilot/using-github-copilot/using-github-copilot-for-pull-requests/using-copilot-to-help-you-work-on-a-pull-request).
### {% data variables.product.prodname_copilot_autocomplete_pr %} ({% data variables.release-phases.public_preview %})
### {% data variables.copilot.copilot_autocomplete_pr %} ({% data variables.release-phases.public_preview %})
AI-generated text completion to help you write pull request descriptions quickly and accurately. See [AUTOTITLE](/copilot/using-github-copilot/using-copilot-text-completion).
### {% data variables.product.prodname_copilot_extensions %}
### {% data variables.copilot.copilot_extensions %}
{% data reusables.copilot.copilot-extensions.copilot-extensions-intro %} See [AUTOTITLE](/copilot/building-copilot-extensions/about-building-copilot-extensions).
@@ -56,25 +56,29 @@ AI-generated text completion to help you write pull request descriptions quickly
Bringing the power of industry leading large and small language models to users directly on {% data variables.product.github %}. See [AUTOTITLE](/github-models).
### {% data variables.product.prodname_copilot_edits_short %}
### {% data variables.copilot.copilot_edits_short %}
{% data variables.product.prodname_copilot_edits_short %} is available in {% data variables.product.prodname_vscode %}, {% data variables.product.prodname_vs %}, and JetBrains IDEs. {% data reusables.copilot.copilot-edits.about-copilot-edits %}
{% data variables.copilot.copilot_edits_short %} is available in {% data variables.product.prodname_vscode %}, {% data variables.product.prodname_vs %}, and JetBrains IDEs. {% data reusables.copilot.copilot-edits.about-copilot-edits %}
### {% data variables.product.prodname_copilot_short %} custom instructions
Enhance {% data variables.product.prodname_copilot_chat_short %} responses by providing contextual details on your preferences, tools, and requirements. See [AUTOTITLE](/copilot/customizing-copilot/about-customizing-github-copilot-chat-responses).
Enhance {% data variables.copilot.copilot_chat_short %} responses by providing contextual details on your preferences, tools, and requirements. See [AUTOTITLE](/copilot/customizing-copilot/about-customizing-github-copilot-chat-responses).
### {% data variables.product.prodname_copilot_desktop_short %} ({% data variables.release-phases.public_preview %})
### {% data variables.copilot.copilot_desktop_short %} ({% data variables.release-phases.public_preview %})
Automatically generate commit messages and descriptions with {% data variables.product.prodname_copilot_desktop_short %} based on the changes you make to your project.
Automatically generate commit messages and descriptions with {% data variables.copilot.copilot_desktop_short %} based on the changes you make to your project.
### {% data variables.product.prodname_copilot_short %} knowledge bases _({% data variables.product.prodname_copilot_enterprise_short %} only)_
### {% data variables.copilot.copilot_spaces %} ({% data variables.release-phases.public_preview %})
Create and manage collections of documentation to use as context for chatting with {% data variables.product.prodname_copilot_short %}. When you ask a question in {% data variables.product.prodname_copilot_chat_dotcom_short %} or in {% data variables.product.prodname_vscode_shortname %}, you can specify a knowledge base as the context for your question. See [AUTOTITLE](/copilot/customizing-copilot/managing-copilot-knowledge-bases).
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).
### {% data variables.product.prodname_copilot_short %} knowledge bases _({% data variables.copilot.copilot_enterprise_short %} only)_
Create and manage collections of documentation to use as context for chatting with {% data variables.product.prodname_copilot_short %}. When you ask a question in {% data variables.copilot.copilot_chat_dotcom_short %} or in {% data variables.product.prodname_vscode_shortname %}, you can specify a knowledge base as the context for your question. See [AUTOTITLE](/copilot/customizing-copilot/managing-copilot-knowledge-bases).
## {% data variables.product.prodname_copilot %} features for administrators
The following features are available to organization and enterprise owners with a {% data variables.product.prodname_copilot_business_short %} or {% data variables.product.prodname_copilot_enterprise_short %} plan.
The following features are available to organization and enterprise owners with a {% data variables.copilot.copilot_business_short %} or {% data variables.copilot.copilot_enterprise_short %} plan.
### Policy management

View File

@@ -16,15 +16,15 @@ redirect_from:
{% data variables.product.company_short %} offers several plans for {% data variables.product.prodname_copilot %}, depending on your needs and whether you're using {% data variables.product.prodname_copilot_short %} as an individual or as part of an organization or enterprise.
* **{% data variables.product.prodname_copilot_free %}** is available to individual developers who don't have access to {% data variables.product.prodname_copilot_short %} through an organization or enterprise. This free plan includes limited access to select {% data variables.product.prodname_copilot_short %} features, allowing you to try AI-powered coding assistance at no cost.
* **{% data variables.copilot.copilot_free %}** is available to individual developers who don't have access to {% data variables.product.prodname_copilot_short %} through an organization or enterprise. This free plan includes limited access to select {% data variables.product.prodname_copilot_short %} features, allowing you to try AI-powered coding assistance at no cost.
* **{% data variables.product.prodname_copilot_pro %}** is designed for individuals who want more flexibility. This paid plan includes unlimited completions, access to premium models in {% data variables.product.prodname_copilot_chat_short %}, and a monthly allowance of premium requests. Verified students, teachers, and maintainers of popular open source projects may be eligible for free access.
* **{% data variables.copilot.copilot_pro %}** is designed for individuals who want more flexibility. This paid plan includes unlimited completions, access to premium models in {% data variables.copilot.copilot_chat_short %}, and a monthly allowance of premium requests. Verified students, teachers, and maintainers of popular open source projects may be eligible for free access.
* **{% data variables.product.prodname_copilot_pro_plus %}** offers the highest level of access for individual developers. In addition to everything in {% data variables.product.prodname_copilot_pro_short %}, this plan includes {% data variables.copilot.copilot_coding_agent %}, a larger allowance of premium requests, and full access to all available models in {% data variables.product.prodname_copilot_chat_short %}. Ideal for AI power users who want access to the most advanced capabilities.
* **{% data variables.copilot.copilot_pro_plus %}** offers the highest level of access for individual developers. In addition to everything in {% data variables.copilot.copilot_pro_short %}, this plan includes {% data variables.copilot.copilot_coding_agent %}, a larger allowance of premium requests, and full access to all available models in {% data variables.copilot.copilot_chat_short %}. Ideal for AI power users who want access to the most advanced capabilities.
* **{% data variables.product.prodname_copilot_for_business %}** is for organizations on {% data variables.product.prodname_free_team %} or {% data variables.product.prodname_team %} plan, or enterprises on {% data variables.product.prodname_ghe_cloud %}. This plan enables centralized management and {% data variables.product.prodname_copilot_short %} policy control for organization members.
* **{% data variables.copilot.copilot_for_business %}** is for organizations on {% data variables.product.prodname_free_team %} or {% data variables.product.prodname_team %} plan, or enterprises on {% data variables.product.prodname_ghe_cloud %}. This plan enables centralized management and {% data variables.product.prodname_copilot_short %} policy control for organization members.
* **{% data variables.product.prodname_copilot_enterprise %}** is for enterprises using {% data variables.product.prodname_ghe_cloud %}. It includes all the features of {% data variables.product.prodname_copilot_business_short %}, plus {% data variables.copilot.copilot_coding_agent %} and additional enterprise-grade capabilities. Enterprise owners can assign either {% data variables.product.prodname_copilot_enterprise_short %} or {% data variables.product.prodname_copilot_business_short %} to individual organizations.
* **{% data variables.copilot.copilot_enterprise %}** is for enterprises using {% data variables.product.prodname_ghe_cloud %}. It includes all the features of {% data variables.copilot.copilot_business_short %}, plus {% data variables.copilot.copilot_coding_agent %} and additional enterprise-grade capabilities. Enterprise owners can assign either {% data variables.copilot.copilot_enterprise_short %} or {% data variables.copilot.copilot_business_short %} to individual organizations.
{% data variables.product.prodname_copilot_short %} is not currently available for {% data variables.product.prodname_ghe_server %}.
@@ -40,12 +40,12 @@ For more information, see [AUTOTITLE](/copilot/about-github-copilot/github-copil
Start using {% data variables.product.prodname_copilot_short %} by signing up for the plan that best fits your needs.
* **{% data variables.product.prodname_copilot_free_short %}** — Try {% data variables.product.prodname_copilot_short %} with limited features and requests. [Start using {% data variables.product.prodname_copilot_free_short %}](https://github.com/copilot).
* **{% data variables.copilot.copilot_free_short %}** — Try {% data variables.product.prodname_copilot_short %} with limited features and requests. [Start using {% data variables.copilot.copilot_free_short %}](https://github.com/copilot).
* **{% data variables.product.prodname_copilot_pro_short %}** — Get unlimited completions and access to premium models. Includes a free 30-day trial for eligible users. [Try {% data variables.product.prodname_copilot_pro_short %} for free](https://github.com/github-copilot/signup?ref_cta=Copilot+trial&ref_loc=about+github+copilot&ref_page=docs).
* **{% data variables.copilot.copilot_pro_short %}** — Get unlimited completions and access to premium models. Includes a free 30-day trial for eligible users. [Try {% data variables.copilot.copilot_pro_short %} for free](https://github.com/github-copilot/signup?ref_cta=Copilot+trial&ref_loc=about+github+copilot&ref_page=docs).
* **{% data variables.product.prodname_copilot_pro_plus_short %}** — Unlock advanced AI models, extended request limits, and extra capabilities. [Subscribe to {% data variables.product.prodname_copilot_pro_plus_short %}](https://github.com/github-copilot/signup?ref_cta=Copilot+Pro%2B&ref_loc=subscriptions+page&ref_page=docs).
* **{% data variables.copilot.copilot_pro_plus_short %}** — Unlock advanced AI models, extended request limits, and extra capabilities. [Subscribe to {% data variables.copilot.copilot_pro_plus_short %}](https://github.com/github-copilot/signup?ref_cta=Copilot+Pro%2B&ref_loc=subscriptions+page&ref_page=docs).
* **{% data variables.product.prodname_copilot_business_short %}** — For teams and organizations. [Subscribe to {% data variables.product.prodname_copilot_business_short %}](https://github.com/github-copilot/purchase?priority=business&cft=copilot_li.copilot_plans.cfb).
* **{% data variables.copilot.copilot_business_short %}** — For teams and organizations. [Subscribe to {% data variables.copilot.copilot_business_short %}](https://github.com/github-copilot/purchase?priority=business&cft=copilot_li.copilot_plans.cfb).
* **{% data variables.product.prodname_copilot_enterprise_short %}** — For enterprises that need advanced features and centralized management. [Subscribe to {% data variables.product.prodname_copilot_enterprise_short %}](https://github.com/github-copilot/purchase?priority=enterprise&cft=copilot_li.copilot_plans.ce).
* **{% data variables.copilot.copilot_enterprise_short %}** — For enterprises that need advanced features and centralized management. [Subscribe to {% data variables.copilot.copilot_enterprise_short %}](https://github.com/github-copilot/purchase?priority=enterprise&cft=copilot_li.copilot_plans.ce).

View File

@@ -36,9 +36,10 @@ redirect_from:
* Get code suggestions as you type in your IDE
* Chat with {% data variables.product.prodname_copilot_short %} to ask for help with your code
* Ask {% data variables.product.prodname_copilot_short %} for help using the command line
* Generate a description of the changes in a pull request _({% data variables.product.prodname_copilot_enterprise_short %} only)_
* Create and manage collections of documentation, called knowledge bases, to use as a context for chatting with {% data variables.product.prodname_copilot_short %} _({% data variables.product.prodname_copilot_enterprise_short %} only)_
* Work on code changes and create a pull request for you to review _({% data variables.product.prodname_copilot_pro_plus_short %} and {% data variables.product.prodname_copilot_enterprise_short %} only)_
* Organize and share task-specific context with {% data variables.copilot.copilot_spaces %} to get more relevant answers
* Generate a description of the changes in a pull request _({% data variables.copilot.copilot_enterprise_short %} only)_
* Create and manage collections of documentation, called knowledge bases, to use as a context for chatting with {% data variables.product.prodname_copilot_short %} _({% data variables.copilot.copilot_enterprise_short %} only)_
* Work on code changes and create a pull request for you to review _({% data variables.copilot.copilot_pro_plus_short %} and {% data variables.copilot.copilot_enterprise_short %} only)_
{% data variables.product.prodname_copilot_short %} is available:
@@ -56,19 +57,19 @@ There are a few ways you can start using {% data variables.product.prodname_copi
### For individuals
* **Try {% data variables.product.prodname_copilot_short %} for free**: Use {% data variables.product.prodname_copilot_free_short %} to explore core {% data variables.product.prodname_copilot_short %} features with no paid plan required.
* **Subscribe to a paid plan**: Upgrade to {% data variables.product.prodname_copilot_pro_short %} or {% data variables.product.prodname_copilot_pro_plus_short %} for full access to premium features and more generous usage limits. You can <a href="https://github.com/github-copilot/signup?ref_cta=Copilot+trial&ref_loc=about+github+copilot&ref_page=docs" target="_blank"><span>try {% data variables.product.prodname_copilot_pro_short %} for free</span></a> with a one-time 30-day trial.
* **Eligible for free {% data variables.product.prodname_copilot_pro_short %} access?** Students, teachers, and open source maintainers may qualify for {% data variables.product.prodname_copilot_pro_short %} at no cost. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/getting-free-access-to-copilot-as-a-student-teacher-or-maintainer).
* **Try {% data variables.product.prodname_copilot_short %} for free**: Use {% data variables.copilot.copilot_free_short %} to explore core {% data variables.product.prodname_copilot_short %} features with no paid plan required.
* **Subscribe to a paid plan**: Upgrade to {% data variables.copilot.copilot_pro_short %} or {% data variables.copilot.copilot_pro_plus_short %} for full access to premium features and more generous usage limits. You can <a href="https://github.com/github-copilot/signup?ref_cta=Copilot+trial&ref_loc=about+github+copilot&ref_page=docs" target="_blank"><span>try {% data variables.copilot.copilot_pro_short %} for free</span></a> with a one-time 30-day trial.
* **Eligible for free {% data variables.copilot.copilot_pro_short %} access?** Students, teachers, and open source maintainers may qualify for {% data variables.copilot.copilot_pro_short %} at no cost. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/getting-free-access-to-copilot-as-a-student-teacher-or-maintainer).
* **Organization members**: If your organization or enterprise has a {% data variables.product.prodname_copilot %} plan, you can request access to {% data variables.product.prodname_copilot_short %} by going to [https://github.com/settings/copilot](https://github.com/settings/copilot) and requesting 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.
### For organizations and enterprises
* **Organization owners**: Purchase {% data variables.product.prodname_copilot_business_short %} for your team. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/subscribing-to-copilot-for-your-organization). If your organization is owned by an enterprise that has a {% data variables.product.prodname_copilot_short %} subscription, you can ask your enterprise owner to enable {% data variables.product.prodname_copilot_short %} for your organization by going to [https://github.com/settings/copilot](https://github.com/settings/copilot) and requesting access under "Get {% data variables.product.prodname_copilot_short %} from an organization."
* **Enterprise owners**: Purchase {% data variables.product.prodname_copilot_business_short %} or {% data variables.product.prodname_copilot_enterprise_short %} for your enterprise. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/subscribing-to-copilot-for-your-enterprise).
* **Organization owners**: Purchase {% data variables.copilot.copilot_business_short %} for your team. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/subscribing-to-copilot-for-your-organization). If your organization is owned by an enterprise that has a {% data variables.product.prodname_copilot_short %} subscription, you can ask your enterprise owner to enable {% data variables.product.prodname_copilot_short %} for your organization by going to [https://github.com/settings/copilot](https://github.com/settings/copilot) and requesting access under "Get {% data variables.product.prodname_copilot_short %} from an organization."
* **Enterprise owners**: Purchase {% data variables.copilot.copilot_business_short %} or {% data variables.copilot.copilot_enterprise_short %} for your enterprise. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/subscribing-to-copilot-for-your-enterprise).
If you **don't need other {% data variables.product.github %} features**, you can request an enterprise account specifically for managing {% data variables.product.prodname_copilot_business_short %} licenses. These accounts don't include repository or organization creation and dont incur {% data variables.product.prodname_enterprise %} seat charges. See [AUTOTITLE](/enterprise-cloud@latest/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business).
If you **don't need other {% data variables.product.github %} features**, you can request an enterprise account specifically for managing {% data variables.copilot.copilot_business_short %} licenses. These accounts don't include repository or organization creation and dont incur {% data variables.product.prodname_enterprise %} seat charges. See [AUTOTITLE](/enterprise-cloud@latest/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business).
## Next steps

View File

@@ -1,6 +1,6 @@
---
title: About building Copilot Extensions
intro: 'Learn about the development process for {% data variables.product.prodname_copilot_extensions_short %}.'
intro: 'Learn about the development process for {% data variables.copilot.copilot_extensions_short %}.'
product: '{% data reusables.gated-features.copilot-extensions %}'
versions:
feature: copilot-extensions
@@ -10,26 +10,26 @@ shortTitle: About building Extensions
type: overview
---
## About {% data variables.product.prodname_copilot_extensions_short %}
## About {% data variables.copilot.copilot_extensions_short %}
{% data variables.product.prodname_copilot_extensions_short %} are integrations that expand the functionality of {% data variables.product.prodname_copilot_chat_short %}, allowing developers to bring external tools, services, and custom behaviors into the Chat experience. You can use {% data variables.product.prodname_copilot_extensions_short %} to extend the capabilities of {% data variables.product.prodname_copilot_chat_short %} in a variety of ways, including:
{% data variables.copilot.copilot_extensions_short %} are integrations that expand the functionality of {% data variables.copilot.copilot_chat_short %}, allowing developers to bring external tools, services, and custom behaviors into the Chat experience. You can use {% data variables.copilot.copilot_extensions_short %} to extend the capabilities of {% data variables.copilot.copilot_chat_short %} in a variety of ways, including:
* **Querying documentation:** A {% data variables.product.prodname_copilot_extension_short %} can allow {% data variables.product.prodname_copilot_chat_short %} to query a third-party documentation service to find information about a specific topic.
* **AI-assisted coding:** A {% data variables.product.prodname_copilot_extension_short %} can use a third-party AI model to provide code suggestions.
* **Data retrieval:** A {% data variables.product.prodname_copilot_extension_short %} can allow {% data variables.product.prodname_copilot_chat_short %} to query a third-party data service to retrieve information about a specific topic.
* **Action execution:** A {% data variables.product.prodname_copilot_extension_short %} can allow {% data variables.product.prodname_copilot_chat_short %} to execute a specific action, such as posting to a message board or updating a tracking item in an external system.
* **Querying documentation:** A {% data variables.copilot.copilot_extension_short %} can allow {% data variables.copilot.copilot_chat_short %} to query a third-party documentation service to find information about a specific topic.
* **AI-assisted coding:** A {% data variables.copilot.copilot_extension_short %} can use a third-party AI model to provide code suggestions.
* **Data retrieval:** A {% data variables.copilot.copilot_extension_short %} can allow {% data variables.copilot.copilot_chat_short %} to query a third-party data service to retrieve information about a specific topic.
* **Action execution:** A {% data variables.copilot.copilot_extension_short %} can allow {% data variables.copilot.copilot_chat_short %} to execute a specific action, such as posting to a message board or updating a tracking item in an external system.
## About building {% data variables.product.prodname_copilot_extensions %}
## About building {% data variables.copilot.copilot_extensions %}
{% data variables.product.prodname_copilot_extensions %} are a type of {% data variables.product.prodname_copilot_extension_short %} built with {% data variables.product.prodname_github_apps %}. {% data variables.product.prodname_copilot_extensions %} are best suited for developers who want cross-platform compatibility and app management and support from {% data variables.product.github %}.
{% data variables.copilot.copilot_extensions %} are a type of {% data variables.copilot.copilot_extension_short %} built with {% data variables.product.prodname_github_apps %}. {% data variables.copilot.copilot_extensions %} are best suited for developers who want cross-platform compatibility and app management and support from {% data variables.product.github %}.
### Supported clients and IDEs
{% data reusables.copilot.copilot-extensions.supported-clients-and-ides-table %}
### About visibility of {% data variables.product.prodname_copilot_extensions %}
### About visibility of {% data variables.copilot.copilot_extensions %}
{% data variables.product.prodname_copilot_extensions %} can be private, public and shareable, or public and listed on the {% data variables.product.prodname_marketplace %}. Which visibility option you choose will depend on your use case and the audience you are targeting.
{% data variables.copilot.copilot_extensions %} can be private, public and shareable, or public and listed on the {% data variables.product.prodname_marketplace %}. Which visibility option you choose will depend on your use case and the audience you are targeting.
* Private extensions are often preferred by large enterprises or companies that:
* Want more customization and controls over data access
@@ -44,13 +44,13 @@ type: overview
* Integrate their tool into the developer workflow on {% data variables.product.company_short %} and the IDE
* Leverage the {% data variables.product.company_short %} ecosystem to raise awareness for their product
### About {% data variables.product.prodname_copilot_extensions %} permissions
### About {% data variables.copilot.copilot_extensions %} permissions
{% data reusables.copilot.copilot-extensions.about-extensions-permissions %}
#### Granting permissions to access organization resources
Only organization admins can grant permissions for {% data variables.product.prodname_copilot_extensions_short %} to access organization resources.
Only organization admins can grant permissions for {% data variables.copilot.copilot_extensions_short %} to access organization resources.
To grant organization members access:
* The organization admin must install the extension.
* The organization admin must grant the extension permission to access specific repositories.
@@ -64,9 +64,9 @@ For more information about skillsets, see [AUTOTITLE](/copilot/building-copilot-
### About context passing
You can allow your {% data variables.product.prodname_copilot_extension_short %} to receive context from the editor, such as the currently opened file, by enabling the **Read-only** access level for the "{% data variables.product.prodname_copilot_short %} Editor Context" permission in your {% data variables.product.prodname_github_app %} settings. See step 10 of [Configuring your {% data variables.product.prodname_github_app %}](/copilot/building-copilot-extensions/creating-a-copilot-extension/configuring-your-github-app-for-your-copilot-extension#configuring-your-github-app).
You can allow your {% data variables.copilot.copilot_extension_short %} to receive context from the editor, such as the currently opened file, by enabling the **Read-only** access level for the "{% data variables.product.prodname_copilot_short %} Editor Context" permission in your {% data variables.product.prodname_github_app %} settings. See step 10 of [Configuring your {% data variables.product.prodname_github_app %}](/copilot/building-copilot-extensions/creating-a-copilot-extension/configuring-your-github-app-for-your-copilot-extension#configuring-your-github-app).
The {% data variables.product.prodname_copilot_extensibility_platform %} automatically handles messaging when implicit and explicit context is unavailable or unauthorized. To enable context passing, you are required to request permissions from users. To enable context passing, you are required to:
The {% data variables.copilot.copilot_extensibility_platform %} automatically handles messaging when implicit and explicit context is unavailable or unauthorized. To enable context passing, you are required to request permissions from users. To enable context passing, you are required to:
* Update your APIs to handle new reference types.
* Request permissions from users. When requesting permissions, follow these best practices:
@@ -79,39 +79,39 @@ Context passing respects content exclusions, which refers to any files listed in
For more information about context passing, see [AUTOTITLE](/copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/context-passing-for-your-agent).
### Using APIs in {% data variables.product.prodname_copilot_extensions %}
### Using APIs in {% data variables.copilot.copilot_extensions %}
Building {% data variables.product.prodname_copilot_extensions %} requires using the {% data variables.product.github %} API. Optionally, the {% data variables.product.prodname_copilot_short %} API can be used for additional capabilities. For details on request and response formatting, see the [OpenAI API documentation](https://platform.openai.com/docs/api-reference/chat).
Building {% data variables.copilot.copilot_extensions %} requires using the {% data variables.product.github %} API. Optionally, the {% data variables.product.prodname_copilot_short %} API can be used for additional capabilities. For details on request and response formatting, see the [OpenAI API documentation](https://platform.openai.com/docs/api-reference/chat).
> [!NOTE] The {% data variables.product.prodname_copilot_short %} API is available for {% data variables.product.prodname_copilot_extension_short %} builders, but only {% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_vscode_shortname %} Chat extensions can be used to access these endpoints.
> [!NOTE] The {% data variables.product.prodname_copilot_short %} API is available for {% data variables.copilot.copilot_extension_short %} builders, but only {% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_vscode_shortname %} Chat extensions can be used to access these endpoints.
## Resources for building {% data variables.product.prodname_copilot_extensions %}
## Resources for building {% data variables.copilot.copilot_extensions %}
{% data variables.product.company_short %} provides a comprehensive toolkit for extension builders, with code samples, a CLI debugging tool, quickstart SDKs, and a user feedback repository. For more information, see the [copilot-extensions](https://github.com/orgs/copilot-extensions/) organization on {% data variables.product.company_short %}.
Before creating your own {% data variables.product.prodname_copilot_extension %} from scratch, you may want to explore an existing {% data variables.product.prodname_copilot_agent_short %}, then integrate it with a {% data variables.product.prodname_github_app %} to see how it works. {% data variables.product.company_short %} provides a few example {% data variables.product.prodname_copilot_agents_short %} that you can clone and use as the basis for your own {% data variables.product.prodname_copilot_extension %}:
Before creating your own {% data variables.copilot.copilot_extension %} from scratch, you may want to explore an existing {% data variables.copilot.copilot_agent_short %}, then integrate it with a {% data variables.product.prodname_github_app %} to see how it works. {% data variables.product.company_short %} provides a few example {% data variables.copilot.copilot_agents_short %} that you can clone and use as the basis for your own {% data variables.copilot.copilot_extension %}:
* **Blackbeard:** A simple {% data variables.product.prodname_copilot_agent_short %} that responds to requests like a pirate, using {% data variables.product.prodname_copilot_short %}'s LLM API and special system prompts. It is a good starting point for learning how to build a {% data variables.product.prodname_copilot_extension %}. For more information, see the [Blackbeard {% data variables.product.prodname_copilot_extension_short %}](https://github.com/copilot-extensions/blackbeard-extension).
* **{% data variables.product.prodname_github_models %}:** A more complex {% data variables.product.prodname_copilot_agent_short %} that lets you ask about and interact with various LLMs listed on the {% data variables.product.prodname_marketplace %} from within {% data variables.product.prodname_copilot_chat_short %}. For more information, see the [{% data variables.product.prodname_github_models %} {% data variables.product.prodname_copilot_extension_short %}](https://github.com/copilot-extensions/github-models-extension).
* **Blackbeard:** A simple {% data variables.copilot.copilot_agent_short %} that responds to requests like a pirate, using {% data variables.product.prodname_copilot_short %}'s LLM API and special system prompts. It is a good starting point for learning how to build a {% data variables.copilot.copilot_extension %}. For more information, see the [Blackbeard {% data variables.copilot.copilot_extension_short %}](https://github.com/copilot-extensions/blackbeard-extension).
* **{% data variables.product.prodname_github_models %}:** A more complex {% data variables.copilot.copilot_agent_short %} that lets you ask about and interact with various LLMs listed on the {% data variables.product.prodname_marketplace %} from within {% data variables.copilot.copilot_chat_short %}. For more information, see the [{% data variables.product.prodname_github_models %} {% data variables.copilot.copilot_extension_short %}](https://github.com/copilot-extensions/github-models-extension).
> [!NOTE] {% data variables.product.prodname_github_models %} are in {% data variables.release-phases.public_preview %} and subject to change. To request access, join the [waitlist](https://github.com/marketplace/models/waitlist).
* **Function calling:** an example agent written in Go that demonstrates function calling and confirmation dialogues. For more information, see the [Function calling extension](https://github.com/copilot-extensions/function-calling-extension).
* **RAG extension:** an example agent written in Go that demonstrates a simple implementation of retrieval augmented generation. For more information, see the [RAG extension](https://github.com/copilot-extensions/rag-extension).
* **Preview SDK:** An SDK that simplifies the process of building {% data variables.product.prodname_copilot_extensions %} by handling request verification, response formatting, and API interactions. It allows builders to focus on their extension's core functionality rather than boilerplate, by streamlining the integration of tools, APIs, and data sources into {% data variables.product.prodname_copilot_chat_short %}. For more information, see the [Preview SDK](https://github.com/copilot-extensions/preview-sdk.js).
* **Preview SDK:** An SDK that simplifies the process of building {% data variables.copilot.copilot_extensions %} by handling request verification, response formatting, and API interactions. It allows builders to focus on their extension's core functionality rather than boilerplate, by streamlining the integration of tools, APIs, and data sources into {% data variables.copilot.copilot_chat_short %}. For more information, see the [Preview SDK](https://github.com/copilot-extensions/preview-sdk.js).
## About building {% data variables.product.prodname_copilot_extensions_vsc %}
## About building {% data variables.copilot.copilot_extensions_vsc %}
> [!NOTE] The {% data variables.product.github %} documentation focuses on building {% data variables.product.prodname_copilot_extensions %}, not {% data variables.product.prodname_copilot_extensions_vsc %}.
> [!NOTE] The {% data variables.product.github %} documentation focuses on building {% data variables.copilot.copilot_extensions %}, not {% data variables.copilot.copilot_extensions_vsc %}.
You can build a {% data variables.product.prodname_copilot_extension_short %} that is exclusive and native to {% data variables.product.prodname_vscode %}, called a {% data variables.product.prodname_copilot_extensions_vsc %}. This option is best suited for developers who want to build extensions that use {% data variables.product.prodname_vscode_shortname %}-specific APIs and functionality, or extend existing {% data variables.product.prodname_vscode_shortname %} extensions.
You can build a {% data variables.copilot.copilot_extension_short %} that is exclusive and native to {% data variables.product.prodname_vscode %}, called a {% data variables.copilot.copilot_extensions_vsc %}. This option is best suited for developers who want to build extensions that use {% data variables.product.prodname_vscode_shortname %}-specific APIs and functionality, or extend existing {% data variables.product.prodname_vscode_shortname %} extensions.
Also known as {% data variables.product.prodname_vscode_shortname %} Chat extensions, {% data variables.product.prodname_copilot_extensions_vsc %} function similarly to {% data variables.product.prodname_copilot_extensions %} by extending the capabilities of {% data variables.product.prodname_copilot_chat_short %}, with a few notable differences:
Also known as {% data variables.product.prodname_vscode_shortname %} Chat extensions, {% data variables.copilot.copilot_extensions_vsc %} function similarly to {% data variables.copilot.copilot_extensions %} by extending the capabilities of {% data variables.copilot.copilot_chat_short %}, with a few notable differences:
* {% data variables.product.prodname_vscode_shortname %} Chat extensions are only usable in {% data variables.product.prodname_vscode_shortname %}.
* {% data variables.product.prodname_vscode_shortname %} Chat extensions have more access to {% data variables.product.prodname_vscode_shortname %}'s features and APIs, allowing more editor-specific interactions like accessing local workspace data, manipulating {% data variables.product.prodname_vscode %}'s interface, and read/write access to local files.
* {% data variables.product.prodname_vscode_shortname %} Chat extensions are published to the {% data variables.product.prodname_vs_marketplace_shortname %}, not the {% data variables.product.prodname_marketplace %}.
* {% data variables.product.prodname_vscode_shortname %} Chat extensions are local to the user's machine, and cannot be controlled by an organization{% ifversion ghec %} or enterprise's{% else %}'s{% endif %} policies.
For more information on {% data variables.product.prodname_copilot_extensions_vsc %}, see [Chat extensions](https://code.visualstudio.com/api/extension-guides/chat) in the {% data variables.product.prodname_vscode %} documentation.
For more information on {% data variables.copilot.copilot_extensions_vsc %}, see [Chat extensions](https://code.visualstudio.com/api/extension-guides/chat) in the {% data variables.product.prodname_vscode %} documentation.
## Further reading

View File

@@ -1,6 +1,6 @@
---
title: About Copilot agents
intro: 'Learn what {% data variables.product.prodname_copilot_agents %} are and how they can enhance your {% data variables.product.prodname_copilot_chat %} experience.'
intro: 'Learn what {% data variables.copilot.copilot_agents %} are and how they can enhance your {% data variables.copilot.copilot_chat %} experience.'
versions:
feature: copilot-extensions
topics:
@@ -9,11 +9,11 @@ shortTitle: About Copilot agents
type: overview
---
{% data variables.product.prodname_copilot_agents_short %} are custom tools embedded in {% data variables.product.prodname_copilot_extensions_short %}. They integrate with {% data variables.product.prodname_copilot_chat_short %} to provide additional functionalities tailored to specific needs. {% data variables.product.prodname_copilot_agents_short %} can perform various tasks such as querying documentation, retrieving data, executing specific actions, or providing AI-assisted coding suggestions. They enhance the capabilities of {% data variables.product.prodname_copilot %} by allowing developers to build and integrate custom features directly into the {% data variables.product.prodname_copilot_chat_short %} interface.
{% data variables.copilot.copilot_agents_short %} are custom tools embedded in {% data variables.copilot.copilot_extensions_short %}. They integrate with {% data variables.copilot.copilot_chat_short %} to provide additional functionalities tailored to specific needs. {% data variables.copilot.copilot_agents_short %} can perform various tasks such as querying documentation, retrieving data, executing specific actions, or providing AI-assisted coding suggestions. They enhance the capabilities of {% data variables.product.prodname_copilot %} by allowing developers to build and integrate custom features directly into the {% data variables.copilot.copilot_chat_short %} interface.
To use a {% data variables.product.prodname_copilot_agent_short %} in {% data variables.product.prodname_copilot_chat_short %}, it must be associated with a {% data variables.product.prodname_github_app %}. This combination of a {% data variables.product.prodname_github_app %} and a {% data variables.product.prodname_copilot_agent_short %} is what we refer to as a {% data variables.product.prodname_copilot_extension %}. For more information on {% data variables.product.prodname_copilot_extensions_short %}, see [AUTOTITLE](/copilot/building-copilot-extensions/about-building-copilot-extensions).
To use a {% data variables.copilot.copilot_agent_short %} in {% data variables.copilot.copilot_chat_short %}, it must be associated with a {% data variables.product.prodname_github_app %}. This combination of a {% data variables.product.prodname_github_app %} and a {% data variables.copilot.copilot_agent_short %} is what we refer to as a {% data variables.copilot.copilot_extension %}. For more information on {% data variables.copilot.copilot_extensions_short %}, see [AUTOTITLE](/copilot/building-copilot-extensions/about-building-copilot-extensions).
Any {% data variables.product.company_short %} user can create a {% data variables.product.prodname_copilot_extension_short %} by building a {% data variables.product.prodname_copilot_agent_short %} and associating it with a {% data variables.product.prodname_github_app %}. For more information on creating a {% data variables.product.prodname_copilot_extension_short %}, see [AUTOTITLE](/copilot/building-copilot-extensions/setting-up-copilot-extensions).
Any {% data variables.product.company_short %} user can create a {% data variables.copilot.copilot_extension_short %} by building a {% data variables.copilot.copilot_agent_short %} and associating it with a {% data variables.product.prodname_github_app %}. For more information on creating a {% data variables.copilot.copilot_extension_short %}, see [AUTOTITLE](/copilot/building-copilot-extensions/setting-up-copilot-extensions).
## Further reading

View File

@@ -1,6 +1,6 @@
---
title: Configuring your Copilot agent to communicate with GitHub
intro: 'Learn how to verify payloads and get resources from {% data variables.product.github %} with your {% data variables.product.prodname_copilot_agent_short %}.'
intro: 'Learn how to verify payloads and get resources from {% data variables.product.github %} with your {% data variables.copilot.copilot_agent_short %}.'
versions:
feature: copilot-extensions
topics:
@@ -15,7 +15,7 @@ type: reference
## Verifying that payloads are coming from {% data variables.product.github %}
Before your {% data variables.product.prodname_copilot_agent_short %} begins processing a request, you should verify that the request came from {% data variables.product.github %}, and that it is intended for your agent. All agent requests contain the `X-GitHub-Public-Key-Identifier` and `X-GitHub-Public-Key-Signature` headers. To verify the signature for a particular request, compare the signature in the `X-GitHub-Public-Key-Signature` header with a signed copy of the request body using the current public key listed at https://api.github.com/meta/public_keys/copilot_api.
Before your {% data variables.copilot.copilot_agent_short %} begins processing a request, you should verify that the request came from {% data variables.product.github %}, and that it is intended for your agent. All agent requests contain the `X-GitHub-Public-Key-Identifier` and `X-GitHub-Public-Key-Signature` headers. To verify the signature for a particular request, compare the signature in the `X-GitHub-Public-Key-Signature` header with a signed copy of the request body using the current public key listed at https://api.github.com/meta/public_keys/copilot_api.
For more details and examples of signature verification in specific languages, see the [`github-technology-partners/signature-verification`](https://github.com/github-technology-partners/signature-verification) repository.
@@ -23,7 +23,7 @@ For more details and examples of signature verification in specific languages, s
## Fetching resources from the {% data variables.product.github %} API
Requests to your {% data variables.product.prodname_copilot_agent_short %} will receive an `X-GitHub-Token` header. This header contains an API token that can be used to fetch resources from the {% data variables.product.github %} API on behalf of the user interacting with your agent. The permissions of this token are the overlap of the user's own permissions and the permissions granted to your {% data variables.product.prodname_github_app %} installation.
Requests to your {% data variables.copilot.copilot_agent_short %} will receive an `X-GitHub-Token` header. This header contains an API token that can be used to fetch resources from the {% data variables.product.github %} API on behalf of the user interacting with your agent. The permissions of this token are the overlap of the user's own permissions and the permissions granted to your {% data variables.product.prodname_github_app %} installation.
For an example of how you might use `X-GitHub-Token`, see the following code sample:

View File

@@ -1,6 +1,6 @@
---
title: Configuring your Copilot agent to communicate with the Copilot platform
intro: 'Learn how to interact with the {% data variables.product.prodname_copilot_short %} platform by sending and receiving server-sent events with your {% data variables.product.prodname_copilot_agent_short %}.'
intro: 'Learn how to interact with the {% data variables.product.prodname_copilot_short %} platform by sending and receiving server-sent events with your {% data variables.copilot.copilot_agent_short %}.'
versions:
feature: copilot-extensions
topics:
@@ -10,7 +10,7 @@ type: reference
layout: inline
---
{% data variables.product.prodname_copilot_agents_short %} communicate with the {% data variables.product.prodname_copilot_short %} platform in the form of server-sent events (SSEs). Rather than waiting for the {% data variables.product.prodname_copilot_short %} platform to request an update from your agent, or vice versa, you can use SSEs to send and receive updates to and from the platform in real time.
{% data variables.copilot.copilot_agents_short %} communicate with the {% data variables.product.prodname_copilot_short %} platform in the form of server-sent events (SSEs). Rather than waiting for the {% data variables.product.prodname_copilot_short %} platform to request an update from your agent, or vice versa, you can use SSEs to send and receive updates to and from the platform in real time.
To learn more about SSEs, see [Server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events) in the mdn documentation.
@@ -87,7 +87,7 @@ data: [{
### `copilot_references`
> [!NOTE] Rendering references is currently unsupported for {% data variables.product.prodname_copilot_mobile_short %}. Extensions that depend on reference memory to generate responses will still work, but the references will not be displayed to the user.
> [!NOTE] Rendering references is currently unsupported for {% data variables.copilot.copilot_mobile_short %}. Extensions that depend on reference memory to generate responses will still work, but the references will not be displayed to the user.
The `copilot_references` SSE sends the user a list of references used to generate a response. This SSE is sent through an event type and data field. See the following code for an example of a `copilot_references` SSE:
@@ -149,4 +149,4 @@ curl --request POST \
## Next steps
Now that you understand how your {% data variables.product.prodname_copilot_agent_short %} communicates with the {% data variables.product.prodname_copilot_short %} platform, you can learn how to integrate your agent with the {% data variables.product.github %} API. See [AUTOTITLE](/copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/configuring-your-copilot-agent-to-communicate-with-github).
Now that you understand how your {% data variables.copilot.copilot_agent_short %} communicates with the {% data variables.product.prodname_copilot_short %} platform, you can learn how to integrate your agent with the {% data variables.product.github %} API. See [AUTOTITLE](/copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/configuring-your-copilot-agent-to-communicate-with-github).

View File

@@ -1,6 +1,6 @@
---
title: Context passing for your agent
intro: 'Learn how to use context passing with your {% data variables.product.prodname_copilot_agent_short %}.'
intro: 'Learn how to use context passing with your {% data variables.copilot.copilot_agent_short %}.'
versions:
feature: copilot-extensions
topics:
@@ -11,12 +11,12 @@ type: how_to
## About context passing
{% data variables.product.prodname_copilot_extensions %} can access certain contextual information using context passing.
{% data variables.copilot.copilot_extensions %} can access certain contextual information using context passing.
Context passing allows agents to receive relevant details about a users current file, selected text, and repository.
It happens automatically when you interact with an extension, but requires your explicit authorization through {% data variables.product.prodname_github_app %} permissions for use in any organization-owned repositories.
Different clients, such as {% data variables.product.prodname_copilot_chat %} in {% data variables.product.prodname_vscode %}, {% data variables.product.prodname_vs %}, and {% data variables.product.github %}, provide context through different reference types.
For example, IDEs send information such as file contents and selections, while {% data variables.product.prodname_copilot_chat_dotcom_short %} includes the current URL for the page being viewed.
Different clients, such as {% data variables.copilot.copilot_chat %} in {% data variables.product.prodname_vscode %}, {% data variables.product.prodname_vs %}, and {% data variables.product.github %}, provide context through different reference types.
For example, IDEs send information such as file contents and selections, while {% data variables.copilot.copilot_chat_dotcom_short %} includes the current URL for the page being viewed.
## Prerequisites
@@ -28,7 +28,7 @@ Context passing enables agents to receive information about the users active
Your agent receives server-sent events (SSEs) that contain a list of messages from the user as well as references to the users current environment.
Depending on the client, different types of context are provided.
The following table shows the reference types that are passed to {% data variables.product.prodname_copilot_extensions %} based on the client or IDE you are using.
The following table shows the reference types that are passed to {% data variables.copilot.copilot_extensions %} based on the client or IDE you are using.
{% rowheaders %}
@@ -41,14 +41,14 @@ The following table shows the reference types that are passed to {% data variabl
{% endrowheaders %}
### Reference types for {% data variables.product.prodname_copilot_chat_short %} in IDEs
### Reference types for {% data variables.copilot.copilot_chat_short %} in IDEs
The following reference types can be passed to your agent from an IDE:
* `client.file`: Represents the full content of the currently active file in the IDE.
* `client.selection`: Represents the selected portion of text the user highlighted in the active file.
* `github.repository`: Provides information about the active repository.
### Reference types for {% data variables.product.prodname_copilot_chat_dotcom_short %}
### Reference types for {% data variables.copilot.copilot_chat_dotcom_short %}
The following reference types can be passed to your agent from {% data variables.product.github %}:
* `github.current-url`: Represents the URL of the current {% data variables.product.github %} page the user is viewing.

View File

@@ -1,7 +1,7 @@
---
title: Building a Copilot agent for your Copilot Extension
shortTitle: Build a Copilot agent
intro: 'Learn how to build a custom {% data variables.product.prodname_copilot_agent_short %} that determines the functionality of your {% data variables.product.prodname_copilot_extension_short %}.'
intro: 'Learn how to build a custom {% data variables.copilot.copilot_agent_short %} that determines the functionality of your {% data variables.copilot.copilot_extension_short %}.'
versions:
feature: copilot
topics:

View File

@@ -1,15 +1,15 @@
---
title: About Copilot skillsets
intro: 'Learn what {% data variables.product.prodname_copilot_skillsets %} are and how they simplify integrating third-party tools and functions into your {% data variables.product.prodname_copilot_short %} experience.'
intro: 'Learn what {% data variables.copilot.copilot_skillsets %} are and how they simplify integrating third-party tools and functions into your {% data variables.product.prodname_copilot_short %} experience.'
versions:
feature: copilot-extensions
topics:
- Copilot
shortTitle: About {% data variables.product.prodname_copilot_skillsets_short %}
shortTitle: About {% data variables.copilot.copilot_skillsets_short %}
type: overview
---
A skill within {% data variables.product.prodname_copilot %} is a tool that the model calls to perform a specific task in response to a user query. A skillset is a collection of these skills (up to five per skillset). {% data variables.product.prodname_copilot_skillsets %} provide a streamlined way to extend {% data variables.product.prodname_copilot_short %}s functionality, allowing builders to integrate external services or custom API endpoints into their {% data variables.product.prodname_copilot_short %} workflow. With skillsets, builders can enable {% data variables.product.prodname_copilot_short %} to perform tasks—such as retrieving data or executing actions in third-party services—without needing to manage complex workflows or architecture.
A skill within {% data variables.product.prodname_copilot %} is a tool that the model calls to perform a specific task in response to a user query. A skillset is a collection of these skills (up to five per skillset). {% data variables.copilot.copilot_skillsets %} provide a streamlined way to extend {% data variables.product.prodname_copilot_short %}s functionality, allowing builders to integrate external services or custom API endpoints into their {% data variables.product.prodname_copilot_short %} workflow. With skillsets, builders can enable {% data variables.product.prodname_copilot_short %} to perform tasks—such as retrieving data or executing actions in third-party services—without needing to manage complex workflows or architecture.
For a quickstart example of a skillset, see the [skillset-example](https://github.com/copilot-extensions/skillset-example) repository. For information on building a skillset, see [AUTOTITLE](/copilot/building-copilot-extensions/building-a-copilot-skillset-for-your-copilot-extension/building-copilot-skillsets).
@@ -20,14 +20,14 @@ For a quickstart example of a skillset, see the [skillset-example](https://githu
## The extensibility platform
Skillsets and agents both operate on the {% data variables.product.prodname_copilot_extensibility_platform %}, which manages the flow of user requests and function evaluations. With {% data variables.product.prodname_copilot_skillsets_short %}, the platform handles routing, prompt crafting, function calls and prompt generation.
Skillsets and agents both operate on the {% data variables.copilot.copilot_extensibility_platform %}, which manages the flow of user requests and function evaluations. With {% data variables.copilot.copilot_skillsets_short %}, the platform handles routing, prompt crafting, function calls and prompt generation.
### Workflow overview
The extensibility platform follows a structured workflow to process user requests and generate responses:
1. **User request**
A user issues a request in the {% data variables.product.prodname_copilot_chat_short %} interface, such as asking for data or executing a specific action.
A user issues a request in the {% data variables.copilot.copilot_chat_short %} interface, such as asking for data or executing a specific action.
1. **Routing**
The request is routed to the appropriate extension. For skillsets, this means the platform agent identifies and invokes the corresponding skillset based on the users intent. Each skills inference description helps the platform determine which skill to call.
@@ -47,7 +47,7 @@ The language model (LLM) processes the prompt and determines:
1. **Function Evaluation**
The extension invokes the selected function(s), which may involve:
* Gathering relevant context, such as {% data variables.product.prodname_copilot_skillsets_short %} repository or user metadata.
* Gathering relevant context, such as {% data variables.copilot.copilot_skillsets_short %} repository or user metadata.
* Making an API call to an external service to retrieve data or execute an action.
1. **Response generation**

View File

@@ -1,17 +1,17 @@
---
title: Building Copilot skillsets
intro: 'Learn the steps to build {% data variables.product.prodname_copilot_skillsets %} and integrate custom tools and functions into your Copilot environment.'
intro: 'Learn the steps to build {% data variables.copilot.copilot_skillsets %} and integrate custom tools and functions into your Copilot environment.'
versions:
feature: copilot-extensions
topics:
- Copilot
shortTitle: Build {% data variables.product.prodname_copilot_skillsets_short %}
shortTitle: Build {% data variables.copilot.copilot_skillsets_short %}
type: how_to
---
## Introduction
{% data variables.product.prodname_copilot_skillsets %} are a streamlined way to extend {% data variables.product.prodname_copilot %}'s functionality by defining API endpoints that {% data variables.product.prodname_copilot_short %} can call. When you create a skillset, {% data variables.product.prodname_copilot_short %} handles all the AI interactions while your endpoints provide the data or functionality. This guide walks you through configuring and deploying a skillset within your {% data variables.product.prodname_github_app %}.
{% data variables.copilot.copilot_skillsets %} are a streamlined way to extend {% data variables.product.prodname_copilot %}'s functionality by defining API endpoints that {% data variables.product.prodname_copilot_short %} can call. When you create a skillset, {% data variables.product.prodname_copilot_short %} handles all the AI interactions while your endpoints provide the data or functionality. This guide walks you through configuring and deploying a skillset within your {% data variables.product.prodname_github_app %}.
## Prerequisites

View File

@@ -1,7 +1,7 @@
---
title: Building a Copilot skillset for your Copilot Extension
shortTitle: Build a Copilot skillset
intro: 'Learn how to build a custom {% data variables.product.prodname_copilot_skillset_short %} to combine custom skills and extend the capabilities of {% data variables.product.prodname_copilot_short %}.'
intro: 'Learn how to build a custom {% data variables.copilot.copilot_skillset_short %} to combine custom skills and extend the capabilities of {% data variables.product.prodname_copilot_short %}.'
versions:
feature: copilot
topics:

View File

@@ -1,6 +1,6 @@
---
title: Copilot Extensions FAQ
intro: 'Find answers to common questions about {% data variables.product.prodname_copilot_extensions %}.'
intro: 'Find answers to common questions about {% data variables.copilot.copilot_extensions %}.'
versions:
feature: copilot-extensions
topics:
@@ -11,79 +11,79 @@ type: reference
## General
This section answers common questions about {% data variables.product.prodname_copilot_extensions %}.
This section answers common questions about {% data variables.copilot.copilot_extensions %}.
* [What is the difference between a {% data variables.product.prodname_copilot_extension %} and a {% data variables.product.prodname_vscode %} chat participant?](#what-is-the-difference-between-a-github-copilot-extension-and-a-visual-studio-code-chat-participant)
* [Is indemnity provided for {% data variables.product.prodname_copilot_extensions_short %}?](#is-indemnity-provided-for-copilot-extensions)
* [What is the difference between a {% data variables.copilot.copilot_extension %} and a {% data variables.product.prodname_vscode %} chat participant?](#what-is-the-difference-between-a-github-copilot-extension-and-a-visual-studio-code-chat-participant)
* [Is indemnity provided for {% data variables.copilot.copilot_extensions_short %}?](#is-indemnity-provided-for-copilot-extensions)
### What is the difference between a {% data variables.product.prodname_copilot_extension %} and a {% data variables.product.prodname_vscode %} chat participant?
### What is the difference between a {% data variables.copilot.copilot_extension %} and a {% data variables.product.prodname_vscode %} chat participant?
{% data variables.product.prodname_copilot_extensions %} and {% data variables.product.prodname_vscode %} chat participants use the same backend platform to route requests to extensions. Both provide similar end-user experiences, integrate with {% data variables.product.prodname_copilot_chat_short %}, and can leverage the {% data variables.product.prodname_copilot_short %} API or other LLMs.
{% data variables.copilot.copilot_extensions %} and {% data variables.product.prodname_vscode %} chat participants use the same backend platform to route requests to extensions. Both provide similar end-user experiences, integrate with {% data variables.copilot.copilot_chat_short %}, and can leverage the {% data variables.product.prodname_copilot_short %} API or other LLMs.
While they share similarities, below are several key differences:
* {% data variables.product.prodname_copilot_extensions %} and {% data variables.product.prodname_vscode %} chat participants are accessed through different marketplaces.
* {% data variables.product.prodname_copilot_extensions %} are server-side extensions, requiring server infrastructure to build. These extensions provide a built-in connection to your {% data variables.product.github %} workspaces, as set by your organization admin.
* {% data variables.copilot.copilot_extensions %} and {% data variables.product.prodname_vscode %} chat participants are accessed through different marketplaces.
* {% data variables.copilot.copilot_extensions %} are server-side extensions, requiring server infrastructure to build. These extensions provide a built-in connection to your {% data variables.product.github %} workspaces, as set by your organization admin.
* {% data variables.product.prodname_vscode %} chat participants are client-side extensions that have read and write access to your local files. They do not require server infrastructure.
* {% data variables.product.prodname_copilot_extensions %} can be used in any editor where extensions are supported, while {% data variables.product.prodname_vscode %} Chat Participants are only available in {% data variables.product.prodname_vscode %}.
* {% data variables.copilot.copilot_extensions %} can be used in any editor where extensions are supported, while {% data variables.product.prodname_vscode %} Chat Participants are only available in {% data variables.product.prodname_vscode %}.
For more information, see [AUTOTITLE](/copilot/building-copilot-extensions/about-building-copilot-extensions).
### Is indemnity provided for {% data variables.product.prodname_copilot_extensions_short %}?
### Is indemnity provided for {% data variables.copilot.copilot_extensions_short %}?
No, {% data variables.product.prodname_copilot_extensions_short %} are not covered by {% data variables.product.prodname_copilot %}s indemnity policy. However, this exclusion applies only to issues that arise within extension chat threads.
No, {% data variables.copilot.copilot_extensions_short %} are not covered by {% data variables.product.prodname_copilot %}s indemnity policy. However, this exclusion applies only to issues that arise within extension chat threads.
Installing and using extensions does not affect indemnity coverage for any issues that occur while using other {% data variables.product.prodname_copilot_short %} features such as code completion and chat.
## Data and Permissions
This section explains what data is collected and shared when using {% data variables.product.prodname_copilot_extensions_short %}.
This section explains what data is collected and shared when using {% data variables.copilot.copilot_extensions_short %}.
* [What data is being collected and shared with {% data variables.product.prodname_copilot_extensions_short %}?](#what-data-is-being-collected-and-shared-with-copilot-extensions)
* [What permissions are required for {% data variables.product.prodname_copilot_extensions_short %}?](#what-permissions-are-required-for-copilot-extensions)
* [Who can provide permissions for {% data variables.product.prodname_copilot_extensions_short %} to access organization resources?](#who-can-provide-permissions-for-copilot-extensions-to-access-organization-resources)
* [Can a user use {% data variables.product.prodname_copilot_extensions_short %} that the organization has not provided permissions for?](#can-a-user-use-copilot-extensions-that-the-organization-has-not-provided-permissions-for)
* [What data is being collected and shared with {% data variables.copilot.copilot_extensions_short %}?](#what-data-is-being-collected-and-shared-with-copilot-extensions)
* [What permissions are required for {% data variables.copilot.copilot_extensions_short %}?](#what-permissions-are-required-for-copilot-extensions)
* [Who can provide permissions for {% data variables.copilot.copilot_extensions_short %} to access organization resources?](#who-can-provide-permissions-for-copilot-extensions-to-access-organization-resources)
* [Can a user use {% data variables.copilot.copilot_extensions_short %} that the organization has not provided permissions for?](#can-a-user-use-copilot-extensions-that-the-organization-has-not-provided-permissions-for)
### What data is being collected and shared with {% data variables.product.prodname_copilot_extensions_short %}?
### What data is being collected and shared with {% data variables.copilot.copilot_extensions_short %}?
The following data is shared when interacting with {% data variables.product.prodname_copilot_extensions_short %}:
* Data attached to your account and {% data variables.product.prodname_copilot_chat_short %} usage, such as {% data variables.product.github %} user ID, and timestamps of messages.
The following data is shared when interacting with {% data variables.copilot.copilot_extensions_short %}:
* Data attached to your account and {% data variables.copilot.copilot_chat_short %} usage, such as {% data variables.product.github %} user ID, and timestamps of messages.
* Past messages within the chat thread where you are invoking an extension. Only one extension can be used per thread, preventing data sharing across extensions. The data retention period for thread context is 30 days.
* Any additional organization and repository data that is authorized for the extension by your organization admin. Admins installing extensions must approve access to the required permissions prior to completing installation.
* For {% data variables.product.prodname_copilot_chat_dotcom_short %}, if your admin has approved the extension to access repository or organization metadata , that data will be shared as well.
* For {% data variables.copilot.copilot_chat_dotcom_short %}, if your admin has approved the extension to access repository or organization metadata , that data will be shared as well.
### What permissions are required for {% data variables.product.prodname_copilot_extensions_short %}?
### What permissions are required for {% data variables.copilot.copilot_extensions_short %}?
{% data reusables.copilot.copilot-extensions.about-extensions-permissions %}
### Who can provide permissions for {% data variables.product.prodname_copilot_extensions_short %} to access organization resources?
### Who can provide permissions for {% data variables.copilot.copilot_extensions_short %} to access organization resources?
Only organization admins can grant permissions for {% data variables.product.prodname_copilot_extensions_short %} to access organization resources.
Only organization admins can grant permissions for {% data variables.copilot.copilot_extensions_short %} to access organization resources.
Organization members may encounter cases where an extension cannot access a repository or query context. This typically happens because the organization admin has not yet provided permissions or authorized the extension. See [Granting permissions to access organization resources](/copilot/building-copilot-extensions/about-building-copilot-extensions#granting-permissions-to-access-organization-resources).
### Can a user use {% data variables.product.prodname_copilot_extensions_short %} that the organization has not provided permissions for?
### Can a user use {% data variables.copilot.copilot_extensions_short %} that the organization has not provided permissions for?
Yes, any user can install and use {% data variables.product.prodname_copilot_extensions_short %}. However, to query organization resources and repositories, an extension must be installed and authorized by an organization admin. See [Granting permissions to access organization resources](/copilot/building-copilot-extensions/about-building-copilot-extensions#granting-permissions-to-access-organization-resources).
Yes, any user can install and use {% data variables.copilot.copilot_extensions_short %}. However, to query organization resources and repositories, an extension must be installed and authorized by an organization admin. See [Granting permissions to access organization resources](/copilot/building-copilot-extensions/about-building-copilot-extensions#granting-permissions-to-access-organization-resources).
Users should contact their organization admin to request installation and authorization. Company context cannot be accessed without admin permissions.
## Policies
This section covers administrative policies for {% data variables.product.prodname_copilot_extensions_short %}
This section covers administrative policies for {% data variables.copilot.copilot_extensions_short %}
* [How do I control which {% data variables.product.prodname_copilot_extensions_short %} can be used in my enterprise?](#how-do-i-control-which-copilot-extensions-can-be-used-in-my-enterprise)
* [How do I control which {% data variables.copilot.copilot_extensions_short %} can be used in my enterprise?](#how-do-i-control-which-copilot-extensions-can-be-used-in-my-enterprise)
* [Is there an allowlist/blocklist at the enterprise level?](#is-there-an-allowlistblocklist-at-the-enterprise-level)
* [As a member of an organization, how can I get access to {% data variables.product.prodname_copilot_extensions_short %}?](#as-a-member-of-an-organization-how-can-i-get-access-to-copilot-extensions)
* [As a member of an organization, how can I get access to {% data variables.copilot.copilot_extensions_short %}?](#as-a-member-of-an-organization-how-can-i-get-access-to-copilot-extensions)
### How do I control which {% data variables.product.prodname_copilot_extensions_short %} can be used in my enterprise?
### How do I control which {% data variables.copilot.copilot_extensions_short %} can be used in my enterprise?
Enterprise admins can disable {% data variables.product.prodname_copilot_extensions_short %} across their enterprise by setting the **{% data variables.product.prodname_copilot_extensions_short %}** policy to "Disabled" or "No Policy".
Enterprise admins can disable {% data variables.copilot.copilot_extensions_short %} across their enterprise by setting the **{% data variables.copilot.copilot_extensions_short %}** policy to "Disabled" or "No Policy".
### Is there an allowlist/blocklist at the enterprise level?
No, there is no allowlist or blocklist at the enterprise level.
### As a member of an organization, how can I get access to {% data variables.product.prodname_copilot_extensions_short %}?
### As a member of an organization, how can I get access to {% data variables.copilot.copilot_extensions_short %}?
To access {% data variables.product.prodname_copilot_extensions_short %} as a member of an organization, the organization that assigned you a {% data variables.product.github %} seat must enable the {% data variables.product.prodname_copilot_extensions_short %} policy. Additionally, the same organization must install and authorize the extension to access any organization owned repositories.
To access {% data variables.copilot.copilot_extensions_short %} as a member of an organization, the organization that assigned you a {% data variables.product.github %} seat must enable the {% data variables.copilot.copilot_extensions_short %} policy. Additionally, the same organization must install and authorize the extension to access any organization owned repositories.
For example, if you are a member of multiple organizations and Organization A has assigned you a {% data variables.product.github %} seat, you will only have access to extensions if Organization A has enabled the policy. If Organization B has enabled extensions but you do not have access, it is because Organization A has disabled the {% data variables.product.prodname_copilot_extensions_short %} policy.
For example, if you are a member of multiple organizations and Organization A has assigned you a {% data variables.product.github %} seat, you will only have access to extensions if Organization A has enabled the policy. If Organization B has enabled extensions but you do not have access, it is because Organization A has disabled the {% data variables.copilot.copilot_extensions_short %} policy.

View File

@@ -1,6 +1,6 @@
---
title: Copilot Extensions Glossary
intro: 'Understand the terminology used in {% data variables.product.prodname_copilot_extensions_short %}.'
intro: 'Understand the terminology used in {% data variables.copilot.copilot_extensions_short %}.'
versions:
feature: copilot-extensions
topics:
@@ -9,39 +9,39 @@ shortTitle: Extensions Glossary
type: reference
---
The following terms are used in the context of {% data variables.product.prodname_copilot_extensions_short %}, and are defined here for clarity.
The following terms are used in the context of {% data variables.copilot.copilot_extensions_short %}, and are defined here for clarity.
#### Agent
A type of {% data variables.product.prodname_copilot_extension_short %} implementation that gives developers full control over handling user queries and response generation. This approach is ideal for builders who want complete customization and management of AI interactions.
A type of {% data variables.copilot.copilot_extension_short %} implementation that gives developers full control over handling user queries and response generation. This approach is ideal for builders who want complete customization and management of AI interactions.
#### Context Passing
A capability in {% data variables.product.prodname_copilot_extensions_short %} that enables user context from editors to be sent to agents, allowing for more tailored responses.
A capability in {% data variables.copilot.copilot_extensions_short %} that enables user context from editors to be sent to agents, allowing for more tailored responses.
#### {% data variables.product.prodname_copilot_chat_short %}
#### {% data variables.copilot.copilot_chat_short %}
The conversational interface within {% data variables.product.prodname_copilot %} where users can interact with the AI assistant and extensions.
#### {% data variables.product.prodname_copilot_extension_short %}
#### {% data variables.copilot.copilot_extension_short %}
A {% data variables.product.prodname_github_app %} with additional access to the {% data variables.product.prodname_copilot_chat_short %} window and Copilot API, allowing for extended functionality in {% data variables.product.company_short %}'s {% data variables.product.prodname_copilot_chat_short %}. This is how we will refer to extensions from the perspective of an extension user.
A {% data variables.product.prodname_github_app %} with additional access to the {% data variables.copilot.copilot_chat_short %} window and Copilot API, allowing for extended functionality in {% data variables.product.company_short %}'s {% data variables.copilot.copilot_chat_short %}. This is how we will refer to extensions from the perspective of an extension user.
#### {% data variables.product.prodname_copilot_short %} Extensibility Platform
The system that handles authentication and proxies requests between clients and agent plugins.
#### {% data variables.product.prodname_copilot_extension_vsc %}
#### {% data variables.copilot.copilot_extension_vsc %}
Also known as {% data variables.product.prodname_vscode %} Chat extensions, {% data variables.product.prodname_copilot_extensions_vsc %} are built as a {% data variables.product.prodname_vscode %} extension rather than a {% data variables.product.prodname_github_app %}. These extensions are exclusive to {% data variables.product.prodname_vscode_shortname %} and can be downloaded from the {% data variables.product.prodname_vscode_shortname %} Marketplace.
Also known as {% data variables.product.prodname_vscode %} Chat extensions, {% data variables.copilot.copilot_extensions_vsc %} are built as a {% data variables.product.prodname_vscode %} extension rather than a {% data variables.product.prodname_github_app %}. These extensions are exclusive to {% data variables.product.prodname_vscode_shortname %} and can be downloaded from the {% data variables.product.prodname_vscode_shortname %} Marketplace.
#### {% data variables.product.prodname_github_app %}
The foundation for a {% data variables.product.prodname_copilot_extension_short %} that provides the necessary infrastructure, permissions, and context from {% data variables.product.company_short %}, such as user, repo and organization metadata.
The foundation for a {% data variables.copilot.copilot_extension_short %} that provides the necessary infrastructure, permissions, and context from {% data variables.product.company_short %}, such as user, repo and organization metadata.
#### {% data variables.product.prodname_marketplace %}
The platform where {% data variables.product.company_short %} approved {% data variables.product.prodname_copilot_extensions %} can be listed publicly and discovered by users.
The platform where {% data variables.product.company_short %} approved {% data variables.copilot.copilot_extensions %} can be listed publicly and discovered by users.
#### Listed/Published Extension
@@ -61,7 +61,7 @@ A piece of code that retrieves context or executes an action in response to a us
#### Skillset
A type of {% data variables.product.prodname_copilot_extension_short %} implementation that gives developers the ability to connect external services and custom API endpoints to {% data variables.product.prodname_copilot_short %} with minimal complexity. The {% data variables.product.prodname_copilot_extensibility_platform_short %} handles prompt crafting, function evaluation, and response generation. The builder only needs to handle API skill definitions. This approach is ideal for builders who want minimal complexity.
A type of {% data variables.copilot.copilot_extension_short %} implementation that gives developers the ability to connect external services and custom API endpoints to {% data variables.product.prodname_copilot_short %} with minimal complexity. The {% data variables.copilot.copilot_extensibility_platform_short %} handles prompt crafting, function evaluation, and response generation. The builder only needs to handle API skill definitions. This approach is ideal for builders who want minimal complexity.
#### Tool/Function Calling

View File

@@ -1,6 +1,6 @@
---
title: Configuring your GitHub App for your Copilot extension
intro: 'Learn how to configure your {% data variables.product.prodname_github_app %} so that it is associated with your {% data variables.product.prodname_copilot_extension_short %}.'
intro: 'Learn how to configure your {% data variables.product.prodname_github_app %} so that it is associated with your {% data variables.copilot.copilot_extension_short %}.'
defaultTool: agents
versions:
feature: copilot-extensions
@@ -16,7 +16,7 @@ Once you have configured your server and created your {% data variables.product.
## Prerequisites
* You have configured your server to deploy your {% data variables.product.prodname_copilot_extension_short %}, and you have your hostname (aka forwarding endpoint). For more information, see [AUTOTITLE](/copilot/building-copilot-extensions/creating-a-copilot-extension/configuring-your-server-to-deploy-your-copilot-agent).
* You have configured your server to deploy your {% data variables.copilot.copilot_extension_short %}, and you have your hostname (aka forwarding endpoint). For more information, see [AUTOTITLE](/copilot/building-copilot-extensions/creating-a-copilot-extension/configuring-your-server-to-deploy-your-copilot-agent).
* You have created a {% data variables.product.prodname_github_app %} for your {% data variables.product.prodname_copilot_short %} extension. For more information, see [AUTOTITLE](/copilot/building-copilot-extensions/creating-a-copilot-extension/creating-a-github-app-for-your-copilot-extension).
## Configuring your {% data variables.product.prodname_github_app %}
@@ -25,7 +25,7 @@ Once you have configured your server and created your {% data variables.product.
{% data reusables.apps.settings-step %}
{% data reusables.apps.enterprise-apps-steps %}
1. To the right of the {% data variables.product.prodname_github_app %} you want to configure for your {% data variables.product.prodname_copilot_extension_short %}, click **Edit**.
1. To the right of the {% data variables.product.prodname_github_app %} you want to configure for your {% data variables.copilot.copilot_extension_short %}, click **Edit**.
1. In the "Identifying and authorizing users" section, under "Callback URL", enter your callback endpoint URL, then click **Save changes**.
> [!NOTE] Your server's hostname is the forwarding endpoint that you copied from your terminal when you configured your server. See [AUTOTITLE](/copilot/building-copilot-extensions/creating-a-copilot-extension/configuring-your-server-to-deploy-your-copilot-agent).
@@ -36,7 +36,7 @@ Once you have configured your server and created your {% data variables.product.
1. To expand the "Account permissions" section, click anywhere in the section.
{% data reusables.copilot.copilot-extensions.account-permissions %}
1. In the left sidebar, click **{% data variables.product.prodname_copilot_short %}**.
1. Read the {% data variables.product.prodname_marketplace %} Developer Agreement and the {% data variables.product.github %} Pre-release License Terms, then accept the terms for creating a {% data variables.product.prodname_copilot_extension_short %}.
1. Read the {% data variables.product.prodname_marketplace %} Developer Agreement and the {% data variables.product.github %} Pre-release License Terms, then accept the terms for creating a {% data variables.copilot.copilot_extension_short %}.
1. In the "App type" section, select the dropdown menu, then click **Agent**.
1. Under "URL," enter your server's hostname (aka forwarding endpoint) that you copied from your terminal.
@@ -57,7 +57,7 @@ Once you have configured your server and created your {% data variables.product.
{% data reusables.apps.settings-step %}
{% data reusables.apps.enterprise-apps-steps %}
1. To the right of the {% data variables.product.prodname_github_app %} you want to configure for your {% data variables.product.prodname_copilot_extension_short %}, click **Edit**.
1. To the right of the {% data variables.product.prodname_github_app %} you want to configure for your {% data variables.copilot.copilot_extension_short %}, click **Edit**.
1. In the "Identifying and authorizing users" section, under "Callback URL", enter your callback endpoint URL, then click **Save changes**.
> [!NOTE] Your server's hostname is the forwarding endpoint that you copied from your terminal when you configured your server. See [AUTOTITLE](/copilot/building-copilot-extensions/creating-a-copilot-extension/configuring-your-server-to-deploy-your-copilot-agent).
@@ -68,7 +68,7 @@ Once you have configured your server and created your {% data variables.product.
1. To expand the "Account permissions" section, click anywhere in the section.
{% data reusables.copilot.copilot-extensions.account-permissions %}
1. In the left sidebar, click **{% data variables.product.prodname_copilot_short %}**.
1. Read the {% data variables.product.prodname_marketplace %} Developer Agreement and the {% data variables.product.github %} Pre-release License Terms, then accept the terms for creating a {% data variables.product.prodname_copilot_extension_short %}.
1. Read the {% data variables.product.prodname_marketplace %} Developer Agreement and the {% data variables.product.github %} Pre-release License Terms, then accept the terms for creating a {% data variables.copilot.copilot_extension_short %}.
1. In the "App type" section, select the dropdown menu, then click **Skillset**.
1. Your pre-authorization URL is a link on your website that starts the authorization process for your extension. Users will be redirected to this URL when they decide to authorize your extension. If you are using a pre-authorization URL, under "Pre-authorization URL," enter the URL, then click **Save**.

View File

@@ -12,13 +12,13 @@ shortTitle: Host your extension
type: how_to
---
Your {% data variables.product.prodname_copilot_extension_short %} must be hosted on a server that is accessible to the internet. In this guide, we will use [ngrok](https://ngrok.com/) to create a tunnel to your local server, but you could also use a service like [localtunnel](https://localtunnel.github.io/www/).
Your {% data variables.copilot.copilot_extension_short %} must be hosted on a server that is accessible to the internet. In this guide, we will use [ngrok](https://ngrok.com/) to create a tunnel to your local server, but you could also use a service like [localtunnel](https://localtunnel.github.io/www/).
Alternatively, if you are a {% data variables.product.prodname_codespaces %} user, you can use the built-in {% data variables.product.prodname_codespaces %} port forwarding. For more information, see [AUTOTITLE](/codespaces/developing-in-a-codespace/forwarding-ports-in-your-codespace).
## Prerequisites
* You have created a {% data variables.product.prodname_copilot_extension_short %}. For more information, see [AUTOTITLE](/copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension) or [AUTOTITLE](/copilot/building-copilot-extensions/building-a-copilot-skillset-for-your-copilot-extension).
* You have created a {% data variables.copilot.copilot_extension_short %}. For more information, see [AUTOTITLE](/copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension) or [AUTOTITLE](/copilot/building-copilot-extensions/building-a-copilot-skillset-for-your-copilot-extension).
## Configuring your server

View File

@@ -1,6 +1,6 @@
---
title: Creating a GitHub App for your Copilot Extension
intro: 'Learn how to create a {% data variables.product.prodname_github_app %} for your {% data variables.product.prodname_copilot_extension_short %}.'
intro: 'Learn how to create a {% data variables.product.prodname_github_app %} for your {% data variables.copilot.copilot_extension_short %}.'
versions:
feature: copilot-extensions
topics:
@@ -9,12 +9,12 @@ shortTitle: Create GitHub App
type: how_to
---
A {% data variables.product.prodname_copilot_extension_short %} is a {% data variables.product.prodname_github_app %} that is associated with a {% data variables.product.prodname_copilot_agent_short %}. The {% data variables.product.prodname_github_app %} you associate your {% data variables.product.prodname_copilot_agent_short %} with is used to authenticate the {% data variables.product.prodname_copilot_agent_short %} with {% data variables.product.prodname_dotcom %} and to authorize the {% data variables.product.prodname_copilot_agent_short %} to access the {% data variables.product.prodname_copilot_chat_short %} API. Each {% data variables.product.prodname_copilot_agent_short %} must be associated with a unique {% data variables.product.prodname_github_app %}.
A {% data variables.copilot.copilot_extension_short %} is a {% data variables.product.prodname_github_app %} that is associated with a {% data variables.copilot.copilot_agent_short %}. The {% data variables.product.prodname_github_app %} you associate your {% data variables.copilot.copilot_agent_short %} with is used to authenticate the {% data variables.copilot.copilot_agent_short %} with {% data variables.product.prodname_dotcom %} and to authorize the {% data variables.copilot.copilot_agent_short %} to access the {% data variables.copilot.copilot_chat_short %} API. Each {% data variables.copilot.copilot_agent_short %} must be associated with a unique {% data variables.product.prodname_github_app %}.
## Prerequisites
* You have created a {% data variables.product.prodname_copilot_agent_short %}. For more information, see [AUTOTITLE](/copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension).
* You have configured your server to deploy your {% data variables.product.prodname_copilot_agent_short %}, and you have your hostname (aka forwarding endpoint). For more information, see [AUTOTITLE](/copilot/building-copilot-extensions/creating-a-copilot-extension/configuring-your-server-to-deploy-your-copilot-agent).
* You have created a {% data variables.copilot.copilot_agent_short %}. For more information, see [AUTOTITLE](/copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension).
* You have configured your server to deploy your {% data variables.copilot.copilot_agent_short %}, and you have your hostname (aka forwarding endpoint). For more information, see [AUTOTITLE](/copilot/building-copilot-extensions/creating-a-copilot-extension/configuring-your-server-to-deploy-your-copilot-agent).
## Creating a {% data variables.product.prodname_github_app %}

View File

@@ -1,7 +1,7 @@
---
title: Creating a Copilot Extension
shortTitle: Create a Copilot Extension
intro: 'Learn how to integrate your {% data variables.product.prodname_copilot_agent_short %} with a {% data variables.product.prodname_github_app %} to create your {% data variables.product.prodname_copilot_extension_short %}.'
intro: 'Learn how to integrate your {% data variables.copilot.copilot_agent_short %} with a {% data variables.product.prodname_github_app %} to create your {% data variables.copilot.copilot_extension_short %}.'
versions:
feature: copilot
topics:

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