Merge branch 'main' of github.com:github/docs-internal into github-ae-release-notes
|
@ -7,6 +7,8 @@
|
|||
*.js @github/docs-engineering
|
||||
/.github/ @github/docs-engineering
|
||||
/script/ @github/docs-engineering
|
||||
/includes/ @github/docs-engineering
|
||||
/layouts/ @github/docs-engineering
|
||||
app.json @github/docs-engineering
|
||||
Dockerfile @github/docs-engineering
|
||||
package-lock.json @github/docs-engineering
|
||||
|
|
|
@ -21,17 +21,18 @@ module.exports = [
|
|||
"fkirc/skip-duplicate-actions@36feb0d8d062137530c2e00bd278d138fe191289",
|
||||
"github/codeql-action/analyze@v1",
|
||||
"github/codeql-action/init@v1",
|
||||
"ianwalter/puppeteer-container@2466ba8ecf689ccf4e5dfadeff3ac2db227b2e17",
|
||||
"juliangruber/approve-pull-request-action@c530832d4d346c597332e20e03605aa94fa150a8",
|
||||
"juliangruber/find-pull-request-action@2fc55e82a6d5d36fe1e7f1848f7e64fd02d99de9",
|
||||
"juliangruber/read-file-action@e0a316da496006ffd19142f0fd594a1783f3b512",
|
||||
"lee-dohm/close-matching-issues@22002609b2555fe18f52b8e2e7c07cbf5529e8a8",
|
||||
"octokit/graphql-action@5b3e01d42dee4509b0ac6b1cb2cf7778cdce85c2",
|
||||
"pascalgn/automerge-action@c9bd1823770819dc8fb8a5db2d11a3a95fbe9b07", //pascalgn/automerge@0.12.0
|
||||
"peter-evans/create-issue-from-file@a04ce672e3acedb1f8e416b46716ddfd09905326",
|
||||
"peter-evans/create-or-update-comment@5221bf4aa615e5c6e95bb142f9673a9c791be2cd",
|
||||
"peter-evans/create-pull-request@8c603dbb04b917a9fc2dd991dc54fef54b640b43",
|
||||
"rachmari/actions-add-new-issue-to-column@1a459ef92308ba7c9c9dc2fcdd72f232495574a9",
|
||||
"rachmari/labeler@832d42ec5523f3c6d46e8168de71cd54363e3e2e",
|
||||
"rachmari/puppeteer-container@6d56d6e132a3df76cf60bc290a4282f7fbaed05e",
|
||||
"repo-sync/github-sync@3832fe8e2be32372e1b3970bbae8e7079edeec88",
|
||||
"repo-sync/pull-request@33777245b1aace1a58c87a29c90321aa7a74bd7d",
|
||||
"someimportantcompany/github-actions-slack-message@0b470c14b39da4260ed9e3f9a4f1298a74ccdefd",
|
||||
|
|
|
@ -0,0 +1,10 @@
|
|||
trigger: remove-from-fr-board
|
||||
title: Remove from FR board
|
||||
description: Remove the current issue or pull request from the project board for the docs content first responder
|
||||
surfaces:
|
||||
- issue
|
||||
- pull_request
|
||||
- discussion
|
||||
steps:
|
||||
- type: repository_dispatch
|
||||
eventType: remove_from_FR_board
|
|
@ -2,10 +2,10 @@ name: Browser Tests
|
|||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
# push:
|
||||
# branches:
|
||||
# - main
|
||||
# pull_request:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
pull_request:
|
||||
|
||||
jobs:
|
||||
see_if_should_skip:
|
||||
|
@ -39,7 +39,7 @@ jobs:
|
|||
|
||||
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
|
||||
name: Install
|
||||
uses: ianwalter/puppeteer-container@2466ba8ecf689ccf4e5dfadeff3ac2db227b2e17
|
||||
uses: rachmari/puppeteer-container@6d56d6e132a3df76cf60bc290a4282f7fbaed05e
|
||||
timeout-minutes: 5
|
||||
with:
|
||||
args: npm ci
|
||||
|
@ -47,6 +47,6 @@ jobs:
|
|||
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
|
||||
name: Test
|
||||
timeout-minutes: 10
|
||||
uses: ianwalter/puppeteer-container@2466ba8ecf689ccf4e5dfadeff3ac2db227b2e17
|
||||
uses: rachmari/puppeteer-container@6d56d6e132a3df76cf60bc290a4282f7fbaed05e
|
||||
with:
|
||||
args: npm run browser-test
|
||||
|
|
|
@ -15,5 +15,5 @@ jobs:
|
|||
github.issues.createComment({
|
||||
...context.repo,
|
||||
issue_number: context.payload.pull_request.number,
|
||||
body: 'Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our [help wanted issues](https://github.com/github/docs/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) :zap:'
|
||||
body: "Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our [help wanted issues](https://github.com/github/docs/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) :zap:"
|
||||
})
|
||||
|
|
|
@ -0,0 +1,64 @@
|
|||
name: Remove card from FR board
|
||||
|
||||
on:
|
||||
repository_dispatch:
|
||||
types: remove_from_FR_board
|
||||
|
||||
jobs:
|
||||
remove_from_FR_board:
|
||||
if: github.repository == 'github/docs-internal'
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- id: find_project_cards
|
||||
uses: octokit/graphql-action@5b3e01d42dee4509b0ac6b1cb2cf7778cdce85c2
|
||||
with:
|
||||
query: |
|
||||
query($issue_node_id:ID!) {
|
||||
node(id:$issue_node_id) {
|
||||
... on Issue {
|
||||
projectCards(first: 10) {
|
||||
nodes {
|
||||
id
|
||||
project {
|
||||
name
|
||||
id
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
... on PullRequest {
|
||||
projectCards(first: 10) {
|
||||
nodes {
|
||||
id
|
||||
project {
|
||||
name
|
||||
id
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
issue_node_id: ${{ github.event.client_payload.command.resource.id }}
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }}
|
||||
|
||||
- run: "echo 'Project cards found: ${{ steps.find_project_cards.outputs.data }}'"
|
||||
|
||||
- name: Get FR card
|
||||
env:
|
||||
QUERY_DATA: ${{ steps.find_project_cards.outputs.data }}
|
||||
run: |
|
||||
echo 'FR_CARDS='$(jq '.node.projectCards.nodes | .[] | select(.project.id == "MDc6UHJvamVjdDQ1NzI0ODI=") | .id' <<< "$QUERY_DATA") >> $GITHUB_ENV
|
||||
|
||||
- name: Delete card
|
||||
id: delete_project_card
|
||||
if: ${{ env.FR_CARDS }}
|
||||
uses: octokit/graphql-action@5b3e01d42dee4509b0ac6b1cb2cf7778cdce85c2
|
||||
with:
|
||||
query: |
|
||||
mutation DeleteCard {
|
||||
deleteProjectCard(input:{cardId:${{ env.FR_CARDS }}}) {deletedCardId}
|
||||
}
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }}
|
Двоичные данные
assets/images/enterprise/github-ae/settings/access-token-scopes-for-ghae.png
Normal file
После Ширина: | Высота: | Размер: 174 KiB |
До Ширина: | Высота: | Размер: 21 KiB После Ширина: | Высота: | Размер: 21 KiB |
До Ширина: | Высота: | Размер: 50 KiB После Ширина: | Высота: | Размер: 50 KiB |
После Ширина: | Высота: | Размер: 30 KiB |
Двоичные данные
assets/images/help/billing/settings_organization_billing_planning_tab.png
Normal file
После Ширина: | Высота: | Размер: 18 KiB |
Двоичные данные
assets/images/help/enterprises/enterprise-licensing-tab-ghas-no-seats.png
Normal file
После Ширина: | Высота: | Размер: 40 KiB |
После Ширина: | Высота: | Размер: 31 KiB |
Двоичные данные
assets/images/help/enterprises/settings-security-analysis-ghas-repos-list.png
Normal file
После Ширина: | Высота: | Размер: 111 KiB |
Двоичные данные
assets/images/help/organizations/ghas-repos-list.png
До Ширина: | Высота: | Размер: 82 KiB |
Двоичные данные
assets/images/help/organizations/settings-security-analysis-ghas-repos-list.png
Normal file
После Ширина: | Высота: | Размер: 109 KiB |
|
@ -117,7 +117,7 @@ GitHub Actions
|
|||
</tr>
|
||||
</table>
|
||||
|
||||
{% data variables.product.prodname_actions %} caching is only applicable to {% data variables.product.prodname_dotcom %}-hosted runners. For more information, see "<a href="/actions/guides/caching-dependencies-to-speed-up-workflows" class="dotcom-only">Caching dependencies to speed up workflows</a>."
|
||||
{% data variables.product.prodname_actions %} caching is only applicable for repositories hosted on {% data variables.product.prodname_dotcom_the_website %}. For more information, see "<a href="/actions/guides/caching-dependencies-to-speed-up-workflows" class="dotcom-only">Caching dependencies to speed up workflows</a>."
|
||||
|
||||
{% data variables.product.prodname_actions %} does not have an equivalent of CircleCI’s Docker Layer Caching (or DLC).
|
||||
|
||||
|
|
|
@ -77,7 +77,7 @@ This means that a compromise of a single action within a workflow can be very si
|
|||
|
||||
### Considering cross-repository access
|
||||
|
||||
{% data variables.product.prodname_actions %} is intentionally scoped for a single repository at a time. The `GITHUB_TOKEN` grants the same level of access as a write-access user, because any write-access user can access this token by creating or modifying workflow files. Users have specific permissions for each repository, so having the `GITHUB_TOKEN` for one repository grant access to another would impact the {% data variables.product.prodname_dotcom %} permission model if not implemented carefully. Similarly, caution must be taken when adding {% data variables.product.prodname_dotcom %} authentication tokens to a workflow, because this can also affect the {% data variables.product.prodname_dotcom %} permission model by inadvertently granting broad access to collaborators.
|
||||
{% data variables.product.prodname_actions %} is intentionally scoped for a single repository at a time. The `GITHUB_TOKEN` grants the same level of access as a write-access user, because any write-access user can access this token by creating or modifying workflow files. Users have specific permissions for each repository, so allowing the `GITHUB_TOKEN` for one repository to grant access to another would impact the {% data variables.product.prodname_dotcom %} permission model if not implemented carefully. Similarly, caution must be taken when adding {% data variables.product.prodname_dotcom %} authentication tokens to a workflow, because this can also affect the {% data variables.product.prodname_dotcom %} permission model by inadvertently granting broad access to collaborators.
|
||||
|
||||
We have [a plan on the {% data variables.product.prodname_dotcom %} roadmap](https://github.com/github/roadmap/issues/74) to support a flow that allows cross-repository access within {% data variables.product.product_name %}, but this is not yet a supported feature. Currently, the only way to perform privileged cross-repository interactions is to place a {% data variables.product.prodname_dotcom %} authentication token or SSH key as a secret within the workflow. Because many authentication token types do not allow for granular access to specific resources, there is significant risk in using the wrong token type, as it can grant much broader access than intended.
|
||||
|
||||
|
|
|
@ -18,7 +18,7 @@ To provide a high level of security, {% data variables.product.product_name %} e
|
|||
|
||||
For encryption in transit, {% data variables.product.product_name %} uses Transport Layer Security (TLS). For encryption at rest, {% data variables.product.product_name %} provides a default RSA key. After you've initialized your enterprise, you can choose to provide your own key instead. Your key should be a 2048 bit RSA private key in PEM format.
|
||||
|
||||
The key that you provide is stored in a hardware security module (HSM) in a key vault that {% data variables.product.company_short %} manages.
|
||||
The key that you provide is stored in a FIPS 140-2 compliant hardware security module (HSM) in a key vault that {% data variables.product.company_short %} manages.
|
||||
|
||||
To configure your encryption key, use the REST API. There are a number of API endpoints, for example to check the status of encryption, update your encryption key, and disable your encryption key. Note that disabling your key will freeze your enterprise. For more information about the API endpoints, see "[Encryption at rest](/rest/reference/enterprise-admin#encryption-at-rest)" in the REST API documentation.
|
||||
|
||||
|
|
|
@ -66,7 +66,7 @@ If you enable SNMP v3, you can take advantage of increased user based security t
|
|||
|
||||
##### Querying SNMP data
|
||||
|
||||
Both hardware and software-level information about your appliance is available with SNMP v3. Due to the lack of encryption and privacy for the `noAuthNoPriv` and `authNoPriv` security levels, we exclude the `hrSWRun` table (1.1.3.6.1.2.1.25.41) from the resulting SNMP reports. We include this table if you're using the `authPriv` security level.
|
||||
Both hardware and software-level information about your appliance is available with SNMP v3. Due to the lack of encryption and privacy for the `noAuthNoPriv` and `authNoPriv` security levels, we exclude the `hrSWRun` table (1.3.6.1.2.1.25.4) from the resulting SNMP reports. We include this table if you're using the `authPriv` security level. For more information, see the "[OID reference documentation](http://oidref.com/1.3.6.1.2.1.25.4)."
|
||||
|
||||
With SNMP v2c, only hardware-level information about your appliance is available. The applications and services within {% data variables.product.prodname_enterprise %} do not have OIDs configured to report metrics. Several MIBs are available, which you can see by running `snmpwalk` on a separate workstation with SNMP support in your network:
|
||||
|
||||
|
@ -76,16 +76,16 @@ With SNMP v2c, only hardware-level information about your appliance is available
|
|||
$ snmpwalk -v 2c -c <em>community-string</em> -O e <em>hostname</em>
|
||||
```
|
||||
|
||||
Of the available MIBs for SNMP, the most useful is `HOST-RESOURCES-MIB` (.1.3.6.1.2.1.25). See the table below for some important objects in this MIB:
|
||||
Of the available MIBs for SNMP, the most useful is `HOST-RESOURCES-MIB` (1.3.6.1.2.1.25). See the table below for some important objects in this MIB:
|
||||
|
||||
| Name | OID | Description |
|
||||
| ---- | --- | ----------- |
|
||||
| hrSystemDate.2 | .1.3.6.1.2.1.25.1.2 | The hosts notion of the local date and time of day. |
|
||||
| hrSystemUptime.0 |.1.3.6.1.2.1.25.1.1.0 | How long it's been since the host was last initialized. |
|
||||
| hrMemorySize.0 | .1.3.6.1.2.1.25.2.2.0 | The amount of RAM on the host. |
|
||||
| hrSystemProcesses.0 | .1.3.6.1.2.1.25.1.6.0 | The number of process contexts currently loaded or running on the host. |
|
||||
| hrStorageUsed.1 | .1.3.6.1.2.1.25.2.3.1.6.1 | The amount of storage space consumed on the host, in hrStorageAllocationUnits. |
|
||||
| hrStorageAllocationUnits.1 | .1.3.6.1.2.1.25.2.3.1.4.1 | The size, in bytes, of an hrStorageAllocationUnit |
|
||||
| hrSystemDate.2 | 1.3.6.1.2.1.25.1.2 | The hosts notion of the local date and time of day. |
|
||||
| hrSystemUptime.0 | 1.3.6.1.2.1.25.1.1.0 | How long it's been since the host was last initialized. |
|
||||
| hrMemorySize.0 | 1.3.6.1.2.1.25.2.2.0 | The amount of RAM on the host. |
|
||||
| hrSystemProcesses.0 | 1.3.6.1.2.1.25.1.6.0 | The number of process contexts currently loaded or running on the host. |
|
||||
| hrStorageUsed.1 | 1.3.6.1.2.1.25.2.3.1.6.1 | The amount of storage space consumed on the host, in hrStorageAllocationUnits. |
|
||||
| hrStorageAllocationUnits.1 | 1.3.6.1.2.1.25.2.3.1.4.1 | The size, in bytes, of an hrStorageAllocationUnit |
|
||||
|
||||
For example, to query for `hrMemorySize` with SNMP v3, run the following command on a separate workstation with SNMP support in your network:
|
||||
```shell
|
||||
|
@ -108,7 +108,7 @@ snmpget -v 2c -c <em>community-string</em> <em>hostname</em> HOST-RESOURCES-MIB:
|
|||
|
||||
{% tip %}
|
||||
|
||||
**Note:** To prevent leaking information about services running on your appliance, we exclude the `hrSWRun` table (1.1.3.6.1.2.1.25.41) from the resulting SNMP reports unless you're using the `authPriv` security level with SNMP v3. If you're using the `authPriv` security level, we include the `hrSWRun` table.
|
||||
**Note:** To prevent leaking information about services running on your appliance, we exclude the `hrSWRun` table (1.3.6.1.2.1.25.4) from the resulting SNMP reports unless you're using the `authPriv` security level with SNMP v3. If you're using the `authPriv` security level, we include the `hrSWRun` table.
|
||||
|
||||
{% endtip %}
|
||||
|
||||
|
|
|
@ -38,19 +38,19 @@ X-Accepted-OAuth-Scopes: user
|
|||
### Available scopes
|
||||
|
||||
Name | Description
|
||||
-----|-----------|
|
||||
**`(no scope)`** | Grants read-only access to public information (includes public user profile info, public repository info, and gists){% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
|
||||
-----|-----------|{% if currentVersion != "github-ae@latest" %}
|
||||
**`(no scope)`** | Grants read-only access to public information (including user profile info, repository info, and gists){% endif %}{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
|
||||
**`site_admin`** | Grants site administrators access to [{% data variables.product.prodname_ghe_server %} Administration API endpoints](/rest/reference/enterprise-admin).{% endif %}
|
||||
**`repo`** | Grants full access to private and public repositories. That includes read/write access to code, commit statuses, repository and organization projects, invitations, collaborators, adding team memberships, deployment statuses, and repository webhooks for public and private repositories and organizations. Also grants ability to manage user projects.
|
||||
 `repo:status`| Grants read/write access to public and private repository commit statuses. This scope is only necessary to grant other users or services access to private repository commit statuses *without* granting access to the code.
|
||||
 `repo_deployment`| Grants access to [deployment statuses](/rest/reference/repos#deployments) for public and private repositories. This scope is only necessary to grant other users or services access to deployment statuses, *without* granting access to the code.
|
||||
 `public_repo`| Limits access to public repositories. That includes read/write access to code, commit statuses, repository projects, collaborators, and deployment statuses for public repositories and organizations. Also required for starring public repositories.
|
||||
**`repo`** | Grants full access to repositories, including private repositories. That includes read/write access to code, commit statuses, repository and organization projects, invitations, collaborators, adding team memberships, deployment statuses, and repository webhooks for repositories and organizations. Also grants ability to manage user projects.
|
||||
 `repo:status`| Grants read/write access to {% if currentVersion != "github-ae@latest" %}public{% else %}internal{% endif %} and private repository commit statuses. This scope is only necessary to grant other users or services access to private repository commit statuses *without* granting access to the code.
|
||||
 `repo_deployment`| Grants access to [deployment statuses](/rest/reference/repos#deployments) for {% if currentVersion != "github-ae@latest" %}public{% else %}internal{% endif %} and private repositories. This scope is only necessary to grant other users or services access to deployment statuses, *without* granting access to the code.{% if currentVersion != "github-ae@latest" %}
|
||||
 `public_repo`| Limits access to public repositories. That includes read/write access to code, commit statuses, repository projects, collaborators, and deployment statuses for public repositories and organizations. Also required for starring public repositories.{% endif %}
|
||||
 `repo:invite` | Grants accept/decline abilities for invitations to collaborate on a repository. This scope is only necessary to grant other users or services access to invites *without* granting access to the code.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}
|
||||
 `security_events` | Grants: <br/> read and write access to security events in the [{% data variables.product.prodname_code_scanning %} API](/rest/reference/code-scanning) <br/> read and write access to security events in the [{% data variables.product.prodname_secret_scanning %} API](/rest/reference/secret-scanning) <br/> This scope is only necessary to grant other users or services access to security events *without* granting access to the code.{% endif %}{% if currentVersion ver_gt "enterprise-server@2.21" and currentVersion ver_lt "enterprise-server@3.1" %}
|
||||
 `security_events` | Grants read and write access to security events in the [{% data variables.product.prodname_code_scanning %} API](/rest/reference/code-scanning). This scope is only necessary to grant other users or services access to security events *without* granting access to the code.{% endif %}
|
||||
**`admin:repo_hook`** | Grants read, write, ping, and delete access to repository hooks in public and private repositories. The `repo` and `public_repo` scopes grants full access to repositories, including repository hooks. Use the `admin:repo_hook` scope to limit access to only repository hooks.
|
||||
 `write:repo_hook` | Grants read, write, and ping access to hooks in public or private repositories.
|
||||
 `read:repo_hook`| Grants read and ping access to hooks in public or private repositories.
|
||||
**`admin:repo_hook`** | Grants read, write, ping, and delete access to repository hooks in {% if currentVersion != "github-ae@latest" %}public{% else %}internal{% endif %} and private repositories. The `repo` {% if currentVersion != "github-ae@latest" %}and `public_repo` scopes grant{% else %}scope grants{% endif %} full access to repositories, including repository hooks. Use the `admin:repo_hook` scope to limit access to only repository hooks.
|
||||
 `write:repo_hook` | Grants read, write, and ping access to hooks in {% if currentVersion != "github-ae@latest" %}public{% else %}internal{% endif %} or private repositories.
|
||||
 `read:repo_hook`| Grants read and ping access to hooks in {% if currentVersion != "github-ae@latest" %}public{% else %}internal{% endif %} or private repositories.
|
||||
**`admin:org`** | Fully manage the organization and its teams, projects, and memberships.
|
||||
 `write:org`| Read and write access to organization membership, organization projects, and team membership.
|
||||
 `read:org`| Read-only access to organization membership, organization projects, and team membership.
|
||||
|
@ -78,11 +78,11 @@ Name | Description
|
|||
{% note %}
|
||||
|
||||
**Note:** Your OAuth App can request the scopes in the initial redirection. You
|
||||
can specify multiple scopes by separating them with a space:
|
||||
can specify multiple scopes by separating them with a space using `%20`:
|
||||
|
||||
https://github.com/login/oauth/authorize?
|
||||
client_id=...&
|
||||
scope=user%20public_repo
|
||||
scope=user%20repo_deployment
|
||||
|
||||
{% endnote %}
|
||||
|
||||
|
|
|
@ -46,11 +46,16 @@ If you're a repository administrator or an organization owner, you can enable {%
|
|||
|
||||
When you push commits to a{% if currentVersion == "free-pro-team@latest" %} private{% endif %} repository with {% data variables.product.prodname_secret_scanning %} enabled, {% data variables.product.prodname_dotcom %} scans the contents of the commits for secrets.
|
||||
|
||||
When {% data variables.product.prodname_secret_scanning %} detects a secret in a{% if currentVersion == "free-pro-team@latest" %} private{% endif %} repository, {% data variables.product.prodname_dotcom %} sends alerts.
|
||||
When {% data variables.product.prodname_secret_scanning %} detects a secret in a{% if currentVersion == "free-pro-team@latest" %} private{% endif %} repository, {% data variables.product.prodname_dotcom %} generates an alert.
|
||||
|
||||
- {% data variables.product.prodname_dotcom %} sends an email alert to the repository administrators and organization owners.
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == 'github-ae@next' %}
|
||||
- {% data variables.product.prodname_dotcom %} sends an email alert to the contributor who committed the secret to the repository, with a link to the related {% data variables.product.prodname_secret_scanning %} alert. The commit author can then view the alert in the repository, and resolve the alert.
|
||||
{% endif %}
|
||||
- {% data variables.product.prodname_dotcom %} displays an alert in the repository.{% if currentVersion == "enterprise-server@3.0" %} For more information, see "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/managing-alerts-from-secret-scanning)."{% endif %}
|
||||
|
||||
- {% data variables.product.prodname_dotcom %} displays an alert in the repository. For more information, see "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/managing-alerts-from-secret-scanning)."
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == 'github-ae@next' %}
|
||||
For more information about viewing and resolving {% data variables.product.prodname_secret_scanning %} alerts, see "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/managing-alerts-from-secret-scanning)."{% endif %}
|
||||
|
||||
Repository administrators and organization owners can grant users and teams access to {% data variables.product.prodname_secret_scanning %} alerts. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)."
|
||||
|
||||
|
|
|
@ -35,14 +35,13 @@ You can manage the security and analysis features for your {% if currentVersion
|
|||
{% data reusables.repositories.sidebar-settings %}
|
||||
{% data reusables.repositories.navigate-to-security-and-analysis %}
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
|
||||
4. Under "Configure security and analysis features", to the right of the feature, click **Disable** or **Enable**. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}If the control for "{% data variables.product.prodname_secret_scanning_caps %}" is not active, you need to enable {% data variables.product.prodname_GH_advanced_security %} first.
|
||||
4. Under "Configure security and analysis features", to the right of the feature, click **Disable** or **Enable**.{% endif %} {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}The control for "{% data variables.product.prodname_GH_advanced_security %}" is disabled if you have no available seats in your {% data variables.product.prodname_GH_advanced_security %} license.
|
||||
!["Enable" or "Disable" button for "Configure security and analysis" features](/assets/images/help/repository/security-and-analysis-disable-or-enable-dotcom-private.png)
|
||||
{% note %}
|
||||
|
||||
**Note:** If you disable {% data variables.product.prodname_GH_advanced_security %}, both {% data variables.product.prodname_secret_scanning %} and {% data variables.product.prodname_code_scanning %} are disabled. Any workflows, SARIF uploads, or API calls for {% data variables.product.prodname_code_scanning %} will fail.
|
||||
**Note:** If you disable {% data variables.product.prodname_GH_advanced_security %}, {% if currentVersion == "free-pro-team@latest" %}dependency review, {% endif %}{% data variables.product.prodname_secret_scanning %} and {% data variables.product.prodname_code_scanning %} are disabled. Any workflows, SARIF uploads, or API calls for {% data variables.product.prodname_code_scanning %} will fail.
|
||||
{% endnote %}
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
{% if currentVersion == "enterprise-server@3.0" %}
|
||||
!["Enable" or "Disable" button for "Configure security and analysis" features](/assets/images/help/repository/security-and-analysis-disable-or-enable-ghe.png)
|
||||
{% endif %}
|
||||
|
@ -51,7 +50,6 @@ You can manage the security and analysis features for your {% if currentVersion
|
|||
![Enable or disable {% data variables.product.prodname_GH_advanced_security %} or {% data variables.product.prodname_secret_scanning %} for your repository](/assets/images/enterprise/github-ae/repository/enable-ghas-secret-scanning-ghae.png)
|
||||
{% endif %}
|
||||
|
||||
|
||||
### Granting access to security alerts
|
||||
|
||||
After you enable {% if currentVersion != "github-ae@latest" %}{% data variables.product.prodname_dependabot %} or {% endif %}{% data variables.product.prodname_secret_scanning %} alerts for a repository in an organization, organization owners and repository administrators can view the alerts by default. You can give additional teams and people access to the alerts for a repository.
|
||||
|
|
|
@ -25,7 +25,7 @@ We recommend reviewing the following caveats before you change the visibility of
|
|||
* If you're using {% data variables.product.prodname_free_user %} for user accounts or organizations, some features won't be available in the repository after you change the visibility to private. {% data reusables.gated-features.more-info %}{% endif %}
|
||||
* Any published {% data variables.product.prodname_pages %} site will be automatically unpublished.{% if currentVersion == "free-pro-team@latest" %} If you added a custom domain to the {% data variables.product.prodname_pages %} site, you should remove or update your DNS records before making the repository private, to avoid the risk of a domain takeover. For more information, see "[Managing a custom domain for your {% data variables.product.prodname_pages %} site](/articles/managing-a-custom-domain-for-your-github-pages-site)."{% endif %}{% if currentVersion == "free-pro-team@latest" %}
|
||||
* {% data variables.product.prodname_dotcom %} will no longer include the repository in the {% data variables.product.prodname_archive %}. For more information, see "[About archiving content and data on {% data variables.product.prodname_dotcom %}](/github/creating-cloning-and-archiving-repositories/about-archiving-content-and-data-on-github#about-the-github-archive-program)."{% endif %}{% if currentVersion == "free-pro-team@latest" %}
|
||||
* {% data variables.product.prodname_GH_advanced_security %} features, such as {% data variables.product.prodname_code_scanning %}, will stop working unless the repository is owned by an organization that has a license for {% data variables.product.prodname_advanced_security %}. {% data reusables.advanced-security.more-info-ghas %}{% endif %}{% if enterpriseServerVersions contains currentVersion %}
|
||||
* {% data variables.product.prodname_GH_advanced_security %} features, such as {% data variables.product.prodname_code_scanning %}, will stop working unless the repository is owned by an organization that has a license for {% data variables.product.prodname_advanced_security %} with sufficient spare seats. {% data reusables.advanced-security.more-info-ghas %}{% endif %}{% if enterpriseServerVersions contains currentVersion %}
|
||||
* Anonymous Git read access is no longer available. For more information, see "[Enabling anonymous Git read access for a repository](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository)."{% endif %}
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
|
||||
|
|
|
@ -55,13 +55,13 @@ There are several types of data that applications can request.
|
|||
| Type of data | Description |
|
||||
| --- | --- |
|
||||
| Commit status | You can grant access for a third-party application to report your commit status. Commit status access allows applications to determine if a build is a successful against a specific commit. Applications won't have access to your code, but they <em>can</em> read and write status information against a specific commit. |
|
||||
| Deployments | Deployment status access allows applications to determine if a deployment is successful against a specific commit for public and private repositories. Applications won't have access to your code. |
|
||||
| Gists | [Gist](https://gist.github.com) access allows applications to read or write to both your public and secret Gists. |
|
||||
| Deployments | Deployment status access allows applications to determine if a deployment is successful against a specific commit for a repository. Applications won't have access to your code. |
|
||||
| Gists | [Gist](https://gist.github.com) access allows applications to read or write to {% if currentVersion != "github-ae@latest" %}both your public and{% else %}both your internal and{% endif %} secret Gists. |
|
||||
| Hooks | [Webhooks](/webhooks) access allows applications to read or write hook configurations on repositories you manage. |
|
||||
| Notifications | Notification access allows applications to read your {% data variables.product.product_name %} notifications, such as comments on issues and pull requests. However, applications remain unable to access anything in your repositories. |
|
||||
| Organizations and teams | Organization and teams access allows apps to access and manage organization and team membership. |
|
||||
| Personal user data | User data includes information found in your user profile, like your name, e-mail address, and location. |
|
||||
| Repositories | Repository information includes the names of contributors, the branches you've created, and the actual files within your repository. Applications can request access for either public or private repositories on a user-wide level. |
|
||||
| Repositories | Repository information includes the names of contributors, the branches you've created, and the actual files within your repository. Applications can request access for either {% if currentVersion != "github-ae@latest" %}public{% else %}internal{% endif %} or private repositories on a user-wide level. |
|
||||
| Repository delete | Applications can request to delete repositories that you administer, but they won't have access to your code. |
|
||||
|
||||
### Requesting updated permissions
|
||||
|
|
|
@ -29,7 +29,11 @@ Personal access tokens (PATs) are an alternative to using passwords for authenti
|
|||
5. Give your token a descriptive name.
|
||||
![Token description field](/assets/images/help/settings/token_description.png)
|
||||
6. Select the scopes, or permissions, you'd like to grant this token. To use your token to access repositories from the command line, select **repo**.
|
||||
{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
|
||||
![Selecting token scopes](/assets/images/help/settings/token_scopes.gif)
|
||||
{% elsif currentVersion == "github-ae@latest" %}
|
||||
![Selecting token scopes](/assets/images/enterprise/github-ae/settings/access-token-scopes-for-ghae.png)
|
||||
{% endif %}
|
||||
7. Click **Generate token**.
|
||||
![Generate token button](/assets/images/help/settings/generate_token.png)
|
||||
8. Click {% octicon "clippy" aria-label="The copy to clipboard icon" %} to copy the token to your clipboard. For security reasons, after you navigate off the page, you will not be able to see the token again.{% if currentVersion == "free-pro-team@latest" %}
|
||||
|
|
|
@ -23,7 +23,7 @@ You're under no obligation to choose a license. However, without a license, the
|
|||
|
||||
### Determining the location of your license
|
||||
|
||||
Most people place their license text in a file named `LICENSE.txt` (or `LICENSE.md`) in the root of the repository; [here's an example from Hubot](https://github.com/github/hubot/blob/master/LICENSE.md).
|
||||
Most people place their license text in a file named `LICENSE.txt` (or `LICENSE.md` or `LICENSE.rst`) in the root of the repository; [here's an example from Hubot](https://github.com/github/hubot/blob/master/LICENSE.md).
|
||||
|
||||
Some projects include information about their license in their README. For example, a project's README may include a note saying "This project is licensed under the terms of the MIT license."
|
||||
|
||||
|
|
|
@ -9,9 +9,9 @@ versions:
|
|||
|
||||
### About {% data variables.product.prodname_GH_advanced_security %}
|
||||
|
||||
{% data variables.product.prodname_dotcom %} has many features that help you improve and maintain the quality of your code. Some of these are included in all plans, for example: dependency graph and {% data variables.product.prodname_dependabot_alerts %}. Other security features require a license for {% data variables.product.prodname_GH_advanced_security %} to run on repositories apart from public repositories on {% data variables.product.prodname_dotcom_the_website %}. (That is, private and internal repositories on {% data variables.product.prodname_dotcom_the_website %}, and all repositories on {% data variables.product.prodname_ghe_server %}.)
|
||||
{% data variables.product.prodname_dotcom %} has many features that help you improve and maintain the quality of your code. Some of these are included in all plans{% if currentVersion != "github-ae@latest" %}, such as dependency graph and {% data variables.product.prodname_dependabot_alerts %}{% endif %}. Other security features require a license for {% data variables.product.prodname_GH_advanced_security %} to run on repositories apart from public repositories on {% data variables.product.prodname_dotcom_the_website %}.
|
||||
|
||||
For an overview of all security features, see "[About securing your repository](/github/administering-a-repository/about-securing-your-repository#setting-up-your-repository-securely)." For information about permission requirements for actions related to security features, see "[Repository permission levels for an organization](/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-requirements-for-security-features)."
|
||||
{% if currentVersion == "free-pro-team@latest" %}For more information, see "[About licensing for {% data variables.product.prodname_GH_advanced_security %}](/github/setting-up-and-managing-billing-and-payments-on-github/about-licensing-for-github-advanced-security)."{% elsif currentVersion ver_gt "enterprise-server@2.22" %}For information about purchasing a license for {% data variables.product.prodname_GH_advanced_security %}, contact {% data variables.contact.contact_enterprise_sales %}.{% elsif currentVersion == "github-ae@latest" %}There is no charge for {% data variables.product.prodname_GH_advanced_security %} on {% data variables.product.prodname_ghe_managed %} during the beta release.{% endif %}
|
||||
|
||||
### About {% data variables.product.prodname_advanced_security %} features
|
||||
|
||||
|
@ -25,17 +25,7 @@ A {% data variables.product.prodname_GH_advanced_security %} license provides th
|
|||
- **Dependency review** - Show the full impact of changes to dependencies and see details of any vulnerable versions before you merge a pull request. For more information, see "[Reviewing dependency changes in a pull request](/github/collaborating-with-issues-and-pull-requests/reviewing-dependency-changes-in-a-pull-request)."
|
||||
{% endif %}
|
||||
|
||||
For information about {% data variables.product.prodname_advanced_security %} features that are in development, see "[{% data variables.product.prodname_dotcom %} public roadmap](https://github.com/github/roadmap)."
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}
|
||||
|
||||
### About {% data variables.product.prodname_advanced_security %} licensing
|
||||
|
||||
{% data reusables.advanced-security.license-overview %}
|
||||
|
||||
{% data reusables.advanced-security.enable-disable-committer-info %}
|
||||
|
||||
{% endif %}
|
||||
For information about {% data variables.product.prodname_advanced_security %} features that are in development, see "[{% data variables.product.prodname_dotcom %} public roadmap](https://github.com/github/roadmap)." For an overview of all security features, see "[About securing your repository](/github/administering-a-repository/about-securing-your-repository#setting-up-your-repository-securely)."
|
||||
|
||||
{% if currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}
|
||||
### Enabling {% data variables.product.prodname_advanced_security %} features on {% data variables.product.product_name %}
|
||||
|
@ -46,24 +36,18 @@ The site administrator must enable {% data variables.product.prodname_advanced_s
|
|||
|
||||
Once your system is set up, you can enable and disable these features at the organization or repository level. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)" and "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)."
|
||||
|
||||
{% if currentVersion ver_gt "enterprise-server@2.22" %}
|
||||
For information about purchasing a license for {% data variables.product.prodname_GH_advanced_security %}, contact {% data variables.contact.contact_enterprise_sales %}.
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
|
||||
{% if currentVersion != "github-ae@latest" %}
|
||||
### Enabling {% data variables.product.prodname_advanced_security %} features on {% data variables.product.prodname_dotcom_the_website %}
|
||||
|
||||
For public repositories on {% data variables.product.prodname_dotcom_the_website %}, these features are permanently on and are only disabled if you change the visibility of the project so that the code is no longer public.
|
||||
For public repositories on {% data variables.product.prodname_dotcom_the_website %}, these features are permanently on and can only be disabled if you change the visibility of the project so that the code is no longer public.
|
||||
|
||||
For other repositories, once you have a license for your organization or enterprise, you can enable and disable these features at the organization or repository level. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)" and "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)."
|
||||
For other repositories, once you have a license for your organization or enterprise, you can enable and disable these features at the organization or repository level. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)" and "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)."{% endif %}
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
|
||||
If you have an enterprise account, license use for the enterprise is shown on your billing page. For more information, see "[Managing use of Advanced Security for organizations in your enterprise account](/github/setting-up-and-managing-your-enterprise/managing-use-of-advanced-security-for-organizations-in-your-enterprise-account)."
|
||||
If you have an enterprise account, license use for the entire enterprise is shown on your enterprise license page. For more information, see "[Viewing your {% data variables.product.prodname_GH_advanced_security %} usage](/github/setting-up-and-managing-billing-and-payments-on-github/viewing-your-github-advanced-security-usage)."
|
||||
|
||||
{% endif %}
|
||||
|
||||
For information about purchasing a license for {% data variables.product.prodname_GH_advanced_security %}, contact {% data variables.contact.contact_enterprise_sales %}.
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
|
|
|
@ -0,0 +1,50 @@
|
|||
---
|
||||
title: About licensing for GitHub Advanced Security
|
||||
intro: 'If you want to use {% data variables.product.prodname_GH_advanced_security %} features in a private or internal repository, you need a license. These features are available free of charge for public repositories.'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
---
|
||||
|
||||
### About licensing for {% data variables.product.prodname_GH_advanced_security %}
|
||||
|
||||
If you want to use {% data variables.product.prodname_GH_advanced_security %} features on any repository apart from a public repository on {% data variables.product.prodname_dotcom_the_website %}, you will need a license. For more information about {% data variables.product.prodname_GH_advanced_security %}, see "[About {% data variables.product.prodname_GH_advanced_security %}](/github/getting-started-with-github/about-github-advanced-security)."
|
||||
|
||||
{% data reusables.advanced-security.license-overview %}
|
||||
|
||||
You can buy a license for an organization that is owned by a user account or for your enterprise account. If you want to use {% data variables.product.prodname_GH_advanced_security %} features for a private, user-owned repository, you must transfer the repository to an organization with a license.
|
||||
|
||||
To discuss licensing for {% data variables.product.prodname_GH_advanced_security %}, contact {% data variables.contact.contact_enterprise_sales %}.
|
||||
|
||||
### About committer numbers for {% data variables.product.prodname_GH_advanced_security %}
|
||||
|
||||
We record and display two numbers of committers for {% data variables.product.prodname_GH_advanced_security %} on {% data variables.product.prodname_dotcom_the_website %}:
|
||||
|
||||
- **Committers** is the number of committers who contributed to at least one private repository in an organization and who use a seat in your license. That is, they are also an organization member, an external collaborator, or have a pending invitation to join your organization or enterprise account.
|
||||
- **Unique to this repository/organization** is the number of committers who contributed only to this repository, or to repositories in this organization. This number shows how many license seats you can free up by disabling {% data variables.product.prodname_GH_advanced_security %} for that repository or organization.
|
||||
|
||||
If there are no unique committers, this means that all active committers also contribute to other repositories or organizations that use {% data variables.product.prodname_GH_advanced_security %}. Disabling the feature for that repository or organization would not free any seats on your license.
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** The total number of seats used in your license is not the sum of either the committers or the unique committers to each repository or organization. This is because there are people who contribute to multiple repositories or organizations. The number of seats used is measured across the whole enterprise or organization account to ensure that each person is counted only once regardless of how many repositories or organizations they contribute to.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
### Managing your license usage for {% data variables.product.prodname_GH_advanced_security %}
|
||||
|
||||
When you enable {% data variables.product.prodname_GH_advanced_security %} for a single repository, or for all repositories in an organization, {% data variables.product.company_short %} shows how many extra seats this will use and prompts you for confirmation. If you disable access to {% data variables.product.prodname_GH_advanced_security %}, any seats used by "unique" committers are freed up. This makes it easy to understand the impact of your changes on the use of your license.
|
||||
|
||||
If you are over your license limit, {% data variables.product.prodname_GH_advanced_security %} continues to work on all repositories where it is already enabled. However, in organizations where {% data variables.product.prodname_GH_advanced_security %} is enabled for new repositories, repositories will be created with the feature disabled. In addition, the option to enable {% data variables.product.prodname_GH_advanced_security %} for existing repositories will not be available. If you change the visibility of a public repository to private then {% data variables.product.prodname_GH_advanced_security %} will be disabled for that repository.
|
||||
|
||||
As soon as you free up some seats, by disabling {% data variables.product.prodname_GH_advanced_security %} for some repositories or by increasing your license size, the options for enabling {% data variables.product.prodname_GH_advanced_security %} will work again as normal.
|
||||
|
||||
For information on viewing usage, see "[Viewing your GitHub Advanced Security usage](/github/setting-up-and-managing-billing-and-payments-on-github/viewing-your-github-advanced-security-usage)."
|
||||
|
||||
### Getting the most out of your {% data variables.product.prodname_GH_advanced_security %} license
|
||||
|
||||
When you decide which repositories and organizations to prioritize for {% data variables.product.prodname_GH_advanced_security %}, you should review them and identify:
|
||||
|
||||
- Codebases that are the most critical to your company's success. These are the projects for which the introduction of vulnerable code, hard-coded secrets, or vulnerable dependencies would have the greatest impact on your company.
|
||||
- Codebases with the highest commit frequency. These are the most actively developed projects, consequently there is a higher risk that security problems could be introduced.
|
||||
|
||||
When you have enabled {% data variables.product.prodname_GH_advanced_security %} for these organizations or repositories, you should assess which other codebases you could add without adding any extra unique committers and using up more seats on your license. After this, review the next most important and busy code bases. If you want to increase the number of seats in your license, contact {% data variables.contact.contact_enterprise_sales %}.
|
|
@ -44,6 +44,9 @@ versions:
|
|||
{% link_in_list /viewing-your-git-large-file-storage-usage %}
|
||||
{% link_in_list /upgrading-git-large-file-storage %}
|
||||
{% link_in_list /downgrading-git-large-file-storage %}
|
||||
{% topic_link_in_list /managing-licensing-for-github-advanced-security %}
|
||||
{% link_in_list /about-licensing-for-github-advanced-security %}
|
||||
{% link_in_list /viewing-your-github-advanced-security-usage %}
|
||||
{% topic_link_in_list /managing-billing-for-github-sponsors %}
|
||||
{% link_in_list /about-billing-for-github-sponsors %}
|
||||
{% link_in_list /upgrading-a-sponsorship %}
|
||||
|
|
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
title: Managing licensing for GitHub Advanced Security
|
||||
intro: 'You can view and manage your use of seats on a license for {% data variables.product.prodname_advanced_security %}.'
|
||||
mapTopic: true
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
---
|
|
@ -0,0 +1,45 @@
|
|||
---
|
||||
title: Viewing your GitHub Advanced Security usage
|
||||
intro: 'You can view and manage usage of your {% data variables.product.prodname_GH_advanced_security %} license.'
|
||||
permissions: Organization and enterprise owners can manage access to {% data variables.product.prodname_GH_advanced_security %} for their organization or enterprise organizations.
|
||||
redirect_from: /github/setting-up-and-managing-your-enterprise/managing-use-of-advanced-security-for-organizations-in-your-enterprise-account
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
---
|
||||
|
||||
Each license for {% data variables.product.prodname_GH_advanced_security %} specifies a maximum number of accounts, or seats, that can use these features. Periodically you should check that your use is within your license capacity. For more information, see "[About licensing for {% data variables.product.prodname_GH_advanced_security %} enterprise license](/github/setting-up-and-managing-billing-and-payments-on-github/about-licensing-for-github-advanced-security)."
|
||||
|
||||
### Viewing and managing {% data variables.product.prodname_GH_advanced_security %} license usage for your organization
|
||||
|
||||
You can check how many seats your license includes and how many of them are currently used on the "Billing & plans" page for your organization.
|
||||
|
||||
{% data reusables.profile.access_profile %}
|
||||
{% data reusables.profile.access_org %}
|
||||
{% data reusables.organizations.org_settings %}
|
||||
{% data reusables.organizations.billing_planning %}
|
||||
5. Optionally, in the "{% data variables.product.prodname_GH_advanced_security %}" section, click **Manage repositories** to see the usage for each repository that has the feature enabled.
|
||||
![Details of usage of seats](/assets/images/help/billing/ghas-seats-org.png)
|
||||
6. Scroll to the "{% data variables.product.prodname_GH_advanced_security %} repositories" section to see a detailed breakdown of usage by repository for your organization.
|
||||
![{% data variables.product.prodname_GH_advanced_security %} repositories section](/assets/images/help/organizations/settings-security-analysis-ghas-repos-list.png)
|
||||
For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)."
|
||||
|
||||
### Viewing and managing {% data variables.product.prodname_GH_advanced_security %} license usage for your enterprise account
|
||||
|
||||
You can check how many seats your license includes and how many of them are currently used on the "Enterprise licensing" page.
|
||||
|
||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||
{% data reusables.enterprise-accounts.settings-tab %}
|
||||
{% data reusables.enterprise-accounts.license-tab %}
|
||||
The "{% data variables.product.prodname_GH_advanced_security %}" section shows details of the current usage.
|
||||
![{% data variables.product.prodname_GH_advanced_security %} in enterprise licensing settings](/assets/images/help/enterprises/enterprise-licensing-tab-ghas.png)
|
||||
If you run out of seats, the section will be red. You should either reduce your use of {% data variables.product.prodname_GH_advanced_security %} or purchase more seats. For more information, see "[About licensing for {% data variables.product.prodname_GH_advanced_security %} enterprise license](/github/setting-up-and-managing-billing-and-payments-on-github/about-licensing-for-github-advanced-security#getting-the-most-out-of-your-github-advanced-security-enterprise-license)."
|
||||
![{% data variables.product.prodname_GH_advanced_security %} in enterprise licensing settings](/assets/images/help/enterprises/enterprise-licensing-tab-ghas-no-seats.png)
|
||||
4. Optionally, to see a detailed breakdown of usage per organization, in the left sidebar, click **Billing**.
|
||||
![Billing tab in the enterprise account settings sidebar](/assets/images/help/business-accounts/settings-billing-tab.png)
|
||||
In the "{% data variables.product.prodname_GH_advanced_security %}" section you can see the number of committers and unique committers for each organization.
|
||||
![{% data variables.product.prodname_GH_advanced_security %} in enterprise billing settings](/assets/images/help/billing/ghas-orgs-list-enterprise.png)
|
||||
5. Optionally, click the name of an organization where you are an owner to display the security and analysis settings for the organization.
|
||||
![Owned organization in {% data variables.product.prodname_GH_advanced_security %} section of enterprise billing settings](/assets/images/help/billing/ghas-orgs-list-enterprise-click-org.png)
|
||||
6. On the "Security & analysis" settings page, scroll to the "{% data variables.product.prodname_GH_advanced_security %} repositories" section to see a detailed breakdown of usage by repository for this organization.
|
||||
![{% data variables.product.prodname_GH_advanced_security %} repositories section](/assets/images/help/enterprises/settings-security-analysis-ghas-repos-list.png)
|
||||
For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)."
|
|
@ -45,7 +45,7 @@ You can enable or disable features for all repositories. {% if currentVersion ==
|
|||
{% data reusables.advanced-security.note-org-enable-uses-seats %}
|
||||
|
||||
1. Go to the security and analysis settings for your organization. For more information, see "[Displaying the security and analysis settings](#displaying-the-security-and-analysis-settings)."
|
||||
2. Under "Configure security and analysis features", to the right of the feature, click **Disable all** or **Enable all**.
|
||||
2. Under "Configure security and analysis features", to the right of the feature, click **Disable all** or **Enable all**. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}The control for "{% data variables.product.prodname_GH_advanced_security %}" is disabled if you have no available seats in your {% data variables.product.prodname_GH_advanced_security %} license.{% endif %}
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}
|
||||
!["Enable all" or "Disable all" button for "Configure security and analysis" features](/assets/images/help/organizations/security-and-analysis-disable-or-enable-all-ghas-dotcom.png)
|
||||
{% endif %}
|
||||
|
@ -90,8 +90,6 @@ You can enable or disable features for all repositories. {% if currentVersion ==
|
|||
![Checkbox for enabling or disabling a feature for new repositories](/assets/images/enterprise/github-ae/organizations/security-and-analysis-enable-or-disable-secret-scanning-checkbox-ghae.png)
|
||||
{% endif %}
|
||||
|
||||
{% data reusables.advanced-security.note-org-enable-uses-seats %}
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
|
||||
### Allowing Dependabot to access private repositories
|
||||
|
@ -117,18 +115,18 @@ By default, {% data variables.product.prodname_dependabot %} can't update depend
|
|||
|
||||
### Removing access to {% data variables.product.prodname_GH_advanced_security %} from individual repositories in an organization
|
||||
|
||||
You can manage the use of {% data variables.product.prodname_GH_advanced_security %} for a repository using the "Security & analysis" page, on the "Settings" tab. You can also disable the use of {% data variables.product.prodname_GH_advanced_security %} for any repository in an organization from the "Security & analysis" page of the organization.
|
||||
You can manage access to {% data variables.product.prodname_GH_advanced_security %} features for a repository from its "Settings" tab. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)." However, you can also disable {% data variables.product.prodname_GH_advanced_security %} features for a repository from the "Settings" tab for the organization.
|
||||
|
||||
1. Go to the security and analysis settings for your organization. For more information, see "[Displaying the security and analysis settings](#displaying-the-security-and-analysis-settings)."
|
||||
1. To see a list of all the repositories in your organization with {% data variables.product.prodname_GH_advanced_security %} enabled, scroll to the "{% data variables.product.prodname_GH_advanced_security %} repositories" section.
|
||||
![{% data variables.product.prodname_GH_advanced_security %} repositories section](/assets/images/help/organizations/ghas-repos-list.png)
|
||||
The table lists the number of unique committers for each repository. This is the number of seats you could free up on your license by removing access to {% data variables.product.prodname_GH_advanced_security %}.
|
||||
1. To remove access to {% data variables.product.prodname_GH_advanced_security %} from a repository, click the adjacent {% octicon "x" aria-label="X symbol" %}.
|
||||
![{% data variables.product.prodname_GH_advanced_security %} repositories section](/assets/images/help/organizations/settings-security-analysis-ghas-repos-list.png)
|
||||
The table lists the number of unique committers for each repository. This is the number of seats you could free up on your license by removing access to {% data variables.product.prodname_GH_advanced_security %}. The size of your license is shown for organization-level licenses. For more information, see "[About licensing for {% data variables.product.prodname_GH_advanced_security %}](/github/setting-up-and-managing-billing-and-payments-on-github/about-licensing-for-github-advanced-security)."
|
||||
1. To remove access to {% data variables.product.prodname_GH_advanced_security %} from a repository and free up seats used by any committers that are unique to the repository, click the adjacent {% octicon "x" aria-label="X symbol" %}.
|
||||
1. In the confirmation dialog, click **Remove repository** to remove access to the features of {% data variables.product.prodname_GH_advanced_security %}.
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** If you remove access to {% data variables.product.prodname_GH_advanced_security %} for a repository, you should communicate with the affected development team so that they know that the change was intended. Otherwise they may assume that the change was a mistake and re-enable access.
|
||||
**Note:** If you remove access to {% data variables.product.prodname_GH_advanced_security %} for a repository, you should communicate with the affected development team so that they know that the change was intended. This ensures that they don't waste time debugging failed runs of code scanning.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
|
|
|
@ -145,10 +145,16 @@ In this section, you can find the repository permission levels required for secu
|
|||
| [Enable the dependency graph](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-and-dependents-of-a-repository) for a private repository | | | | | **X** |
|
||||
| [View dependency reviews](/github/collaborating-with-issues-and-pull-requests/reviewing-dependency-changes-in-a-pull-request) | **X** | **X** | **X** | **X** | **X** |{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}
|
||||
| [View {% data variables.product.prodname_code_scanning %} alerts on pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests) | **X** | **X** | **X** | **X** | **X** |
|
||||
| [List, dismiss, and delete {% data variables.product.prodname_code_scanning %} alerts](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository) | | | **X** | **X** | **X** |{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}
|
||||
| [List, dismiss, and delete {% data variables.product.prodname_code_scanning %} alerts](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository) | | | **X** | **X** | **X** |{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == 'github-ae@next' %}
|
||||
| [View {% data variables.product.prodname_secret_scanning %} alerts in a repository](/github/administering-a-repository/managing-alerts-from-secret-scanning) | | | **X**<sup>[1]</sup> | **X**<sup>[1]</sup> | **X** |
|
||||
| [Resolve, revoke, or re-open {% data variables.product.prodname_secret_scanning %} alerts](/github/administering-a-repository/managing-alerts-from-secret-scanning) | | | **X**<sup>[1]</sup> | **X**<sup>[1]</sup> | **X** |{% endif %}{% if currentVersion == "enterprise-server@3.0" %}
|
||||
| [View {% data variables.product.prodname_secret_scanning %} alerts in a repository](/github/administering-a-repository/managing-alerts-from-secret-scanning) | | | | | **X** |
|
||||
| [Resolve, revoke or re-open {% data variables.product.prodname_secret_scanning %} alerts](/github/administering-a-repository/managing-alerts-from-secret-scanning) | | | | | **X** |
|
||||
| [Resolve, revoke, or re-open {% data variables.product.prodname_secret_scanning %} alerts](/github/administering-a-repository/managing-alerts-from-secret-scanning) | | | | | **X** |{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
|
||||
| [Designate additional people or teams to receive {% data variables.product.prodname_secret_scanning %} alerts](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts) in repositories | | | | | **X** |{% endif %}
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == 'github-ae@next' %}
|
||||
[1] Repository writers and maintainers can only see alert information for their own commits.
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
|
||||
### Further reading
|
||||
|
|
|
@ -29,7 +29,6 @@ versions:
|
|||
{% link_in_list /managing-unowned-organizations-in-your-enterprise-account %}
|
||||
{% link_in_list /viewing-the-audit-logs-for-organizations-in-your-enterprise-account %}
|
||||
{% link_in_list /configuring-webhooks-for-organization-events-in-your-enterprise-account %}
|
||||
{% link_in_list /managing-use-of-advanced-security-for-organizations-in-your-enterprise-account %}
|
||||
{% topic_link_in_list /configuring-identity-and-access-management-for-your-enterprise-account %}
|
||||
{% link_in_list /about-identity-and-access-management-for-your-enterprise-account %}
|
||||
{% link_in_list /enabling-saml-single-sign-on-for-organizations-in-your-enterprise-account %}
|
||||
|
|
|
@ -1,42 +0,0 @@
|
|||
---
|
||||
title: Managing use of Advanced Security for organizations in your enterprise account
|
||||
intro: 'You can review and manage the use of {% data variables.product.prodname_GH_advanced_security %} for organizations owned by an enterprise account.'
|
||||
shortTitle: Managing use of Advanced Security
|
||||
product: '{% data reusables.gated-features.enterprise-accounts %}'
|
||||
permissions: Enterprise owners can manage access to {% data variables.product.prodname_GH_advanced_security %} for organizations and repositories in an enterprise account.
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
---
|
||||
|
||||
### About {% data variables.product.prodname_GH_advanced_security %} for enterprise accounts
|
||||
|
||||
{% data variables.product.prodname_dotcom %} makes additional security features available to private repositories owned by enterprise accounts with a license for {% data variables.product.prodname_GH_advanced_security %}. {% data reusables.advanced-security.more-info-ghas %}
|
||||
|
||||
{% data reusables.advanced-security.license-overview %}
|
||||
|
||||
You can see a summary of your current license usage for each organization on the billing page for the enterprise account (see below).
|
||||
|
||||
### About committer numbers for enterprise accounts
|
||||
|
||||
The {% data variables.product.prodname_GH_advanced_security %} summary for an enterprise account reports two numbers of committers for each organization:
|
||||
|
||||
- **Committers** is the number of committers who contributed to at least one private repository in the organization and who use a seat in your enterprise license. That is, they are an organization member, external collaborator to a repository, or have a pending invitation to join your enterprise account.
|
||||
- **Unique to this organization** is the number of committers who contributed only to repositories in that organization. This number shows how many license seats you can free up by disabling {% data variables.product.prodname_GH_advanced_security %} for that organization.
|
||||
|
||||
{% data reusables.advanced-security.enable-disable-committer-info %}
|
||||
|
||||
### Managing the use of {% data variables.product.prodname_GH_advanced_security %} for an enterprise account
|
||||
|
||||
If you have a license for {% data variables.product.prodname_GH_advanced_security %}, the enterprise billing page includes a "{% data variables.product.prodname_GH_advanced_security %}" section that lists the organizations that use the feature.
|
||||
|
||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||
{% data reusables.enterprise-accounts.settings-tab %}
|
||||
{% data reusables.enterprise-accounts.billing-tab %}
|
||||
1. In the "{% data variables.product.prodname_GH_advanced_security %}" section you can see the number of committers and unique committers for each organization.
|
||||
![{% data variables.product.prodname_GH_advanced_security %} in enterprise billing settings](/assets/images/help/enterprises/ghas-orgs-list.png)
|
||||
1. If you are an organization owner, you can click the name to display the billings and plans for the organization.
|
||||
![Owned organization in {% data variables.product.prodname_GH_advanced_security %} section of enterprise billing settings](/assets/images/help/enterprises/ghas-orgs-list-click-org.png)
|
||||
|
||||
For detailed information of which repositories in an organization use {% data variables.product.prodname_GH_advanced_security %}, view the "Security & analysis" page for an organization.
|
||||
|
||||
For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)."
|
|
@ -37,6 +37,6 @@ For more information about managing billing managers, see "[Inviting people to m
|
|||
|
||||
- "[About billing for GitHub Actions](/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-actions#about-billing-for-github-actions)"
|
||||
- "[About billing for Git Large File Storage](/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-git-large-file-storage)"
|
||||
- "[Managing use of Advanced Security for organizations in your enterprise account](/github/setting-up-and-managing-your-enterprise/managing-use-of-advanced-security-for-organizations-in-your-enterprise-account)"
|
||||
- "[About licensing for {% data variables.product.prodname_GH_advanced_security %}](/github/setting-up-and-managing-billing-and-payments-on-github/about-licensing-for-github-advanced-security)"
|
||||
|
||||
{% endif %}
|
||||
|
|
|
@ -0,0 +1,72 @@
|
|||
---
|
||||
title: GitHub Candidate Privacy Policy
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
---
|
||||
|
||||
Effective Date: March 8, 2021
|
||||
|
||||
This GitHub Candidate Privacy Policy explains what information we collect about you during the application or recruitment process for employment with GitHub, as well as the purposes for which we collect and use that information.
|
||||
|
||||
For the purposes of this policy:
|
||||
|
||||
“Candidate” includes applicants and candidates who are part of the GitHub application or recruitment process; and
|
||||
|
||||
"Candidate Personal Information" refers to any information we collect about one of our Candidates during the application or recruitment process which could, alone or together with other information, personally identify them or otherwise be reasonably linked or connected with them.
|
||||
|
||||
This policy does not apply to the use of GitHub services, which are covered under our [GitHub Privacy Statement](/github/site-policy/github-privacy-statement).
|
||||
|
||||
### What Candidate Personal Information do we collect?
|
||||
|
||||
The Candidate Personal Information we collect, use, and maintain (or “process”) can include the following, but is not limited to:
|
||||
|
||||
**Identification and contact information**, including your name, email address, phone number, location, GitHub profile, and any other information you provide (such as referrals and references).
|
||||
|
||||
**National identifiers**, such as your citizenship status, residency and work permit status.
|
||||
|
||||
**Employment and education history**, such as your resume or CV, cover letter, details of how you heard about the position you are applying for, information about any previous employment at GitHub or affiliates of GitHub, or other information you provide to us in support of an application and/or the application and recruitment process.
|
||||
|
||||
**Professional or employment information**, including your desired salary or terms related to benefits, willingness to relocate, other job preferences, interview details, reference information and/or information received from background checks (where applicable), and information from publicly available resources (such as your LinkedIn profile or website).
|
||||
|
||||
**Sensitive or demographic information**, such as your gender, medical or health information, veteran status, or your racial or ethnic origin.
|
||||
|
||||
### How do we use the Candidate Personal Information we collect?
|
||||
|
||||
We use the Candidate Personal Information for the following purposes:
|
||||
- To assess your skills, qualifications and interests for employment opportunities with GitHub;
|
||||
- To verify the information provided by you or others, including checking your references;
|
||||
- To communicate with you about your application and the recruitment process, including informing you of other potential employment opportunities at GitHub;
|
||||
- If you were referred, to inform the referrer of the status of your application;
|
||||
- If you are offered a position, to prepare your offer letter and conduct a background check (to the extent permitted by applicable law);
|
||||
- If you are offered a position and where requested by you, to assist you with obtaining an immigration visa or work permit;
|
||||
- To comply with local laws, regulations, legal processes or enforceable government requests; and
|
||||
- To prepare and submit reports as required under local laws and regulations;
|
||||
- To manage and improve our application and recruitment process (such as making the application process more efficient and improving our diversity practices).
|
||||
|
||||
### How do we share your Candidate Personal Information?
|
||||
|
||||
GitHub will share your Candidate Personal Information with those who have a legitimate business need for it. Whenever we permit a third party to access your Candidate Personal Information, we will make sure the information is used in a manner consistent with this policy. Your Candidate Personal Information may be shared with our affiliates (such as Microsoft) and other third parties (such as vendors) for the following purposes:
|
||||
1. In order to carry out the uses of Candidate Personal Information described above;
|
||||
2. To enable third parties to provide products or services to us or on our behalf (such as to facilitate the application process or conduct background checks).
|
||||
3. To comply with our legal obligations, regulations or contracts, or to respond to a court order, administrative or judicial process (such as subpoena, government audit or search warrant) or, in response to lawful requests by public authorities (such as national security or law enforcement);
|
||||
4. As necessary to establish, exercise, or defend against potential or pending litigation;
|
||||
5. Where necessary to protect GitHub, your vital interests (such as safety and security), or those of another person; or
|
||||
6. With your consent (such to contact your referees). It is your responsibility to obtain consent from referees before providing their personal information to GitHub.
|
||||
|
||||
### Your rights to your Candidate Personal Information
|
||||
|
||||
In some locations, Candidates may have certain rights under applicable local privacy laws (such as the European General Data Protection Regulation). However, regardless of your location, we provide the same high standard of privacy protection to all of our Candidates around the world.
|
||||
|
||||
This includes the rights to request access or correct your information, request that your information be deleted, or object to or restrict GitHub from using it for certain purposes.
|
||||
|
||||
You can make a request to do so by contacting privacy@github.com. We will respond to all requests in accordance with applicable data protection laws.
|
||||
|
||||
### How long do we retain your Candidate Personal Information?
|
||||
|
||||
Candidate Personal Information will be stored for one year after your application to comply with our legal obligations. After that time, we will contact you and ask for your consent to continue to retain your personal information so that we can consider you for any future job opportunities at GitHub.
|
||||
|
||||
If you are hired for a position at GitHub, we will retain the information provided during the application and recruitment process as part of your employee record.
|
||||
|
||||
### Changes to this Policy
|
||||
|
||||
We may occasionally update this GitHub Candidate Privacy Policy. When we do make changes to this page, we will update the "last updated" date.
|
|
@ -180,7 +180,7 @@ GitHub may offer subscription-based access to our API for those Users who requir
|
|||
Some Service features may be subject to additional terms specific to that feature or product as set forth in the GitHub Additional Product Terms. By accessing or using the Services, you also agree to the [GitHub Additional Product Terms](/github/site-policy/github-additional-product-terms).
|
||||
|
||||
### J. Beta Previews
|
||||
**Short version:** *Beta Previews may not be supported or may change at any time, you may receive confidential information through those programs that must remain confidential while the program is private, and we'd love your feedback to make our Beta Previews better.*
|
||||
**Short version:** *Beta Previews may not be supported or may change at any time. You may receive confidential information through those programs that must remain confidential while the program is private. We'd love your feedback to make our Beta Previews better.*
|
||||
|
||||
#### 1. Subject to Change
|
||||
|
||||
|
|
|
@ -44,6 +44,7 @@ versions:
|
|||
{% link_in_list /github-deceased-user-policy %}
|
||||
{% link_in_list /github-statement-against-modern-slavery-and-child-labor %}
|
||||
{% link_in_list /github-anti-bribery-statement %}
|
||||
{% link_in_list /github-candidate-privacy-policy %}
|
||||
{% link_in_list /github-gifts-and-entertainment-policy %}
|
||||
{% link_in_list /github-event-terms %}
|
||||
{% link_in_list /github-event-code-of-conduct %}
|
||||
|
|
|
@ -14,8 +14,6 @@ When you enable data use for your private repository, you'll be able to access t
|
|||
|
||||
### Enabling or disabling data use features
|
||||
|
||||
{% data reusables.security.some-security-and-analysis-features-are-enabled-by-default %}
|
||||
|
||||
{% data reusables.security.security-and-analysis-features-enable-read-only %}
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
|
|
|
@ -70,7 +70,7 @@ The recommended formats explicitly define which versions are used for all direct
|
|||
| `dotnet` CLI | .NET languages (C#, C++, F#, VB) | `.csproj`, `.vbproj`, `.nuspec`, `.vcxproj`, `.fsproj` | `.csproj`, `.vbproj`, `.nuspec`, `.vcxproj`, `.fsproj`, `packages.config` |
|
||||
| Maven | Java, Scala | `pom.xml` | `pom.xml` |
|
||||
| npm | JavaScript | `package-lock.json` | `package-lock.json`, `package.json`|
|
||||
| Python PIP | Python | `requirements.txt`, `pipfile.lock` | `requirements.txt`, `pipfile.lock`, `setup.py`* |
|
||||
| Python PIP | Python | `requirements.txt`, `pipfile.lock` | `requirements.txt`, `pipfile`, `pipfile.lock`, `setup.py`* |
|
||||
| RubyGems | Ruby | `Gemfile.lock` | `Gemfile.lock`, `Gemfile`, `*.gemspec` |
|
||||
| Yarn | JavaScript | `yarn.lock` | `package.json`, `yarn.lock` |
|
||||
|
||||
|
|
|
@ -26,9 +26,10 @@ The following scopes are recommended:
|
|||
|
||||
{% endif %}
|
||||
|
||||
|
||||
```
|
||||
user
|
||||
public_repo
|
||||
user{% if currentVersion != "github-ae@latest" %}
|
||||
public_repo{% endif %}
|
||||
repo
|
||||
repo_deployment
|
||||
repo:status
|
||||
|
@ -246,7 +247,7 @@ Looking at the composition line by line:
|
|||
|
||||
The `labels` field has the type [`LabelConnection`](/graphql/reference/objects#labelconnection). As with the `issues` object, because `labels` is a connection, we must travel its edges to a connected node: the `label` object. At the node, we can specify the `label` object fields we want to return, in this case, `name`.
|
||||
|
||||
You may notice that running this query on the Octocat's public `Hello-World` repository won't return many labels. Try running it on one of your own repositories that does use labels, and you'll likely see a difference.
|
||||
You may notice that running this query on the Octocat's {% if currentVersion != "github-ae@latest" %}public{% endif %} `Hello-World` repository won't return many labels. Try running it on one of your own repositories that does use labels, and you'll likely see a difference.
|
||||
|
||||
### Example mutation
|
||||
|
||||
|
|
|
@ -58,9 +58,7 @@ For some example queries, see "[An example query using the Enterprise Accounts A
|
|||
- `admin:enterprise`: Gives full control of enterprises (includes `manage_billing:enterprise` and `read:enterprise`)
|
||||
- `manage_billing:enterprise`: Read and write enterprise billing data.
|
||||
- `read:enterprise`: Read enterprise profile data.
|
||||
|
||||
![Permissions options for personal access token](/assets/images/developer/graphql/permissions-for-access-token.png)
|
||||
|
||||
|
||||
4. Copy your personal access token and keep it in a secure place until you add it to your GraphQL client.
|
||||
|
||||
#### 2. Choose a GraphQL client
|
||||
|
@ -95,7 +93,9 @@ Now you are ready to start making queries.
|
|||
|
||||
### An example query using the Enterprise Accounts API
|
||||
|
||||
This GraphQL query requests the total number of `public` repositories in each of your appliance's organizations using the Enterprise Accounts API. To customize this query, replace `<enterprise-account-name>` with the slug of your Enterprise's instance slug.
|
||||
This GraphQL query requests the total number of {% if currentVersion != "github-ae@latest" %}`public`{% else %}`private`{% endif %} repositories in each of your appliance's organizations using the Enterprise Accounts API. To customize this query, replace `<enterprise-account-name>` with the slug of your Enterprise's instance slug.
|
||||
|
||||
{% if currentVersion != "github-ae@latest" %}
|
||||
|
||||
```graphql
|
||||
query publicRepositoriesByOrganization($slug: String!) {
|
||||
|
@ -127,8 +127,42 @@ variables {
|
|||
}
|
||||
```
|
||||
|
||||
The next GraphQL query example shows how challenging it is to retrieve the number of `public` repositories in each organization without using the Enterprise Account API. Notice that the GraphQL Enterprise Accounts API has made this task simpler for enterprises since you only need to customize a single variable. To customize this query, replace `<name-of-organization-one>` and `<name-of-organization-one>`, etc. with the organization names on your instance.
|
||||
{% else %}
|
||||
|
||||
```graphql
|
||||
query privateRepositoriesByOrganization($slug: String!) {
|
||||
enterprise(slug: $slug) {
|
||||
...enterpriseFragment
|
||||
}
|
||||
}
|
||||
|
||||
fragment enterpriseFragment on Enterprise {
|
||||
... on Enterprise{
|
||||
name
|
||||
organizations(first: 100){
|
||||
nodes{
|
||||
name
|
||||
... on Organization{
|
||||
name
|
||||
repositories(privacy: PRIVATE){
|
||||
totalCount
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
# Passing our Enterprise Account as a variable
|
||||
variables {
|
||||
"slug": "<enterprise-account-name>"
|
||||
}
|
||||
```
|
||||
{% endif %}
|
||||
|
||||
The next GraphQL query example shows how challenging it is to retrieve the number of {% if currentVersion != "github-ae@latest" %}`public`{% else %}`private`{% endif %} repositories in each organization without using the Enterprise Account API. Notice that the GraphQL Enterprise Accounts API has made this task simpler for enterprises since you only need to customize a single variable. To customize this query, replace `<name-of-organization-one>` and `<name-of-organization-two>`, etc. with the organization names on your instance.
|
||||
|
||||
{% if currentVersion != "github-ae@latest" %}
|
||||
```graphql
|
||||
# Each organization is queried separately
|
||||
{
|
||||
|
@ -150,9 +184,34 @@ fragment repositories on Organization {
|
|||
}
|
||||
}
|
||||
```
|
||||
{% else %}
|
||||
```graphql
|
||||
# Each organization is queried separately
|
||||
{
|
||||
organizationOneAlias: organization(login: "name-of-organization-one") {
|
||||
# How to use a fragment
|
||||
...repositories
|
||||
}
|
||||
organizationTwoAlias: organization(login: "name-of-organization-two") {
|
||||
...repositories
|
||||
}
|
||||
# organizationThreeAlias ... and so on up-to lets say 100
|
||||
}
|
||||
|
||||
## How to define a fragment
|
||||
fragment repositories on Organization {
|
||||
name
|
||||
repositories(privacy: PRIVATE){
|
||||
totalCount
|
||||
}
|
||||
}
|
||||
```
|
||||
{% endif %}
|
||||
|
||||
### Query each organization separately
|
||||
|
||||
{% if currentVersion != "github-ae@latest" %}
|
||||
|
||||
```graphql
|
||||
query publicRepositoriesByOrganization {
|
||||
organizationOneAlias: organization(login: "<name-of-organization-one>") {
|
||||
|
@ -173,6 +232,30 @@ fragment repositories on Organization {
|
|||
}
|
||||
```
|
||||
|
||||
{% else %}
|
||||
|
||||
```graphql
|
||||
query privateRepositoriesByOrganization {
|
||||
organizationOneAlias: organization(login: "<name-of-organization-one>") {
|
||||
# How to use a fragment
|
||||
...repositories
|
||||
}
|
||||
organizationTwoAlias: organization(login: "<name-of-organization-two>") {
|
||||
...repositories
|
||||
}
|
||||
# organizationThreeAlias ... and so on up-to lets say 100
|
||||
}
|
||||
# How to define a fragment
|
||||
fragment repositories on Organization {
|
||||
name
|
||||
repositories(privacy: PRIVATE){
|
||||
totalCount
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
{% endif %}
|
||||
|
||||
This GraphQL query requests the last 5 log entries for an enterprise organization. To customize this query, replace `<org-name>` and `<user-name>`.
|
||||
|
||||
```graphql
|
||||
|
|
|
@ -57,13 +57,13 @@ If your instance has subdomain isolation enabled:
|
|||
<repository>
|
||||
<id>central</id>
|
||||
<url>https://repo1.maven.org/maven2</url>
|
||||
<releases><enabled>true</enabled></releases>
|
||||
<snapshots><enabled>true</enabled></snapshots>
|
||||
</repository>
|
||||
<repository>
|
||||
<id>github</id>
|
||||
<name>GitHub OWNER Apache Maven Packages</name>
|
||||
<url>https://{% if currentVersion == "free-pro-team@latest" %}maven.pkg.github.com{% else %}maven.HOSTNAME{% endif %}/OWNER/REPOSITORY</url>
|
||||
<url>https://{% if currentVersion == "free-pro-team@latest" %}maven.pkg.github.com{% else %}maven.HOSTNAME{% endif %}/OWNER/*</url>
|
||||
<snapshots>
|
||||
<enabled>true</enabled>
|
||||
</snapshots>
|
||||
</repository>
|
||||
</repositories>
|
||||
</profile>
|
||||
|
@ -99,13 +99,13 @@ If your instance has subdomain isolation disabled:
|
|||
<repository>
|
||||
<id>central</id>
|
||||
<url>https://repo1.maven.org/maven2</url>
|
||||
<releases><enabled>true</enabled></releases>
|
||||
<snapshots><enabled>true</enabled></snapshots>
|
||||
</repository>
|
||||
<repository>
|
||||
<id>github</id>
|
||||
<name>GitHub OWNER Apache Maven Packages</name>
|
||||
<url>https://HOSTNAME/_registry/maven/OWNER/REPOSITORY</url>
|
||||
<url>https://maven.pkg.github.com/OWNER/*</url>
|
||||
<snapshots>
|
||||
<enabled>true</enabled>
|
||||
</snapshots>
|
||||
</repository>
|
||||
</repositories>
|
||||
</profile>
|
||||
|
|
|
@ -22,7 +22,7 @@ If you haven't already, you should read the ["Basics of Authentication"][basics-
|
|||
|
||||
### Discover the repositories that your app can access for a user
|
||||
|
||||
In addition to having their own personal repositories, a user may be a collaborator on repositories owned by other users and organizations. Collectively, these are the repositories where the user has privileged access: either it's a private repository where the user has read or write access, or it's a public repository where the user has write access.
|
||||
In addition to having their own personal repositories, a user may be a collaborator on repositories owned by other users and organizations. Collectively, these are the repositories where the user has privileged access: either it's a private repository where the user has read or write access, or it's a {% if currentVersion != "github-ae@latest" %}public{% else %}internal{% endif %} repository where the user has write access.
|
||||
|
||||
[OAuth scopes][scopes] and [organization application policies][oap] determine which of those repositories your app can access for a user. Use the workflow below to discover those repositories.
|
||||
|
||||
|
@ -87,11 +87,11 @@ client.organizations.each do |organization|
|
|||
end
|
||||
```
|
||||
|
||||
#### Don’t rely on public organizations
|
||||
#### Return all of the user's organization memberships
|
||||
|
||||
If you've read the docs from cover to cover, you may have noticed an [API method for listing a user's public organization memberships][list-public-orgs]. Most applications should avoid this API method. This method only returns the user's public organization memberships, not their private organization memberships.
|
||||
|
||||
As an application, you typically want all of the user's organizations (public and private) that your app is authorized to access. The workflow above will give you exactly that.
|
||||
As an application, you typically want all of the user's organizations that your app is authorized to access. The workflow above will give you exactly that.
|
||||
|
||||
[basics-of-authentication]: /rest/guides/basics-of-authentication
|
||||
[list-public-orgs]: /rest/reference/orgs#list-organizations-for-a-user
|
||||
|
|
|
@ -155,9 +155,7 @@ $ curl -i -u <em>your_username</em>:<em>your_token</em> {% data variables.produc
|
|||
```
|
||||
|
||||
This time, in addition to the same set of public information we
|
||||
retrieved for [@defunkt][defunkt github] earlier, you should also see the non-public
|
||||
information for your user profile. For example, you'll see a `plan` object
|
||||
in the response which gives details about the {% data variables.product.product_name %} plan for the account.
|
||||
retrieved for [@defunkt][defunkt github] earlier, you should also see the non-public information for your user profile. For example, you'll see a `plan` object in the response which gives details about the {% data variables.product.product_name %} plan for the account.
|
||||
|
||||
#### Using OAuth tokens for apps
|
||||
|
||||
|
@ -215,8 +213,9 @@ $ curl -i {% data variables.product.api_url_pre %}/orgs/octo-org/repos
|
|||
|
||||
The information returned from these calls will depend on which scopes our token has when we authenticate:
|
||||
|
||||
* A token with `public_repo` [scope][scopes] returns a response that includes all public repositories we have access to see on github.com.
|
||||
* A token with `repo` [scope][scopes] returns a response that includes all public and private repositories we have access to see on github.com.
|
||||
{% if currentVersion != "github-ae@latest" %}
|
||||
* A token with `public_repo` [scope][scopes] returns a response that includes all public repositories we have access to see on github.com.{% endif %}
|
||||
* A token with `repo` [scope][scopes] returns a response that includes all {% if currentVersion != "github-ae@latest" %}public{% else %}internal{% endif %} and private repositories we have access to see on {% data variables.product.product_location %}.
|
||||
|
||||
As the [docs][repos-api] indicate, these methods take a `type` parameter that
|
||||
can filter the repositories returned based on what type of access the user has
|
||||
|
@ -249,10 +248,8 @@ $ curl -i -H "Authorization: token 5199831f4dd3b79e7c5b7e0ebe75d67aa66e79d4" \
|
|||
{% data variables.product.api_url_pre %}/user/repos
|
||||
```
|
||||
|
||||
In this minimal example, we create a new repository for our blog (to be served
|
||||
on [GitHub Pages][pages], perhaps). Though the blog will be public, we've made
|
||||
the repository private. In this single step, we'll also initialize it with
|
||||
a README and a [nanoc][nanoc]-flavored [.gitignore template][gitignore templates].
|
||||
In this minimal example, we create a new private repository for our blog (to be served
|
||||
on [GitHub Pages][pages], perhaps). Though the blog {% if currentVersion != "github-ae@latest" %}will be public{% else %}is accessible to all enterprise members{% endif %}, we've made the repository private. In this single step, we'll also initialize it with a README and a [nanoc][nanoc]-flavored [.gitignore template][gitignore templates].
|
||||
|
||||
The resulting repository will be found at `https://github.com/<your_username>/blog`.
|
||||
To create a repository under an organization for which you're
|
||||
|
|
|
@ -360,6 +360,8 @@ For users that belong to a {% data variables.product.prodname_ghe_cloud %} accou
|
|||
|
||||
{% endif %}
|
||||
|
||||
When using the built-in `GITHUB_TOKEN` in GitHub Actions, the rate limit is 1,000 requests per hour per repository. For organizations that belong to a GitHub Enterprise Cloud account, this limit is 15,000 requests per hour per repository.
|
||||
|
||||
For unauthenticated requests, the rate limit allows for up to 60 requests per hour. Unauthenticated requests are associated with the originating IP address, and not the user making requests.
|
||||
|
||||
{% data reusables.enterprise.rate_limit %}
|
||||
|
|
|
@ -140,7 +140,8 @@ Below is a simple sequence diagram for how these interactions would work.
|
|||
|
||||
Keep in mind that GitHub is never actually accessing your servers. It's up to your third-party integration to interact with deployment events. Multiple systems can listen for deployment events, and it's up to each of those systems to decide whether they're responsible for pushing the code out to your servers, building native code, etc.
|
||||
|
||||
Note that the `repo_deployment` [OAuth scope](/developers/apps/scopes-for-oauth-apps) grants targeted access to deployments and deployment statuses **without** granting access to repository code, while the `public_repo` and `repo` scopes grant permission to code as well.
|
||||
Note that the `repo_deployment` [OAuth scope](/developers/apps/scopes-for-oauth-apps) grants targeted access to deployments and deployment statuses **without** granting access to repository code, while the {% if currentVersion != "github-ae@latest" %}`public_repo` and{% endif %}`repo` scopes grant permission to code as well.
|
||||
|
||||
|
||||
### Inactive deployments
|
||||
|
||||
|
@ -197,7 +198,7 @@ The authenticated user will be the author of any merges done through this endpoi
|
|||
|
||||
## Pages
|
||||
|
||||
The {% data variables.product.prodname_pages %} API retrieves information about your {% data variables.product.prodname_pages %} configuration, and the statuses of your builds. Information about the site and the builds can only be accessed by authenticated owners, even though the websites are public. For more information, see "[About {% data variables.product.prodname_pages %}](/github/working-with-github-pages/about-github-pages)."
|
||||
The {% data variables.product.prodname_pages %} API retrieves information about your {% data variables.product.prodname_pages %} configuration, and the statuses of your builds. Information about the site and the builds can only be accessed by authenticated owners{% if currentVersion != "github-ae@latest" %}, even if the websites are public{% endif %}. For more information, see "[About {% data variables.product.prodname_pages %}](/github/working-with-github-pages/about-github-pages)."
|
||||
|
||||
In {% data variables.product.prodname_pages %} API endpoints with a `status` key in their response, the value can be one of:
|
||||
* `null`: The site has yet to be built.
|
||||
|
|
|
@ -3,7 +3,7 @@ sections:
|
|||
security_fixes:
|
||||
- '**HIGH:** An improper access control vulnerability was identified in GitHub Enterprise Server that allowed authenticated users of the instance to gain write access to unauthorized repositories via specifically crafted pull requests and REST API requests. An attacker would need to be able to fork the targeted repository, a setting that is disabled by default for organization owned private repositories. Branch protections such as required pull request reviews or status checks would prevent unauthorized commits from being merged without further review or validation. This vulnerability has been assigned CVE-2021-22861. This issue was reported via the [GitHub Bug Bounty Program](https://bounty.github.com).'
|
||||
- '**HIGH:** An improper access control vulnerability was identified in the GitHub Enterprise Server GraphQL API that allowed authenticated users of the instance to modify the maintainer collaboration permission of a pull request without proper authorization. By exploiting this vulnerability, an attacker would be able to gain access to head branches of pull requests opened on repositories of which they are a maintainer. Forking is disabled by default for organization owned private repositories and would prevent this vulnerability. Additionally, branch protections such as required pull request reviews or status checks would prevent unauthorized commits from being merged without further review or validation. This vulnerability has been assigned CVE-2021-22863. This issue was reported via the [GitHub Bug Bounty Program](https://bounty.github.com).'
|
||||
- '**HIGH:** A remote code execution vulnerability was identified in GitHub Enterprise Server that could be exploited when building a GitHub Pages site. User-controlled configuration of the underlying parsers used by GitHub Pages were not sufficiently restricted and made it possible to execute commands on the GitHub Enterprise Server instance. To exploit this vulnerability, an attacker would need permission to create and build a GitHub Pages site on the GitHub Enterprise Server instance. This vulnerability has been assigned CVE-2020-10519.'
|
||||
- '**HIGH:** A remote code execution vulnerability was identified in GitHub Enterprise Server that could be exploited when building a GitHub Pages site. User-controlled configuration of the underlying parsers used by GitHub Pages were not sufficiently restricted and made it possible to execute commands on the GitHub Enterprise Server instance. To exploit this vulnerability, an attacker would need permission to create and build a GitHub Pages site on the GitHub Enterprise Server instance. This vulnerability has been assigned CVE-2020-10519 and was reported via the [GitHub Bug Bounty Program](https://bounty.github.com).'
|
||||
- '**LOW:** A specially crafted request to the SVN bridge could trigger a long wait before failure resulting in Denial of Service (DoS).'
|
||||
- 'Packages have been updated to the latest security versions.'
|
||||
bugs:
|
||||
|
|
|
@ -3,7 +3,7 @@ sections:
|
|||
security_fixes:
|
||||
- '**HIGH:** An improper access control vulnerability was identified in GitHub Enterprise Server that allowed authenticated users of the instance to gain write access to unauthorized repositories via specifically crafted pull requests and REST API requests. An attacker would need to be able to fork the targeted repository, a setting that is disabled by default for organization owned private repositories. Branch protections such as required pull request reviews or status checks would prevent unauthorized commits from being merged without further review or validation. This vulnerability has been assigned CVE-2021-22861. This issue was reported via the [GitHub Bug Bounty Program](https://bounty.github.com).'
|
||||
- '**HIGH:** An improper access control vulnerability was identified in the GitHub Enterprise Server GraphQL API that allowed authenticated users of the instance to modify the maintainer collaboration permission of a pull request without proper authorization. By exploiting this vulnerability, an attacker would be able to gain access to head branches of pull requests opened on repositories of which they are a maintainer. Forking is disabled by default for organization owned private repositories and would prevent this vulnerability. Additionally, branch protections such as required pull request reviews or status checks would prevent unauthorized commits from being merged without further review or validation. This vulnerability has been assigned CVE-2021-22863. This issue was reported via the [GitHub Bug Bounty Program](https://bounty.github.com).'
|
||||
- '**HIGH:** A remote code execution vulnerability was identified in GitHub Enterprise Server that could be exploited when building a GitHub Pages site. User-controlled configuration of the underlying parsers used by GitHub Pages were not sufficiently restricted and made it possible to execute commands on the GitHub Enterprise Server instance. To exploit this vulnerability, an attacker would need permission to create and build a GitHub Pages site on the GitHub Enterprise Server instance. This vulnerability has been assigned CVE-2020-10519.'
|
||||
- '**HIGH:** A remote code execution vulnerability was identified in GitHub Enterprise Server that could be exploited when building a GitHub Pages site. User-controlled configuration of the underlying parsers used by GitHub Pages were not sufficiently restricted and made it possible to execute commands on the GitHub Enterprise Server instance. To exploit this vulnerability, an attacker would need permission to create and build a GitHub Pages site on the GitHub Enterprise Server instance. This vulnerability has been assigned CVE-2020-10519 and was reported via the [GitHub Bug Bounty Program](https://bounty.github.com).'
|
||||
- '**MEDIUM:** GitHub Tokens from GitHub Pages builds could end up in logs.'
|
||||
- '**LOW:** A specially crafted request to the SVN bridge could trigger a long wait before failure resulting in Denial of Service (DoS).'
|
||||
- 'Packages have been updated to the latest security versions.'
|
||||
|
|
|
@ -3,7 +3,7 @@ sections:
|
|||
security_fixes:
|
||||
- '**HIGH:** An improper access control vulnerability was identified in GitHub Enterprise Server that allowed authenticated users of the instance to gain write access to unauthorized repositories via specifically crafted pull requests and REST API requests. An attacker would need to be able to fork the targeted repository, a setting that is disabled by default for organization owned private repositories. Branch protections such as required pull request reviews or status checks would prevent unauthorized commits from being merged without further review or validation. This vulnerability has been assigned CVE-2021-22861. This issue was reported via the [GitHub Bug Bounty Program](https://bounty.github.com).'
|
||||
- '**HIGH:** An improper access control vulnerability was identified in the GitHub Enterprise Server GraphQL API that allowed authenticated users of the instance to modify the maintainer collaboration permission of a pull request without proper authorization. By exploiting this vulnerability, an attacker would be able to gain access to head branches of pull requests opened on repositories of which they are a maintainer. Forking is disabled by default for organization owned private repositories and would prevent this vulnerability. Additionally, branch protections such as required pull request reviews or status checks would prevent unauthorized commits from being merged without further review or validation. This vulnerability has been assigned CVE-2021-22863. This issue was reported via the [GitHub Bug Bounty Program](https://bounty.github.com).'
|
||||
- '**HIGH:** A remote code execution vulnerability was identified in GitHub Enterprise Server that could be exploited when building a GitHub Pages site. User-controlled configuration of the underlying parsers used by GitHub Pages were not sufficiently restricted and made it possible to execute commands on the GitHub Enterprise Server instance. To exploit this vulnerability, an attacker would need permission to create and build a GitHub Pages site on the GitHub Enterprise Server instance. This vulnerability has been assigned CVE-2020-10519.'
|
||||
- '**HIGH:** A remote code execution vulnerability was identified in GitHub Enterprise Server that could be exploited when building a GitHub Pages site. User-controlled configuration of the underlying parsers used by GitHub Pages were not sufficiently restricted and made it possible to execute commands on the GitHub Enterprise Server instance. To exploit this vulnerability, an attacker would need permission to create and build a GitHub Pages site on the GitHub Enterprise Server instance. This vulnerability has been assigned CVE-2020-10519 and was reported via the [GitHub Bug Bounty Program](https://bounty.github.com).'
|
||||
- '**MEDIUM:** GitHub Tokens from GitHub Pages builds could end up in logs.'
|
||||
- '**LOW:** A specially crafted request to the SVN bridge could trigger a long wait before failure resulting in Denial of Service (DoS).'
|
||||
- 'Packages have been updated to the latest security versions.'
|
||||
|
|
|
@ -23,7 +23,6 @@ sections:
|
|||
- 'Fixes users being shown the option to set up the Code Scanning CodeQL Action even if Actions was not enabled for their repository.'
|
||||
- 'The "Prevent repository admins from changing anonymous Git read access" checkbox available in the enterprise account settings could not be successfully enabled or disabled.'
|
||||
- 'The modal used to display a mandatory message contained no vertical scrollbar, meaning longer messages could not be viewed in full.'
|
||||
- 'Users could dismiss a mandatory message without checking all checkboxes.'
|
||||
- 'Redis would sometimes fail to start after a hard reboot or application crash.'
|
||||
changes:
|
||||
- 'Satisfy requests concurrently when multiple users are downloading the same archive, resulting in improved performance.'
|
||||
|
@ -34,3 +33,4 @@ sections:
|
|||
- 'Issues cannot be closed if they contain a permalink to a blob in the same repository where the file path is longer than 255 characters.'
|
||||
- 'When "Users can search GitHub.com" is enabled with GitHub Connect, issues in private and internal repositories are not included in GitHub.com search results.'
|
||||
- 'When maintenance mode is enabled, some services continue to be listed as "active processes". The services identified are expected to run during maintenance mode. If you experience this issue and are unsure, contact [GitHub Enterprise Support](https://enterprise.githubsupport.com/hc/en-us) or [GitHub Premium Support](https://premium.githubsupport.com/).'
|
||||
- 'Users can dismiss a mandatory message without checking all checkboxes.'
|
||||
|
|
|
@ -1,5 +1,6 @@
|
|||
date: '2021-01-12'
|
||||
release_candidate: true
|
||||
deprecated: true
|
||||
intro: Release candidate versions should be tested on non-production environments. For more information about the Release Candidate Program, see the [GitHub Blog](https://github.blog/2020-12-03-improving-the-ghes-release-process-release-candidates/) or "[About upgrades to new releases](/admin/overview/about-upgrades-to-new-releases)".
|
||||
sections:
|
||||
bugs:
|
||||
|
|
|
@ -1,5 +1,6 @@
|
|||
date: '2021-01-29'
|
||||
release_candidate: true
|
||||
deprecated: true
|
||||
intro: Release candidate versions should be tested on non-production environments. For more information about the Release Candidate Program, see the [GitHub Blog](https://github.blog/2020-12-03-improving-the-ghes-release-process-release-candidates/) or "[About upgrades to new releases](/admin/overview/about-upgrades-to-new-releases)."
|
||||
sections:
|
||||
bugs:
|
||||
|
|
|
@ -121,6 +121,7 @@ sections:
|
|||
- When "Users can search GitHub.com" is enabled with GitHub Connect, issues in private and internal repositories are not included in GitHub.com search results.
|
||||
- When maintenance mode is enabled, some services continue to be listed as "active processes". The services identified are expected to run during maintenance mode. If you experience this issue and are unsure, contact {% data variables.contact.contact_ent_support %}.
|
||||
- When GitHub Actions is enabled, use '`ghe-maintenance -u`' to unset maintenance mode.
|
||||
- Users can dismiss a mandatory message without checking all checkboxes.
|
||||
|
||||
deprecations:
|
||||
- heading: Deprecation of GitHub Enterprise Server 2.19
|
||||
|
|
|
@ -1 +0,0 @@
|
|||
When you enable {% data variables.product.prodname_GH_advanced_security %}, {% data variables.product.prodname_dotcom %} shows how many extra committers this will add and prompts for confirmation. If you disable access to {% data variables.product.prodname_GH_advanced_security %}, you can see how many seats this will free before you confirm the change. This makes it easy to see the impact of your changes on the use of your license.
|
|
@ -1 +1 @@
|
|||
Each license for {% data variables.product.prodname_GH_advanced_security %} specifies a maximum number of committers whose work can use these features. A committer is someone who authored at least one commit that was pushed to the repository in the last 90 days. Each committer is counted once, no matter how many repositories they contribute to.
|
||||
Each license for {% data variables.product.prodname_GH_advanced_security %} specifies a maximum number of accounts, or seats, that can use these features. Each active committer to at least one repository with the feature enabled uses one seat. An active committer is someone who authored at least one commit that was pushed to the repository in the last 90 days.
|
||||
|
|
|
@ -1,7 +1,6 @@
|
|||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}
|
||||
{% note %}
|
||||
|
||||
**Note:** If you enable {% data variables.product.prodname_GH_advanced_security %}, committers to these repositories will use seats on your {% data variables.product.prodname_GH_advanced_security %} license. This option controls access to all {% data variables.product.prodname_advanced_security %} features including {% if currentVersion == "free-pro-team@latest" %}dependency review,{% endif %} {% data variables.product.prodname_code_scanning %}, and {% data variables.product.prodname_secret_scanning %}.
|
||||
|
||||
**Note:** If you enable {% data variables.product.prodname_GH_advanced_security %}, committers to these repositories will use seats on your {% data variables.product.prodname_GH_advanced_security %} license. This option is disabled if you have exceeded your license capacity. For more information, see "[About licensing for {% data variables.product.prodname_GH_advanced_security %}](/github/setting-up-and-managing-billing-and-payments-on-github/about-licensing-for-github-advanced-security)."
|
||||
{% endnote %}
|
||||
{% endif %}
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
{% note %}
|
||||
|
||||
**Note:** Team synchronization with Okta is currently in beta and subject to change.
|
||||
**Note:** Team synchronization with Okta is currently in beta and subject to change. Please contact your GitHub Sales account representative to register for the beta.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
|
|
|
@ -0,0 +1,2 @@
|
|||
1. In your organization's Settings sidebar, click **Billing & planning**.
|
||||
![Billing settings](/assets/images/help/billing/settings_organization_billing_planning_tab.png)
|
|
@ -1 +1 @@
|
|||
{% data variables.product.prodname_registry %} supports `SNAPSHOT` versions of Apache Maven. To use a repository for downloading this type of artifact, you must enable SNAPSHOTS in your *~/.m2/settings.xml* file.
|
||||
{% data variables.product.prodname_registry %} supports `SNAPSHOT` versions of Apache Maven. To use the {% data variables.product.prodname_registry %} repository for downloading `SNAPSHOT` artifacts, enable SNAPSHOTS in the POM of the consuming project or your *~/.m2/settings.xml* file.
|
||||
|
|
|
@ -29,7 +29,7 @@
|
|||
|
||||
<div class="markdown-body">
|
||||
{% for patch in releaseNotes %}
|
||||
<div class="js-release-notes-patch mb-10 bg-gray-light pb-6 border-bottom border-top" data-version="{{ patch.version }}">
|
||||
<div class="js-release-notes-patch mb-10 bg-gray-light pb-6 border-bottom border-top" data-version="{{ patch.version }}" id="{{ patch.version }}">
|
||||
<header class="container-xl position-sticky top-0 bg-gray-light border-bottom px-3 pt-4 pb-2 js-release-notes-patch-heading" data-version="{{ patch.version }}">
|
||||
<div class="d-flex flex-items-center">
|
||||
<h2 class="border-bottom-0 m-0 p-0">
|
||||
|
@ -54,7 +54,7 @@
|
|||
<p class="text-gray mt-1">{{ patch.date | date: "%B %d, %Y" }}</p>
|
||||
</header>
|
||||
|
||||
<div class="container-xl px-3" id="{{ patch.version }}">
|
||||
<div class="container-xl px-3">
|
||||
<div class="mt-3">{{ patch.intro }}</div>
|
||||
|
||||
{% for section in patch.sections %}
|
||||
|
|
|
@ -34,7 +34,7 @@
|
|||
<li class="lh-condensed mb-3"><a href="https://github.community" class="link-gray">{% data ui.footer.support.links.community_forum %}</a></li>
|
||||
<li class="lh-condensed mb-3"><a href="https://services.github.com/" class="link-gray">{% data ui.footer.support.links.training %}</a></li>
|
||||
<li class="lh-condensed mb-3"><a href="https://www.githubstatus.com/" class="link-gray">{% data ui.footer.support.links.status %}</a></li>
|
||||
<li class="lh-condensed mb-3"><a href="https://support.github.com/contact" class="link-gray">{% data ui.footer.support.links.contact_github %}</a></li>
|
||||
<li class="lh-condensed mb-3"><a href="https://support.github.com/" class="link-gray">{% data ui.footer.support.links.contact_github %}</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="col-6 col-sm-3 col-lg-2 mb-6 mb-md-2 pr-3 pr-md-0 pl-md-4">
|
||||
|
|
|
@ -11,7 +11,7 @@
|
|||
|
||||
<div class="markdown-body">
|
||||
{% for patch in releaseNotes %}
|
||||
<div class="js-release-notes-patch mb-10 bg-gray-light pb-6 border-bottom border-top" data-version="{{ patch.version }}">
|
||||
<div class="js-release-notes-patch mb-10 bg-gray-light pb-6 border-bottom border-top" data-version="{{ patch.version }}" id="{{ patch.version }}">
|
||||
<header class="container-xl position-sticky top-0 bg-gray-light border-bottom px-3 pt-4 pb-2 js-release-notes-patch-heading" data-version="{{ patch.version }}">
|
||||
<div class="d-flex flex-items-center">
|
||||
<h2 class="border-bottom-0 m-0 p-0">
|
||||
|
@ -30,7 +30,7 @@
|
|||
<p class="text-gray mt-1">{{ patch.date | date: "%B %d, %Y" }}</p>
|
||||
</header>
|
||||
|
||||
<div class="container-xl px-3" id="{{ patch.version }}">
|
||||
<div class="container-xl px-3">
|
||||
<div class="mt-3">{{ patch.intro }}</div>
|
||||
|
||||
{% for section in patch.sections %}
|
||||
|
|
|
@ -37,6 +37,10 @@ module.exports = {
|
|||
type: 'boolean',
|
||||
default: false
|
||||
},
|
||||
deprecated: {
|
||||
type: 'boolean',
|
||||
default: false
|
||||
},
|
||||
sections: {
|
||||
required: true,
|
||||
type: 'object',
|
||||
|
|
|
@ -15,6 +15,8 @@ function sortPatchKeys (release, version, options = {}) {
|
|||
...release[key]
|
||||
}
|
||||
})
|
||||
// Filter out any deprecated patches
|
||||
.filter(key => !key.deprecated)
|
||||
|
||||
// Versions with numbered releases like GHES 2.22, 3.0, etc. need additional semver sorting;
|
||||
// Versions with date releases do not.
|
||||
|
|
|
@ -77181,7 +77181,7 @@
|
|||
},
|
||||
{
|
||||
"name": "type",
|
||||
"description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.",
|
||||
"description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
|
@ -79003,7 +79003,7 @@
|
|||
},
|
||||
"post": {
|
||||
"summary": "Create an organization repository",
|
||||
"description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository",
|
||||
"description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
|
@ -79042,12 +79042,12 @@
|
|||
},
|
||||
"private": {
|
||||
"type": "boolean",
|
||||
"description": "Either `true` to create a private repository or `false` to create a public one.",
|
||||
"description": "Whether the repository is private.",
|
||||
"default": false
|
||||
},
|
||||
"visibility": {
|
||||
"type": "string",
|
||||
"description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.",
|
||||
"description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.",
|
||||
"enum": [
|
||||
"public",
|
||||
"private",
|
||||
|
@ -273638,7 +273638,7 @@
|
|||
"/repos/{template_owner}/{template_repo}/generate": {
|
||||
"post": {
|
||||
"summary": "Create a repository using a template",
|
||||
"description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository",
|
||||
"description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
|
@ -274824,7 +274824,7 @@
|
|||
"/repositories": {
|
||||
"get": {
|
||||
"summary": "List public repositories",
|
||||
"description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.",
|
||||
"description": "Lists all public repositories in the order that they were created.\n\nNotes:\n- For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
|
@ -325542,7 +325542,7 @@
|
|||
"parameters": [
|
||||
{
|
||||
"name": "visibility",
|
||||
"description": "Can be one of `all`, `public`, or `private`.",
|
||||
"description": "Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`.",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
|
@ -325567,7 +325567,7 @@
|
|||
},
|
||||
{
|
||||
"name": "type",
|
||||
"description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.",
|
||||
"description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
|
@ -326875,7 +326875,7 @@
|
|||
},
|
||||
"post": {
|
||||
"summary": "Create a repository for the authenticated user",
|
||||
"description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository",
|
||||
"description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository.",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
|
@ -326906,7 +326906,7 @@
|
|||
"type": "string"
|
||||
},
|
||||
"private": {
|
||||
"description": "Whether the repository is private or public.",
|
||||
"description": "Whether the repository is private.",
|
||||
"default": false,
|
||||
"type": "boolean"
|
||||
},
|
||||
|
@ -355080,7 +355080,7 @@
|
|||
"/users/{username}/repos": {
|
||||
"get": {
|
||||
"summary": "List repositories for a user",
|
||||
"description": "Lists public repositories for the specified user.",
|
||||
"description": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
|
|
|
@ -49563,7 +49563,7 @@
|
|||
},
|
||||
{
|
||||
"name": "type",
|
||||
"description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.",
|
||||
"description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
|
@ -51251,7 +51251,7 @@
|
|||
},
|
||||
"post": {
|
||||
"summary": "Create an organization repository",
|
||||
"description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository",
|
||||
"description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
|
@ -51290,12 +51290,12 @@
|
|||
},
|
||||
"private": {
|
||||
"type": "boolean",
|
||||
"description": "Either `true` to create a private repository or `false` to create a public one.",
|
||||
"description": "Whether the repository is private.",
|
||||
"default": false
|
||||
},
|
||||
"visibility": {
|
||||
"type": "string",
|
||||
"description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.",
|
||||
"description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.",
|
||||
"enum": [
|
||||
"public",
|
||||
"private",
|
||||
|
@ -201460,7 +201460,7 @@
|
|||
"/repos/{template_owner}/{template_repo}/generate": {
|
||||
"post": {
|
||||
"summary": "Create a repository using a template",
|
||||
"description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository",
|
||||
"description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
|
@ -202631,7 +202631,7 @@
|
|||
"/repositories": {
|
||||
"get": {
|
||||
"summary": "List public repositories",
|
||||
"description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.",
|
||||
"description": "Lists all public repositories in the order that they were created.\n\nNotes:\n- For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
|
@ -202652,7 +202652,7 @@
|
|||
},
|
||||
{
|
||||
"name": "visibility",
|
||||
"description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`.",
|
||||
"description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
|
@ -239678,7 +239678,7 @@
|
|||
"parameters": [
|
||||
{
|
||||
"name": "visibility",
|
||||
"description": "Can be one of `all`, `public`, or `private`.",
|
||||
"description": "Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`.",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
|
@ -239703,7 +239703,7 @@
|
|||
},
|
||||
{
|
||||
"name": "type",
|
||||
"description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.",
|
||||
"description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
|
@ -240981,7 +240981,7 @@
|
|||
},
|
||||
"post": {
|
||||
"summary": "Create a repository for the authenticated user",
|
||||
"description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository",
|
||||
"description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository.",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
|
@ -241012,7 +241012,7 @@
|
|||
"type": "string"
|
||||
},
|
||||
"private": {
|
||||
"description": "Whether the repository is private or public.",
|
||||
"description": "Whether the repository is private.",
|
||||
"default": false,
|
||||
"type": "boolean"
|
||||
},
|
||||
|
@ -266447,7 +266447,7 @@
|
|||
"/users/{username}/repos": {
|
||||
"get": {
|
||||
"summary": "List repositories for a user",
|
||||
"description": "Lists public repositories for the specified user.",
|
||||
"description": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
|
|
|
@ -50206,7 +50206,7 @@
|
|||
},
|
||||
{
|
||||
"name": "type",
|
||||
"description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.",
|
||||
"description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
|
@ -51894,7 +51894,7 @@
|
|||
},
|
||||
"post": {
|
||||
"summary": "Create an organization repository",
|
||||
"description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository",
|
||||
"description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
|
@ -51933,12 +51933,12 @@
|
|||
},
|
||||
"private": {
|
||||
"type": "boolean",
|
||||
"description": "Either `true` to create a private repository or `false` to create a public one.",
|
||||
"description": "Whether the repository is private.",
|
||||
"default": false
|
||||
},
|
||||
"visibility": {
|
||||
"type": "string",
|
||||
"description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.",
|
||||
"description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.",
|
||||
"enum": [
|
||||
"public",
|
||||
"private",
|
||||
|
@ -204884,7 +204884,7 @@
|
|||
"/repos/{template_owner}/{template_repo}/generate": {
|
||||
"post": {
|
||||
"summary": "Create a repository using a template",
|
||||
"description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository",
|
||||
"description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
|
@ -206055,7 +206055,7 @@
|
|||
"/repositories": {
|
||||
"get": {
|
||||
"summary": "List public repositories",
|
||||
"description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.",
|
||||
"description": "Lists all public repositories in the order that they were created.\n\nNotes:\n- For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
|
@ -206076,7 +206076,7 @@
|
|||
},
|
||||
{
|
||||
"name": "visibility",
|
||||
"description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`.",
|
||||
"description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
|
@ -242932,7 +242932,7 @@
|
|||
"parameters": [
|
||||
{
|
||||
"name": "visibility",
|
||||
"description": "Can be one of `all`, `public`, or `private`.",
|
||||
"description": "Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`.",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
|
@ -242957,7 +242957,7 @@
|
|||
},
|
||||
{
|
||||
"name": "type",
|
||||
"description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.",
|
||||
"description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
|
@ -244235,7 +244235,7 @@
|
|||
},
|
||||
"post": {
|
||||
"summary": "Create a repository for the authenticated user",
|
||||
"description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository",
|
||||
"description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository.",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
|
@ -244266,7 +244266,7 @@
|
|||
"type": "string"
|
||||
},
|
||||
"private": {
|
||||
"description": "Whether the repository is private or public.",
|
||||
"description": "Whether the repository is private.",
|
||||
"default": false,
|
||||
"type": "boolean"
|
||||
},
|
||||
|
@ -269751,7 +269751,7 @@
|
|||
"/users/{username}/repos": {
|
||||
"get": {
|
||||
"summary": "List repositories for a user",
|
||||
"description": "Lists public repositories for the specified user.",
|
||||
"description": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
|
|
|
@ -53243,7 +53243,7 @@
|
|||
},
|
||||
{
|
||||
"name": "type",
|
||||
"description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.",
|
||||
"description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
|
@ -54943,7 +54943,7 @@
|
|||
},
|
||||
"post": {
|
||||
"summary": "Create an organization repository",
|
||||
"description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.20/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository",
|
||||
"description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.20/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
|
@ -54982,12 +54982,12 @@
|
|||
},
|
||||
"private": {
|
||||
"type": "boolean",
|
||||
"description": "Either `true` to create a private repository or `false` to create a public one.",
|
||||
"description": "Whether the repository is private.",
|
||||
"default": false
|
||||
},
|
||||
"visibility": {
|
||||
"type": "string",
|
||||
"description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.",
|
||||
"description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.",
|
||||
"enum": [
|
||||
"public",
|
||||
"private",
|
||||
|
@ -207882,7 +207882,7 @@
|
|||
"/repos/{template_owner}/{template_repo}/generate": {
|
||||
"post": {
|
||||
"summary": "Create a repository using a template",
|
||||
"description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.20/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.20/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository",
|
||||
"description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.20/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.20/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
|
@ -209062,7 +209062,7 @@
|
|||
"/repositories": {
|
||||
"get": {
|
||||
"summary": "List public repositories",
|
||||
"description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.",
|
||||
"description": "Lists all public repositories in the order that they were created.\n\nNotes:\n- For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
|
@ -209083,7 +209083,7 @@
|
|||
},
|
||||
{
|
||||
"name": "visibility",
|
||||
"description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`.",
|
||||
"description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
|
@ -246010,7 +246010,7 @@
|
|||
"parameters": [
|
||||
{
|
||||
"name": "visibility",
|
||||
"description": "Can be one of `all`, `public`, or `private`.",
|
||||
"description": "Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`.",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
|
@ -246035,7 +246035,7 @@
|
|||
},
|
||||
{
|
||||
"name": "type",
|
||||
"description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.",
|
||||
"description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
|
@ -247322,7 +247322,7 @@
|
|||
},
|
||||
"post": {
|
||||
"summary": "Create a repository for the authenticated user",
|
||||
"description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.20/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository",
|
||||
"description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.20/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository.",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
|
@ -247353,7 +247353,7 @@
|
|||
"type": "string"
|
||||
},
|
||||
"private": {
|
||||
"description": "Whether the repository is private or public.",
|
||||
"description": "Whether the repository is private.",
|
||||
"default": false,
|
||||
"type": "boolean"
|
||||
},
|
||||
|
@ -272940,7 +272940,7 @@
|
|||
"/users/{username}/repos": {
|
||||
"get": {
|
||||
"summary": "List repositories for a user",
|
||||
"description": "Lists public repositories for the specified user.",
|
||||
"description": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
|
|
|
@ -53329,7 +53329,7 @@
|
|||
},
|
||||
{
|
||||
"name": "type",
|
||||
"description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.",
|
||||
"description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
|
@ -55042,7 +55042,7 @@
|
|||
},
|
||||
"post": {
|
||||
"summary": "Create an organization repository",
|
||||
"description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository",
|
||||
"description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
|
@ -55081,12 +55081,12 @@
|
|||
},
|
||||
"private": {
|
||||
"type": "boolean",
|
||||
"description": "Either `true` to create a private repository or `false` to create a public one.",
|
||||
"description": "Whether the repository is private.",
|
||||
"default": false
|
||||
},
|
||||
"visibility": {
|
||||
"type": "string",
|
||||
"description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.",
|
||||
"description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.",
|
||||
"enum": [
|
||||
"public",
|
||||
"private",
|
||||
|
@ -219501,7 +219501,7 @@
|
|||
"/repos/{template_owner}/{template_repo}/generate": {
|
||||
"post": {
|
||||
"summary": "Create a repository using a template",
|
||||
"description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.21/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository",
|
||||
"description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.21/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
|
@ -220690,7 +220690,7 @@
|
|||
"/repositories": {
|
||||
"get": {
|
||||
"summary": "List public repositories",
|
||||
"description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.",
|
||||
"description": "Lists all public repositories in the order that they were created.\n\nNotes:\n- For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
|
@ -220711,7 +220711,7 @@
|
|||
},
|
||||
{
|
||||
"name": "visibility",
|
||||
"description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`.",
|
||||
"description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
|
@ -255009,7 +255009,7 @@
|
|||
"parameters": [
|
||||
{
|
||||
"name": "visibility",
|
||||
"description": "Can be one of `all`, `public`, or `private`.",
|
||||
"description": "Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`.",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
|
@ -255034,7 +255034,7 @@
|
|||
},
|
||||
{
|
||||
"name": "type",
|
||||
"description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.",
|
||||
"description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
|
@ -256331,7 +256331,7 @@
|
|||
},
|
||||
"post": {
|
||||
"summary": "Create a repository for the authenticated user",
|
||||
"description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository",
|
||||
"description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository.",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
|
@ -256362,7 +256362,7 @@
|
|||
"type": "string"
|
||||
},
|
||||
"private": {
|
||||
"description": "Whether the repository is private or public.",
|
||||
"description": "Whether the repository is private.",
|
||||
"default": false,
|
||||
"type": "boolean"
|
||||
},
|
||||
|
@ -282049,7 +282049,7 @@
|
|||
"/users/{username}/repos": {
|
||||
"get": {
|
||||
"summary": "List repositories for a user",
|
||||
"description": "Lists public repositories for the specified user.",
|
||||
"description": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
|
|
|
@ -64172,7 +64172,7 @@
|
|||
},
|
||||
{
|
||||
"name": "type",
|
||||
"description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.",
|
||||
"description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
|
@ -65994,7 +65994,7 @@
|
|||
},
|
||||
"post": {
|
||||
"summary": "Create an organization repository",
|
||||
"description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository",
|
||||
"description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
|
@ -66033,12 +66033,12 @@
|
|||
},
|
||||
"private": {
|
||||
"type": "boolean",
|
||||
"description": "Either `true` to create a private repository or `false` to create a public one.",
|
||||
"description": "Whether the repository is private.",
|
||||
"default": false
|
||||
},
|
||||
"visibility": {
|
||||
"type": "string",
|
||||
"description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.",
|
||||
"description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.",
|
||||
"enum": [
|
||||
"public",
|
||||
"private",
|
||||
|
@ -248642,7 +248642,7 @@
|
|||
"/repos/{template_owner}/{template_repo}/generate": {
|
||||
"post": {
|
||||
"summary": "Create a repository using a template",
|
||||
"description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository",
|
||||
"description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
|
@ -249828,7 +249828,7 @@
|
|||
"/repositories": {
|
||||
"get": {
|
||||
"summary": "List public repositories",
|
||||
"description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.",
|
||||
"description": "Lists all public repositories in the order that they were created.\n\nNotes:\n- For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
|
@ -249849,7 +249849,7 @@
|
|||
},
|
||||
{
|
||||
"name": "visibility",
|
||||
"description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`.",
|
||||
"description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
|
@ -284265,7 +284265,7 @@
|
|||
"parameters": [
|
||||
{
|
||||
"name": "visibility",
|
||||
"description": "Can be one of `all`, `public`, or `private`.",
|
||||
"description": "Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`.",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
|
@ -284290,7 +284290,7 @@
|
|||
},
|
||||
{
|
||||
"name": "type",
|
||||
"description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.",
|
||||
"description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
|
@ -285598,7 +285598,7 @@
|
|||
},
|
||||
"post": {
|
||||
"summary": "Create a repository for the authenticated user",
|
||||
"description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository",
|
||||
"description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository.",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
|
@ -285629,7 +285629,7 @@
|
|||
"type": "string"
|
||||
},
|
||||
"private": {
|
||||
"description": "Whether the repository is private or public.",
|
||||
"description": "Whether the repository is private.",
|
||||
"default": false,
|
||||
"type": "boolean"
|
||||
},
|
||||
|
@ -311445,7 +311445,7 @@
|
|||
"/users/{username}/repos": {
|
||||
"get": {
|
||||
"summary": "List repositories for a user",
|
||||
"description": "Lists public repositories for the specified user.",
|
||||
"description": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
|
|
|
@ -68705,7 +68705,7 @@
|
|||
},
|
||||
{
|
||||
"name": "type",
|
||||
"description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.",
|
||||
"description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
|
@ -70527,7 +70527,7 @@
|
|||
},
|
||||
"post": {
|
||||
"summary": "Create an organization repository",
|
||||
"description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository",
|
||||
"description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
|
@ -70566,12 +70566,12 @@
|
|||
},
|
||||
"private": {
|
||||
"type": "boolean",
|
||||
"description": "Either `true` to create a private repository or `false` to create a public one.",
|
||||
"description": "Whether the repository is private.",
|
||||
"default": false
|
||||
},
|
||||
"visibility": {
|
||||
"type": "string",
|
||||
"description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.",
|
||||
"description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.",
|
||||
"enum": [
|
||||
"public",
|
||||
"private",
|
||||
|
@ -253971,7 +253971,7 @@
|
|||
"/repos/{template_owner}/{template_repo}/generate": {
|
||||
"post": {
|
||||
"summary": "Create a repository using a template",
|
||||
"description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository",
|
||||
"description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
|
@ -255157,7 +255157,7 @@
|
|||
"/repositories": {
|
||||
"get": {
|
||||
"summary": "List public repositories",
|
||||
"description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.",
|
||||
"description": "Lists all public repositories in the order that they were created.\n\nNotes:\n- For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
|
@ -255178,7 +255178,7 @@
|
|||
},
|
||||
{
|
||||
"name": "visibility",
|
||||
"description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`.",
|
||||
"description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
|
@ -289618,7 +289618,7 @@
|
|||
"parameters": [
|
||||
{
|
||||
"name": "visibility",
|
||||
"description": "Can be one of `all`, `public`, or `private`.",
|
||||
"description": "Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`.",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
|
@ -289643,7 +289643,7 @@
|
|||
},
|
||||
{
|
||||
"name": "type",
|
||||
"description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.",
|
||||
"description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
|
@ -290951,7 +290951,7 @@
|
|||
},
|
||||
"post": {
|
||||
"summary": "Create a repository for the authenticated user",
|
||||
"description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository",
|
||||
"description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository.",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
|
@ -290982,7 +290982,7 @@
|
|||
"type": "string"
|
||||
},
|
||||
"private": {
|
||||
"description": "Whether the repository is private or public.",
|
||||
"description": "Whether the repository is private.",
|
||||
"default": false,
|
||||
"type": "boolean"
|
||||
},
|
||||
|
@ -316817,7 +316817,7 @@
|
|||
"/users/{username}/repos": {
|
||||
"get": {
|
||||
"summary": "List repositories for a user",
|
||||
"description": "Lists public repositories for the specified user.",
|
||||
"description": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
|
|
|
@ -51991,7 +51991,7 @@
|
|||
},
|
||||
{
|
||||
"name": "type",
|
||||
"description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.",
|
||||
"description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
|
@ -53813,7 +53813,7 @@
|
|||
},
|
||||
"post": {
|
||||
"summary": "Create an organization repository",
|
||||
"description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository",
|
||||
"description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
|
@ -53852,12 +53852,12 @@
|
|||
},
|
||||
"private": {
|
||||
"type": "boolean",
|
||||
"description": "Either `true` to create a private repository or `false` to create a public one.",
|
||||
"description": "Whether the repository is private.",
|
||||
"default": false
|
||||
},
|
||||
"visibility": {
|
||||
"type": "string",
|
||||
"description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.",
|
||||
"description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.",
|
||||
"enum": [
|
||||
"public",
|
||||
"private",
|
||||
|
@ -239039,7 +239039,7 @@
|
|||
"/repos/{template_owner}/{template_repo}/generate": {
|
||||
"post": {
|
||||
"summary": "Create a repository using a template",
|
||||
"description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/github-ae@latest/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository",
|
||||
"description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/github-ae@latest/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
|
@ -240225,7 +240225,7 @@
|
|||
"/repositories": {
|
||||
"get": {
|
||||
"summary": "List public repositories",
|
||||
"description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.",
|
||||
"description": "Lists all public repositories in the order that they were created.\n\nNotes:\n- For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
|
@ -273064,7 +273064,7 @@
|
|||
"parameters": [
|
||||
{
|
||||
"name": "visibility",
|
||||
"description": "Can be one of `all`, `public`, or `private`.",
|
||||
"description": "Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`.",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
|
@ -273089,7 +273089,7 @@
|
|||
},
|
||||
{
|
||||
"name": "type",
|
||||
"description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.",
|
||||
"description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
|
@ -274397,7 +274397,7 @@
|
|||
},
|
||||
"post": {
|
||||
"summary": "Create a repository for the authenticated user",
|
||||
"description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository",
|
||||
"description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository.",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
|
@ -274428,7 +274428,7 @@
|
|||
"type": "string"
|
||||
},
|
||||
"private": {
|
||||
"description": "Whether the repository is private or public.",
|
||||
"description": "Whether the repository is private.",
|
||||
"default": false,
|
||||
"type": "boolean"
|
||||
},
|
||||
|
@ -300273,7 +300273,7 @@
|
|||
"/users/{username}/repos": {
|
||||
"get": {
|
||||
"summary": "List repositories for a user",
|
||||
"description": "Lists public repositories for the specified user.",
|
||||
"description": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
|
|