jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-21 19:06:49 -05:00
Code Issues Projects Releases Wiki Activity

Merge branch 'main' into patch-1

Browse Source
This commit is contained in:
Janice
2020-11-06 14:08:13 -07:00
committed by GitHub
parent ca2df6966c ccebc21eda
commit 80532c43bf
63 changed files with 686 additions and 319 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
.editorconfig Normal file
View File

@@ -0,0 +1,11 @@
root = true
[*]
indent_style = space
indent_size = 2
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
[*.md]
trim_trailing_whitespace = false

2
.github/allowed-actions.js vendored
View File

@@ -5,7 +5,7 @@
module.exports = [
'actions/cache@d1255ad9362389eac595a9ae406b8e8cb3331f16', //actions/cache@v2.1.2
'actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675', //actions/checkout@v2.3.3
'actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f', //actions/checkout@v2.3.4
'actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9', //actions/script@v3.0.0
'actions/labeler@5f867a63be70efff62b767459b009290364495eb', //actions/labeler@v2.2.0
'actions/setup-node@56899e050abffc08c2b3b61f3ec6a79a9dc3223d', //actions/setup-node@v1.4.4

2
.github/workflows/browser-test.yml vendored
View File

@@ -26,7 +26,7 @@ jobs:
# Even if if doesn't do anything
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
name: Checkout
uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
name: Install

2
.github/workflows/check-all-english-links.yml vendored
View File

@@ -10,7 +10,7 @@ jobs:
if: github.repository == 'github/docs-internal'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
- uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
- name: npm ci
run: npm ci
- name: npm run build

2
.github/workflows/codeql.yml vendored
View File

@@ -11,7 +11,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
- uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
- uses: github/codeql-action/init@v1
with:
languages: javascript # comma separated list of values from {go, python, javascript, java, cpp, csharp} (not YET ruby, sorry!)

2
.github/workflows/crowdin.yml vendored
View File

@@ -12,7 +12,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
- name: Sync
uses: crowdin/github-action@fd9429dd63d6c0f8a8cb4b93ad8076990bd6e688

2
.github/workflows/dry-run-sync-algolia-search-indices.yml vendored
View File

@@ -10,7 +10,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: checkout
uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
- uses: actions/setup-node@56899e050abffc08c2b3b61f3ec6a79a9dc3223d
with:
node-version: 14.x

2
.github/workflows/js-lint.yml vendored
View File

@@ -29,7 +29,7 @@ jobs:
if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
steps:
- name: Check out repo
uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
- name: Setup node
uses: actions/setup-node@56899e050abffc08c2b3b61f3ec6a79a9dc3223d

3
.github/workflows/merged-notification.yml vendored
View File

@@ -1,10 +1,11 @@
name: Merged notification
on:
pull_request_target:
types: ['closed']
jobs:
comment:
if: github.event.repository.private == false && github.event.pull_request.merged && github.event.pull_request.base.ref == github.event.repository.default_branch
if: github.repository == 'github/docs' && github.event.pull_request.merged && github.event.pull_request.base.ref == github.event.repository.default_branch
runs-on: ubuntu-latest
steps:
- uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9

2
.github/workflows/pa11y.yml vendored
View File

@@ -8,7 +8,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Check out repo
uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
- name: Get npm cache directory
id: npm-cache

2
.github/workflows/ping-staging-apps.yml vendored
View File

@@ -12,7 +12,7 @@ jobs:
env:
HEROKU_API_TOKEN: ${{ secrets.HEROKU_API_TOKEN }}
steps:
- uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
- uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
- name: npm ci
run: npm ci
- name: npm run build

2
.github/workflows/remove-unused-assets.yml vendored
View File

@@ -18,7 +18,7 @@ jobs:
echo 'The repo is currently frozen! Exiting this workflow.'
exit 1 # prevents further steps from running
- name: Checkout
uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
- name: npm ci
run: npm ci
- name: Run scripts

2
.github/workflows/repo-sync.yml vendored
View File

@@ -32,7 +32,7 @@ jobs:
steps:
- name: Check out repo
uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
- name: Sync repo to branch
uses: repo-sync/github-sync@3832fe8e2be32372e1b3970bbae8e7079edeec88

2
.github/workflows/sync-algolia-search-indices.yml vendored
View File

@@ -13,7 +13,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: checkout
uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
- uses: actions/setup-node@56899e050abffc08c2b3b61f3ec6a79a9dc3223d
with:
node-version: 14.x

4
.github/workflows/test-translations.yml vendored
View File

@@ -12,7 +12,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Check out repo
uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
with:
ref: translations # check out the 'translations' branch
@@ -52,7 +52,7 @@ jobs:
test-group: [content, meta, rendering, routing, unit, links-and-images]
steps:
- name: Check out repo
uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
- name: Setup node
uses: actions/setup-node@56899e050abffc08c2b3b61f3ec6a79a9dc3223d

2
.github/workflows/test-windows.yml vendored
View File

@@ -19,7 +19,7 @@ jobs:
test-group: [content, meta, rendering, routing, unit, links-and-images]
steps:
- name: Check out repo
uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
- name: Setup node
uses: actions/setup-node@56899e050abffc08c2b3b61f3ec6a79a9dc3223d

3
.github/workflows/test.yml vendored
View File

@@ -32,6 +32,7 @@ jobs:
test:
needs: see_if_should_skip
runs-on: ubuntu-latest
timeout-minutes: 60
strategy:
fail-fast: false
matrix:
@@ -41,7 +42,7 @@ jobs:
# Even if if doesn't do anything
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
name: Check out repo
uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
name: Setup node

2
.github/workflows/update-graphql-files.yml vendored
View File

@@ -22,7 +22,7 @@ jobs:
echo 'The repo is currently frozen! Exiting this workflow.'
exit 1 # prevents further steps from running
- name: Checkout
uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
- name: Set up Ruby
uses: actions/setup-ruby@5f29a1cd8dfebf420691c4c9a0e832e2fae5a526
with:

BIN
assets/images/help/images/comparing-travis-with-actions.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 50 KiB

3
content/actions/learn-github-actions/index.md
View File

@@ -36,7 +36,8 @@ versions:
{% link_with_intro /managing-complex-workflows %}
{% link_with_intro /sharing-workflows-with-your-organization %}
{% link_with_intro /security-hardening-for-github-actions %}
{% link_with_intro /migrating-from-azure-pipelines-to-github-actions %}
{% link_with_intro /migrating-from-circleci-to-github-actions %}
{% link_with_intro /migrating-from-gitlab-cicd-to-github-actions %}
{% link_with_intro /migrating-from-azure-pipelines-to-github-actions %}
{% link_with_intro /migrating-from-jenkins-to-github-actions %}
{% link_with_intro /migrating-from-travis-ci-to-github-actions %}

410
content/actions/learn-github-actions/migrating-from-travis-ci-to-github-actions.md Normal file
View File

@@ -0,0 +1,410 @@
---
title: Migrating from Travis CI to GitHub Actions
intro: '{% data variables.product.prodname_actions %} and Travis CI share multiple similarities, which helps make it relatively straightforward to migrate to {% data variables.product.prodname_actions %}.'
redirect_from:
- /actions/migrating-to-github-actions/migrating-from-travis-ci-to-github-actions
versions:
free-pro-team: '*'
enterprise-server: '>=2.22'
---
### Introduction
This guide helps you migrate from Travis CI to {% data variables.product.prodname_actions %}. It compares their concepts and syntax, describes the similarities, and demonstrates their different approaches to common tasks.
### Before you start
Before starting your migration to {% data variables.product.prodname_actions %}, it would be useful to become familiar with how it works:
- For a quick example that demonstrates a {% data variables.product.prodname_actions %} job, see "[Quickstart for {% data variables.product.prodname_actions %}](/actions/quickstart)."
- To learn the essential {% data variables.product.prodname_actions %} concepts, see "[Introduction to GitHub Actions](/actions/learn-github-actions/introduction-to-github-actions)."
### Comparing job execution
To give you control over when CI tasks are executed, a {% data variables.product.prodname_actions %} _workflow_ uses _jobs_ that run in parallel by default. Each job contains _steps_ that are executed in a sequence that you define. If you need to run setup and cleanup actions for a job, you can define steps in each job to perform these.
### Key similarities
{% data variables.product.prodname_actions %} and Travis CI share certain similarities, and understanding these ahead of time can help smooth the migration process.
#### Using YAML syntax
Travis CI and {% data variables.product.prodname_actions %} both use YAML to create jobs and workflows, and these files are stored in the code's repository. For more information on how {% data variables.product.prodname_actions %} uses YAML, see ["Creating a workflow file](/actions/learn-github-actions/introduction-to-github-actions#create-an-example-workflow)."
#### Custom environment variables
Travis CI lets you set environment variables and share them between stages. Similarly, {% data variables.product.prodname_actions %} lets you define environment variables for a step, job, or workflow. For more information, see ["Environment variables](/actions/reference/environment-variables)."
#### Default environment variables
Travis CI and {% data variables.product.prodname_actions %} both include default environment variables that you can use in your YAML files. For {% data variables.product.prodname_actions %}, you can see these listed in "[Default environment variables](/actions/reference/environment-variables#default-environment-variables)."
#### Parallel job processing
Travis CI can use `stages` to run jobs in parallel. Similarly, {% data variables.product.prodname_actions %} runs `jobs` in parallel. For more information, see "[Creating dependent jobs](/actions/learn-github-actions/managing-complex-workflows#creating-dependent-jobs)."
#### Status badges
Travis CI and {% data variables.product.prodname_actions %} both support status badges, which let you indicate whether a build is passing or failing.
For more information, see ["Adding a workflow status badge to your repository](/actions/managing-workflow-runs/adding-a-workflow-status-badge)."
#### Using a build matrix
Travis CI and {% data variables.product.prodname_actions %} both support a build matrix, allowing you to perform testing using combinations of operating systems and software packages. For more information, see "[Using a build matrix](/actions/learn-github-actions/managing-complex-workflows#using-a-build-matrix)."
Below is an example comparing the syntax for each system:
<table>
<tr>
<th>
Travis CI
</th>
<th>
{% data variables.product.prodname_actions %}
</th>
</tr>
<tr>
<td class="d-table-cell v-align-top">
{% raw %}
```yaml
matrix:
include:
- rvm: 2.5
- rvm: 2.6.3
```
{% endraw %}
</td>
<td class="d-table-cell v-align-top">
{% raw %}
```yaml
jobs:
build:
strategy:
matrix:
ruby: [2.5, 2.6.3]
```
{% endraw %}
</td>
</tr>
</table>
#### Targeting specific branches
Travis CI and {% data variables.product.prodname_actions %} both allow you to target your CI to a specific branch. For more information, see "[Workflow syntax for GitHub Actions](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestbranchestags)."
Below is an example of the syntax for each system:
<table>
<tr>
<th>
Travis CI
</th>
<th>
{% data variables.product.prodname_actions %}
</th>
</tr>
<tr>
<td class="d-table-cell v-align-top">
{% raw %}
```yaml
branches:
only:
- main
- 'mona/octocat'
```
{% endraw %}
</td>
<td class="d-table-cell v-align-top">
{% raw %}
```yaml
on:
push:
branches:
- main
- 'mona/octocat'
```
{% endraw %}
</td>
</tr>
</table>
#### Checking out submodules
Travis CI and {% data variables.product.prodname_actions %} both allow you to control whether submodules are included in the repository clone.
Below is an example of the syntax for each system:
<table>
<tr>
<th>
Travis CI
</th>
<th>
{% data variables.product.prodname_actions %}
</th>
</tr>
<tr>
<td class="d-table-cell v-align-top">
{% raw %}
```yaml
git:
submodules: false
```
{% endraw %}
</td>
<td class="d-table-cell v-align-top">
{% raw %}
```yaml
- uses: actions/checkout@v2
with:
submodules: false
```
{% endraw %}
</td>
</tr>
</table>
### Key features in {% data variables.product.prodname_actions %}
When migrating from Travis CI, consider the following key features in {% data variables.product.prodname_actions %}:
#### Storing secrets
{% data variables.product.prodname_actions %} allows you to store secrets and reference them in your jobs. {% data variables.product.prodname_actions %} also includes policies that allow you to limit access to secrets at the repository and organization level. For more information, see "[Encrypted secrets](/actions/reference/encrypted-secrets)."
#### Sharing files between jobs and workflows
{% data variables.product.prodname_actions %} includes integrated support for artifact storage, allowing you to share files between jobs in a workflow. You can also save the resulting files and share them with other workflows. For more information, see "[Sharing data between jobs](/actions/learn-github-actions/essential-features-of-github-actions#sharing-data-between-jobs)."
#### Hosting your own runners
If your jobs require specific hardware or software, {% data variables.product.prodname_actions %} allows you to host your own runners and send your jobs to them for processing. {% data variables.product.prodname_actions %} also lets you use policies to control how these runners are accessed, granting access at the organization or repository level. For more information, see ["Hosting your own runners](/actions/hosting-your-own-runners)."
#### Concurrent jobs and execution time
The concurrent jobs and workflow execution times in {% data variables.product.prodname_actions %} can vary depending on your {% data variables.product.company_short %} plan. For more information, see "[Usage limits, billing, and administration](/actions/reference/usage-limits-billing-and-administration)."
#### Using different languages in {% data variables.product.prodname_actions %}
When working with different languages in {% data variables.product.prodname_actions %}, you can create a step in your job to set up your language dependencies. For more information about working with a particular language, see the specific guide:
- [Building and testing Node.js](/actions/guides/building-and-testing-nodejs)
- [Building and testing PowerShell](/actions/guides/building-and-testing-powershell)
- [Building and testing Python](/actions/guides/building-and-testing-python)
- [Building and testing Java with Maven](/actions/guides/building-and-testing-java-with-maven)
- [Building and testing Java with Gradle](/actions/guides/building-and-testing-java-with-gradle)
- [Building and testing Java with Ant](/actions/guides/building-and-testing-java-with-ant)
### Executing scripts
{% data variables.product.prodname_actions %} can use `run` steps to run scripts or shell commands. To use a particular shell, you can specify the `shell` type when providing the path to the script. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsrun)."
For example:
```yaml
steps:
- name: Run build script
run: ./.github/scripts/build.sh
shell: bash
```
### Error handling in {% data variables.product.prodname_actions %}
When migrating to {% data variables.product.prodname_actions %}, there are different approaches to error handling that you might need to be aware of.
#### Script error handling
{% data variables.product.prodname_actions %} stops a job immediately if one of the steps returns an error code. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#exit-codes-and-error-action-preference)."
#### Job error handling
{% data variables.product.prodname_actions %} uses `if` conditionals to execute jobs or steps in certain situations. For example, you can run a step when another step results in a `failure()`. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#example-using-status-check-functions)." You can also use [`continue-on-error`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idcontinue-on-error) to prevent a workflow run from stopping when a job fails.
### Migrating syntax for conditionals and expressions
To run jobs under conditional expressions, Travis CI and {% data variables.product.prodname_actions %} share a similar `if` condition syntax. {% data variables.product.prodname_actions %} lets you use the `if` conditional to prevent a job or step from running unless a condition is met. For more information, see "[Context and expression syntax for {% data variables.product.prodname_actions %}](/actions/reference/context-and-expression-syntax-for-github-actions)."
This example demonstrates how an `if` conditional can control whether a step is executed:
```yaml
jobs:
conditional:
runs-on: ubuntu-latest
steps:
- run: echo "This step runs with str equals 'ABC' and num equals 123"
if: env.str == 'ABC' && env.num == 123
```
### Migrating phases to steps
Where Travis CI uses _phases_ to run _steps_, {% data variables.product.prodname_actions %} has _steps_ which execute _actions_. You can find prebuilt actions in the [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace?type=actions), or you can create your own actions. For more information, see "[Building actions](/actions/building-actions)."
Below is an example of the syntax for each system:
<table>
<tr>
<th>
Travis CI
</th>
<th>
{% data variables.product.prodname_actions %}
</th>
</tr>
<tr>
<td class="d-table-cell v-align-top">
{% raw %}
```yaml
language: python
python:
- "3.7"
script:
- python script.py
```
{% endraw %}
</td>
<td class="d-table-cell v-align-top">
{% raw %}
```yaml
jobs:
run_python:
runs-on: ubuntu-latest
steps:
- uses: actions/setup-python@v2
with:
python-version: '3.7'
architecture: 'x64'
- run: python script.py
```
{% endraw %}
</td>
</tr>
</table>
### Caching dependencies
Travis CI and {% data variables.product.prodname_actions %} let you manually cache dependencies for later reuse. This example demonstrates the cache syntax for each system.
<table>
<tr>
<th>
Travis CI
</th>
<th>
GitHub Actions
</th>
</tr>
<tr>
<td class="d-table-cell v-align-top">
{% raw %}
```yaml
language: node_js
cache: npm
```
{% endraw %}
</td>
<td class="d-table-cell v-align-top">
{% raw %}
```yaml
- name: Cache node modules
uses: actions/cache@v2
with:
path: ~/.npm
key: v1-npm-deps-${{ hashFiles('**/package-lock.json') }}
restore-keys: v1-npm-deps-
```
{% endraw %}
</td>
</tr>
</table>
For more information, see "[Caching dependencies to speed up workflows](/actions/guides/caching-dependencies-to-speed-up-workflows)."
### Examples of common tasks
This section compares how {% data variables.product.prodname_actions %} and Travis CI perform common tasks.
#### Configuring environment variables
You can create custom environment variables in a {% data variables.product.prodname_actions %} job. For example:
<table>
<tr>
<th>
Travis CI
</th>
<th>
{% data variables.product.prodname_actions %} Workflow
</th>
</tr>
<tr>
<td>
```yaml
env:
- MAVEN_PATH="/usr/local/maven"
```
</td>
<td>
```yaml
jobs:
maven-build:
env:
MAVEN_PATH: '/usr/local/maven'
```
</td>
</tr>
</table>
#### Building with Node.js
<table>
<tr>
<th>
Travis CI
</th>
<th>
{% data variables.product.prodname_actions %} Workflow
</th>
</tr>
<tr>
<td>
{% raw %}
```yaml
install:
- npm install
script:
- npm run build
- npm test
```
{% endraw %}
</td>
<td>
{% raw %}
```yaml
name: Node.js CI
on: [push]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Use Node.js
uses: actions/setup-node@v1
with:
node-version: '12.x'
- run: npm install
- run: npm run build
- run: npm test
```
{% endraw %}
</td>
</tr>
</table>
### Next steps
To continue learning about the main features of {% data variables.product.prodname_actions %}, see "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)."

26
content/admin/enterprise-management/monitoring-cluster-nodes.md
View File

@@ -33,26 +33,34 @@ You can configure [Nagios](https://www.nagios.org/) to monitor {% data variables
#### Configuring the Nagios host
1. Generate an SSH key with a blank passphrase. Nagios uses this to authenticate to the {% data variables.product.prodname_ghe_server %} cluster.
```shell
nagiosuser@nagios:~$ <em>ssh-keygen -t rsa -b 4096</em>
> Generating public/private rsa key pair.
> Enter file in which to save the key (/home/nagiosuser/.ssh/id_rsa):
nagiosuser@nagios:~$ <em>ssh-keygen -t ed25519</em>
> Generating public/private ed25519 key pair.
> Enter file in which to save the key (/home/nagiosuser/.ssh/id_ed25519):
> Enter passphrase (empty for no passphrase): <em>leave blank by pressing enter</em>
> Enter same passphrase again: <em>press enter again</em>
> Your identification has been saved in /home/nagiosuser/.ssh/id_rsa.
> Your public key has been saved in /home/nagiosuser/.ssh/id_rsa.pub.
> Your identification has been saved in /home/nagiosuser/.ssh/id_ed25519.
> Your public key has been saved in /home/nagiosuser/.ssh/id_ed25519.pub.
```
{% danger %}
**Security Warning:** An SSH key without a passphrase can pose a security risk if authorized for full access to a host. Limit this key's authorization to a single read-only command.
{% enddanger %}
2. Copy the private key (`id_rsa`) to the `nagios` home folder and set the appropriate ownership.
{% note %}
**Note:** If you're using a distribution of Linux that doesn't support the Ed25519 algorithm, use the command:
```shell
nagiosuser@nagios:~$ <em>sudo cp .ssh/id_rsa /var/lib/nagios/.ssh/</em>
nagiosuser@nagios:~$ <em>sudo chown nagios:nagios /var/lib/nagios/.ssh/id_rsa</em>
nagiosuser@nagios:~$ ssh-keygen -t rsa -b 4096
```
3. To authorize the public key to run *only* the `ghe-cluster-status -n` command, use a `command=` prefix in the `/data/user/common/authorized_keys` file. From the administrative shell on any node, modify this file to add the public key generated in step 1. For example: `command="/usr/local/bin/ghe-cluster-status -n" ssh-rsa AAAA....`
{% endnote %}
2. Copy the private key (`id_ed25519`) to the `nagios` home folder and set the appropriate ownership.
```shell
nagiosuser@nagios:~$ <em>sudo cp .ssh/id_ed25519 /var/lib/nagios/.ssh/</em>
nagiosuser@nagios:~$ <em>sudo chown nagios:nagios /var/lib/nagios/.ssh/id_ed25519</em>
```
3. To authorize the public key to run *only* the `ghe-cluster-status -n` command, use a `command=` prefix in the `/data/user/common/authorized_keys` file. From the administrative shell on any node, modify this file to add the public key generated in step 1. For example: `command="/usr/local/bin/ghe-cluster-status -n" ssh-ed25519 AAAA....`
4. Validate and copy the configuration to each node in the cluster by running `ghe-cluster-config-apply` on the node where you modified the `/data/user/common/authorized_keys` file.

16
content/admin/policies/creating-a-pre-receive-hook-script.md
View File

@@ -103,8 +103,8 @@ You can test a pre-receive hook script locally before you create or update it on
adduser git -D -G root -h /home/git -s /bin/bash && \
passwd -d git && \
su git -c "mkdir /home/git/.ssh && \
ssh-keygen -t rsa -b 4096 -f /home/git/.ssh/id_rsa -P '' && \
mv /home/git/.ssh/id_rsa.pub /home/git/.ssh/authorized_keys && \
ssh-keygen -t ed25519 -f /home/git/.ssh/id_ed25519 -P '' && \
mv /home/git/.ssh/id_ed25519.pub /home/git/.ssh/authorized_keys && \
mkdir /home/git/test.git && \
git --bare init /home/git/test.git"
@@ -136,7 +136,7 @@ You can test a pre-receive hook script locally before you create or update it on
> Sending build context to Docker daemon 3.584 kB
> Step 1 : FROM gliderlabs/alpine:3.3
> ---> 8944964f99f4
> Step 2 : RUN apk add --no-cache git openssh bash && ssh-keygen -A && sed -i "s/#AuthorizedKeysFile/AuthorizedKeysFile/g" /etc/ssh/sshd_config && adduser git -D -G root -h /home/git -s /bin/bash && passwd -d git && su git -c "mkdir /home/git/.ssh && ssh-keygen -t rsa -b 4096 -f /home/git/.ssh/id_rsa -P ' && mv /home/git/.ssh/id_rsa.pub /home/git/.ssh/authorized_keys && mkdir /home/git/test.git && git --bare init /home/git/test.git"
> Step 2 : RUN apk add --no-cache git openssh bash && ssh-keygen -A && sed -i "s/#AuthorizedKeysFile/AuthorizedKeysFile/g" /etc/ssh/sshd_config && adduser git -D -G root -h /home/git -s /bin/bash && passwd -d git && su git -c "mkdir /home/git/.ssh && ssh-keygen -t ed25519 -f /home/git/.ssh/id_ed25519 -P ' && mv /home/git/.ssh/id_ed25519.pub /home/git/.ssh/authorized_keys && mkdir /home/git/test.git && git --bare init /home/git/test.git"
> ---> Running in e9d79ab3b92c
> fetch http://alpine.gliderlabs.com/alpine/v3.3/main/x86_64/APKINDEX.tar.gz
> fetch http://alpine.gliderlabs.com/alpine/v3.3/community/x86_64/APKINDEX.tar.gz
@@ -144,9 +144,9 @@ You can test a pre-receive hook script locally before you create or update it on
> OK: 34 MiB in 26 packages
> ssh-keygen: generating new host keys: RSA DSA ECDSA ED25519
> Password for git changed by root
> Generating public/private rsa key pair.
> Your identification has been saved in /home/git/.ssh/id_rsa.
> Your public key has been saved in /home/git/.ssh/id_rsa.pub.
> Generating public/private ed25519 key pair.
> Your identification has been saved in /home/git/.ssh/id_ed25519.
> Your public key has been saved in /home/git/.ssh/id_ed25519.pub.
....truncated output....
> Initialized empty Git repository in /home/git/test.git/
> Successfully built dd8610c24f82
@@ -174,7 +174,7 @@ You can test a pre-receive hook script locally before you create or update it on
9. Copy the generated SSH key from the data container to the local machine:
```shell
$ docker cp data:/home/git/.ssh/id_rsa .
$ docker cp data:/home/git/.ssh/id_ed25519 .
```
10. Modify the remote of a test repository and push to the `test.git` repo within the Docker container. This example uses `git@github.com:octocat/Hello-World.git` but you can use any repo you want. This example assumes your local machine (127.0.0.1) is binding port 52311, but you can use a different IP address if docker is running on a remote machine.
@@ -183,7 +183,7 @@ You can test a pre-receive hook script locally before you create or update it on
$ git clone git@github.com:octocat/Hello-World.git
$ cd Hello-World
$ git remote add test git@127.0.0.1:test.git
$ GIT_SSH_COMMAND="ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no -p 52311 -i ../id_rsa" git push -u test main
$ GIT_SSH_COMMAND="ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no -p 52311 -i ../id_ed25519" git push -u test main
> Warning: Permanently added '[192.168.99.100]:52311' (ECDSA) to the list of known hosts.
> Counting objects: 7, done.
> Delta compression using up to 4 threads.

1
content/github/building-a-strong-community/blocking-a-user-from-your-personal-account.md
View File

@@ -20,6 +20,7 @@ You can block a user in your account settings or from the user's profile. {% dat
When you block a user:
- The user stops following you
- The user stops watching and unpins your repositories
- The user is not able to join any organizations you are an owner of
- The user's stars and issue assignments are removed from your repositories
- The user's forks of your repositories are deleted
- You delete any forks of the user's repositories

1
content/github/setting-up-and-managing-your-enterprise/about-enterprise-accounts.md
View File

@@ -5,6 +5,7 @@ product: '{% data reusables.gated-features.enterprise-accounts %}'
redirect_from:
- /articles/about-github-business-accounts/
- /articles/about-enterprise-accounts
- /github/setting-up-and-managing-your-enterprise-account/about-enterprise-accounts
versions:
free-pro-team: '*'
enterprise-server: '*'

1
content/github/setting-up-and-managing-your-enterprise/adding-organizations-to-your-enterprise-account.md
View File

@@ -4,6 +4,7 @@ intro: You can create new organizations to manage within your enterprise account
product: '{% data reusables.gated-features.enterprise-accounts %}'
redirect_from:
- /articles/adding-organizations-to-your-enterprise-account
- /github/setting-up-and-managing-your-enterprise-account/adding-organizations-to-your-enterprise-account
versions:
free-pro-team: '*'
---

3
content/github/setting-up-and-managing-your-enterprise/configuring-saml-single-sign-on-and-scim-for-your-enterprise-account-using-okta.md
View File

@@ -4,6 +4,7 @@ intro: 'You can use Security Assertion Markup Language (SAML) single sign-on (SS
product: '{% data reusables.gated-features.enterprise-accounts %}'
redirect_from:
- /github/setting-up-and-managing-your-enterprise/configuring-single-sign-on-and-scim-for-your-enterprise-account-using-okta
- /github/setting-up-and-managing-your-enterprise-account/configuring-saml-single-sign-on-and-scim-for-your-enterprise-account-using-okta
versions:
free-pro-team: '*'
---
@@ -63,7 +64,7 @@ After you enable SCIM, the following provisioning features are available for any
1. Assign the application you created for your enterprise account to each group. {% data variables.product.prodname_dotcom %} will receive all `groups` data for each user.
1. Add users to groups based on the organizations you'd like users to belong to.
### Configuring user provisioning with SCIM in Okta
### Configuring user provisioning with SCIM in Okta
{% data reusables.scim.enterprise-account-scim %}

2
content/github/setting-up-and-managing-your-enterprise/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-enterprise-account.md
View File

@@ -2,6 +2,8 @@
title: Configuring the retention period for GitHub Actions artifacts and logs in your enterprise account
intro: 'Enterprise owners can configure the retention period for {% data variables.product.prodname_actions %} artifacts and logs in an enterprise account.'
product: '{% data reusables.gated-features.enterprise-accounts %}'
redirect_from:
- /github/setting-up-and-managing-your-enterprise-account/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-enterprise-account
miniTocMaxHeadingLevel: 4
versions:
free-pro-team: '*'

1
content/github/setting-up-and-managing-your-enterprise/configuring-webhooks-for-organization-events-in-your-enterprise-account.md
View File

@@ -5,6 +5,7 @@ product: '{% data reusables.gated-features.enterprise-accounts %}'
redirect_from:
- /articles/configuring-webhooks-for-organization-events-in-your-business-account/
- /articles/configuring-webhooks-for-organization-events-in-your-enterprise-account
- /github/setting-up-and-managing-your-enterprise-account/configuring-webhooks-for-organization-events-in-your-enterprise-account
versions:
free-pro-team: '*'
---

1
content/github/setting-up-and-managing-your-enterprise/enforcing-a-policy-on-dependency-insights-in-your-enterprise-account.md
View File

@@ -5,6 +5,7 @@ product: '{% data reusables.gated-features.enterprise-accounts %}'
redirect_from:
- /articles/enforcing-a-policy-on-dependency-insights/
- /articles/enforcing-a-policy-on-dependency-insights-in-your-enterprise-account
- /github/setting-up-and-managing-your-enterprise-account/enforcing-a-policy-on-dependency-insights-in-your-enterprise-account
versions:
free-pro-team: '*'
---

6
content/github/setting-up-and-managing-your-enterprise/enforcing-github-actions-policies-in-your-enterprise-account.md
View File

@@ -2,6 +2,8 @@
title: Enforcing GitHub Actions policies in your enterprise account
intro: 'Enterprise owners can disable, enable, and limit {% data variables.product.prodname_actions %} for an enterprise account.'
product: '{% data reusables.gated-features.enterprise-accounts %}'
redirect_from:
- /github/setting-up-and-managing-your-enterprise-account/enforcing-github-actions-policies-in-your-enterprise-account
miniTocMaxHeadingLevel: 4
versions:
free-pro-team: '*'
@@ -9,13 +11,13 @@ versions:
### About {% data variables.product.prodname_actions %} permissions for your enterprise account
By default, {% data variables.product.prodname_actions %} is enabled in all organizations owned by an enterprise account. You can choose to disable {% data variables.product.prodname_actions %} for all organizations owned by an enterprise account, or only allow specified organizations. You can also limit the use of public actions, so that people can only use local actions that exist in your organization.
By default, {% data variables.product.prodname_actions %} is enabled in all organizations owned by an enterprise account. You can choose to disable {% data variables.product.prodname_actions %} for all organizations owned by an enterprise account, or only allow specified organizations. You can also limit the use of public actions, so that people can only use local actions that exist in your organization.
For more information about {% data variables.product.prodname_actions %}, see "[About {% data variables.product.prodname_actions %}](/actions/getting-started-with-github-actions/about-github-actions)."
### Managing {% data variables.product.prodname_actions %} permissions for your enterprise account
You can disable all workflows for an enterprise or set a policy that configures which actions can be used in an organization.
You can disable all workflows for an enterprise or set a policy that configures which actions can be used in an organization.
{% data reusables.actions.actions-use-policy-settings %}

1
content/github/setting-up-and-managing-your-enterprise/enforcing-project-board-policies-in-your-enterprise-account.md
View File

@@ -6,6 +6,7 @@ redirect_from:
- /articles/enforcing-project-board-settings-for-organizations-in-your-business-account/
- /articles/enforcing-project-board-policies-for-organizations-in-your-enterprise-account/
- /articles/enforcing-project-board-policies-in-your-enterprise-account
- /github/setting-up-and-managing-your-enterprise-account/enforcing-project-board-policies-in-your-enterprise-account
versions:
free-pro-team: '*'
---

7
content/github/setting-up-and-managing-your-enterprise/enforcing-repository-management-policies-in-your-enterprise-account.md
View File

@@ -6,6 +6,7 @@ redirect_from:
- /articles/enforcing-repository-management-settings-for-organizations-in-your-business-account/
- /articles/enforcing-repository-management-policies-for-organizations-in-your-enterprise-account/
- /articles/enforcing-repository-management-policies-in-your-enterprise-account
- /github/setting-up-and-managing-your-enterprise-account/enforcing-repository-management-policies-in-your-enterprise-account
versions:
free-pro-team: '*'
---
@@ -47,10 +48,10 @@ Across all organizations owned by your enterprise account, you can allow people
Across all organizations owned by your enterprise account, you can allow members to invite outside collaborators to repositories, restrict outside collaborator invitations to organization owners, or allow owners to administer the setting on the organization level.
{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.policies-tab %}
3. On the **Repository policies** tab, under "Repository invitations", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %}
4. Under "Repository invitations", use the drop-down menu and choose a policy.
3. On the **Repository policies** tab, under "Repository invitations", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %}
4. Under "Repository invitations", use the drop-down menu and choose a policy.
![Drop-down menu with outside collaborator invitation policy options](/assets/images/help/business-accounts/repository-invitation-policy-drop-down.png)
### Enforcing a policy on changing repository visibility

1
content/github/setting-up-and-managing-your-enterprise/enforcing-security-settings-in-your-enterprise-account.md
View File

@@ -8,6 +8,7 @@ redirect_from:
- /articles/enforcing-security-settings-for-organizations-in-your-enterprise-account/
- /articles/enforcing-security-settings-in-your-enterprise-account
- /github/articles/managing-allowed-ip-addresses-for-organizations-in-your-enterprise-account
- /github/setting-up-and-managing-your-enterprise-account/enforcing-security-settings-in-your-enterprise-account
versions:
free-pro-team: '*'
---

1
content/github/setting-up-and-managing-your-enterprise/enforcing-team-policies-in-your-enterprise-account.md
View File

@@ -6,6 +6,7 @@ redirect_from:
- /articles/enforcing-team-settings-for-organizations-in-your-business-account/
- /articles/enforcing-team-policies-for-organizations-in-your-enterprise-account/
- /articles/enforcing-team-policies-in-your-enterprise-account
- /github/setting-up-and-managing-your-enterprise-account/enforcing-team-policies-in-your-enterprise-account
versions:
free-pro-team: '*'
---

3
content/github/setting-up-and-managing-your-enterprise/managing-licenses-for-visual-studio-subscription-with-github-enterprise.md
View File

@@ -5,11 +5,12 @@ redirect_from:
- /github/setting-up-and-managing-your-enterprise/managing-licenses-for-the-github-enterprise-and-visual-studio-bundle
- /github/articles/about-the-github-and-visual-studio-bundle
- /articles/about-the-github-and-visual-studio-bundle
- /github/setting-up-and-managing-your-enterprise-account/managing-licenses-for-visual-studio-subscription-with-github-enterprise
versions:
free-pro-team: '*'
---
### About {% data variables.product.prodname_vss_ghe %}
### About {% data variables.product.prodname_vss_ghe %}
{% data variables.product.prodname_vss_ghe %} is a combined offering from Microsoft that allows a subscriber to use both {% data variables.product.prodname_enterprise %} and {% data variables.product.prodname_vs %}. {% data variables.product.prodname_vss_ghe %} is available from Microsoft under the terms of the Microsoft Enterprise Agreement. For more information, see [{% data variables.product.prodname_vss_ghe %}](https://visualstudio.microsoft.com/subscriptions/visual-studio-github/) on the {% data variables.product.prodname_vs %} website.

2
content/github/setting-up-and-managing-your-enterprise/managing-organizations-in-your-enterprise-account.md
View File

@@ -4,7 +4,7 @@ product: '{% data reusables.gated-features.enterprise-accounts %}'
mapTopic: true
redirect_from:
- /articles/managing-organizations-in-your-enterprise-account
- /github/setting-up-and-managing-your-enterprise-account/managing-organizations-in-your-enterprise-account
versions:
free-pro-team: '*'
---

2
content/github/setting-up-and-managing-your-enterprise/managing-unowned-organizations-in-your-enterprise-account.md
View File

@@ -3,6 +3,8 @@ title: Managing unowned organizations in your enterprise account
intro: You can become an owner of an organization in your enterprise account that currently has no owners.
product: '{% data reusables.gated-features.enterprise-accounts %}'
permissions: Enterprise owners can manage unowned organizations in an enterprise account.
redirect_from:
- /github/setting-up-and-managing-your-enterprise-account/managing-unowned-organizations-in-your-enterprise-account
versions:
free-pro-team: '*'
---

2
content/github/setting-up-and-managing-your-enterprise/managing-users-in-your-enterprise.md
View File

@@ -4,6 +4,7 @@ product: '{% data reusables.gated-features.enterprise-accounts %}'
mapTopic: true
redirect_from:
- /github/setting-up-and-managing-your-enterprise/managing-users-in-your-enterprise-account
- /github/setting-up-and-managing-your-enterprise-account/managing-users-in-your-enterprise-account
- /articles/managing-users-in-your-enterprise-account
- /articles/managing-users-in-your-enterprise
versions:
@@ -11,4 +12,3 @@ versions:
enterprise-server: '*'
github-ae: '*'
---

2
content/github/setting-up-and-managing-your-enterprise/setting-policies-for-organizations-in-your-enterprise-account.md
View File

@@ -4,7 +4,7 @@ product: '{% data reusables.gated-features.enterprise-accounts %}'
mapTopic: true
redirect_from:
- /articles/setting-policies-for-organizations-in-your-enterprise-account
- /github/setting-up-and-managing-your-enterprise-account/setting-policies-for-organizations-in-your-enterprise-account
versions:
free-pro-team: '*'
---

1
content/github/setting-up-and-managing-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise.md
View File

@@ -5,6 +5,7 @@ permissions: Enterprise owners can view and manage a member's SAML access to an
product: '{% data reusables.gated-features.enterprise-accounts %}'
redirect_from:
- /github/setting-up-and-managing-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise-account
- /github/setting-up-and-managing-your-enterprise-account/viewing-and-managing-a-users-saml-access-to-your-enterprise-account
versions:
free-pro-team: '*'
---

1
content/github/setting-up-and-managing-your-enterprise/viewing-the-audit-logs-for-organizations-in-your-enterprise-account.md
View File

@@ -5,6 +5,7 @@ product: '{% data reusables.gated-features.enterprise-accounts %}'
redirect_from:
- /articles/viewing-the-audit-logs-for-organizations-in-your-business-account/
- /articles/viewing-the-audit-logs-for-organizations-in-your-enterprise-account
- /github/setting-up-and-managing-your-enterprise-account/viewing-the-audit-logs-for-organizations-in-your-enterprise-account
versions:
free-pro-team: '*'
---

2
content/github/site-policy/github-insights-and-data-protection-for-your-organization.md
View File

@@ -5,9 +5,7 @@ product: '{% data reusables.gated-features.github-insights %}'
redirect_from:
- /github/installing-and-configuring-github-insights/github-insights-and-data-protection-for-your-organization
versions:
free-pro-team: '*'
enterprise-server: '*'
github-ae: '*'
---
For more information about the terms that govern {% data variables.product.prodname_insights %}, see your {% data variables.product.prodname_ghe_one %} subscription agreement.

1
content/github/site-policy/guidelines-for-legal-requests-of-user-data.md
View File

@@ -194,7 +194,6 @@ In addition to the non-public user account information and account access logs m
- Any security keys used for authentication or encryption
- <a name="in-exigent-circumstances"></a>
**Under exigent circumstances** —
If we receive a request for information under certain exigent circumstances (where we believe the disclosure is necessary to prevent an emergency involving danger of death or serious physical injury to a person), we may disclose limited information that we determine necessary to enable law enforcement to address the emergency. For any information beyond that, we would require a subpoena, search warrant, or court order, as described above. For example, we will not disclose contents of private repositories without a search warrant. Before disclosing information, we confirm that the request came from a law enforcement agency, an authority sent an official notice summarizing the emergency, and how the information requested will assist in addressing the emergency.

2
content/github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site.md
View File

@@ -40,7 +40,7 @@ To set up a `www` or custom subdomain, such as `www.example.com` or `blog.exampl
{% data reusables.pages.navigate-site-repo %}
{% data reusables.repositories.sidebar-settings %}
{% data reusables.pages.save-custom-domain %}
5. Navigate to your DNS provider and create a `CNAME` record that points your subdomain to the default domain for your site. For example, if you want to use the subdomain `www.example.com` for your user site, create a `CNAME` record that points `www.example.com` to `<user>.github.io`. If you want to use the subdomain `www.anotherexample.com` for your organization site, create a `CNAME` record that points `www.anotherexample.com` to `<organization>.github.io`. The `CNAME` file should always point to `<user>.github.io` or `<organization>.github.io`, excluding the repository name. {% data reusables.pages.contact-dns-provider %}{% data reusables.pages.default-domain-information %}
5. Navigate to your DNS provider and create a `CNAME` record that points your subdomain to the default domain for your site. For example, if you want to use the subdomain `www.example.com` for your user site, create a `CNAME` record that points `www.example.com` to `<user>.github.io`. If you want to use the subdomain `www.anotherexample.com` for your organization site, create a `CNAME` record that points `www.anotherexample.com` to `<organization>.github.io`. The `CNAME` file should always point to `<user>.github.io` or `<organization>.github.io`, excluding the repository name. {% data reusables.pages.contact-dns-provider %} {% data reusables.pages.default-domain-information %}
{% data reusables.command_line.open_the_multi_os_terminal %}
6. To confirm that your DNS record configured correctly, use the `dig` command, replacing _WWW.EXAMPLE.COM_ with your subdomain.
```shell

20
content/rest/overview/api-previews.md
View File

@@ -81,15 +81,6 @@ Manage [projects](/v3/projects/).
**Custom media type:** `cloak-preview`
**Announced:** [2017-01-05](https://developer.github.com/changes/2017-01-05-commit-search-api/)
{% if currentVersion == "free-pro-team@latest" %}
### Community profile metrics
Retrieve [community profile metrics](/v3/repos/community/) (also known as community health) for any public repository.
**Custom media type:** `black-panther-preview`
**Announced:** [2017-02-09](https://developer.github.com/changes/2017-02-09-community-health/)
{% endif %}
{% if currentVersion == "free-pro-team@latest" %}
### User blocking
@@ -235,17 +226,6 @@ You can now provide more information in GitHub for URLs that link to registered
**Custom media types:** `corsair-preview`
**Announced:** [2018-12-10](https://developer.github.com/changes/2018-12-10-content-attachments-api/)
{% if currentVersion == "free-pro-team@latest" %}
### Interaction restrictions for repositories and organizations
Allows you to temporarily restrict interactions, such as commenting, opening issues, and creating pull requests, for {% data variables.product.product_name %} repositories or organizations. When enabled, only the specified group of {% data variables.product.product_name %} users will be able to participate in these interactions. See the [Repository interactions](/v3/interactions/repos/) and [Organization interactions](/v3/interactions/orgs/) APIs for more details.
**Custom media type:** `sombra-preview`
**Announced:** [2018-12-18](https://developer.github.com/changes/2018-12-18-interactions-preview/)
{% endif %}
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.21" %}
### Draft pull requests

174
content/rest/overview/libraries.md
View File

@@ -11,13 +11,12 @@ versions:
<div class="jumbotron libraries-jumbotron">
<img src="/assets/images/gundamcat.png" class="gundamcat" alt="The Gundamcat" />
<h1>Octokit comes in<br />
many flavors</h1>
<h1>Octokit comes in many flavors</h1>
<p class="lead">Use the official Octokit library, or choose between any of the available third party libraries.</p>
<div class="octokit-links">
<div class="octokit-language"><span>Ruby</span> <a href="https://github.com/octokit/octokit.rb">octokit.rb</a></div>
<div class="octokit-language"><span>.NET</span> <a href="https://github.com/octokit/octokit.net">octokit.net</a></div>
<div class="octokit-language"><span>JavaScript</span> <a href="https://github.com/octokit/rest.js">octokit/rest.js</a></div>
<div class="octokit-links"><br/>
<div class="octokit-language"> <span>Ruby → </span><a href="https://github.com/octokit/octokit.rb">octokit.rb</a></div><br/>
<div class="octokit-language"><span>.NET → </span> <a href="https://github.com/octokit/octokit.net">octokit.net</a></div><br/>
<div class="octokit-language"><span>JavaScript → </span> <a href="https://github.com/octokit/rest.js">octokit/rest.js</a></div><br/>
</div>
</div>
@@ -25,141 +24,118 @@ versions:
### Clojure
* [Tentacles][tentacles]
[tentacles]: https://github.com/Raynes/tentacles
Library name | Repository
|---|---|
**Tentacles**| [Raynes/tentacles](https://github.com/Raynes/tentacles)
### Dart
* [github.dart][github.dart]
[github.dart]: https://github.com/DirectMyFile/github.dart
Library name | Repository
|---|---|
**github.dart** | [DirectMyFile/github.dart](https://github.com/DirectMyFile/github.dart)
### Emacs Lisp
* [gh.el][gh.el]
[gh.el]: https://github.com/sigma/gh.el
Library name | Repository
|---|---|
**gh.el** | [sigma/gh.el](https://github.com/sigma/gh.el)
### Erlang
* [octo.erl][octo-erl]
[octo-erl]: https://github.com/sdepold/octo.erl
Library name | Repository
|---|---|
**octo-erl** | [sdepold/octo.erl](https://github.com/sdepold/octo.erl)
### Go
* [go-github][]
[go-github]: https://github.com/google/go-github
Library name | Repository
|---|---|
**go-github**| [google/go-github](https://github.com/google/go-github)
### Haskell
* [github][haskell-github]
[haskell-github]: https://github.com/fpco/GitHub
Library name | Repository
|---|---|
**haskell-github** | [fpco/Github](https://github.com/fpco/GitHub)
### Java
* The [GitHub Java API (org.eclipse.egit.github.core)](https://github.com/eclipse/egit-github/tree/master/org.eclipse.egit.github.core) library
is part of the [GitHub Mylyn Connector](https://github.com/eclipse/egit-github) and aims to support the entire
GitHub v3 API. Builds are available in [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Ca%3A%22org.eclipse.egit.github.core%22).
* [GitHub API for Java (org.kohsuke.github)](http://github-api.kohsuke.org/) defines an object oriented representation of the GitHub API.
* [JCabi GitHub API](http://github.jcabi.com) is based on Java7 JSON API (JSR-353), simplifies tests with a runtime GitHub stub, and
covers the entire API.
Library name | Repository | More information
|---|---|---|
**GitHub Java API**| [org.eclipse.egit.github.core](https://github.com/eclipse/egit-github/tree/master/org.eclipse.egit.github.core) | Is part of the [GitHub Mylyn Connector](https://github.com/eclipse/egit-github) and aims to support the entire GitHub v3 API. Builds are available in [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Ca%3A%22org.eclipse.egit.github.core%22).
**GitHub API for Java**| [org.kohsuke.github (From github-api)](http://github-api.kohsuke.org/)|defines an object oriented representation of the GitHub API.
**JCabi GitHub API**|[github.jcabi.com (Personal Website)](http://github.jcabi.com)|is based on Java7 JSON API (JSR-353), simplifies tests with a runtime GitHub stub, and covers the entire API.
### JavaScript
* [NodeJS GitHub library][octonode]
* [gh3 client-side API v3 wrapper][gh3]
* [GitHub.js wrapper around the GitHub API][github]
* [Promise-Based CoffeeScript library for the browser or NodeJS][github-client]
[octonode]: https://github.com/pksunkara/octonode
[gh3]: https://github.com/k33g/gh3
[github]: https://github.com/michael/github
[github-client]: https://github.com/philschatz/github-client
Library name | Repository |
|---|---|
**NodeJS GitHub library**| [pksunkara/octonode](https://github.com/pksunkara/octonode)
**gh3 client-side API v3 wrapper**| [k33g/gh3](https://github.com/k33g/gh3)
**Github.js wrapper around the GitHub API**|[michael/github](https://github.com/michael/github)
**Promise-Based CoffeeScript library for the Browser or NodeJS**|[philschatz/github-client](https://github.com/philschatz/github-client)
### Julia
* [GitHub.jl][github.jl]
[github.jl]: https://github.com/WestleyArgentum/GitHub.jl
Library name | Repository |
|---|---|
**Github.jl**|[WestleyArgentum/Github.jl](https://github.com/WestleyArgentum/GitHub.jl)
### OCaml
* [ocaml-github][ocaml-github]
[ocaml-github]: https://github.com/mirage/ocaml-github
Library name | Repository |
|---|---|
**ocaml-github**|[mirage/ocaml-github](https://github.com/mirage/ocaml-github)
### Perl
* [Pithub][pithub-github] ([CPAN][pithub-cpan])
* [Net::GitHub][net-github-github] ([CPAN][net-github-cpan])
[net-github-github]: https://github.com/fayland/perl-net-github
[net-github-cpan]: https://metacpan.org/pod/Net::GitHub
[pithub-github]: https://github.com/plu/Pithub
[pithub-cpan]: http://metacpan.org/module/Pithub
Library name | Repository | metacpan Website for the Library
|---|---|---|
**Pithub**|[plu/Pithub](https://github.com/plu/Pithub)|[Pithub CPAN](http://metacpan.org/module/Pithub)
**Net::Github**|[fayland/perl-net-github](https://github.com/fayland/perl-net-github)|[Net:Github CPAN](https://metacpan.org/pod/Net::GitHub)
### PHP
* [GitHub PHP Client][github-php-client]
* [PHP GitHub API][php-github-api]
* [GitHub API][github-api]
* [GitHub Joomla! Package][joomla]
* [Github Nette Extension][kdyby-github]
* [GitHub API Easy Access][milo-github-api]
* [GitHub bridge for Laravel][github-laravel]
* [PHP5.6|PHP7 Client & WebHook wrapper][flexyproject-githubapi]
[github-php-client]: https://github.com/tan-tan-kanarek/github-php-client
[php-github-api]: https://github.com/KnpLabs/php-github-api
[github-api]: https://github.com/yiiext/github-api
[joomla]: https://github.com/joomla-framework/github-api
[kdyby-github]: https://github.com/kdyby/github
[milo-github-api]: https://github.com/milo/github-api
[github-laravel]: https://github.com/GrahamCampbell/Laravel-GitHub
[flexyproject-githubapi]: https://github.com/FlexyProject/GitHubAPI
Library name | Repository
|---|---|
**GitHub PHP Client**|[tan-tan-kanarek/github-php-client](https://github.com/tan-tan-kanarek/github-php-client)
**PHP GitHub API**|[KnpLabs/php-github-api](https://github.com/KnpLabs/php-github-api)
**GitHub API**|[yiiext/github-api](https://github.com/yiiext/github-api)
**GitHub Joomla! Package**|[joomla-framework/github-api](https://github.com/joomla-framework/github-api)
**GitHub Nette Extension**|[kdyby/github](https://github.com/kdyby/github)
**GitHub API Easy Access**|[milo/github-api](https://github.com/milo/github-api)
**GitHub bridge for Laravel**|[GrahamCampbell/Laravel-Github](https://github.com/GrahamCampbell/Laravel-GitHub)
**PHP7 Client & WebHook wrapper**|[FlexyProject/GithubAPI](https://github.com/FlexyProject/GitHubAPI)
### Python
* [PyGithub][jacquev6_pygithub]
* [libsaas][libsaas]
* [github3.py][github3py]
* [sanction][sanction]
* [agithub][agithub]
* [octohub][octohub]
* [Github-Flask][github-flask]
* [torngithub][torngithub]
[jacquev6_pygithub]: https://github.com/PyGithub/PyGithub
[libsaas]: https://github.com/ducksboard/libsaas
[github3py]: https://github.com/sigmavirus24/github3.py
[sanction]: https://github.com/demianbrecht/sanction
[agithub]: https://github.com/jpaugh/agithub "Agnostic GitHub"
[octohub]: https://github.com/turnkeylinux/octohub
[github-flask]: http://github-flask.readthedocs.org
[torngithub]: https://github.com/jkeylu/torngithub
Library name | Repository
|---|---|
**PyGithub**|[PyGithub/PyGithub](https://github.com/PyGithub/PyGithub)
**libsaas**|[duckboard/libsaas](https://github.com/ducksboard/libsaas)
**github3.py**|[sigmavirus24/github3.py](https://github.com/sigmavirus24/github3.py)
**sanction**|[demianbrecht/sanction](https://github.com/demianbrecht/sanction)
**agithub**|[jpaugh/agithub](https://github.com/jpaugh/agithub)
**octohub**|[turnkeylinux/octohub](https://github.com/turnkeylinux/octohub)
**github-flask**|[github-flask (Oficial Website)](http://github-flask.readthedocs.org)
**torngithub**|[jkeylu/torngithub](https://github.com/jkeylu/torngithub)
### Ruby
* [GitHub API Gem][ghapi]
* [Ghee][ghee]
[ghapi]: https://github.com/peter-murach/github
[ghee]: https://github.com/rauhryan/ghee
Library name | Repository
|---|---|
**GitHub API Gem**|[peter-murach/github](https://github.com/peter-murach/github)
**Ghee**|[rauhryan/ghee](https://github.com/rauhryan/ghee)
### Scala
* [Hubcat][hubcat]
* [Github4s][github4s]
[hubcat]: https://github.com/softprops/hubcat
[Github4s]: https://github.com/47deg/github4s
Library name | Repository
|---|---|
**Hubcat**|[softprops/hubcat](https://github.com/softprops/hubcat)
**Github4s**|[47deg/github4s](https://github.com/47deg/github4s)
### Shell
* [ok.sh][ok.sh]
[ok.sh]: https://github.com/whiteinge/ok.sh
Library name | Repository
|---|---|
**ok.sh**|[whiteinge/ok.sh](https://github.com/whiteinge/ok.sh)

2
contributing/content-markup-reference.md
View File

@@ -64,7 +64,7 @@ Octicons are icons used across GitHub’s interface. We reference Octicons when
`{% octicon "<name of octicon>" %}`
`{% octicon "plus" %}`
`{% octicon "plus" aria-label="The plus icon"}`
`{% octicon "plus" aria-label="The plus icon" %}`
## Operating system tags

18
data/graphql/ghae/graphql_upcoming_changes.public-ghae.yml
View File

@@ -66,18 +66,6 @@ upcoming_changes:
date: '2020-10-01T00:00:00+00:00'
criticality: breaking
owner: mikesea
- location: RepositoryCollaboratorEdge.permission
description: Type for `permission` will change from `RepositoryPermission!` to `String`.
reason: This field may return additional values
date: '2020-10-01T00:00:00+00:00'
criticality: breaking
owner: oneill38
- location: RepositoryInvitation.permission
description: Type for `permission` will change from `RepositoryPermission!` to `String`.
reason: This field may return additional values
date: '2020-10-01T00:00:00+00:00'
criticality: breaking
owner: oneill38
- location: RepositoryInvitationOrderField.INVITEE_LOGIN
description: "`INVITEE_LOGIN` will be removed."
reason: "`INVITEE_LOGIN` is no longer a valid field value. Repository invitations
@@ -91,12 +79,6 @@ upcoming_changes:
date: '2020-10-01T00:00:00+00:00'
criticality: breaking
owner: nholden
- location: TeamRepositoryEdge.permission
description: Type for `permission` will change from `RepositoryPermission!` to `String`.
reason: This field may return additional values
date: '2020-10-01T00:00:00+00:00'
criticality: breaking
owner: oneill38
- location: EnterpriseMemberEdge.isUnlicensed
description: "`isUnlicensed` will be removed."
reason: All members consume a license

27
data/graphql/ghae/schema.docs-ghae.graphql
View File

@@ -1180,6 +1180,16 @@ type Bot implements Actor & Node & UniformResourceLocatable {
A branch protection rule.
"""
type BranchProtectionRule implements Node {
"""
Can this branch be deleted.
"""
allowsDeletions: Boolean!
"""
Are force pushes allowed on this branch.
"""
allowsForcePushes: Boolean!
"""
A list of conflicts matching branches protection rule and other branch protection rules
"""
@@ -1316,6 +1326,11 @@ type BranchProtectionRule implements Node {
"""
requiresCommitSignatures: Boolean!
"""
Are merge commits prohibited from being pushed to this branch.
"""
requiresLinearHistory: Boolean!
"""
Are status checks required to update matching branches.
"""
@@ -27827,10 +27842,6 @@ type RepositoryCollaboratorEdge {
"""
The permission the user has on the repository.
**Upcoming Change on 2020-10-01 UTC**
**Description:** Type for `permission` will change from `RepositoryPermission!` to `String`.
**Reason:** This field may return additional values
"""
permission: RepositoryPermission!
@@ -28117,10 +28128,6 @@ type RepositoryInvitation implements Node {
"""
The permission granted on this repository by this invitation.
**Upcoming Change on 2020-10-01 UTC**
**Description:** Type for `permission` will change from `RepositoryPermission!` to `String`.
**Reason:** This field may return additional values
"""
permission: RepositoryPermission!
@@ -32583,10 +32590,6 @@ type TeamRepositoryEdge {
"""
The permission level the team has on the repository
**Upcoming Change on 2020-10-01 UTC**
**Description:** Type for `permission` will change from `RepositoryPermission!` to `String`.
**Reason:** This field may return additional values
"""
permission: RepositoryPermission!
}

18
data/graphql/graphql_upcoming_changes.public.yml
View File

@@ -73,18 +73,6 @@ upcoming_changes:
date: '2020-10-01T00:00:00+00:00'
criticality: breaking
owner: mikesea
- location: RepositoryCollaboratorEdge.permission
description: Type for `permission` will change from `RepositoryPermission!` to `String`.
reason: This field may return additional values
date: '2020-10-01T00:00:00+00:00'
criticality: breaking
owner: oneill38
- location: RepositoryInvitation.permission
description: Type for `permission` will change from `RepositoryPermission!` to `String`.
reason: This field may return additional values
date: '2020-10-01T00:00:00+00:00'
criticality: breaking
owner: oneill38
- location: RepositoryInvitationOrderField.INVITEE_LOGIN
description: "`INVITEE_LOGIN` will be removed."
reason: "`INVITEE_LOGIN` is no longer a valid field value. Repository invitations
@@ -98,12 +86,6 @@ upcoming_changes:
date: '2020-10-01T00:00:00+00:00'
criticality: breaking
owner: nholden
- location: TeamRepositoryEdge.permission
description: Type for `permission` will change from `RepositoryPermission!` to `String`.
reason: This field may return additional values
date: '2020-10-01T00:00:00+00:00'
criticality: breaking
owner: oneill38
- location: EnterpriseMemberEdge.isUnlicensed
description: "`isUnlicensed` will be removed."
reason: All members consume a license

27
data/graphql/schema.docs.graphql
View File

@@ -1200,6 +1200,16 @@ type Bot implements Actor & Node & UniformResourceLocatable {
A branch protection rule.
"""
type BranchProtectionRule implements Node {
"""
Can this branch be deleted.
"""
allowsDeletions: Boolean!
"""
Are force pushes allowed on this branch.
"""
allowsForcePushes: Boolean!
"""
A list of conflicts matching branches protection rule and other branch protection rules
"""
@@ -1336,6 +1346,11 @@ type BranchProtectionRule implements Node {
"""
requiresCommitSignatures: Boolean!
"""
Are merge commits prohibited from being pushed to this branch.
"""
requiresLinearHistory: Boolean!
"""
Are status checks required to update matching branches.
"""
@@ -29748,10 +29763,6 @@ type RepositoryCollaboratorEdge {
"""
The permission the user has on the repository.
**Upcoming Change on 2020-10-01 UTC**
**Description:** Type for `permission` will change from `RepositoryPermission!` to `String`.
**Reason:** This field may return additional values
"""
permission: RepositoryPermission!
@@ -30033,10 +30044,6 @@ type RepositoryInvitation implements Node {
"""
The permission granted on this repository by this invitation.
**Upcoming Change on 2020-10-01 UTC**
**Description:** Type for `permission` will change from `RepositoryPermission!` to `String`.
**Reason:** This field may return additional values
"""
permission: RepositoryPermission!
@@ -34897,10 +34904,6 @@ type TeamRepositoryEdge {
"""
The permission level the team has on the repository
**Upcoming Change on 2020-10-01 UTC**
**Description:** Type for `permission` will change from `RepositoryPermission!` to `String`.
**Reason:** This field may return additional values
"""
permission: RepositoryPermission!
}

4
lib/graphql/static/prerendered-objects.json
View File

File diff suppressed because one or more lines are too long

30
lib/graphql/static/schema-dotcom.json
View File

@@ -6606,6 +6606,22 @@
}
],
"fields": [
{
"name": "allowsDeletions",
"description": "<p>Can this branch be deleted.</p>",
"type": "Boolean!",
"id": "boolean",
"kind": "scalars",
"href": "/graphql/reference/scalars#boolean"
},
{
"name": "allowsForcePushes",
"description": "<p>Are force pushes allowed on this branch.</p>",
"type": "Boolean!",
"id": "boolean",
"kind": "scalars",
"href": "/graphql/reference/scalars#boolean"
},
{
"name": "branchProtectionRuleConflicts",
"description": "<p>A list of conflicts matching branches protection rule and other branch protection rules.</p>",
@@ -6854,6 +6870,14 @@
"kind": "scalars",
"href": "/graphql/reference/scalars#boolean"
},
{
"name": "requiresLinearHistory",
"description": "<p>Are merge commits prohibited from being pushed to this branch.</p>",
"type": "Boolean!",
"id": "boolean",
"kind": "scalars",
"href": "/graphql/reference/scalars#boolean"
},
{
"name": "requiresStatusChecks",
"description": "<p>Are status checks required to update matching branches.</p>",
@@ -44354,7 +44378,7 @@
},
{
"name": "permission",
"description": "<p>The permission the user has on the repository.</p>\n<p><strong>Upcoming Change on 2020-10-01 UTC</strong>\n<strong>Description:</strong> Type for <code>permission</code> will change from <code>RepositoryPermission!</code> to <code>String</code>.\n<strong>Reason:</strong> This field may return additional values.</p>",
"description": "<p>The permission the user has on the repository.</p>",
"type": "RepositoryPermission!",
"id": "repositorypermission",
"kind": "enums",
@@ -44525,7 +44549,7 @@
},
{
"name": "permission",
"description": "<p>The permission granted on this repository by this invitation.</p>\n<p><strong>Upcoming Change on 2020-10-01 UTC</strong>\n<strong>Description:</strong> Type for <code>permission</code> will change from <code>RepositoryPermission!</code> to <code>String</code>.\n<strong>Reason:</strong> This field may return additional values.</p>",
"description": "<p>The permission granted on this repository by this invitation.</p>",
"type": "RepositoryPermission!",
"id": "repositorypermission",
"kind": "enums",
@@ -51056,7 +51080,7 @@
},
{
"name": "permission",
"description": "<p>The permission level the team has on the repository</p>\n<p><strong>Upcoming Change on 2020-10-01 UTC</strong>\n<strong>Description:</strong> Type for <code>permission</code> will change from <code>RepositoryPermission!</code> to <code>String</code>.\n<strong>Reason:</strong> This field may return additional values.</p>",
"description": "<p>The permission level the team has on the repository.</p>",
"type": "RepositoryPermission!",
"id": "repositorypermission",
"kind": "enums",

30
lib/graphql/static/schema-ghae.json
View File

@@ -5996,6 +5996,22 @@
}
],
"fields": [
{
"name": "allowsDeletions",
"description": "<p>Can this branch be deleted.</p>",
"type": "Boolean!",
"id": "boolean",
"kind": "scalars",
"href": "/graphql/reference/scalars#boolean"
},
{
"name": "allowsForcePushes",
"description": "<p>Are force pushes allowed on this branch.</p>",
"type": "Boolean!",
"id": "boolean",
"kind": "scalars",
"href": "/graphql/reference/scalars#boolean"
},
{
"name": "branchProtectionRuleConflicts",
"description": "<p>A list of conflicts matching branches protection rule and other branch protection rules.</p>",
@@ -6244,6 +6260,14 @@
"kind": "scalars",
"href": "/graphql/reference/scalars#boolean"
},
{
"name": "requiresLinearHistory",
"description": "<p>Are merge commits prohibited from being pushed to this branch.</p>",
"type": "Boolean!",
"id": "boolean",
"kind": "scalars",
"href": "/graphql/reference/scalars#boolean"
},
{
"name": "requiresStatusChecks",
"description": "<p>Are status checks required to update matching branches.</p>",
@@ -41603,7 +41627,7 @@
},
{
"name": "permission",
"description": "<p>The permission the user has on the repository.</p>\n<p><strong>Upcoming Change on 2020-10-01 UTC</strong>\n<strong>Description:</strong> Type for <code>permission</code> will change from <code>RepositoryPermission!</code> to <code>String</code>.\n<strong>Reason:</strong> This field may return additional values.</p>",
"description": "<p>The permission the user has on the repository.</p>",
"type": "RepositoryPermission!",
"id": "repositorypermission",
"kind": "enums",
@@ -41774,7 +41798,7 @@
},
{
"name": "permission",
"description": "<p>The permission granted on this repository by this invitation.</p>\n<p><strong>Upcoming Change on 2020-10-01 UTC</strong>\n<strong>Description:</strong> Type for <code>permission</code> will change from <code>RepositoryPermission!</code> to <code>String</code>.\n<strong>Reason:</strong> This field may return additional values.</p>",
"description": "<p>The permission granted on this repository by this invitation.</p>",
"type": "RepositoryPermission!",
"id": "repositorypermission",
"kind": "enums",
@@ -47929,7 +47953,7 @@
},
{
"name": "permission",
"description": "<p>The permission level the team has on the repository</p>\n<p><strong>Upcoming Change on 2020-10-01 UTC</strong>\n<strong>Description:</strong> Type for <code>permission</code> will change from <code>RepositoryPermission!</code> to <code>String</code>.\n<strong>Reason:</strong> This field may return additional values.</p>",
"description": "<p>The permission level the team has on the repository.</p>",
"type": "RepositoryPermission!",
"id": "repositorypermission",
"kind": "enums",

48
lib/graphql/static/upcoming-changes.json
View File

@@ -97,22 +97,6 @@
"criticality": "breaking",
"owner": "mikesea"
},
{
"location": "RepositoryCollaboratorEdge.permission",
"description": "<p>Type for <code>permission</code> will change from <code>RepositoryPermission!</code> to <code>String</code>.</p>",
"reason": "<p>This field may return additional values</p>",
"date": "2020-10-01",
"criticality": "breaking",
"owner": "oneill38"
},
{
"location": "RepositoryInvitation.permission",
"description": "<p>Type for <code>permission</code> will change from <code>RepositoryPermission!</code> to <code>String</code>.</p>",
"reason": "<p>This field may return additional values</p>",
"date": "2020-10-01",
"criticality": "breaking",
"owner": "oneill38"
},
{
"location": "RepositoryInvitationOrderField.INVITEE_LOGIN",
"description": "<p><code>INVITEE_LOGIN</code> will be removed.</p>",
@@ -128,14 +112,6 @@
"date": "2020-10-01",
"criticality": "breaking",
"owner": "nholden"
},
{
"location": "TeamRepositoryEdge.permission",
"description": "<p>Type for <code>permission</code> will change from <code>RepositoryPermission!</code> to <code>String</code>.</p>",
"reason": "<p>This field may return additional values</p>",
"date": "2020-10-01",
"criticality": "breaking",
"owner": "oneill38"
}
],
"2021-01-01": [
@@ -1811,22 +1787,6 @@
"criticality": "breaking",
"owner": "mikesea"
},
{
"location": "RepositoryCollaboratorEdge.permission",
"description": "<p>Type for <code>permission</code> will change from <code>RepositoryPermission!</code> to <code>String</code>.</p>",
"reason": "<p>This field may return additional values</p>",
"date": "2020-10-01",
"criticality": "breaking",
"owner": "oneill38"
},
{
"location": "RepositoryInvitation.permission",
"description": "<p>Type for <code>permission</code> will change from <code>RepositoryPermission!</code> to <code>String</code>.</p>",
"reason": "<p>This field may return additional values</p>",
"date": "2020-10-01",
"criticality": "breaking",
"owner": "oneill38"
},
{
"location": "RepositoryInvitationOrderField.INVITEE_LOGIN",
"description": "<p><code>INVITEE_LOGIN</code> will be removed.</p>",
@@ -1842,14 +1802,6 @@
"date": "2020-10-01",
"criticality": "breaking",
"owner": "nholden"
},
{
"location": "TeamRepositoryEdge.permission",
"description": "<p>Type for <code>permission</code> will change from <code>RepositoryPermission!</code> to <code>String</code>.</p>",
"reason": "<p>This field may return additional values</p>",
"date": "2020-10-01",
"criticality": "breaking",
"owner": "oneill38"
}
],
"2021-01-01": [

9
middleware/enterprise-data-endpoint.js
View File

@@ -1,9 +0,0 @@
// This middleware serves an endpoint that's used by https://github.com/docs/scheduled-tasks
module.exports = async (req, res, next) => {
if (req.path !== '/enterprise.json') return next()
return res.json({
enterpriseDates: require('../lib/enterprise-dates'),
enterpriseVersions: require('../lib/enterprise-server-releases')
})
}

7
middleware/events.js
View File

@@ -11,10 +11,17 @@ const router = express.Router()
router.post('/', async (req, res, next) => {
const fields = omit(req.body, '_csrf')
if (!ajv.validate(schema, fields)) {
if (process.env.NODE_ENV === 'development') console.log(ajv.errorsText())
return res.status(400).json({})
}
// Don't depend on Hydro on local development
if (process.env.NODE_ENV === 'development' && !req.hydro.maySend()) {
return res.status(200).json({})
}
try {
const hydroRes = await req.hydro.publish(
req.hydro.schemas[fields.type],

1
middleware/index.js
View File

@@ -36,7 +36,6 @@ module.exports = function (app) {
app.use('/dist', express.static('dist'))
app.use('/events', require('./events'))
app.use(require('./categories-for-support-team'))
app.use(require('./enterprise-data-endpoint'))
app.use(require('./detect-language'))
app.use(asyncMiddleware(require('./context')))
app.use('/csrf', require('./csrf-route'))

8
package-lock.json generated
View File

@@ -1156,9 +1156,9 @@
}
},
"@github/rest-api-operations": {
"version": "3.3.2",
"resolved": "https://registry.npmjs.org/@github/rest-api-operations/-/rest-api-operations-3.3.2.tgz",
"integrity": "sha512-0AYobx/iwl1RKrjOi/c/g+kB7u8WlgzBu9lpU1QnoXJJyi/NoBSxF4bAGJyPeG3hm+3izL3U7dpVOtq04X66rw=="
"version": "3.6.1",
"resolved": "https://registry.npmjs.org/@github/rest-api-operations/-/rest-api-operations-3.6.1.tgz",
"integrity": "sha512-tMbNFpAIxwalH46AIZGLM+6s1bP4B65lIaRZcDOrqpHbsDDRhO4fGklxqk2CfPz8goRRBETppKqOnhSmEPnADQ=="
},
"@hapi/address": {
"version": "2.1.4",
@@ -7297,7 +7297,7 @@
},
"load-json-file": {
"version": "2.0.0",
"resolved": "http://registry.npmjs.org/load-json-file/-/load-json-file-2.0.0.tgz",
"resolved": "https://registry.npmjs.org/load-json-file/-/load-json-file-2.0.0.tgz",
"integrity": "sha1-eUfkIUmvgNaWy/eXvKq8/h/inKg=",
"dev": true,
"requires": {

2
package.json
View File

@@ -16,7 +16,7 @@
"@github-docs/data-directory": "^1.2.0",
"@github-docs/frontmatter": "^1.3.1",
"@github-docs/render-content": "^5.2.0",
"@github/rest-api-operations": "^3.3.2",
"@github/rest-api-operations": "^3.6.1",
"@octokit/rest": "^16.38.1",
"@primer/css": "^15.1.0",
"@primer/octicons": "^11.0.0",

14
script/graphql/update-files.js
View File

@@ -15,6 +15,20 @@ const processUpcomingChanges = require('./utils/process-upcoming-changes')
const processSchemas = require('./utils/process-schemas')
const prerenderObjects = require('./utils/prerender-objects')
// check for required PAT
if (!process.env.GITHUB_TOKEN) {
console.error('Error! You must have a GITHUB_TOKEN set in an .env file to run this script.')
process.exit(1)
}
// check for required Ruby gems (see note below about why this is needed)
try {
execSync('gem which graphql')
} catch (err) {
console.error('\nYou need to run: bundle install')
process.exit(1)
}
// TODO this step is only required as long as we support GHE versions *OLDER THAN* 2.21
// as soon as 2.20 is deprecated on 2021-02-11, we can remove all graphql-ruby filtering
const removeHiddenMembersScript = path.join(__dirname, './utils/remove-hidden-schema-members.rb')

18
tests/rendering/server.js
View File

@@ -163,24 +163,6 @@ describe('server', () => {
})
})
test('serves publicly accessible /enterprise.json', async () => {
const res = await get('/enterprise.json')
// check for CORS header
expect(res.headers['access-control-allow-origin']).toBe('*')
const enterpriseData = JSON.parse(res.text)
expect(Object.keys(enterpriseData).length).toBe(2)
expect(enterpriseData.enterpriseDates['2.0'].releaseDate).toBe('2014-11-11')
expect(enterpriseData.enterpriseDates['2.15'].deprecationDate).toBe('2019-10-16')
expect(enterpriseData.enterpriseVersions.supported.length).toBeGreaterThan(2)
expect(enterpriseData.enterpriseVersions.deprecated.length).toBeGreaterThan(16)
expect(typeof enterpriseData.enterpriseVersions.latest).toBe('string')
expect(typeof enterpriseData.enterpriseVersions.oldestSupported).toBe('string')
expect(typeof enterpriseData.enterpriseVersions.nextDeprecationDate).toBe('string')
expect(enterpriseData.enterpriseVersions.deprecatedOnNewSite.length).toBeGreaterThan(2)
})
test('renders Markdown links that have Liquid hrefs', async () => {
// example from markdown source:
// 1. Go to {{ site.data.variables.product.product_name }}'s [Pricing]({{ site.data.variables.dotcom_billing.plans_url }}) page.