Skip to content

Commit

Permalink
Merge pull request #35176 from github/repo-sync
Browse files Browse the repository at this point in the history
Repo sync
  • Loading branch information
docs-bot authored Nov 4, 2024
2 parents 36ee1c6 + 99ec37f commit e59b14e
Show file tree
Hide file tree
Showing 33 changed files with 3,868 additions and 383 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ versions:
topics:
- Copilot
type: rai
redirect_from:
- /early-access/copilot/code-review/responsible-use-of-copilot-code-review
- /early-access/copilot/code-reviews/responsible-use-of-copilot-code-review
- /early-access/copilot/code-reviews/responsible-use-of-copilot-code-reviews
---

> [!NOTE]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,13 @@ title: Configuring coding guidelines for GitHub Copilot code review
shortTitle: Configuring coding guidelines
intro: "Learn how to customize {% data variables.copilot.copilot_code-review_short %} with custom coding guidelines."
allowTitleToDifferFromFilename: true
redirect_from:
- /early-access/copilot/code-reviews/configuring-coding-guidelines
versions:
feature: copilot
topics:
- Copilot
redirect_from:
- /early-access/copilot/code-review/configuring-coding-guidelines
- /early-access/copilot/code-reviews/configuring-coding-guidelines
---

> [!NOTE] Custom coding guidelines are limited to selected participants in the {% data variables.release-phases.public_preview %} of {% data variables.copilot.copilot_code-review_short %}, and only available as part of a subscription to {% data variables.product.prodname_copilot_enterprise %}.
Expand All @@ -31,11 +32,11 @@ Coding guidelines are configured at the repository level. You can create and ena
## Dos and don'ts for coding guidelines

* **Do** use simple, clear and concise language to describe your coding guideline.
* **Do** be as specific as possible about what Copilot should look for - that is, what you \*o or don't want to see in your code.
* **Do** take a look at the "[Coding guidelines examples](#coding-guidelines-examples)" \*elow for some inspiration.
* **Don't** try to use coding guidelines to enforce style guidelines that can be covered \*y your linter or static analysis tool.
* **Do** be as specific as possible about what Copilot should look for - that is, what you do or don't want to see in your code.
* **Do** take a look at the "[Coding guidelines examples](#coding-guidelines-examples)" below for some inspiration.
* **Don't** try to use coding guidelines to enforce style guidelines that can be covered by your linter or static analysis tool.
* **Don't** use wording that is ambiguous or could be interpreted in different ways.
* **Don't** try to fit multiple different ideas into a single coding guideline.\*
* **Don't** try to fit multiple different ideas into a single coding guideline.

## Creating a coding guideline

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ versions:
feature: copilot
topics:
- Copilot
redirect_from:
- /early-access/copilot/code-review/using-copilot-code-review
- /early-access/copilot/code-reviews/using-copilot-code-review
- /early-access/copilot/code-reviews/using-copilot-code-reviews
---

> [!NOTE]
Expand Down
14 changes: 14 additions & 0 deletions content/rest/orgs/api-insights.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: REST API endpoints for API Insights
shortTitle: API Insights
intro: Use the REST API to view statistics for API usage in an organization.
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghec: '*'
topics:
- API
autogenerated: rest
allowTitleToDifferFromFilename: true
---

<!-- Content after this section is automatically generated -->
1 change: 1 addition & 0 deletions content/rest/orgs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ versions:
topics:
- API
children:
- /api-insights
- /blocking
- /custom-properties
- /custom-roles
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
| Clients and IDEs | {% data variables.product.prodname_copilot_extensions %} support |
|------------------------------------|:---------:|
| {% data variables.product.prodname_vscode %} | {% octicon "check" aria-label="Supported" %} |
| {% data variables.product.prodname_vs %} | {% octicon "check" aria-label="Supported" %} |
| {% data variables.product.prodname_dotcom_the_website %} | {% octicon "check" aria-label="Supported" %} |
| {% data variables.product.prodname_mobile %} | {% octicon "check" aria-label="Supported" %} |
| JetBrains IDEs | {% octicon "check" aria-label="Supported" %} |
| Vim/Neovim | {% octicon "x" aria-label="Unsupported" %} |
| {% data variables.product.prodname_copilot_cli_short %} | {% octicon "x" aria-label="Unsupported" %} |
| Xcode | {% octicon "x" aria-label="Unsupported" %} |
| Clients and IDEs | {% data variables.product.prodname_copilot_extensions %} support |
|----------------------------------------------------------|:----------------------------------------------------------------:|
| {% data variables.product.prodname_vscode %} | {% octicon "check" aria-label="Supported" %} |
| {% data variables.product.prodname_vs %} | {% octicon "check" aria-label="Supported" %} |
| {% data variables.product.prodname_dotcom_the_website %} | {% octicon "check" aria-label="Supported" %} |
| {% data variables.product.prodname_mobile %} | {% octicon "check" aria-label="Supported" %} |
| JetBrains IDEs | {% octicon "x" aria-label="Unsupported" %} |
| Vim/Neovim | {% octicon "x" aria-label="Unsupported" %} |
| {% data variables.product.prodname_copilot_cli_short %} | {% octicon "x" aria-label="Unsupported" %} |
| Xcode | {% octicon "x" aria-label="Unsupported" %} |
Original file line number Diff line number Diff line change
@@ -1,4 +1,91 @@
{
"organization_api_insights": {
"title": "API Insights",
"displayTitle": "Organization permissions for \"API Insights\"",
"permissions": [
{
"category": "orgs",
"slug": "get-route-stats-by-actor",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}",
"additional-permissions": false,
"access": "read"
},
{
"category": "orgs",
"slug": "get-subject-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/subject-stats",
"additional-permissions": false,
"access": "read"
},
{
"category": "orgs",
"slug": "get-summary-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/summary-stats",
"additional-permissions": false,
"access": "read"
},
{
"category": "orgs",
"slug": "get-summary-stats-by-user",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/summary-stats/users/{user_id}",
"additional-permissions": false,
"access": "read"
},
{
"category": "orgs",
"slug": "get-summary-stats-by-actor",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}",
"additional-permissions": false,
"access": "read"
},
{
"category": "orgs",
"slug": "get-time-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/time-stats",
"additional-permissions": false,
"access": "read"
},
{
"category": "orgs",
"slug": "get-time-stats-by-user",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/time-stats/users/{user_id}",
"additional-permissions": false,
"access": "read"
},
{
"category": "orgs",
"slug": "get-time-stats-by-actor",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}",
"additional-permissions": false,
"access": "read"
},
{
"category": "orgs",
"slug": "get-user-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/user-stats/{user_id}",
"additional-permissions": false,
"access": "read"
}
]
},
"organization_administration": {
"title": "Administration",
"displayTitle": "Organization permissions for \"Administration\"",
Expand Down
54 changes: 54 additions & 0 deletions src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json
Original file line number Diff line number Diff line change
Expand Up @@ -3178,6 +3178,60 @@
"verb": "post",
"requestPath": "/orgs/{org}/hooks/{hook_id}/pings"
},
{
"slug": "get-route-stats-by-actor",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}"
},
{
"slug": "get-subject-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/subject-stats"
},
{
"slug": "get-summary-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/summary-stats"
},
{
"slug": "get-summary-stats-by-user",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/summary-stats/users/{user_id}"
},
{
"slug": "get-summary-stats-by-actor",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}"
},
{
"slug": "get-time-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/time-stats"
},
{
"slug": "get-time-stats-by-user",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/time-stats/users/{user_id}"
},
{
"slug": "get-time-stats-by-actor",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}"
},
{
"slug": "get-user-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/user-stats/{user_id}"
},
{
"slug": "list-app-installations-for-an-organization",
"subcategory": "orgs",
Expand Down
105 changes: 105 additions & 0 deletions src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,111 @@
}
]
},
"organization_api_insights": {
"title": "API Insights",
"displayTitle": "Organization permissions for \"API Insights\"",
"permissions": [
{
"category": "orgs",
"slug": "get-route-stats-by-actor",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "orgs",
"slug": "get-subject-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/subject-stats",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "orgs",
"slug": "get-summary-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/summary-stats",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "orgs",
"slug": "get-summary-stats-by-user",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/summary-stats/users/{user_id}",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "orgs",
"slug": "get-summary-stats-by-actor",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "orgs",
"slug": "get-time-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/time-stats",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "orgs",
"slug": "get-time-stats-by-user",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/time-stats/users/{user_id}",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "orgs",
"slug": "get-time-stats-by-actor",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "orgs",
"slug": "get-user-stats",
"subcategory": "api-insights",
"verb": "get",
"requestPath": "/orgs/{org}/insights/api/user-stats/{user_id}",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
}
]
},
"organization_administration": {
"title": "Administration",
"displayTitle": "Organization permissions for \"Administration\"",
Expand Down
Loading

0 comments on commit e59b14e

Please sign in to comment.