Merge branch 'main' into lucalves/spelling-fix
@@ -14,8 +14,8 @@ HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN I
|
|||||||
For questions, ask in Discussions: https://github.com/github/docs/discussions
|
For questions, ask in Discussions: https://github.com/github/docs/discussions
|
||||||
|
|
||||||
Before you file an issue read the:
|
Before you file an issue read the:
|
||||||
- Code of Conduct: https://github.com/github/docs/blob/onboarding/CODE_OF_CONDUCT.md
|
- Code of Conduct: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md
|
||||||
- Contributing guide: https://github.com/github/docs/blob/onboarding/CONTRIBUTING.md
|
- Contributing guide: https://github.com/github/docs/blob/main/CONTRIBUTING.md
|
||||||
|
|
||||||
Check to make sure someone hasn't already opened a similar issue: https://github.com/github/docs/issues
|
Check to make sure someone hasn't already opened a similar issue: https://github.com/github/docs/issues
|
||||||
-->
|
-->
|
||||||
|
|||||||
4
.github/ISSUE_TEMPLATE/improve-the-site.md
vendored
@@ -14,8 +14,8 @@ HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN I
|
|||||||
For questions, ask in Discussions: https://github.com/github/docs/discussions
|
For questions, ask in Discussions: https://github.com/github/docs/discussions
|
||||||
|
|
||||||
Before you file an issue read the:
|
Before you file an issue read the:
|
||||||
- Code of Conduct: https://github.com/github/docs/blob/onboarding/CODE_OF_CONDUCT.md
|
- Code of Conduct: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md
|
||||||
- Contributing guide: https://github.com/github/docs/blob/onboarding/CONTRIBUTING.md
|
- Contributing guide: https://github.com/github/docs/blob/main/CONTRIBUTING.md
|
||||||
|
|
||||||
Check to make sure someone hasn't already opened a similar issue: https://github.com/github/docs/issues
|
Check to make sure someone hasn't already opened a similar issue: https://github.com/github/docs/issues
|
||||||
-->
|
-->
|
||||||
|
|||||||
@@ -53,7 +53,7 @@ jobs:
|
|||||||
|
|
||||||
first-responder-remove-pr:
|
first-responder-remove-pr:
|
||||||
name: Remove PR from FR project board
|
name: Remove PR from FR project board
|
||||||
if: (github.event.label.name == 'docs-content-fr' && github.event.action == 'unlabeled') || github.event.action == 'closed'
|
if: github.repository == 'github/docs-internal' && (github.event.label.name == 'docs-content-fr' && github.event.action == 'unlabeled') || github.event.action == 'closed'
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
|
|||||||
1
.github/workflows/repo-sync.yml
vendored
@@ -17,7 +17,6 @@ jobs:
|
|||||||
repo-sync:
|
repo-sync:
|
||||||
name: Repo Sync
|
name: Repo Sync
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
continue-on-error: true
|
|
||||||
steps:
|
steps:
|
||||||
|
|
||||||
- name: Exit if repo is frozen
|
- name: Exit if repo is frozen
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 5.0 KiB After Width: | Height: | Size: 49 KiB |
|
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 29 KiB |
|
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 29 KiB |
|
Before Width: | Height: | Size: 6.5 KiB After Width: | Height: | Size: 53 KiB |
|
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 29 KiB |
@@ -50,7 +50,7 @@ To push to Docker Hub, you will need to have a Docker Hub account, and have a Do
|
|||||||
|
|
||||||
The `build-push-action` options required for Docker Hub are:
|
The `build-push-action` options required for Docker Hub are:
|
||||||
|
|
||||||
* `username` and `password`: This is your Docker Hub username and password. We recommend storing your Docker Hub username and password as encrypted secrets in the your {% data variables.product.prodname_dotcom %} repository so they aren't exposed in your workflow file. For more information, see "[Creating and using encrypted secrets](/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)."
|
* `username` and `password`: This is your Docker Hub username and password. We recommend storing your Docker Hub username and password as encrypted secrets in your {% data variables.product.prodname_dotcom %} repository so they aren't exposed in your workflow file. For more information, see "[Creating and using encrypted secrets](/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)."
|
||||||
* `repository`: Your Docker Hub repository in the format `DOCKER-HUB-NAMESPACE/DOCKER-HUB-REPOSITORY`.
|
* `repository`: Your Docker Hub repository in the format `DOCKER-HUB-NAMESPACE/DOCKER-HUB-REPOSITORY`.
|
||||||
|
|
||||||
{% raw %}
|
{% raw %}
|
||||||
|
|||||||
@@ -91,7 +91,7 @@ The following operating systems are supported for the self-hosted runner applica
|
|||||||
|
|
||||||
- macOS 10.13 (High Sierra) or later
|
- macOS 10.13 (High Sierra) or later
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
|
|
||||||
### Supported actions on self-hosted runners
|
### Supported actions on self-hosted runners
|
||||||
|
|
||||||
|
|||||||
@@ -50,13 +50,13 @@ You can add self-hosted runners to an enterprise, where they can be assigned to
|
|||||||
|
|
||||||
{% if currentVersion == "free-pro-team@latest" %}
|
{% if currentVersion == "free-pro-team@latest" %}
|
||||||
To add a self-hosted runner to an enterprise account, you must be an enterprise owner.
|
To add a self-hosted runner to an enterprise account, you must be an enterprise owner.
|
||||||
{% else if currentVersion != "free-pro-team@latest" and currentVersion ver_gt "enterprise-server@2.21"%}
|
{% else if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21"%}
|
||||||
To add a self-hosted runner at the enterprise level of {% data variables.product.product_location %}, you must be a site administrator.
|
To add a self-hosted runner at the enterprise level of {% data variables.product.product_location %}, you must be a site administrator.
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% if currentVersion == "free-pro-team@latest" %}
|
{% if currentVersion == "free-pro-team@latest" %}
|
||||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||||
{% else if currentVersion != "free-pro-team@latest" and currentVersion ver_gt "enterprise-server@2.21"%}
|
{% else if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21"%}
|
||||||
{% data reusables.enterprise_site_admin_settings.access-settings %}
|
{% data reusables.enterprise_site_admin_settings.access-settings %}
|
||||||
{% data reusables.enterprise_site_admin_settings.business %}
|
{% data reusables.enterprise_site_admin_settings.business %}
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|||||||
@@ -56,7 +56,7 @@ When creating a group, you must choose a policy that grants access to all organi
|
|||||||
|
|
||||||
{% if currentVersion == "free-pro-team@latest" %}
|
{% if currentVersion == "free-pro-team@latest" %}
|
||||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||||
{% else if currentVersion != "free-pro-team@latest" and currentVersion ver_gt "enterprise-server@2.21"%}
|
{% else if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21"%}
|
||||||
{% data reusables.enterprise_site_admin_settings.access-settings %}
|
{% data reusables.enterprise_site_admin_settings.access-settings %}
|
||||||
{% data reusables.enterprise_site_admin_settings.business %}
|
{% data reusables.enterprise_site_admin_settings.business %}
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|||||||
@@ -62,7 +62,7 @@ To remove a self-hosted runner from an organization, you must be an organization
|
|||||||
|
|
||||||
{% if currentVersion == "free-pro-team@latest" %}
|
{% if currentVersion == "free-pro-team@latest" %}
|
||||||
To remove a self-hosted runner from an enterprise account, you must be an enterprise owner. We recommend that you also have access to the self-hosted runner machine.
|
To remove a self-hosted runner from an enterprise account, you must be an enterprise owner. We recommend that you also have access to the self-hosted runner machine.
|
||||||
{% else if currentVersion != "free-pro-team@latest" and currentVersion ver_gt "enterprise-server@2.21"%}
|
{% else if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21"%}
|
||||||
To remove a self-hosted runner at the enterprise level of {% data variables.product.product_location %}, you must be a site administrator. We recommend that you also have access to the self-hosted runner machine.
|
To remove a self-hosted runner at the enterprise level of {% data variables.product.product_location %}, you must be a site administrator. We recommend that you also have access to the self-hosted runner machine.
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
@@ -70,7 +70,7 @@ To remove a self-hosted runner at the enterprise level of {% data variables.prod
|
|||||||
|
|
||||||
{% if currentVersion == "free-pro-team@latest" %}
|
{% if currentVersion == "free-pro-team@latest" %}
|
||||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||||
{% else if currentVersion != "free-pro-team@latest" and currentVersion ver_gt "enterprise-server@2.21"%}
|
{% else if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21"%}
|
||||||
{% data reusables.enterprise_site_admin_settings.access-settings %}
|
{% data reusables.enterprise_site_admin_settings.access-settings %}
|
||||||
{% data reusables.enterprise_site_admin_settings.business %}
|
{% data reusables.enterprise_site_admin_settings.business %}
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Disabling and enabling a workflow
|
title: Disabling and enabling a workflow
|
||||||
intro: You can disable and re-enable a workflow using {% data variables.product.prodname_dotcom %} or the REST API.
|
intro: 'You can disable and re-enable a workflow using {% data variables.product.prodname_dotcom %} or the REST API.'
|
||||||
product: '{% data reusables.gated-features.actions %}'
|
product: '{% data reusables.gated-features.actions %}'
|
||||||
versions:
|
versions:
|
||||||
free-pro-team: '*'
|
free-pro-team: '*'
|
||||||
|
|||||||
@@ -946,7 +946,7 @@ jobs:
|
|||||||
|
|
||||||
#### **`jobs.<job_id>.container.image`**
|
#### **`jobs.<job_id>.container.image`**
|
||||||
|
|
||||||
The Docker image to use as the container to run the action. The value can be the Docker Hub image name or a {% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.23" %}public{% endif %} registry name.
|
The Docker image to use as the container to run the action. The value can be the Docker Hub image name or a {% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.23" %}public{% endif %} registry name.
|
||||||
|
|
||||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
|
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
|
||||||
#### **`jobs.<job_id>.container.credentials`**
|
#### **`jobs.<job_id>.container.credentials`**
|
||||||
@@ -1029,7 +1029,7 @@ services:
|
|||||||
|
|
||||||
#### **`jobs.<job_id>.services.<service_id>.image`**
|
#### **`jobs.<job_id>.services.<service_id>.image`**
|
||||||
|
|
||||||
The Docker image to use as the service container to run the action. The value can be the Docker Hub image name or a {% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.23" %}public{% endif %} registry name.
|
The Docker image to use as the service container to run the action. The value can be the Docker Hub image name or a {% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.23" %}public{% endif %} registry name.
|
||||||
|
|
||||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
|
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
|
||||||
#### **`jobs.<job_id>.services.<service_id>.credentials`**
|
#### **`jobs.<job_id>.services.<service_id>.credentials`**
|
||||||
|
|||||||
@@ -45,6 +45,12 @@ Before enabling {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data v
|
|||||||
``` shell
|
``` shell
|
||||||
$ ghe-dep-graph-enable
|
$ ghe-dep-graph-enable
|
||||||
```
|
```
|
||||||
|
{% note %}
|
||||||
|
|
||||||
|
**Note**: For more information about enabling access to the administrative shell via SSH, see "[Accessing the administrative shell (SSH)](/enterprise/{{ currentVersion }}/admin/configuration/accessing-the-administrative-shell-ssh)."
|
||||||
|
|
||||||
|
{% endnote %}
|
||||||
|
|
||||||
3. Return to {% data variables.product.prodname_ghe_server %}.
|
3. Return to {% data variables.product.prodname_ghe_server %}.
|
||||||
{% data reusables.enterprise_site_admin_settings.access-settings %}
|
{% data reusables.enterprise_site_admin_settings.access-settings %}
|
||||||
{% data reusables.enterprise_site_admin_settings.business %}
|
{% data reusables.enterprise_site_admin_settings.business %}
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ Before launching {% data variables.product.product_location_enterprise %} on Goo
|
|||||||
#### Supported machine types
|
#### Supported machine types
|
||||||
|
|
||||||
{% data variables.product.prodname_ghe_server %} is supported on the following Google Compute Engine (GCE) machine types. For more information, see [the Google Cloud Platform machine types article](https://cloud.google.com/compute/docs/machine-types).
|
{% data variables.product.prodname_ghe_server %} is supported on the following Google Compute Engine (GCE) machine types. For more information, see [the Google Cloud Platform machine types article](https://cloud.google.com/compute/docs/machine-types).
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
|
||||||
| High-memory |
|
| High-memory |
|
||||||
------------- |
|
------------- |
|
||||||
| n1-highmem-4 |
|
| n1-highmem-4 |
|
||||||
@@ -34,7 +34,6 @@ Before launching {% data variables.product.product_location_enterprise %} on Goo
|
|||||||
| n1-highmem-32 |
|
| n1-highmem-32 |
|
||||||
| n1-highmem-64 |
|
| n1-highmem-64 |
|
||||||
| n1-highmem-96 |
|
| n1-highmem-96 |
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
#### Recommended machine types
|
#### Recommended machine types
|
||||||
|
|
||||||
|
|||||||
@@ -11,7 +11,7 @@ When using LDAP or built-in authentication, two-factor authentication is support
|
|||||||
|
|
||||||
{% data reusables.enterprise_user_management.external_auth_disables_2fa %}
|
{% data reusables.enterprise_user_management.external_auth_disables_2fa %}
|
||||||
|
|
||||||
For more information, see [this chart on authentication methods that support 2FA](/enterprise/{{ currentVersion }}/user/articles/about-two-factor-authentication/#authentication-methods-that-support-2fa).
|
For more information, see "[About two-factor authentication](/github/authenticating-to-github/about-two-factor-authentication)."
|
||||||
|
|
||||||
### Requirements for enforcing two-factor authentication
|
### Requirements for enforcing two-factor authentication
|
||||||
|
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ versions:
|
|||||||
enterprise-server: '*'
|
enterprise-server: '*'
|
||||||
---
|
---
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
|
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
|
||||||
{% data reusables.pre-release-program.machine-man-preview %}
|
{% data reusables.pre-release-program.machine-man-preview %}
|
||||||
{% data reusables.pre-release-program.api-preview-warning %}
|
{% data reusables.pre-release-program.api-preview-warning %}
|
||||||
{% endif %}
|
{% endif %}
|
||||||
@@ -94,7 +94,7 @@ Use your {% data variables.product.prodname_github_app %}'s identifier (`YOUR_AP
|
|||||||
|
|
||||||
After creating the JWT, set it in the `Header` of the API request:
|
After creating the JWT, set it in the `Header` of the API request:
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
|
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
|
||||||
```shell
|
```shell
|
||||||
$ curl -i -H "Authorization: Bearer YOUR_JWT" -H "Accept: application/vnd.github.machine-man-preview+json" {% data variables.product.api_url_pre %}/app
|
$ curl -i -H "Authorization: Bearer YOUR_JWT" -H "Accept: application/vnd.github.machine-man-preview+json" {% data variables.product.api_url_pre %}/app
|
||||||
```
|
```
|
||||||
@@ -129,7 +129,7 @@ By default, installation access tokens are scoped to all the repositories that a
|
|||||||
|
|
||||||
To create an installation access token, include the JWT [generated above](#jwt-payload) in the Authorization header in the API request:
|
To create an installation access token, include the JWT [generated above](#jwt-payload) in the Authorization header in the API request:
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
|
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
|
||||||
```shell
|
```shell
|
||||||
$ curl -i -X POST \
|
$ curl -i -X POST \
|
||||||
-H "Authorization: Bearer YOUR_JWT" \
|
-H "Authorization: Bearer YOUR_JWT" \
|
||||||
@@ -149,7 +149,7 @@ The response will include your installation access token, the expiration date, t
|
|||||||
|
|
||||||
To authenticate with an installation access token, include it in the Authorization header in the API request:
|
To authenticate with an installation access token, include it in the Authorization header in the API request:
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
|
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
|
||||||
```shell
|
```shell
|
||||||
$ curl -i \
|
$ curl -i \
|
||||||
-H "Authorization: token YOUR_INSTALLATION_ACCESS_TOKEN" \
|
-H "Authorization: token YOUR_INSTALLATION_ACCESS_TOKEN" \
|
||||||
|
|||||||
@@ -162,7 +162,7 @@ You must complete this step of the GitHub App Manifest flow within one hour.
|
|||||||
|
|
||||||
{% endnote %}
|
{% endnote %}
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.21" %}
|
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.21" %}
|
||||||
{% data reusables.pre-release-program.fury-pre-release %}
|
{% data reusables.pre-release-program.fury-pre-release %}
|
||||||
{% data reusables.pre-release-program.api-preview-warning %}
|
{% data reusables.pre-release-program.api-preview-warning %}
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|||||||
@@ -136,7 +136,7 @@ For more information about authorizing users using the device flow, see "[Author
|
|||||||
|
|
||||||
### Check which installation's resources a user can access
|
### Check which installation's resources a user can access
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
|
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
|
||||||
{% data reusables.pre-release-program.machine-man-preview %}
|
{% data reusables.pre-release-program.machine-man-preview %}
|
||||||
{% data reusables.pre-release-program.api-preview-warning %}
|
{% data reusables.pre-release-program.api-preview-warning %}
|
||||||
{% endif %}
|
{% endif %}
|
||||||
@@ -422,7 +422,7 @@ While most of your API interaction should occur using your server-to-server inst
|
|||||||
* [Convert an organization member to outside collaborator](/v3/orgs/outside_collaborators/#convert-an-organization-member-to-outside-collaborator)
|
* [Convert an organization member to outside collaborator](/v3/orgs/outside_collaborators/#convert-an-organization-member-to-outside-collaborator)
|
||||||
* [Remove outside collaborator from an organization](/v3/orgs/outside_collaborators/#remove-outside-collaborator-from-an-organization)
|
* [Remove outside collaborator from an organization](/v3/orgs/outside_collaborators/#remove-outside-collaborator-from-an-organization)
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
##### Organization Pre Receive Hooks
|
##### Organization Pre Receive Hooks
|
||||||
|
|
||||||
* [List pre-receive hooks for an organization](/enterprise/user/rest/reference/enterprise-admin#list-pre-receive-hooks-for-an-organization)
|
* [List pre-receive hooks for an organization](/enterprise/user/rest/reference/enterprise-admin#list-pre-receive-hooks-for-an-organization)
|
||||||
@@ -460,7 +460,7 @@ While most of your API interaction should occur using your server-to-server inst
|
|||||||
* [List teams](/v3/teams/#list-teams)
|
* [List teams](/v3/teams/#list-teams)
|
||||||
* [Create a team](/v3/teams/#create-a-team)
|
* [Create a team](/v3/teams/#create-a-team)
|
||||||
* [Get a team by name](/v3/teams/#get-a-team-by-name)
|
* [Get a team by name](/v3/teams/#get-a-team-by-name)
|
||||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.21" %}
|
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.21" %}
|
||||||
* [Get a team](/v3/teams/#get-a-team)
|
* [Get a team](/v3/teams/#get-a-team)
|
||||||
{% endif %}
|
{% endif %}
|
||||||
* [Update a team](/v3/teams/#update-a-team)
|
* [Update a team](/v3/teams/#update-a-team)
|
||||||
@@ -762,7 +762,7 @@ While most of your API interaction should occur using your server-to-server inst
|
|||||||
* [Get GitHub Pages build](/rest/reference/repos#get-github-pages-build)
|
* [Get GitHub Pages build](/rest/reference/repos#get-github-pages-build)
|
||||||
* [Get latest pages build](/rest/reference/repos#get-latest-pages-build)
|
* [Get latest pages build](/rest/reference/repos#get-latest-pages-build)
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
##### Repository Pre Receive Hooks
|
##### Repository Pre Receive Hooks
|
||||||
|
|
||||||
* [List pre-receive hooks for a repository](/enterprise/user/rest/reference/enterprise-admin#list-pre-receive-hooks-for-a-repository)
|
* [List pre-receive hooks for a repository](/enterprise/user/rest/reference/enterprise-admin#list-pre-receive-hooks-for-a-repository)
|
||||||
|
|||||||
@@ -38,7 +38,7 @@ X-Accepted-OAuth-Scopes: user
|
|||||||
|
|
||||||
Name | Description
|
Name | Description
|
||||||
-----|-----------|
|
-----|-----------|
|
||||||
**`(no scope)`** | Grants read-only access to public information (includes public user profile info, public repository info, and gists){% if currentVersion != "free-pro-team@latest" %}
|
**`(no scope)`** | Grants read-only access to public information (includes public user profile info, public repository info, and gists){% if enterpriseServerVersions contains currentVersion %}
|
||||||
**`site_admin`** | Grants site administrators access to [{% data variables.product.prodname_ghe_server %} Administration API endpoints](/v3/enterprise-admin).{% endif %}
|
**`site_admin`** | Grants site administrators access to [{% data variables.product.prodname_ghe_server %} Administration API endpoints](/v3/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`** | 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: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.
|
||||||
|
|||||||
@@ -29,7 +29,7 @@ As an alternative to the email service, you can now start using email notificati
|
|||||||
|
|
||||||
GitHub Services (sometimes referred to as Service Hooks) is the legacy method of integrating where GitHub hosted a portion of our integrator’s services via [the `github-services` repository](https://github.com/github/github-services). Actions performed on GitHub trigger these services, and you can use these services to trigger actions outside of GitHub.
|
GitHub Services (sometimes referred to as Service Hooks) is the legacy method of integrating where GitHub hosted a portion of our integrator’s services via [the `github-services` repository](https://github.com/github/github-services). Actions performed on GitHub trigger these services, and you can use these services to trigger actions outside of GitHub.
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
### Finding repositories that use GitHub Services
|
### Finding repositories that use GitHub Services
|
||||||
We provide a command-line script that helps you identify which repositories on your appliance use GitHub Services. For more information, see [ghe-legacy-github-services-report](/enterprise/{{currentVersion}}/admin/articles/command-line-utilities/#ghe-legacy-github-services-report).{% endif %}
|
We provide a command-line script that helps you identify which repositories on your appliance use GitHub Services. For more information, see [ghe-legacy-github-services-report](/enterprise/{{currentVersion}}/admin/articles/command-line-utilities/#ghe-legacy-github-services-report).{% endif %}
|
||||||
|
|
||||||
|
|||||||
@@ -11,9 +11,9 @@ versions:
|
|||||||
|
|
||||||
Webhooks allow you to build or set up integrations, such as [{% data variables.product.prodname_github_app %}s](/apps/building-github-apps/) or [{% data variables.product.prodname_oauth_app %}s](/apps/building-oauth-apps/), which subscribe to certain events on GitHub.com. When one of those events is triggered, we'll send a HTTP POST payload to the webhook's configured URL. Webhooks can be used to update an external issue tracker, trigger CI builds, update a backup mirror, or even deploy to your production server. You're only limited by your imagination.
|
Webhooks allow you to build or set up integrations, such as [{% data variables.product.prodname_github_app %}s](/apps/building-github-apps/) or [{% data variables.product.prodname_oauth_app %}s](/apps/building-oauth-apps/), which subscribe to certain events on GitHub.com. When one of those events is triggered, we'll send a HTTP POST payload to the webhook's configured URL. Webhooks can be used to update an external issue tracker, trigger CI builds, update a backup mirror, or even deploy to your production server. You're only limited by your imagination.
|
||||||
|
|
||||||
Webhooks can be installed on{% if currentVersion != "free-pro-team@latest" %} a [{% data variables.product.prodname_ghe_server %} instance](/rest/reference/enterprise-admin#global-webhooks/),{% endif %} an [organization][org-hooks], a specific [repository][repo-hooks], or a {% data variables.product.prodname_github_app %}. Once installed, the webhook will be sent each time one or more subscribed events occurs.
|
Webhooks can be installed on{% if enterpriseServerVersions contains currentVersion %} a [{% data variables.product.prodname_ghe_server %} instance](/rest/reference/enterprise-admin#global-webhooks/),{% endif %} an [organization][org-hooks], a specific [repository][repo-hooks], or a {% data variables.product.prodname_github_app %}. Once installed, the webhook will be sent each time one or more subscribed events occurs.
|
||||||
|
|
||||||
You can create up to {% if currentVersion != "free-pro-team@latest" %}250{% else %}20{% endif %} webhooks for each event on each installation target {% if currentVersion != "free-pro-team@latest" %}({% data variables.product.prodname_ghe_server %} instance, specific organization, or specific repository).{% else %}(specific organization or specific repository).{% endif %}
|
You can create up to {% if enterpriseServerVersions contains currentVersion %}250{% else %}20{% endif %} webhooks for each event on each installation target {% if enterpriseServerVersions contains currentVersion %}({% data variables.product.prodname_ghe_server %} instance, specific organization, or specific repository).{% else %}(specific organization or specific repository).{% endif %}
|
||||||
|
|
||||||
### Events
|
### Events
|
||||||
|
|
||||||
|
|||||||
@@ -348,7 +348,7 @@ The issue or pull request was locked.
|
|||||||
|
|
||||||
#### Event object properties
|
#### Event object properties
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
|
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
|
||||||
{% data reusables.pre-release-program.sailor-v-preview %}
|
{% data reusables.pre-release-program.sailor-v-preview %}
|
||||||
{% data reusables.pre-release-program.api-preview-warning %}
|
{% data reusables.pre-release-program.api-preview-warning %}
|
||||||
{% endif %}
|
{% endif %}
|
||||||
@@ -668,7 +668,7 @@ The issue was unlocked.
|
|||||||
|
|
||||||
#### Event object properties
|
#### Event object properties
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
|
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
|
||||||
{% data reusables.pre-release-program.sailor-v-preview %}
|
{% data reusables.pre-release-program.sailor-v-preview %}
|
||||||
{% data reusables.pre-release-program.api-preview-warning %}
|
{% data reusables.pre-release-program.api-preview-warning %}
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|||||||
@@ -47,7 +47,7 @@ HTTP POST payloads that are delivered to your webhook's configured URL endpoint
|
|||||||
Header | Description
|
Header | Description
|
||||||
-------|-------------|
|
-------|-------------|
|
||||||
`X-GitHub-Event`| Name of the event that triggered the delivery.
|
`X-GitHub-Event`| Name of the event that triggered the delivery.
|
||||||
`X-GitHub-Delivery`| A [GUID](http://en.wikipedia.org/wiki/Globally_unique_identifier) to identify the delivery.{% if currentVersion != "free-pro-team@latest" %}
|
`X-GitHub-Delivery`| A [GUID](http://en.wikipedia.org/wiki/Globally_unique_identifier) to identify the delivery.{% if enterpriseServerVersions contains currentVersion %}
|
||||||
`X-GitHub-Enterprise-Version` | The version of the {% data variables.product.prodname_ghe_server %} instance that sent the HTTP POST payload.
|
`X-GitHub-Enterprise-Version` | The version of the {% data variables.product.prodname_ghe_server %} instance that sent the HTTP POST payload.
|
||||||
`X-GitHub-Enterprise-Host` | The hostname of the {% data variables.product.prodname_ghe_server %} instance that sent the HTTP POST payload.{% endif %}{% if currentVersion != "private-instances@latest" %}
|
`X-GitHub-Enterprise-Host` | The hostname of the {% data variables.product.prodname_ghe_server %} instance that sent the HTTP POST payload.{% endif %}{% if currentVersion != "private-instances@latest" %}
|
||||||
`X-Hub-Signature`| This header is sent if the webhook is configured with a [`secret`](/v3/repos/hooks/#create-hook-config-params). This is the HMAC hex digest of the request body, and is generated using the SHA-1 hash function and the `secret` as the HMAC `key`.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} `X-Hub-Signature` is provided for compatibility with existing integrations, and we recommend that you use the more secure `X-Hub-Signature-256` instead.{% endif %}{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "private-instances@latest" %}
|
`X-Hub-Signature`| This header is sent if the webhook is configured with a [`secret`](/v3/repos/hooks/#create-hook-config-params). This is the HMAC hex digest of the request body, and is generated using the SHA-1 hash function and the `secret` as the HMAC `key`.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} `X-Hub-Signature` is provided for compatibility with existing integrations, and we recommend that you use the more secure `X-Hub-Signature-256` instead.{% endif %}{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "private-instances@latest" %}
|
||||||
@@ -61,7 +61,7 @@ Also, the `User-Agent` for the requests will have the prefix `GitHub-Hookshot/`.
|
|||||||
> POST /payload HTTP/1.1
|
> POST /payload HTTP/1.1
|
||||||
|
|
||||||
> Host: localhost:4567
|
> Host: localhost:4567
|
||||||
> X-GitHub-Delivery: 72d3162e-cc78-11e3-81ab-4c9367dc0958{% if currentVersion != "free-pro-team@latest" %}
|
> X-GitHub-Delivery: 72d3162e-cc78-11e3-81ab-4c9367dc0958{% if enterpriseServerVersions contains currentVersion %}
|
||||||
> X-GitHub-Enterprise-Version: 2.15.0
|
> X-GitHub-Enterprise-Version: 2.15.0
|
||||||
> X-GitHub-Enterprise-Host: example.com{% endif %}{% if currentVersion != "private-instances@latest" %}
|
> X-GitHub-Enterprise-Host: example.com{% endif %}{% if currentVersion != "private-instances@latest" %}
|
||||||
> X-Hub-Signature: sha1=7d38cdd689735b008b3c702edd92eea23791c5f6{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "private-instances@latest" %}
|
> X-Hub-Signature: sha1=7d38cdd689735b008b3c702edd92eea23791c5f6{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "private-instances@latest" %}
|
||||||
@@ -332,7 +332,7 @@ Key | Type | Description
|
|||||||
|
|
||||||
{{ webhookPayloadsForCurrentVersion.deployment_status }}
|
{{ webhookPayloadsForCurrentVersion.deployment_status }}
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
|
|
||||||
### enterprise
|
### enterprise
|
||||||
|
|
||||||
@@ -667,7 +667,7 @@ Key | Type | Description
|
|||||||
|
|
||||||
#### Availability
|
#### Availability
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
- GitHub Enterprise webhooks only receive `created` and `deleted` events. For more information, "[Global webhooks](/rest/reference/enterprise-admin#global-webhooks/).{% endif %}
|
- GitHub Enterprise webhooks only receive `created` and `deleted` events. For more information, "[Global webhooks](/rest/reference/enterprise-admin#global-webhooks/).{% endif %}
|
||||||
- Organization webhooks only receive the `deleted`, `added`, `removed`, `renamed`, and `invited` events
|
- Organization webhooks only receive the `deleted`, `added`, `removed`, `renamed`, and `invited` events
|
||||||
- {% data variables.product.prodname_github_app %}s with the `members` permission
|
- {% data variables.product.prodname_github_app %}s with the `members` permission
|
||||||
@@ -676,7 +676,7 @@ Key | Type | Description
|
|||||||
|
|
||||||
Key | Type | Description
|
Key | Type | Description
|
||||||
----|------|-------------
|
----|------|-------------
|
||||||
`action` |`string` | The action that was performed. Can be one of:{% if currentVersion != "free-pro-team@latest" %} `created`,{% endif %} `deleted`, `renamed`, `member_added`, `member_removed`, or `member_invited`.
|
`action` |`string` | The action that was performed. Can be one of:{% if enterpriseServerVersions contains currentVersion %} `created`,{% endif %} `deleted`, `renamed`, `member_added`, `member_removed`, or `member_invited`.
|
||||||
`invitation` |`object` | The invitation for the user or email if the action is `member_invited`.
|
`invitation` |`object` | The invitation for the user or email if the action is `member_invited`.
|
||||||
`membership` |`object` | The membership between the user and the organization. Not present when the action is `member_invited`.
|
`membership` |`object` | The membership between the user and the organization. Not present when the action is `member_invited`.
|
||||||
{% data reusables.webhooks.org_desc %}
|
{% data reusables.webhooks.org_desc %}
|
||||||
@@ -1045,7 +1045,7 @@ This event occurs when a {% data variables.product.prodname_github_app %} sends
|
|||||||
|
|
||||||
Key | Type | Description
|
Key | Type | Description
|
||||||
----|------|-------------
|
----|------|-------------
|
||||||
`action` |`string` | The action that was performed. This can be one of:<ul><li>`created` - A repository is created.</li><li>`deleted` - A repository is deleted. This event type is only available to [organization hooks](/rest/reference/orgs#webhooks/)</li><li>`archived` - A repository is archived.</li><li>`unarchived` - A repository is unarchived.</li>{% if currentVersion != "free-pro-team@latest" %}<li>`anonymous_access_enabled` - A repository is [enabled for anonymous Git access](/v3/previews/#anonymous-git-access-to-repositories), `anonymous_access_disabled` - A repository is [disabled for anonymous Git access](/v3/previews/#anonymous-git-access-to-repositories)</li>{% endif %}<li>`edited` - A repository's information is edited.</li><li>`renamed` - A repository is renamed.</li><li>`transferred` - A repository is transferred.</li><li>`publicized` - A repository is made public.</li><li> `privatized` - A repository is made private.</li></ul>
|
`action` |`string` | The action that was performed. This can be one of:<ul><li>`created` - A repository is created.</li><li>`deleted` - A repository is deleted. This event type is only available to [organization hooks](/rest/reference/orgs#webhooks/)</li><li>`archived` - A repository is archived.</li><li>`unarchived` - A repository is unarchived.</li>{% if enterpriseServerVersions contains currentVersion %}<li>`anonymous_access_enabled` - A repository is [enabled for anonymous Git access](/v3/previews/#anonymous-git-access-to-repositories), `anonymous_access_disabled` - A repository is [disabled for anonymous Git access](/v3/previews/#anonymous-git-access-to-repositories)</li>{% endif %}<li>`edited` - A repository's information is edited.</li><li>`renamed` - A repository is renamed.</li><li>`transferred` - A repository is transferred.</li><li>`publicized` - A repository is made public.</li><li> `privatized` - A repository is made private.</li></ul>
|
||||||
{% data reusables.webhooks.repo_desc %}
|
{% data reusables.webhooks.repo_desc %}
|
||||||
{% data reusables.webhooks.org_desc %}
|
{% data reusables.webhooks.org_desc %}
|
||||||
{% data reusables.webhooks.app_desc %}
|
{% data reusables.webhooks.app_desc %}
|
||||||
@@ -1247,7 +1247,7 @@ Key | Type | Description
|
|||||||
|
|
||||||
{{ webhookPayloadsForCurrentVersion.team_add }}
|
{{ webhookPayloadsForCurrentVersion.team_add }}
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
|
|
||||||
### user
|
### user
|
||||||
|
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ versions:
|
|||||||
enterprise-server: '*'
|
enterprise-server: '*'
|
||||||
---
|
---
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}{% data reusables.notifications.outbound_email_tip %}{% endif %}
|
{% if enterpriseServerVersions contains currentVersion %}{% data reusables.notifications.outbound_email_tip %}{% endif %}
|
||||||
|
|
||||||
Each email notification for a push to a repository lists the new commits and links to a diff containing just those commits. In the email notification you'll see:
|
Each email notification for a push to a repository lists the new commits and links to a diff containing just those commits. In the email notification you'll see:
|
||||||
|
|
||||||
|
|||||||
@@ -27,7 +27,7 @@ You can search for repositories that are associated with a particular topic. For
|
|||||||
|
|
||||||
### Adding topics to your repository
|
### Adding topics to your repository
|
||||||
|
|
||||||
{% data reusables.repositories.navigate-to-repo %}{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
|
{% data reusables.repositories.navigate-to-repo %}{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
|
||||||
2. Under your repository description, click **Add topics**.
|
2. Under your repository description, click **Add topics**.
|
||||||

|

|
||||||
3. Type the topic you want to add to your repository, then type a space.
|
3. Type the topic you want to add to your repository, then type a space.
|
||||||
|
|||||||
@@ -546,12 +546,6 @@ updates:
|
|||||||
|
|
||||||
Use the `vendor` option to tell {% data variables.product.prodname_dependabot_short %} to vendor dependencies when updating them.
|
Use the `vendor` option to tell {% data variables.product.prodname_dependabot_short %} to vendor dependencies when updating them.
|
||||||
|
|
||||||
{% note %}
|
|
||||||
|
|
||||||
Currently, {% data variables.product.prodname_dependabot_short %} only supports vendoring dependencies for Bundler.
|
|
||||||
|
|
||||||
{% endnote %}
|
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Configure version updates for both dependencies defined in manifests and vendored dependencies
|
# Configure version updates for both dependencies defined in manifests and vendored dependencies
|
||||||
|
|
||||||
@@ -565,7 +559,13 @@ updates:
|
|||||||
interval: "weekly"
|
interval: "weekly"
|
||||||
```
|
```
|
||||||
|
|
||||||
{% data variables.product.prodname_dependabot_short %} only updates the vendored dependencies located in specific directories in a repository. For Bundler, the dependencies must be in the _vendor/cache_ directory. Other file paths are not supported. For more information, see the [`bundle cache` documentation](https://bundler.io/man/bundle-cache.1.html).
|
{% data variables.product.prodname_dependabot_short %} only updates the vendored dependencies located in specific directories in a repository.
|
||||||
|
|
||||||
|
| Package manager | Required file path for vendored dependencies | More information |
|
||||||
|
|------------------|-------------------------------|--------|
|
||||||
|
| `bundler` | The dependencies must be in the _vendor/cache_ directory.</br>Other file paths are not supported. | [`bundle cache` documentation](https://bundler.io/man/bundle-cache.1.html) |
|
||||||
|
| `gomod` | No path requirement (dependencies are usually located in the _vendor_ directory) | [`go mod vendor` documentation](https://golang.org/ref/mod#go-mod-vendor) |
|
||||||
|
|
||||||
|
|
||||||
### `versioning-strategy`
|
### `versioning-strategy`
|
||||||
|
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ You can enable {% data variables.product.prodname_actions %} for your repository
|
|||||||
|
|
||||||
Alternatively, you can enable {% data variables.product.prodname_actions %} in your repository but limit the actions a workflow can run. {% data reusables.github-actions.enabled-local-github-actions %}
|
Alternatively, you can enable {% data variables.product.prodname_actions %} in your repository but limit the actions a workflow can run. {% data reusables.github-actions.enabled-local-github-actions %}
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.23" %}
|
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.23" %}
|
||||||
|
|
||||||
### Managing {% data variables.product.prodname_actions %} permissions for your repository
|
### Managing {% data variables.product.prodname_actions %} permissions for your repository
|
||||||
|
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ By default, force pushes are blocked on all protected branches. When you enable
|
|||||||
|
|
||||||
Enabling force pushes will not override any other branch protection rules. For example, if a branch requires a linear commit history, you cannot force push merge commits to that branch.
|
Enabling force pushes will not override any other branch protection rules. For example, if a branch requires a linear commit history, you cannot force push merge commits to that branch.
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}You cannot enable force pushes for a protected branch if a site administrator has blocked force pushes to all branches in your repository. For more information, see "[Blocking force pushes to repositories owned by a user account or organization](/enterprise/{{ currentVersion }}/admin/developer-workflow/blocking-force-pushes-to-repositories-owned-by-a-user-account-or-organization)."
|
{% if enterpriseServerVersions contains currentVersion %}You cannot enable force pushes for a protected branch if a site administrator has blocked force pushes to all branches in your repository. For more information, see "[Blocking force pushes to repositories owned by a user account or organization](/enterprise/{{ currentVersion }}/admin/developer-workflow/blocking-force-pushes-to-repositories-owned-by-a-user-account-or-organization)."
|
||||||
|
|
||||||
If a site administrator has blocked force pushes to the default branch only, you can still enable force pushes for any other protected branch.{% endif %}
|
If a site administrator has blocked force pushes to the default branch only, you can still enable force pushes for any other protected branch.{% endif %}
|
||||||
|
|
||||||
|
|||||||
@@ -26,7 +26,7 @@ versions:
|
|||||||
{% link_in_list /viewing-deployment-activity-for-your-repository %}
|
{% link_in_list /viewing-deployment-activity-for-your-repository %}
|
||||||
<!-- endif -->
|
<!-- endif -->
|
||||||
{% link_in_list /managing-the-forking-policy-for-your-repository %}
|
{% link_in_list /managing-the-forking-policy-for-your-repository %}
|
||||||
<!-- if currentVersion != "free-pro-team@latest" -->
|
<!-- if enterpriseServerVersions contains currentVersion -->
|
||||||
{% link_in_list /configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository %}
|
{% link_in_list /configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository %}
|
||||||
{% link_in_list /disabling-or-limiting-github-actions-for-a-repository %}
|
{% link_in_list /disabling-or-limiting-github-actions-for-a-repository %}
|
||||||
{% link_in_list /managing-git-lfs-objects-in-archives-of-your-repository %}
|
{% link_in_list /managing-git-lfs-objects-in-archives-of-your-repository %}
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ We recommend reviewing the following caveats before you change the visibility of
|
|||||||
{% if currentVersion == "free-pro-team@latest" %}* 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 %}
|
{% if currentVersion == "free-pro-team@latest" %}* 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 %}
|
||||||
* Any published {% data variables.product.prodname_pages %} site will be automatically unpublished. 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)."
|
* Any published {% data variables.product.prodname_pages %} site will be automatically unpublished. 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)."
|
||||||
* {% data variables.product.prodname_dotcom %} will no longer included 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 %}
|
* {% data variables.product.prodname_dotcom %} will no longer included 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" %}* 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 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 %}
|
||||||
|
|
||||||
#### Making a repository public
|
#### Making a repository public
|
||||||
|
|
||||||
|
|||||||
@@ -29,7 +29,7 @@ versions:
|
|||||||
```shell
|
```shell
|
||||||
$ gpg --default-new-key-algo rsa4096 --gen-key
|
$ gpg --default-new-key-algo rsa4096 --gen-key
|
||||||
```
|
```
|
||||||
4. At the prompt, specify the kind of key you want, or press `Enter` to accept the default `RSA and DSA`.
|
4. At the prompt, specify the kind of key you want, or press `Enter` to accept the default `RSA and RSA`.
|
||||||
5. Enter the desired key size. Your key must be at least `4096` bits.
|
5. Enter the desired key size. Your key must be at least `4096` bits.
|
||||||
6. Enter the length of time the key should be valid. Press `Enter` to specify the default selection, indicating that the key doesn't expire.
|
6. Enter the length of time the key should be valid. Press `Enter` to specify the default selection, indicating that the key doesn't expire.
|
||||||
7. Verify that your selections are correct.
|
7. Verify that your selections are correct.
|
||||||
|
|||||||
@@ -134,7 +134,7 @@ To illustrate how `git filter-branch` works, we'll show you how to remove your f
|
|||||||
|
|
||||||
{% endnote %}
|
{% endnote %}
|
||||||
|
|
||||||
## Avoiding accidental commits in the future
|
### Avoiding accidental commits in the future
|
||||||
|
|
||||||
There are a few simple tricks to avoid committing things you don't want committed:
|
There are a few simple tricks to avoid committing things you don't want committed:
|
||||||
|
|
||||||
@@ -145,5 +145,5 @@ There are a few simple tricks to avoid committing things you don't want committe
|
|||||||
|
|
||||||
### Further reading
|
### Further reading
|
||||||
|
|
||||||
- [`git filter-branch` main page](https://git-scm.com/docs/git-filter-branch)
|
- [`git filter-branch` man page](https://git-scm.com/docs/git-filter-branch)
|
||||||
- [Pro Git: Git Tools - Rewriting History](https://git-scm.com/book/en/Git-Tools-Rewriting-History)
|
- [Pro Git: Git Tools - Rewriting History](https://git-scm.com/book/en/Git-Tools-Rewriting-History)
|
||||||
|
|||||||
@@ -48,7 +48,7 @@ Actions listed in your security log are grouped within the following categories:
|
|||||||
| `project` | Contains all activities related to project boards.
|
| `project` | Contains all activities related to project boards.
|
||||||
| `public_key` | Contains all activities related to [your public SSH keys](/articles/adding-a-new-ssh-key-to-your-github-account).
|
| `public_key` | Contains all activities related to [your public SSH keys](/articles/adding-a-new-ssh-key-to-your-github-account).
|
||||||
| `repo` | Contains all activities related to the repositories you own.{% if currentVersion == "free-pro-team@latest" %}
|
| `repo` | Contains all activities related to the repositories you own.{% if currentVersion == "free-pro-team@latest" %}
|
||||||
| `sponsors` | Contains all events related to {% data variables.product.prodname_sponsors %} and sponsor buttons (see "[About {% data variables.product.prodname_sponsors %}](/articles/about-github-sponsors)" and "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)"){% endif %}{% if currentVersion != "free-pro-team@latest" %}
|
| `sponsors` | Contains all events related to {% data variables.product.prodname_sponsors %} and sponsor buttons (see "[About {% data variables.product.prodname_sponsors %}](/articles/about-github-sponsors)" and "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)"){% endif %}{% if enterpriseServerVersions contains currentVersion %}
|
||||||
| `team` | Contains all activities related to teams you are a part of.{% endif %}
|
| `team` | Contains all activities related to teams you are a part of.{% endif %}
|
||||||
| `two_factor_authentication` | Contains all activities related to [two-factor authentication](/articles/securing-your-account-with-two-factor-authentication-2fa).
|
| `two_factor_authentication` | Contains all activities related to [two-factor authentication](/articles/securing-your-account-with-two-factor-authentication-2fa).
|
||||||
| `user` | Contains all activities related to your account.
|
| `user` | Contains all activities related to your account.
|
||||||
@@ -142,7 +142,7 @@ A description of the events within these categories is listed below.
|
|||||||
| access | Triggered when you a repository you own is [switched from "private" to "public"](/articles/making-a-private-repository-public) (or vice versa).
|
| access | Triggered when you a repository you own is [switched from "private" to "public"](/articles/making-a-private-repository-public) (or vice versa).
|
||||||
| add_member | Triggered when a {% data variables.product.product_name %} user is {% if currentVersion == "free-pro-team@latest" %}[invited to have collaboration access](/articles/inviting-collaborators-to-a-personal-repository){% else %}[given collaboration access](/articles/inviting-collaborators-to-a-personal-repository){% endif %} to a repository.
|
| add_member | Triggered when a {% data variables.product.product_name %} user is {% if currentVersion == "free-pro-team@latest" %}[invited to have collaboration access](/articles/inviting-collaborators-to-a-personal-repository){% else %}[given collaboration access](/articles/inviting-collaborators-to-a-personal-repository){% endif %} to a repository.
|
||||||
| add_topic | Triggered when a repository owner [adds a topic](/articles/classifying-your-repository-with-topics) to a repository.
|
| add_topic | Triggered when a repository owner [adds a topic](/articles/classifying-your-repository-with-topics) to a repository.
|
||||||
| archived | Triggered when a repository owner [archives a repository](/articles/about-archiving-repositories).{% if currentVersion != "free-pro-team@latest" %}
|
| archived | Triggered when a repository owner [archives a repository](/articles/about-archiving-repositories).{% if enterpriseServerVersions contains currentVersion %}
|
||||||
| config.disable_anonymous_git_access | Triggered when [anonymous Git read access is disabled](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository) in a public repository.
|
| config.disable_anonymous_git_access | Triggered when [anonymous Git read access is disabled](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository) in a public repository.
|
||||||
| config.enable_anonymous_git_access | Triggered when [anonymous Git read access is enabled](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository) in a public repository.
|
| config.enable_anonymous_git_access | Triggered when [anonymous Git read access is enabled](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository) in a public repository.
|
||||||
| config.lock_anonymous_git_access | Triggered when a repository's [anonymous Git read access setting is locked](/enterprise/{{ currentVersion }}/admin/guides/user-management/preventing-users-from-changing-anonymous-git-read-access).
|
| config.lock_anonymous_git_access | Triggered when a repository's [anonymous Git read access setting is locked](/enterprise/{{ currentVersion }}/admin/guides/user-management/preventing-users-from-changing-anonymous-git-read-access).
|
||||||
@@ -191,7 +191,7 @@ A description of the events within these categories is listed below.
|
|||||||
| revoke | Triggered when you revoke a succession invitation (see "[Maintaining ownership continuity of your user account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)")
|
| revoke | Triggered when you revoke a succession invitation (see "[Maintaining ownership continuity of your user account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)")
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
|
|
||||||
#### The `team` category
|
#### The `team` category
|
||||||
|
|
||||||
|
|||||||
@@ -35,7 +35,7 @@ Open source licenses enable others to freely use, change, and distribute the pro
|
|||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
<!--GHE version just adds a file named LICENSE or LICENSE.md-->
|
<!--GHE version just adds a file named LICENSE or LICENSE.md-->
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
|
|
||||||
{% data reusables.repositories.navigate-to-repo %}
|
{% data reusables.repositories.navigate-to-repo %}
|
||||||
{% data reusables.files.add-file %}
|
{% data reusables.files.add-file %}
|
||||||
|
|||||||
@@ -28,7 +28,7 @@ assignees: octocat
|
|||||||
```
|
```
|
||||||
{% note %}
|
{% note %}
|
||||||
|
|
||||||
**Note:** You must put YAML-reserved characters such as `:` in quotes. For example, `":bug: Bug"`.
|
**Note:** If a front matter value includes a YAML-reserved character such as `:` , you must put the whole value in quotes. For example, `":bug: Bug"` or `":new: triage needed, :bug: bug"`.
|
||||||
|
|
||||||
{% endnote %}
|
{% endnote %}
|
||||||
|
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ You can unblock a user in your account settings or from the user's profile page.
|
|||||||
### Unblocking a user from their profile page
|
### Unblocking a user from their profile page
|
||||||
|
|
||||||
{% data reusables.profile.user_profile_page_navigation %}
|
{% data reusables.profile.user_profile_page_navigation %}
|
||||||
2. In the left sidebar, under the user's profile picture, click **Unblock or report user**.
|
2. In the left sidebar, under the user's profile picture, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}, then click **Unblock or report user**.
|
||||||

|

|
||||||
3. Click **Unblock user**.
|
3. Click **Unblock user**.
|
||||||

|

|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Collaborating on repositories with code quality features
|
title: Collaborating on repositories with code quality features
|
||||||
intro: 'Workflow quality features like statuses, {% if currentVersion != "free-pro-team@latest" %}pre-receive hooks, {% endif %}protected branches, and required status checks help collaborators make contributions that meet conditions set by organization and repository administrators.'
|
intro: 'Workflow quality features like statuses, {% if enterpriseServerVersions contains currentVersion %}pre-receive hooks, {% endif %}protected branches, and required status checks help collaborators make contributions that meet conditions set by organization and repository administrators.'
|
||||||
mapTopic: true
|
mapTopic: true
|
||||||
redirect_from:
|
redirect_from:
|
||||||
- /articles/collaborating-on-repositories-with-code-quality-features-enabled/
|
- /articles/collaborating-on-repositories-with-code-quality-features-enabled/
|
||||||
|
|||||||
@@ -28,7 +28,7 @@ versions:
|
|||||||
{% link_in_list /what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility %}
|
{% link_in_list /what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility %}
|
||||||
{% topic_link_in_list /collaborating-on-repositories-with-code-quality-features %}
|
{% topic_link_in_list /collaborating-on-repositories-with-code-quality-features %}
|
||||||
{% link_in_list /about-status-checks %}
|
{% link_in_list /about-status-checks %}
|
||||||
<!-- if currentVersion != "free-pro-team@latest" -->
|
<!-- if enterpriseServerVersions contains currentVersion -->
|
||||||
{% link_in_list /working-with-pre-receive-hooks %}
|
{% link_in_list /working-with-pre-receive-hooks %}
|
||||||
<!-- endif -->
|
<!-- endif -->
|
||||||
{% topic_link_in_list /proposing-changes-to-your-work-with-pull-requests %}
|
{% topic_link_in_list /proposing-changes-to-your-work-with-pull-requests %}
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ versions:
|
|||||||
|
|
||||||
You can only resolve merge conflicts on {% data variables.product.product_name %} that are caused by competing line changes, such as when people make different changes to the same line of the same file on different branches in your Git repository. For all other types of merge conflicts, you must resolve the conflict locally on the command line. For more information, see "[Resolving a merge conflict using the command line](/articles/resolving-a-merge-conflict-using-the-command-line/)."
|
You can only resolve merge conflicts on {% data variables.product.product_name %} that are caused by competing line changes, such as when people make different changes to the same line of the same file on different branches in your Git repository. For all other types of merge conflicts, you must resolve the conflict locally on the command line. For more information, see "[Resolving a merge conflict using the command line](/articles/resolving-a-merge-conflict-using-the-command-line/)."
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
If a site administrator disables the merge conflict editor for pull requests between repositories, you cannot use the conflict editor on {% data variables.product.product_name %} and must resolve merge conflicts on the command line. For example, if the merge conflict editor is disabled, you cannot use it on a pull request between a fork and upstream repository.
|
If a site administrator disables the merge conflict editor for pull requests between repositories, you cannot use the conflict editor on {% data variables.product.product_name %} and must resolve merge conflicts on the command line. For example, if the merge conflict editor is disabled, you cannot use it on a pull request between a fork and upstream repository.
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
@@ -31,7 +31,7 @@ If a site administrator disables the merge conflict editor for pull requests bet
|
|||||||
|
|
||||||
{% tip %}
|
{% tip %}
|
||||||
|
|
||||||
**Tip:** If the **Resolve conflicts** button is deactivated, your pull request's merge conflict is too complex to resolve on {% data variables.product.product_name %}{% if currentVersion != "free-pro-team@latest" %} or the site administrator has disabled the conflict editor for pull requests between repositories{% endif %}. You must resolve the merge conflict using an alternative Git client, or by using Git on the command line. For more information see "[Resolving a merge conflict using the command line](/articles/resolving-a-merge-conflict-using-the-command-line)."
|
**Tip:** If the **Resolve conflicts** button is deactivated, your pull request's merge conflict is too complex to resolve on {% data variables.product.product_name %}{% if enterpriseServerVersions contains currentVersion %} or the site administrator has disabled the conflict editor for pull requests between repositories{% endif %}. You must resolve the merge conflict using an alternative Git client, or by using Git on the command line. For more information see "[Resolving a merge conflict using the command line](/articles/resolving-a-merge-conflict-using-the-command-line)."
|
||||||
|
|
||||||
{% endtip %}
|
{% endtip %}
|
||||||
{% data reusables.pull_requests.decide-how-to-resolve-competing-line-change-merge-conflict %}
|
{% data reusables.pull_requests.decide-how-to-resolve-competing-line-change-merge-conflict %}
|
||||||
|
|||||||
@@ -29,7 +29,7 @@ If a public repository is made private, its public forks are split off into a ne
|
|||||||
|
|
||||||
In other words, a public repository's forks will remain public in their own separate repository network even after the parent repository is made private. This allows the fork owners to continue to work and collaborate without interruption. If public forks were not moved into a separate network in this way, the owners of those forks would need to get the appropriate [access permissions](/articles/access-permissions-on-github) to pull changes from and submit pull requests to the (now private) parent repository—even though they didn't need those permissions before.
|
In other words, a public repository's forks will remain public in their own separate repository network even after the parent repository is made private. This allows the fork owners to continue to work and collaborate without interruption. If public forks were not moved into a separate network in this way, the owners of those forks would need to get the appropriate [access permissions](/articles/access-permissions-on-github) to pull changes from and submit pull requests to the (now private) parent repository—even though they didn't need those permissions before.
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
If a public repository has anonymous Git read access enabled and the repository is made private, all of the repository's forks will lose anonymous Git read access and return to the default disabled setting. If a forked repository is made public, repository administrators can re-enable anonymous Git read access. For more information, see "[Enabling anonymous Git read access for a repository](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository)."
|
If a public repository has anonymous Git read access enabled and the repository is made private, all of the repository's forks will lose anonymous Git read access and return to the default disabled setting. If a forked repository is made public, repository administrators can re-enable anonymous Git read access. 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 %}
|
{% endif %}
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Creating a commit with multiple authors
|
title: Creating a commit with multiple authors
|
||||||
intro: 'You can attribute a commit to more than one author by adding one or more `Co-authored-by` trailers to the commit''s message. Co-authored commits are visible on {% data variables.product.product_name %}{% if currentVersion != "free-pro-team@latest" %} and can be included in the profile contributions graph and the repository''s statistics{% endif %}.'
|
intro: 'You can attribute a commit to more than one author by adding one or more `Co-authored-by` trailers to the commit''s message. Co-authored commits are visible on {% data variables.product.product_name %}{% if enterpriseServerVersions contains currentVersion %} and can be included in the profile contributions graph and the repository''s statistics{% endif %}.'
|
||||||
redirect_from:
|
redirect_from:
|
||||||
- /articles/creating-a-commit-with-multiple-authors
|
- /articles/creating-a-commit-with-multiple-authors
|
||||||
versions:
|
versions:
|
||||||
@@ -68,7 +68,7 @@ After you've made changes in a file using the web editor on {% data variables.pr
|
|||||||
The new commit and message will appear on {% data variables.product.product_location %}.
|
The new commit and message will appear on {% data variables.product.product_location %}.
|
||||||
|
|
||||||
### Further reading
|
### Further reading
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
- "[Viewing contributions on your profile](/articles/viewing-contributions-on-your-profile)"
|
- "[Viewing contributions on your profile](/articles/viewing-contributions-on-your-profile)"
|
||||||
- "[Why are my contributions not showing up on my profile?](/articles/why-are-my-contributions-not-showing-up-on-my-profile)"{% endif %}
|
- "[Why are my contributions not showing up on my profile?](/articles/why-are-my-contributions-not-showing-up-on-my-profile)"{% endif %}
|
||||||
- "[Viewing a summary of repository activity](/articles/viewing-a-summary-of-repository-activity)"
|
- "[Viewing a summary of repository activity](/articles/viewing-a-summary-of-repository-activity)"
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ versions:
|
|||||||
|
|
||||||
When you create a repository, you can choose to make the repository public or private. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}If you're creating the repository in an organization{% if currentVersion == "free-pro-team@latest" %} that is owned by an enterprise account{% endif %}, you can also choose to make the repository internal.{% endif %}
|
When you create a repository, you can choose to make the repository public or private. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}If you're creating the repository in an organization{% if currentVersion == "free-pro-team@latest" %} that is owned by an enterprise account{% endif %}, you can also choose to make the repository internal.{% endif %}
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}If {% data variables.product.product_location_enterprise %} is not in private mode or behind a firewall, p{% else %}P{% endif %}ublic repositories are accessible to everyone on the internet.{% if currentVersion != "free-pro-team@latest" %} Otherwise, public repositories are available to everyone using {% data variables.product.product_location_enterprise %}, including outside collaborators.{% endif %} Private repositories are only accessible to you, people you explicitly share access with, and, for organization repositories, [certain organization members](/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization). {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}Internal repositories are accessible to {% if currentVersion == "free-pro-team@latest" %}members of your enterprise account{% else %}members of any organization on your instance{% endif %}. For more information, see "[About internal repositories](#about-internal-repositories)."{% endif %}
|
{% if enterpriseServerVersions contains currentVersion %}If {% data variables.product.product_location_enterprise %} is not in private mode or behind a firewall, p{% else %}P{% endif %}ublic repositories are accessible to everyone on the internet.{% if enterpriseServerVersions contains currentVersion %} Otherwise, public repositories are available to everyone using {% data variables.product.product_location_enterprise %}, including outside collaborators.{% endif %} Private repositories are only accessible to you, people you explicitly share access with, and, for organization repositories, [certain organization members](/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization). {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}Internal repositories are accessible to members of your enterprise. For more information, see "[About internal repositories](#about-internal-repositories)."{% endif %}
|
||||||
|
|
||||||
Organization owners always have access to every repository created in an organization. For more information, see "[Repository permission levels for an organization](/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization)."
|
Organization owners always have access to every repository created in an organization. For more information, see "[Repository permission levels for an organization](/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization)."
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Backing up a repository
|
title: Backing up a repository
|
||||||
intro: 'You can use{% if currentVersion != "free-pro-team@latest" %} Git and{% endif %} the API {% if currentVersion == "free-pro-team@latest" %}or a third-party tool {% endif %}to back up your repository.'
|
intro: 'You can use{% if enterpriseServerVersions contains currentVersion %} Git and{% endif %} the API {% if currentVersion == "free-pro-team@latest" %}or a third-party tool {% endif %}to back up your repository.'
|
||||||
redirect_from:
|
redirect_from:
|
||||||
- /articles/backing-up-a-repository
|
- /articles/backing-up-a-repository
|
||||||
versions:
|
versions:
|
||||||
@@ -30,7 +30,7 @@ When you clone a repository or wiki, only Git data, such as project files and co
|
|||||||
- [Projects](/v3/projects/#list-repository-projects)
|
- [Projects](/v3/projects/#list-repository-projects)
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
Once you have {% if currentVersion != "free-pro-team@latest" %}a local version of all the content you want to back up, you can create a zip archive and {% else %}downloaded your archive, you can {% endif %}copy it to an external hard drive and/or upload it to a cloud-based backup service such as [Google Drive](https://www.google.com/drive/) or [Dropbox](https://www.dropbox.com/).
|
Once you have {% if enterpriseServerVersions contains currentVersion %}a local version of all the content you want to back up, you can create a zip archive and {% else %}downloaded your archive, you can {% endif %}copy it to an external hard drive and/or upload it to a cloud-based backup service such as [Google Drive](https://www.google.com/drive/) or [Dropbox](https://www.dropbox.com/).
|
||||||
|
|
||||||
{% if currentVersion == "free-pro-team@latest" %}
|
{% if currentVersion == "free-pro-team@latest" %}
|
||||||
### Third-party backup tools
|
### Third-party backup tools
|
||||||
|
|||||||
@@ -1,6 +1,7 @@
|
|||||||
---
|
---
|
||||||
title: Creating a template repository
|
title: Creating a template repository
|
||||||
intro: 'You can make an existing repository a template, so you and others can generate new repositories with the same directory structure{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}, branches,{% endif %} and files.'
|
intro: 'You can make an existing repository a template, so you and others can generate new repositories with the same directory structure{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}, branches,{% endif %} and files.'
|
||||||
|
permissions: 'Anyone with admin permissions to a repository can make the repository a template.'
|
||||||
redirect_from:
|
redirect_from:
|
||||||
- /articles/creating-a-template-repository
|
- /articles/creating-a-template-repository
|
||||||
versions:
|
versions:
|
||||||
@@ -8,7 +9,11 @@ versions:
|
|||||||
enterprise-server: '*'
|
enterprise-server: '*'
|
||||||
---
|
---
|
||||||
|
|
||||||
Anyone with admin permissions to a repository can make the repository a template.
|
{% note %}
|
||||||
|
|
||||||
|
**Note**: Your template repository cannot include files stored using {% data variables.large_files.product_name_short %}.
|
||||||
|
|
||||||
|
{% endnote %}
|
||||||
|
|
||||||
To create a template repository, you must create a repository, then make the repository a template. For more information about creating a repository, see "[Creating a new repository](/articles/creating-a-new-repository)."
|
To create a template repository, you must create a repository, then make the repository a template. For more information about creating a repository, see "[Creating a new repository](/articles/creating-a-new-repository)."
|
||||||
|
|
||||||
@@ -16,5 +21,5 @@ After you make your repository a template, anyone with access to the repository
|
|||||||
|
|
||||||
{% data reusables.repositories.navigate-to-repo %}
|
{% data reusables.repositories.navigate-to-repo %}
|
||||||
{% data reusables.repositories.sidebar-settings %}
|
{% data reusables.repositories.sidebar-settings %}
|
||||||
3. Select **Template repository**.
|
1. Select **Template repository**.
|
||||||

|

|
||||||
|
|||||||
@@ -43,7 +43,7 @@ If the repository belongs to an organization and you're using an SSH key generat
|
|||||||
|
|
||||||
For more information, see [Adding a new SSH key to your GitHub account](/articles/adding-a-new-ssh-key-to-your-github-account).
|
For more information, see [Adding a new SSH key to your GitHub account](/articles/adding-a-new-ssh-key-to-your-github-account).
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
|
|
||||||
### Check if your instance is in private mode
|
### Check if your instance is in private mode
|
||||||
|
|
||||||
|
|||||||
@@ -72,7 +72,7 @@ When prompted for a username and password, make sure you use an account that has
|
|||||||
|
|
||||||
{% tip %}
|
{% tip %}
|
||||||
|
|
||||||
**Tip**: If you don't want to enter your credentials every time you interact with the remote repository, you can turn on [credential caching](/github/using-git/caching-your-github-credentials-in-git).
|
**Tip**: If you don't want to enter your credentials every time you interact with the remote repository, you can turn on [credential caching](/github/using-git/caching-your-github-credentials-in-git). If you are already using credential caching, please make sure that your computer has the correct credentials cached. Incorrect or out of date credentials will cause authentication to fail.
|
||||||
|
|
||||||
{% endtip %}
|
{% endtip %}
|
||||||
|
|
||||||
|
|||||||
@@ -37,7 +37,7 @@ Anyone with read permission for a repository can see {% data variables.product.p
|
|||||||
{% data reusables.repositories.navigate-to-repo %}
|
{% data reusables.repositories.navigate-to-repo %}
|
||||||
{% data reusables.repositories.sidebar-security %}
|
{% data reusables.repositories.sidebar-security %}
|
||||||
{% data reusables.repositories.sidebar-code-scanning-alerts %}
|
{% data reusables.repositories.sidebar-code-scanning-alerts %}
|
||||||
1. Under "{% data variables.product.prodname_code_scanning %}," click the alert you'd like to explore.
|
1. Under "{% data variables.product.prodname_code_scanning_capc %}," click the alert you'd like to explore.
|
||||||

|

|
||||||
1. Optionally, if the alert highlights a problem with data flow, click **Show paths** to display the path from the data source to the sink where it's used.
|
1. Optionally, if the alert highlights a problem with data flow, click **Show paths** to display the path from the data source to the sink where it's used.
|
||||||

|

|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
---
|
---
|
||||||
title: 'Running CodeQL code scanning in a container'
|
title: Running CodeQL code scanning in a container
|
||||||
shortTitle: '{% data variables.product.prodname_code_scanning_capc %} in a container'
|
shortTitle: '{% data variables.product.prodname_code_scanning_capc %} in a container'
|
||||||
intro: 'You can run {% data variables.product.prodname_code_scanning %} in a container by ensuring that all processes run in the same container.'
|
intro: 'You can run {% data variables.product.prodname_code_scanning %} in a container by ensuring that all processes run in the same container.'
|
||||||
product: '{% data reusables.gated-features.code-scanning %}'
|
product: '{% data reusables.gated-features.code-scanning %}'
|
||||||
|
|||||||
@@ -9,6 +9,7 @@ versions:
|
|||||||
free-pro-team: '*'
|
free-pro-team: '*'
|
||||||
enterprise-server: '>=2.22'
|
enterprise-server: '>=2.22'
|
||||||
---
|
---
|
||||||
|
<!--UI-LINK: When GitHub Enterprise Server doesn't have GitHub Actions set up, the Security > Code scanning alerts view links to this article.-->
|
||||||
|
|
||||||
{% data reusables.code-scanning.beta-codeql-runner %}
|
{% data reusables.code-scanning.beta-codeql-runner %}
|
||||||
{% data reusables.code-scanning.beta %}
|
{% data reusables.code-scanning.beta %}
|
||||||
@@ -65,7 +66,7 @@ The options for providing access to the {% data variables.product.prodname_codeq
|
|||||||
|
|
||||||
1. Allow the CI servers access to {% data variables.product.prodname_dotcom_the_website %} so that the {% data variables.product.prodname_codeql_runner %} can download the bundle automatically.
|
1. Allow the CI servers access to {% data variables.product.prodname_dotcom_the_website %} so that the {% data variables.product.prodname_codeql_runner %} can download the bundle automatically.
|
||||||
1. Manually download/extract the bundle, store it with other central resources, and use the `--codeql-path` flag to specify the location of the bundle in calls to initialize the {% data variables.product.prodname_codeql_runner %}.
|
1. Manually download/extract the bundle, store it with other central resources, and use the `--codeql-path` flag to specify the location of the bundle in calls to initialize the {% data variables.product.prodname_codeql_runner %}.
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
1. You can mirror the `github/codeql-action` repository on {% data variables.product.product_location %}. Unless you specify the <nobr>`--codeql-path`</nobr> flag, the runner automatically checks for the bundle in this location and on {% data variables.product.prodname_dotcom_the_website %}.{% endif %}
|
1. You can mirror the `github/codeql-action` repository on {% data variables.product.product_location %}. Unless you specify the <nobr>`--codeql-path`</nobr> flag, the runner automatically checks for the bundle in this location and on {% data variables.product.prodname_dotcom_the_website %}.{% endif %}
|
||||||
|
|
||||||
### Calling the {% data variables.product.prodname_codeql_runner %}
|
### Calling the {% data variables.product.prodname_codeql_runner %}
|
||||||
@@ -75,7 +76,7 @@ You should call the {% data variables.product.prodname_codeql_runner %} from the
|
|||||||
1. `init` required to initialize the runner and create a {% data variables.product.prodname_codeql %} database for each language to be analyzed. These databases are populated and analyzed by subsequent commands.
|
1. `init` required to initialize the runner and create a {% data variables.product.prodname_codeql %} database for each language to be analyzed. These databases are populated and analyzed by subsequent commands.
|
||||||
1. `analyze` required to populate the {% data variables.product.prodname_codeql %} databases, analyze them, and upload results to {% data variables.product.product_location %}.
|
1. `analyze` required to populate the {% data variables.product.prodname_codeql %} databases, analyze them, and upload results to {% data variables.product.product_location %}.
|
||||||
|
|
||||||
For both commands, you must specify the URL of {% data variables.product.product_location %}, the repository *OWNER/NAME*, and the GitHub Apps or personal access token to use for authentication. You also need to specify the location of the CodeQL bundle unless the CI server has access to download it directly from the `github/codeql-action` repository on {% data variables.product.prodname_dotcom_the_website %}{% if currentVersion != "free-pro-team@latest" %} or mirrored on {% data variables.product.product_location %}{% endif %}.
|
For both commands, you must specify the URL of {% data variables.product.product_location %}, the repository *OWNER/NAME*, and the GitHub Apps or personal access token to use for authentication. You also need to specify the location of the CodeQL bundle unless the CI server has access to download it directly from the `github/codeql-action` repository on {% data variables.product.prodname_dotcom_the_website %}{% if enterpriseServerVersions contains currentVersion %} or mirrored on {% data variables.product.product_location %}{% endif %}.
|
||||||
|
|
||||||
You can configure where the {% data variables.product.prodname_codeql_runner %} stores the CodeQL bundle for future analysis on a server using the <nobr>`--tools-dir`</nobr> flag and where it stores temporary files during analysis using <nobr>`--temp-dir`</nobr>.
|
You can configure where the {% data variables.product.prodname_codeql_runner %} stores the CodeQL bundle for future analysis on a server using the <nobr>`--tools-dir`</nobr> flag and where it stores temporary files during analysis using <nobr>`--temp-dir`</nobr>.
|
||||||
|
|
||||||
@@ -109,7 +110,7 @@ This example runs {% data variables.product.prodname_codeql %} analysis on a Lin
|
|||||||
> Successfully uploaded results
|
> Successfully uploaded results
|
||||||
```
|
```
|
||||||
|
|
||||||
The server has access to download the {% data variables.product.prodname_codeql %} bundle directly from the `github/codeql-action` repository on {% data variables.product.prodname_dotcom_the_website %}{% if currentVersion != "free-pro-team@latest" %} or mirrored on {% data variables.product.product_location %}{% endif %}, so there is no need to use the `--codeql-path` flag. When the analysis is complete, the {% data variables.product.prodname_codeql_runner %} uploads the results to the {% data variables.product.prodname_code_scanning %} view. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository)."
|
The server has access to download the {% data variables.product.prodname_codeql %} bundle directly from the `github/codeql-action` repository on {% data variables.product.prodname_dotcom_the_website %}{% if enterpriseServerVersions contains currentVersion %} or mirrored on {% data variables.product.product_location %}{% endif %}, so there is no need to use the `--codeql-path` flag. When the analysis is complete, the {% data variables.product.prodname_codeql_runner %} uploads the results to the {% data variables.product.prodname_code_scanning %} view. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository)."
|
||||||
|
|
||||||
#### Compiled language example
|
#### Compiled language example
|
||||||
|
|
||||||
|
|||||||
@@ -36,6 +36,8 @@ If you upload a SARIF file without fingerprint data using the `/code-scanning/sa
|
|||||||
|
|
||||||
### Validating your SARIF file
|
### Validating your SARIF file
|
||||||
|
|
||||||
|
<!--UI-LINK: When code scanning fails, the error banner shown in the Security > Code scanning alerts view links to this anchor.-->
|
||||||
|
|
||||||
You can check a SARIF file is compatible with {% data variables.product.prodname_code_scanning %} by testing it against the {% data variables.product.prodname_dotcom %} ingestion rules. For more information, visit the [Microsoft SARIF validator](https://sarifweb.azurewebsites.net/).
|
You can check a SARIF file is compatible with {% data variables.product.prodname_code_scanning %} by testing it against the {% data variables.product.prodname_dotcom %} ingestion rules. For more information, visit the [Microsoft SARIF validator](https://sarifweb.azurewebsites.net/).
|
||||||
|
|
||||||
### Supported SARIF output file properties
|
### Supported SARIF output file properties
|
||||||
|
|||||||
@@ -96,7 +96,7 @@ For more information about hosting your own instance of [{% data variables.produ
|
|||||||
|
|
||||||
- {% data variables.contact.github_support %} {% data variables.product.premium_plus_support_plan %}
|
- {% data variables.contact.github_support %} {% data variables.product.premium_plus_support_plan %}
|
||||||
- {% data variables.product.prodname_insights %}
|
- {% data variables.product.prodname_insights %}
|
||||||
- {% data variables.product.prodname_advanced_security %}{% if currentVersion == "free-pro-team@latest" %}. For more information, see "[About {% data variables.product.prodname_code_scanning %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning)" and "[About {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/about-secret-scanning) (beta)."{% endif %}{% if currentVersion != "free-pro-team@latest" and currentVersion ver_gt "enterprise-server@2.21" %}. For more information, see "[About {% data variables.product.prodname_code_scanning %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning) (beta)."{% endif %}
|
- {% data variables.product.prodname_advanced_security %}{% if currentVersion == "free-pro-team@latest" %}. For more information, see "[About {% data variables.product.prodname_code_scanning %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning)" and "[About {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/about-secret-scanning) (beta)."{% endif %}{% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" %}. For more information, see "[About {% data variables.product.prodname_code_scanning %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning) (beta)."{% endif %}
|
||||||
- [{% data variables.product.prodname_learning %} for organizations](https://lab.github.com/organizations)
|
- [{% data variables.product.prodname_learning %} for organizations](https://lab.github.com/organizations)
|
||||||
|
|
||||||
For more information about signing up for {% data variables.product.prodname_ghe_one %}, contact [{% data variables.product.product_name %}'s Sales team](https://enterprise.github.com/contact).
|
For more information about signing up for {% data variables.product.prodname_ghe_one %}, contact [{% data variables.product.product_name %}'s Sales team](https://enterprise.github.com/contact).
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ redirect_from:
|
|||||||
- /articles/why-doesn-t-graphs-work-with-ie-8/
|
- /articles/why-doesn-t-graphs-work-with-ie-8/
|
||||||
- /articles/why-don-t-graphs-work-with-ie8/
|
- /articles/why-don-t-graphs-work-with-ie8/
|
||||||
- /articles/supported-browsers
|
- /articles/supported-browsers
|
||||||
intro: 'We design {% data variables.product.product_name %} to support the latest web browsers. We support the current versions of [Chrome](https://www.google.com/chrome/), [Firefox](http://www.mozilla.org/firefox/), [Safari](http://www.apple.com/safari/), {% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.16" %}Internet Explorer 11, {% endif %}and [Microsoft Edge](https://www.microsoft.com/en-us/windows/microsoft-edge).'
|
intro: 'We design {% data variables.product.product_name %} to support the latest web browsers. We support the current versions of [Chrome](https://www.google.com/chrome/), [Firefox](http://www.mozilla.org/firefox/), [Safari](http://www.apple.com/safari/), and [Microsoft Edge](https://www.microsoft.com/en-us/windows/microsoft-edge).'
|
||||||
versions:
|
versions:
|
||||||
free-pro-team: '*'
|
free-pro-team: '*'
|
||||||
enterprise-server: '*'
|
enterprise-server: '*'
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ Files that you add to a repository via a browser are limited to {% data variable
|
|||||||
{% endtip %}
|
{% endtip %}
|
||||||
|
|
||||||
{% data reusables.repositories.navigate-to-repo %}
|
{% data reusables.repositories.navigate-to-repo %}
|
||||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
|
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
|
||||||
2. Under your repository name, click **Upload files**.
|
2. Under your repository name, click **Upload files**.
|
||||||

|

|
||||||
{% else %}
|
{% else %}
|
||||||
|
|||||||
@@ -39,11 +39,13 @@ size 84977953
|
|||||||
|
|
||||||
It tracks the `version` of {% data variables.large_files.product_name_short %} you're using, followed by a unique identifier for the file (`oid`). It also stores the `size` of the final file.
|
It tracks the `version` of {% data variables.large_files.product_name_short %} you're using, followed by a unique identifier for the file (`oid`). It also stores the `size` of the final file.
|
||||||
|
|
||||||
{% tip %}
|
{% note %}
|
||||||
|
|
||||||
**Tip**: {% data variables.large_files.product_name_short %} cannot be used with {% data variables.product.prodname_pages %} sites.
|
**Notes**:
|
||||||
|
- {% data variables.large_files.product_name_short %} cannot be used with {% data variables.product.prodname_pages %} sites.
|
||||||
|
- {% data variables.large_files.product_name_short %} cannot be used with template repositories.
|
||||||
|
|
||||||
{% endtip %}
|
{% endnote %}
|
||||||
|
|
||||||
### Further reading
|
### Further reading
|
||||||
|
|
||||||
|
|||||||
@@ -16,4 +16,4 @@ If you attempt to add or update a file that is larger than {% data variables.lar
|
|||||||
|
|
||||||
### Blocked pushes for large files
|
### Blocked pushes for large files
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}By default, {% endif %}{% data variables.product.product_name %} blocks pushes that exceed {% data variables.large_files.max_github_size %}. {% if currentVersion != "free-pro-team@latest" %}However, a site administrator can configure a different limit for your {% data variables.product.prodname_ghe_server %} instance. For more information, see "[Setting Git push limits](/enterprise/{{ currentVersion }}/admin/guides/installation/setting-git-push-limits)".{% endif %}
|
{% if enterpriseServerVersions contains currentVersion %}By default, {% endif %}{% data variables.product.product_name %} blocks pushes that exceed {% data variables.large_files.max_github_size %}. {% if enterpriseServerVersions contains currentVersion %}However, a site administrator can configure a different limit for your {% data variables.product.prodname_ghe_server %} instance. For more information, see "[Setting Git push limits](/enterprise/{{ currentVersion }}/admin/guides/installation/setting-git-push-limits)".{% endif %}
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ If there are existing files in your repository that you'd like to use {% data va
|
|||||||
|
|
||||||
{% data reusables.large_files.resolving-upload-failures %}
|
{% data reusables.large_files.resolving-upload-failures %}
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
|
|
||||||
{% tip %}
|
{% tip %}
|
||||||
|
|
||||||
|
|||||||
@@ -52,7 +52,7 @@ You can also enable or disable {% data variables.product.prodname_dependabot %}
|
|||||||
When {% data variables.product.product_name %} identifies a vulnerable dependency, we send a {% data variables.product.prodname_dependabot_short %} alert to the maintainers of affected repositories with details of the vulnerability, a link to the affected file in the project, and information about a fixed version. {% if currentVersion == "free-pro-team@latest" %}For repositories that have enabled {% data variables.product.prodname_dependabot_security_updates %}, the alert also contains a link to a pull request to update the manifest or lock file to the minimum version that resolves the vulnerability. For more information, see "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-github-dependabot-security-updates)."{% endif %}
|
When {% data variables.product.product_name %} identifies a vulnerable dependency, we send a {% data variables.product.prodname_dependabot_short %} alert to the maintainers of affected repositories with details of the vulnerability, a link to the affected file in the project, and information about a fixed version. {% if currentVersion == "free-pro-team@latest" %}For repositories that have enabled {% data variables.product.prodname_dependabot_security_updates %}, the alert also contains a link to a pull request to update the manifest or lock file to the minimum version that resolves the vulnerability. For more information, see "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-github-dependabot-security-updates)."{% endif %}
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
|
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
|
||||||
When {% data variables.product.product_name %} identifies a vulnerable dependency, we send a security alert to the maintainers of affected repositories with details of the vulnerability, a link to the affected file in the project, and information about a fixed version.
|
When {% data variables.product.product_name %} identifies a vulnerable dependency, we send a security alert to the maintainers of affected repositories with details of the vulnerability, a link to the affected file in the project, and information about a fixed version.
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
@@ -70,7 +70,7 @@ You can see all of the alerts that affect a particular project{% if currentVersi
|
|||||||
We send {% data variables.product.prodname_dependabot_short %} alerts to people with admin permissions in the affected repositories by default. {% data variables.product.product_name %} never publicly discloses identified vulnerabilities for any repository.{% if currentVersion == "free-pro-team@latest" %} You can also enable {% data variables.product.prodname_dependabot_short %} alerts for additional people or teams working repositories that you own or have admin permissions for. 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-github-dependabot-alerts)."{% endif %}
|
We send {% data variables.product.prodname_dependabot_short %} alerts to people with admin permissions in the affected repositories by default. {% data variables.product.product_name %} never publicly discloses identified vulnerabilities for any repository.{% if currentVersion == "free-pro-team@latest" %} You can also enable {% data variables.product.prodname_dependabot_short %} alerts for additional people or teams working repositories that you own or have admin permissions for. 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-github-dependabot-alerts)."{% endif %}
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
|
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
|
||||||
We send security alerts to people with admin permissions in the affected repositories by default. {% data variables.product.product_name %} never publicly discloses identified vulnerabilities for any repository.
|
We send security alerts to people with admin permissions in the affected repositories by default. {% data variables.product.product_name %} never publicly discloses identified vulnerabilities for any repository.
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
@@ -80,20 +80,20 @@ We send security alerts to people with admin permissions in the affected reposit
|
|||||||
By default, you will receive {% data variables.product.prodname_dependabot_alerts %} by email, grouped by the specific vulnerability. You can also choose to receive {% data variables.product.prodname_dependabot_alerts %} in a weekly email summarizing alerts for up to 10 of your repositories, in your web notifications, or in the {% data variables.product.product_name %} user interface. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#github-dependabot-alerts-notification-options)."
|
By default, you will receive {% data variables.product.prodname_dependabot_alerts %} by email, grouped by the specific vulnerability. You can also choose to receive {% data variables.product.prodname_dependabot_alerts %} in a weekly email summarizing alerts for up to 10 of your repositories, in your web notifications, or in the {% data variables.product.product_name %} user interface. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#github-dependabot-alerts-notification-options)."
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_gt "enterprise-server@2.21" %}
|
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" %}
|
||||||
By default, if your site administrator has configured email for notifications on your instance, you will receive {% data variables.product.prodname_dependabot_alerts %} by email. You can also choose to receive {% data variables.product.prodname_dependabot_alerts %} in a weekly email summarizing alerts for up to 10 of your repositories, in your web notifications, or in the {% data variables.product.product_name %} user interface. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#github-dependabot-alerts-notification-options)."
|
By default, if your site administrator has configured email for notifications on your instance, you will receive {% data variables.product.prodname_dependabot_alerts %} by email. You can also choose to receive {% data variables.product.prodname_dependabot_alerts %} in a weekly email summarizing alerts for up to 10 of your repositories, in your web notifications, or in the {% data variables.product.product_name %} user interface. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#github-dependabot-alerts-notification-options)."
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" and currentVersion == "enterprise-server@2.21" %}
|
{% if enterpriseServerVersions contains currentVersion and currentVersion == "enterprise-server@2.21" %}
|
||||||
By default, if your site administrator has configured email for notifications on your instance, you will receive security alerts by email. You can also choose to receive security alerts in a weekly email summarizing alerts for up to 10 of your repositories, in your web notifications, or in the {% data variables.product.product_name %} user interface. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#security-alert-notification-options)."
|
By default, if your site administrator has configured email for notifications on your instance, you will receive security alerts by email. You can also choose to receive security alerts in a weekly email summarizing alerts for up to 10 of your repositories, in your web notifications, or in the {% data variables.product.product_name %} user interface. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#security-alert-notification-options)."
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.21" %}
|
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.21" %}
|
||||||
By default, if your site administrator has configured email for notifications on your instance, you will receive security alerts by email. You can also choose to receive security alerts in a weekly email summarizing alerts for up to 10 of your repositories, in your web notifications, or in the {% data variables.product.product_name %} user interface. For more information, see "[Choosing the delivery method for your notifications
|
By default, if your site administrator has configured email for notifications on your instance, you will receive security alerts by email. You can also choose to receive security alerts in a weekly email summarizing alerts for up to 10 of your repositories, in your web notifications, or in the {% data variables.product.product_name %} user interface. For more information, see "[Choosing the delivery method for your notifications
|
||||||
](/github/receiving-notifications-about-activity-on-github/choosing-the-delivery-method-for-your-notifications)."
|
](/github/receiving-notifications-about-activity-on-github/choosing-the-delivery-method-for-your-notifications)."
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_gt "enterprise-server@2.20" % %}
|
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.20" % %}
|
||||||
|
|
||||||
{% if currentVersion ver_gt "enterprise-server@2.21" %}Site administrators can also enable {% data variables.product.prodname_dependabot_alerts %} without notifications. For more information, see "[Enabling {% data variables.product.prodname_dependabot_short %} alerts for vulnerable dependencies on {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server)."{% endif %}
|
{% if currentVersion ver_gt "enterprise-server@2.21" %}Site administrators can also enable {% data variables.product.prodname_dependabot_alerts %} without notifications. For more information, see "[Enabling {% data variables.product.prodname_dependabot_short %} alerts for vulnerable dependencies on {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server)."{% endif %}
|
||||||
|
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ versions:
|
|||||||
---
|
---
|
||||||
{% warning %}
|
{% warning %}
|
||||||
|
|
||||||
**Warning:** If you add an image to a pull request or issue comment, anyone can view the anonymized image URL without authentication, even if the pull request is in a private repository{% if currentVersion != "free-pro-team@latest" %}, or if private mode is enabled{% endif %}. To keep sensitive images private, serve them from a private network or server that requires authentication. {% if currentVersion == "free-pro-team@latest" %}For more information on anonymized URLs see "[About anonymized image URLs](/articles/about-anonymized-image-urls)".{% endif %}
|
**Warning:** If you add an image to a pull request or issue comment, anyone can view the anonymized image URL without authentication, even if the pull request is in a private repository{% if enterpriseServerVersions contains currentVersion %}, or if private mode is enabled{% endif %}. To keep sensitive images private, serve them from a private network or server that requires authentication. {% if currentVersion == "free-pro-team@latest" %}For more information on anonymized URLs see "[About anonymized image URLs](/articles/about-anonymized-image-urls)".{% endif %}
|
||||||
|
|
||||||
{% endwarning %}
|
{% endwarning %}
|
||||||
|
|
||||||
|
|||||||
@@ -18,7 +18,7 @@ versions:
|
|||||||
{% endtip %}
|
{% endtip %}
|
||||||
|
|
||||||
{% data reusables.repositories.navigate-to-repo %}
|
{% data reusables.repositories.navigate-to-repo %}
|
||||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
|
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
|
||||||
2. Under your repository name, click **Find file**.
|
2. Under your repository name, click **Find file**.
|
||||||

|

|
||||||
{% else %}
|
{% else %}
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ versions:
|
|||||||
|
|
||||||
You can search for packages globally across all of {% data variables.product.product_name %}, or search for packages within a particular organization. For more information, see "[About searching on {% data variables.product.prodname_dotcom %}](/articles/about-searching-on-github)."
|
You can search for packages globally across all of {% data variables.product.product_name %}, or search for packages within a particular organization. For more information, see "[About searching on {% data variables.product.prodname_dotcom %}](/articles/about-searching-on-github)."
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
You can only search for packages on {% data variables.product.product_location_enterprise %}, not {% data variables.product.prodname_dotcom_the_website %}, even if {% data variables.product.prodname_github_connect %} is enabled.
|
You can only search for packages on {% data variables.product.product_location_enterprise %}, not {% data variables.product.prodname_dotcom_the_website %}, even if {% data variables.product.prodname_github_connect %} is enabled.
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ You can search for issues and pull requests globally across all of {% data varia
|
|||||||
|
|
||||||
{% tip %}
|
{% tip %}
|
||||||
|
|
||||||
**Tips:**{% if currentVersion != "free-pro-team@latest" %}
|
**Tips:**{% if enterpriseServerVersions contains currentVersion %}
|
||||||
- This article contains example searches on the {% data variables.product.prodname_dotcom %}.com website, but you can use the same search filters on {% data variables.product.product_location_enterprise %}.{% endif %}
|
- This article contains example searches on the {% data variables.product.prodname_dotcom %}.com website, but you can use the same search filters on {% data variables.product.product_location_enterprise %}.{% endif %}
|
||||||
- For a list of search syntaxes that you can add to any search qualifier to further improve your results, see "[Understanding the search syntax](/articles/understanding-the-search-syntax)".
|
- For a list of search syntaxes that you can add to any search qualifier to further improve your results, see "[Understanding the search syntax](/articles/understanding-the-search-syntax)".
|
||||||
- Use quotations around multi-word search terms. For example, if you want to search for issues with the label "In progress," you'd search for `label:"in progress"`. Search is not case sensitive.
|
- Use quotations around multi-word search terms. For example, if you want to search for issues with the label "In progress," you'd search for `label:"in progress"`. Search is not case sensitive.
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ For more information, see:
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
|
|
||||||
You can also use LDAP Sync to synchronize {% data variables.product.product_location_enterprise %} team members and team roles against your established LDAP groups. This lets you establish role-based access control for users from your LDAP server instead of manually within {% data variables.product.product_location_enterprise %}. For more information, see "[Enabling LDAP Sync](/enterprise/admin/authentication/using-ldap#enabling-ldap-sync)."
|
You can also use LDAP Sync to synchronize {% data variables.product.product_location_enterprise %} team members and team roles against your established LDAP groups. This lets you establish role-based access control for users from your LDAP server instead of manually within {% data variables.product.product_location_enterprise %}. For more information, see "[Enabling LDAP Sync](/enterprise/admin/authentication/using-ldap#enabling-ldap-sync)."
|
||||||
|
|
||||||
@@ -55,7 +55,7 @@ To easily understand who shares a parent team's permissions and mentions, you ca
|
|||||||
|
|
||||||
You can choose a parent when you create the team, or you can move a team in your organization's hierarchy later. For more information see, "[Moving a team in your organization’s hierarchy](/articles/moving-a-team-in-your-organization-s-hierarchy)."
|
You can choose a parent when you create the team, or you can move a team in your organization's hierarchy later. For more information see, "[Moving a team in your organization’s hierarchy](/articles/moving-a-team-in-your-organization-s-hierarchy)."
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
|
|
||||||
{% data reusables.enterprise_user_management.ldap-sync-nested-teams %}
|
{% data reusables.enterprise_user_management.ldap-sync-nested-teams %}
|
||||||
|
|
||||||
|
|||||||
@@ -28,7 +28,7 @@ In the left sidebar of your dashboard, you can access your organization's top re
|
|||||||
|
|
||||||
In the "All activity" section of your news feed, you can view updates from other teams and repositories in your organization.
|
In the "All activity" section of your news feed, you can view updates from other teams and repositories in your organization.
|
||||||
|
|
||||||
The "All activity" section shows all recent activity in the organization, including activity in repositories you're not subscribed to and of people you're not following. For more information, see {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}"About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications){% else %}"[Watching and unwatching repositories](/github/receiving-notifications-about-activity-on-github/watching-and-unwatching-repositories){% endif %}" and "[Following people](/articles/following-people)."
|
The "All activity" section shows all recent activity in the organization, including activity in repositories you're not subscribed to and of people you're not following. For more information, see {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}"[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications){% else %}"[Watching and unwatching repositories](/github/receiving-notifications-about-activity-on-github/watching-and-unwatching-repositories){% endif %}" and "[Following people](/articles/following-people)."
|
||||||
|
|
||||||
For instance, the organization news feed shows updates when someone in the organization:
|
For instance, the organization news feed shows updates when someone in the organization:
|
||||||
- Creates a new branch.
|
- Creates a new branch.
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ You can enable {% data variables.product.prodname_actions %} for all repositorie
|
|||||||
|
|
||||||
Alternatively, you can enable {% data variables.product.prodname_actions %} for all repositories in your organization but limit the actions a workflow can run. {% data reusables.github-actions.enabled-local-github-actions %}
|
Alternatively, you can enable {% data variables.product.prodname_actions %} for all repositories in your organization but limit the actions a workflow can run. {% data reusables.github-actions.enabled-local-github-actions %}
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.23" %}
|
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.23" %}
|
||||||
|
|
||||||
### Managing {% data variables.product.prodname_actions %} permissions for your organization
|
### Managing {% data variables.product.prodname_actions %} permissions for your organization
|
||||||
|
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ versions:
|
|||||||
|
|
||||||
You can control whether members of your organization can publish websites from repositories in your organization using {% data variables.product.prodname_pages %}. For more information about {% data variables.product.prodname_pages %}, see "[About {% data variables.product.prodname_pages %}](/github/working-with-github-pages/about-github-pages)."
|
You can control whether members of your organization can publish websites from repositories in your organization using {% data variables.product.prodname_pages %}. For more information about {% data variables.product.prodname_pages %}, see "[About {% data variables.product.prodname_pages %}](/github/working-with-github-pages/about-github-pages)."
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}If your site administrator has enabled Public Pages, {% endif %}{% data variables.product.prodname_pages %} sites are publicly available on the internet, even if the repository for the site is private{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} or internal{% endif %}. For more information, see{% if currentVersion != "free-pro-team@latest" %} "[Configuring {% data variables.product.prodname_pages %} on your appliance](/enterprise/admin/installation/configuring-github-pages-on-your-appliance#making-github-pages-publicly-accessible)" and{% endif %} "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility)."
|
{% if enterpriseServerVersions contains currentVersion %}If your site administrator has enabled Public Pages, {% endif %}{% data variables.product.prodname_pages %} sites are publicly available on the internet, even if the repository for the site is private{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} or internal{% endif %}. For more information, see{% if enterpriseServerVersions contains currentVersion %} "[Configuring {% data variables.product.prodname_pages %} on your appliance](/enterprise/admin/installation/configuring-github-pages-on-your-appliance#making-github-pages-publicly-accessible)" and{% endif %} "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility)."
|
||||||
|
|
||||||
### Disabling publication of {% data variables.product.prodname_pages %} sites
|
### Disabling publication of {% data variables.product.prodname_pages %} sites
|
||||||
|
|
||||||
|
|||||||
@@ -127,7 +127,7 @@ versions:
|
|||||||
{% link_in_list /disabling-publication-of-github-pages-sites-for-your-organization %}
|
{% link_in_list /disabling-publication-of-github-pages-sites-for-your-organization %}
|
||||||
{% link_in_list /deleting-an-organization-account %}
|
{% link_in_list /deleting-an-organization-account %}
|
||||||
{% link_in_list /converting-an-organization-into-a-user %}
|
{% link_in_list /converting-an-organization-into-a-user %}
|
||||||
<!-- if currentVersion != "free-pro-team@latest" -->
|
<!-- if enterpriseServerVersions contains currentVersion -->
|
||||||
{% link_in_list /integrating-jira-with-your-organization-project-board %}
|
{% link_in_list /integrating-jira-with-your-organization-project-board %}
|
||||||
<!-- endif -->
|
<!-- endif -->
|
||||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||||
|
|||||||
@@ -47,7 +47,7 @@ To search for specific events, use the `action` qualifier in your query. Actions
|
|||||||
| `repository_content_analysis` | Contains all activities related to [enabling or disabling data use for a private repository](/articles/about-github-s-use-of-your-data).
|
| `repository_content_analysis` | Contains all activities related to [enabling or disabling data use for a private repository](/articles/about-github-s-use-of-your-data).
|
||||||
| `repository_dependency_graph` | Contains all activities related to [enabling or disabling the dependency graph for a private repository](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-and-dependents-of-a-repository).{% endif %}
|
| `repository_dependency_graph` | Contains all activities related to [enabling or disabling the dependency graph for a private repository](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-and-dependents-of-a-repository).{% endif %}
|
||||||
| `repository_vulnerability_alert` | Contains all activities related to [{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_short %}{% else %}security{% endif %} alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies).{% if currentVersion == "free-pro-team@latest" %}
|
| `repository_vulnerability_alert` | Contains all activities related to [{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_short %}{% else %}security{% endif %} alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies).{% if currentVersion == "free-pro-team@latest" %}
|
||||||
| `sponsors` | Contains all events related to sponsor buttons (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)"){% endif %}{% if currentVersion != "free-pro-team@latest" %}
|
| `sponsors` | Contains all events related to sponsor buttons (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)"){% endif %}{% if enterpriseServerVersions contains currentVersion %}
|
||||||
| `team` | Contains all activities related to teams in your organization.{% endif %}
|
| `team` | Contains all activities related to teams in your organization.{% endif %}
|
||||||
| `team_discussions` | Contains activities related to managing team discussions for an organization.
|
| `team_discussions` | Contains activities related to managing team discussions for an organization.
|
||||||
|
|
||||||
@@ -85,7 +85,7 @@ This list describes the available categories and associated events:
|
|||||||
- [The `repository_content_analysis` category](#the-repository_content_analysis-category)
|
- [The `repository_content_analysis` category](#the-repository_content_analysis-category)
|
||||||
- [The `repository_dependency_graph` category](#the-repository_dependency_graph-category){% endif %}
|
- [The `repository_dependency_graph` category](#the-repository_dependency_graph-category){% endif %}
|
||||||
- [The `repository_vulnerability_alert` category](#the-repository_vulnerability_alert-category){% if currentVersion == "free-pro-team@latest" %}
|
- [The `repository_vulnerability_alert` category](#the-repository_vulnerability_alert-category){% if currentVersion == "free-pro-team@latest" %}
|
||||||
- [The `sponsors` category](#the-sponsors-category){% endif %}{% if currentVersion != "free-pro-team@latest" %}
|
- [The `sponsors` category](#the-sponsors-category){% endif %}{% if enterpriseServerVersions contains currentVersion %}
|
||||||
- [The `team` category](#the-team-category){% endif %}
|
- [The `team` category](#the-team-category){% endif %}
|
||||||
- [The `team_discussions` category](#the-team_discussions-category)
|
- [The `team_discussions` category](#the-team_discussions-category)
|
||||||
|
|
||||||
@@ -300,7 +300,7 @@ For more information, see "[Restricting publication of {% data variables.product
|
|||||||
| `access` | Triggered when a repository owned by an organization is [switched from "private" to "public"](/articles/making-a-private-repository-public) (or vice versa).
|
| `access` | Triggered when a repository owned by an organization is [switched from "private" to "public"](/articles/making-a-private-repository-public) (or vice versa).
|
||||||
| `add_member` | Triggered when a user accepts an [invitation to have collaboration access to a repository](/articles/inviting-collaborators-to-a-personal-repository).
|
| `add_member` | Triggered when a user accepts an [invitation to have collaboration access to a repository](/articles/inviting-collaborators-to-a-personal-repository).
|
||||||
| `add_topic` | Triggered when a repository admin [adds a topic](/articles/classifying-your-repository-with-topics) to a repository.
|
| `add_topic` | Triggered when a repository admin [adds a topic](/articles/classifying-your-repository-with-topics) to a repository.
|
||||||
| `archived` | Triggered when a repository admin [archives a repository](/articles/about-archiving-repositories).{% if currentVersion != "free-pro-team@latest" %}
|
| `archived` | Triggered when a repository admin [archives a repository](/articles/about-archiving-repositories).{% if enterpriseServerVersions contains currentVersion %}
|
||||||
| `config.disable_anonymous_git_access` | Triggered when [anonymous Git read access is disabled](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository) in a public repository.
|
| `config.disable_anonymous_git_access` | Triggered when [anonymous Git read access is disabled](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository) in a public repository.
|
||||||
| `config.enable_anonymous_git_access` | Triggered when [anonymous Git read access is enabled](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository) in a public repository.
|
| `config.enable_anonymous_git_access` | Triggered when [anonymous Git read access is enabled](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository) in a public repository.
|
||||||
| `config.lock_anonymous_git_access` | Triggered when a repository's [anonymous Git read access setting is locked](/enterprise/{{ currentVersion }}/admin/guides/user-management/preventing-users-from-changing-anonymous-git-read-access).
|
| `config.lock_anonymous_git_access` | Triggered when a repository's [anonymous Git read access setting is locked](/enterprise/{{ currentVersion }}/admin/guides/user-management/preventing-users-from-changing-anonymous-git-read-access).
|
||||||
@@ -351,7 +351,7 @@ For more information, see "[Restricting publication of {% data variables.product
|
|||||||
| repo_funding_links_file_action | Triggered when you change the FUNDING file in your repository (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)")
|
| repo_funding_links_file_action | Triggered when you change the FUNDING file in your repository (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)")
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
##### The `team` category
|
##### The `team` category
|
||||||
|
|
||||||
| Action | Description
|
| Action | Description
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ On your profile page, certain actions count as contributions:
|
|||||||
- Committing to a repository's default branch or `gh-pages` branch
|
- Committing to a repository's default branch or `gh-pages` branch
|
||||||
- Opening an issue
|
- Opening an issue
|
||||||
- Proposing a pull request
|
- Proposing a pull request
|
||||||
- Submitting a pull request review{% if currentVersion != "free-pro-team@latest" %}
|
- Submitting a pull request review{% if enterpriseServerVersions contains currentVersion %}
|
||||||
- Co-authoring commits in a repository's default branch or `gh-pages` branch{% endif %}
|
- Co-authoring commits in a repository's default branch or `gh-pages` branch{% endif %}
|
||||||
|
|
||||||
{% data reusables.pull_requests.pull_request_merges_and_contributions %}
|
{% data reusables.pull_requests.pull_request_merges_and_contributions %}
|
||||||
|
|||||||
@@ -29,10 +29,10 @@ In addition, **at least one** of the following must be true:
|
|||||||
- You have forked the repository.
|
- You have forked the repository.
|
||||||
- You have opened a pull request or issue in the repository.
|
- You have opened a pull request or issue in the repository.
|
||||||
- You have starred the repository.
|
- You have starred the repository.
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
|
||||||
### Common reasons that contributions are not counted
|
### Common reasons that contributions are not counted
|
||||||
|
|
||||||
{% data reusables.pull_requests.pull_request_merges_and_contributions %}{% endif %}
|
{% data reusables.pull_requests.pull_request_merges_and_contributions %}
|
||||||
|
|
||||||
#### Commit was made less than 24 hours ago
|
#### Commit was made less than 24 hours ago
|
||||||
|
|
||||||
|
|||||||
@@ -24,7 +24,7 @@ versions:
|
|||||||
{% link_in_list /managing-the-default-branch-name-for-your-repositories %}
|
{% link_in_list /managing-the-default-branch-name-for-your-repositories %}
|
||||||
{% link_in_list /managing-security-and-analysis-settings-for-your-user-account %}
|
{% link_in_list /managing-security-and-analysis-settings-for-your-user-account %}
|
||||||
{% link_in_list /managing-access-to-your-user-accounts-project-boards %}
|
{% link_in_list /managing-access-to-your-user-accounts-project-boards %}
|
||||||
<!-- if currentVersion != "free-pro-team@latest" -->
|
<!-- if enterpriseServerVersions contains currentVersion -->
|
||||||
{% link_in_list /integrating-jira-with-your-personal-projects %}
|
{% link_in_list /integrating-jira-with-your-personal-projects %}
|
||||||
<!-- endif -->
|
<!-- endif -->
|
||||||
<!-- if currentVersion == "free-pro-team@latest" -->
|
<!-- if currentVersion == "free-pro-team@latest" -->
|
||||||
|
|||||||
@@ -50,7 +50,7 @@ git@{% data variables.command_line.codeblock %}:<em>USERNAME</em>/<em>REPOSITORY
|
|||||||
> origin https://{% data variables.command_line.codeblock %}/<em>USERNAME/REPOSITORY</em>.git (push)
|
> origin https://{% data variables.command_line.codeblock %}/<em>USERNAME/REPOSITORY</em>.git (push)
|
||||||
```
|
```
|
||||||
|
|
||||||
The next time you `git fetch`, `git pull`, or `git push` to the remote repository, you'll be asked for your GitHub username and password.
|
The next time you `git fetch`, `git pull`, or `git push` to the remote repository, you'll be asked for your GitHub username and password. {% data reusables.user_settings.password-authentication-deprecation %}
|
||||||
|
|
||||||
- If you have [two-factor authentication](/articles/securing-your-account-with-two-factor-authentication-2fa) enabled, you must [create a personal access token](/github/authenticating-to-github/creating-a-personal-access-token) to use instead of your GitHub password.
|
- If you have [two-factor authentication](/articles/securing-your-account-with-two-factor-authentication-2fa) enabled, you must [create a personal access token](/github/authenticating-to-github/creating-a-personal-access-token) to use instead of your GitHub password.
|
||||||
- You can [use a credential helper](/github/using-git/caching-your-github-credentials-in-git) so Git will remember your GitHub username and password every time it talks to GitHub.
|
- You can [use a credential helper](/github/using-git/caching-your-github-credentials-in-git) so Git will remember your GitHub username and password every time it talks to GitHub.
|
||||||
|
|||||||
@@ -47,9 +47,9 @@ You can use the dependency graph to:
|
|||||||
|
|
||||||
{% if currentVersion == "free-pro-team@latest" %}To generate a dependency graph, {% data variables.product.product_name %} needs read-only access to the dependency manifest and lock files for a repository. The dependency graph is automatically generated for all public repositories and you can choose to enable it for private repositories. For information about enabling or disabling it for private repositories, see "[Exploring the dependencies of a repository](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository)."{% endif %}
|
{% if currentVersion == "free-pro-team@latest" %}To generate a dependency graph, {% data variables.product.product_name %} needs read-only access to the dependency manifest and lock files for a repository. The dependency graph is automatically generated for all public repositories and you can choose to enable it for private repositories. For information about enabling or disabling it for private repositories, see "[Exploring the dependencies of a repository](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository)."{% endif %}
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_gt "enterprise-server@2.21" %}If the dependency graph is not available in your system, your site administrator can enable the dependency graph and {% data variables.product.prodname_dependabot_short %} alerts. For more information, see "[Enabling alerts for vulnerable dependencies on {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server)."{% endif %}
|
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" %}If the dependency graph is not available in your system, your site administrator can enable the dependency graph and {% data variables.product.prodname_dependabot_short %} alerts. For more information, see "[Enabling alerts for vulnerable dependencies on {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server)."{% endif %}
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %} If the dependency graph is not available in your system, your site administrator can enable the dependency graph and security alerts. For more information, see "[Enabling alerts for vulnerable dependencies on {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server)."
|
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %} If the dependency graph is not available in your system, your site administrator can enable the dependency graph and security alerts. For more information, see "[Enabling alerts for vulnerable dependencies on {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server)."
|
||||||
|
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
|
|||||||
@@ -35,7 +35,7 @@ If vulnerabilities have been detected in the repository, these are shown at the
|
|||||||
|
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_gt "enterprise-server@2.21" %}
|
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" %}
|
||||||
Any direct and indirect dependencies that are specified in the repository's manifest or lock files are listed, grouped by ecosystem. If vulnerabilities have been detected in the repository, these are shown at the top of the view for users with access to {% data variables.product.prodname_dependabot_short %} alerts.
|
Any direct and indirect dependencies that are specified in the repository's manifest or lock files are listed, grouped by ecosystem. If vulnerabilities have been detected in the repository, these are shown at the top of the view for users with access to {% data variables.product.prodname_dependabot_short %} alerts.
|
||||||
|
|
||||||
{% note %}
|
{% note %}
|
||||||
@@ -54,7 +54,7 @@ Any direct and indirect dependencies that are specified in the repository's mani
|
|||||||
|
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
|
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
|
||||||
Any direct and indirect dependencies that are specified in the repository's manifest or lock files are listed, grouped by ecosystem. If vulnerabilities have been detected in the repository, these are shown at the top of the view for users with access to security alerts.
|
Any direct and indirect dependencies that are specified in the repository's manifest or lock files are listed, grouped by ecosystem. If vulnerabilities have been detected in the repository, these are shown at the top of the view for users with access to security alerts.
|
||||||
|
|
||||||
{% note %}
|
{% note %}
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ versions:
|
|||||||
|
|
||||||
### About contributors
|
### About contributors
|
||||||
|
|
||||||
You can view the top 100 contributors to a repository{% if currentVersion != "free-pro-team@latest" %}, including commit co-authors,{% endif %} in the contributors graph. Merge commits and empty commits aren't counted as contributions for this graph.
|
You can view the top 100 contributors to a repository{% if enterpriseServerVersions contains currentVersion %}, including commit co-authors,{% endif %} in the contributors graph. Merge commits and empty commits aren't counted as contributions for this graph.
|
||||||
|
|
||||||
{% if currentVersion == "free-pro-team@latest" %}
|
{% if currentVersion == "free-pro-team@latest" %}
|
||||||
You can also see a list of people who have contributed to the project's Python dependencies. To access this list of community contributors, visit `https://github.com/REPO-OWNER/REPO-NAME/community_contributors`.
|
You can also see a list of people who have contributed to the project's Python dependencies. To access this list of community contributors, visit `https://github.com/REPO-OWNER/REPO-NAME/community_contributors`.
|
||||||
|
|||||||
@@ -43,7 +43,7 @@ For more information about how custom domains affect the URL for your site, see
|
|||||||
|
|
||||||
You can only create one user or organization site for each {% data variables.product.product_name %} account. Project sites, whether owned by an organization or a user account, are unlimited.
|
You can only create one user or organization site for each {% data variables.product.product_name %} account. Project sites, whether owned by an organization or a user account, are unlimited.
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
The URL where your site is available depends on whether subdomain isolation is enabled for {% data variables.product.product_location %}.
|
The URL where your site is available depends on whether subdomain isolation is enabled for {% data variables.product.product_location %}.
|
||||||
|
|
||||||
| Type of site | Subdomain isolation enabled | Subdomain isolation disabled |
|
| Type of site | Subdomain isolation enabled | Subdomain isolation disabled |
|
||||||
|
|||||||
@@ -81,7 +81,7 @@ gem "github-pages", "~> <em>VERSION</em>", group: :jekyll_plugins
|
|||||||
```
|
```
|
||||||
10. Save and close the Gemfile.
|
10. Save and close the Gemfile.
|
||||||
11. Optionally, test your site locally. For more information, see "[Testing your {% data variables.product.prodname_pages %} site locally with Jekyll](/articles/testing-your-github-pages-site-locally-with-jekyll)."
|
11. Optionally, test your site locally. For more information, see "[Testing your {% data variables.product.prodname_pages %} site locally with Jekyll](/articles/testing-your-github-pages-site-locally-with-jekyll)."
|
||||||
12. Add your {% data variables.product.product_name %} repository as a remote, replacing {% if currentVersion != "free-pro-team@latest" %}_HOSTNAME_ with your appliance's hostname,{% endif %} _USER_ with the account that owns the repository{% if currentVersion != "free-pro-team@latest" %},{% endif %} and _REPOSITORY_ with the name of the repository.
|
12. Add your {% data variables.product.product_name %} repository as a remote, replacing {% if enterpriseServerVersions contains currentVersion %}_HOSTNAME_ with your appliance's hostname,{% endif %} _USER_ with the account that owns the repository{% if enterpriseServerVersions contains currentVersion %},{% endif %} and _REPOSITORY_ with the name of the repository.
|
||||||
```shell
|
```shell
|
||||||
{% if currentVersion == "free-pro-team@latest" %}
|
{% if currentVersion == "free-pro-team@latest" %}
|
||||||
$ git remote add origin https://github.com/<em>USER</em>/<em>REPOSITORY</em>.git
|
$ git remote add origin https://github.com/<em>USER</em>/<em>REPOSITORY</em>.git
|
||||||
|
|||||||
@@ -17,9 +17,9 @@ Every gist is a Git repository, which means that it can be forked and cloned. If
|
|||||||
|
|
||||||
Gists can be public or secret. Public gists show up in {% data variables.gists.discover_url %}, where people can browse new gists as they're created. They're also searchable, so you can use them if you'd like other people to find and see your work. {% data reusables.gist.cannot-convert-public-gists-to-secret %}
|
Gists can be public or secret. Public gists show up in {% data variables.gists.discover_url %}, where people can browse new gists as they're created. They're also searchable, so you can use them if you'd like other people to find and see your work. {% data reusables.gist.cannot-convert-public-gists-to-secret %}
|
||||||
|
|
||||||
Secret gists don't show up in {% data variables.gists.discover_url %}{% if currentVersion != "free-pro-team@latest" %},{% endif %} and are not searchable. {% data reusables.gist.cannot-convert-public-gists-to-secret %} Secret gists aren't private. If you send the URL of a secret gist to a friend, they'll be able to see it. However, if someone you don't know discovers the URL, they'll also be able to see your gist. If you need to keep your code away from prying eyes, you may want to [create a private repository](/articles/creating-a-new-repository) instead.
|
Secret gists don't show up in {% data variables.gists.discover_url %} and are not searchable. {% data reusables.gist.cannot-convert-public-gists-to-secret %} Secret gists aren't private. If you send the URL of a secret gist to a friend, they'll be able to see it. However, if someone you don't know discovers the URL, they'll also be able to see your gist. If you need to keep your code away from prying eyes, you may want to [create a private repository](/articles/creating-a-new-repository) instead.
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
|
|
||||||
If your site administrator has disabled private mode, you can also use anonymous gists, which can be public or secret.
|
If your site administrator has disabled private mode, you can also use anonymous gists, which can be public or secret.
|
||||||
|
|
||||||
|
|||||||
@@ -27,13 +27,13 @@ You can authenticate to {% data variables.product.prodname_registry %} with Apac
|
|||||||
|
|
||||||
In the `servers` tag, add a child `server` tag with an `id`, replacing *USERNAME* with your {% data variables.product.prodname_dotcom %} username, and *TOKEN* with your personal access token.
|
In the `servers` tag, add a child `server` tag with an `id`, replacing *USERNAME* with your {% data variables.product.prodname_dotcom %} username, and *TOKEN* with your personal access token.
|
||||||
|
|
||||||
In the `repositories` tag, configure a repository by mapping the `id` of the repository to the `id` you added in the `server` tag containing your credentials. Replace {% if currentVersion != "free-pro-team@latest" %}*HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance, {% endif %}*REPOSITORY* with the name of the repository you'd like to publish a package to or install a package from, and *OWNER* with the name of the user or organization account that owns the repository. {% data reusables.package_registry.lowercase-name-field %}
|
In the `repositories` tag, configure a repository by mapping the `id` of the repository to the `id` you added in the `server` tag containing your credentials. Replace {% if enterpriseServerVersions contains currentVersion %}*HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance, {% endif %}*REPOSITORY* with the name of the repository you'd like to publish a package to or install a package from, and *OWNER* with the name of the user or organization account that owns the repository. {% data reusables.package_registry.lowercase-name-field %}
|
||||||
|
|
||||||
If you want to interact with multiple repositories, you can add each repository to separate `repository` children in the `repositories` tag, mapping the `id` of each to the credentials in the `servers` tag.
|
If you want to interact with multiple repositories, you can add each repository to separate `repository` children in the `repositories` tag, mapping the `id` of each to the credentials in the `servers` tag.
|
||||||
|
|
||||||
{% data reusables.package_registry.apache-maven-snapshot-versions-supported %}
|
{% data reusables.package_registry.apache-maven-snapshot-versions-supported %}
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
If your instance has subdomain isolation enabled:
|
If your instance has subdomain isolation enabled:
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
@@ -76,7 +76,7 @@ If your instance has subdomain isolation enabled:
|
|||||||
</settings>
|
</settings>
|
||||||
```
|
```
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
If your instance has subdomain isolation disabled:
|
If your instance has subdomain isolation disabled:
|
||||||
|
|
||||||
```
|
```
|
||||||
@@ -131,8 +131,8 @@ If you would like to publish multiple packages to the same repository, you can i
|
|||||||
|
|
||||||
For more information on creating a package, see the [maven.apache.org documentation](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html).
|
For more information on creating a package, see the [maven.apache.org documentation](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html).
|
||||||
|
|
||||||
1. Edit the `distributionManagement` element of the *pom.xml* file located in your package directory, replacing {% if currentVersion != "free-pro-team@latest" %}*HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance, {% endif %}`OWNER` with the name of the user or organization account that owns the repository and `REPOSITORY` with the name of the repository containing your project.
|
1. Edit the `distributionManagement` element of the *pom.xml* file located in your package directory, replacing {% if enterpriseServerVersions contains currentVersion %}*HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance, {% endif %}`OWNER` with the name of the user or organization account that owns the repository and `REPOSITORY` with the name of the repository containing your project.
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
If your instance has subdomain isolation enabled:
|
If your instance has subdomain isolation enabled:
|
||||||
{% endif %}
|
{% endif %}
|
||||||
```
|
```
|
||||||
@@ -144,7 +144,7 @@ For more information on creating a package, see the [maven.apache.org documentat
|
|||||||
</repository>
|
</repository>
|
||||||
</distributionManagement>
|
</distributionManagement>
|
||||||
```
|
```
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
If your instance has subdomain isolation disabled:
|
If your instance has subdomain isolation disabled:
|
||||||
```
|
```
|
||||||
<distributionManagement>
|
<distributionManagement>
|
||||||
|
|||||||
@@ -21,7 +21,7 @@ versions:
|
|||||||
|
|
||||||
When installing or publishing a docker image, {% data variables.product.prodname_registry %} does not currently support foreign layers, such as Windows images.
|
When installing or publishing a docker image, {% data variables.product.prodname_registry %} does not currently support foreign layers, such as Windows images.
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
|
|
||||||
Before you can use the Docker registry on {% data variables.product.prodname_registry %}, the site administrator for {% data variables.product.product_location_enterprise %} must enable Docker support and subdomain isolation for your instance. For more information, see "[Managing GitHub Packages for your enterprise](/enterprise/admin/packages)."
|
Before you can use the Docker registry on {% data variables.product.prodname_registry %}, the site administrator for {% data variables.product.product_location_enterprise %} must enable Docker support and subdomain isolation for your instance. For more information, see "[Managing GitHub Packages for your enterprise](/enterprise/admin/packages)."
|
||||||
|
|
||||||
@@ -49,7 +49,7 @@ To keep your credentials secure, we recommend you save your personal access toke
|
|||||||
{% endraw %}
|
{% endraw %}
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
{% raw %}
|
{% raw %}
|
||||||
```shell
|
```shell
|
||||||
$ cat <em>~/TOKEN.txt</em> | docker login docker.HOSTNAME -u <em>USERNAME</em> --password-stdin
|
$ cat <em>~/TOKEN.txt</em> | docker login docker.HOSTNAME -u <em>USERNAME</em> --password-stdin
|
||||||
@@ -57,7 +57,7 @@ To keep your credentials secure, we recommend you save your personal access toke
|
|||||||
{% endraw %}
|
{% endraw %}
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
To use this example login command, replace `USERNAME` with your {% data variables.product.product_name %} username{% if currentVersion != "free-pro-team@latest" %}, `HOSTNAME` with the URL for {% data variables.product.product_location_enterprise %},{% endif %} and `~/TOKEN.txt` with the file path to your personal access token for {% data variables.product.product_name %}.
|
To use this example login command, replace `USERNAME` with your {% data variables.product.product_name %} username{% if enterpriseServerVersions contains currentVersion %}, `HOSTNAME` with the URL for {% data variables.product.product_location_enterprise %},{% endif %} and `~/TOKEN.txt` with the file path to your personal access token for {% data variables.product.product_name %}.
|
||||||
|
|
||||||
For more information, see "[Docker login](https://docs.docker.com/engine/reference/commandline/login/#provide-a-password-using-stdin)."
|
For more information, see "[Docker login](https://docs.docker.com/engine/reference/commandline/login/#provide-a-password-using-stdin)."
|
||||||
|
|
||||||
@@ -82,7 +82,7 @@ For more information, see "[Docker login](https://docs.docker.com/engine/referen
|
|||||||
> REPOSITORY TAG IMAGE ID CREATED SIZE
|
> REPOSITORY TAG IMAGE ID CREATED SIZE
|
||||||
> <em>IMAGE_NAME</em> <em>VERSION</em> <em>IMAGE_ID</em> 4 weeks ago 1.11MB
|
> <em>IMAGE_NAME</em> <em>VERSION</em> <em>IMAGE_ID</em> 4 weeks ago 1.11MB
|
||||||
```
|
```
|
||||||
2. Using the Docker image ID, tag the docker image, replacing *OWNER* with the name of the user or organization account that owns the repository, *REPOSITORY* with the name of the repository containing your project, *IMAGE_NAME* with name of the package or image,{% if currentVersion != "free-pro-team@latest" %} *HOSTNAME* with the hostname of {% data variables.product.product_location_enterprise %},{% endif %} and *VERSION* with package version at build time.
|
2. Using the Docker image ID, tag the docker image, replacing *OWNER* with the name of the user or organization account that owns the repository, *REPOSITORY* with the name of the repository containing your project, *IMAGE_NAME* with name of the package or image,{% if enterpriseServerVersions contains currentVersion %} *HOSTNAME* with the hostname of {% data variables.product.product_location_enterprise %},{% endif %} and *VERSION* with package version at build time.
|
||||||
{% if currentVersion == "free-pro-team@latest" %}
|
{% if currentVersion == "free-pro-team@latest" %}
|
||||||
```shell
|
```shell
|
||||||
$ docker tag <em>IMAGE_ID</em> docker.pkg.github.com/<em>OWNER/REPOSITORY/IMAGE_NAME:VERSION</em>
|
$ docker tag <em>IMAGE_ID</em> docker.pkg.github.com/<em>OWNER/REPOSITORY/IMAGE_NAME:VERSION</em>
|
||||||
@@ -92,7 +92,7 @@ For more information, see "[Docker login](https://docs.docker.com/engine/referen
|
|||||||
$ docker tag <em>IMAGE_ID</em> docker.<em>HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION</em>
|
$ docker tag <em>IMAGE_ID</em> docker.<em>HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION</em>
|
||||||
```
|
```
|
||||||
{% endif %}
|
{% endif %}
|
||||||
3. If you haven't already built a docker image for the package, build the image, replacing *OWNER* with the name of the user or organization account that owns the repository, *REPOSITORY* with the name of the repository containing your project, *IMAGE_NAME* with name of the package or image, *VERSION* with package version at build time,{% if currentVersion != "free-pro-team@latest" %} *HOSTNAME* with the hostname of {% data variables.product.product_location_enterprise %},{% endif %} and *PATH* to the image if it isn't in the current working directory.s
|
3. If you haven't already built a docker image for the package, build the image, replacing *OWNER* with the name of the user or organization account that owns the repository, *REPOSITORY* with the name of the repository containing your project, *IMAGE_NAME* with name of the package or image, *VERSION* with package version at build time,{% if enterpriseServerVersions contains currentVersion %} *HOSTNAME* with the hostname of {% data variables.product.product_location_enterprise %},{% endif %} and *PATH* to the image if it isn't in the current working directory.s
|
||||||
{% if currentVersion == "free-pro-team@latest" %}
|
{% if currentVersion == "free-pro-team@latest" %}
|
||||||
```shell
|
```shell
|
||||||
$ docker build -t docker.pkg.github.com/<em>OWNER/REPOSITORY/IMAGE_NAME:VERSION</em> <em>PATH</em>
|
$ docker build -t docker.pkg.github.com/<em>OWNER/REPOSITORY/IMAGE_NAME:VERSION</em> <em>PATH</em>
|
||||||
@@ -182,7 +182,7 @@ $ docker push docker.<em>HOSTNAME</em>/octocat/octo-app/monalisa:1.0
|
|||||||
|
|
||||||
{% data reusables.package_registry.docker_registry_deprecation_status %}
|
{% data reusables.package_registry.docker_registry_deprecation_status %}
|
||||||
|
|
||||||
You can use the `docker pull` command to install a docker image from {% data variables.product.prodname_registry %}, replacing *OWNER* with the name of the user or organization account that owns the repository, *REPOSITORY* with the name of the repository containing your project, *IMAGE_NAME* with name of the package or image,{% if currentVersion != "free-pro-team@latest" %}*HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance, {% endif %} and *TAG_NAME* with tag for the image you want to install. {% data reusables.package_registry.lowercase-name-field %}
|
You can use the `docker pull` command to install a docker image from {% data variables.product.prodname_registry %}, replacing *OWNER* with the name of the user or organization account that owns the repository, *REPOSITORY* with the name of the repository containing your project, *IMAGE_NAME* with name of the package or image,{% if enterpriseServerVersions contains currentVersion %}*HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance, {% endif %} and *TAG_NAME* with tag for the image you want to install. {% data reusables.package_registry.lowercase-name-field %}
|
||||||
|
|
||||||
{% if currentVersion == "free-pro-team@latest" %}
|
{% if currentVersion == "free-pro-team@latest" %}
|
||||||
```shell
|
```shell
|
||||||
|
|||||||
@@ -29,7 +29,7 @@ To authenticate to {% data variables.product.prodname_registry %} with the `dotn
|
|||||||
You must replace:
|
You must replace:
|
||||||
- `USERNAME` with the name of your user account on {% data variables.product.prodname_dotcom %}.
|
- `USERNAME` with the name of your user account on {% data variables.product.prodname_dotcom %}.
|
||||||
- `TOKEN` with your personal access token.
|
- `TOKEN` with your personal access token.
|
||||||
- `OWNER` with the name of the user or organization account that owns the repository containing your project.{% if currentVersion != "free-pro-team@latest" %}
|
- `OWNER` with the name of the user or organization account that owns the repository containing your project.{% if enterpriseServerVersions contains currentVersion %}
|
||||||
- `HOSTNAME` with the host name for your {% data variables.product.prodname_ghe_server %} instance.
|
- `HOSTNAME` with the host name for your {% data variables.product.prodname_ghe_server %} instance.
|
||||||
|
|
||||||
If your instance has subdomain isolation enabled:
|
If your instance has subdomain isolation enabled:
|
||||||
@@ -51,7 +51,7 @@ If your instance has subdomain isolation enabled:
|
|||||||
</configuration>
|
</configuration>
|
||||||
```
|
```
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
If your instance has subdomain isolation disabled:
|
If your instance has subdomain isolation disabled:
|
||||||
|
|
||||||
```xml
|
```xml
|
||||||
@@ -89,7 +89,7 @@ You can publish a package to {% data variables.product.prodname_registry %} by a
|
|||||||
3. Add your project's specific information to your project's file, which ends in *.csproj*. You must replace:
|
3. Add your project's specific information to your project's file, which ends in *.csproj*. You must replace:
|
||||||
- `OWNER` with the name of the user or organization account that owns the repository containing your project.
|
- `OWNER` with the name of the user or organization account that owns the repository containing your project.
|
||||||
- `REPOSITORY` with the name of the repository containing the package you want to publish.
|
- `REPOSITORY` with the name of the repository containing the package you want to publish.
|
||||||
- `1.0.0` with the version number of the package.{% if currentVersion != "free-pro-team@latest" %}
|
- `1.0.0` with the version number of the package.{% if enterpriseServerVersions contains currentVersion %}
|
||||||
- `HOSTNAME` with the host name for your {% data variables.product.prodname_ghe_server %} instance.{% endif %}
|
- `HOSTNAME` with the host name for your {% data variables.product.prodname_ghe_server %} instance.{% endif %}
|
||||||
``` xml
|
``` xml
|
||||||
<Project Sdk="Microsoft.NET.Sdk">
|
<Project Sdk="Microsoft.NET.Sdk">
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ versions:
|
|||||||
|
|
||||||
You can authenticate to {% data variables.product.prodname_registry %} with Gradle using either Gradle Groovy or Kotlin DSL by editing your *build.gradle* file (Gradle Groovy) or *build.gradle.kts* file (Kotlin DSL) file to include your personal access token. You can also configure Gradle Groovy and Kotlin DSL to recognize a single package or multiple packages in a repository.
|
You can authenticate to {% data variables.product.prodname_registry %} with Gradle using either Gradle Groovy or Kotlin DSL by editing your *build.gradle* file (Gradle Groovy) or *build.gradle.kts* file (Kotlin DSL) file to include your personal access token. You can also configure Gradle Groovy and Kotlin DSL to recognize a single package or multiple packages in a repository.
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
Replace *REGISTRY-URL* with the URL for your instance's Maven registry. If your instance has subdomain isolation enabled, use `maven.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/maven`. In either case, replace *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance.
|
Replace *REGISTRY-URL* with the URL for your instance's Maven registry. If your instance has subdomain isolation enabled, use `maven.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/maven`. In either case, replace *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance.
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
|
|||||||
@@ -25,9 +25,9 @@ versions:
|
|||||||
|
|
||||||
You can authenticate to {% data variables.product.prodname_registry %} with npm by either editing your per-user *~/.npmrc* file to include your personal access token or by logging in to npm on the command line using your username and personal access token.
|
You can authenticate to {% data variables.product.prodname_registry %} with npm by either editing your per-user *~/.npmrc* file to include your personal access token or by logging in to npm on the command line using your username and personal access token.
|
||||||
|
|
||||||
To authenticate by adding your personal access token to your *~/.npmrc* file, edit the *~/.npmrc* file for your project to include the following line, replacing {% if currentVersion != "free-pro-team@latest" %}*HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance and {% endif %}*TOKEN* with your personal access token. Create a new *~/.npmrc* file if one doesn't exist.
|
To authenticate by adding your personal access token to your *~/.npmrc* file, edit the *~/.npmrc* file for your project to include the following line, replacing {% if enterpriseServerVersions contains currentVersion %}*HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance and {% endif %}*TOKEN* with your personal access token. Create a new *~/.npmrc* file if one doesn't exist.
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
If your instance has subdomain isolation enabled:
|
If your instance has subdomain isolation enabled:
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
@@ -35,7 +35,7 @@ If your instance has subdomain isolation enabled:
|
|||||||
//{% if currentVersion == "free-pro-team@latest" %}npm.pkg.github.com{% else %}npm.<em>HOSTNAME</em>/{% endif %}/:_authToken=<em>TOKEN</em>
|
//{% if currentVersion == "free-pro-team@latest" %}npm.pkg.github.com{% else %}npm.<em>HOSTNAME</em>/{% endif %}/:_authToken=<em>TOKEN</em>
|
||||||
```
|
```
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
If your instance has subdomain isolation disabled:
|
If your instance has subdomain isolation disabled:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
@@ -45,7 +45,7 @@ If your instance has subdomain isolation disabled:
|
|||||||
|
|
||||||
To authenticate by logging in to npm, use the `npm login` command, replacing *USERNAME* with your {% data variables.product.prodname_dotcom %} username, *TOKEN* with your personal access token, and *PUBLIC-EMAIL-ADDRESS* with your email address.
|
To authenticate by logging in to npm, use the `npm login` command, replacing *USERNAME* with your {% data variables.product.prodname_dotcom %} username, *TOKEN* with your personal access token, and *PUBLIC-EMAIL-ADDRESS* with your email address.
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
If your instance has subdomain isolation enabled:
|
If your instance has subdomain isolation enabled:
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
@@ -56,7 +56,7 @@ $ npm login --registry=https://{% if currentVersion == "free-pro-team@latest" %}
|
|||||||
> Email: <em>PUBLIC-EMAIL-ADDRESS</em>
|
> Email: <em>PUBLIC-EMAIL-ADDRESS</em>
|
||||||
```
|
```
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
If your instance has subdomain isolation disabled:
|
If your instance has subdomain isolation disabled:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
@@ -97,7 +97,7 @@ You can use an *.npmrc* file to configure the scope mapping for your project. In
|
|||||||
You can use `publishConfig` element in the *package.json* file to specify the registry where you want the package published. For more information, see "[publishConfig](https://docs.npmjs.com/files/package.json#publishconfig)" in the npm documentation.
|
You can use `publishConfig` element in the *package.json* file to specify the registry where you want the package published. For more information, see "[publishConfig](https://docs.npmjs.com/files/package.json#publishconfig)" in the npm documentation.
|
||||||
|
|
||||||
1. Edit the *package.json* file for your package and include a `publishConfig` entry.
|
1. Edit the *package.json* file for your package and include a `publishConfig` entry.
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
If your instance has subdomain isolation enabled:
|
If your instance has subdomain isolation enabled:
|
||||||
{% endif %}
|
{% endif %}
|
||||||
```shell
|
```shell
|
||||||
@@ -105,7 +105,7 @@ You can use `publishConfig` element in the *package.json* file to specify the re
|
|||||||
"registry":"https://{% if currentVersion == "free-pro-team@latest" %}npm.pkg.github.com{% else %}npm.<em>HOSTNAME</em>/{% endif %}"
|
"registry":"https://{% if currentVersion == "free-pro-team@latest" %}npm.pkg.github.com{% else %}npm.<em>HOSTNAME</em>/{% endif %}"
|
||||||
},
|
},
|
||||||
```
|
```
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
If your instance has subdomain isolation disabled:
|
If your instance has subdomain isolation disabled:
|
||||||
```shell
|
```shell
|
||||||
"publishConfig": {
|
"publishConfig": {
|
||||||
@@ -166,9 +166,9 @@ You also need to add the *.npmrc* file to your project so all requests to instal
|
|||||||
|
|
||||||
#### Installing packages from other organizations
|
#### Installing packages from other organizations
|
||||||
|
|
||||||
By default, you can only use {% data variables.product.prodname_registry %} packages from one organization. If you'd like to route package requests to multiple organizations and users, you can add additional lines to your *.npmrc* file, replacing {% if currentVersion != "free-pro-team@latest" %}*HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance and {% endif %}*OWNER* with the name of the user or organization account that owns the repository containing your project. {% data reusables.package_registry.lowercase-name-field %}
|
By default, you can only use {% data variables.product.prodname_registry %} packages from one organization. If you'd like to route package requests to multiple organizations and users, you can add additional lines to your *.npmrc* file, replacing {% if enterpriseServerVersions contains currentVersion %}*HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance and {% endif %}*OWNER* with the name of the user or organization account that owns the repository containing your project. {% data reusables.package_registry.lowercase-name-field %}
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
If your instance has subdomain isolation enabled:
|
If your instance has subdomain isolation enabled:
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
@@ -178,7 +178,7 @@ registry=https://{% if currentVersion == "free-pro-team@latest" %}npm.pkg.github
|
|||||||
@<em>OWNER</em>:registry={% if currentVersion == "free-pro-team@latest" %}npm.pkg.github.com{% else %}npm.<em>HOSTNAME</em>/{% endif %}
|
@<em>OWNER</em>:registry={% if currentVersion == "free-pro-team@latest" %}npm.pkg.github.com{% else %}npm.<em>HOSTNAME</em>/{% endif %}
|
||||||
```
|
```
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
If your instance has subdomain isolation disabled:
|
If your instance has subdomain isolation disabled:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
|
|||||||
@@ -56,7 +56,7 @@ For example, you would create or edit a *~/.gem/credentials* to include the foll
|
|||||||
To install gems, you need to authenticate to {% data variables.product.prodname_registry %} by editing the *~/.gemrc* file for your project to include `https://USERNAME:TOKEN@{% if currentVersion == "free-pro-team@latest" %}rubygems.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER/`. You must replace:
|
To install gems, you need to authenticate to {% data variables.product.prodname_registry %} by editing the *~/.gemrc* file for your project to include `https://USERNAME:TOKEN@{% if currentVersion == "free-pro-team@latest" %}rubygems.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER/`. You must replace:
|
||||||
- `USERNAME` with your {% data variables.product.prodname_dotcom %} username.
|
- `USERNAME` with your {% data variables.product.prodname_dotcom %} username.
|
||||||
- `TOKEN` with your personal access token.
|
- `TOKEN` with your personal access token.
|
||||||
- `OWNER` with the name of the user or organization account that owns the repository containing your project.{% if currentVersion != "free-pro-team@latest" %}
|
- `OWNER` with the name of the user or organization account that owns the repository containing your project.{% if enterpriseServerVersions contains currentVersion %}
|
||||||
- `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the hostname of your {% data variables.product.prodname_ghe_server %} instance.
|
- `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the hostname of your {% data variables.product.prodname_ghe_server %} instance.
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
@@ -74,7 +74,7 @@ If you don't have a *~/.gemrc* file, create a new *~/.gemrc* file using this exa
|
|||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
To authenticate with Bundler, configure Bundler to use your personal access token, replacing *USERNAME* with your {% data variables.product.prodname_dotcom %} username, *TOKEN* with your personal access token, and *OWNER* with the name of the user or organization account that owns the repository containing your project.{% if currentVersion != "free-pro-team@latest" %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the hostname of your {% data variables.product.prodname_ghe_server %} instance.{% endif %}
|
To authenticate with Bundler, configure Bundler to use your personal access token, replacing *USERNAME* with your {% data variables.product.prodname_dotcom %} username, *TOKEN* with your personal access token, and *OWNER* with the name of the user or organization account that owns the repository containing your project.{% if enterpriseServerVersions contains currentVersion %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the hostname of your {% data variables.product.prodname_ghe_server %} instance.{% endif %}
|
||||||
|
|
||||||
{% data reusables.package_registry.lowercase-name-field %}
|
{% data reusables.package_registry.lowercase-name-field %}
|
||||||
|
|
||||||
@@ -97,7 +97,7 @@ $ bundle config https://{% if currentVersion == "free-pro-team@latest" %}rubygem
|
|||||||
```shell
|
```shell
|
||||||
gem build OCTO-GEM.gemspec
|
gem build OCTO-GEM.gemspec
|
||||||
```
|
```
|
||||||
3. Publish a package to {% data variables.product.prodname_registry %}, replacing `OWNER` with the name of the user or organization account that owns the repository containing your project and `OCTO-GEM` with the name of your gem package.{% if currentVersion != "free-pro-team@latest" %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance.{% endif %}
|
3. Publish a package to {% data variables.product.prodname_registry %}, replacing `OWNER` with the name of the user or organization account that owns the repository containing your project and `OCTO-GEM` with the name of your gem package.{% if enterpriseServerVersions contains currentVersion %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance.{% endif %}
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
$ gem push --key github \
|
$ gem push --key github \
|
||||||
@@ -107,7 +107,7 @@ $ bundle config https://{% if currentVersion == "free-pro-team@latest" %}rubygem
|
|||||||
|
|
||||||
### Publishing multiple packages to the same repository
|
### Publishing multiple packages to the same repository
|
||||||
|
|
||||||
To publish multiple gems to the same repository, you can include the URL to the {% data variables.product.prodname_dotcom %} repository in the `github_repo` field in `gem.metadata`. If you include this field, {% data variables.product.prodname_dotcom %} matches the repository based on this value, instead of using the gem name.{% if currentVersion != "free-pro-team@latest" %} Replace *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance.{% endif %}
|
To publish multiple gems to the same repository, you can include the URL to the {% data variables.product.prodname_dotcom %} repository in the `github_repo` field in `gem.metadata`. If you include this field, {% data variables.product.prodname_dotcom %} matches the repository based on this value, instead of using the gem name.{% if enterpriseServerVersions contains currentVersion %} Replace *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance.{% endif %}
|
||||||
|
|
||||||
```
|
```
|
||||||
gem.metadata = { "github_repo" => "ssh://{% if currentVersion == "free-pro-team@latest" %}github.com{% else %}HOSTNAME{% endif %}/OWNER/REPOSITORY" }
|
gem.metadata = { "github_repo" => "ssh://{% if currentVersion == "free-pro-team@latest" %}github.com{% else %}HOSTNAME{% endif %}/OWNER/REPOSITORY" }
|
||||||
@@ -118,7 +118,7 @@ gem.metadata = { "github_repo" => "ssh://{% if currentVersion == "free-pro-team@
|
|||||||
You can use gems from {% data variables.product.prodname_registry %} much like you use gems from *rubygems.org*. You need to authenticate to {% data variables.product.prodname_registry %} by adding your {% data variables.product.prodname_dotcom %} user or organization as a source in the *~/.gemrc* file or by using Bundler and editing you *Gemfile*.
|
You can use gems from {% data variables.product.prodname_registry %} much like you use gems from *rubygems.org*. You need to authenticate to {% data variables.product.prodname_registry %} by adding your {% data variables.product.prodname_dotcom %} user or organization as a source in the *~/.gemrc* file or by using Bundler and editing you *Gemfile*.
|
||||||
|
|
||||||
{% data reusables.package_registry.authenticate-step %}
|
{% data reusables.package_registry.authenticate-step %}
|
||||||
2. For Bundler, add your {% data variables.product.prodname_dotcom %} user or organization as a source in your *Gemfile* to fetch gems from this new source. For example, you can add a new `source` block to your *Gemfile* that uses {% data variables.product.prodname_registry %} only for the packages you specify, replacing *GEM NAME* with the package you want to install from {% data variables.product.prodname_registry %} and *OWNER* with the user or organization that owns the repository containing the gem you want to install.{% if currentVersion != "free-pro-team@latest" %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance.{% endif %}
|
2. For Bundler, add your {% data variables.product.prodname_dotcom %} user or organization as a source in your *Gemfile* to fetch gems from this new source. For example, you can add a new `source` block to your *Gemfile* that uses {% data variables.product.prodname_registry %} only for the packages you specify, replacing *GEM NAME* with the package you want to install from {% data variables.product.prodname_registry %} and *OWNER* with the user or organization that owns the repository containing the gem you want to install.{% if enterpriseServerVersions contains currentVersion %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance.{% endif %}
|
||||||
|
|
||||||
```
|
```
|
||||||
source "https://rubygems.org"
|
source "https://rubygems.org"
|
||||||
|
|||||||
@@ -47,7 +47,7 @@ Get a [list of events](/v3/issues/timeline/) for an issue or pull request.
|
|||||||
**Custom media type:** `mockingbird-preview`
|
**Custom media type:** `mockingbird-preview`
|
||||||
**Announced:** [2016-05-23](https://developer.github.com/changes/2016-05-23-timeline-preview-api/)
|
**Announced:** [2016-05-23](https://developer.github.com/changes/2016-05-23-timeline-preview-api/)
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
### Pre-receive environments
|
### Pre-receive environments
|
||||||
|
|
||||||
Create, list, update, and delete environments for pre-receive hooks.
|
Create, list, update, and delete environments for pre-receive hooks.
|
||||||
@@ -56,7 +56,7 @@ Create, list, update, and delete environments for pre-receive hooks.
|
|||||||
**Announced:** [2015-07-29](/rest/reference/enterprise-admin#pre-receive-environments)
|
**Announced:** [2015-07-29](/rest/reference/enterprise-admin#pre-receive-environments)
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
|
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
|
||||||
### Integrations
|
### Integrations
|
||||||
|
|
||||||
Manage [integrations](/early-access/integrations/) through the API.
|
Manage [integrations](/early-access/integrations/) through the API.
|
||||||
@@ -113,7 +113,7 @@ View all [codes of conduct](/v3/codes_of_conduct) or get which code of conduct a
|
|||||||
|
|
||||||
**Custom media type:** `scarlet-witch-preview`
|
**Custom media type:** `scarlet-witch-preview`
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.20" %}
|
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.20" %}
|
||||||
### Nested teams
|
### Nested teams
|
||||||
|
|
||||||
Include nested team content in [team](/v3/teams/) payloads.
|
Include nested team content in [team](/v3/teams/) payloads.
|
||||||
@@ -123,7 +123,7 @@ Include nested team content in [team](/v3/teams/) payloads.
|
|||||||
|
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
|
|
||||||
### Global webhooks
|
### Global webhooks
|
||||||
|
|
||||||
@@ -134,7 +134,7 @@ Enables [global webhooks](/rest/reference/enterprise-admin#global-webhooks/) for
|
|||||||
|
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.20" %}
|
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.20" %}
|
||||||
### Repository transfer
|
### Repository transfer
|
||||||
|
|
||||||
Transfer a [repository](/v3/repos/) to an organization or user.
|
Transfer a [repository](/v3/repos/) to an organization or user.
|
||||||
@@ -143,7 +143,7 @@ Transfer a [repository](/v3/repos/) to an organization or user.
|
|||||||
**Announced:** [2017-11-09](https://developer.github.com/changes/2017-11-09-repository-transfer-api-preview)
|
**Announced:** [2017-11-09](https://developer.github.com/changes/2017-11-09-repository-transfer-api-preview)
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
|
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
|
||||||
### Add lock reason
|
### Add lock reason
|
||||||
|
|
||||||
You can now add a reason when you [lock an issue](/v3/issues/#lock-an-issue).
|
You can now add a reason when you [lock an issue](/v3/issues/#lock-an-issue).
|
||||||
@@ -166,7 +166,7 @@ You can now [require multiple approving reviews](/v3/repos/branches) for a pull
|
|||||||
**Custom media type:** `luke-cage-preview`
|
**Custom media type:** `luke-cage-preview`
|
||||||
**Announced:** [2018-03-16](https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews)
|
**Announced:** [2018-03-16](https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews)
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.19" %}
|
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.19" %}
|
||||||
### Retrieve hovercard information
|
### Retrieve hovercard information
|
||||||
|
|
||||||
Retrieve information from [someone's hovercard](/v3/users/#get-contextual-information-for-a-user).
|
Retrieve information from [someone's hovercard](/v3/users/#get-contextual-information-for-a-user).
|
||||||
@@ -185,7 +185,7 @@ Allows a GitHub App to run external checks on a repository's code. See the [Chec
|
|||||||
**Announced:** [2018-05-07](https://developer.github.com/changes/2018-05-07-new-checks-api-public-beta/)
|
**Announced:** [2018-05-07](https://developer.github.com/changes/2018-05-07-new-checks-api-public-beta/)
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
|
|
||||||
### Anonymous Git access to repositories
|
### Anonymous Git access to repositories
|
||||||
|
|
||||||
@@ -245,7 +245,7 @@ Allows you to temporarily restrict interactions, such as commenting, opening iss
|
|||||||
|
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.21" %}
|
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.21" %}
|
||||||
### Draft pull requests
|
### Draft pull requests
|
||||||
|
|
||||||
You can use the Draft Pull Requests API and its [pull request](/v3/pulls/) endpoints to see whether a pull request is in draft state. To learn more about draft pull requests, see "[About pull requests](/articles/about-pull-requests/)".
|
You can use the Draft Pull Requests API and its [pull request](/v3/pulls/) endpoints to see whether a pull request is in draft state. To learn more about draft pull requests, see "[About pull requests](/articles/about-pull-requests/)".
|
||||||
@@ -269,7 +269,7 @@ You can use two new endpoints in the [Commits API](/v3/repos/commits/) to list b
|
|||||||
**Custom media types:** `groot-preview`
|
**Custom media types:** `groot-preview`
|
||||||
**Announced:** [2019-04-11](https://developer.github.com/changes/2019-04-11-pulls-branches-for-commit/)
|
**Announced:** [2019-04-11](https://developer.github.com/changes/2019-04-11-pulls-branches-for-commit/)
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.21" %}
|
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.21" %}
|
||||||
### Uninstall a GitHub App
|
### Uninstall a GitHub App
|
||||||
|
|
||||||
Owners of GitHub Apps can now uninstall an app using the [Apps API](/v3/apps/#delete-an-installation-for-the-authenticated-app).
|
Owners of GitHub Apps can now uninstall an app using the [Apps API](/v3/apps/#delete-an-installation-for-the-authenticated-app).
|
||||||
|
|||||||
@@ -41,7 +41,7 @@ $ curl -i {% data variables.product.api_url_pre %}/users/octocat/orgs
|
|||||||
> X-GitHub-Media-Type: github.v3
|
> X-GitHub-Media-Type: github.v3
|
||||||
> X-RateLimit-Limit: 5000
|
> X-RateLimit-Limit: 5000
|
||||||
> X-RateLimit-Remaining: 4987
|
> X-RateLimit-Remaining: 4987
|
||||||
> X-RateLimit-Reset: 1350085394{% if currentVersion != "free-pro-team@latest" %}
|
> X-RateLimit-Reset: 1350085394{% if enterpriseServerVersions contains currentVersion %}
|
||||||
> X-GitHub-Enterprise-Version: {{ currentVersion }}.0{% endif %}
|
> X-GitHub-Enterprise-Version: {{ currentVersion }}.0{% endif %}
|
||||||
> Content-Length: 5
|
> Content-Length: 5
|
||||||
> Cache-Control: max-age=0, private, must-revalidate
|
> Cache-Control: max-age=0, private, must-revalidate
|
||||||
@@ -123,7 +123,7 @@ curl -u my_client_id:my_client_secret '{% data variables.product.api_url_pre %}/
|
|||||||
|
|
||||||
Using your `client_id` and `client_secret` does _not_ authenticate as a user, it will only identify your OAuth application to increase your rate limit. Permissions are only granted to users, not applications, and you will only get back data that an unauthenticated user would see. For this reason, you should only use the OAuth2 key/secret in server-to-server scenarios. Don't leak your OAuth application's client secret to your users.
|
Using your `client_id` and `client_secret` does _not_ authenticate as a user, it will only identify your OAuth application to increase your rate limit. Permissions are only granted to users, not applications, and you will only get back data that an unauthenticated user would see. For this reason, you should only use the OAuth2 key/secret in server-to-server scenarios. Don't leak your OAuth application's client secret to your users.
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
You will be unable to authenticate using your OAuth2 key and secret while in private mode, and trying to authenticate will return `401 Unauthorized`. For more information, see "[Enabling private mode](/enterprise/admin/installation/enabling-private-mode)".
|
You will be unable to authenticate using your OAuth2 key and secret while in private mode, and trying to authenticate will return `401 Unauthorized`. For more information, see "[Enabling private mode](/enterprise/admin/installation/enabling-private-mode)".
|
||||||
{% endif %}
|
{% endif %}
|
||||||
{% if currentVersion == "free-pro-team@latest" %}
|
{% if currentVersion == "free-pro-team@latest" %}
|
||||||
@@ -186,10 +186,10 @@ $ curl -i -u username -d '{"scopes":["public_repo"]}' {% data variables.product.
|
|||||||
You can issue a `GET` request to the root endpoint to get all the endpoint categories that the REST API supports:
|
You can issue a `GET` request to the root endpoint to get all the endpoint categories that the REST API supports:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
$ curl {% if currentVersion != "free-pro-team@latest" %}-u <em>username</em>:<em>password</em> {% endif %}{% data variables.product.api_url_pre %}
|
$ curl {% if enterpriseServerVersions contains currentVersion %}-u <em>username</em>:<em>password</em> {% endif %}{% data variables.product.api_url_pre %}
|
||||||
```
|
```
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
|
|
||||||
{% note %}
|
{% note %}
|
||||||
|
|
||||||
|
|||||||
@@ -21,7 +21,7 @@ You can use these endpoints to administer your enterprise.
|
|||||||
|
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
|
|
||||||
### Endpoint URLs
|
### Endpoint URLs
|
||||||
|
|
||||||
@@ -39,7 +39,7 @@ http(s)://<em>hostname</em>/
|
|||||||
|
|
||||||
### Authentication
|
### Authentication
|
||||||
|
|
||||||
Your {% data variables.product.product_name %} installation's API endpoints accept [the same authentication methods](/rest/overview/resources-in-the-rest-api#authentication) as the GitHub.com API. You can authenticate yourself with **[OAuth tokens](/apps/building-integrations/setting-up-and-registering-oauth-apps/)** (which can be created using the [Authorizations API](/rest/reference/oauth-authorizations#create-a-new-authorization)) or **[basic authentication](/rest/overview/resources-in-the-rest-api#basic-authentication)**. {% if currentVersion != "free-pro-team@latest" %}
|
Your {% data variables.product.product_name %} installation's API endpoints accept [the same authentication methods](/rest/overview/resources-in-the-rest-api#authentication) as the GitHub.com API. You can authenticate yourself with **[OAuth tokens](/apps/building-integrations/setting-up-and-registering-oauth-apps/)** (which can be created using the [Authorizations API](/rest/reference/oauth-authorizations#create-a-new-authorization)) or **[basic authentication](/rest/overview/resources-in-the-rest-api#basic-authentication)**. {% if enterpriseServerVersions contains currentVersion %}
|
||||||
OAuth tokens must have the `site_admin` [OAuth scope](/developers/apps/scopes-for-oauth-apps#available-scopes) when used with Enterprise-specific endpoints.{% endif %}
|
OAuth tokens must have the `site_admin` [OAuth scope](/developers/apps/scopes-for-oauth-apps#available-scopes) when used with Enterprise-specific endpoints.{% endif %}
|
||||||
|
|
||||||
Enterprise administration API endpoints are only accessible to authenticated {% data variables.product.product_name %} site administrators, except for the [Management Console](#management-console) API, which requires the [Management Console password](/enterprise/admin/articles/accessing-the-management-console/).
|
Enterprise administration API endpoints are only accessible to authenticated {% data variables.product.product_name %} site administrators, except for the [Management Console](#management-console) API, which requires the [Management Console password](/enterprise/admin/articles/accessing-the-management-console/).
|
||||||
@@ -138,7 +138,7 @@ Name | Type | Description
|
|||||||
|
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
|
|
||||||
## Admin stats
|
## Admin stats
|
||||||
|
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ versions:
|
|||||||
|
|
||||||
### Authentication
|
### Authentication
|
||||||
|
|
||||||
You can read public gists {% if currentVersion != "free-pro-team@latest" and currentVersion ver_gt "2.9" %}and create them for anonymous users without a token.{% else %} anonymously, but you must be signed into GitHub to create gists.{% endif %} To read or write gists on a user's behalf, you need the gist OAuth scope and a token. For more information, see "[Scopes for OAuth Apps](/developers/apps/scopes-for-oauth-apps)."
|
You can read public gists {% if enterpriseServerVersions contains currentVersion %}and create them for anonymous users without a token.{% else %} anonymously, but you must be signed into GitHub to create gists.{% endif %} To read or write gists on a user's behalf, you need the gist OAuth scope and a token. For more information, see "[Scopes for OAuth Apps](/developers/apps/scopes-for-oauth-apps)."
|
||||||
|
|
||||||
<!-- When an OAuth client does not have the gists scope, the API will return a 404 "Not Found" response regardless of the validity of the credentials. The API will return a 401 "Bad credentials" response if the gists scope was given to the application but the credentials are invalid. -->
|
<!-- When an OAuth client does not have the gists scope, the API will return a 404 "Not Found" response regardless of the validity of the credentials. The API will return a 401 "Bad credentials" response if the gists scope was given to the application but the credentials are invalid. -->
|
||||||
|
|
||||||
|
|||||||
@@ -577,7 +577,7 @@ _Teams_
|
|||||||
- [`GET /orgs/:org/teams`](/v3/teams/#list-teams) (:read)
|
- [`GET /orgs/:org/teams`](/v3/teams/#list-teams) (:read)
|
||||||
- [`POST /orgs/:org/teams`](/v3/teams/#create-a-team) (:write)
|
- [`POST /orgs/:org/teams`](/v3/teams/#create-a-team) (:write)
|
||||||
- [`GET /orgs/:org/teams/:team_slug`](/v3/teams/#get-a-team-by-name) (:read)
|
- [`GET /orgs/:org/teams/:team_slug`](/v3/teams/#get-a-team-by-name) (:read)
|
||||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.21" %}
|
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.21" %}
|
||||||
- [`GET /teams/:team_id`](/v3/teams/#get-a-team) (:read)
|
- [`GET /teams/:team_id`](/v3/teams/#get-a-team) (:read)
|
||||||
{% endif %}
|
{% endif %}
|
||||||
- [`PATCH /teams/:team_id`](/v3/teams/#update-a-team) (:write)
|
- [`PATCH /teams/:team_id`](/v3/teams/#update-a-team) (:write)
|
||||||
@@ -619,7 +619,7 @@ _Teams_
|
|||||||
_Teams_
|
_Teams_
|
||||||
- [`DELETE /teams/:team_id/projects/:project_id`](/v3/teams/#remove-a-project-from-a-team) (:read)
|
- [`DELETE /teams/:team_id/projects/:project_id`](/v3/teams/#remove-a-project-from-a-team) (:read)
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
### Permission on "organization pre receive hooks"
|
### Permission on "organization pre receive hooks"
|
||||||
|
|
||||||
- [`GET /orgs/:org/pre-receive-hooks`](/enterprise/user/rest/reference/enterprise-admin#list-pre-receive-hooks-for-an-organization) (:read)
|
- [`GET /orgs/:org/pre-receive-hooks`](/enterprise/user/rest/reference/enterprise-admin#list-pre-receive-hooks-for-an-organization) (:read)
|
||||||
@@ -766,7 +766,7 @@ _Reviews_
|
|||||||
- [`POST /repos/:owner/:repo/hooks/:hook_id/pings`](/v3/repos/hooks/#ping-a-repository-webhook) (:read)
|
- [`POST /repos/:owner/:repo/hooks/:hook_id/pings`](/v3/repos/hooks/#ping-a-repository-webhook) (:read)
|
||||||
- [`POST /repos/:owner/:repo/hooks/:hook_id/tests`](/v3/repos/hooks/#test-the-push-repository-webhook) (:read)
|
- [`POST /repos/:owner/:repo/hooks/:hook_id/tests`](/v3/repos/hooks/#test-the-push-repository-webhook) (:read)
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
### Permission on "repository pre receive hooks"
|
### Permission on "repository pre receive hooks"
|
||||||
|
|
||||||
- [`GET /repos/:owner/:repo/pre-receive-hooks`](/enterprise/user/rest/reference/enterprise-admin#list-pre-receive-hooks-for-a-repository) (:read)
|
- [`GET /repos/:owner/:repo/pre-receive-hooks`](/enterprise/user/rest/reference/enterprise-admin#list-pre-receive-hooks-for-a-repository) (:read)
|
||||||
|
|||||||
@@ -317,14 +317,14 @@ The default format is what [existing post-receive hooks should expect](/post-rec
|
|||||||
|
|
||||||
#### Callback URLs
|
#### Callback URLs
|
||||||
|
|
||||||
Callback URLs can use the `http://` protocol. {% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.20" %}You can also `github://` callbacks to specify a GitHub service.
|
Callback URLs can use the `http://` protocol. {% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.20" %}You can also `github://` callbacks to specify a GitHub service.
|
||||||
{% data reusables.apps.deprecating_github_services_ghe %}
|
{% data reusables.apps.deprecating_github_services_ghe %}
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
# Send updates to postbin.org
|
# Send updates to postbin.org
|
||||||
http://postbin.org/123
|
http://postbin.org/123
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.20" %}
|
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.20" %}
|
||||||
# Send updates to Campfire
|
# Send updates to Campfire
|
||||||
github://campfire?subdomain=github&room=Commits&token=abc123
|
github://campfire?subdomain=github&room=Commits&token=abc123
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|||||||
@@ -13,3 +13,9 @@ For example, an article that is available in currently supported versions will h
|
|||||||
An article that is not available in Enterprise will have just one permalink:
|
An article that is not available in Enterprise will have just one permalink:
|
||||||
|
|
||||||
* `/en/free-pro-team@latest/github/getting-started-with-github/set-up-git`
|
* `/en/free-pro-team@latest/github/getting-started-with-github/set-up-git`
|
||||||
|
|
||||||
|
**If you are a content contributor:** You don't need to worry about supported versions when adding a link to a document. Following the examples above, if you want to reference an article you can just use its relative location:
|
||||||
|
|
||||||
|
* `/github/getting-started-with-github/set-up-git`
|
||||||
|
|
||||||
|
*(Please note that using a hard-coded link or supported version will result in an error when your submitted PR is automatically tested)*
|
||||||
|
|||||||
@@ -1 +1 @@
|
|||||||
Anyone can publish an action in {% data variables.product.prodname_marketplace %} as long as they meet the terms of service. Unlike apps, {% data variables.product.prodname_actions %} listed in {% data variables.product.prodname_marketplace %} are not verified by {% data variables.product.prodname_dotcom %}.
|
Anyone can publish an action in {% data variables.product.prodname_marketplace %}. {% data variables.product.prodname_dotcom %} verifies some partner organizations, but unlike verified apps, {% data variables.product.prodname_dotcom %} does not review or verify individual actions listed in {% data variables.product.prodname_marketplace %}.
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
{% if currentVersion != "free-pro-team@latest" and currentVersion == "enterprise-server@2.22" %}
|
{% if enterpriseServerVersions contains currentVersion and currentVersion == "enterprise-server@2.22" %}
|
||||||
{% note %}
|
{% note %}
|
||||||
|
|
||||||
**Note:** {% data variables.product.prodname_actions %} support on {% data variables.product.prodname_ghe_server %} 2.22 is a limited public beta. To review the external storage requirements and request access to the beta, see "[Enabling {% data variables.product.prodname_actions %} and configuring storage](/enterprise/admin/github-actions/enabling-github-actions-and-configuring-storage)."
|
**Note:** {% data variables.product.prodname_actions %} support on {% data variables.product.prodname_ghe_server %} 2.22 is a limited public beta. To review the external storage requirements and request access to the beta, see "[Enabling {% data variables.product.prodname_actions %} and configuring storage](/enterprise/admin/github-actions/enabling-github-actions-and-configuring-storage)."
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_gt "enterprise-server@2.21" %}
|
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" %}
|
||||||
{% note %}
|
{% note %}
|
||||||
|
|
||||||
**Note:** {% data variables.product.prodname_dotcom %}-hosted runners are not currently supported on {% data variables.product.prodname_ghe_server %}. You can see more information about planned future support on the [{% data variables.product.prodname_roadmap %}](https://github.com/github/roadmap/issues/72).
|
**Note:** {% data variables.product.prodname_dotcom %}-hosted runners are not currently supported on {% data variables.product.prodname_ghe_server %}. You can see more information about planned future support on the [{% data variables.product.prodname_roadmap %}](https://github.com/github/roadmap/issues/72).
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
{% if currentVersion != "free-pro-team@latest" %}
|
{% if enterpriseServerVersions contains currentVersion %}
|
||||||
|
|
||||||
{% note %}
|
{% note %}
|
||||||
|
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_gt "enterprise-server@2.21" %}
|
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" %}
|
||||||
|
|
||||||
#### Using self-hosted runners on {% data variables.product.prodname_ghe_server %}
|
#### Using self-hosted runners on {% data variables.product.prodname_ghe_server %}
|
||||||
|
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
|
|
||||||
**Deprecation Notice:** {% data variables.product.prodname_dotcom %} will discontinue authentication to the API using query parameters. Authenticating to the API should be done with [HTTP basic authentication](/v3/auth/#via-oauth-and-personal-access-tokens).{% if currentVersion == "free-pro-team@latest" %} Using query parameters to authenticate to the API will no longer work on May 5, 2021. {% endif %} For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-10-deprecating-auth-through-query-param/).
|
**Deprecation Notice:** {% data variables.product.prodname_dotcom %} will discontinue authentication to the API using query parameters. Authenticating to the API should be done with [HTTP basic authentication](/v3/auth/#via-oauth-and-personal-access-tokens).{% if currentVersion == "free-pro-team@latest" %} Using query parameters to authenticate to the API will no longer work on May 5, 2021. {% endif %} For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-10-deprecating-auth-through-query-param/).
|
||||||
|
|
||||||
{% if currentVersion != "free-pro-team@latest" %} Authentication to the API using query parameters while available is no longer supported due to security concerns. Instead we recommend integrators move their access token, `client_id`, or `client_secret` in the header. {% data variables.product.prodname_dotcom %} will announce the removal of authentication by query parameters with advanced notice. {% endif %}
|
{% if enterpriseServerVersions contains currentVersion %} Authentication to the API using query parameters while available is no longer supported due to security concerns. Instead we recommend integrators move their access token, `client_id`, or `client_secret` in the header. {% data variables.product.prodname_dotcom %} will announce the removal of authentication by query parameters with advanced notice. {% endif %}
|
||||||
|
|
||||||
{% endwarning %}
|
{% endwarning %}
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|||||||