Skip to content

Commit

Permalink
Remove deprecated GHES versions from content and data (github#15830)
Browse files Browse the repository at this point in the history
* ran script/remove-unused-assets.js (manually removed unused variables printed by the script)

* package-lock

* turn elsif into two ifs to prepare for running Liquid deprecation script

* ran script/remove-deprecated-enterprise-version-markup.js --release 2.14 (ONLY UPDATES LINE BREAKS ETC.)

* ran script/remove-deprecated-enterprise-version-markup.js --release 2.15

* ran script/remove-deprecated-enterprise-version-markup.js --release 2.17

* ran script/remove-deprecated-enterprise-version-markup.js --release 2.18

* update hardcoded test

* Update content/github/collaborating-with-issues-and-pull-requests/filtering-files-in-a-pull-request.md

Co-authored-by: Matt Pollard <[email protected]>

* add currentVersion is NOT free-pro-team to conditional, to make sure the deprecation script does the right thing when it is time to deprecate 2.21

Co-authored-by: Matt Pollard <[email protected]>
  • Loading branch information
sarahs and mattpollard authored Oct 1, 2020
1 parent dc5b6f2 commit f272eec
Show file tree
Hide file tree
Showing 355 changed files with 346 additions and 566 deletions.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ Action metadata files use YAML syntax. If you're new to YAML, you can read "[Lea

This example configures two inputs: numOctocats and octocatEyeColor. The numOctocats input is not required and will default to a value of '1'. The octocatEyeColor input is required and has no default value. Workflow files that use this action must use the `with` keyword to set an input value for octocatEyeColor. For more information about the `with` syntax, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/articles/workflow-syntax-for-github-actions/#jobsjob_idstepswith)."


```yaml
inputs:
numOctocats:
Expand All @@ -54,7 +53,6 @@ inputs:
required: true
```
When you specify an input to an action in a workflow file or use a default input value, {% data variables.product.prodname_dotcom %} creates an environment variable for the input with the name `INPUT_<VARIABLE_NAME>`. The environment variable created converts input names to uppercase letters and replaces spaces with `_` characters.

For example, if a workflow defined the numOctocats and octocatEyeColor inputs, the action code could read the values of the inputs using the `INPUT_NUMOCTOCATS` and `INPUT_OCTOCATEYECOLOR` environment variables.
Expand Down
2 changes: 1 addition & 1 deletion content/actions/reference/events-that-trigger-workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -602,7 +602,7 @@ Runs your workflow anytime the `release` event occurs. {% data reusables.develop

| Webhook event payload | Activity types | `GITHUB_SHA` | `GITHUB_REF` |
| --------------------- | -------------- | ------------ | -------------|
| [`release`](/webhooks/event-payloads/#release) | - `published`{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %} <br/>- `unpublished` <br/>- `created` <br/>- `edited` <br/>- `deleted` <br/>- `prereleased`<br/> - `released`{% endif %} | Last commit in the tagged release | Tag of release |
| [`release`](/webhooks/event-payloads/#release) | - `published` <br/>- `unpublished` <br/>- `created` <br/>- `edited` <br/>- `deleted` <br/>- `prereleased`<br/> - `released` | Last commit in the tagged release | Tag of release |

{% data reusables.developer-site.limit_workflow_to_activity_types %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,6 @@ steps:
echo 'EOF' >> $GITHUB_ENV
```


### Adding a system path

`echo "{path}" >> $GITHUB_PATH`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -704,7 +704,6 @@ The `args` are used in place of the `CMD` instruction in a `Dockerfile`. If you
1. Use defaults that allow using the action without specifying any `args`.
1. If the action exposes a `--help` flag, or something similar, use that as the default to make your action self-documenting.


#### **`jobs.<job_id>.steps.with.entrypoint`**

Overrides the Docker `ENTRYPOINT` in the `Dockerfile`, or sets it if one wasn't already specified. Unlike the Docker `ENTRYPOINT` instruction which has a shell and exec form, `entrypoint` keyword accepts only a single string defining the executable to be run.
Expand Down Expand Up @@ -839,7 +838,6 @@ strategy:

You can use `include` to add new jobs to a build matrix. Any unmatched include configurations are added to the matrix. For example, if you want to use `node` version 12 to build on multiple operating systems, but wanted one extra experimental job using node version 13 on Ubuntu, you can use `include` to specify that additional job.


{% raw %}
```yaml
runs-on: ${{ matrix.os }}
Expand Down
2 changes: 0 additions & 2 deletions content/admin/configuration/command-line-utilities.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,15 +180,13 @@ This utility allows you to control the state of the installation's maintenance m
ghe-maintenance -h
```

{% if currentVersion ver_gt "[email protected]" %}
#### ghe-motd

This utility re-displays the message of the day (MOTD) that administrators see when accessing the instance via the administrative shell. The output contains an overview of the instance's state.

```shell
ghe-motd
```
{% endif %}

#### ghe-nwo

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,7 @@ Enabling {% data variables.product.prodname_github_connect %} also creates a {%

Enabling {% data variables.product.prodname_github_connect %} will not allow {% data variables.product.prodname_dotcom_the_website %} users to make changes to {% data variables.product.prodname_ghe_server %}.

{% if currentVersion ver_gt "[email protected]" %}
For more information about managing enterprise accounts using the GraphQL API, see "[Enterprise accounts](/v4/guides/managing-enterprise-accounts)."
{% endif %}
### Enabling {% data variables.product.prodname_github_connect %}

1. Sign in to {% data variables.product.product_location_enterprise %} and {% data variables.product.prodname_dotcom_the_website %}.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Geo DNS, such as [Amazon's Route 53 service](http://docs.aws.amazon.com/Route53/

### Limitations

Writing requests to the replica requires sending the data to the primary and all replicas. This means that the performance of all writes are limited by the slowest replica{% if currentVersion ver_gt "[email protected]" %}, although new geo-replicas can seed the majority of their data from existing co-located geo-replicas, rather than from the primary{% endif %}. Geo-replication will not add capacity to a {% data variables.product.prodname_ghe_server %} instance or solve performance issues related to insufficient CPU or memory resources. If the primary appliance is offline, active replicas will be unable to serve any read or write requests.
Writing requests to the replica requires sending the data to the primary and all replicas. This means that the performance of all writes are limited by the slowest replica, although new geo-replicas can seed the majority of their data from existing co-located geo-replicas, rather than from the primary. Geo-replication will not add capacity to a {% data variables.product.prodname_ghe_server %} instance or solve performance issues related to insufficient CPU or memory resources. If the primary appliance is offline, active replicas will be unable to serve any read or write requests.

### Monitoring a geo-replication configuration

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ To manage replication on {% data variables.product.prodname_ghe_server %}, use t

The `ghe-repl-setup` command puts a {% data variables.product.prodname_ghe_server %} appliance in replica standby mode.

- An encrypted {% if currentVersion ver_gt "[email protected]" %}WireGuard VPN{% else %}OpenVPN{% endif %} tunnel is configured for communication between the two appliances.
- An encrypted WireGuard VPN tunnel is configured for communication between the two appliances.
- Database services are configured for replication and started.
- Application services are disabled. Attempts to access the replica appliance over HTTP, Git, or other supported protocols will result in an "appliance in replica mode" maintenance page or error message.

Expand All @@ -71,8 +71,7 @@ Run `ghe-repl-start' to start replicating against the newly configured primary.
The `ghe-repl-start` command turns on active replication of all datastores.

```shell
admin@169-254-1-2:~$ ghe-repl-start{% if currentVersion ver_lt "[email protected]" %}
Starting OpenVPN tunnel ... {% endif %}
admin@169-254-1-2:~$ ghe-repl-start
Starting MySQL replication ...
Starting Redis replication ...
Starting Elasticsearch replication ...
Expand Down Expand Up @@ -144,8 +143,7 @@ Stopping Pages replication ...
Stopping Git replication ...
Stopping MySQL replication ...
Stopping Redis replication ...
Stopping Elasticsearch replication ...{% if currentVersion ver_lt "[email protected]" %}
Stopping OpenVPN tunnel ...{% endif %}
Stopping Elasticsearch replication ...
Success: replication was stopped for all services.
```
Expand All @@ -163,8 +161,7 @@ Stopping replication ...
| Stopping Git replication ...
| Stopping MySQL replication ...
| Stopping Redis replication ...
| Stopping Elasticsearch replication ...{% if currentVersion ver_lt "[email protected]" %}
| Stopping OpenVPN tunnel ...{% endif %}
| Stopping Elasticsearch replication ...
| Success: replication was stopped for all services.
Switching out of replica mode ...
| Success: Replication configuration has been removed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,6 @@ If a network level firewall is in place between nodes, these ports will need to
| 8302/UDP | Consul |
| 25827/UDP | Collectd |


### Configuring a load balancer

We recommend an external TCP-based load balancer that supports the PROXY protocol to distribute traffic across nodes. Consider these load balancer configurations:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ This example configuration uses a primary and two replicas, which are located in
(replica2)$ ghe-repl-setup --add <em>PRIMARY IP</em>
(replica2)$ ghe-repl-start
```
3. By default, replicas are configured to the same datacenter{% if currentVersion ver_gt "[email protected]" %}, and will now attempt to seed from an existing node in the same datacenter{% endif %}. Configure the replicas for different datacenters by setting a different value for the datacenter option. The specific values can be anything you would like as long as they are different from each other. Run the `ghe-repl-node` command on each node and specify the datacenter.
3. By default, replicas are configured to the same datacenter, and will now attempt to seed from an existing node in the same datacenter. Configure the replicas for different datacenters by setting a different value for the datacenter option. The specific values can be anything you would like as long as they are different from each other. Run the `ghe-repl-node` command on each node and specify the datacenter.

On the primary:
```shell
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,5 @@ For the complete documentation for {% data variables.product.prodname_enterprise

- Perform changes to the {% data variables.enterprise.management_console %}. For more information, see "[{% data variables.enterprise.management_console %}](/enterprise/{{ currentVersion }}/user/rest/reference/enterprise-admin#management-console)."
- Collect statistics about your instance. For more information, see "[Admin stats](/enterprise/{{ currentVersion }}/user/rest/reference/enterprise-admin#admin-stats)."
- Configure LDAP sync. For more information, see "[LDAP](/enterprise/{{ currentVersion }}/user/rest/reference/enterprise-admin#ldap)."{% if currentVersion ver_gt "[email protected]" %}
- Manage your enterprise account. For more information, see "[Enterprise accounts](/v4/guides/managing-enterprise-accounts)."{% endif %}
- Configure LDAP sync. For more information, see "[LDAP](/enterprise/{{ currentVersion }}/user/rest/reference/enterprise-admin#ldap)."
- Manage your enterprise account. For more information, see "[Enterprise accounts](/v4/guides/managing-enterprise-accounts)."
Original file line number Diff line number Diff line change
Expand Up @@ -230,4 +230,3 @@ If necessary, you can prevent repository administrators from changing anonymous
8. Optionally, to prevent repository admins from changing this setting for this repository, select **Prevent repository admins from changing anonymous Git read access**.
![Select checkbox to prevent repository admins from changing anonymous Git read access for this repository](/assets/images/enterprise/site-admin-settings/lock_anonymous_git_access_for_specific_repo.png)


1 change: 0 additions & 1 deletion content/developers/apps/authorizing-oauth-apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,6 @@ Name | Type | Description

##### Response


{% if currentVersion == "free-pro-team@latest" %}
```JSON
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ versions:
---



### Introduction

This guide will introduce you to [Github Apps](/apps/) and the [Checks API](/v3/checks/), which you'll use to build a continuous integration (CI) server that runs tests.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -273,11 +273,8 @@ While most of your API interaction should occur using your server-to-server inst

##### Git Refs

* [Create a reference](/v3/git/refs/#create-a-reference){% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "[email protected]" %}
* [List references](/v3/git/refs/#list-references)
* [Get a reference](/v3/git/refs/#get-a-reference){% else %}
* [Get a reference](/v3/git/refs/#get-a-reference)
* [List matching references](/v3/git/refs/#list-matching-references){% endif %}
* [Create a reference](/v3/git/refs/#create-a-reference)* [Get a reference](/v3/git/refs/#get-a-reference)
* [List matching references](/v3/git/refs/#list-matching-references)
* [Update a reference](/v3/git/refs/#update-a-reference)
* [Delete a reference](/v3/git/refs/#delete-a-reference)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ versions:

This article provides guidelines for existing integrators who are considering migrating from an OAuth App to a GitHub App.


### Reasons for switching to GitHub Apps

[GitHub Apps](/apps/) are the officially recommended way to integrate with GitHub because they offer many advantages over a pure OAuth-based integration:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ versions:
---



### Introduction

This guide will walk through the steps needed to configure a GitHub App and run it on a server. GitHub Apps require some setup steps to manage webhook events and connect the app registration on GitHub to your code. The app in this guide serves as a foundation that you can use to extend and build new GitHub Apps.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ versions:
---



### Introduction

This guide will help you build a GitHub App and run it on a server. The app you build will add a label to all new issues opened in the repository where the app is installed.
Expand Down
1 change: 0 additions & 1 deletion content/developers/overview/managing-deploy-keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ versions:
---



You can manage SSH keys on your servers when automating deployment scripts using SSH agent forwarding, HTTPS with OAuth tokens, deploy keys, or machine users.

### SSH agent forwarding
Expand Down
1 change: 0 additions & 1 deletion content/developers/overview/replacing-github-services.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ As an alternative to the email service, you can now start using email notificati

{% endnote %}


### Deprecation timeline

- **October 1, 2018**: GitHub discontinued allowing users to install services. We removed GitHub Services from the GitHub.com user interface.
Expand Down
1 change: 0 additions & 1 deletion content/developers/webhooks-and-events/about-webhooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ 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](/v3/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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ The Events API can return different types of events triggered by activity on Git

{% endif %}


### Event object common properties

The event objects returned from the Events API endpoints have the same structure.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ versions:

Issue events are triggered by activity in issues and pull requests and are available in the [Issue Events API](/v3/issues/events) and the [Timeline Events API](/v3/issues/timeline). Each event type specifies whether the event is available in the Issue Events or Timeline Events APIs.


GitHub's REST API considers every pull request to be an issue, but not every issue is a pull request. For this reason, the Issue Events and Timeline Events endpoints may return both issues and pull requests in the response. Pull requests have a `pull_request` property in the `issue` object. Because pull requests are issues, issue and pull request numbers do not overlap in a repository. For example, if you open your first issue in a repository, the number will be 1. If you then open a pull request, the number will be 2. Each event type specifies if the event occurs in pull request, issues, or both.

### Issue event object common properties
Expand Down
1 change: 0 additions & 1 deletion content/developers/webhooks-and-events/testing-webhooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ versions:
---



Now that you've [configured your local server](/webhooks/configuring/), you might
be interested in pushing your code to the limits. To that end, GitHub's webhooks
view provides some tooling for testing your deployed payloads.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ versions:

You can create webhooks that subscribe to the events listed on this page. Each webhook event includes a description of the webhook properties and an example payload. For more information, see "[Creating webhooks](/webhooks/creating/)."


### Webhook payload object common properties

Each webhook event payload also contains properties unique to the event. You can find the unique properties in the individual event type sections.
Expand Down Expand Up @@ -1295,7 +1294,6 @@ This event occurs when someone triggers a workflow run on GitHub or sends a `POS
{{ webhookPayloadsForCurrentVersion.workflow_dispatch }}
{% endif %}
### workflow_run
When a {% data variables.product.prodname_actions %} workflow run is requested or completed. For more information, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_run)."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ versions:
enterprise-server: '*'
---

When you enable branch restrictions, only users{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %},{% else %} or{% endif %} teams{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %}, or apps{% endif %} that have been given permission can push to the protected branch. For more information, see "[Enabling branch restrictions](/articles/enabling-branch-restrictions)" and "[About protected branches](/articles/about-protected-branches)." You can view and edit the users{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %},{% else %} or{% endif %} teams{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %}, or apps{% endif %} with push access to a protected branch in the protected branch's settings.
When you enable branch restrictions, only users, teams, or apps that have been given permission can push to the protected branch. For more information, see "[Enabling branch restrictions](/articles/enabling-branch-restrictions)" and "[About protected branches](/articles/about-protected-branches)." You can view and edit the users, teams, or apps with push access to a protected branch in the protected branch's settings.

You can only give push access to a protected branch to users{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %},{% else %} or{% endif %} teams{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %}, or installed {% data variables.product.prodname_github_apps %}{% endif %} with `write` access to a repository.
You can only give push access to a protected branch to users, teams, or installed {% data variables.product.prodname_github_apps %} with `write` access to a repository.

People{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %} and apps{% endif %} with admin permissions to a repository are always able to push to a protected branch.
People and apps with admin permissions to a repository are always able to push to a protected branch.

{% tip %}

**Note:** If "Include administrators" is selected, you've enabled required status checks on the branch, and if any status checks fail, any attempt to push changes to the protected branch will also fail, even for people{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %} and apps{% endif %} with admin permissions. For more information, see "[Enabling required status checks](/articles/enabling-required-status-checks)."
**Note:** If "Include administrators" is selected, you've enabled required status checks on the branch, and if any status checks fail, any attempt to push changes to the protected branch will also fail, even for people and apps with admin permissions. For more information, see "[Enabling required status checks](/articles/enabling-required-status-checks)."

{% endtip %}

Expand Down
Loading

0 comments on commit f272eec

Please sign in to comment.