Skip to content

Commit

Permalink
Merge branch 'main' into patch-22
Browse files Browse the repository at this point in the history
  • Loading branch information
shati-patel authored Oct 22, 2020
2 parents c045fc2 + 7bef323 commit f52410d
Show file tree
Hide file tree
Showing 146 changed files with 508 additions and 317 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/first-responder-docs-content.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ jobs:

first-responder-remove-pr:
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

steps:
Expand Down
1 change: 0 additions & 1 deletion .github/workflows/repo-sync.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ jobs:
repo-sync:
name: Repo Sync
runs-on: ubuntu-latest
continue-on-error: true
steps:

- name: Exit if repo is frozen
Expand Down
Binary file modified assets/images/help/profile/profile-block-or-report-button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/help/profile/profile-blockuser.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/help/profile/profile-report-abuse.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/help/profile/profile-unblock-or-report-user.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/help/profile/profile-unblockuser.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -267,4 +267,4 @@ From your repository, click the **Actions** tab, and select the latest workflow
![A screenshot of using your action in a workflow](/assets/images/help/repository/javascript-action-workflow-run-updated.png)
{% else %}
![A screenshot of using your action in a workflow](/assets/images/help/repository/javascript-action-workflow-run.png)
{% endif %}
{% endif %}
2 changes: 1 addition & 1 deletion content/actions/guides/publishing-docker-images.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

* `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`.

{% raw %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ The following operating systems are supported for the self-hosted runner applica

- macOS 10.13 (High Sierra) or later

{% if currentVersion != "free-pro-team@latest" %}
{% if enterpriseServerVersions contains currentVersion %}

### Supported actions on self-hosted runners

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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" %}
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.
{% endif %}

{% if currentVersion == "free-pro-team@latest" %}
{% 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.business %}
{% endif %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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" %}
{% 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.business %}
{% endif %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,15 +62,15 @@ To remove a self-hosted runner from an organization, you must be an organization

{% 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.
{% 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.
{% endif %}

{% data reusables.github-actions.self-hosted-runner-reusing %}

{% if currentVersion == "free-pro-team@latest" %}
{% 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.business %}
{% endif %}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
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 %}'
versions:
free-pro-team: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ You can also define a custom retention period for individual artifacts using the
### Finding the expiration date of an artifact

You can use the API to confirm the date that an artifact is scheduled to be deleted. For more information, see the `expires_at` value returned by "[List artifacts for a repository](/rest/reference/actions#artifacts)."
{% endif %}
{% endif %}
Original file line number Diff line number Diff line change
Expand Up @@ -946,7 +946,7 @@ jobs:

#### **`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" %}
#### **`jobs.<job_id>.container.credentials`**
Expand Down Expand Up @@ -1029,7 +1029,7 @@ services:

#### **`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" %}
#### **`jobs.<job_id>.services.<service_id>.credentials`**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Before launching {% data variables.product.product_location_enterprise %} on Goo
#### 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).
{% if currentVersion != "free-pro-team@latest" %}

| High-memory |
------------- |
| n1-highmem-4 |
Expand All @@ -34,7 +34,6 @@ Before launching {% data variables.product.product_location_enterprise %} on Goo
| n1-highmem-32 |
| n1-highmem-64 |
| n1-highmem-96 |
{% endif %}

#### Recommended machine types

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}

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

Expand Down
8 changes: 4 additions & 4 deletions content/developers/apps/authenticating-with-github-apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ versions:
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.api-preview-warning %}
{% endif %}
Expand Down Expand Up @@ -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:
{% 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
$ curl -i -H "Authorization: Bearer YOUR_JWT" -H "Accept: application/vnd.github.machine-man-preview+json" {% data variables.product.api_url_pre %}/app
```
Expand Down Expand Up @@ -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:
{% 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
$ curl -i -X POST \
-H "Authorization: Bearer YOUR_JWT" \
Expand All @@ -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:
{% 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
$ curl -i \
-H "Authorization: token YOUR_INSTALLATION_ACCESS_TOKEN" \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ You must complete this step of the GitHub App Manifest flow within one hour.

{% 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.api-preview-warning %}
{% endif %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

{% 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.api-preview-warning %}
{% endif %}
Expand Down Expand Up @@ -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)
* [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

* [List pre-receive hooks for an organization](/enterprise/user/rest/reference/enterprise-admin#list-pre-receive-hooks-for-an-organization)
Expand Down Expand Up @@ -460,7 +460,7 @@ While most of your API interaction should occur using your server-to-server inst
* [List teams](/v3/teams/#list-teams)
* [Create a team](/v3/teams/#create-a-team)
* [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)
{% endif %}
* [Update a team](/v3/teams/#update-a-team)
Expand Down Expand Up @@ -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 latest pages build](/rest/reference/repos#get-latest-pages-build)

{% if currentVersion != "free-pro-team@latest" %}
{% if enterpriseServerVersions contains currentVersion %}
##### Repository Pre Receive Hooks

* [List pre-receive hooks for a repository](/enterprise/user/rest/reference/enterprise-admin#list-pre-receive-hooks-for-a-repository)
Expand Down
2 changes: 1 addition & 1 deletion content/developers/apps/scopes-for-oauth-apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ X-Accepted-OAuth-Scopes: user

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 %}
**`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.
&emsp;`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.
Expand Down
2 changes: 1 addition & 1 deletion content/developers/overview/replacing-github-services.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

{% if currentVersion != "free-pro-team@latest" %}
{% if enterpriseServerVersions contains currentVersion %}
### 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 %}

Expand Down
4 changes: 2 additions & 2 deletions content/developers/webhooks-and-events/about-webhooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 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

Expand Down
4 changes: 2 additions & 2 deletions content/developers/webhooks-and-events/issue-event-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -348,7 +348,7 @@ The issue or pull request was locked.

#### 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.api-preview-warning %}
{% endif %}
Expand Down Expand Up @@ -668,7 +668,7 @@ The issue was unlocked.

#### 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.api-preview-warning %}
{% endif %}
Expand Down
Loading

0 comments on commit f52410d

Please sign in to comment.