More guides
@@ -162,7 +140,7 @@ versions:
diff --git a/content/actions/learn-github-actions/finding-and-customizing-actions.md b/content/actions/learn-github-actions/finding-and-customizing-actions.md
index 4f1a287d3d01..e6fb2043fc96 100644
--- a/content/actions/learn-github-actions/finding-and-customizing-actions.md
+++ b/content/actions/learn-github-actions/finding-and-customizing-actions.md
@@ -90,7 +90,7 @@ For more information, see "[Using release management for actions](/actions/creat
### Using inputs and outputs with an action
-An action often accepts or requires inputs and generates outputs that you can use. For example, an action might require you to specify a path to a file, the name of a label, or other data it will uses as part of the action processing.
+An action often accepts or requires inputs and generates outputs that you can use. For example, an action might require you to specify a path to a file, the name of a label, or other data it will use as part of the action processing.
To see the inputs and outputs of an action, check the `action.yml` or `action.yaml` in the root directory of the repository.
diff --git a/content/actions/learn-github-actions/index.md b/content/actions/learn-github-actions/index.md
index 8bc97d038f8e..e120b015a2b3 100644
--- a/content/actions/learn-github-actions/index.md
+++ b/content/actions/learn-github-actions/index.md
@@ -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 %}
\ No newline at end of file
diff --git a/content/actions/learn-github-actions/introduction-to-github-actions.md b/content/actions/learn-github-actions/introduction-to-github-actions.md
index 7c2fa9ec700a..66434457338f 100644
--- a/content/actions/learn-github-actions/introduction-to-github-actions.md
+++ b/content/actions/learn-github-actions/introduction-to-github-actions.md
@@ -34,7 +34,7 @@ The workflow is an automated procedure that you add to your repository. Workflow
#### Events
-An event is a specific activity that triggers a workflow. For example, activity can originate from {% data variables.product.prodname_dotcom %} when someone pushes a commit to a repository or when an issue or pull request is created. You can also use the repository dispatch webhook to trigger a workflow when an external event occurs. For a complete list of events that can be used to trigger workflows, see [Events that trigger workflows](/actions/reference/events-that-trigger-workflows).
+An event is a specific activity that triggers a workflow. For example, activity can originate from {% data variables.product.prodname_dotcom %} when someone pushes a commit to a repository or when an issue or pull request is created. You can also use the [repository dispatch webhook](/rest/reference/repos#create-a-repository-dispatch-event) to trigger a workflow when an external event occurs. For a complete list of events that can be used to trigger workflows, see [Events that trigger workflows](/actions/reference/events-that-trigger-workflows).
#### Jobs
diff --git a/content/actions/learn-github-actions/managing-complex-workflows.md b/content/actions/learn-github-actions/managing-complex-workflows.md
index 38e7e68e94cd..ae35c35064e9 100644
--- a/content/actions/learn-github-actions/managing-complex-workflows.md
+++ b/content/actions/learn-github-actions/managing-complex-workflows.md
@@ -24,12 +24,13 @@ This example action demonstrates how to reference an existing secret as an envir
```yaml
jobs:
example-job:
+ runs-on: ubuntu-latest
steps:
- name: Retrieve secret
env:
super_secret: ${{ secrets.SUPERSECRET }}
run: |
- example-command "$SUPER_SECRET"
+ example-command "$super_secret"
```
{% endraw %}
@@ -49,6 +50,7 @@ jobs:
- run: ./setup_server.sh
build:
needs: setup
+ runs-on: ubuntu-latest
steps:
- run: ./build_server.sh
test:
@@ -141,7 +143,7 @@ This example shows how a workflow can use labels to specify the required runner:
```yaml
jobs:
example-job:
- runs-on: [self-hosted, linux, x64, gpu]
+ runs-on: [self-hosted, linux, x64, gpu]
```
For more information, see ["Using labels with self-hosted runners](/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners)."
diff --git a/content/actions/learn-github-actions/migrating-from-azure-pipelines-to-github-actions.md b/content/actions/learn-github-actions/migrating-from-azure-pipelines-to-github-actions.md
index c27988992679..15963c3d2ef5 100644
--- a/content/actions/learn-github-actions/migrating-from-azure-pipelines-to-github-actions.md
+++ b/content/actions/learn-github-actions/migrating-from-azure-pipelines-to-github-actions.md
@@ -41,7 +41,7 @@ Jobs and steps in Azure Pipelines are very similar to jobs and steps in {% data
### Migrating script steps
-You can run a script or a shell command as a step in a workflow. In Azure Pipelines, script steps can be specified using the `script` key, or with the `bash`, `powershell`, or `pwsh` keys. Scripts can also be specified as an input to the [Bash task](https://docs.microsoft.com/en-us/azure/devops/pipelines/tasks/utility/bash?view=azure-devops) or the [PowerShell task](https://docs.microsoft.com/en-us/azure/devops/pipelines/tasks/utility/powershell?view=azure-devops).
+You can run a script or a shell command as a step in a workflow. In Azure Pipelines, script steps can be specified using the `script` key, or with the `bash`, `powershell`, or `pwsh` keys. Scripts can also be specified as an input to the [Bash task](https://docs.microsoft.com/azure/devops/pipelines/tasks/utility/bash?view=azure-devops) or the [PowerShell task](https://docs.microsoft.com/azure/devops/pipelines/tasks/utility/powershell?view=azure-devops).
In {% data variables.product.prodname_actions %}, all scripts are specified using the `run` key. To select a particular shell, you can specify the `shell` key when providing the script. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsrun)."
diff --git a/content/actions/learn-github-actions/migrating-from-gitlab-cicd-to-github-actions.md b/content/actions/learn-github-actions/migrating-from-gitlab-cicd-to-github-actions.md
index 873144e8fe04..618503642e5d 100644
--- a/content/actions/learn-github-actions/migrating-from-gitlab-cicd-to-github-actions.md
+++ b/content/actions/learn-github-actions/migrating-from-gitlab-cicd-to-github-actions.md
@@ -180,7 +180,7 @@ GitLab CI/CD
deploy_prod:
stage: deploy
script:
- - echo "Deply to production server"
+ - echo "Deploy to production server"
rules:
- if: '$CI_COMMIT_BRANCH == "master"'
```
@@ -194,7 +194,7 @@ jobs:
if: contains( github.ref, 'master')
runs-on: ubuntu-latest
steps:
- - run: echo "Deply to production server"
+ - run: echo "Deploy to production server"
```
{% endraw %}
diff --git a/content/actions/learn-github-actions/migrating-from-jenkins-to-github-actions.md b/content/actions/learn-github-actions/migrating-from-jenkins-to-github-actions.md
index d7c662b90dba..28a1e556e0f0 100644
--- a/content/actions/learn-github-actions/migrating-from-jenkins-to-github-actions.md
+++ b/content/actions/learn-github-actions/migrating-from-jenkins-to-github-actions.md
@@ -232,25 +232,22 @@ Jenkins Pipeline
```yaml
pipeline {
- agent none
- stages {
- stage('Run Tests') {
- parallel {
- stage('Test On MacOS') {
- agent { label "macos" }
- tools { nodejs "node-12" }
- steps {
- dir("scripts/myapp") {
- sh(script: "npm install -g bats")
- sh(script: "bats tests")
- }
- }
+agent none
+stages {
+ stage('Run Tests') {
+ matrix {
+ axes {
+ axis {
+ name: 'PLATFORM'
+ values: 'macos', 'linux'
}
- stage('Test On Linux') {
- agent { label "linux" }
+ }
+ agent { label "${PLATFORM}" }
+ stages {
+ stage('test') {
tools { nodejs "node-12" }
steps {
- dir("script/myapp") {
+ dir("scripts/myapp") {
sh(script: "npm install -g bats")
sh(script: "bats tests")
}
@@ -259,6 +256,7 @@ pipeline {
}
}
}
+}
}
```
diff --git a/content/actions/learn-github-actions/migrating-from-travis-ci-to-github-actions.md b/content/actions/learn-github-actions/migrating-from-travis-ci-to-github-actions.md
new file mode 100644
index 000000000000..2d95d8d0f73b
--- /dev/null
+++ b/content/actions/learn-github-actions/migrating-from-travis-ci-to-github-actions.md
@@ -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:
+
+Publishing Node.js packages
Use GitHub Actions to push your Node.js package to GitHub Packages or npm.
- Java
+ JavaScript/TypeScript
CI
| +Travis CI + | ++{% data variables.product.prodname_actions %} + | +
|---|---|
| +{% raw %} +```yaml +matrix: + include: + - rvm: 2.5 + - rvm: 2.6.3 +``` +{% endraw %} + | ++{% raw %} +```yaml +jobs: + build: + strategy: + matrix: + ruby: [2.5, 2.6.3] +``` +{% endraw %} + | +
| +Travis CI + | ++{% data variables.product.prodname_actions %} + | +
|---|---|
| +{% raw %} +```yaml +branches: + only: + - main + - 'mona/octocat' +``` +{% endraw %} + | ++{% raw %} +```yaml +on: + push: + branches: + - main + - 'mona/octocat' +``` +{% endraw %} + | +
| +Travis CI + | ++{% data variables.product.prodname_actions %} + | +
|---|---|
| +{% raw %} +```yaml +git: + submodules: false +``` +{% endraw %} + | ++{% raw %} +```yaml + - uses: actions/checkout@v2 + with: + submodules: false +``` +{% endraw %} + | +
| +Travis CI + | ++{% data variables.product.prodname_actions %} + | +
|---|---|
| +{% raw %} +```yaml +language: python +python: + - "3.7" + +script: + - python script.py +``` +{% endraw %} + | ++{% 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 %} + | +
| +Travis CI + | ++GitHub Actions + | +
|---|---|
| +{% raw %} +```yaml +language: node_js +cache: npm +``` +{% endraw %} + | ++{% 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 %} + | +
| +Travis CI + | ++{% data variables.product.prodname_actions %} Workflow + | +
|---|---|
| + + ```yaml +env: + - MAVEN_PATH="/usr/local/maven" + ``` + + | ++ + ```yaml + jobs: + maven-build: + env: + MAVEN_PATH: '/usr/local/maven' + ``` + + | +
| +Travis CI + | ++{% data variables.product.prodname_actions %} Workflow + | +
|---|---|
| +{% raw %} + ```yaml +install: + - npm install +script: + - npm run build + - npm test + ``` +{% endraw %} + | ++{% 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 %} + | +
https://YOUR-GITHUB-AE-HOSTNAME |
+ | Reply URL | https://YOUR-GITHUB-AE-HOSTNAME/saml/consume |
+ | Sign on URL | https://YOUR-GITHUB-AE-HOSTNAME/sso |
+
+1. In {% data variables.product.prodname_ghe_managed %}, enter the details for your Azure AD tenant.
+
+ - {% data reusables.saml.ae-enable-saml-sso-during-bootstrapping %}
+
+ - If you've already configured SAML SSO for {% data variables.product.product_location %} using another IdP and you want to use Azure AD instead, you can edit your configuration. For more information, see "[Configuring SAML single sign-on for your enterprise](/admin/authentication/configuring-saml-single-sign-on-for-your-enterprise#editing-the-saml-sso-configuration)."
+
+1. Enable user provisioning in {% data variables.product.product_name %} and configure user provisioning in Azure AD. For more information, see "[Configuring user provisioning for your enterprise](/admin/authentication/configuring-user-provisioning-for-your-enterprise#enabling-user-provisioning-for-your-enterprise)."
+
+{% endif %}
diff --git a/content/admin/authentication/configuring-authentication-and-provisioning-with-your-identity-provider.md b/content/admin/authentication/configuring-authentication-and-provisioning-with-your-identity-provider.md
new file mode 100644
index 000000000000..ef320ac2ce7e
--- /dev/null
+++ b/content/admin/authentication/configuring-authentication-and-provisioning-with-your-identity-provider.md
@@ -0,0 +1,8 @@
+---
+title: Configuring authentication and provisioning with your identity provider
+intro: You can use an identity provider (IdP) that supports both SAML single sign-on (SSO) and System for Cross-domain Identity Management (SCIM) to configure authentication and user provisioning for {% data variables.product.product_location %}.
+mapTopic: true
+versions:
+ github-ae: '*'
+---
+
diff --git a/content/admin/authentication/configuring-saml-single-sign-on-for-your-enterprise.md b/content/admin/authentication/configuring-saml-single-sign-on-for-your-enterprise.md
new file mode 100644
index 000000000000..51b0cf031db1
--- /dev/null
+++ b/content/admin/authentication/configuring-saml-single-sign-on-for-your-enterprise.md
@@ -0,0 +1,105 @@
+---
+title: Configuring SAML single sign-on for your enterprise
+shortTitle: Configuring SAML SSO
+intro: You can configure SAML single sign-on (SSO) for your enterprise, which allows you to centrally control authentication for {% data variables.product.product_location %} using your identity provider (IdP).
+product: '{% data reusables.gated-features.saml-sso %}'
+permissions: Enterprise owners can configure SAML SSO for an enterprise on {% data variables.product.product_name %}.
+versions:
+ github-ae: '*'
+---
+
+### About SAML SSO
+
+{% if currentVersion == "github-ae@latest" %}
+
+SAML SSO allows you to centrally control and secure access to {% data variables.product.product_location %} from your SAML IdP. When an unauthenticated user visits {% data variables.product.product_location %} in a browser, {% data variables.product.product_name %} will redirect the user to your SAML IdP to authenticate. After the user successfully authenticates with an account on the IdP, the IdP redirects the user back to {% data variables.product.product_location %}. {% data variables.product.product_name %} validates the response from your IdP, then grants access to the user.
+
+After a user successfully authenticates on your IdP, the user's SAML session for {% data variables.product.product_location %} is active in the browser for 24 hours. After 24 hours, the user must authenticate again with your IdP.
+
+{% data reusables.saml.assert-the-administrator-attribute %}
+
+{% data reusables.scim.after-you-configure-saml %} For more information, see "[Configuring user provisioning for your enterprise](/admin/authentication/configuring-user-provisioning-for-your-enterprise)."
+
+{% endif %}
+
+### Supported identity providers
+
+{% data variables.product.product_name %} supports SAML SSO with IdPs that implement the SAML 2.0 standard. For more information, see the [SAML Wiki](https://wiki.oasis-open.org/security) on the OASIS website.
+
+{% data variables.product.company_short %} has tested SAML SSO for {% data variables.product.product_name %} with the following IdPs.
+
+{% if currentVersion == "github-ae@latest" %}
+- Azure AD
+{% endif %}
+
+### Enabling SAML SSO
+
+{% if currentVersion == "github-ae@latest" %}
+
+{% data reusables.saml.ae-enable-saml-sso-during-bootstrapping %}
+
+During initialization for {% data variables.product.product_name %}, you must configure {% data variables.product.product_name %} as a SAML Service Provider (SP) on your IdP. You must enter several unique values on your IdP to configure {% data variables.product.product_name %} as a valid SP.
+
+| Value | Other names | Description | Example |
+| :- | :- | :- | :- |
+| SP Entity ID | SP URL | Your top-level URL for {% data variables.product.prodname_ghe_managed %} | https://YOUR-GITHUB-AE-HOSTNAME
+| SP Assertion Consumer Service (ACS) URL | Reply URL | URL where IdP sends SAML responses | https://YOUR-GITHUB-AE-HOSTNAME/saml/consume |
+| SP Single Sign-On (SSO) URL | | URL where IdP begins SSO | https://YOUR-GITHUB-AE-HOSTNAME/sso |
+
+{% endif %}
+
+### Editing the SAML SSO configuration
+
+If the details for your IdP change, you'll need to edit the SAML SSO configuration for {% data variables.product.product_location %}. For example, if the certificate for your IdP expires, you can edit the value for the public certificate.
+
+{% if currentVersion == "github-ae@latest" %}
+
+{% note %}
+
+**Note**: {% data reusables.saml.contact-support-if-your-idp-is-unavailable %}
+
+{% endnote %}
+
+{% data reusables.enterprise-accounts.access-enterprise %}
+{% data reusables.enterprise-accounts.settings-tab %}
+{% data reusables.enterprise-accounts.security-tab %}
+1. Under "SAML single sign-on", type the new details for your IdP.
+ 
+1. Optionally, click {% octicon "pencil" aria-label="The edit icon" %} to configure a new signature or digest method.
+ 
+
+ - Use the drop-down menus and choose the new signature or digest method.
+ 
+1. To ensure that the information you've entered is correct, click **Test SAML configuration**.
+ 
+1. Click **Save**.
+ 
+1. Optionally, to automatically provision and deprovision user accounts for {% data variables.product.product_location %}, reconfigure user provisioning with SCIM. For more information, see "[Configuring user provisioning for your enterprise](/admin/authentication/configuring-user-provisioning-for-your-enterprise)."
+
+{% endif %}
+
+### Disabling SAML SSO
+
+{% if currentVersion == "github-ae@latest" %}
+
+{% warning %}
+
+**Warning**: If you disable SAML SSO for {% data variables.product.product_location %}, users without existing SAML SSO sessions cannot sign into {% data variables.product.product_location %}. SAML SSO sessions on {% data variables.product.product_location %} end after 24 hours.
+
+{% endwarning %}
+
+{% note %}
+
+**Note**: {% data reusables.saml.contact-support-if-your-idp-is-unavailable %}
+
+{% endnote %}
+
+{% data reusables.enterprise-accounts.access-enterprise %}
+{% data reusables.enterprise-accounts.settings-tab %}
+{% data reusables.enterprise-accounts.security-tab %}
+1. Under "SAML single sign-on", unselect **Enable SAML authentication**.
+ 
+1. To disable SAML SSO and require signing in with the built-in user account you created during initialization, click **Save**.
+ 
+
+{% endif %}
diff --git a/content/admin/authentication/configuring-user-provisioning-for-your-enterprise.md b/content/admin/authentication/configuring-user-provisioning-for-your-enterprise.md
new file mode 100644
index 000000000000..00e17a70ca5f
--- /dev/null
+++ b/content/admin/authentication/configuring-user-provisioning-for-your-enterprise.md
@@ -0,0 +1,72 @@
+---
+title: Configuring user provisioning for your enterprise
+shortTitle: Configuring user provisioning
+intro: You can configure System for Cross-domain Identity Management (SCIM) for your enterprise, which automatically provisions user accounts on {% data variables.product.product_location %} when you assign the application for {% data variables.product.product_location %} to a user on your identity provider (IdP).
+permissions: Enterprise owners can configure user provisioning for an enterprise on {% data variables.product.product_name %}.
+product: '{% data reusables.gated-features.saml-sso %}'
+versions:
+ github-ae: '*'
+---
+
+### About user provisioning for your enterprise
+
+{% data reusables.saml.ae-uses-saml-sso %} For more information, see "[Configuring SAML single sign-on for your enterprise](/admin/authentication/configuring-saml-single-sign-on-for-your-enterprise)."
+
+{% data reusables.scim.after-you-configure-saml %} For more information about SCIM, see [System for Cross-domain Identity Management: Protocol (RFC 7644)](https://tools.ietf.org/html/rfc7644) on the IETF website.
+
+{% if currentVersion == "github-ae@latest" %}
+
+Configuring provisioning allows your IdP to communicate with {% data variables.product.product_location %} when you assign or unassign the application for {% data variables.product.product_name %} to a user on your IdP. When you assign the application, your IdP will prompt {% data variables.product.product_location %} to create an account and send an onboarding email to the user. When you unassign the application, your IdP will communicate with {% data variables.product.product_name %} to invalidate any SAML sessions and disable the member's account.
+
+To configure provisioning for your enterprise, you must enable provisioning on {% data variables.product.product_name %}, then install and configure a provisioning application on your IdP.
+
+The provisioning application on your IdP communicates with {% data variables.product.product_name %} via our SCIM API for enterprises. For more information, see "[GitHub Enterprise administration](/rest/reference/enterprise-admin#scim)" in the {% data variables.product.prodname_dotcom %} REST API documentation.
+
+{% endif %}
+
+### Supported identity providers
+
+{% data reusables.scim.supported-idps %}
+
+### Prerequisites
+
+{% if currentVersion == "github-ae@latest" %}
+
+To automatically provision and deprovision access to {% data variables.product.product_location %} from your IdP, you must first configure SAML SSO when you initialize {% data variables.product.product_name %}. For more information, see "[Initializing {% data variables.product.prodname_ghe_managed %}](/admin/configuration/initializing-github-ae)."
+
+You must have administrative access on your IdP to configure the application for user provisioning for {% data variables.product.product_name %}.
+
+{% endif %}
+
+### Enabling user provisioning for your enterprise
+
+{% if currentVersion == "github-ae@latest" %}
+
+1. While signed into {% data variables.product.product_location %} as an enterprise owner, create a personal access token with **admin:enterprise** scope. For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)."
+ {% note %}
+
+ **Notes**:
+ - To create the personal access token, we recommend using the account for the first enterprise owner that you created during initialization. For more information, see "[Initializing {% data variables.product.prodname_ghe_managed %}](/admin/configuration/initializing-github-ae)."
+ - You'll need this personal access token to configure the application for SCIM on your IdP. Store the token securely in a password manager until you need the token again later in these instructions.
+
+ {% endnote %}
+ {% warning %}
+
+ **Warning**: If the user account for the enterprise owner who creates the personal access token is deactivated or deprovisioned, your IdP will no longer provision and deprovision user accounts for your enterprise automatically. Another enterprise owner must create a new personal access token and reconfigure provisioning on the IdP.
+
+ {% endwarning %}
+{% data reusables.enterprise-accounts.access-enterprise %}
+{% data reusables.enterprise-accounts.settings-tab %}
+{% data reusables.enterprise-accounts.security-tab %}
+1. Under "SCIM User Provisioning", select **Require SCIM user provisioning**.
+ 
+1. Click **Save**.
+ 
+1. Configure user provisioning in the application for {% data variables.product.product_name %} on your IdP. The application on your IdP requires two values to provision or deprovision user accounts on {% data variables.product.product_location %}.
+
+ | Value | Other names | Description | Example |
+ | :- | :- | :- | :- |
+ | URL | Tenant URL | URL to the SCIM provisioning API for your enterprise on {% data variables.product.prodname_ghe_managed %} | https://YOUR-GITHUB-AE-HOSTNAME/scim/v2 |
+ | Shared secret | Personal access token, secret token | Token for application on your IdP to perform provisioning tasks on behalf of an enterprise owner | Personal access token you created in step 1 |
+
+{% endif %}
diff --git a/content/admin/authentication/index.md b/content/admin/authentication/index.md
index fa91d86c3535..deacdaf76f0d 100644
--- a/content/admin/authentication/index.md
+++ b/content/admin/authentication/index.md
@@ -1,10 +1,11 @@
---
title: Authentication
-intro: 'You can use {% data variables.product.prodname_ghe_server %}''s built-in authentication, or choose between CAS, LDAP, or SAML to integrate your existing accounts and centrally manage user access to {% data variables.product.product_location_enterprise %}.'
+intro: You can configure how users sign into {% data variables.product.product_name %}.
redirect_from:
- /enterprise/admin/authentication
versions:
enterprise-server: '*'
+ github-ae: '*'
---
@@ -18,5 +19,9 @@ versions:
{% link_in_list /using-ldap %}
{% link_in_list /allowing-built-in-authentication-for-users-outside-your-identity-provider %}
{% link_in_list /changing-authentication-methods %}
-
-
+{% topic_link_in_list /managing-identity-and-access-for-your-enterprise %}
+ {% link_in_list /about-identity-and-access-management-for-your-enterprise %}
+ {% link_in_list /configuring-saml-single-sign-on-for-your-enterprise %}
+ {% link_in_list /configuring-user-provisioning-for-your-enterprise %}
+{% topic_link_in_list /configuring-authentication-and-provisioning-with-your-identity-provider %}
+ {% link_in_list /configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad %}
diff --git a/content/admin/authentication/managing-identity-and-access-for-your-enterprise.md b/content/admin/authentication/managing-identity-and-access-for-your-enterprise.md
new file mode 100644
index 000000000000..9b4b3f0a0aae
--- /dev/null
+++ b/content/admin/authentication/managing-identity-and-access-for-your-enterprise.md
@@ -0,0 +1,9 @@
+---
+title: Managing identity and access for your enterprise
+shortTitle: Managing identity and access
+intro: You can centrally manage accounts and access to {% data variables.product.product_location %}.
+mapTopic: true
+versions:
+ github-ae: '*'
+---
+
diff --git a/content/admin/authentication/using-built-in-authentication.md b/content/admin/authentication/using-built-in-authentication.md
index 8ea4483fac0f..4df510e488bc 100644
--- a/content/admin/authentication/using-built-in-authentication.md
+++ b/content/admin/authentication/using-built-in-authentication.md
@@ -1,6 +1,6 @@
---
title: Using built-in authentication
-intro: 'When you use the default authentication method, all authentication details are stored within {% data variables.product.product_location_enterprise %}. Built-in authentication is the default method if you don’t already have an established authentication provider, such as LDAP, SAML, or CAS.'
+intro: 'When you use the default authentication method, all authentication details are stored within {% data variables.product.product_location %}. Built-in authentication is the default method if you don’t already have an established authentication provider, such as LDAP, SAML, or CAS.'
redirect_from:
- /enterprise/admin/user-management/using-built-in-authentication
- /enterprise/admin/authentication/using-built-in-authentication
diff --git a/content/admin/authentication/using-cas.md b/content/admin/authentication/using-cas.md
index a6326ea9f3b4..fa765d66b83b 100644
--- a/content/admin/authentication/using-cas.md
+++ b/content/admin/authentication/using-cas.md
@@ -32,7 +32,7 @@ The following attributes are available.
### Configuring CAS
{% warning %}
-**Warning:** Before configuring CAS on {% data variables.product.product_location_enterprise %}, note that users will not be able to use their CAS usernames and passwords to authenticate API requests or Git operations over HTTP/HTTPS. Instead, they will need to [create an access token](/enterprise/{{ currentVersion }}/user/articles/creating-an-access-token-for-command-line-use).
+**Warning:** Before configuring CAS on {% data variables.product.product_location %}, note that users will not be able to use their CAS usernames and passwords to authenticate API requests or Git operations over HTTP/HTTPS. Instead, they will need to [create an access token](/enterprise/{{ currentVersion }}/user/articles/creating-an-access-token-for-command-line-use).
{% endwarning %}
diff --git a/content/admin/authentication/using-ldap.md b/content/admin/authentication/using-ldap.md
index 795cf526d2aa..c0c06c8abdec 100644
--- a/content/admin/authentication/using-ldap.md
+++ b/content/admin/authentication/using-ldap.md
@@ -35,7 +35,7 @@ versions:
{% data reusables.enterprise_user_management.two_factor_auth_header %}
{% data reusables.enterprise_user_management.2fa_is_available %}
-### Configuring LDAP with {% data variables.product.product_location_enterprise %}
+### Configuring LDAP with {% data variables.product.product_location %}
After you configure LDAP, users will be able to sign into your instance with their LDAP credentials. When users sign in for the first time, their profile names, email addresses, and SSH keys will be set with the LDAP attributes from your directory.
@@ -43,7 +43,7 @@ When you configure LDAP access for users via the {% data variables.enterprise.ma
{% warning %}
-**Warning:** Before configuring LDAP on {% data variables.product.product_location_enterprise %}, make sure that your LDAP service supports paged results.
+**Warning:** Before configuring LDAP on {% data variables.product.product_location %}, make sure that your LDAP service supports paged results.
{% endwarning %}
@@ -56,11 +56,11 @@ When you configure LDAP access for users via the {% data variables.enterprise.ma
5. Add your configuration settings.
### LDAP attributes
-Use these attributes to finish configuring LDAP for {% data variables.product.product_location_enterprise %}.
+Use these attributes to finish configuring LDAP for {% data variables.product.product_location %}.
| Attribute name | Type | Description |
|--------------------------|----------|-------------|
-| `Host` | Required | The LDAP host, e.g. `ldap.example.com` or `10.0.0.30`. If the hostname is only available from your internal network, you may need to configure {% data variables.product.product_location_enterprise %}'s DNS first so it can resolve the hostname using your internal nameservers. |
+| `Host` | Required | The LDAP host, e.g. `ldap.example.com` or `10.0.0.30`. If the hostname is only available from your internal network, you may need to configure {% data variables.product.product_location %}'s DNS first so it can resolve the hostname using your internal nameservers. |
| `Port` | Required | The port the host's LDAP services are listening on. Examples include: 389 and 636 (for LDAPS). |
| `Encryption` | Required | The encryption method used to secure communications to the LDAP server. Examples include plain (no encryption), SSL/LDAPS (encrypted from the start), and StartTLS (upgrade to encrypted communication once connected). |
| `Domain search user` | Optional | The LDAP user that performs user lookups to authenticate other users when they sign in. This is typically a service account created specifically for third-party integrations. Use a fully qualified name, such as `cn=Administrator,cn=Users,dc=Example,dc=com`. With Active Directory, you can also use the `[DOMAIN]\[USERNAME]` syntax (e.g. `WINDOWS\Administrator`) for the domain search user with Active Directory. |
@@ -194,7 +194,7 @@ Unless [LDAP Sync is enabled](#enabling-ldap-sync), changes to LDAP accounts are
You can also [use the API to trigger a manual sync](/enterprise/{{ currentVersion }}/user/rest/reference/enterprise-admin#ldap).
-### Revoking access to {% data variables.product.product_location_enterprise %}
+### Revoking access to {% data variables.product.product_location %}
If [LDAP Sync is enabled](#enabling-ldap-sync), removing a user's LDAP credentials will suspend their account after the next synchronization run.
diff --git a/content/admin/authentication/using-saml.md b/content/admin/authentication/using-saml.md
index 7e3fac25d2ee..f6fe021b1bf8 100644
--- a/content/admin/authentication/using-saml.md
+++ b/content/admin/authentication/using-saml.md
@@ -29,7 +29,7 @@ Each {% data variables.product.prodname_ghe_server %} username is determined by
The `NameID` element is required even if other attributes are present.
-A mapping is created between the `NameID` and the {% data variables.product.prodname_ghe_server %} username, so the `NameID` should be persistent, unique, and not subject to change for the lifecyle of the user.
+A mapping is created between the `NameID` and the {% data variables.product.prodname_ghe_server %} username, so the `NameID` should be persistent, unique, and not subject to change for the lifecycle of the user.
{% note %}
@@ -81,13 +81,13 @@ These attributes are available. You can change the attribute names in the [manag
{% endtip %}
-5. Select **Disable administrator demotion/promotion** if you **do not** want your SAML provider to determine administrator rights for users on {% data variables.product.product_location_enterprise %}.
+5. Select **Disable administrator demotion/promotion** if you **do not** want your SAML provider to determine administrator rights for users on {% data variables.product.product_location %}.
-6. In the **Single sign-on URL** field, type the HTTP or HTTPS endpoint on your IdP for single sign-on requests. This value is provided by your IdP configuration. If the host is only available from your internal network, you may need to [configure {% data variables.product.product_location_enterprise %} to use internal nameservers](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-dns-nameservers/).
+6. In the **Single sign-on URL** field, type the HTTP or HTTPS endpoint on your IdP for single sign-on requests. This value is provided by your IdP configuration. If the host is only available from your internal network, you may need to [configure {% data variables.product.product_location %} to use internal nameservers](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-dns-nameservers/).
-7. Optionally, in the **Issuer** field, type your SAML issuer's name. This verifies the authenticity of messages sent to {% data variables.product.product_location_enterprise %}.
+7. Optionally, in the **Issuer** field, type your SAML issuer's name. This verifies the authenticity of messages sent to {% data variables.product.product_location %}.
-8. In the **Signature Method** and **Digest Method** drop-down menus, choose the hashing algorithm used by your SAML issuer to verify the integrity of the requests from {% data variables.product.product_location_enterprise %}. Specify the format with the **Name Identifier Format** drop-down menu.
+8. In the **Signature Method** and **Digest Method** drop-down menus, choose the hashing algorithm used by your SAML issuer to verify the integrity of the requests from {% data variables.product.product_location %}. Specify the format with the **Name Identifier Format** drop-down menu.
9. Under **Verification certificate**, click **Choose File** and choose a certificate to validate SAML responses from the IdP.
@@ -113,7 +113,7 @@ These attributes are available. You can change the attribute names in the [manag
{% endif %}
-### Revoking access to {% data variables.product.product_location_enterprise %}
+### Revoking access to {% data variables.product.product_location %}
If you remove a user from your identity provider, you must also manually suspend them. Otherwise, they'll continue to be able to authenticate using access tokens or SSH keys. For more information, see "[Suspending and unsuspending users](/enterprise/admin/guides/user-management/suspending-and-unsuspending-users)".
diff --git a/content/admin/configuration/about-enterprise-configuration.md b/content/admin/configuration/about-enterprise-configuration.md
new file mode 100644
index 000000000000..8f90db06228d
--- /dev/null
+++ b/content/admin/configuration/about-enterprise-configuration.md
@@ -0,0 +1,30 @@
+---
+title: About enterprise configuration
+intro: 'You can use the site admin dashboard{% if enterpriseServerVersions contains currentVersion %}, {% data variables.enterprise.management_console %}, and administrative shell (SSH) {% elsif currentVersion == "github-ae@latest" %} and enterprise settings or contact support{% endif %} to manage your enterprise.'
+versions:
+ enterprise-server: '*'
+ github-ae: '*'
+---
+
+{% if enterpriseServerVersions contains currentVersion %}
+{% data reusables.enterprise_site_admin_settings.about-the-site-admin-dashboard %} For more information, see "[Site admin dashboard](/admin/configuration/site-admin-dashboard)."
+
+{% data reusables.enterprise_site_admin_settings.about-the-management-console %} For more information, see "[Accessing the management console](/admin/configuration/accessing-the-management-console)."
+
+{% data reusables.enterprise_site_admin_settings.about-ssh-access %} For more information, see "[Accessing the administrative shell (SSH)](/admin/configuration/accessing-the-administrative-shell-ssh)."
+{% endif %}
+
+{% if currentVersion == "github-ae@latest" %}
+The first time you access your enterprise, you will complete an initial configuration to get {% data variables.product.product_name %} ready to use. The initial configuration includes connecting your enterprise with an idP, authenticating with SAML SSO, and configuring policies for repositories and organizations in your enterprise. For more information, see "[Initializing {% data variables.product.prodname_ghe_managed %}](/admin/configuration/initializing-github-ae)."
+
+For users to receive any emails from {% data variables.product.product_name %} after the initial configuration, you must ask {% data variables.contact.github_support %} to configure outbound email support with your SMTP server. For more information, see "[Configuring email for notifications](/admin/configuration/configuring-email-for-notifications)."
+
+Later, you can use the site admin dashboard and enterprise settings to further configure your enterprise, manage users, organizations and repositories, and set policies that reduce risk and increase quality.
+
+All enterprises are configured with subdomain isolation and support for TLS 1.2 and higher for encrypted traffic only.
+{% endif %}
+
+### Further reading
+
+- "[Managing users, organizations, and repositories](/admin/user-management)"
+- "[Setting policies for your enterprise](/admin/policies)"
diff --git a/content/admin/configuration/accessing-the-administrative-shell-ssh.md b/content/admin/configuration/accessing-the-administrative-shell-ssh.md
index fdf3010df9b2..a56c2aaf359a 100644
--- a/content/admin/configuration/accessing-the-administrative-shell-ssh.md
+++ b/content/admin/configuration/accessing-the-administrative-shell-ssh.md
@@ -10,7 +10,7 @@ redirect_from:
- /enterprise/admin/2.15/articles/troubleshooting-ssh-permission-denied-publickey/
- /enterprise/admin/installation/accessing-the-administrative-shell-ssh
- /enterprise/admin/configuration/accessing-the-administrative-shell-ssh
-intro: 'SSH access allows you to run the {% data variables.product.prodname_ghe_server %} command line utilities and is useful for troubleshooting, running backups, and configuring replication.'
+intro: '{% data reusables.enterprise_site_admin_settings.about-ssh-access %}'
versions:
enterprise-server: '*'
---
@@ -47,7 +47,7 @@ admin@github-example-com:~$ █
#### Troubleshooting SSH connection problems
-If you encounter the `Permission denied (publickey)` error when you try to connect to {% data variables.product.product_location_enterprise %} via SSH, confirm that you are connecting over port 122. You may need to explicitly specify which private SSH key to use.
+If you encounter the `Permission denied (publickey)` error when you try to connect to {% data variables.product.product_location %} via SSH, confirm that you are connecting over port 122. You may need to explicitly specify which private SSH key to use.
To specify a private SSH key using the command line, run `ssh` with the `-i` argument.
diff --git a/content/admin/configuration/accessing-the-management-console.md b/content/admin/configuration/accessing-the-management-console.md
index d37b78b44a65..b107ad6dbc87 100644
--- a/content/admin/configuration/accessing-the-management-console.md
+++ b/content/admin/configuration/accessing-the-management-console.md
@@ -1,6 +1,6 @@
---
title: Accessing the management console
-intro: 'Use the {% data variables.enterprise.management_console %} to set up and configure {% data variables.product.product_location %}, schedule maintenance windows, troubleshoot issues, and manage your license.'
+intro: '{% data reusables.enterprise_site_admin_settings.about-the-management-console %}'
redirect_from:
- /enterprise/admin/articles/about-the-management-console/
- /enterprise/admin/articles/management-console-for-emergency-recovery/
@@ -17,15 +17,15 @@ versions:
### About the {% data variables.enterprise.management_console %}
Use the {% data variables.enterprise.management_console %} for basic administrative activities:
-- **Initial setup**: Walk through the initial setup process when first launching {% data variables.product.product_location_enterprise %} by visiting {% data variables.product.product_location_enterprise %}'s IP address in your browser.
+- **Initial setup**: Walk through the initial setup process when first launching {% data variables.product.product_location %} by visiting {% data variables.product.product_location %}'s IP address in your browser.
- **Configuring basic settings for your instance**: Configure DNS, hostname, SSL, user authentication, email, monitoring services, and log forwarding on the Settings page.
-- **Scheduling maintenance windows**: Take your {% data variables.product.product_location_enterprise %} offline while performing maintenance using the {% data variables.enterprise.management_console %} or administrative shell.
+- **Scheduling maintenance windows**: Take your {% data variables.product.product_location %} offline while performing maintenance using the {% data variables.enterprise.management_console %} or administrative shell.
- **Troubleshooting**: Generate a support bundle or view high level diagnostic information.
- **License management**: View or update your {% data variables.product.prodname_enterprise %} license.
-You can always reach the {% data variables.enterprise.management_console %} using {% data variables.product.product_location_enterprise %}'s IP address, even when the instance is in maintenance mode, or there is a critical application failure or hostname or SSL misconfiguration.
+You can always reach the {% data variables.enterprise.management_console %} using {% data variables.product.product_location %}'s IP address, even when the instance is in maintenance mode, or there is a critical application failure or hostname or SSL misconfiguration.
-To access the {% data variables.enterprise.management_console %}, you must use the administrator password established during initial setup of {% data variables.product.product_location_enterprise %}. You must also be able to connect to the virtual machine host on port 8443. If you're having trouble reaching the {% data variables.enterprise.management_console %}, please check intermediate firewall and security group configurations.
+To access the {% data variables.enterprise.management_console %}, you must use the administrator password established during initial setup of {% data variables.product.product_location %}. You must also be able to connect to the virtual machine host on port 8443. If you're having trouble reaching the {% data variables.enterprise.management_console %}, please check intermediate firewall and security group configurations.
### Accessing the {% data variables.enterprise.management_console %} as a site administrator
diff --git a/content/admin/configuration/command-line-utilities.md b/content/admin/configuration/command-line-utilities.md
index 5223ec18390f..204fc49dfe00 100644
--- a/content/admin/configuration/command-line-utilities.md
+++ b/content/admin/configuration/command-line-utilities.md
@@ -62,7 +62,7 @@ ghe-cleanup-settings
#### ghe-config
-With this utility, you can both retrieve and modify the configuration settings of {% data variables.product.product_location_enterprise %}.
+With this utility, you can both retrieve and modify the configuration settings of {% data variables.product.product_location %}.
```shell
$ ghe-config core.github-hostname
@@ -393,7 +393,7 @@ This utility allows you to install a custom root CA certificate on your {% data
Run this utility to add a certificate chain for S/MIME commit signature verification. For more information, see "[About commit signature verification](/enterprise/{{ currentVersion }}/user/articles/about-commit-signature-verification/)."
-Run this utility when {% data variables.product.product_location_enterprise %} is unable to connect to another server because the latter is using a self-signed SSL certificate or an SSL certificate for which it doesn't provide the necessary CA bundle. One way to confirm this is to run `openssl s_client -connect host:port -verify 0 -CApath /etc/ssl/certs` from {% data variables.product.product_location_enterprise %}. If the remote server's SSL certificate can be verified, your `SSL-Session` should have a return code of 0, as shown below.
+Run this utility when {% data variables.product.product_location %} is unable to connect to another server because the latter is using a self-signed SSL certificate or an SSL certificate for which it doesn't provide the necessary CA bundle. One way to confirm this is to run `openssl s_client -connect host:port -verify 0 -CApath /etc/ssl/certs` from {% data variables.product.product_location %}. If the remote server's SSL certificate can be verified, your `SSL-Session` should have a return code of 0, as shown below.
```
SSL-Session:
@@ -451,7 +451,7 @@ $ ghe-storage-extend
#### ghe-version
-This utility prints the version, platform, and build of {% data variables.product.product_location_enterprise %}.
+This utility prints the version, platform, and build of {% data variables.product.product_location %}.
```shell
$ ghe-version
diff --git a/content/admin/configuration/configuring-a-hostname.md b/content/admin/configuration/configuring-a-hostname.md
index f6166a567c33..3e7bd4b662ab 100644
--- a/content/admin/configuration/configuring-a-hostname.md
+++ b/content/admin/configuration/configuring-a-hostname.md
@@ -9,7 +9,7 @@ versions:
enterprise-server: '*'
---
-If you configure a hostname instead of a hard-coded IP address, you will be able to change the physical hardware that {% data variables.product.product_location_enterprise %} runs on without affecting users or client software.
+If you configure a hostname instead of a hard-coded IP address, you will be able to change the physical hardware that {% data variables.product.product_location %} runs on without affecting users or client software.
The hostname setting in the {% data variables.enterprise.management_console %} should be set to an appropriate fully qualified domain name (FQDN) which is resolvable on the internet or within your internal network. For example, your hostname setting could be `github.companyname.com.` We also recommend enabling subdomain isolation for the chosen hostname to mitigate several cross-site scripting style vulnerabilities. For more information on hostname settings, see [Section 2.1 of the HTTP RFC](https://tools.ietf.org/html/rfc1123#section-2).
@@ -18,11 +18,11 @@ The hostname setting in the {% data variables.enterprise.management_console %} s
{% data reusables.enterprise_site_admin_settings.access-settings %}
{% data reusables.enterprise_site_admin_settings.management-console %}
{% data reusables.enterprise_management_console.hostname-menu-item %}
-4. Type the hostname you'd like to set for {% data variables.product.product_location_enterprise %}.
+4. Type the hostname you'd like to set for {% data variables.product.product_location %}.
5. To test the DNS and SSL settings for the new hostname, click **Test domain settings**.
{% data reusables.enterprise_management_console.test-domain-settings-failure %}
{% data reusables.enterprise_management_console.save-settings %}
-After you configure a hostname, we recommend that you enable subdomain isolation for {% data variables.product.product_location_enterprise %}. For more information, see "[Enabling subdomain isolation](/enterprise/{{ currentVersion }}/admin/guides/installation/enabling-subdomain-isolation/)."
+After you configure a hostname, we recommend that you enable subdomain isolation for {% data variables.product.product_location %}. For more information, see "[Enabling subdomain isolation](/enterprise/{{ currentVersion }}/admin/guides/installation/enabling-subdomain-isolation/)."
diff --git a/content/admin/configuration/configuring-an-outbound-web-proxy-server.md b/content/admin/configuration/configuring-an-outbound-web-proxy-server.md
index 172f5a047e6e..e2922e8b4616 100644
--- a/content/admin/configuration/configuring-an-outbound-web-proxy-server.md
+++ b/content/admin/configuration/configuring-an-outbound-web-proxy-server.md
@@ -1,6 +1,6 @@
---
title: Configuring an outbound web proxy server
-intro: 'A proxy server provides an additional level of security for {% data variables.product.product_location_enterprise %}.'
+intro: 'A proxy server provides an additional level of security for {% data variables.product.product_location %}.'
redirect_from:
- /enterprise/admin/guides/installation/configuring-a-proxy-server/
- /enterprise/admin/installation/configuring-an-outbound-web-proxy-server
@@ -8,11 +8,11 @@ redirect_from:
versions:
enterprise-server: '*'
---
-When a proxy server is enabled for {% data variables.product.product_location_enterprise %}, outbound messages sent by {% data variables.product.prodname_ghe_server %} are first sent through the proxy server, unless the destination host is added as an HTTP proxy exclusion. Types of outbound messages include outgoing webhooks, uploading bundles, and fetching legacy avatars. The proxy server's URL is the protocol, domain or IP address, plus the port number, for example `http://127.0.0.1:8123`.
+When a proxy server is enabled for {% data variables.product.product_location %}, outbound messages sent by {% data variables.product.prodname_ghe_server %} are first sent through the proxy server, unless the destination host is added as an HTTP proxy exclusion. Types of outbound messages include outgoing webhooks, uploading bundles, and fetching legacy avatars. The proxy server's URL is the protocol, domain or IP address, plus the port number, for example `http://127.0.0.1:8123`.
{% note %}
-**Note:** To connect {% data variables.product.product_location_enterprise %} to {% data variables.product.prodname_dotcom_the_website %}, your proxy configuration must allow connectivity to `github.com` and `api.github.com`. For more information, see "[Connecting {% data variables.product.prodname_ghe_server %} to {% data variables.product.prodname_dotcom_the_website %}](/enterprise/{{ currentVersion }}/admin/guides/developer-workflow/connecting-github-enterprise-server-to-github-com)."
+**Note:** To connect {% data variables.product.product_location %} to {% data variables.product.prodname_dotcom_the_website %}, your proxy configuration must allow connectivity to `github.com` and `api.github.com`. For more information, see "[Connecting {% data variables.product.prodname_ghe_server %} to {% data variables.product.prodname_dotcom_the_website %}](/enterprise/{{ currentVersion }}/admin/guides/developer-workflow/connecting-github-enterprise-server-to-github-com)."
{% endnote %}
diff --git a/content/admin/configuration/configuring-applications.md b/content/admin/configuration/configuring-applications.md
index 6839d0578745..534c4c76d9af 100644
--- a/content/admin/configuration/configuring-applications.md
+++ b/content/admin/configuration/configuring-applications.md
@@ -1,6 +1,6 @@
---
title: Configuring applications
-intro: 'You can configure internal application settings for {% data variables.product.product_location_enterprise %}.'
+intro: 'You can configure internal application settings for {% data variables.product.product_location %}.'
redirect_from:
- /enterprise/admin/installation/configuring-applications
- /enterprise/admin/configuration/configuring-applications
@@ -10,12 +10,12 @@ versions:
### Adjusting image caching
-You can choose the amount of time that {% data variables.product.product_location_enterprise %} caches avatars. When you increase the cache time, you increase the amount of time a user's avatar will take to load. Configuring the cache time with too low a value can overload {% data variables.product.product_location_enterprise %} work processes.
+You can choose the amount of time that {% data variables.product.product_location %} caches avatars. When you increase the cache time, you increase the amount of time a user's avatar will take to load. Configuring the cache time with too low a value can overload {% data variables.product.product_location %} work processes.
{% data reusables.enterprise_site_admin_settings.access-settings %}
{% data reusables.enterprise_site_admin_settings.management-console %}
3. In the left sidebar, click **Applications**.
-4. Under "Avatar image cache time (seconds)", type the number of seconds that you would like {% data variables.product.product_location_enterprise %} to cache avatar images.
+4. Under "Avatar image cache time (seconds)", type the number of seconds that you would like {% data variables.product.product_location %} to cache avatar images.
{% data reusables.enterprise_management_console.save-settings %}
diff --git a/content/admin/configuration/configuring-backups-on-your-appliance.md b/content/admin/configuration/configuring-backups-on-your-appliance.md
index cd590cf86674..0910093998fd 100644
--- a/content/admin/configuration/configuring-backups-on-your-appliance.md
+++ b/content/admin/configuration/configuring-backups-on-your-appliance.md
@@ -12,14 +12,14 @@ redirect_from:
- /enterprise/admin/guides/installation/backups-and-disaster-recovery/
- /enterprise/admin/installation/configuring-backups-on-your-appliance
- /enterprise/admin/configuration/configuring-backups-on-your-appliance
-intro: 'As part of a disaster recovery plan, you can protect production data on {% data variables.product.product_location_enterprise %} by configuring automated backups.'
+intro: 'As part of a disaster recovery plan, you can protect production data on {% data variables.product.product_location %} by configuring automated backups.'
versions:
enterprise-server: '*'
---
### About {% data variables.product.prodname_enterprise_backup_utilities %}
-{% data variables.product.prodname_enterprise_backup_utilities %} is a backup system you install on a separate host, which takes backup snapshots of {% data variables.product.product_location_enterprise %} at regular intervals over a secure SSH network connection. You can use a snapshot to restore an existing {% data variables.product.prodname_ghe_server %} instance to a previous state from the backup host.
+{% data variables.product.prodname_enterprise_backup_utilities %} is a backup system you install on a separate host, which takes backup snapshots of {% data variables.product.product_location %} at regular intervals over a secure SSH network connection. You can use a snapshot to restore an existing {% data variables.product.prodname_ghe_server %} instance to a previous state from the backup host.
Only data added since the last snapshot will transfer over the network and occupy additional physical storage space. To minimize performance impact, backups are performed online under the lowest CPU/IO priority. You do not need to schedule a maintenance window to perform a backup.
@@ -27,11 +27,11 @@ For more detailed information on features, requirements, and advanced usage, see
### Prerequisites
-To use {% data variables.product.prodname_enterprise_backup_utilities %}, you must have a Linux or Unix host system separate from {% data variables.product.product_location_enterprise %}.
+To use {% data variables.product.prodname_enterprise_backup_utilities %}, you must have a Linux or Unix host system separate from {% data variables.product.product_location %}.
You can also integrate {% data variables.product.prodname_enterprise_backup_utilities %} into an existing environment for long-term permanent storage of critical data.
-We recommend that the backup host and {% data variables.product.product_location_enterprise %} be geographically distant from each other. This ensures that backups are available for recovery in the event of a major disaster or network outage at the primary site.
+We recommend that the backup host and {% data variables.product.product_location %} be geographically distant from each other. This ensures that backups are available for recovery in the event of a major disaster or network outage at the primary site.
Physical storage requirements will vary based on Git repository disk usage and expected growth patterns:
@@ -59,7 +59,7 @@ More resources may be required depending on your usage, such as user activity an
3. Set the `GHE_HOSTNAME` value to your primary {% data variables.product.prodname_ghe_server %} instance's hostname or IP address.
4. Set the `GHE_DATA_DIR` value to the filesystem location where you want to store backup snapshots.
5. Open your primary instance's settings page at `https://HOSTNAME/setup/settings` and add the backup host's SSH key to the list of authorized SSH keys. For more information, see [Accessing the administrative shell (SSH)](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-administrative-shell-ssh/).
-5. Verify SSH connectivity with {% data variables.product.product_location_enterprise %} with the `ghe-host-check` command.
+5. Verify SSH connectivity with {% data variables.product.product_location %} with the `ghe-host-check` command.
```shell
$ bin/ghe-host-check
```
@@ -78,9 +78,9 @@ If backup attempts overlap, the `ghe-backup` command will abort with an error me
### Restoring a backup
-In the event of prolonged outage or catastrophic event at the primary site, you can restore {% data variables.product.product_location_enterprise %} by provisioning another {% data variables.product.prodname_enterprise %} appliance and performing a restore from the backup host. You must add the backup host's SSH key to the target {% data variables.product.prodname_enterprise %} appliance as an authorized SSH key before restoring an appliance.
+In the event of prolonged outage or catastrophic event at the primary site, you can restore {% data variables.product.product_location %} by provisioning another {% data variables.product.prodname_enterprise %} appliance and performing a restore from the backup host. You must add the backup host's SSH key to the target {% data variables.product.prodname_enterprise %} appliance as an authorized SSH key before restoring an appliance.
-To restore {% data variables.product.product_location_enterprise %} from the last successful snapshot, use the `ghe-restore` command. You should see output similar to this:
+To restore {% data variables.product.product_location %} from the last successful snapshot, use the `ghe-restore` command. You should see output similar to this:
```shell
$ ghe-restore -c 169.154.1.1
diff --git a/content/admin/configuration/configuring-built-in-firewall-rules.md b/content/admin/configuration/configuring-built-in-firewall-rules.md
index 0b98a22cfe6d..d6a3059f5343 100644
--- a/content/admin/configuration/configuring-built-in-firewall-rules.md
+++ b/content/admin/configuration/configuring-built-in-firewall-rules.md
@@ -1,6 +1,6 @@
---
title: Configuring built-in firewall rules
-intro: 'You can view default firewall rules and customize rules for {% data variables.product.product_location_enterprise %}.'
+intro: 'You can view default firewall rules and customize rules for {% data variables.product.product_location %}.'
redirect_from:
- /enterprise/admin/guides/installation/configuring-firewall-settings/
- /enterprise/admin/installation/configuring-built-in-firewall-rules
@@ -9,7 +9,7 @@ versions:
enterprise-server: '*'
---
-### About {% data variables.product.product_location_enterprise %}'s firewall
+### About {% data variables.product.product_location %}'s firewall
{% data variables.product.prodname_ghe_server %} uses Ubuntu's Uncomplicated Firewall (UFW) on the virtual appliance. For more information see "[UFW](https://help.ubuntu.com/community/UFW)" in the Ubuntu documentation. {% data variables.product.prodname_ghe_server %} automatically updates the firewall allowlist of allowed services with each release.
@@ -66,7 +66,7 @@ The UFW firewall also opens several other ports that are required for {% data va
$ sudo cp -r /lib/ufw ~/ufw.backup
```
-After you upgrade {% data variables.product.product_location_enterprise %}, you must reapply your custom firewall rules. We recommend that you create a script to reapply your firewall custom rules.
+After you upgrade {% data variables.product.product_location %}, you must reapply your custom firewall rules. We recommend that you create a script to reapply your firewall custom rules.
### Restoring the default firewall rules
diff --git a/content/admin/configuration/configuring-code-scanning-for-your-appliance.md b/content/admin/configuration/configuring-code-scanning-for-your-appliance.md
index 95ca6a245aa3..e642fbbda207 100644
--- a/content/admin/configuration/configuring-code-scanning-for-your-appliance.md
+++ b/content/admin/configuration/configuring-code-scanning-for-your-appliance.md
@@ -1,7 +1,7 @@
---
title: Configuring code scanning for your appliance
shortTitle: Configuring code scanning
-intro: 'You can enable, configure and disable {% data variables.product.prodname_code_scanning %} for {% data variables.product.product_location_enterprise %}. {% data variables.product.prodname_code_scanning_capc %} allows users to scan code for vulnerabilities and errors.'
+intro: 'You can enable, configure and disable {% data variables.product.prodname_code_scanning %} for {% data variables.product.product_location %}. {% data variables.product.prodname_code_scanning_capc %} allows users to scan code for vulnerabilities and errors.'
product: '{% data reusables.gated-features.code-scanning %}'
miniTocMaxHeadingLevel: 4
redirect_from:
@@ -20,7 +20,7 @@ The table below summarizes the available types of analysis for {% data variables
{% data reusables.code-scanning.enabling-options %}
-For the users of {% data variables.product.product_location_enterprise %} to be able to enable and use {% data variables.product.prodname_code_scanning %} in their repositories, you need, as a site administrator, to enable this feature for the whole appliance.
+For the users of {% data variables.product.product_location %} to be able to enable and use {% data variables.product.prodname_code_scanning %} in their repositories, you need, as a site administrator, to enable this feature for the whole appliance.
### How do I know if {% data variables.product.prodname_code_scanning %} is enabled for my appliance
@@ -55,18 +55,18 @@ You must ensure that Git is in the PATH variable on any self-hosted runners you
To run {% data variables.product.prodname_code_scanning %} on {% data variables.product.prodname_ghe_server %} with {% data variables.product.prodname_actions %}, the appropriate action must be available locally. You can make the action available in three ways.
- **Recommended** You can use [{% data variables.product.prodname_github_connect %}](/enterprise/admin/configuration/connecting-github-enterprise-server-to-github-enterprise-cloud) to automatically download actions from {% data variables.product.prodname_dotcom_the_website %}. The machine that hosts your instance must be able to access {% data variables.product.prodname_dotcom_the_website %}. This approach ensures that you get the latest software automatically. For more information, see "[Configuring {% data variables.product.prodname_github_connect %} to sync {% data variables.product.prodname_actions %}](/enterprise/admin/configuration/configuring-code-scanning-for-your-appliance#configuring-github-connect-to-sync-github-actions)."
-- If you want to use the {% data variables.product.prodname_codeql_workflow %}, you can sync the repository from {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.prodname_ghe_server %}, by using the {% data variables.product.prodname_codeql %} Action sync tool available at [https://github.com/github/codeql-action-sync-tool](https://github.com/github/codeql-action-sync-tool/). You can use this tool regardless of whether {% data variables.product.product_location_enterprise %} or your {% data variables.product.prodname_actions %} runners have access to the internet, as long as you can access both {% data variables.product.product_location_enterprise %} and {% data variables.product.prodname_dotcom_the_website %} simultaneously on your computer.
+- If you want to use the {% data variables.product.prodname_codeql_workflow %}, you can sync the repository from {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.prodname_ghe_server %}, by using the {% data variables.product.prodname_codeql %} Action sync tool available at [https://github.com/github/codeql-action-sync-tool](https://github.com/github/codeql-action-sync-tool/). You can use this tool regardless of whether {% data variables.product.product_location %} or your {% data variables.product.prodname_actions %} runners have access to the internet, as long as you can access both {% data variables.product.product_location %} and {% data variables.product.prodname_dotcom_the_website %} simultaneously on your computer.
- You can create a local copy of the action's repository on your server, by cloning the {% data variables.product.prodname_dotcom_the_website %} repository with the action. For example, if you want to use the {% data variables.product.prodname_codeql %} action, you can create a repository in your instance called `github/codeql-action`, then clone the [repository](https://github.com/github/codeql-action) from {% data variables.product.prodname_dotcom_the_website %}, and then push that repository to your instance's `github/codeql-action` repository. You will also need to download any of the releases from the repository on {% data variables.product.prodname_dotcom_the_website %} and upload them to your instance's `github/codeql-action` repository as releases.
##### Configuring {% data variables.product.prodname_github_connect %} to sync {% data variables.product.prodname_actions %}
1. If you want to download action workflows on demand from {% data variables.product.prodname_dotcom_the_website %}, you need to enable {% data variables.product.prodname_github_connect %}. For more information, see "[Enabling {% data variables.product.prodname_github_connect %}](/enterprise/admin/configuration/connecting-github-enterprise-server-to-github-enterprise-cloud#enabling-github-connect)."
-2. You'll also need to enable {% data variables.product.prodname_actions %} for {% data variables.product.product_location_enterprise %}. For more information, see "[Enabling {% data variables.product.prodname_actions %} and configuring storage](/enterprise/admin/github-actions/enabling-github-actions-and-configuring-storage)."
+2. You'll also need to enable {% data variables.product.prodname_actions %} for {% data variables.product.product_location %}. For more information, see "[Enabling {% data variables.product.prodname_actions %} and configuring storage](/enterprise/admin/github-actions/enabling-github-actions-and-configuring-storage)."
3. The next step is to configure access to actions on {% data variables.product.prodname_dotcom_the_website %} using {% data variables.product.prodname_github_connect %}. For more information, see "[Enabling automatic access to {% data variables.product.prodname_dotcom_the_website %} actions using {% data variables.product.prodname_github_connect %}](/enterprise/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect)."
4. Add a self-hosted runner to your repository, organization, or enterprise account. For more information, see "[Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners)."
-After you configure a self-hosted runner, users can enable {% data variables.product.prodname_code_scanning %} for individual repositories on {% data variables.product.product_location_enterprise %}. For more information, see "[Enabling {% data variables.product.prodname_code_scanning %} for a repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/enabling-code-scanning-for-a-repository)."
+After you configure a self-hosted runner, users can enable {% data variables.product.prodname_code_scanning %} for individual repositories on {% data variables.product.product_location %}. For more information, see "[Enabling {% data variables.product.prodname_code_scanning %} for a repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/enabling-code-scanning-for-a-repository)."
### Running {% data variables.product.prodname_code_scanning %} using the {% data variables.product.prodname_codeql_runner %}
If your organization isn't taking part in the beta for {% data variables.product.prodname_actions %}, or if you don't want to use {% data variables.product.prodname_actions %}, you can run {% data variables.product.prodname_code_scanning %} using the {% data variables.product.prodname_codeql_runner %}.
diff --git a/content/admin/configuration/configuring-data-encryption-for-your-enterprise.md b/content/admin/configuration/configuring-data-encryption-for-your-enterprise.md
new file mode 100644
index 000000000000..2d426fccb96c
--- /dev/null
+++ b/content/admin/configuration/configuring-data-encryption-for-your-enterprise.md
@@ -0,0 +1,71 @@
+---
+title: Configuring data encryption for your enterprise
+shortTitle: Configuring data encryption
+intro: 'For encryption at rest, you can provide your own encryption key to encrypt your data under your encryption policies.'
+versions:
+ github-ae: '*'
+---
+
+{% note %}
+
+**Note:** Configuring encryption at rest with a customer-managed key is currently in beta and subject to change.
+
+{% endnote %}
+
+### About data encryption
+
+To provide a high level of security, {% data variables.product.product_name %} encrypts your data while at rest in the data centers and while your data is in transit between users' machines and the data centers.
+
+For encryption in transit, {% data variables.product.product_name %} uses Transport Layer Security (TLS). For encryption at rest, {% data variables.product.product_name %} provides a default RSA key. After you've initialized your enterprise, you can choose to provide your own key instead. Your key should be a 2048 bit RSA private key in PEM format.
+
+The key that you provide is stored in a hardware security module (HSM) in a key vault that {% data variables.product.company_short %} manages.
+
+To configure your encryption key, use the REST API. There are a number of API endpoints, for example to check the status of encryption, update your encryption key, and delete your encryption key. Note that deleting your key will freeze your enterprise. For more information about the API endpoints, see "[Encryption at rest](/rest/reference/enterprise-admin#encryption-at-rest)" in the REST API documentation.
+
+### Adding or updating an encryption key
+
+You can add a new encryption key as often as you need. When you add a new key, the old key is discarded. Your enterprise won't experience downtime when you update the key.
+
+Your 2048 bit RSA private key should be in PEM format, for example in a file called _private-key.pem_.
+
+ ```
+ -----BEGIN RSA PRIVATE KEY-----
+ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+ -----END RSA PRIVATE KEY-----
+ ```
+
+1. To add your key, use the `PATCH /enterprise/encryption` endpoint, replacing *~/private-key.pem* with the path to your private key.
+
+ ```shell
+ curl -X PATCH http(s)://hostname/api/v3/enterprise/encryption \
+ -d "{ \"key\": \"$(awk '{printf "%s\\n", $0}' ~/private-key.pem)\" }"
+ ```
+
+2. Optionally, check the status of the update operation.
+
+ ```shell
+ curl -X GET http(s)://hostname/api/v3/enterprise/encryption/status/request_id
+ ```
+
+### Deleting your encryption key
+
+To freeze your enterprise, for example in the case of a breach, you can disable encryption at rest by deleting your encryption key.
+
+To unfreeze your enterprise after you've deleted your encryption key, contact support. For more information, see "[About {% data variables.contact.enterprise_support %}](/admin/enterprise-support/about-github-enterprise-support)."
+
+1. To delete your key and disable encryption at rest, use the `DELETE /enterprise/encryption` endpoint.
+
+ ```shell
+ curl -X DELETE http(s)://hostname/api/v3/enterprise/encryption
+ ```
+
+2. Optionally, check the status of the delete operation.
+
+ ```shell
+ curl -X GET http(s)://hostname/api/v3/enterprise/encryption/status/request_id
+ ```
+
+### Further reading
+
+- "[Encryption at rest](/rest/reference/enterprise-admin#encryption-at-rest)" in the REST API documentation
diff --git a/content/admin/configuration/configuring-dns-nameservers.md b/content/admin/configuration/configuring-dns-nameservers.md
index 6856350548b7..5e3dd8edbf83 100644
--- a/content/admin/configuration/configuring-dns-nameservers.md
+++ b/content/admin/configuration/configuring-dns-nameservers.md
@@ -9,7 +9,7 @@ versions:
enterprise-server: '*'
---
-The nameservers you specify must resolve {% data variables.product.product_location_enterprise %}'s hostname.
+The nameservers you specify must resolve {% data variables.product.product_location %}'s hostname.
{% data reusables.enterprise_installation.changing-hostname-not-supported %}
@@ -28,7 +28,7 @@ The nameservers you specify must resolve {% data variables.product.product_locat
```
3. Append any `nameserver` entries, then save the file.
4. After verifying your changes, save the file.
-5. To add your new nameserver entries to {% data variables.product.product_location_enterprise %}, enter:
+5. To add your new nameserver entries to {% data variables.product.product_location %}, enter:
```shell
$ sudo service resolvconf restart
```
diff --git a/content/admin/user-management/configuring-email-for-notifications.md b/content/admin/configuration/configuring-email-for-notifications.md
similarity index 86%
rename from content/admin/user-management/configuring-email-for-notifications.md
rename to content/admin/configuration/configuring-email-for-notifications.md
index 20c4d1503eb1..622261500ad9 100644
--- a/content/admin/user-management/configuring-email-for-notifications.md
+++ b/content/admin/configuration/configuring-email-for-notifications.md
@@ -6,11 +6,25 @@ redirect_from:
- /enterprise/admin/articles/troubleshooting-email/
- /enterprise/admin/articles/email-configuration-and-troubleshooting/
- /enterprise/admin/user-management/configuring-email-for-notifications
-intro: 'To make it easy for users to respond quickly to activity on {% data variables.product.prodname_ghe_server %}, you can configure your instance to send email notifications on issue, pull request, and commit comments, as well as additional settings to allow inbound email replies. Notification emails are sent if there is activity on a repository a user is watching, if there is activity in a pull request or issue they are participating in, or if the user or team they''re a member of are @mentioned in a comment.'
+intro: 'To make it easy for users to respond quickly to activity on {% data variables.product.product_name %}, you can configure your enterprise to send email notifications on issue, pull request, and commit comments{% if enterpriseServerVersions contains currentVersion %}, as well as additional settings to allow inbound email replies{% endif %}.'
versions:
enterprise-server: '*'
+ github-ae: '*'
---
+Notification emails are sent if there is activity on a repository a user is watching, if there is activity in a pull request or issue they are participating in, or if the user or team they're a member of are @mentioned in a comment.
+
+{% if currentVersion == "github-ae@latest" %}
+Your dedicated technical account manager in {% data variables.contact.github_support %} can configure email for notifications to be sent through your SMTP server. Make sure you include the following details in your support request.
+
+- Your SMTP server address
+- The port your SMTP server uses to send email
+- The domain name that your SMTP server will send with a HELO response, if any
+- The type of encryption used by your SMTP server
+- The no-reply email address to use in the `From` and `To` field for all notifications
+
+For more information about contacting support, see "[About {% data variables.contact.enterprise_support %}](/enterprise/admin/guides/enterprise-support/about-github-enterprise-support)."
+{% else %}
### Configuring SMTP
{% data reusables.enterprise_site_admin_settings.access-settings %}
@@ -120,7 +134,7 @@ This log shows that the appliance:
* The `login` authentication type was performed (`<- "AUTH LOGIN\r\n"`).
* The SMTP Server rejected the authentication as invalid (`-> "535-5.7.1 Username and Password not accepted.`).
-#### Check {% data variables.product.product_location_enterprise %} logs
+#### Check {% data variables.product.product_location %} logs
If you need to verify that your inbound email is functioning, there are two logfiles that you can examine on your instance: To verify that */var/log/mail.log* and */var/log/mail-replies/metroplex.log*.
@@ -155,8 +169,9 @@ In order to properly process inbound emails, you must configure a valid A Record
#### Check firewall or AWS Security Group settings
-If {% data variables.product.product_location_enterprise %} is behind a firewall or is being served through an AWS Security Group, make sure port 25 is open to all mail servers that send emails to `reply@reply.[hostname]`.
+If {% data variables.product.product_location %} is behind a firewall or is being served through an AWS Security Group, make sure port 25 is open to all mail servers that send emails to `reply@reply.[hostname]`.
#### Contact support
If you're still unable to resolve the problem, contact {% data variables.contact.contact_ent_support %}. Please attach the output file from `http(s)://[hostname]/setup/diagnostics` to your email to help us troubleshoot your problem.
+{% endif %}
diff --git a/content/admin/configuration/configuring-github-pages-for-your-enterprise.md b/content/admin/configuration/configuring-github-pages-for-your-enterprise.md
new file mode 100644
index 000000000000..29a92ff609f6
--- /dev/null
+++ b/content/admin/configuration/configuring-github-pages-for-your-enterprise.md
@@ -0,0 +1,68 @@
+---
+title: Configuring GitHub Pages for your enterprise
+intro: 'You can enable or disable {% data variables.product.prodname_pages %} for your enterprise and choose whether to make sites publicly accessible.'
+redirect_from:
+ - /enterprise/admin/guides/installation/disabling-github-enterprise-pages/
+ - /enterprise/admin/guides/installation/configuring-github-enterprise-pages/
+ - /enterprise/admin/installation/configuring-github-pages-on-your-appliance
+ - /enterprise/admin/configuration/configuring-github-pages-on-your-appliance
+ - /admin/configuration/configuring-github-pages-on-your-appliance
+ - /enterprise/admin/guides/installation/configuring-github-pages-for-your-enterprise/
+versions:
+ enterprise-server: '*'
+ github-ae: '*'
+---
+
+### Enabling public sites for {% data variables.product.prodname_pages %}
+
+{% if enterpriseServerVersions contains currentVersion %}If private mode is enabled on your enterprise, the {% else %}The {% endif %}public cannot access {% data variables.product.prodname_pages %} sites hosted by your enterprise unless you enable public sites.
+
+{% warning %}
+
+**Warning:** If you enable public sites for {% data variables.product.prodname_pages %}, every site in every repository on your enterprise will be accessible to the public.
+
+{% endwarning %}
+
+{% if enterpriseServerVersions contains currentVersion %}
+{% data reusables.enterprise_site_admin_settings.access-settings %}
+{% data reusables.enterprise_site_admin_settings.management-console %}
+{% data reusables.enterprise_management_console.pages-tab %}
+4. Select **Public Pages**.
+ 
+{% data reusables.enterprise_management_console.save-settings %}
+{% elsif currentVersion == "github-ae@latest" %}
+{% data reusables.enterprise-accounts.access-enterprise %}
+{% data reusables.enterprise-accounts.policies-tab %}
+{% data reusables.enterprise-accounts.pages-tab %}
+5. Under "Pages policies", select **Public {% data variables.product.prodname_pages %}**.
+ 
+{% data reusables.enterprise-accounts.pages-policies-save %}
+{% endif %}
+
+### Disabling {% data variables.product.prodname_pages %} for your enterprise
+
+{% if enterpriseServerVersions contains currentVersion %}
+If subdomain isolation is disabled for your enterprise, you should also disable {% data variables.product.prodname_pages %} to protect yourself from potential security vulnerabilities. For more information, see "[Enabling subdomain isolation](/admin/configuration/enabling-subdomain-isolation)."
+{% endif %}
+
+{% if enterpriseServerVersions contains currentVersion %}
+{% data reusables.enterprise_site_admin_settings.access-settings %}
+{% data reusables.enterprise_site_admin_settings.management-console %}
+{% data reusables.enterprise_management_console.pages-tab %}
+4. Unselect **Enable Pages**.
+ 
+{% data reusables.enterprise_management_console.save-settings %}
+{% elsif currentVersion == "github-ae@latest" %}
+{% data reusables.enterprise-accounts.access-enterprise %}
+{% data reusables.enterprise-accounts.policies-tab %}
+{% data reusables.enterprise-accounts.pages-tab %}
+5. Under "Pages policies", deselect **Enable {% data variables.product.prodname_pages %}**.
+ 
+{% data reusables.enterprise-accounts.pages-policies-save %}
+{% endif %}
+
+{% if enterpriseServerVersions contains currentVersion %}
+### Further reading
+
+- "[Enabling private mode](/admin/configuration/enabling-private-mode)"
+{% endif %}
diff --git a/content/admin/configuration/configuring-github-pages-on-your-appliance.md b/content/admin/configuration/configuring-github-pages-on-your-appliance.md
deleted file mode 100644
index 813ae9bbf9d0..000000000000
--- a/content/admin/configuration/configuring-github-pages-on-your-appliance.md
+++ /dev/null
@@ -1,43 +0,0 @@
----
-title: Configuring GitHub Pages on your appliance
-intro: 'You can enable or disable {% data variables.product.prodname_pages %} on your instance. You can also choose to make {% data variables.product.prodname_pages %} sites publicly accessible.'
-redirect_from:
- - /enterprise/admin/guides/installation/disabling-github-enterprise-pages/
- - /enterprise/admin/guides/installation/configuring-github-enterprise-pages/
- - /enterprise/admin/installation/configuring-github-pages-on-your-appliance
- - /enterprise/admin/configuration/configuring-github-pages-on-your-appliance
-versions:
- enterprise-server: '*'
----
-
-### Making {% data variables.product.prodname_pages %} publicly accessible
-
-If private mode is enabled on your instance, the public cannot access {% data variables.product.prodname_pages %} sites hosted on {% data variables.product.product_location_enterprise %}.
-
-{% warning %}
-
-**Warning:** If you enable public {% data variables.product.prodname_pages %} sites, every {% data variables.product.prodname_pages %} site in every repository on your instance will be accessible to the public.
-
-{% endwarning %}
-
-{% data reusables.enterprise_site_admin_settings.access-settings %}
-{% data reusables.enterprise_site_admin_settings.management-console %}
-{% data reusables.enterprise_management_console.pages-tab %}
-4. Select **Public Pages**.
-
-{% data reusables.enterprise_management_console.save-settings %}
-
-### Disabling {% data variables.product.prodname_pages %} on {% data variables.product.product_location_enterprise %}
-
-If subdomain isolation is disabled for {% data variables.product.product_location_enterprise %}, you should also disable {% data variables.product.prodname_pages %} to protect yourself from potential security vulnerabilities. For more information, see "[Enabling subdomain isolation](/enterprise/{{ currentVersion }}/admin/guides/installation/enabling-subdomain-isolation)."
-
-{% data reusables.enterprise_site_admin_settings.access-settings %}
-{% data reusables.enterprise_site_admin_settings.management-console %}
-{% data reusables.enterprise_management_console.pages-tab %}
-4. Unselect **Enable Pages**.
-
-{% data reusables.enterprise_management_console.save-settings %}
-
-### Further reading
-
-- "[Enabling private mode](/enterprise/{{ currentVersion }}/admin/guides/installation/enabling-private-mode)"
diff --git a/content/admin/configuration/configuring-rate-limits.md b/content/admin/configuration/configuring-rate-limits.md
index 878952490deb..5cffccdf1693 100644
--- a/content/admin/configuration/configuring-rate-limits.md
+++ b/content/admin/configuration/configuring-rate-limits.md
@@ -31,7 +31,7 @@ You can exempt a list of users from API rate limits using the `ghe-config` utili
### Enabling abuse rate limits
-Setting abuse rate limits protects the overall level of service on {% data variables.product.product_location_enterprise %}.
+Setting abuse rate limits protects the overall level of service on {% data variables.product.product_location %}.
{% data reusables.enterprise_site_admin_settings.access-settings %}
{% data reusables.enterprise_site_admin_settings.management-console %}
diff --git a/content/admin/configuration/configuring-tls.md b/content/admin/configuration/configuring-tls.md
index 466b5106b415..fd106938d1f5 100644
--- a/content/admin/configuration/configuring-tls.md
+++ b/content/admin/configuration/configuring-tls.md
@@ -1,6 +1,6 @@
---
title: Configuring TLS
-intro: 'You can configure Transport Layer Security (TLS) on {% data variables.product.product_location_enterprise %} so that you can use a certificate that is signed by a trusted certificate authority.'
+intro: 'You can configure Transport Layer Security (TLS) on {% data variables.product.product_location %} so that you can use a certificate that is signed by a trusted certificate authority.'
redirect_from:
- /enterprise/admin/articles/ssl-configuration/
- /enterprise/admin/guides/installation/about-tls/
@@ -54,9 +54,9 @@ Let's Encrypt is a public certificate authority that issues free, automated TLS
{% data reusables.enterprise_installation.lets-encrypt-prerequisites %}
-When you enable automation of TLS certificate management using Let's Encrypt, {% data variables.product.product_location_enterprise %} will contact the Let's Encrypt servers to obtain a certificate. To renew a certificate, Let's Encrypt servers must validate control of the configured domain name with inbound HTTP requests.
+When you enable automation of TLS certificate management using Let's Encrypt, {% data variables.product.product_location %} will contact the Let's Encrypt servers to obtain a certificate. To renew a certificate, Let's Encrypt servers must validate control of the configured domain name with inbound HTTP requests.
-You can also use the `ghe-ssl-acme` command line utility on {% data variables.product.product_location_enterprise %} to automatically generate a Let's Encrypt certificate. For more information, see "[Command-line utilities](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-ssl-acme)."
+You can also use the `ghe-ssl-acme` command line utility on {% data variables.product.product_location %} to automatically generate a Let's Encrypt certificate. For more information, see "[Command-line utilities](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-ssl-acme)."
### Configuring TLS using Let's Encrypt
diff --git a/content/admin/configuration/configuring-your-enterprise.md b/content/admin/configuration/configuring-your-enterprise.md
index 74b50d6c1bc9..5afbbe175155 100644
--- a/content/admin/configuration/configuring-your-enterprise.md
+++ b/content/admin/configuration/configuring-your-enterprise.md
@@ -1,6 +1,6 @@
---
title: Configuring your enterprise
-intro: 'Once {% data variables.product.prodname_ghe_server %} is up and running, you can configure the appliance to suit your organization''s needs.'
+intro: "After {% data variables.product.product_name %} is up and running, you can configure your enterprise to suit your organization's needs."
redirect_from:
- /enterprise/admin/guides/installation/basic-configuration/
- /enterprise/admin/guides/installation/administrative-tools/
@@ -11,5 +11,6 @@ redirect_from:
mapTopic: true
versions:
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/admin/configuration/connecting-github-enterprise-server-to-github-enterprise-cloud.md b/content/admin/configuration/connecting-github-enterprise-server-to-github-enterprise-cloud.md
index 4c67bacb469f..5be23f3a18f8 100644
--- a/content/admin/configuration/connecting-github-enterprise-server-to-github-enterprise-cloud.md
+++ b/content/admin/configuration/connecting-github-enterprise-server-to-github-enterprise-cloud.md
@@ -41,8 +41,7 @@ For more information about managing enterprise accounts using the GraphQL API, s
### 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 %}.
-{% data reusables.enterprise_site_admin_settings.access-settings %}
-{% data reusables.enterprise_site_admin_settings.business %}
+{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.github-connect-tab %}
5. Under "{% data variables.product.prodname_dotcom_the_website %} is not enabled yet", click **Enable {% data variables.product.prodname_github_connect %}**. By clicking **Enable {% data variables.product.prodname_github_connect %}**, you agree to the {% data variables.product.prodname_github_connect %} Addendum to the {% data variables.product.prodname_enterprise %} License Agreement.
@@ -54,8 +53,7 @@ For more information about managing enterprise accounts using the GraphQL API, s
When you disconnect from {% data variables.product.prodname_ghe_cloud %}, the {% data variables.product.prodname_github_connect %} {% data variables.product.prodname_github_app %} is deleted from your enterprise account or organization and credentials stored on {% data variables.product.product_location_enterprise %} are deleted.
-{% data reusables.enterprise_site_admin_settings.access-settings %}
-{% data reusables.enterprise_site_admin_settings.business %}
+{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.github-connect-tab %}
5. Next to the enterprise account or organization you'd like to disconnect, click **Disable {% data variables.product.prodname_github_connect %}**.
diff --git a/content/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server.md b/content/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server.md
index bcc57d5406a1..8d25c497ef94 100644
--- a/content/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server.md
+++ b/content/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server.md
@@ -1,11 +1,11 @@
---
title: Enabling alerts for vulnerable dependencies on GitHub Enterprise Server
-intro: 'You can connect {% data variables.product.product_location_enterprise %} to {% data variables.product.prodname_ghe_cloud %} and enable {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_short %}{% else %}security{% endif %} alerts for vulnerable dependencies in repositories in your instance.'
+intro: 'You can connect {% data variables.product.product_location %} to {% data variables.product.prodname_ghe_cloud %} and enable {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot %}{% else %}security{% endif %} alerts for vulnerable dependencies in repositories in your instance.'
redirect_from:
- /enterprise/admin/installation/enabling-security-alerts-for-vulnerable-dependencies-on-github-enterprise-server
- /enterprise/admin/configuration/enabling-security-alerts-for-vulnerable-dependencies-on-github-enterprise-server
- /enterprise/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server
-permissions: 'Site administrators for {% data variables.product.prodname_ghe_server %} who are also owners of the connected {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_short %}{% else %}security{% endif %} alerts for vulnerable dependencies on {% data variables.product.prodname_ghe_server %}.'
+permissions: 'Site administrators for {% data variables.product.prodname_ghe_server %} who are also owners of the connected {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot %}{% else %}security{% endif %} alerts for vulnerable dependencies on {% data variables.product.prodname_ghe_server %}.'
versions:
enterprise-server: '*'
---
@@ -14,40 +14,50 @@ versions:
{% data reusables.repositories.tracks-vulnerabilities %} For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)."
-You can connect {% data variables.product.product_location_enterprise %} to {% data variables.product.prodname_dotcom_the_website %}, then sync vulnerability data to your instance and generate {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_short %}{% else %}security{% endif %} alerts in repositories with a vulnerable dependency.
+You can connect {% data variables.product.product_location %} to {% data variables.product.prodname_dotcom_the_website %}, then sync vulnerability data to your instance and generate {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot %}{% else %}security{% endif %} alerts in repositories with a vulnerable dependency.
-After connecting {% data variables.product.product_location_enterprise %} to {% data variables.product.prodname_dotcom_the_website %} and enabling {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_short %}{% else %}security{% endif %} alerts for vulnerable dependencies, vulnerability data is synced from {% data variables.product.prodname_dotcom_the_website %} to your instance once every hour. You can also choose to manually sync vulnerability data at any time. No code or information about code from {% data variables.product.product_location_enterprise %} is uploaded to {% data variables.product.prodname_dotcom_the_website %}.
+After connecting {% data variables.product.product_location %} to {% data variables.product.prodname_dotcom_the_website %} and enabling {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot %}{% else %}security{% endif %} alerts for vulnerable dependencies, vulnerability data is synced from {% data variables.product.prodname_dotcom_the_website %} to your instance once every hour. You can also choose to manually sync vulnerability data at any time. No code or information about code from {% data variables.product.product_location %} is uploaded to {% data variables.product.prodname_dotcom_the_website %}.
-{% if currentVersion ver_gt "enterprise-server@2.21" %}When {% data variables.product.product_location_enterprise %} receives information about a vulnerability, it will identify repositories in your instance that use the affected version of the dependency and send {% data variables.product.prodname_dependabot_short %} alerts to owners and people with admin access in those repositories. They can customize how they receive {% data variables.product.prodname_dependabot_short %} alerts. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies/#configuring-notifications-for-github-dependabot-alerts)."
+{% if currentVersion ver_gt "enterprise-server@2.21" %}When {% data variables.product.product_location %} receives information about a vulnerability, it will identify repositories in your instance that use the affected version of the dependency and generate {% data variables.product.prodname_dependabot_alerts %}. You can customize how you receive {% data variables.product.prodname_dependabot_alerts %}. For more information, see "[Configuring notifications for vulnerable dependencies](/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies/#configuring-notifications-for-dependabot-alerts)."
{% endif %}
-{% if currentVersion ver_lt "enterprise-server@2.21" or currentVersion == "enterprise-server@2.21" %}When {% data variables.product.product_location_enterprise %} receives information about a vulnerability, it will identify repositories in your instance that use the affected version of the dependency and send security alerts to owners and people with admin access in those repositories. They can customize how they receive security alerts. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies/#configuring-notifications-for-security-alerts)."
+{% if currentVersion == "enterprise-server@2.21" %}When {% data variables.product.product_location %} receives information about a vulnerability, it will identify repositories in your instance that use the affected version of the dependency and generate security alerts. You can customize how you receive security alerts. For more information, see "[Configuring notifications for vulnerable dependencies](/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies/#configuring-notifications-for-security-alerts)."
+{% endif %}
+
+{% if currentVersion ver_lt "enterprise-server@2.21" %}When {% data variables.product.product_location %} receives information about a vulnerability, it will identify repositories in your instance that use the affected version of the dependency and generate security alerts. You can customize how you receive security alerts. For more information, see "[Choosing the delivery method for your notifications](/github/receiving-notifications-about-activity-on-github/choosing-the-delivery-method-for-your-notifications#choosing-the-delivery-method-for-security-alerts-for-vulnerable-dependencies)."
{% endif %}
{% if currentVersion ver_gt "enterprise-server@2.21" %}
-### Enabling {% data variables.product.prodname_dependabot_short %} alerts for vulnerable dependencies on {% data variables.product.prodname_ghe_server %}
+### Enabling {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies on {% data variables.product.prodname_ghe_server %}
{% else %}
### Enabling security alerts for vulnerable dependencies on {% data variables.product.prodname_ghe_server %}
{% endif %}
-Before enabling {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_short %}{% else %}security{% endif %} alerts for vulnerable dependencies on {% data variables.product.product_location_enterprise %}, you must connect {% data variables.product.product_location_enterprise %} to {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[Connecting {% data variables.product.prodname_ghe_server %} to {% data variables.product.prodname_ghe_cloud %}](/enterprise/{{ currentVersion }}/admin/guides/installation/connecting-github-enterprise-server-to-github-enterprise-cloud)."
+Before enabling {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot %}{% else %}security{% endif %} alerts for vulnerable dependencies on {% data variables.product.product_location %}, you must connect {% data variables.product.product_location %} to {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[Connecting {% data variables.product.prodname_ghe_server %} to {% data variables.product.prodname_ghe_cloud %}](/enterprise/{{ currentVersion }}/admin/guides/installation/connecting-github-enterprise-server-to-github-enterprise-cloud)."
-{% if currentVersion ver_gt "enterprise-server@2.20" %}
+{% if currentVersion ver_gt "enterprise-server@2.20" %}
-{% if currentVersion ver_gt "enterprise-server@2.21" %}We recommend configuring {% data variables.product.prodname_dependabot_short %} alerts without notifications for the first few days to avoid an overload of emails. After a few days, you can enable notifications to receive {% data variables.product.prodname_dependabot_short %} alerts as usual.{% endif %}
+{% if currentVersion ver_gt "enterprise-server@2.21" %}We recommend configuring {% data variables.product.prodname_dependabot_alerts %} without notifications for the first few days to avoid an overload of emails. After a few days, you can enable notifications to receive {% data variables.product.prodname_dependabot_alerts %} as usual.{% endif %}
{% if currentVersion == "enterprise-server@2.21" %}We recommend configuring security alerts without notifications for the first few days to avoid an overload of emails. After a few days, you can enable notifications to receive security alerts as usual.{% endif %}
{% endif %}
{% data reusables.enterprise_site_admin_settings.sign-in %}
-1. In the administrative shell, enable the {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_short %}{% else %}security{% endif %} alerts for vulnerable dependencies on {% data variables.product.product_location_enterprise %}:
+
+1. In the administrative shell, enable the {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot %}{% else %}security{% endif %} alerts for vulnerable dependencies on {% data variables.product.product_location %}:
+
``` shell
$ ghe-dep-graph-enable
```
+ {% note %}
+
+ **Note**: For more information about enabling access to the administrative shell via SSH, see "[Accessing the administrative shell (SSH)](/enterprise/{{ currentVersion }}/admin/configuration/accessing-the-administrative-shell-ssh)."
+
+ {% endnote %}
+
3. Return to {% data variables.product.prodname_ghe_server %}.
-{% data reusables.enterprise_site_admin_settings.access-settings %}
-{% data reusables.enterprise_site_admin_settings.business %}
+{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.github-connect-tab %}{% if currentVersion ver_gt "enterprise-server@2.20" %}
5. Under "Repositories can be scanned for vulnerabilities", use the drop-down menu and select **Enabled without notifications**. Optionally, to enable alerts with notifications, select **Enabled with notifications**.{% else %}
@@ -57,7 +67,7 @@ $ ghe-dep-graph-enable
### Viewing vulnerable dependencies on {% data variables.product.prodname_ghe_server %}
-You can view all vulnerabilities in {% data variables.product.product_location_enterprise %} and manually sync vulnerability data from {% data variables.product.prodname_dotcom_the_website %} to update the list.
+You can view all vulnerabilities in {% data variables.product.product_location %} and manually sync vulnerability data from {% data variables.product.prodname_dotcom_the_website %} to update the list.
{% data reusables.enterprise_site_admin_settings.access-settings %}
2. In the left sidebar, click **Vulnerabilities**.
diff --git a/content/admin/configuration/enabling-and-scheduling-maintenance-mode.md b/content/admin/configuration/enabling-and-scheduling-maintenance-mode.md
index a92a2ea9748c..832241da5f92 100644
--- a/content/admin/configuration/enabling-and-scheduling-maintenance-mode.md
+++ b/content/admin/configuration/enabling-and-scheduling-maintenance-mode.md
@@ -1,6 +1,6 @@
---
title: Enabling and scheduling maintenance mode
-intro: 'Some standard maintenance procedures, such as upgrading {% data variables.product.product_location_enterprise %} or restoring backups, require the instance to be taken offline for normal use.'
+intro: 'Some standard maintenance procedures, such as upgrading {% data variables.product.product_location %} or restoring backups, require the instance to be taken offline for normal use.'
redirect_from:
- /enterprise/admin/maintenance-mode/
- /enterprise/admin/categories/maintenance-mode/
@@ -16,7 +16,7 @@ versions:
### About maintenance mode
-Some types of operations require that you take {% data variables.product.product_location_enterprise %} offline and put it into maintenance mode:
+Some types of operations require that you take {% data variables.product.product_location %} offline and put it into maintenance mode:
- Upgrading to a new version of {% data variables.product.prodname_ghe_server %}
- Increasing CPU, memory, or storage resources allocated to the virtual machine
- Migrating data from one virtual machine to another
diff --git a/content/admin/configuration/enabling-automatic-user-license-sync-between-github-enterprise-server-and-github-enterprise-cloud.md b/content/admin/configuration/enabling-automatic-user-license-sync-between-github-enterprise-server-and-github-enterprise-cloud.md
index f4d927fa12cb..a320a62917a3 100644
--- a/content/admin/configuration/enabling-automatic-user-license-sync-between-github-enterprise-server-and-github-enterprise-cloud.md
+++ b/content/admin/configuration/enabling-automatic-user-license-sync-between-github-enterprise-server-and-github-enterprise-cloud.md
@@ -19,8 +19,7 @@ You can also manually upload {% data variables.product.prodname_ghe_server %} us
Before enabling license synchronization on {% data variables.product.product_location_enterprise %}, you must connect {% data variables.product.product_location_enterprise %} to {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[Connecting {% data variables.product.prodname_ghe_server %} to {% data variables.product.prodname_ghe_cloud %}](/enterprise/{{ currentVersion }}/admin/guides/installation/connecting-github-enterprise-server-to-github-enterprise-cloud)."
-{% data reusables.enterprise_site_admin_settings.access-settings %}
-{% data reusables.enterprise_site_admin_settings.business %}
+{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.github-connect-tab %}
5. Under "Server can sync user license count and usage", use the drop-down menu and select **Enabled**.
diff --git a/content/admin/configuration/enabling-private-mode.md b/content/admin/configuration/enabling-private-mode.md
index f71588a536d5..831e440b7ff8 100644
--- a/content/admin/configuration/enabling-private-mode.md
+++ b/content/admin/configuration/enabling-private-mode.md
@@ -11,11 +11,11 @@ versions:
enterprise-server: '*'
---
-You must enable private mode if {% data variables.product.product_location_enterprise %} is publicly accessible over the Internet. In private mode, users cannot anonymously clone repositories over `git://`. If built-in authentication is also enabled, an administrator must invite new users to create an account on the instance. For more information, see "[Using built-in authentication](/enterprise/{{ currentVersion }}/admin/guides/user-management/using-built-in-authentication)."
+You must enable private mode if {% data variables.product.product_location %} is publicly accessible over the Internet. In private mode, users cannot anonymously clone repositories over `git://`. If built-in authentication is also enabled, an administrator must invite new users to create an account on the instance. For more information, see "[Using built-in authentication](/enterprise/{{ currentVersion }}/admin/guides/user-management/using-built-in-authentication)."
{% data reusables.enterprise_installation.image-urls-viewable-warning %}
-With private mode enabled, you can allow unauthenticated Git operations (and anyone with network access to {% data variables.product.product_location_enterprise %}) to read a public repository's code on your instance with anonymous Git read access enabled. For more information, see "[Allowing admins to enable anonymous Git read access to public repositories](/enterprise/{{ currentVersion }}/admin/guides/user-management/allowing-admins-to-enable-anonymous-git-read-access-to-public-repositories)."
+With private mode enabled, you can allow unauthenticated Git operations (and anyone with network access to {% data variables.product.product_location %}) to read a public repository's code on your instance with anonymous Git read access enabled. For more information, see "[Allowing admins to enable anonymous Git read access to public repositories](/enterprise/{{ currentVersion }}/admin/guides/user-management/allowing-admins-to-enable-anonymous-git-read-access-to-public-repositories)."
{% data reusables.enterprise_site_admin_settings.access-settings %}
{% data reusables.enterprise_site_admin_settings.management-console %}
diff --git a/content/admin/configuration/enabling-subdomain-isolation.md b/content/admin/configuration/enabling-subdomain-isolation.md
index 5dea7745a917..33ebac277078 100644
--- a/content/admin/configuration/enabling-subdomain-isolation.md
+++ b/content/admin/configuration/enabling-subdomain-isolation.md
@@ -11,7 +11,7 @@ versions:
### About subdomain isolation
-Subdomain isolation mitigates cross-site scripting and other related vulnerabilities. For more information, see "[Cross-site scripting](http://en.wikipedia.org/wiki/Cross-site_scripting)" on Wikipedia. We highly recommend that you enable subdomain isolation on {% data variables.product.product_location_enterprise %}.
+Subdomain isolation mitigates cross-site scripting and other related vulnerabilities. For more information, see "[Cross-site scripting](http://en.wikipedia.org/wiki/Cross-site_scripting)" on Wikipedia. We highly recommend that you enable subdomain isolation on {% data variables.product.product_location %}.
When subdomain isolation is enabled, {% data variables.product.prodname_ghe_server %} replaces several paths with subdomains.
diff --git a/content/admin/configuration/index.md b/content/admin/configuration/index.md
index 2e8a92d9f8a8..736ec887b61d 100644
--- a/content/admin/configuration/index.md
+++ b/content/admin/configuration/index.md
@@ -1,23 +1,35 @@
---
title: Configuring GitHub Enterprise
shortTitle: Configuring GitHub Enterprise
-intro: 'Once {% data variables.product.prodname_ghe_server %} is installed and set up, you can configure the appliance to suit your organization''s needs.'
+intro: "You can configure your enterprise to suit your organization's needs."
redirect_from:
- /enterprise/admin/configuration
versions:
enterprise-server: '*'
+ github-ae: '*'
---
+{% if currentVersion ver_gt "enterprise-server@2.21" %}
+{% note %}
+
+**Note:** To configure {% data variables.product.prodname_actions %} or {% data variables.product.prodname_registry %} for your enterprise, see "[Managing GitHub Actions for your enterprise](/admin/github-actions)" or "[Managing GitHub Packages for your enterprise](/admin/packages)."
+
+{% endnote %}
+{% endif %}
### Table of Contents
{% topic_link_in_list /configuring-your-enterprise %}
+ {% link_in_list /about-enterprise-configuration %}
+ {% link_in_list /initializing-github-ae %}
{% link_in_list /accessing-the-management-console %}
{% link_in_list /accessing-the-administrative-shell-ssh %}
+ {% link_in_list /configuring-data-encryption-for-your-enterprise %}
{% link_in_list /enabling-and-scheduling-maintenance-mode %}
{% link_in_list /configuring-backups-on-your-appliance %}
{% link_in_list /site-admin-dashboard %}
{% link_in_list /enabling-private-mode %}
+ {% link_in_list /configuring-email-for-notifications %}
{% link_in_list /configuring-rate-limits %}
{% link_in_list /configuring-applications %}
@@ -25,7 +37,8 @@ versions:
{% link_in_list /troubleshooting-ssl-errors %}
{% link_in_list /configuring-time-synchronization %}
{% link_in_list /command-line-utilities %}
- {% link_in_list /configuring-github-pages-on-your-appliance %}
+ {% link_in_list /restricting-network-traffic-to-your-enterprise %}
+ {% link_in_list /configuring-github-pages-for-your-enterprise %}
{% topic_link_in_list /configuring-network-settings %}
{% link_in_list /configuring-the-ip-address-using-the-virtual-machine-console %}
{% link_in_list /configuring-dns-nameservers %}
@@ -49,11 +62,3 @@ versions:
{% topic_link_in_list /configuring-advanced-security-features %}
{% link_in_list /configuring-code-scanning-for-your-appliance %}
-
-{% if currentVersion ver_gt "enterprise-server@2.21" %}
-{% note %}
-
-**Note:** To configure {% data variables.product.prodname_actions %} or {% data variables.product.prodname_registry %} for your enterprise, see "[Managing GitHub Actions for your enterprise](/admin/github-actions)" or "[Managing GitHub Packages for your enterprise](/admin/packages)."
-
-{% endnote %}
-{% endif %}
diff --git a/content/admin/configuration/initializing-github-ae.md b/content/admin/configuration/initializing-github-ae.md
new file mode 100644
index 000000000000..773dd7d1b592
--- /dev/null
+++ b/content/admin/configuration/initializing-github-ae.md
@@ -0,0 +1,94 @@
+---
+title: Initializing GitHub AE
+intro: 'To get your enterprise ready to use, you can complete the initial configuration of {% data variables.product.product_name %}.'
+versions:
+ github-ae: '*'
+---
+
+### About initialization
+
+Before you can initialize your enterprise, you must purchase {% data variables.product.product_name %}. For more information, contact {% data variables.contact.contact_enterprise_sales %}.
+
+After you purchase {% data variables.product.product_name %}, we'll ask you to provide an email address and username for the person you want to initialize the enterprise. Your dedicated technical account manager in {% data variables.contact.enterprise_support %} will create an account for the enterprise owner and send the enterprise owner an email to log into {% data variables.product.product_name %} and complete the initialization. Make sure the information you provide matches the intended enterprise owner's information in the IdP. For more information about enterprise owners, see "[Roles in an enterprise](/github/setting-up-and-managing-your-enterprise/roles-in-an-enterprise#enterprise-owner)."
+
+During initialization, the enterprise owner will name your enterprise, configure SAML SSO, create policies for all organizations in your enterprise, and configure a support contact for your users.
+
+### Prerequisites
+
+{% note %}
+
+**Note**: Before you begin initialization, store the initial username and password for {% data variables.product.prodname_ghe_managed %} securely in a password manager. {% data reusables.saml.contact-support-if-your-idp-is-unavailable %}
+
+{% endnote %}
+
+1. To initialize {% data variables.product.product_location %}, you must have a SAML identity provider (IdP). {% data reusables.saml.ae-uses-saml-sso %} To connect your IdP to your enterprise during initialization, you should have your IdP's Entity ID (SSO) URL, Issuer ID URL, and public signing certificate (Base64-encoded). For more information, see "[About identity and access management for your enterprise](/admin/authentication/about-identity-and-access-management-for-your-enterprise)."
+
+ {% note %}
+
+ **Note**: {% data reusables.saml.create-a-machine-user %}
+
+ {% endnote %}
+
+2. {% data reusables.saml.assert-the-administrator-attribute %}
+
+### Signing in and naming your enterprise
+
+1. Follow the instructions in your welcome email to reach your enterprise.
+2. Type your credentials under "Change password", then click **Change password**.
+3. Under "What would you like your enterprise account to be named?", type the enterprise's name, then click **Save and continue**.
+ 
+
+### Connecting your IdP to your enterprise
+
+To configure authentication for {% data variables.product.product_name %}, you must provide {% data variables.product.product_name %} with the details for your SAML IdP. {% data variables.product.company_short %} recommends using Azure AD as your IdP. For more information, see "[Configuring authentication and provisioning with your identity provider](/admin/authentication/configuring-authentication-and-provisioning-with-your-identity-provider)."
+
+1. To the right of "Set up your identity provider", click **Configure**.
+ 
+1. Under "Sign on URL", copy and paste the URL for your SAML IdP.
+ 
+1. Under "Issuer", copy and paste the issuer URL for your SAML IdP.
+ 
+1. Under "Public certificate", copy and paste the public certificate for your SAML IdP.
+ 
+1. Click **Test SAML configuration** to ensure that the information you've entered is correct.
+ 
+1. Click **Save**.
+ 
+
+### Setting your enterprise policies
+
+Configuring policies will set limitations for repository and organization management for your enterprise. These can be reconfigured after the initialization process.
+
+1. To the right of "Set your enterprise policies", click **Configure**.
+ 
+2. Under "Default Repository Permissions", use the drop-down menu and click a default permissions level for repositories in your enterprise. If a person has multiple avenues of access to an organization, either individually, through a team, or as an organization member, the highest permission level overrides any lower permission levels. Optionally, to allow organizations within your enterprise to set their default repository permissions, click **No policy**
+ 
+3. Under "Repository creation", choose whether you want to allow members to create repositories. Optionally, to allow organizations within your enterprise to set permissions, click **No policy**.
+ 
+4. Under "Repository forking", choose whether to allow forking of private and internal repositories. Optionally, to allow organizations within your enterprise to set permissions, click **No policy**
+ 
+5. Under "Repository invitations", choose whether members or organization owners can invite collaborators to repositories. Optionally, to allow organizations within your enterprise to set permissions, click **No policy**
+ 
+6. Under "Default repository visibility", use the drop-down menu and click the default visibility setting for new repositories.
+ 
+7. Under "Users can create organizations", use the drop-down menu to enable or disable organization creation access for members of the enterprise.
+ 
+8. Under "Force pushes", use the drop-down menu and choose whether to allow or block force pushes.
+ 
+9. Under "Git SSH access", use the drop-down menu and choose whether to enable Git SSH access for all repositories in the enterprise.
+ 
+10. Click **Save**
+ 
+11. Optionally, to reset all selections, click "Reset to default policies".
+ 
+
+### Setting your internal support contact
+
+You can configure the method your users will use to contact your internal support team. This can be reconfigured after the initialization process.
+
+1. To the right of "Internal support contact", click **Configure**.
+ 
+2. Under "Internal support contact", select the method for users of your enterprise to contact support, through a URL or an e-mail address. Then, type the support contact information.
+ 
+3. Click **Save**.
+ 
diff --git a/content/admin/configuration/network-ports.md b/content/admin/configuration/network-ports.md
index d8eafa1d6f3e..9a4688b5f2db 100644
--- a/content/admin/configuration/network-ports.md
+++ b/content/admin/configuration/network-ports.md
@@ -14,13 +14,13 @@ versions:
### Administrative ports
-Some administrative ports are required to configure {% data variables.product.product_location_enterprise %} and run certain features. Administrative ports are not required for basic application use by end users.
+Some administrative ports are required to configure {% data variables.product.product_location %} and run certain features. Administrative ports are not required for basic application use by end users.
| Port | Service | Description |
|---|---|---|
| 8443 | HTTPS | Secure web-based {% data variables.enterprise.management_console %}. Required for basic installation and configuration. |
| 8080 | HTTP | Plain-text web-based {% data variables.enterprise.management_console %}. Not required unless SSL is disabled manually. |
-| 122 | SSH | Shell access for {% data variables.product.product_location_enterprise %}. Required to be open to incoming connections from all other nodes in a High Availability configuration. The default SSH port (22) is dedicated to Git and SSH application network traffic. |
+| 122 | SSH | Shell access for {% data variables.product.product_location %}. Required to be open to incoming connections from all other nodes in a High Availability configuration. The default SSH port (22) is dedicated to Git and SSH application network traffic. |
| 1194/UDP | VPN | Secure replication network tunnel in High Availability configuration. Required to be open to all other nodes in the configuration.|
| 123/UDP| NTP | Required for time protocol operation. |
| 161/UDP | SNMP | Required for network monitoring protocol operation. |
diff --git a/content/admin/configuration/restricting-network-traffic-to-your-enterprise.md b/content/admin/configuration/restricting-network-traffic-to-your-enterprise.md
new file mode 100644
index 000000000000..d20a711bd06d
--- /dev/null
+++ b/content/admin/configuration/restricting-network-traffic-to-your-enterprise.md
@@ -0,0 +1,11 @@
+---
+title: Restricting network traffic to your enterprise
+shortTitle: Restricting network traffic
+intro: 'You can restrict access to your enterprise to connections from specified IP addresses.'
+versions:
+ github-ae: '*'
+---
+
+By default, authorized users can access your enterprise from any IP address. You can restrict access to specific IP addresses such as your physical office locations by contacting support.
+
+Contact {% data variables.contact.github_support %} with the IP addresses that should be allowed to access your enterprise. Specify address ranges using the standard CIDR (Classless Inter-Domain Routing) format. {% data variables.contact.github_support %} will configure the appropriate firewall rules for your enterprise to restrict network access over HTTP, SSH, HTTPS, and SMTP. For more information, see "[Receiving help from {% data variables.contact.github_support %}](/enterprise/admin/guides/enterprise-support/receiving-help-from-github-support)."
diff --git a/content/admin/configuration/site-admin-dashboard.md b/content/admin/configuration/site-admin-dashboard.md
index 52a28c3b6451..6e24da8a369f 100644
--- a/content/admin/configuration/site-admin-dashboard.md
+++ b/content/admin/configuration/site-admin-dashboard.md
@@ -1,6 +1,6 @@
---
title: Site admin dashboard
-intro: 'The site admin dashboard provides a number of tools to help you manage {% data variables.product.product_location_enterprise %}.'
+intro: '{% data reusables.enterprise_site_admin_settings.about-the-site-admin-dashboard %}'
redirect_from:
- /enterprise/admin/articles/site-admin-dashboard/
- /enterprise/admin/installation/site-admin-dashboard
@@ -46,7 +46,7 @@ For more information on audit logging in general, see "[Audit logging](/enterpri
### Reports
-If you need to get information on the users, organizations, and repositories in {% data variables.product.product_location_enterprise %}, you would ordinarily fetch JSON data through the [GitHub API](/rest). Unfortunately, the API may not provide all of the data that you want and it requires a bit of technical expertise to use. The site admin dashboard offers a **Reports** section as an alternative, making it easy for you to download CSV reports with most of the information that you are likely to need for users, organizations, and repositories.
+If you need to get information on the users, organizations, and repositories in {% data variables.product.product_location %}, you would ordinarily fetch JSON data through the [GitHub API](/rest). Unfortunately, the API may not provide all of the data that you want and it requires a bit of technical expertise to use. The site admin dashboard offers a **Reports** section as an alternative, making it easy for you to download CSV reports with most of the information that you are likely to need for users, organizations, and repositories.
Specifically, you can download CSV reports that list
@@ -152,7 +152,7 @@ In other words, repair jobs are started as needed and run in the background—th
Furthermore, repair jobs use a "repair offset" for parallelization. This is an offset into the database table for the record being reconciled. Multiple background jobs can synchronize work based on this offset.
-A progress bar shows the current status of a repair job across all of its background workers. It is the percentage difference of the repair offset with the highest record ID in the database. Don't worry about the value shown in the progress bar after a repair job has completed: because it shows the difference between the repair offset and the highest record ID in the database, it will decrease as more repositories are added to {% data variables.product.product_location_enterprise %} even though those repositories are actually indexed.
+A progress bar shows the current status of a repair job across all of its background workers. It is the percentage difference of the repair offset with the highest record ID in the database. Don't worry about the value shown in the progress bar after a repair job has completed: because it shows the difference between the repair offset and the highest record ID in the database, it will decrease as more repositories are added to {% data variables.product.product_location %} even though those repositories are actually indexed.
You can start a new code-search index repair job at any time. It will use a single CPU as it reconciles the search index with database and Git repository data. To minimize the effects this will have on I/O performance and reduce the chances of operations timing out, try to run a repair job during off-peak hours first. Monitor your system's load averages and CPU usage with a utility like `top`; if you don't notice any significant changes, it should be safe to run an index repair job during peak hours, as well.
@@ -176,7 +176,7 @@ Refer to this section of the site admin dashboard to manage organizations, peopl
### Repositories
-This is a list of the repositories on {% data variables.product.product_location_enterprise %}. You can click on a repository name and access functions for administering the repository.
+This is a list of the repositories on {% data variables.product.product_location %}. You can click on a repository name and access functions for administering the repository.
- [Blocking force pushes to a repository](/enterprise/{{ currentVersion }}/admin/guides/developer-workflow/blocking-force-pushes-to-a-repository/)
- [Configuring {% data variables.large_files.product_name_long %}](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-git-large-file-storage/#configuring-git-large-file-storage-for-an-individual-repository)
@@ -184,17 +184,17 @@ This is a list of the repositories on {% data variables.product.product_location
### All users
-Here you can see all of the users on {% data variables.product.product_location_enterprise %}—, and [initiate an SSH key audit](/enterprise/{{ currentVersion }}/admin/guides/user-management/auditing-ssh-keys).
+Here you can see all of the users on {% data variables.product.product_location %}—, and [initiate an SSH key audit](/enterprise/{{ currentVersion }}/admin/guides/user-management/auditing-ssh-keys).
### Site admins
-Here you can see all of the administrators on {% data variables.product.product_location_enterprise %}, and [initiate an SSH key audit](/enterprise/{{ currentVersion }}/admin/guides/user-management/auditing-ssh-keys).
+Here you can see all of the administrators on {% data variables.product.product_location %}, and [initiate an SSH key audit](/enterprise/{{ currentVersion }}/admin/guides/user-management/auditing-ssh-keys).
### Dormant users
-Here you can see and [suspend](/enterprise/{{ currentVersion }}/admin/guides/user-management/suspending-and-unsuspending-users) all of the inactive users on {% data variables.product.product_location_enterprise %}. A user account is considered to be inactive ("dormant") when it:
+Here you can see and [suspend](/enterprise/{{ currentVersion }}/admin/guides/user-management/suspending-and-unsuspending-users) all of the inactive users on {% data variables.product.product_location %}. A user account is considered to be inactive ("dormant") when it:
-- Has existed for longer than the dormancy threshold that's set for {% data variables.product.product_location_enterprise %}.
+- Has existed for longer than the dormancy threshold that's set for {% data variables.product.product_location %}.
- Has not generated any activity within that time period.
- Is not a site administrator.
@@ -202,4 +202,4 @@ Here you can see and [suspend](/enterprise/{{ currentVersion }}/admin/guides/use
### Suspended users
-Here you can see all of the users who have been suspended on {% data variables.product.product_location_enterprise %}, and [initiate an SSH key audit](/enterprise/{{ currentVersion }}/admin/guides/user-management/auditing-ssh-keys).
+Here you can see all of the users who have been suspended on {% data variables.product.product_location %}, and [initiate an SSH key audit](/enterprise/{{ currentVersion }}/admin/guides/user-management/auditing-ssh-keys).
diff --git a/content/admin/configuration/troubleshooting-ssl-errors.md b/content/admin/configuration/troubleshooting-ssl-errors.md
index 98c2bf418f44..61c4bb3ce97a 100644
--- a/content/admin/configuration/troubleshooting-ssl-errors.md
+++ b/content/admin/configuration/troubleshooting-ssl-errors.md
@@ -39,7 +39,7 @@ Otherwise, you can use the SSL Converter tool to convert your certificate into t
### Unresponsive installation after uploading a key
-If {% data variables.product.product_location_enterprise %} is unresponsive after uploading an SSL key, please [contact {% data variables.product.prodname_enterprise %} Support](https://enterprise.github.com/support) with specific details, including a copy of your SSL certificate.
+If {% data variables.product.product_location %} is unresponsive after uploading an SSL key, please [contact {% data variables.product.prodname_enterprise %} Support](https://enterprise.github.com/support) with specific details, including a copy of your SSL certificate.
### Certificate validity errors
diff --git a/content/admin/configuration/using-github-enterprise-server-with-a-load-balancer.md b/content/admin/configuration/using-github-enterprise-server-with-a-load-balancer.md
index 6b3b83e96603..539b679d7354 100644
--- a/content/admin/configuration/using-github-enterprise-server-with-a-load-balancer.md
+++ b/content/admin/configuration/using-github-enterprise-server-with-a-load-balancer.md
@@ -21,7 +21,7 @@ Because client connections to {% data variables.product.prodname_ghe_server %} c
{% data reusables.enterprise_clustering.proxy_xff_firewall_warning %}
-#### Enabling PROXY protocol support on {% data variables.product.product_location_enterprise %}
+#### Enabling PROXY protocol support on {% data variables.product.product_location %}
We strongly recommend enabling PROXY protocol support for both your appliance and the load balancer. Use the instructions provided by your vendor to enable the PROXY protocol on your load balancer. For more information, see [the PROXY protocol documentation](http://www.haproxy.org/download/1.6/doc/proxy-protocol.txt).
@@ -34,7 +34,7 @@ We strongly recommend enabling PROXY protocol support for both your appliance an
{% data reusables.enterprise_clustering.proxy_protocol_ports %}
-#### Enabling X-Forwarded-For support on {% data variables.product.product_location_enterprise %}
+#### Enabling X-Forwarded-For support on {% data variables.product.product_location %}
{% data reusables.enterprise_clustering.x-forwarded-for %}
diff --git a/content/admin/configuration/validating-your-domain-settings.md b/content/admin/configuration/validating-your-domain-settings.md
index 4649dd7dd3d6..1c731a310c8a 100644
--- a/content/admin/configuration/validating-your-domain-settings.md
+++ b/content/admin/configuration/validating-your-domain-settings.md
@@ -1,6 +1,6 @@
---
title: Validating your domain settings
-intro: 'Ensure that your domain settings are properly configured before booting up {% data variables.product.product_location_enterprise %} for the first time.'
+intro: 'Ensure that your domain settings are properly configured before booting up {% data variables.product.product_location %} for the first time.'
redirect_from:
- /enterprise/admin/installation/validating-your-domain-settings
- /enterprise/admin/configuration/validating-your-domain-settings
diff --git a/content/admin/enterprise-management/accessing-the-monitor-dashboard.md b/content/admin/enterprise-management/accessing-the-monitor-dashboard.md
index 5b8abed66cc8..a83ec1d35979 100644
--- a/content/admin/enterprise-management/accessing-the-monitor-dashboard.md
+++ b/content/admin/enterprise-management/accessing-the-monitor-dashboard.md
@@ -19,7 +19,7 @@ versions:
{% note %}
-**Note**: Because regularly polling {% data variables.product.product_location_enterprise %} with continuous integration (CI) or build servers can effectively cause a denial of service attack that results in problems, we recommend using webhooks to push updates. For more information, see "[About webhooks](/enterprise/{{ currentVersion }}/user/articles/about-webhooks/)".
+**Note**: Because regularly polling {% data variables.product.product_location %} with continuous integration (CI) or build servers can effectively cause a denial of service attack that results in problems, we recommend using webhooks to push updates. For more information, see "[About webhooks](/enterprise/{{ currentVersion }}/user/articles/about-webhooks/)".
{% endnote %}
diff --git a/content/admin/enterprise-management/configuring-collectd.md b/content/admin/enterprise-management/configuring-collectd.md
index 9d1ae627f673..0482ad809a41 100644
--- a/content/admin/enterprise-management/configuring-collectd.md
+++ b/content/admin/enterprise-management/configuring-collectd.md
@@ -10,7 +10,7 @@ versions:
---
### Set up an external `collectd` server
-If you haven't already set up an external `collectd` server, you will need to do so before enabling `collectd` forwarding on {% data variables.product.product_location_enterprise %}. Your `collectd` server must by running `collectd` version 5.x or higher.
+If you haven't already set up an external `collectd` server, you will need to do so before enabling `collectd` forwarding on {% data variables.product.product_location %}. Your `collectd` server must by running `collectd` version 5.x or higher.
1. Log into your `collectd` server.
2. Create or edit the `collectd` configuration file to load the network plugin and populate the server and port directives with the proper values. On most distributions, this is located at `/etc/collectd/collectd.conf`
@@ -52,6 +52,6 @@ ssh -p 122 admin@[hostname] -- 'ghe-export-graphs' && scp -P 122 admin@[hostname
#### Central collectd server receives no data
-{% data variables.product.prodname_enterprise %} ships with `collectd` version 5.x. `collectd` 5.x is not backwards compatible with the 4.x release series. Your central `collectd` server needs to be at least version 5.x to accept data sent from {% data variables.product.product_location_enterprise %}.
+{% data variables.product.prodname_enterprise %} ships with `collectd` version 5.x. `collectd` 5.x is not backwards compatible with the 4.x release series. Your central `collectd` server needs to be at least version 5.x to accept data sent from {% data variables.product.product_location %}.
For help with further questions or issues, contact {% data variables.contact.contact_ent_support %}.
diff --git a/content/admin/enterprise-management/enabling-automatic-update-checks.md b/content/admin/enterprise-management/enabling-automatic-update-checks.md
index 60d8e948656f..07f741e1bc61 100644
--- a/content/admin/enterprise-management/enabling-automatic-update-checks.md
+++ b/content/admin/enterprise-management/enabling-automatic-update-checks.md
@@ -1,6 +1,6 @@
---
title: Enabling automatic update checks
-intro: 'You can enable automatic update checks so that {% data variables.product.product_location_enterprise %} checks for and downloads the latest {% data variables.product.prodname_ghe_server %} release.'
+intro: 'You can enable automatic update checks so that {% data variables.product.product_location %} checks for and downloads the latest {% data variables.product.prodname_ghe_server %} release.'
redirect_from:
- /enterprise/admin/installation/enabling-automatic-update-checks
- /enterprise/admin/enterprise-management/enabling-automatic-update-checks
@@ -8,13 +8,13 @@ versions:
enterprise-server: '*'
---
-When an upgrade package is automatically downloaded for {% data variables.product.product_location_enterprise %}, you'll receive a message letting you know you can upgrade {% data variables.product.prodname_ghe_server %}. Packages download to the `/var/lib/ghe-updates` directory on {% data variables.product.product_location_enterprise %}. For more information, see "[Upgrading {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/guides/installation/upgrading-github-enterprise-server)."
+When an upgrade package is automatically downloaded for {% data variables.product.product_location %}, you'll receive a message letting you know you can upgrade {% data variables.product.prodname_ghe_server %}. Packages download to the `/var/lib/ghe-updates` directory on {% data variables.product.product_location %}. For more information, see "[Upgrading {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/guides/installation/upgrading-github-enterprise-server)."
If a hotpatch is available for an upgrade, the `.hpkg` will download automatically. In the management console you can choose to install the hotpatch immediately or schedule installation for a later time. For more information, see "[Upgrading with a hotpatch](/enterprise/{{ currentVersion }}/admin/guides/installation/upgrading-github-enterprise-server#upgrading-with-a-hotpatch)."
{% tip %}
-**Tip:** To enable automatic update checks, {% data variables.product.product_location_enterprise %} must be able to connect to `https://github-enterprise.s3.amazonaws.com`.
+**Tip:** To enable automatic update checks, {% data variables.product.product_location %} must be able to connect to `https://github-enterprise.s3.amazonaws.com`.
{% endtip %}
diff --git a/content/admin/enterprise-management/increasing-cpu-or-memory-resources.md b/content/admin/enterprise-management/increasing-cpu-or-memory-resources.md
index 5ac497071d6d..70ad38778a38 100644
--- a/content/admin/enterprise-management/increasing-cpu-or-memory-resources.md
+++ b/content/admin/enterprise-management/increasing-cpu-or-memory-resources.md
@@ -20,7 +20,7 @@ versions:
#### Resizing considerations
-Before increasing CPU or memory resources for {% data variables.product.product_location_enterprise %}, review the following recommendations.
+Before increasing CPU or memory resources for {% data variables.product.product_location %}, review the following recommendations.
- **Scale your memory with CPUs**. {% data reusables.enterprise_installation.increasing-cpus-req %}
- **Assign an Elastic IP address to the instance**. If you haven't assigned an Elastic IP to your instance, you'll have to adjust the DNS A records for your {% data variables.product.prodname_ghe_server %} host after the restart to account for the change in public IP address. Once your instance restarts, the instance keeps the Elastic IP if you launched the instance in a virtual private cloud (VPC). If you create the instance in an EC2-Classic network, you must manually reassign the Elastic IP to the instance.
@@ -64,7 +64,7 @@ It's not possible to add CPU or memory resources to an existing OpenStack KVM in
{% data reusables.enterprise_installation.increasing-cpus-req %}
1. Use the vSphere Client to connect to the VMware ESXi host.
-2. Shut down {% data variables.product.product_location_enterprise %}.
+2. Shut down {% data variables.product.product_location %}.
3. Select the virtual machine and click **Edit Settings**.
4. Under "Hardware", adjust the CPU and/or memory resources allocated to the virtual machine as needed:
diff --git a/content/admin/enterprise-management/increasing-storage-capacity.md b/content/admin/enterprise-management/increasing-storage-capacity.md
index ece10c6a71a9..bb41f8c6021a 100644
--- a/content/admin/enterprise-management/increasing-storage-capacity.md
+++ b/content/admin/enterprise-management/increasing-storage-capacity.md
@@ -10,7 +10,7 @@ versions:
{% data reusables.enterprise_installation.warning-on-upgrading-physical-resources %}
-As more users join {% data variables.product.product_location_enterprise %}, you may need to resize your storage volume. Refer to the documentation for your virtualization platform for information on resizing storage.
+As more users join {% data variables.product.product_location %}, you may need to resize your storage volume. Refer to the documentation for your virtualization platform for information on resizing storage.
### Requirements and recommendations
diff --git a/content/admin/enterprise-management/index.md b/content/admin/enterprise-management/index.md
index d53041ef94fe..0736f9e81df5 100644
--- a/content/admin/enterprise-management/index.md
+++ b/content/admin/enterprise-management/index.md
@@ -15,7 +15,6 @@ versions:
{% link_in_list /recommended-alert-thresholds %}
{% link_in_list /setting-up-external-monitoring %}
{% link_in_list /configuring-collectd %}
- {% link_in_list /log-forwarding %}
{% link_in_list /monitoring-using-snmp %}
{% topic_link_in_list /updating-the-virtual-machine-and-physical-resources %}
{% link_in_list /upgrade-requirements %}
diff --git a/content/admin/enterprise-management/initiating-a-failover-to-your-replica-appliance.md b/content/admin/enterprise-management/initiating-a-failover-to-your-replica-appliance.md
index 5205e4961763..de93a1dba3d7 100644
--- a/content/admin/enterprise-management/initiating-a-failover-to-your-replica-appliance.md
+++ b/content/admin/enterprise-management/initiating-a-failover-to-your-replica-appliance.md
@@ -30,6 +30,15 @@ The time required to failover depends on how long it takes to manually promote t
5. Update the DNS record to point to the IP address of the replica. Traffic is directed to the replica after the TTL period elapses. If you are using a load balancer, ensure it is configured to send traffic to the replica.
6. Notify users that they can resume normal operations.
7. If desired, set up replication from the new primary to existing appliances and the previous primary. For more information, see "[About high availability configuration](/enterprise/{{ currentVersion }}/admin/guides/installation/about-high-availability-configuration/#utilities-for-replication-management)."
+8. Appliances you do not intend to setup replication to that were part of the high availability configuration prior the failover, need to be removed from the high availability configuration by UUID.
+ - On the former appliances, get their UUID via `cat /data/user/common/uuid`.
+ ```shell
+ $ cat /data/user/common/uuid
+ ```
+ - On the new primary, remove the UUIDs using `ghe-repl-teardown`. Please replace *`UUID`* with a UUID you retrieved in the previous step.
+ ```shell
+ $ ghe-repl-teardown -u UUNID
+ ```
### Further reading
diff --git a/content/admin/enterprise-management/log-forwarding.md b/content/admin/enterprise-management/log-forwarding.md
deleted file mode 100644
index d13cf9c440d3..000000000000
--- a/content/admin/enterprise-management/log-forwarding.md
+++ /dev/null
@@ -1,24 +0,0 @@
----
-title: Log forwarding
-intro: '{% data variables.product.prodname_enterprise %} uses `syslog-ng` to forward system and application logs to the server you specify in the {% data variables.enterprise.management_console %} settings.'
-redirect_from:
- - /enterprise/admin/articles/log-forwarding/
- - /enterprise/admin/installation/log-forwarding
- - /enterprise/admin/enterprise-management/log-forwarding
-versions:
- enterprise-server: '*'
----
-Any log collection system that supports syslog-style log streams is supported (e.g., [Logstash](http://logstash.net/) and [Splunk](http://docs.splunk.com/Documentation/Splunk/latest/Data/Monitornetworkports)).
-
-### Enabling log forwarding
-
-1. On the {% data variables.enterprise.management_console %} settings page, in the left sidebar, click **Monitoring**.
-1. Select **Enable log forwarding**.
-1. In the **Server address** field, type the address of the server to which you want to forward logs. You can specify multiple addresses in a comma-separated list.
-1. In the Protocol drop-down menu, select the protocol to use to communicate with the log server. The protocol will apply to all specified log destinations.
-1. Select **Enable TLS**.
-1. Click **Choose File** and choose a CA certificate to encrypt communication between syslog endpoints. The entire certificate chain will be validated, and must terminate in a root certificate. For more information, see [TLS options in the syslog-ng documentation](https://support.oneidentity.com/technical-documents/syslog-ng-open-source-edition/3.16/administration-guide/56#TOPIC-956599).
-
-### Troubleshooting
-
-If you run into issues with log forwarding, contact {% data variables.contact.contact_ent_support %} and attach the output file from `http(s)://[hostname]/setup/diagnostics` to your email.
diff --git a/content/admin/enterprise-management/monitoring-cluster-nodes.md b/content/admin/enterprise-management/monitoring-cluster-nodes.md
index 6d6c8ba3409d..da5fcdd1c91b 100644
--- a/content/admin/enterprise-management/monitoring-cluster-nodes.md
+++ b/content/admin/enterprise-management/monitoring-cluster-nodes.md
@@ -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:~$ ssh-keygen -t rsa -b 4096
- > Generating public/private rsa key pair.
- > Enter file in which to save the key (/home/nagiosuser/.ssh/id_rsa):
+ nagiosuser@nagios:~$ ssh-keygen -t ed25519
+ > 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): leave blank by pressing enter
> Enter same passphrase again: press enter again
- > 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:~$ ssh-keygen -t rsa -b 4096
+ ```
+
+ {% endnote %}
+2. Copy the private key (`id_ed25519`) to the `nagios` home folder and set the appropriate ownership.
```shell
- nagiosuser@nagios:~$ sudo cp .ssh/id_rsa /var/lib/nagios/.ssh/
- nagiosuser@nagios:~$ sudo chown nagios:nagios /var/lib/nagios/.ssh/id_rsa
+ nagiosuser@nagios:~$ sudo cp .ssh/id_ed25519 /var/lib/nagios/.ssh/
+ nagiosuser@nagios:~$ sudo chown nagios:nagios /var/lib/nagios/.ssh/id_ed25519
```
-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....`
+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.
diff --git a/content/admin/enterprise-management/monitoring-using-snmp.md b/content/admin/enterprise-management/monitoring-using-snmp.md
index 6396c92822e5..8038a64e4675 100644
--- a/content/admin/enterprise-management/monitoring-using-snmp.md
+++ b/content/admin/enterprise-management/monitoring-using-snmp.md
@@ -9,7 +9,7 @@ versions:
enterprise-server: '*'
---
-SNMP is a common standard for monitoring devices over a network. We strongly recommend enabling SNMP so you can monitor the health of {% data variables.product.product_location_enterprise %} and know when to add more memory, storage, or processor power to the host machine.
+SNMP is a common standard for monitoring devices over a network. We strongly recommend enabling SNMP so you can monitor the health of {% data variables.product.product_location %} and know when to add more memory, storage, or processor power to the host machine.
{% data variables.product.prodname_enterprise %} has a standard SNMP installation, so you can take advantage of the [many plugins](http://www.monitoring-plugins.org/doc/man/check_snmp.html) available for Nagios or for any other monitoring system.
@@ -29,7 +29,7 @@ SNMP is a common standard for monitoring devices over a network. We strongly rec
$ snmpget -v 2c -c community-string -O e hostname hrSystemDate.0
```
-This should return the system time on {% data variables.product.product_location_enterprise %} host.
+This should return the system time on {% data variables.product.product_location %} host.
### User-based security
diff --git a/content/admin/enterprise-management/monitoring-your-appliance.md b/content/admin/enterprise-management/monitoring-your-appliance.md
index 4e995c9f6266..e8adac6a1100 100644
--- a/content/admin/enterprise-management/monitoring-your-appliance.md
+++ b/content/admin/enterprise-management/monitoring-your-appliance.md
@@ -1,6 +1,6 @@
---
title: Monitoring your appliance
-intro: 'As use of {% data variables.product.product_location_enterprise %} increases over time, the utilization of system resources, like CPU, memory, and storage will also increase. You can configure monitoring and alerting so that you''re aware of potential issues before they become critical enough to negatively impact application performance or availability.'
+intro: 'As use of {% data variables.product.product_location %} increases over time, the utilization of system resources, like CPU, memory, and storage will also increase. You can configure monitoring and alerting so that you''re aware of potential issues before they become critical enough to negatively impact application performance or availability.'
redirect_from:
- /enterprise/admin/guides/installation/system-resource-monitoring-and-alerting/
- /enterprise/admin/guides/installation/monitoring-your-github-enterprise-appliance/
diff --git a/content/admin/enterprise-management/recommended-alert-thresholds.md b/content/admin/enterprise-management/recommended-alert-thresholds.md
index 126d253fde6d..ceae6ab760aa 100644
--- a/content/admin/enterprise-management/recommended-alert-thresholds.md
+++ b/content/admin/enterprise-management/recommended-alert-thresholds.md
@@ -34,7 +34,7 @@ We also recommend that you monitor virtualization "steal" time to ensure that ot
### Monitoring memory usage
-The amount of physical memory allocated to {% data variables.product.product_location_enterprise %} can have a large impact on overall performance and application responsiveness. The system is designed to make heavy use of the kernel disk cache to speed up Git operations. We recommend that the normal RSS working set fit within 50% of total available RAM at peak usage.
+The amount of physical memory allocated to {% data variables.product.product_location %} can have a large impact on overall performance and application responsiveness. The system is designed to make heavy use of the kernel disk cache to speed up Git operations. We recommend that the normal RSS working set fit within 50% of total available RAM at peak usage.
| Severity | Threshold |
| -------- | --------- |
diff --git a/content/admin/enterprise-management/upgrade-requirements.md b/content/admin/enterprise-management/upgrade-requirements.md
index 6506fdf49084..9354cab5263c 100644
--- a/content/admin/enterprise-management/upgrade-requirements.md
+++ b/content/admin/enterprise-management/upgrade-requirements.md
@@ -22,7 +22,7 @@ versions:
### Recommendations
- Include as few upgrades as possible in your upgrade process. For example, instead of upgrading from {% data variables.product.prodname_enterprise %} {{ enterpriseServerReleases.supported[2] }} to {{ enterpriseServerReleases.supported[1] }} to {{ enterpriseServerReleases.latest }}, you could upgrade from {% data variables.product.prodname_enterprise %} {{ enterpriseServerReleases.supported[2] }} to {{ enterpriseServerReleases.latest }}.
-- If you’re several versions behind, upgrade {% data variables.product.product_location_enterprise %} as far forward as possible with each step of your upgrade process. Using the latest version possible on each upgrade allows you to take advantage of performance improvements and bug fixes. For example, you could upgrade from {% data variables.product.prodname_enterprise %} 2.7 to 2.8 to 2.10, but upgrading from {% data variables.product.prodname_enterprise %} 2.7 to 2.9 to 2.10 uses a later version in the second step.
+- If you’re several versions behind, upgrade {% data variables.product.product_location %} as far forward as possible with each step of your upgrade process. Using the latest version possible on each upgrade allows you to take advantage of performance improvements and bug fixes. For example, you could upgrade from {% data variables.product.prodname_enterprise %} 2.7 to 2.8 to 2.10, but upgrading from {% data variables.product.prodname_enterprise %} 2.7 to 2.9 to 2.10 uses a later version in the second step.
- Use the latest patch release when upgrading. {% data reusables.enterprise_installation.enterprise-download-upgrade-pkg %}
- Use a staging instance to test the upgrade steps. For more information, see "[Setting up a staging instance](/enterprise/{{ currentVersion }}/admin/guides/installation/setting-up-a-staging-instance/)."
- When running multiple upgrades, wait at least 24 hours between feature upgrades to allow data migrations and backgrounded upgrade tasks to fully complete.
diff --git a/content/admin/enterprise-management/upgrading-github-enterprise-server.md b/content/admin/enterprise-management/upgrading-github-enterprise-server.md
index dc177b77e40f..e1bedb0e8b76 100644
--- a/content/admin/enterprise-management/upgrading-github-enterprise-server.md
+++ b/content/admin/enterprise-management/upgrading-github-enterprise-server.md
@@ -49,7 +49,7 @@ There are two types of snapshots:
| Platform | Snapshot method | Snapshot documentation URL |
|---|---|---|
| Amazon AWS | Disk |
-| Azure | VM |
| Hyper-V | VM |
| Google Compute Engine | Disk |
| VMware | VM |
@@ -152,7 +152,7 @@ While you can use a hotpatch to upgrade to the latest patch release within a fea
Target root partition: /dev/xvda2
Proceed with installation? [y/N]
```
-7. For single appliance upgrades, disable maintenance mode so users can use {% data variables.product.product_location_enterprise %}.
+7. For single appliance upgrades, disable maintenance mode so users can use {% data variables.product.product_location %}.
{% note %}
@@ -205,7 +205,7 @@ Appliances configured for high-availability and geo-replication use replica inst
1. On the replica instance, run `ghe-repl-setup ` again.
{% data reusables.enterprise_installation.start-replication %}
{% data reusables.enterprise_installation.replication-status %}
-6. When you have completed upgrading the last replica, and the resync is complete, disable maintenance mode so users can use {% data variables.product.product_location_enterprise %}.
+6. When you have completed upgrading the last replica, and the resync is complete, disable maintenance mode so users can use {% data variables.product.product_location %}.
### Restoring from a failed upgrade
diff --git a/content/admin/enterprise-support/about-github-enterprise-support.md b/content/admin/enterprise-support/about-github-enterprise-support.md
index 03244ed720a0..7cad3af57fb0 100644
--- a/content/admin/enterprise-support/about-github-enterprise-support.md
+++ b/content/admin/enterprise-support/about-github-enterprise-support.md
@@ -1,10 +1,11 @@
---
title: About GitHub Enterprise Support
-intro: '{% data variables.product.prodname_ghe_server %} Support can help you troubleshoot issues that arise on your {% data variables.product.prodname_ghe_server %} appliance.'
+intro: '{% data variables.contact.github_support %} can help you troubleshoot issues that arise on {% data variables.product.product_name %}.'
redirect_from:
- /enterprise/admin/enterprise-support/about-github-enterprise-support
versions:
enterprise-server: '*'
+ github-ae: '*'
---
{% note %}
@@ -15,49 +16,69 @@ versions:
### About {% data variables.contact.enterprise_support %}
-{% data variables.product.prodname_ghe_server %} includes {% data variables.contact.enterprise_support %} in English and Japanese.
+{% data variables.product.product_name %} includes {% data variables.contact.enterprise_support %} in English{% if enterpriseServerVersions contains currentVersion %}and Japanese{% endif %}.
-You can contact {% data variables.contact.enterprise_support %} through our support portal for help with:
- - Installing and using {% data variables.product.prodname_ghe_server %}
+{% if enterpriseServerVersions contains currentVersion %}
+You can contact {% data variables.contact.enterprise_support %} through {% data variables.contact.contact_enterprise_portal %} for help with:
+ - Installing and using {% data variables.product.product_name %}
- Identifying and verifying the causes of suspected errors
+{% endif %}
-In addition to all of the benefits of {% data variables.contact.enterprise_support %}, {% data variables.contact.premium_support %} offers:
+In addition to all of the benefits of {% data variables.contact.enterprise_support %}, {% if enterpriseServerVersions contains currentVersion %}{% data variables.contact.premium_support %}{% else %}support for {% data variables.product.product_name %}{% endif %} offers:
- Written support through our support portal 24 hours per day, 7 days per week
- Phone support 24 hours per day, 7 days per week
- - A Service Level Agreement (SLA) with guaranteed initial response times
+ - A{% if currentVersion == "github-ae@latest" %}n enhanced{% endif %} Service Level Agreement (SLA) {% if enterpriseServerVersions contains currentVersion %}with guaranteed initial response times{% endif %}
+{% if currentVersion == "github-ae@latest" %}
+ - An assigned Technical Service Account Manager
+ - Quarterly support reviews
+ - Managed Admin services
+{% else if enterpriseServerVersions contains currentVersion %}
+ - Technical account managers
- Access to premium content
- Scheduled health checks
- - Managed services
+ - Managed Admin hours
+{% endif %}
+{% data reusables.support.government-response-times-may-vary %}
+
+{% if enterpriseServerVersions contains currentVersion %}
For more information, see "[About {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_server %}](/enterprise/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server)."
+{% endif %}
{% data reusables.support.scope-of-support %}
### Contacting {% data variables.contact.enterprise_support %}
-{% data variables.contact.enterprise_support %} customers can use the {% data variables.contact.contact_enterprise_portal %} to report issues in writing.
+You can contact {% data variables.contact.enterprise_support %} through {% if enterpriseServerVersions contains currentVersion %}{% data variables.contact.contact_enterprise_portal %}{% elsif currentVersion == "github-ae@latest" %} the {% data variables.contact.ae_azure_portal %}{% endif %} to report issues in writing. For more information, see "[Receiving help from {% data variables.contact.github_support %}](/admin/enterprise-support/receiving-help-from-github-support)."
### Hours of operation
+{% if enterpriseServerVersions contains currentVersion %}
#### Support in English
+{% endif %}
+{% if enterpriseServerVersions contains currentVersion %}
For standard non-urgent issues, we offer support in English 24 hours per day, 5 days per week, excluding weekends and national U.S. holidays. The standard response time is 24 hours.
-For urgent issues, we are available 24 hours per day, 7 days per week, even during national U.S. holidays.
+For urgent issues, we {% else %}We{% endif %} are available 24 hours per day, 7 days per week, even during national U.S. holidays.
+
+{% data reusables.support.government-response-times-may-vary %}
+{% if enterpriseServerVersions contains currentVersion %}
#### Support in Japanese
For non-urgent issues, support in Japanese is available Monday through Friday from 9:00 AM to 5:00 PM JST, excluding national holidays in Japan. For urgent issues, we offer support in English 24 hours per day, 7 days per week, even during national U.S. holidays.
-For a complete list of U.S. and Japanese national holidays observed by {% data variables.contact.enterprise_support %}, see "[Holiday schedules](#holiday-schedules)."
+For a complete list of U.S. and Japanese national holidays observed by {% data variables.contact.enterprise_support %}, see "[Holiday schedules](#holiday-schedules)."{% endif %}
+{% if enterpriseServerVersions contains currentVersion %}
### Holiday schedules
-For urgent issues, we can help you in English 24 hours per day, 7 days per week, including on U.S. and Japanese holidays.
+For urgent issues, we can help you in English 24 hours per day, 7 days per week, including on U.S. {% if enterpriseServerVersions contains currentVersion %}and Japanese{% endif %} holidays.
#### Holidays in the United States
-{% data variables.contact.enterprise_support %} observes these U.S. holidays, although our global support team is available to answer urgent tickets.
+{% data variables.contact.enterprise_support %} observes these U.S. holidays{% if enterpriseServerVersions contains currentVersion %}, although our global support team is available to answer urgent tickets{% endif %}.
| U.S. holiday | Date observed |
| --- | --- |
@@ -80,6 +101,7 @@ For urgent issues, we can help you in English 24 hours per day, 7 days per week,
{% data variables.contact.enterprise_support %} does not provide Japanese-language support on December 28th through January 3rd as well as on the holidays listed in [国民の祝日について - 内閣府](https://www8.cao.go.jp/chosei/shukujitsu/gaiyou.html).
{% data reusables.enterprise_enterprise_support.installing-releases %}
+{% endif %}
### Assigning a priority to a support ticket
@@ -87,7 +109,11 @@ When you contact {% data variables.contact.enterprise_support %}, you can choose
{% data reusables.support.github-can-modify-ticket-priority %}
+{% if enterpriseServerVersions contains currentVersion %}
{% data reusables.support.ghes-priorities %}
+{% elsif currentVersion == "github-ae@latest" %}
+{% data reusables.support.ghae-priorities %}
+{% endif %}
### Resolving and closing support tickets
@@ -95,8 +121,9 @@ When you contact {% data variables.contact.enterprise_support %}, you can choose
### Further reading
+{% if enterpriseServerVersions contains currentVersion %}
- [Frequently asked questions about {% data variables.product.prodname_ghe_server %}](https://enterprise.github.com/faq)
-- Section 10 on Support in the "[{% data variables.product.prodname_ghe_server %} License Agreement](https://enterprise.github.com/license)"
-- "[Reaching {% data variables.contact.github_support %}](/enterprise/admin/guides/enterprise-support/reaching-github-support)"
-- "[Preparing to submit a ticket](/enterprise/admin/guides/enterprise-support/preparing-to-submit-a-ticket)"
+- Section 10 on Support in the "[{% data variables.product.prodname_ghe_server %} License Agreement](https://enterprise.github.com/license)"{% endif %}
+- "[Receiving help from {% data variables.contact.github_support %}](/admin/enterprise-support/receiving-help-from-github-support)"{% if enterpriseServerVersions contains currentVersion %}
+- "[Preparing to submit a ticket](/enterprise/admin/guides/enterprise-support/preparing-to-submit-a-ticket)"{% endif %}
- "[Submitting a ticket](/enterprise/admin/guides/enterprise-support/submitting-a-ticket)"
diff --git a/content/admin/enterprise-support/index.md b/content/admin/enterprise-support/index.md
index a66aab840af2..d6f1ed919145 100644
--- a/content/admin/enterprise-support/index.md
+++ b/content/admin/enterprise-support/index.md
@@ -5,6 +5,7 @@ redirect_from:
- /enterprise/admin/enterprise-support
versions:
enterprise-server: '*'
+ github-ae: '*'
---
### Table of Contents
diff --git a/content/admin/enterprise-support/overview.md b/content/admin/enterprise-support/overview.md
index 0506a1678dda..67f3ad9d93fd 100644
--- a/content/admin/enterprise-support/overview.md
+++ b/content/admin/enterprise-support/overview.md
@@ -1,10 +1,10 @@
---
title: Overview
-intro: 'Learn about the support options available for {% data variables.product.prodname_ghe_server %}.'
+intro: 'Learn about the support options available for {% data variables.product.product_name %}.'
mapTopic: true
redirect_from:
- /enterprise/admin/enterprise-support/overview
versions:
enterprise-server: '*'
+ github-ae: '*'
---
-
diff --git a/content/admin/enterprise-support/preparing-to-submit-a-ticket.md b/content/admin/enterprise-support/preparing-to-submit-a-ticket.md
index 6edfaf7b3325..9c70a25abf5e 100644
--- a/content/admin/enterprise-support/preparing-to-submit-a-ticket.md
+++ b/content/admin/enterprise-support/preparing-to-submit-a-ticket.md
@@ -1,10 +1,11 @@
---
title: Preparing to submit a ticket
-intro: 'Help {% data variables.contact.github_support %} help you faster by following these suggestions before you open a support ticket.'
+intro: 'You can expedite your issue with {% data variables.contact.enterprise_support %} by following these suggestions before you open a support ticket.'
redirect_from:
- /enterprise/admin/enterprise-support/preparing-to-submit-a-ticket
versions:
enterprise-server: '*'
+ github-ae: '*'
---
Before submitting a ticket, you should:
@@ -16,13 +17,11 @@ Before submitting a ticket, you should:
- Determine if there is an existing ticket number in any ongoing communications with {% data variables.contact.github_support %}.
- Determine the best person to contact {% data variables.contact.github_support %}.
-For more information, see "[Submitting a ticket](/enterprise/admin/guides/enterprise-support/submitting-a-ticket)."
-
### Choosing a contact person
Especially for tickets with {% data variables.product.support_ticket_priority_urgent %} priority, the person contacting {% data variables.contact.github_support %} should:
- Be knowledgeable in your internal systems, tools, policies, and practices.
- - Be a proficient user of {% data variables.product.prodname_ghe_server %}.
+ - Be a proficient user of {% data variables.product.product_name %}.
- Have full access and permissions to any services that are required to troubleshoot the issue.
- - Be authorized to make the recommended changes to your network and any applicable products.
+ - Be authorized to make the recommended changes to your network and any applicable products.
\ No newline at end of file
diff --git a/content/admin/enterprise-support/providing-data-to-github-support.md b/content/admin/enterprise-support/providing-data-to-github-support.md
index 40ee088060b1..a063f6e288c6 100644
--- a/content/admin/enterprise-support/providing-data-to-github-support.md
+++ b/content/admin/enterprise-support/providing-data-to-github-support.md
@@ -85,7 +85,7 @@ You can use these steps to create and share a support bundle if you can access t
#### Creating a support bundle using SSH
-You can use these steps to create and share a support bundle if you have SSH access to your {% data variables.product.prodname_ghe_server %} appliance and have outbound internet access.
+You can use these steps to create and share a support bundle if you have SSH access to {% data variables.product.product_location %} and have outbound internet access.
{% data reusables.enterprise_enterprise_support.use_ghe_cluster_support_bundle %}
@@ -114,8 +114,8 @@ You can use these steps to create and share a support bundle if you have SSH acc
#### Uploading a support bundle directly using SSH
You can directly upload a support bundle to our server if:
-- You have SSH access to your {% data variables.product.prodname_ghe_server %} appliance.
-- Outbound HTTPS connections over TCP port 443 are allowed from your {% data variables.product.prodname_ghe_server %} appliance.
+- You have SSH access to {% data variables.product.product_location %}.
+- Outbound HTTPS connections over TCP port 443 are allowed from {% data variables.product.product_location %}.
1. Upload the bundle to our support bundle server:
```shell
@@ -130,7 +130,7 @@ To prevent bundles from becoming too large, bundles only contain logs that haven
#### Creating an extended support bundle using SSH
-You can use these steps to create and share an extended support bundle if you have SSH access to your {% data variables.product.prodname_ghe_server %} appliance and you have outbound internet access.
+You can use these steps to create and share an extended support bundle if you have SSH access to {% data variables.product.product_location %} and you have outbound internet access.
1. Download the extended support bundle via SSH by adding the `-x` flag to the `ghe-support-bundle` command:
```shell
@@ -142,8 +142,8 @@ You can use these steps to create and share an extended support bundle if you ha
#### Uploading an extended support bundle directly using SSH
You can directly upload a support bundle to our server if:
-- You have SSH access to your {% data variables.product.prodname_ghe_server %} appliance.
-- Outbound HTTPS connections over TCP port 443 are allowed from your {% data variables.product.prodname_ghe_server %} appliance.
+- You have SSH access to {% data variables.product.product_location %}.
+- Outbound HTTPS connections over TCP port 443 are allowed from {% data variables.product.product_location %}.
1. Upload the bundle to our support bundle server:
```shell
diff --git a/content/admin/enterprise-support/reaching-github-support.md b/content/admin/enterprise-support/reaching-github-support.md
index ead3b6aa3ed5..7cf256ce5605 100644
--- a/content/admin/enterprise-support/reaching-github-support.md
+++ b/content/admin/enterprise-support/reaching-github-support.md
@@ -1,6 +1,6 @@
---
title: Reaching GitHub Support
-intro: 'Contact {% data variables.contact.github_support %} using the {% data variables.product.prodname_ghe_server %} {% data variables.enterprise.management_console %} or the support portal.'
+intro: 'Contact {% data variables.contact.enterprise_support %} using the {% if enterpriseServerVersions contains currentVersion %}{% data variables.product.prodname_ghe_server %} {% data variables.enterprise.management_console %} or{% endif %} the support portal.'
redirect_from:
- /enterprise/admin/guides/enterprise-support/reaching-github-enterprise-support/
- /enterprise/admin/enterprise-support/reaching-github-support
@@ -10,12 +10,15 @@ versions:
### Using automated ticketing systems
-Though we'll do our best to respond to automated support requests, we typically need more information than an automated ticketing system can give us to solve your issue. Whenever possible, please initiate support requests from a person or machine that {% data variables.contact.github_support %} can interact with. For more information, see "[Preparing to submit a ticket](/enterprise/admin/guides/enterprise-support/preparing-to-submit-a-ticket)."
+Though we'll do our best to respond to automated support requests, we typically need more information than an automated ticketing system can give us to solve your issue. Whenever possible, please initiate support requests from a person or machine that {% data variables.contact.enterprise_support %} can interact with. For more information, see "[Preparing to submit a ticket](/enterprise/admin/guides/enterprise-support/preparing-to-submit-a-ticket)."
### Contacting {% data variables.contact.enterprise_support %}
-{% data variables.contact.enterprise_support %} customers can open a support ticket using the {% data variables.product.prodname_ghe_server %} {% data variables.enterprise.management_console %} or the {% data variables.contact.contact_enterprise_portal %}. Mark the ticket's priority as {% data variables.product.support_ticket_priority_urgent %}, {% data variables.product.support_ticket_priority_high %}, {% data variables.product.support_ticket_priority_normal %}, or {% data variables.product.support_ticket_priority_low %}. For more information, see "[Assigning a priority to a support ticket](/enterprise/admin/guides/enterprise-support/about-github-enterprise-support#assigning-a-priority-to-a-support-ticket)" and "[Submitting a ticket](/enterprise/admin/guides/enterprise-support/submitting-a-ticket)."
+{% data variables.contact.enterprise_support %} customers can open a support ticket using the {% if enterpriseServerVersions contains currentVersion %}{% data variables.product.prodname_ghe_server %} {% data variables.enterprise.management_console %} or the {% data variables.contact.contact_enterprise_portal %}{% elsif currentVersion == "github-ae@latest" %} the {% data variables.contact.contact_ae_portal %}{% endif %}. Mark the ticket's priority as {% data variables.product.support_ticket_priority_urgent %}, {% data variables.product.support_ticket_priority_high %}, {% data variables.product.support_ticket_priority_normal %}, or {% data variables.product.support_ticket_priority_low %}. For more information, see "[Assigning a priority to a support ticket](/enterprise/admin/guides/enterprise-support/about-github-enterprise-support#assigning-a-priority-to-a-support-ticket)" and "[Submitting a ticket](/enterprise/admin/guides/enterprise-support/submitting-a-ticket)."
+### Contacting {% data variables.contact.enterprise_support %}
+
+{% if enterpriseServerVersions contains currentVersion %}
#### Viewing past support tickets
You can use the {% data variables.contact.enterprise_portal %} to view past support tickets.
@@ -28,10 +31,12 @@ You can use the {% data variables.contact.enterprise_portal %} to view past supp
{% data variables.contact.enterprise_support %} customers can open a support ticket using the {% data variables.product.prodname_ghe_server %} {% data variables.enterprise.management_console %} or the {% data variables.contact.contact_enterprise_portal %}. Mark its priority as {% data variables.product.support_ticket_priority_urgent %}, {% data variables.product.support_ticket_priority_high %}, {% data variables.product.support_ticket_priority_normal %}, or {% data variables.product.support_ticket_priority_low %}. For more information, see "[Assigning a priority to a support ticket](/enterprise/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server#assigning-a-priority-to-a-support-ticket)" and "[Submitting a ticket](/enterprise/admin/guides/enterprise-support/submitting-a-ticket)."
+{% endif %}
### Contacting sales
For pricing, licensing, renewals, quotes, payments, and other related questions, contact {% data variables.contact.contact_enterprise_sales %} or call [+1 (877) 448-4820](tel:+1-877-448-4820).
+{% if enterpriseServerVersions contains currentVersion %}
### Contacting training
To learn more about training options, including customized trainings, see [{% data variables.product.company_short %}'s training site](https://services.github.com/).
@@ -41,6 +46,7 @@ To learn more about training options, including customized trainings, see [{% da
**Note:** Training is included in the {% data variables.product.premium_plus_support_plan %}. For more information, see "[About {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_server %}](/enterprise/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server)."
{% endnote %}
+{% endif %}
### Further reading
diff --git a/content/admin/enterprise-support/receiving-help-from-github-support.md b/content/admin/enterprise-support/receiving-help-from-github-support.md
index 37b9633376ad..98b3cd0eeaf2 100644
--- a/content/admin/enterprise-support/receiving-help-from-github-support.md
+++ b/content/admin/enterprise-support/receiving-help-from-github-support.md
@@ -1,11 +1,11 @@
---
title: Receiving help from GitHub Support
-intro: 'If you run into trouble with {% data variables.product.product_location_enterprise %}, {% data variables.contact.github_support %} can help you out.'
+intro: 'You can contact {% data variables.contact.enterprise_support %} to report a range of issues for your enterprise.'
redirect_from:
- /enterprise/admin/guides/enterprise-support/receiving-help-from-github-enterprise-support/
- /enterprise/admin/enterprise-support/receiving-help-from-github-support
mapTopic: true
versions:
enterprise-server: '*'
+ github-ae: '*'
---
-
diff --git a/content/admin/enterprise-support/submitting-a-ticket.md b/content/admin/enterprise-support/submitting-a-ticket.md
index 787b44889d73..056ebaddf06b 100644
--- a/content/admin/enterprise-support/submitting-a-ticket.md
+++ b/content/admin/enterprise-support/submitting-a-ticket.md
@@ -1,16 +1,18 @@
---
title: Submitting a ticket
-intro: 'Submit a support ticket using the {% data variables.product.prodname_ghe_server %} {% data variables.enterprise.management_console %} or the support portal. You can mark a ticket as urgent when your {% data variables.product.prodname_ghe_server %} production system is down or in an unusable state.'
+intro: 'You can submit a support ticket using the {% if enterpriseServerVersions contains currentVersion %}{% data variables.product.prodname_ghe_server %} {% data variables.enterprise.management_console %} or{% endif %} the support portal.'
redirect_from:
- /enterprise/admin/enterprise-support/submitting-a-ticket
versions:
enterprise-server: '*'
+ github-ae: '*'
---
### About submitting a ticket
Before submitting a ticket, you should gather helpful information for {% data variables.contact.github_support %} and choose a contact person. For more information, see "[Preparing to submit a ticket](/enterprise/admin/guides/enterprise-support/preparing-to-submit-a-ticket)."
+{% if enterpriseServerVersions contains currentVersion %}
After submitting your support request and optional diagnostic information, {% data variables.contact.github_support %} may ask you to download and share a support bundle with us. For more information, see "[Providing data to {% data variables.contact.github_support %}](/enterprise/admin/guides/enterprise-support/providing-data-to-github-support)."
### Submitting a ticket using the {% data variables.contact.enterprise_portal %}
@@ -34,7 +36,7 @@ After submitting your support request and optional diagnostic information, {% da
{% data reusables.enterprise_enterprise_support.submit-support-ticket-first-section %}
{% data reusables.enterprise_enterprise_support.submit-support-ticket-second-section %}
-### Submitting a ticket using the {% data variables.product.prodname_ghe_server %} {% data variables.enterprise.management_console %}
+### Submitting a ticket using the {% data variables.product.product_name %} {% data variables.enterprise.management_console %}
{% data reusables.enterprise_site_admin_settings.access-settings %}
{% data reusables.enterprise_site_admin_settings.management-console %}
@@ -52,7 +54,17 @@ After submitting your support request and optional diagnostic information, {% da
{% data reusables.enterprise_enterprise_support.submit-support-ticket-second-section %}
7. Click **Submit**.
+{% endif %}
+{% if currentVersion == "github-ae@latest" %}
+### Submitting a ticket using the {% data variables.contact.ae_azure_portal %}
+
+Commercial customers can submit a support request in the {% data variables.contact.contact_ae_portal %}. Government customers should use the [Azure portal for government customers](https://portal.azure.us/#blade/Microsoft_Azure_Support/HelpAndSupportBlade). For more information, see [Create an Azure support request](https://docs.microsoft.com/azure/azure-portal/supportability/how-to-create-azure-support-request) in the Microsoft documentation.
+
+For urgent issues, to ensure a quick response, after you submit a ticket, please call the support hotline immediately. Your Technical Support Account Manager (TSAM) will provide you with the number to use in your onboarding session.
+
+{% endif %}
+
### Further reading
-- "[About {% data variables.contact.enterprise_support %}](/enterprise/admin/guides/enterprise-support/about-github-enterprise-support)"
-- "[About {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_server %}](/enterprise/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server)."
+- "[About {% data variables.contact.enterprise_support %}](/enterprise/admin/guides/enterprise-support/about-github-enterprise-support)"{% if enterpriseServerVersions contains currentVersion %}
+- "[About {% data variables.contact.premium_support %} for {% data variables.product.prodname_ghe_server %}](/enterprise/admin/guides/enterprise-support/about-github-premium-support-for-github-enterprise-server)."{% endif %}
diff --git a/content/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect.md b/content/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect.md
index 32ec1f7d29f4..4cbe16224eee 100644
--- a/content/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect.md
+++ b/content/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect.md
@@ -19,8 +19,7 @@ To make all actions from {% data variables.product.prodname_dotcom_the_website %
Before enabling access to all actions from {% data variables.product.prodname_dotcom_the_website %} on {% data variables.product.product_location_enterprise %}, you must connect {% data variables.product.product_location_enterprise %} to {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[Connecting {% data variables.product.prodname_ghe_server %} to {% data variables.product.prodname_ghe_cloud %}](/enterprise/{{ currentVersion }}/admin/guides/installation/connecting-github-enterprise-server-to-github-enterprise-cloud)."
-{% data reusables.enterprise_site_admin_settings.access-settings %}
-{% data reusables.enterprise_site_admin_settings.business %}
+{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.github-connect-tab %}
1. Under "Server can use actions from GitHub.com in workflows runs", use the drop-down menu and select **Enabled**.
diff --git a/content/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise.md b/content/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise.md
index 0ad89a74ace7..37a543f94838 100644
--- a/content/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise.md
+++ b/content/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise.md
@@ -12,12 +12,11 @@ versions:
### About {% data variables.product.prodname_actions %} permissions for your enterprise
-When you enable {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %}, it is enabled for all organizations in your enterprise. You can choose to disable {% data variables.product.prodname_actions %} for all organizations in your enterprise, or only allow specific organizations. You can also limit the use of public actions, so that people can only use local actions that exist in an organization.
+When you enable {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %}, it is enabled for all organizations in your enterprise. You can choose to disable {% data variables.product.prodname_actions %} for all organizations in your enterprise, or only allow specific organizations. You can also limit the use of public actions, so that people can only use local actions that exist in your enterprise.
### Managing {% data variables.product.prodname_actions %} permissions for your enterprise
-{% data reusables.enterprise_site_admin_settings.access-settings %}
-{% data reusables.enterprise_site_admin_settings.business %}
+{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.policies-tab %}
{% data reusables.enterprise-accounts.actions-tab %}
{% data reusables.actions.enterprise-actions-permissions %}
@@ -29,8 +28,7 @@ When you enable {% data variables.product.prodname_actions %} on {% data variabl
#### Configuring the private fork policy for your enterprise
-{% data reusables.enterprise_site_admin_settings.access-settings %}
-{% data reusables.enterprise_site_admin_settings.business %}
+{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.policies-tab %}
{% data reusables.enterprise-accounts.actions-tab %}
{% data reusables.github-actions.private-repository-forks-configure %}
diff --git a/content/admin/github-actions/manually-syncing-actions-from-githubcom.md b/content/admin/github-actions/manually-syncing-actions-from-githubcom.md
index 50de2a1c5737..4002d2aff1d6 100644
--- a/content/admin/github-actions/manually-syncing-actions-from-githubcom.md
+++ b/content/admin/github-actions/manually-syncing-actions-from-githubcom.md
@@ -24,7 +24,7 @@ The `actions-sync` tool can only download actions from {% data variables.product
### Prerequisites
-* Before using the the `actions-sync` tool, you must ensure that all destination organizations already exist on your enterprise instance. The following example demonstrates how to sync actions to an organization named `synced-actions` on an enterprise instance. For more information, see "[Creating organizations](/enterprise/admin/user-management/creating-organizations)."
+* Before using the the `actions-sync` tool, you must ensure that all destination organizations already exist on your enterprise instance. The following example demonstrates how to sync actions to an organization named `synced-actions` on an enterprise instance. For more information, see "[Creating a new organization from scratch](/github/setting-up-and-managing-organizations-and-teams/creating-a-new-organization-from-scratch)."
* You must create a personal access token (PAT) on your enterprise instance that can create and write to repositories in the destination organizations. For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)."
### Example: Using the `actions-sync` tool
diff --git a/content/admin/github-actions/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access.md b/content/admin/github-actions/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access.md
index c51ee1e49215..2fce2abf54ea 100644
--- a/content/admin/github-actions/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access.md
+++ b/content/admin/github-actions/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access.md
@@ -34,7 +34,7 @@ You can populate the runner tool cache by running a {% data variables.product.pr
### Populating the tool cache for a self-hosted runner
-1. On {% data variables.product.prodname_dotcom_the_website %}, navigate to a repostory that you can use to run a {% data variables.product.prodname_actions %} workflow.
+1. On {% data variables.product.prodname_dotcom_the_website %}, navigate to a repository that you can use to run a {% data variables.product.prodname_actions %} workflow.
1. Create a new workflow file in the repository's `.github/workflows` folder that uploads an artifact containing the {% data variables.product.prodname_dotcom %}-hosted runner's tool cache.
The following example demonstrates a workflow that uploads the tool cache for an Ubuntu 18.04 environment, using the `setup-node` action with Node.js versions 10 and 12.
diff --git a/content/admin/index.md b/content/admin/index.md
index dfbcb7a9914d..14c3aca964de 100644
--- a/content/admin/index.md
+++ b/content/admin/index.md
@@ -3,9 +3,10 @@ title: Enterprise Administrators
redirect_from:
- /enterprise/admin/hidden/migrating-from-github-fi/
- /enterprise/admin
-intro: 'Step-by-step guides for organizational administrators, system administrators, and security specialists who are deploying, configuring, and managing a GitHub Enterprise instance.'
+intro: Documentation and guides for enterprise administrators, system administrators, and security specialists who {% if enterpriseServerVersions contains currentVersion %}deploy, {% endif %}configure{% if enterpriseServerVersions contains currentVersion %},{% endif %} and manage {% data variables.product.product_name %}.
versions:
enterprise-server: '*'
+ github-ae: '*'
---
{% link_with_intro /overview %}
diff --git a/content/admin/installation/installing-github-enterprise-server-on-aws.md b/content/admin/installation/installing-github-enterprise-server-on-aws.md
index 4666f942e737..f7dacdabc134 100644
--- a/content/admin/installation/installing-github-enterprise-server-on-aws.md
+++ b/content/admin/installation/installing-github-enterprise-server-on-aws.md
@@ -12,7 +12,7 @@ versions:
- {% data reusables.enterprise_installation.software-license %}
- You must have an AWS account capable of launching EC2 instances and creating EBS volumes. For more information, see the [Amazon Web Services website](https://aws.amazon.com/).
-- Most actions needed to launch {% data variables.product.product_location_enterprise %} may also be performed using the AWS management console. However, we recommend installing the AWS command line interface (CLI) for initial setup. Examples using the AWS CLI are included below. For more information, see Amazon's guides "[Working with the AWS Management Console](http://docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/getting-started.html)" and "[What is the AWS Command Line Interface](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html)."
+- Most actions needed to launch {% data variables.product.product_location %} may also be performed using the AWS management console. However, we recommend installing the AWS command line interface (CLI) for initial setup. Examples using the AWS CLI are included below. For more information, see Amazon's guides "[Working with the AWS Management Console](http://docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/getting-started.html)" and "[What is the AWS Command Line Interface](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html)."
This guide assumes you are familiar with the following AWS concepts:
@@ -28,7 +28,7 @@ This guide assumes you are familiar with the following AWS concepts:
### Determining the instance type
-Before launching {% data variables.product.product_location_enterprise %} on AWS, you'll need to determine the type of virtual machine that best fits the needs of your organization.
+Before launching {% data variables.product.product_location %} on AWS, you'll need to determine the type of virtual machine that best fits the needs of your organization.
#### Supported instance types
diff --git a/content/admin/installation/installing-github-enterprise-server-on-azure.md b/content/admin/installation/installing-github-enterprise-server-on-azure.md
index b6be4272329c..23e721683ce0 100644
--- a/content/admin/installation/installing-github-enterprise-server-on-azure.md
+++ b/content/admin/installation/installing-github-enterprise-server-on-azure.md
@@ -14,7 +14,7 @@ You can deploy {% data variables.product.prodname_ghe_server %} on global Azure
- {% data reusables.enterprise_installation.software-license %}
- You must have an Azure account capable of provisioning new machines. For more information, see the [Microsoft Azure website](https://azure.microsoft.com).
-- Most actions needed to launch your virtual machine (VM) may also be performed using the Azure Portal. However, we recommend installing the Azure command line interface (CLI) for initial setup. Examples using the Azure CLI 2.0 are included below. For more information, see Azure's guide "[Install Azure CLI 2.0](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest)."
+- Most actions needed to launch your virtual machine (VM) may also be performed using the Azure Portal. However, we recommend installing the Azure command line interface (CLI) for initial setup. Examples using the Azure CLI 2.0 are included below. For more information, see Azure's guide "[Install Azure CLI 2.0](https://docs.microsoft.com/cli/azure/install-azure-cli?view=azure-cli-latest)."
### Hardware considerations
@@ -22,13 +22,13 @@ You can deploy {% data variables.product.prodname_ghe_server %} on global Azure
### Determining the virtual machine type
-Before launching {% data variables.product.product_location_enterprise %} on Azure, you'll need to determine the type of virtual machine that best fits the needs of your organization.
+Before launching {% data variables.product.product_location %} on Azure, you'll need to determine the type of virtual machine that best fits the needs of your organization.
#### Supported VM types and regions
-The {% data variables.product.prodname_ghe_server %} appliance requires a premium storage data disk, and is supported on any Azure VM that supports premium storage. For more information, see "[Supported VMs](https://docs.microsoft.com/en-us/azure/storage/common/storage-premium-storage#supported-vms)" in the Azure documentation. For general information about available VMs, see [the Azure virtual machines overview page](http://azure.microsoft.com/en-us/pricing/details/virtual-machines/#Linux).
+The {% data variables.product.prodname_ghe_server %} appliance requires a premium storage data disk, and is supported on any Azure VM that supports premium storage. For more information, see "[Supported VMs](https://docs.microsoft.com/azure/storage/common/storage-premium-storage#supported-vms)" in the Azure documentation. For general information about available VMs, see [the Azure virtual machines overview page](https://azure.microsoft.com/pricing/details/virtual-machines/#Linux).
-{% data variables.product.prodname_ghe_server %} supports any region that supports your VM type. For more information about the supported regions for each VM, see Azure's "[Products available by region](https://azure.microsoft.com/en-us/regions/services/)."
+{% data variables.product.prodname_ghe_server %} supports any region that supports your VM type. For more information about the supported regions for each VM, see Azure's "[Products available by region](https://azure.microsoft.com/regions/services/)."
#### Recommended VM types
@@ -47,20 +47,20 @@ We recommend you use a DS v2 instance type with at least 14 GB of RAM. You can u
{% data reusables.enterprise_installation.create-ghe-instance %}
-1. Find the most recent {% data variables.product.prodname_ghe_server %} appliance image. For more information about the `vm image list` command, see "[az vm image list](https://docs.microsoft.com/en-us/cli/azure/vm/image?view=azure-cli-latest#az_vm_image_list)" in the Microsoft documentation.
+1. Find the most recent {% data variables.product.prodname_ghe_server %} appliance image. For more information about the `vm image list` command, see "[az vm image list](https://docs.microsoft.com/cli/azure/vm/image?view=azure-cli-latest#az_vm_image_list)" in the Microsoft documentation.
```shell
$ az vm image list --all -f GitHub-Enterprise | grep '"urn":' | sort -V
```
-2. Create a new VM using the appliance image you found. For more information, see "[az vm create](https://docs.microsoft.com/en-us/cli/azure/vm?view=azure-cli-latest#az_vm_create)" in the Microsoft documentation.
+2. Create a new VM using the appliance image you found. For more information, see "[az vm create](https://docs.microsoft.com/cli/azure/vm?view=azure-cli-latest#az_vm_create)" in the Microsoft documentation.
- Pass in options for the name of your VM, the resource group, the size of your VM, the name of your preferred Azure region, the name of the appliance image VM you listed in the previous step, and the storage SKU for premium storage. For more information about resource groups, see "[Resource groups](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-overview#resource-groups)" in the Microsoft documentation.
+ Pass in options for the name of your VM, the resource group, the size of your VM, the name of your preferred Azure region, the name of the appliance image VM you listed in the previous step, and the storage SKU for premium storage. For more information about resource groups, see "[Resource groups](https://docs.microsoft.com/azure/azure-resource-manager/resource-group-overview#resource-groups)" in the Microsoft documentation.
```shell
$ az vm create -n VM_NAME -g RESOURCE_GROUP --size VM_SIZE -l REGION --image APPLIANCE_IMAGE_NAME --storage-sku Premium_LRS
```
-3. Configure the security settings on your VM to open up required ports. For more information, see "[az vm open-port](https://docs.microsoft.com/en-us/cli/azure/vm?view=azure-cli-latest#az_vm_open_port)" in the Microsoft documentation. See the table below for a description of each port to determine what ports you need to open.
+3. Configure the security settings on your VM to open up required ports. For more information, see "[az vm open-port](https://docs.microsoft.com/cli/azure/vm?view=azure-cli-latest#az_vm_open_port)" in the Microsoft documentation. See the table below for a description of each port to determine what ports you need to open.
```shell
$ az vm open-port -n VM_NAME -g RESOURCE_GROUP --port PORT_NUMBER
@@ -70,7 +70,7 @@ We recommend you use a DS v2 instance type with at least 14 GB of RAM. You can u
{% data reusables.enterprise_installation.necessary_ports %}
-4. Create and attach a new unencrypted data disk to the VM, and configure the size based on your user license count. For more information, see "[az vm disk attach](https://docs.microsoft.com/en-us/cli/azure/vm/disk?view=azure-cli-latest#az_vm_disk_attach)" in the Microsoft documentation.
+4. Create and attach a new unencrypted data disk to the VM, and configure the size based on your user license count. For more information, see "[az vm disk attach](https://docs.microsoft.com/cli/azure/vm/disk?view=azure-cli-latest#az_vm_disk_attach)" in the Microsoft documentation.
Pass in options for the name of your VM (for example, `ghe-acme-corp`), the resource group, the premium storage SKU, the size of the disk (for example, `100`), and a name for the resulting VHD.
@@ -86,7 +86,7 @@ We recommend you use a DS v2 instance type with at least 14 GB of RAM. You can u
### Configuring the {% data variables.product.prodname_ghe_server %} virtual machine
-1. Before configuring the VM, you must wait for it to enter ReadyRole status. Check the status of the VM with the `vm list` command. For more information, see "[az vm list](https://docs.microsoft.com/en-us/cli/azure/vm?view=azure-cli-latest#az_vm_list)" in the Microsoft documentation.
+1. Before configuring the VM, you must wait for it to enter ReadyRole status. Check the status of the VM with the `vm list` command. For more information, see "[az vm list](https://docs.microsoft.com/cli/azure/vm?view=azure-cli-latest#az_vm_list)" in the Microsoft documentation.
```shell
$ az vm list -d -g RESOURCE_GROUP -o table
> Name ResourceGroup PowerState PublicIps Fqdns Location Zones
@@ -96,7 +96,7 @@ We recommend you use a DS v2 instance type with at least 14 GB of RAM. You can u
```
{% note %}
- **Note:** Azure does not automatically create a FQDNS entry for the VM. For more information, see Azure's guide on how to "[Create a fully qualified domain name in the Azure portal for a Linux VM](https://docs.microsoft.com/en-us/azure/virtual-machines/linux/portal-create-fqdn)."
+ **Note:** Azure does not automatically create a FQDNS entry for the VM. For more information, see Azure's guide on how to "[Create a fully qualified domain name in the Azure portal for a Linux VM](https://docs.microsoft.com/azure/virtual-machines/linux/portal-create-fqdn)."
{% endnote %}
diff --git a/content/admin/installation/installing-github-enterprise-server-on-google-cloud-platform.md b/content/admin/installation/installing-github-enterprise-server-on-google-cloud-platform.md
index 2f8bfbc5da1c..2978fe87aa42 100644
--- a/content/admin/installation/installing-github-enterprise-server-on-google-cloud-platform.md
+++ b/content/admin/installation/installing-github-enterprise-server-on-google-cloud-platform.md
@@ -20,12 +20,12 @@ versions:
### Determining the machine type
-Before launching {% data variables.product.product_location_enterprise %} on Google Cloud Platform, you'll need to determine the machine type that best fits the needs of your organization.
+Before launching {% data variables.product.product_location %} on Google Cloud Platform, you'll need to determine the machine type that best fits the needs of your organization.
#### Supported machine types
{% data variables.product.prodname_ghe_server %} is supported on the following Google Compute Engine (GCE) machine types. For more information, see [the Google Cloud Platform machine types article](https://cloud.google.com/compute/docs/machine-types).
-{% if currentVersion != "free-pro-team@latest" %}
+
| High-memory |
------------- |
| n1-highmem-4 |
@@ -34,7 +34,6 @@ Before launching {% data variables.product.product_location_enterprise %} on Goo
| n1-highmem-32 |
| n1-highmem-64 |
| n1-highmem-96 |
-{% endif %}
#### Recommended machine types
diff --git a/content/admin/installation/installing-github-enterprise-server-on-hyper-v.md b/content/admin/installation/installing-github-enterprise-server-on-hyper-v.md
index 45f340ae453a..7963e812822c 100644
--- a/content/admin/installation/installing-github-enterprise-server-on-hyper-v.md
+++ b/content/admin/installation/installing-github-enterprise-server-on-hyper-v.md
@@ -12,7 +12,7 @@ versions:
- {% data reusables.enterprise_installation.software-license %}
- You must have Windows Server 2008 through Windows Server 2016, which support Hyper-V.
-- Most actions needed to create your virtual machine (VM) may also be performed using the [Hyper-V Manager](https://docs.microsoft.com/en-us/windows-server/virtualization/hyper-v/manage/remotely-manage-hyper-v-hosts). However, we recommend using the Windows PowerShell command-line shell for initial setup. Examples using PowerShell are included below. For more information, see the Microsoft guide "[Getting Started with Windows PowerShell](https://docs.microsoft.com/en-us/powershell/scripting/getting-started/getting-started-with-windows-powershell?view=powershell-5.1)."
+- Most actions needed to create your virtual machine (VM) may also be performed using the [Hyper-V Manager](https://docs.microsoft.com/windows-server/virtualization/hyper-v/manage/remotely-manage-hyper-v-hosts). However, we recommend using the Windows PowerShell command-line shell for initial setup. Examples using PowerShell are included below. For more information, see the Microsoft guide "[Getting Started with Windows PowerShell](https://docs.microsoft.com/powershell/scripting/getting-started/getting-started-with-windows-powershell?view=powershell-5.1)."
### Hardware considerations
@@ -30,23 +30,23 @@ versions:
{% data reusables.enterprise_installation.create-ghe-instance %}
-1. In PowerShell, create a new Generation 1 virtual machine, configure the size based on your user license count, and attach the {% data variables.product.prodname_ghe_server %} image you downloaded. For more information, see "[New-VM](https://docs.microsoft.com/en-us/powershell/module/hyper-v/new-vm?view=win10-ps)" in the Microsoft documentation.
+1. In PowerShell, create a new Generation 1 virtual machine, configure the size based on your user license count, and attach the {% data variables.product.prodname_ghe_server %} image you downloaded. For more information, see "[New-VM](https://docs.microsoft.com/powershell/module/hyper-v/new-vm?view=win10-ps)" in the Microsoft documentation.
```shell
PS C:\> New-VM -Generation 1 -Name VM_NAME -MemoryStartupBytes MEMORY_SIZE -BootDevice VHD -VHDPath PATH_TO_VHD
```
-{% data reusables.enterprise_installation.create-attached-storage-volume %} Replace `PATH_TO_DATA_DISK` with the path to the location where you create the disk. For more information, see "[New-VHD](https://docs.microsoft.com/en-us/powershell/module/hyper-v/new-vhd?view=win10-ps)" in the Microsoft documentation.
+{% data reusables.enterprise_installation.create-attached-storage-volume %} Replace `PATH_TO_DATA_DISK` with the path to the location where you create the disk. For more information, see "[New-VHD](https://docs.microsoft.com/powershell/module/hyper-v/new-vhd?view=win10-ps)" in the Microsoft documentation.
```shell
PS C:\> New-VHD -Path PATH_TO_DATA_DISK -SizeBytes DISK_SIZE
```
-3. Attach the data disk to your instance. For more information, see "[Add-VMHardDiskDrive](https://docs.microsoft.com/en-us/powershell/module/hyper-v/add-vmharddiskdrive?view=win10-ps)" in the Microsoft documentation.
+3. Attach the data disk to your instance. For more information, see "[Add-VMHardDiskDrive](https://docs.microsoft.com/powershell/module/hyper-v/add-vmharddiskdrive?view=win10-ps)" in the Microsoft documentation.
```shell
PS C:\> Add-VMHardDiskDrive -VMName VM_NAME -Path PATH_TO_DATA_DISK
```
-4. Start the VM. For more information, see "[Start-VM](https://docs.microsoft.com/en-us/powershell/module/hyper-v/start-vm?view=win10-ps)" in the Microsoft documentation.
+4. Start the VM. For more information, see "[Start-VM](https://docs.microsoft.com/powershell/module/hyper-v/start-vm?view=win10-ps)" in the Microsoft documentation.
```shell
PS C:\> Start-VM -Name VM_NAME
```
-5. Get the IP address of your VM. For more information, see "[Get-VMNetworkAdapter](https://docs.microsoft.com/en-us/powershell/module/hyper-v/get-vmnetworkadapter?view=win10-ps)" in the Microsoft documentation.
+5. Get the IP address of your VM. For more information, see "[Get-VMNetworkAdapter](https://docs.microsoft.com/powershell/module/hyper-v/get-vmnetworkadapter?view=win10-ps)" in the Microsoft documentation.
```shell
PS C:\> (Get-VMNetworkAdapter -VMName VM_NAME).IpAddresses
```
diff --git a/content/admin/installation/installing-github-enterprise-server-on-openstack-kvm.md b/content/admin/installation/installing-github-enterprise-server-on-openstack-kvm.md
index 6ae298dbf43c..62345e94ebf7 100644
--- a/content/admin/installation/installing-github-enterprise-server-on-openstack-kvm.md
+++ b/content/admin/installation/installing-github-enterprise-server-on-openstack-kvm.md
@@ -35,7 +35,7 @@ versions:
{% data reusables.enterprise_installation.necessary_ports %}
4. Optionally, associate a floating IP to the instance. Depending on your OpenStack setup, you may need to allocate a floating IP to the project and associate it to the instance. Contact your system administrator to determine if this is the case for you. For more information, see "[Allocate a floating IP address to an instance](https://docs.openstack.org/horizon/latest/user/configure-access-and-security-for-instances.html#allocate-a-floating-ip-address-to-an-instance)" in the OpenStack documentation.
-5. Launch {% data variables.product.product_location_enterprise %} using the image, data volume, and security group created in the previous steps. For instructions, see the OpenStack guide "[Launch and manage instances](https://docs.openstack.org/horizon/latest/user/launch-instances.html)."
+5. Launch {% data variables.product.product_location %} using the image, data volume, and security group created in the previous steps. For instructions, see the OpenStack guide "[Launch and manage instances](https://docs.openstack.org/horizon/latest/user/launch-instances.html)."
### Configuring the {% data variables.product.prodname_ghe_server %} instance
diff --git a/content/admin/installation/installing-github-enterprise-server-on-vmware.md b/content/admin/installation/installing-github-enterprise-server-on-vmware.md
index 6cf21603c498..b14285717285 100644
--- a/content/admin/installation/installing-github-enterprise-server-on-vmware.md
+++ b/content/admin/installation/installing-github-enterprise-server-on-vmware.md
@@ -14,7 +14,7 @@ versions:
### Prerequisites
- {% data reusables.enterprise_installation.software-license %}
-- You must have a VMware vSphere ESXi Hypervisor, applied to a bare metal machine that will run {% data variables.product.product_location_enterprise %}s. We support versions 5.5 through 6.7. The ESXi Hypervisor is free and does not include the (optional) vCenter Server. For more information, see [the VMware ESXi documentation](https://www.vmware.com/products/esxi-and-esx.html).
+- You must have a VMware vSphere ESXi Hypervisor, applied to a bare metal machine that will run {% data variables.product.product_location %}s. We support versions 5.5 through 6.7. The ESXi Hypervisor is free and does not include the (optional) vCenter Server. For more information, see [the VMware ESXi documentation](https://www.vmware.com/products/esxi-and-esx.html).
- You will need access to a vSphere Client. If you have vCenter Server you can use the vSphere Web Client. For more information, see the VMware guide "[Log in to vCenter Server by Using the vSphere Web Client](https://docs.vmware.com/en/VMware-vSphere/6.5/com.vmware.vsphere.install.doc/GUID-CE128B59-E236-45FF-9976-D134DADC8178.html)."
### Hardware considerations
diff --git a/content/admin/installation/setting-up-a-staging-instance.md b/content/admin/installation/setting-up-a-staging-instance.md
index a6c64e0a6aaf..7bca92d93624 100644
--- a/content/admin/installation/setting-up-a-staging-instance.md
+++ b/content/admin/installation/setting-up-a-staging-instance.md
@@ -1,6 +1,6 @@
---
title: Setting up a staging instance
-intro: 'You can use a *staging instance* to test modifications before they are applied to {% data variables.product.product_location_enterprise %}. For example, you could use a staging instance to test new {% data variables.product.prodname_ghe_server %} updates or to practice importing migration data.'
+intro: 'You can use a *staging instance* to test modifications before they are applied to {% data variables.product.product_location %}. For example, you could use a staging instance to test new {% data variables.product.prodname_ghe_server %} updates or to practice importing migration data.'
redirect_from:
- /enterprise/admin/installation/setting-up-a-staging-instance
versions:
diff --git a/content/admin/overview/about-the-github-enterprise-server-api.md b/content/admin/overview/about-the-github-enterprise-api.md
similarity index 62%
rename from content/admin/overview/about-the-github-enterprise-server-api.md
rename to content/admin/overview/about-the-github-enterprise-api.md
index fc6293a2b034..d2586b838169 100644
--- a/content/admin/overview/about-the-github-enterprise-server-api.md
+++ b/content/admin/overview/about-the-github-enterprise-api.md
@@ -1,19 +1,24 @@
---
-title: About the GitHub Enterprise Server API
-intro: '{% data variables.product.prodname_ghe_server %} supports the same powerful API available on {% data variables.product.prodname_dotcom_the_website %} as well as its own set of API endpoints.'
+title: About the GitHub Enterprise API
+intro: '{% data variables.product.product_name %} supports REST and GraphQL APIs.'
redirect_from:
- /enterprise/admin/installation/about-the-github-enterprise-server-api
- /enterprise/admin/articles/about-the-enterprise-api/
- /enterprise/admin/articles/using-the-api/
- /enterprise/admin/categories/api/
- /enterprise/admin/overview/about-the-github-enterprise-server-api
+ - /admin/overview/about-the-github-enterprise-server-api
versions:
enterprise-server: '*'
+ github-ae: '*'
---
-For the complete documentation for {% data variables.product.prodname_enterprise_api %}, see [{% data variables.product.prodname_enterprise_api %} REST API reference docs](/enterprise/{{ currentVersion }}/v3/). With the API, you can automate many administrative tasks. Some examples include:
+With the APIs, you can automate many administrative tasks. Some examples include:
+{% if enterpriseServerVersions contains currentVersion %}
- 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)."
+- Configure LDAP sync. For more information, see "[LDAP](/enterprise/{{ currentVersion }}/user/rest/reference/enterprise-admin#ldap)."{% endif %}
+- Collect statistics about your enterprise. For more information, see "[Admin stats](/rest/reference/enterprise-admin#admin-stats)."
- Manage your enterprise account. For more information, see "[Enterprise accounts](/v4/guides/managing-enterprise-accounts)."
+
+For the complete documentation for {% data variables.product.prodname_enterprise_api %}, see [{% data variables.product.prodname_dotcom %} REST API](/rest) and [{% data variables.product.prodname_dotcom%} GraphQL API](/graphql).
\ No newline at end of file
diff --git a/content/admin/overview/index.md b/content/admin/overview/index.md
index 88d210d69eba..b7c9d60faf7f 100644
--- a/content/admin/overview/index.md
+++ b/content/admin/overview/index.md
@@ -1,10 +1,11 @@
---
title: Overview
-intro: 'With {% data variables.product.prodname_enterprise %} you can manage accounts and access, licenses, and billing. '
+intro: 'You can learn about {% data variables.product.product_name %} and manage{% if enterpriseServerVersions contains currentVersion %} accounts and access, licenses, and{% endif %} billing.'
redirect_from:
- /enterprise/admin/overview
versions:
enterprise-server: '*'
+ github-ae: '*'
---
For more information, or to purchase {% data variables.product.prodname_enterprise %}, see [{% data variables.product.prodname_enterprise %}](https://github.com/enterprise).
@@ -13,6 +14,6 @@ For more information, or to purchase {% data variables.product.prodname_enterpri
{% link_in_list /about-enterprise-accounts %}
{% link_in_list /managing-your-github-enterprise-license %}
-{% link_in_list /managing-billing-for-github-enterprise %}
+{% link_in_list /managing-billing-for-your-enterprise %}
{% link_in_list /system-overview %}
-{% link_in_list /about-the-github-enterprise-server-api %}
+{% link_in_list /about-the-github-enterprise-api %}
diff --git a/content/admin/overview/managing-billing-for-github-enterprise.md b/content/admin/overview/managing-billing-for-github-enterprise.md
deleted file mode 100644
index 99253be4056b..000000000000
--- a/content/admin/overview/managing-billing-for-github-enterprise.md
+++ /dev/null
@@ -1,50 +0,0 @@
----
-title: Managing billing for GitHub Enterprise
-intro: 'You can view the license usage, invoices, payment history, and other billing information for your enterprise account and {% data variables.product.prodname_ghe_server %} instances.'
-product: '{% data reusables.gated-features.enterprise-accounts %}'
-redirect_from:
- - /enterprise/admin/installation/managing-billing-for-github-enterprise
- - /enterprise/admin/overview/managing-billing-for-github-enterprise
-versions:
- enterprise-server: '*'
----
-
-### About billing for enterprise accounts
-
-Enterprise accounts are currently available to {% data variables.product.prodname_enterprise %} customers paying by invoice. Billing for all of the organizations and {% data variables.product.prodname_ghe_server %} instances connected to your enterprise account is aggregated into a single bill charge for all of your paid {% data variables.product.prodname_dotcom_the_website %} services (including paid licenses in organizations, {% data variables.large_files.product_name_long %} data packs, and subscriptions for {% data variables.product.prodname_marketplace %} apps).
-
-Enterprise owners and billing managers can access and manage all billing settings for enterprise accounts. For more information about enterprise accounts, see "[Roles of an enterprise account](/github/setting-up-and-managing-your-enterprise-account/roles-for-an-enterprise-account)." For more information about managing billing managers, see "[Inviting people to manage your enterprise account](/github/setting-up-and-managing-your-enterprise-account/inviting-people-to-manage-your-enterprise-account)."
-
-### Viewing your current invoice
-
-{% data reusables.enterprise-accounts.access-enterprise %}
-{% data reusables.enterprise-accounts.settings-tab %}
-{% data reusables.enterprise-accounts.billing-tab %}
-4. Under "Quick Actions", click **View invoice**.
- 
-
-### Paying your current invoice
-
-{% data reusables.enterprise-accounts.access-enterprise %}
-{% data reusables.enterprise-accounts.settings-tab %}
-{% data reusables.enterprise-accounts.billing-tab %}
-4. Under "Quick Actions", click **Pay invoice**.
- 
-5. Under "Pay invoice", type your credit card information in the secure form, then click **Pay Invoice**.
- 
-
-### Downloading your current invoice
-
-{% data reusables.enterprise-accounts.access-enterprise %}
-{% data reusables.enterprise-accounts.settings-tab %}
-{% data reusables.enterprise-accounts.billing-tab %}
-4. Under "Quick Actions", click **Download current invoice**.
- 
-
-### Viewing your payment history
-
-{% data reusables.enterprise-accounts.access-enterprise %}
-{% data reusables.enterprise-accounts.settings-tab %}
-{% data reusables.enterprise-accounts.billing-tab %}
-4. Under "Billing", click the **Past Invoices** tab to see a summary of your past billing activity.
- 
diff --git a/content/admin/overview/managing-billing-for-your-enterprise.md b/content/admin/overview/managing-billing-for-your-enterprise.md
new file mode 100644
index 000000000000..97c0ba8c0346
--- /dev/null
+++ b/content/admin/overview/managing-billing-for-your-enterprise.md
@@ -0,0 +1,79 @@
+---
+title: Managing billing for your enterprise
+intro: 'You can view billing information for your enterprise.'
+product: '{% data reusables.gated-features.enterprise-accounts %}'
+redirect_from:
+ - /enterprise/admin/installation/managing-billing-for-github-enterprise
+ - /enterprise/admin/overview/managing-billing-for-github-enterprise
+ - /admin/overview/managing-billing-for-github-enterprise
+versions:
+ enterprise-server: '*'
+ github-ae: '*'
+---
+
+{% if currentVersion == "github-ae@latest" %}
+
+{% data reusables.github-ae.about-billing %} Once per day, {% data variables.product.prodname_dotcom %} will count the number of users with a license for your enterprise. {% data variables.product.company_short %} bills you for each licensed user regardless of whether the user logged into {% data variables.product.prodname_ghe_managed %} that day.
+
+For commercial regions, the price per user per day is $1.2580645161. For 31-day months, the monthly cost for each user is $39. For months with fewer days, the monthly cost is lower. Each billing month begins at a fixed time on the first day of the calendar month.
+
+If you add a licensed user mid-month, that user will only be included in the count for the days they have a license. When you remove a licensed user, that user will remain in the count until the end of that month. Therefore, if you add a user mid-month and later remove the user in the same month, the user will be included in the count from the day the user was added through the end of the month. There is no additional cost if you re-add a user during the same month the user was removed.
+
+For example, here are the costs for users with licenses on different dates.
+
+User | License dates | Counted days | Cost
+---- | ------------ | ------- | -----
+@octocat | January 1 - January 31 | 31 | $39
+@robocat | February 1 - February 28 | 29 | $35.23
+@devtocat | January 15 - January 31 | 17 | $21.39
+@doctocat | January 1 - January 15 | 31 | $39
+@prodocat | January 7 - January 15 | 25 | $31.45
+@monalisa | January 1 - January 7,
January 15 - January 31 | 31 | $39
+
+Your enterprise can include one or more instances. {% data variables.product.prodname_ghe_managed %} has a 500-user minimum per instance. {% data variables.product.company_short %} bills you for a minimum of 500 users per instance, even if there are fewer than 500 users with a license that day.
+
+You can see your current usage in your [Azure account portal](https://portal.azure.com).
+
+{% else %}
+
+### About billing for enterprise accounts
+
+Enterprise accounts are currently available to {% data variables.product.prodname_enterprise %} customers paying by invoice. Billing for all of the organizations and {% data variables.product.prodname_ghe_server %} instances connected to your enterprise account is aggregated into a single bill charge for all of your paid {% data variables.product.prodname_dotcom_the_website %} services (including paid licenses in organizations, {% data variables.large_files.product_name_long %} data packs, and subscriptions for {% data variables.product.prodname_marketplace %} apps).
+
+Enterprise owners and billing managers can access and manage all billing settings for enterprise accounts. For more information about enterprise accounts, {% if currentVersion == "free-pro-team@latest" or "github-ae@latest" %}"[Roles in an enterprise](/github/setting-up-and-managing-your-enterprise/roles-in-an-enterprise#enterprise-members)" and {% endif %}"[Repository permission levels for an organization](/articles/repository-permission-levels-for-an-organization)."For more information about managing billing managers, see "[Inviting people to manage your enterprise](/github/setting-up-and-managing-your-enterprise/inviting-people-to-manage-your-enterprise)."
+
+### Viewing your current invoice
+
+{% data reusables.enterprise-accounts.access-enterprise %}
+{% data reusables.enterprise-accounts.settings-tab %}
+{% data reusables.enterprise-accounts.billing-tab %}
+4. Under "Quick Actions", click **View invoice**.
+ 
+
+### Paying your current invoice
+
+{% data reusables.enterprise-accounts.access-enterprise %}
+{% data reusables.enterprise-accounts.settings-tab %}
+{% data reusables.enterprise-accounts.billing-tab %}
+4. Under "Quick Actions", click **Pay invoice**.
+ 
+5. Under "Pay invoice", type your credit card information in the secure form, then click **Pay Invoice**.
+ 
+
+### Downloading your current invoice
+
+{% data reusables.enterprise-accounts.access-enterprise %}
+{% data reusables.enterprise-accounts.settings-tab %}
+{% data reusables.enterprise-accounts.billing-tab %}
+4. Under "Quick Actions", click **Download current invoice**.
+ 
+
+### Viewing your payment history
+
+{% data reusables.enterprise-accounts.access-enterprise %}
+{% data reusables.enterprise-accounts.settings-tab %}
+{% data reusables.enterprise-accounts.billing-tab %}
+4. Under "Billing", click the **Past Invoices** tab to see a summary of your past billing activity.
+ 
+
+{% endif %}
diff --git a/content/admin/overview/managing-your-github-enterprise-license.md b/content/admin/overview/managing-your-github-enterprise-license.md
index c564529bc751..701d4e32d5fb 100644
--- a/content/admin/overview/managing-your-github-enterprise-license.md
+++ b/content/admin/overview/managing-your-github-enterprise-license.md
@@ -37,8 +37,7 @@ If you'd like to renew or add user licenses to {% data variables.product.prodnam
4. Under "Enterprise Server Instances", click {% octicon "download" aria-label="The download icon" %} to download your license file.
5. Log into your {% data variables.product.prodname_ghe_server %} instance as a site administrator.
-{% data reusables.enterprise_site_admin_settings.access-settings %}
-{% data reusables.enterprise_site_admin_settings.business %}
+{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.license-tab %}
12. Under "Quick links", click **Update license**.
@@ -64,8 +63,7 @@ You can use {% data variables.product.prodname_github_connect %} to automaticall
You can download a JSON file from {% data variables.product.prodname_ghe_server %} and upload the file to {% data variables.product.prodname_ghe_cloud %} to manually sync user license usage between the two deployments.
-{% data reusables.enterprise_site_admin_settings.access-settings %}
-{% data reusables.enterprise_site_admin_settings.business %}
+{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.license-tab %}
5. Under "Quick links", to download a file containing your current license usage on {% data variables.product.prodname_ghe_server %}, click **Export license usage**.
diff --git a/content/admin/overview/system-overview.md b/content/admin/overview/system-overview.md
index 95aba06da394..146923377efe 100644
--- a/content/admin/overview/system-overview.md
+++ b/content/admin/overview/system-overview.md
@@ -77,7 +77,7 @@ For more information, see "[Configuring backups on your appliance](/enterprise/{
#### External services and support access
-{% data variables.product.prodname_ghe_server %} can operate without any egress access from your network to outside services. You can optionally enable integration with external services for email delivery, external monitoring, and log forwarding. For more information, see "[Configuring email for notifications](/enterprise/{{ currentVersion }}/admin/user-management/configuring-email-for-notifications)," "[Setting up external monitoring](/enterprise/{{ currentVersion }}/admin/installation/setting-up-external-monitoring)," and "[Log forwarding](/enterprise/{{ currentVersion }}/admin/installation/log-forwarding)."
+{% data variables.product.prodname_ghe_server %} can operate without any egress access from your network to outside services. You can optionally enable integration with external services for email delivery, external monitoring, and log forwarding. For more information, see "[Configuring email for notifications](/admin/configuration/configuring-email-for-notifications)," "[Setting up external monitoring](/enterprise/{{ currentVersion }}/admin/installation/setting-up-external-monitoring)," and "[Log forwarding](/admin/user-management/log-forwarding)."
You can manually collect and send troubleshooting data to {% data variables.contact.github_support %}. For more information, see "[Providing data to {% data variables.contact.github_support %}](/enterprise/{{ currentVersion }}/admin/enterprise-support/providing-data-to-github-support)."
@@ -108,7 +108,7 @@ For more information about {% data variables.product.prodname_ghe_server %}'s us
#### Audit and access logging
-{% data variables.product.prodname_ghe_server %} stores both traditional operating system and application logs. The application also writes detailed auditing and security logs, which {% data variables.product.prodname_ghe_server %} stores permanently. You can forward both types of logs in realtime to multiple destinations via the `syslog-ng` protocol. For more information, see "[Log forwarding](/enterprise/{{ currentVersion }}/admin/installation/log-forwarding)."
+{% data variables.product.prodname_ghe_server %} stores both traditional operating system and application logs. The application also writes detailed auditing and security logs, which {% data variables.product.prodname_ghe_server %} stores permanently. You can forward both types of logs in realtime to multiple destinations via the `syslog-ng` protocol. For more information, see "[Log forwarding](/admin/user-management/log-forwarding)."
Access and audit logs include information like the following.
diff --git a/content/admin/packages/configuring-third-party-storage-for-packages.md b/content/admin/packages/configuring-third-party-storage-for-packages.md
index 5c0f19db55d2..8524547c00d7 100644
--- a/content/admin/packages/configuring-third-party-storage-for-packages.md
+++ b/content/admin/packages/configuring-third-party-storage-for-packages.md
@@ -13,7 +13,7 @@ versions:
{% data variables.product.prodname_registry %} on {% data variables.product.prodname_ghe_server %} uses external blob storage to store your packages. The amount of storage required depends on your usage of {% data variables.product.prodname_registry %}.
-At this time, {% data variables.product.prodname_registry %} supports blob storage with Amazon Web Services (AWS) S3. MinIO is also supported, but configuration is not currently implemented in the {% data variables.product.product_name %} interface. You can use MinIO for storage by following the instructions for AWS S3, entering the analagous information for your MinIO configuration.
+At this time, {% data variables.product.prodname_registry %} supports blob storage with Amazon Web Services (AWS) S3. MinIO is also supported, but configuration is not currently implemented in the {% data variables.product.product_name %} interface. You can use MinIO for storage by following the instructions for AWS S3, entering the analogous information for your MinIO configuration.
For the best experience, we recommend using a dedicated bucket for {% data variables.product.prodname_registry %}, separate from the bucket you use for {% data variables.product.prodname_actions %} storage.
diff --git a/content/admin/policies/about-pre-receive-hooks.md b/content/admin/policies/about-pre-receive-hooks.md
index d8087d8b9f14..b3d43b017635 100644
--- a/content/admin/policies/about-pre-receive-hooks.md
+++ b/content/admin/policies/about-pre-receive-hooks.md
@@ -23,4 +23,4 @@ Examples of how you can use pre-receive hooks:
### Impact on performance and workflows
Impact to developers and their workflows can be significant and must be considered carefully. Pre-receive hooks that are based on business needs and implemented thoughtfully will provide the most benefit to the organization as a whole.
-Pre-receive hooks can have unintended effects on the performance of {% data variables.product.product_location_enterprise %} and should be carefully implemented and reviewed.
+Pre-receive hooks can have unintended effects on the performance of {% data variables.product.product_location %} and should be carefully implemented and reviewed.
diff --git a/content/admin/policies/creating-a-pre-receive-hook-environment.md b/content/admin/policies/creating-a-pre-receive-hook-environment.md
index 80cc6f044510..94769c1ce13e 100644
--- a/content/admin/policies/creating-a-pre-receive-hook-environment.md
+++ b/content/admin/policies/creating-a-pre-receive-hook-environment.md
@@ -72,8 +72,7 @@ For more information about creating a chroot environment see "[Chroot](https://w
### Uploading a pre-receive hook environment on {% data variables.product.prodname_ghe_server %}
-{% data reusables.enterprise_site_admin_settings.access-settings %}
-{% data reusables.enterprise_site_admin_settings.business %}
+{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.hooks-tab %}
5. Click **Manage environments**.
diff --git a/content/admin/policies/creating-a-pre-receive-hook-script.md b/content/admin/policies/creating-a-pre-receive-hook-script.md
index 933d7d8998b0..9a37b9dee71d 100644
--- a/content/admin/policies/creating-a-pre-receive-hook-script.md
+++ b/content/admin/policies/creating-a-pre-receive-hook-script.md
@@ -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.
diff --git a/content/admin/policies/enforcing-policies-for-your-enterprise.md b/content/admin/policies/enforcing-policies-for-your-enterprise.md
index 6d8a1b6daf81..b3673275fc59 100644
--- a/content/admin/policies/enforcing-policies-for-your-enterprise.md
+++ b/content/admin/policies/enforcing-policies-for-your-enterprise.md
@@ -5,5 +5,6 @@ redirect_from:
- /enterprise/admin/policies/enforcing-policies-for-your-enterprise
versions:
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/admin/policies/enforcing-repository-management-policies-in-your-enterprise.md b/content/admin/policies/enforcing-repository-management-policies-in-your-enterprise.md
index b665c66ecc6e..c678eabd74b8 100644
--- a/content/admin/policies/enforcing-repository-management-policies-in-your-enterprise.md
+++ b/content/admin/policies/enforcing-repository-management-policies-in-your-enterprise.md
@@ -27,30 +27,24 @@ redirect_from:
- /enterprise/admin/policies/enforcing-repository-management-policies-in-your-enterprise
versions:
enterprise-server: '*'
+ github-ae: '*'
---
-### Configuring the default visibility of new repositories on your appliance
+### Configuring the default visibility of new repositories in your enterprise
-Each time someone creates a new repository on {% data variables.product.product_location_enterprise %}, that person must choose a visibility for the repository. When you configure a default visibility setting for the instance, you choose which visibility is selected by default. For more information on repository visibility, see "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility)."
+Each time someone creates a new repository on your enterprise, that person must choose a visibility for the repository. When you configure a default visibility setting for the enterprise, you choose which visibility is selected by default. For more information on repository visibility, see "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility)."
-If a site administrator disallows members from creating certain types of repositories, members will not be able to create that type of repository even if the visibility setting defaults to that type. For more information, see "[Restricting repository creation in your instance](/enterprise/{{ currentVersion }}/admin/guides/user-management/restricting-repository-creation-in-your-instance)."
+If a site administrator disallows members from creating certain types of repositories, members will not be able to create that type of repository even if the visibility setting defaults to that type. For more information, see "[Setting a policy for repository creation](#setting-a-policy-for-repository-creation)."
-{% tip %}
-
-**Tip:** You can restrict the ability to change repository visibility to site administrators only. For more information, see "[Preventing users from changing a repository's visibility](/enterprise/{{ currentVersion }}/admin/guides/user-management/preventing-users-from-changing-a-repository-s-visibility)."
-
-{% endtip %}
-
-{% data reusables.enterprise_site_admin_settings.access-settings %}
-{% data reusables.enterprise_site_admin_settings.business %}
-{% if currentVersion ver_gt "enterprise-server@2.21" %}
+{% data reusables.enterprise-accounts.access-enterprise %}
+{% if currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}
{% data reusables.enterprise-accounts.policies-tab %}
{% else %}
{% data reusables.enterprise-accounts.settings-tab %}
{% endif %}
{% data reusables.enterprise-accounts.options-tab %}
1. Under "Default repository visibility", use the drop-down menu and select a default visibility.
- 
+ 
{% data reusables.enterprise_installation.image-urls-viewable-warning %}
@@ -58,10 +52,9 @@ If a site administrator disallows members from creating certain types of reposit
When you prevent members from changing repository visibility, only site administrators have the ability to make public repositories private or make private repositories public.
-If a site administrator has restricted repository creation to organization owners only, then members will not be able to change repository visibility. If a site administrator has restricted member repository creation to private repositories only, then members will only be able to change repositories from public to private. For more information, see "[Setting a policy for repository creation](/enterprise/{{ currentVersion }}/admin/guides/user-management/restricting-repository-creation-in-your-instance)."
+If a site administrator has restricted repository creation to organization owners only, then members will not be able to change repository visibility. If a site administrator has restricted member repository creation to private repositories only, then members will only be able to change repositories from public to private. For more information, see "[Setting a policy for repository creation](#setting-a-policy-for-repository-creation)."
-{% data reusables.enterprise_site_admin_settings.access-settings %}
-{% data reusables.enterprise_site_admin_settings.business %}
+{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.policies-tab %}
{% data reusables.enterprise-accounts.repositories-tab %}
5. Under "Repository visibility change", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %}
@@ -72,12 +65,11 @@ If a site administrator has restricted repository creation to organization owner
{% data reusables.organizations.repo-creation-constants %}
-{% data reusables.enterprise_site_admin_settings.access-settings %}
-{% data reusables.enterprise_site_admin_settings.business %}
+{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.policies-tab %}
{% data reusables.enterprise-accounts.repositories-tab %}
5. Under "Repository creation", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %}
-{% if currentVersion ver_gt "enterprise-server@2.19" %}
+{% if currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %}
{% data reusables.enterprise-accounts.repo-creation-policy %}
{% data reusables.enterprise-accounts.repo-creation-types %}
{% else %}
@@ -87,8 +79,7 @@ If a site administrator has restricted repository creation to organization owner
### Setting a policy for repository deletion and transfer
-{% data reusables.enterprise_site_admin_settings.access-settings %}
-{% data reusables.enterprise_site_admin_settings.business %}
+{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.policies-tab %}
{% data reusables.enterprise-accounts.repositories-tab %}
5. Under "Repository deletion and transfer", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %}
@@ -97,7 +88,7 @@ If a site administrator has restricted repository creation to organization owner
### Setting a policy for Git push limits
-To keep your repository size manageable and prevent performance issues, you can configure a file size limit for repositories on your instance.
+To keep your repository size manageable and prevent performance issues, you can configure a file size limit for repositories in your enterprise.
By default, when you enforce repository upload limits, people cannot add or update files larger than 100 MB.
@@ -109,9 +100,8 @@ By default, when you enforce repository upload limits, people cannot add or upda
{% endtip %}
{% endif %}
-{% data reusables.enterprise_site_admin_settings.access-settings %}
-{% data reusables.enterprise_site_admin_settings.business %}
-{% if currentVersion ver_gt "enterprise-server@2.21" %}
+{% data reusables.enterprise-accounts.access-enterprise %}
+{% if currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}
{% data reusables.enterprise-accounts.policies-tab %}
{% else %}
{% data reusables.enterprise-accounts.settings-tab %}
@@ -119,16 +109,15 @@ By default, when you enforce repository upload limits, people cannot add or upda
{% data reusables.enterprise-accounts.options-tab %}
4. Under "Repository upload limit", use the drop-down menu and click a maximum object size.
-5. Optionally, to enforce a maximum upload limit for all repositories on {% data variables.product.product_location_enterprise %}, select **Enforce on all repositories**
+5. Optionally, to enforce a maximum upload limit for all repositories in your enterprise, select **Enforce on all repositories**
### Configuring the merge conflict editor for pull requests between repositories
Requiring users to resolve merge conflicts locally on their computer can prevent people from inadvertently writing to an upstream repository from a fork.
-{% data reusables.enterprise_site_admin_settings.access-settings %}
-{% data reusables.enterprise_site_admin_settings.business %}
-{% if currentVersion ver_gt "enterprise-server@2.21" %}
+{% data reusables.enterprise-accounts.access-enterprise %}
+{% if currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}
{% data reusables.enterprise-accounts.policies-tab %}
{% else %}
{% data reusables.enterprise-accounts.settings-tab %}
@@ -139,13 +128,12 @@ Requiring users to resolve merge conflicts locally on their computer can prevent
### Configuring force pushes
-Each repository inherits a default force push setting from the settings of the user account or organization to which it belongs. Likewise, each organization and user account inherits a default force push setting from the force push setting for the entire appliance. If you change the force push setting for the appliance, it will change for all repositories owned by any user or organization.
+Each repository inherits a default force push setting from the settings of the user account or organization to which it belongs. Likewise, each organization and user account inherits a default force push setting from the force push setting for the enterprise. If you change the force push setting for the enterprise, it will change for all repositories owned by any user or organization.
#### Blocking all force pushes on your appliance
-{% data reusables.enterprise_site_admin_settings.access-settings %}
-{% data reusables.enterprise_site_admin_settings.business %}
-{% if currentVersion ver_gt "enterprise-server@2.21" %}
+{% data reusables.enterprise-accounts.access-enterprise %}
+{% if currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}
{% data reusables.enterprise-accounts.policies-tab %}
{% else %}
{% data reusables.enterprise-accounts.settings-tab %}
@@ -170,7 +158,7 @@ Each repository inherits a default force push setting from the settings of the u
#### Blocking force pushes to repositories owned by a user account or organization
-Repositories inherit force push settings from the user account or organization to which they belong. User accounts and organizations in turn inherit their force push settings from the force push settings for the entire appliance.
+Repositories inherit force push settings from the user account or organization to which they belong. User accounts and organizations in turn inherit their force push settings from the force push settings for the enterprise.
You can override the default inherited settings by configuring the settings for a user account or organization.
@@ -184,18 +172,18 @@ You can override the default inherited settings by configuring the settings for
- **Block** to block force pushes to all branches.
- **Block to the default branch** to only block force pushes to the default branch.
-6. Optionally, select **Enforce on all repositories** to override repository-specific settings. Note that this will **not** override an appliance-wide policy.
+6. Optionally, select **Enforce on all repositories** to override repository-specific settings. Note that this will **not** override an enterprise-wide policy.
### Configuring anonymous Git read access
{% data reusables.enterprise_user_management.disclaimer-for-git-read-access %}
-If you have [enabled private mode](/enterprise/admin/configuration/enabling-private-mode) on your instance, you can allow repository administrators to enable anonymous Git read access to public repositories.
+{% if enterpriseServerVersions contains currentVersion %}If you have [enabled private mode](/enterprise/admin/configuration/enabling-private-mode) on your enterprise, you {% else %}You {% endif %}can allow repository administrators to enable anonymous Git read access to public repositories.
-Enabling anonymous Git read access allows users to bypass authentication for custom tools on your instance. When you or a repository administrator enable this access setting for a repository, unauthenticated Git operations (and anyone with network access to {% data variables.product.prodname_ghe_server %}) will have read access to the repository without authentication.
+Enabling anonymous Git read access allows users to bypass authentication for custom tools on your enterprise. When you or a repository administrator enable this access setting for a repository, unauthenticated Git operations (and anyone with network access to {% data variables.product.product_name %}) will have read access to the repository without authentication.
-If necessary, you can prevent repository administrators from changing anonymous Git access settings for repositories on {% data variables.product.product_location_enterprise %} by locking the repository's access settings. After you lock a repository's Git read access setting, only a site administrator can change the setting.
+If necessary, you can prevent repository administrators from changing anonymous Git access settings for repositories on your enterprise by locking the repository's access settings. After you lock a repository's Git read access setting, only a site administrator can change the setting.
{% data reusables.enterprise_site_admin_settings.list-of-repos-with-anonymous-git-read-access-enabled %}
@@ -203,9 +191,8 @@ If necessary, you can prevent repository administrators from changing anonymous
#### Setting anonymous Git read access for all repositories
-{% data reusables.enterprise_site_admin_settings.access-settings %}
-{% data reusables.enterprise_site_admin_settings.business %}
-{% if currentVersion ver_gt "enterprise-server@2.21" %}
+{% data reusables.enterprise-accounts.access-enterprise %}
+{% if currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}
{% data reusables.enterprise-accounts.policies-tab %}
{% else %}
{% data reusables.enterprise-accounts.settings-tab %}
@@ -213,9 +200,10 @@ If necessary, you can prevent repository administrators from changing anonymous
{% data reusables.enterprise-accounts.options-tab %}
4. Under "Anonymous Git read access", use the drop-down menu, and click **Enabled**.
-3. Optionally, to prevent repository admins from changing anonymous Git read access settings in all repositories on your instance, select **Prevent repository admins from changing anonymous Git read access**.
-
+3. Optionally, to prevent repository admins from changing anonymous Git read access settings in all repositories on your enterprise, select **Prevent repository admins from changing anonymous Git read access**.
+
+{% if enterpriseServerVersions contains currentVersion %}
#### Setting anonymous Git read access for a specific repository
{% data reusables.enterprise_site_admin_settings.access-settings %}
@@ -229,4 +217,17 @@ 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**.
+{% endif %}
+{% if currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}
+### Enforcing a policy on the default branch name
+
+{% data reusables.enterprise-accounts.access-enterprise %}
+{% data reusables.enterprise-accounts.policies-tab %}
+3. On the **Repository policies** tab, under "Default branch name", enter the default branch name that new repositories should use.
+ 
+4. Optionally, to enforce the default branch name for all organizations in the enterprise, select **Enforce across this enterprise**.
+ 
+5. Click **Update**.
+ 
+{% endif %}
\ No newline at end of file
diff --git a/content/admin/policies/index.md b/content/admin/policies/index.md
index 6dc11872c9b3..9c665ea89426 100644
--- a/content/admin/policies/index.md
+++ b/content/admin/policies/index.md
@@ -1,11 +1,12 @@
---
title: Setting policies for your enterprise
-intro: 'You can set policies in {% data variables.product.prodname_enterprise %} to reduce risk and increase quality.'
+intro: 'You can set policies in {% data variables.product.product_name %} to reduce risk and increase quality.'
redirect_from:
- /enterprise/admin/developer-workflow
- /enterprise/admin/policies
versions:
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/admin/policies/managing-pre-receive-hooks-on-the-github-enterprise-server-appliance.md b/content/admin/policies/managing-pre-receive-hooks-on-the-github-enterprise-server-appliance.md
index 18e18aa30f76..7393f3992efb 100644
--- a/content/admin/policies/managing-pre-receive-hooks-on-the-github-enterprise-server-appliance.md
+++ b/content/admin/policies/managing-pre-receive-hooks-on-the-github-enterprise-server-appliance.md
@@ -11,8 +11,7 @@ versions:
### Creating pre-receive hooks
-{% data reusables.enterprise_site_admin_settings.access-settings %}
-{% data reusables.enterprise_site_admin_settings.business %}
+{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.hooks-tab %}
4. Click **Add pre-receive hook**.
@@ -32,8 +31,7 @@ versions:
### Editing pre-receive hooks
-{% data reusables.enterprise_site_admin_settings.access-settings %}
-{% data reusables.enterprise_site_admin_settings.business %}
+{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.hooks-tab %}
1. Next to the pre-receive hook that you want to edit, click {% octicon "pencil" aria-label="The edit icon" %}.
@@ -41,8 +39,7 @@ versions:
### Deleting pre-receive hooks
-{% data reusables.enterprise_site_admin_settings.access-settings %}
-{% data reusables.enterprise_site_admin_settings.business %}
+{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.hooks-tab %}
2. Next to the pre-receive hook that you want to delete, click {% octicon "x" aria-label="X symbol" %}.
diff --git a/content/admin/user-management/about-migrations.md b/content/admin/user-management/about-migrations.md
index e03b1ef637c0..e04bdf4f4a50 100644
--- a/content/admin/user-management/about-migrations.md
+++ b/content/admin/user-management/about-migrations.md
@@ -14,7 +14,7 @@ There are three types of migrations you can perform:
- A migration from a {% data variables.product.prodname_ghe_server %} instance to another {% data variables.product.prodname_ghe_server %} instance. You can migrate any number of repositories owned by any user or organization on the instance. Before performing a migration, you must have site administrator access to both instances.
- A migration from a {% data variables.product.prodname_dotcom_the_website %} organization to a {% data variables.product.prodname_ghe_server %} instance. You can migrate any number of repositories owned by the organization. Before performing a migration, you must have [administrative access](/enterprise/user/articles/permission-levels-for-an-organization/) to the {% data variables.product.prodname_dotcom_the_website %} organization as well as site administrator access to the target instance.
-- *Trial runs* are migrations that import data to a [staging instance](/enterprise/admin/guides/installation/setting-up-a-staging-instance/). These can be useful to see what *would* happen if a migration were applied to {% data variables.product.product_location_enterprise %}. **We strongly recommend that you perform a trial run on a staging instance before importing data to your production instance.**
+- *Trial runs* are migrations that import data to a [staging instance](/enterprise/admin/guides/installation/setting-up-a-staging-instance/). These can be useful to see what *would* happen if a migration were applied to {% data variables.product.product_location %}. **We strongly recommend that you perform a trial run on a staging instance before importing data to your production instance.**
### Migrated data
diff --git a/content/admin/user-management/activity-dashboard.md b/content/admin/user-management/activity-dashboard.md
index 8a0835e9fe1c..5fb4fce0d924 100644
--- a/content/admin/user-management/activity-dashboard.md
+++ b/content/admin/user-management/activity-dashboard.md
@@ -1,12 +1,13 @@
---
title: Activity dashboard
-intro: 'The Activity dashboard gives you an overview of all the activity on {% data variables.product.product_location_enterprise %}.'
+intro: 'The Activity dashboard gives you an overview of all the activity in your enterprise.'
redirect_from:
- /enterprise/admin/articles/activity-dashboard/
- /enterprise/admin/installation/activity-dashboard
- /enterprise/admin/user-management/activity-dashboard
versions:
enterprise-server: '*'
+ github-ae: '*'
---
The Activity dashboard provides weekly, monthly, and yearly graphs of the number of:
@@ -22,7 +23,9 @@ The Activity dashboard provides weekly, monthly, and yearly graphs of the number
-For more analytics based on data from {% data variables.product.prodname_enterprise %}, you can purchase {% data variables.product.prodname_insights %}. For more information, see "[About {% data variables.product.prodname_insights %}](/insights/installing-and-configuring-github-insights/about-github-insights)."
+{% if enterpriseServerVersions contains currentVersion %}
+For more analytics based on data from {% data variables.product.product_name %}, you can purchase {% data variables.product.prodname_insights %}. For more information, see "[About {% data variables.product.prodname_insights %}](/insights/installing-and-configuring-github-insights/about-github-insights)."
+{% endif %}
### Accessing the Activity dashboard
diff --git a/content/admin/user-management/adding-people-to-teams.md b/content/admin/user-management/adding-people-to-teams.md
index 0f174951a8b2..0a94dea0aa6e 100644
--- a/content/admin/user-management/adding-people-to-teams.md
+++ b/content/admin/user-management/adding-people-to-teams.md
@@ -5,7 +5,7 @@ redirect_from:
- /enterprise/admin/articles/adding-or-inviting-people-to-teams/
- /enterprise/admin/guides/user-management/adding-or-inviting-people-to-teams/
- /enterprise/admin/user-management/adding-people-to-teams
-intro: 'Once a team has been created, organization admins can add users from {% data variables.product.product_location_enterprise %} to the team and determine which repositories they have access to.'
+intro: 'Once a team has been created, organization admins can add users from {% data variables.product.product_location %} to the team and determine which repositories they have access to.'
versions:
enterprise-server: '*'
---
diff --git a/content/admin/user-management/audit-logging.md b/content/admin/user-management/audit-logging.md
index c0fe5edd05f8..8a8da98e14bd 100644
--- a/content/admin/user-management/audit-logging.md
+++ b/content/admin/user-management/audit-logging.md
@@ -1,29 +1,31 @@
---
title: Audit logging
-intro: '{% data variables.product.prodname_enterprise %} keeps logs of audited user, organization, repository, and system events. Logs are useful for debugging and internal and external compliance.'
+intro: '{% data variables.product.product_name %} keeps logs of audited{% if enterpriseServerVersions contains currentVersion %} system,{% endif %} user, organization, and repository events. Logs are useful for debugging and internal and external compliance.'
redirect_from:
- /enterprise/admin/articles/audit-logging/
- /enterprise/admin/installation/audit-logging
- /enterprise/admin/user-management/audit-logging
versions:
enterprise-server: '*'
+ github-ae: '*'
---
-For a full list, see "[Audited actions](/enterprise/{{ currentVersion }}/admin/guides/installation/audited-actions)." For more information on finding a particular action, see "[Searching the audit log](/enterprise/{{ currentVersion }}/admin/guides/installation/searching-the-audit-log)."
+For a full list, see "[Audited actions](/admin/user-management/audited-actions)." For more information on finding a particular action, see "[Searching the audit log](/admin/user-management/searching-the-audit-log)."
### Push logs
-Every Git push operation is logged. For more information, see "[Viewing push logs](/enterprise/{{ currentVersion }}/admin/guides/installation/viewing-push-logs)."
+Every Git push operation is logged. For more information, see "[Viewing push logs](/admin/user-management/viewing-push-logs)."
+{% if enterpriseServerVersions contains currentVersion %}
### System events
All audited system events, including all pushes and pulls, are logged to `/var/log/github/audit.log`. Logs are automatically rotated every 24 hours and are retained for seven days.
-The support bundle includes system logs. For more information, see "[Providing data to {% data variables.product.prodname_dotcom %} Support](/enterprise/{{ currentVersion }}/admin/guides/enterprise-support/providing-data-to-github-support)."
+The support bundle includes system logs. For more information, see "[Providing data to {% data variables.product.prodname_dotcom %} Support](/admin/enterprise-support/providing-data-to-github-support)."
### Support bundles
-All audit information is logged to the `audit.log` file in the `github-logs` directory of any support bundle. If log forwarding is enabled, you can stream this data to an external syslog stream consumer such as [Splunk](http://www.splunk.com/) or [Logstash](http://logstash.net/). All entries from this log use and can be filtered with the `github_audit` keyword. For more information see "[Log forwarding](/enterprise/{{ currentVersion }}/admin/guides/installation/log-forwarding)."
+All audit information is logged to the `audit.log` file in the `github-logs` directory of any support bundle. If log forwarding is enabled, you can stream this data to an external syslog stream consumer such as [Splunk](http://www.splunk.com/) or [Logstash](http://logstash.net/). All entries from this log use and can be filtered with the `github_audit` keyword. For more information see "[Log forwarding](/admin/user-management/log-forwarding)."
For example, this entry shows that a new repository was created.
@@ -36,3 +38,4 @@ This example shows that commits were pushed to a repository.
```
Oct 26 02:19:31 github-ent github_audit: { "pid":22860, "ppid":22859, "program":"receive-pack", "git_dir":"/data/repositories/some-user/some-repository.git", "hostname":"github-ent", "pusher":"some-user", "real_ip":"10.0.0.51", "user_agent":"git/1.7.10.4", "repo_id":1, "repo_name":"some-user/some-repository", "transaction_id":"b031b7dc7043c87323a75f7a92092ef1456e5fbaef995c68", "frontend_ppid":1, "repo_public":true, "user_name":"some-user", "user_login":"some-user", "frontend_pid":18238, "frontend":"github-ent", "user_email":"some-user@github.example.com", "user_id":2, "pgroup":"github-ent_22860", "status":"post_receive_hook", "features":" report-status side-band-64k", "received_objects":3, "receive_pack_size":243, "non_fast_forward":false, "current_ref":"refs/heads/main" }
```
+{% endif %}
\ No newline at end of file
diff --git a/content/admin/user-management/audited-actions.md b/content/admin/user-management/audited-actions.md
index 10bb4189876a..56adff56aca8 100644
--- a/content/admin/user-management/audited-actions.md
+++ b/content/admin/user-management/audited-actions.md
@@ -7,6 +7,7 @@ redirect_from:
- /enterprise/admin/user-management/audited-actions
versions:
enterprise-server: '*'
+ github-ae: '*'
---
#### Authentication
@@ -19,9 +20,9 @@ Name | Description
`oauth_application.transfer` | An [OAuth application][] was transferred from one user or organization account to another.
`public_key.create` | An SSH key was [added][add key] to a user account or a [deploy key][] was added to a repository.
`public_key.delete` | An SSH key was removed from a user account or a [deploy key][] was removed from a repository.
-`public_key.update` | A user account's SSH key or a repository's [deploy key][] was updated.
+`public_key.update` | A user account's SSH key or a repository's [deploy key][] was updated.{% if enterpriseServerVersions contains currentVersion %}
`two_factor_authentication.enabled` | [Two-factor authentication][2fa] was enabled for a user account.
-`two_factor_authentication.disabled` | [Two-factor authentication][2fa] was disabled for a user account.
+`two_factor_authentication.disabled` | [Two-factor authentication][2fa] was disabled for a user account.{% endif %}
[add key]: /articles/adding-a-new-ssh-key-to-your-github-account
[deploy key]: /guides/managing-deploy-keys/#deploy-keys
@@ -39,14 +40,14 @@ Name | Description
`hook.destroy` | A hook was deleted.
`hook.events_changed` | A hook's configured events were changed.
-#### Instance configuration settings
+#### Enterprise configuration settings
Name | Description
-----------------------------------------------:| -------------------------------------------
-`business.update_member_repository_creation_permission` | A site admin restricts repository creation in organizations on the instance. For more information, see "[Restricting repository creation in your instance](/enterprise/{{ currentVersion }}/admin/guides/user-management/restricting-repository-creation-in-your-instance)."
-`business.clear_members_can_create_repos` | A site admin clears a restriction on repository creation in organizations on the instance. For more information, see "[Restricting repository creation in your instance](/enterprise/{{ currentVersion }}/admin/guides/user-management/restricting-repository-creation-in-your-instance)."
-`enterprise.config.lock_anonymous_git_access` | A site admin locks anonymous Git read access to prevent repository admins from changing existing anonymous Git read access settings for repositories on the instance. For more information, see "[Preventing users from changing anonymous Git read access](/enterprise/{{ currentVersion }}/admin/guides/user-management/preventing-users-from-changing-anonymous-git-read-access)."
-`enterprise.config.unlock_anonymous_git_access` | A site admin unlocks anonymous Git read access to allow repository admins to change existing anonymous Git read access settings for repositories on the instance. For more information, see "[Preventing users from changing anonymous Git read access](/enterprise/{{ currentVersion }}/admin/guides/user-management/preventing-users-from-changing-anonymous-git-read-access)."
+`business.update_member_repository_creation_permission` | A site admin restricts repository creation in organizations in the enterprise. For more information, see "[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#setting-a-policy-for-repository-creation)."
+`business.clear_members_can_create_repos` | A site admin clears a restriction on repository creation in organizations in the enterprise. For more information, see "[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#setting-a-policy-for-repository-creation)."
+`enterprise.config.lock_anonymous_git_access` | A site admin locks anonymous Git read access to prevent repository admins from changing existing anonymous Git read access settings for repositories in the enterprise. For more information, see "[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)."
+`enterprise.config.unlock_anonymous_git_access` | A site admin unlocks anonymous Git read access to allow repository admins to change existing anonymous Git read access settings for repositories in the enterprise. For more information, see "[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)."
#### Issues and pull requests
@@ -55,15 +56,15 @@ Name | Description
`issue.update` | An issue's body text (initial comment) changed.
`issue_comment.update` | A comment on an issue (other than the initial one) changed.
`pull_request_review_comment.delete` | A comment on a pull request was deleted.
-`issue.destroy` | An issue was deleted from the repository. For more information, see "[Deleting an issue](/enterprise/{{ currentVersion }}/user/articles/deleting-an-issue)."
+`issue.destroy` | An issue was deleted from the repository. For more information, see "[Deleting an issue](/github/managing-your-work-on-github/deleting-an-issue)."
#### Organizations
Name | Description
------------------:| ----------------------------------------------------------
`org.async_delete` | A user initiated a background job to delete an organization.
-`org.delete` | An organization was deleted by a user-initiated background job.
-`org.transform` | A user account was converted into an organization. For more information, see [Converting a user into an organization](/enterprise/{{ currentVersion}}/user/articles/converting-a-user-into-an-organization/).
+`org.delete` | An organization was deleted by a user-initiated background job.{% if currentVersion != "github-ae@latest" %}
+`org.transform` | A user account was converted into an organization. For more information, see "[Converting a user into an organization](/github/setting-up-and-managing-your-github-user-account/converting-a-user-into-an-organization)."{% endif %}
#### Protected branches
@@ -72,7 +73,7 @@ Name | Description
`protected_branch.create ` | Branch protection is enabled on a branch.
`protected_branch.destroy` | Branch protection is disabled on a branch.
`protected_branch.update_admin_enforced ` | Branch protection is enforced for repository administrators.
-`protected_branch.update_require_code_owner_review ` | Enforcement of required Code Owner review is updated on a branch.
+`protected_branch.update_require_code_owner_review ` | Enforcement of required code owner review is updated on a branch.
`protected_branch.dismiss_stale_reviews ` | Enforcement of dismissing stale pull requests is updated on a branch.
`protected_branch.update_signature_requirement_enforcement_level ` | Enforcement of required commit signing is updated on a branch.
`protected_branch.update_pull_request_reviews_enforcement_level ` | Enforcement of required pull request reviews is updated on a branch.
@@ -85,7 +86,7 @@ Name | Description
Name | Description
---------------------:| -------------------------------------------------------
`repo.access` | A private repository was made public, or a public repository was made private.
-`repo.archive` | A repository was archived. For more information, see [Archiving and unarchiving repositories](/enterprise/{{ currentVersion }}/admin/guides/user-management/archiving-and-unarchiving-repositories/).
+`repo.archive` | A repository was archived. For more information, see "[Archiving a {% data variables.product.prodname_dotcom %} repository](/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository)."
`repo.add_member` | A collaborator was added to a repository.
`repo.config` | A site admin blocked force pushes. For more information, see [Blocking force pushes to a repository](/enterprise/{{ currentVersion }}/admin/guides/developer-workflow/blocking-force-pushes-to-a-repository/) to a repository.
`repo.create` | A repository was created.
@@ -94,7 +95,7 @@ Name | Description
`repo.rename` | A repository was renamed.
`repo.transfer` | A user accepted a request to receive a transferred repository.
`repo.transfer_start` | A user sent a request to transfer a repository to another user or organization.
-`repo.unarchive` | A repository was unarchived. For more information, see [Archiving and unarchiving repositories](/enterprise/{{ currentVersion }}/admin/guides/user-management/archiving-and-unarchiving-repositories/).
+`repo.unarchive` | A repository was unarchived. For more information, see "[Archiving a {% data variables.product.prodname_dotcom %} repository](/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository)."
`repo.config.disable_anonymous_git_access`| Anonymous Git read access is disabled for a public repository. For more information, see "[Enabling anonymous Git read access for a repository](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository)."
`repo.config.enable_anonymous_git_access` | Anonymous Git read access is enabled for a public repository. For more information, see "[Enabling anonymous Git read access for a repository](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository)."
`repo.config.lock_anonymous_git_access` | A repository's anonymous Git read access setting is locked, preventing repository administrators from changing (enabling or disabling) this setting. For more information, see "[Preventing users from changing anonymous Git read access](/enterprise/{{ currentVersion }}/admin/guides/user-management/preventing-users-from-changing-anonymous-git-read-access)."
@@ -106,7 +107,7 @@ Name | Description
-----------------------------:| -----------------------------------------------
`staff.disable_repo` | A site admin disabled access to a repository and all of its forks.
`staff.enable_repo` | A site admin re-enabled access to a repository and all of its forks.
-`staff.fake_login` | A site admin signed into {% data variables.product.prodname_enterprise %} as another user.
+`staff.fake_login` | A site admin signed into {% data variables.product.product_name %} as another user.
`staff.repo_unlock` | A site admin unlocked (temporarily gained full access to) one of a user's private repositories.
`staff.unlock` | A site admin unlocked (temporarily gained full access to) all of a user's private repositories.
@@ -123,18 +124,18 @@ Name | Description
Name | Description
---------------------------------:| -------------------------------------------
`user.add_email` | An email address was added to a user account.
-`user.async_delete` | An asynchronous job was started to destroy a user account, eventually triggering `user.delete`.
-`user.change_password` | A user changed his or her password.
+`user.async_delete` | An asynchronous job was started to destroy a user account, eventually triggering `user.delete`.{% if enterpriseServerVersions contains currentVersion %}
+`user.change_password` | A user changed his or her password.{% endif %}
`user.create` | A new user account was created.
`user.delete` | A user account was destroyed by an asynchronous job.
`user.demote` | A site admin was demoted to an ordinary user account.
-`user.destroy` | A user deleted his or her account, triggering `user.async_delete`.
+`user.destroy` | A user deleted his or her account, triggering `user.async_delete`.{% if enterpriseServerVersions contains currentVersion %}
`user.failed_login` | A user tried to sign in with an incorrect username, password, or two-factor authentication code.
-`user.forgot_password` | A user requested a password reset via the sign-in page.
+`user.forgot_password` | A user requested a password reset via the sign-in page.{% endif %}
`user.login` | A user signed in.
`user.promote` | An ordinary user account was promoted to a site admin.
`user.remove_email` | An email address was removed from a user account.
`user.rename` | A username was changed.
-`user.suspend` | A user account was suspended by a site admin.
-`user.two_factor_requested` | A user was prompted for a two-factor authentication code.
+`user.suspend` | A user account was suspended by a site admin.{% if enterpriseServerVersions contains currentVersion %}
+`user.two_factor_requested` | A user was prompted for a two-factor authentication code.{% endif %}
`user.unsuspend` | A user account was unsuspended by a site admin.
diff --git a/content/admin/user-management/auditing-ssh-keys.md b/content/admin/user-management/auditing-ssh-keys.md
index bb55a3ae1ef0..fca0dbe5be6b 100644
--- a/content/admin/user-management/auditing-ssh-keys.md
+++ b/content/admin/user-management/auditing-ssh-keys.md
@@ -6,6 +6,7 @@ redirect_from:
- /enterprise/admin/user-management/auditing-ssh-keys
versions:
enterprise-server: '*'
+ github-ae: '*'
---
Once initiated, the audit disables all existing SSH keys and forces users to approve or reject them before they're able to clone, pull, or push to any repositories. An audit is useful in situations where an employee or contractor leaves the company and you need to ensure that all keys are verified.
diff --git a/content/admin/user-management/auditing-users-across-your-instance.md b/content/admin/user-management/auditing-users-across-your-enterprise.md
similarity index 77%
rename from content/admin/user-management/auditing-users-across-your-instance.md
rename to content/admin/user-management/auditing-users-across-your-enterprise.md
index 77c0ae1d15fb..015fe8c7a20d 100644
--- a/content/admin/user-management/auditing-users-across-your-instance.md
+++ b/content/admin/user-management/auditing-users-across-your-enterprise.md
@@ -1,29 +1,30 @@
---
-title: Auditing users across your instance
-intro: 'The {% data variables.product.prodname_ghe_server %} audit log dashboard shows site administrators the actions performed by all users and organizations across {% data variables.product.product_location_enterprise %} within the past 90 days. It includes details such as who performed the action, what the action was, and when it was performed.'
+title: Auditing users across your enterprise
+intro: 'The audit log dashboard shows site administrators the actions performed by all users and organizations across your enterprise within the past 90 days, including details such as who performed the action, what the action was, and when the action was performed.'
redirect_from:
- /enterprise/admin/guides/user-management/auditing-users-across-an-organization/
- /enterprise/admin/user-management/auditing-users-across-your-instance
+ - /admin/user-management/auditing-users-across-your-instance
versions:
enterprise-server: '*'
+ github-ae: '*'
---
-### Accessing the {% data variables.product.prodname_ghe_server %} audit log
+### Accessing the audit log
-The audit log dashboard gives you a visual display of audit data across {% data variables.product.product_location_enterprise %}.
+The audit log dashboard gives you a visual display of audit data across your enterprise.
-{% data reusables.enterprise_site_admin_settings.access-settings %}
-{% data reusables.enterprise_site_admin_settings.business %}
+{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.audit-log-tab %}
Within the map, you can pan and zoom to see events around the world. Hover over a country to see a quick count of events from that country.
-### Searching for events across your instance
+### Searching for events across your enterprise
-The audit log lists the following information about actions made within {% data variables.product.product_location_enterprise %}:
+The audit log lists the following information about actions made within your enterprise:
* [The repository](#search-based-on-the-repository) an action was performed in
* [The user](#search-based-on-the-user) who performed the action
@@ -36,7 +37,7 @@ The audit log lists the following information about actions made within {% data
**Notes:**
-- While you can't use text to search for audit entries, you can construct search queries using a variety of filters. Many operators for [searching across {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/user/articles/searching-github) are supported.
+- While you can't use text to search for audit entries, you can construct search queries using a variety of filters. {% data variables.product.product_name %} supports many operators for searching across {% data variables.product.product_name %}. For more information, see "[About searching on {% data variables.product.prodname_dotcom %}](/github/searching-for-information-on-github/about-searching-on-github)."
- To search for events older than 90 days, use the `created` qualifier.
{% endwarning %}
@@ -59,19 +60,19 @@ The `actor` qualifier scopes events based on the member of your organization tha
* `actor:octocat actor:hubot` finds all events performed by both `octocat` and `hubot`.
* `-actor:hubot` excludes all events performed by `hubot`.
-You can only use a {% data variables.product.prodname_ghe_server %} username, not an individual's real name.
+You can only use a {% data variables.product.product_name %} username, not an individual's real name.
#### Search based on the organization
The `org` qualifier limits actions to a specific organization. For example:
-* `org:my-org` finds all events that occured for the `my-org` organization.
+* `org:my-org` finds all events that occurred for the `my-org` organization.
* `org:my-org action:team` finds all team events performed within the `my-org` organization.
-* `-org:my-org` excludes all events that occured for the `my-org` organization.
+* `-org:my-org` excludes all events that occurred for the `my-org` organization.
#### Search based on the action performed
-The `action` qualifier searches for specific events, grouped within categories. For information on the events associated with these categories, see "[Audited actions](/enterprise/{{ currentVersion }}/admin/guides/installation/audited-actions)".
+The `action` qualifier searches for specific events, grouped within categories. For information on the events associated with these categories, see "[Audited actions](/admin/user-management/audited-actions)".
| Category name | Description
|------------------|-------------------
diff --git a/content/admin/user-management/best-practices-for-user-security.md b/content/admin/user-management/best-practices-for-user-security.md
index f8f302a33586..beae6174be88 100644
--- a/content/admin/user-management/best-practices-for-user-security.md
+++ b/content/admin/user-management/best-practices-for-user-security.md
@@ -1,21 +1,24 @@
---
title: Best practices for user security
-intro: 'Outside of instance-level security measures (SSL, subdomain isolation, configuring a firewall) that a site administrator can implement, there are steps your users can take to help protect {% data variables.product.product_location_enterprise %}.'
+intro: '{% if enterpriseServerVersions contains currentVersion %}Outside of instance-level security measures (SSL, subdomain isolation, configuring a firewall) that a site administrator can implement, there {% else %}There {% endif %}are steps your users can take to help protect your enterprise.'
redirect_from:
- /enterprise/admin/user-management/best-practices-for-user-security
versions:
enterprise-server: '*'
+ github-ae: '*'
---
+{% if enterpriseServerVersions contains currentVersion %}
### Enabling two-factor authentication
Two-factor authentication (2FA) is a way of logging in to websites and services that requires a second factor beyond a password for authentication. In {% data variables.product.prodname_ghe_server %}'s case, this second factor is a one time authentication code generated by an application on a user's smartphone. We strongly recommend requiring your users to enable two-factor authentication on their accounts. With two-factor authentication, both a user's password and their smartphone would have to be compromised to allow the account itself to be compromised.
For more information on configuring two-factor authentication, see "[About two-factor authentication](/enterprise/{{ currentVersion }}/user/articles/about-two-factor-authentication)".
+{% endif %}
### Requiring a password manager
-We strongly recommend requiring your users to install and use a password manager--such as [LastPass](https://lastpass.com/), [1Password](https://1password.com/), or [Keeper](https://keepersecurity.com/)--on any computer they use to connect to {% data variables.product.product_location_enterprise %}. Doing so ensures that passwords are stronger and much less likely to be compromised or stolen.
+We strongly recommend requiring your users to install and use a password manager--such as [LastPass](https://lastpass.com/), [1Password](https://1password.com/), or [Keeper](https://keepersecurity.com/)--on any computer they use to connect to your enterprise. Doing so ensures that passwords are stronger and much less likely to be compromised or stolen.
### Restrict access to teams and repositories
diff --git a/content/admin/user-management/configuring-git-large-file-storage-for-your-enterprise.md b/content/admin/user-management/configuring-git-large-file-storage-for-your-enterprise.md
index 7495a0d08839..e51686cb1fbb 100644
--- a/content/admin/user-management/configuring-git-large-file-storage-for-your-enterprise.md
+++ b/content/admin/user-management/configuring-git-large-file-storage-for-your-enterprise.md
@@ -14,11 +14,12 @@ redirect_from:
- /enterprise/admin/user-management/configuring-git-large-file-storage-for-your-enterprise
versions:
enterprise-server: '*'
+ github-ae: '*'
---
### About {% data variables.large_files.product_name_long %}
-{% data reusables.enterprise_site_admin_settings.configuring-large-file-storage-short-description %} You can use {% data variables.large_files.product_name_long %} with a single repository, all of your personal or organization repositories, or with every repository in {% data variables.product.product_location_enterprise %}. Before you can enable {% data variables.large_files.product_name_short %} for specific repositories or organizations, you need to enable {% data variables.large_files.product_name_short %} for your appliance.
+{% data reusables.enterprise_site_admin_settings.configuring-large-file-storage-short-description %} You can use {% data variables.large_files.product_name_long %} with a single repository, all of your personal or organization repositories, or with every repository in your enterprise. Before you can enable {% data variables.large_files.product_name_short %} for specific repositories or organizations, you need to enable {% data variables.large_files.product_name_short %} for your enterprise.
{% data reusables.large_files.storage_assets_location %}
{% data reusables.large_files.rejected_pushes %}
@@ -27,11 +28,10 @@ For more information, see "[About {% data variables.large_files.product_name_lon
{% data reusables.large_files.can-include-lfs-objects-archives %}
-### Configuring {% data variables.large_files.product_name_long %} for your appliance
+### Configuring {% data variables.large_files.product_name_long %} for your enterprise
-{% data reusables.enterprise_site_admin_settings.access-settings %}
-{% data reusables.enterprise_site_admin_settings.business %}
-{% if currentVersion ver_gt "enterprise-server@2.21" %}
+{% data reusables.enterprise-accounts.access-enterprise %}
+{% if currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}
{% data reusables.enterprise-accounts.policies-tab %}
{% else %}
{% data reusables.enterprise-accounts.settings-tab %}
@@ -60,12 +60,13 @@ For more information, see "[About {% data variables.large_files.product_name_lon
{% data reusables.enterprise_site_admin_settings.admin-tab %}
{% data reusables.enterprise_site_admin_settings.git-lfs-toggle %}
+{% if enterpriseServerVersions contains currentVersion %}
### Configuring Git Large File Storage to use a third party server
{% data reusables.large_files.storage_assets_location %}
{% data reusables.large_files.rejected_pushes %}
-1. Disable {% data variables.large_files.product_name_short %} on the {% data variables.product.prodname_ghe_server %} appliance. For more information, see "[Configuring {% data variables.large_files.product_name_long %}](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-git-large-file-storage#configuring-git-large-file-storage-for-your-appliance)."
+1. Disable {% data variables.large_files.product_name_short %} on {% data variables.product.product_location %}. For more information, see "[Configuring {% data variables.large_files.product_name_long %} for your enterprise](#configuring-git-large-file-storage-for-your-enterprise)."
2. Create a {% data variables.large_files.product_name_short %} configuration file that points to the third party server.
```shell
@@ -130,6 +131,7 @@ Before migrating to a different {% data variables.large_files.product_name_long
> Pushing objects...
> Git LFS: (16 of 16 files) 48.00 MB / 48.85 MB, 879.10 KB skipped
```
+{% endif %}
### Further reading
diff --git a/content/admin/user-management/configuring-visibility-for-organization-membership.md b/content/admin/user-management/configuring-visibility-for-organization-membership.md
index 0873ac32c047..6551ad31f8f0 100644
--- a/content/admin/user-management/configuring-visibility-for-organization-membership.md
+++ b/content/admin/user-management/configuring-visibility-for-organization-membership.md
@@ -1,17 +1,19 @@
---
title: Configuring visibility for organization membership
-intro: You can set visibility for new organization members across your instance to public or private. You can also prevent members from changing their visibility from the default.
+intro: You can set visibility for new organization members across your enterprise to public or private. You can also prevent members from changing their visibility from the default.
redirect_from:
- /enterprise/admin/user-management/configuring-visibility-for-organization-membership
versions:
enterprise-server: '*'
+ github-ae: '*'
---
+{% if enterpriseServerVersions contains currentVersion %}
You can also enforce your default setting on all current organization members in your instance using a command-line utility. For example, if you'd like to require every organization member's visibility to be public, you can set the default to public and enforce the default for all new members in the admin settings, and then use the command-line utility to enforce the public setting on existing members.
+{% endif %}
-{% data reusables.enterprise_site_admin_settings.access-settings %}
-{% data reusables.enterprise_site_admin_settings.business %}
-{% if currentVersion ver_gt "enterprise-server@2.21" %}
+{% data reusables.enterprise-accounts.access-enterprise %}
+{% if currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}
{% data reusables.enterprise-accounts.policies-tab %}
{% else %}
{% data reusables.enterprise-accounts.settings-tab %}
@@ -20,5 +22,5 @@ You can also enforce your default setting on all current organization members in
3. Under "Default organization membership visibility", use the drop-down menu, and click **Private** or **Public**.
4. Optionally, to prevent members from changing their membership visibility from the default, select **Enforce on organization members**.
- 
-5. If you'd like to enforce your new visibility setting on all existing members, use the `ghe-org-membership-update` command-line utility. For more information, see "[Command-line utilities](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-org-membership-update)."
+ {% if enterpriseServerVersions contains currentVersion %}
+5. If you'd like to enforce your new visibility setting on all existing members, use the `ghe-org-membership-update` command-line utility. For more information, see "[Command-line utilities](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-org-membership-update)."{% endif %}
diff --git a/content/admin/user-management/continuous-integration-using-jenkins.md b/content/admin/user-management/continuous-integration-using-jenkins.md
index 35d8001b84af..8f1ebe6bdabd 100644
--- a/content/admin/user-management/continuous-integration-using-jenkins.md
+++ b/content/admin/user-management/continuous-integration-using-jenkins.md
@@ -1,6 +1,6 @@
---
title: Continuous integration using Jenkins
-intro: 'You can automatically trigger build jobs on a Jenkins server when pushes are made to a repository in {% data variables.product.product_location_enterprise %}.'
+intro: 'You can automatically trigger build jobs on a Jenkins server when pushes are made to a repository in {% data variables.product.product_location %}.'
redirect_from:
- /enterprise/admin/developer-workflow/continuous-integration-using-jenkins
- /enterprise/admin/user-management/continuous-integration-using-jenkins
@@ -10,4 +10,4 @@ versions:
### Requirements
-- Follow our white paper "[Practical guide to CI with Jenkins and GitHub](https://resources.github.com/whitepapers/practical-guide-to-CI-with-Jenkins-and-GitHub/)" to get step by step instructions on how you can automatically trigger build jobs on a Jenkins server when pushes are made to a repository in {% data variables.product.product_location_enterprise %}.
+- Follow our white paper "[Practical guide to CI with Jenkins and GitHub](https://resources.github.com/whitepapers/practical-guide-to-CI-with-Jenkins-and-GitHub/)" to get step by step instructions on how you can automatically trigger build jobs on a Jenkins server when pushes are made to a repository in {% data variables.product.product_location %}.
diff --git a/content/admin/user-management/creating-organizations.md b/content/admin/user-management/creating-organizations.md
deleted file mode 100644
index a8cc4bad3ab0..000000000000
--- a/content/admin/user-management/creating-organizations.md
+++ /dev/null
@@ -1,22 +0,0 @@
----
-title: Creating organizations
-redirect_from:
- - /enterprise/admin/articles/creating-organizations/
- - /enterprise/admin/user-management/creating-organizations
-intro: You can choose to set up a new organization or convert an existing personal account into an organization.
-versions:
- enterprise-server: '*'
----
-
-An organization is a collection of user accounts that owns repositories. Organizations have one or more owners, who have administrative privileges for the organization. Organizations can also be used for namespacing—for example, `http(s)://[hostname]/[organization name]/` takes you to an organization's profile on {% data variables.product.prodname_ghe_server %}, while `http(s)://[hostname]/[organization name]/[repository name]/` takes you to a repository's profile.
-
-When you create an organization, it doesn't have any repositories associated with it. At any time, [members of the organization with the Owner role can add new repositories](/enterprise/{{ currentVersion }}/user/articles/permission-levels-for-an-organization), or transfer existing repositories. For more information, see "[Transferring a repository](/enterprise/{{ currentVersion }}/user/articles/transferring-a-repository)".
-
-{% data reusables.user_settings.access_settings %}
-{% data reusables.user_settings.organizations %}
-3. In the "Organizations" section, click **New organization**.
-
-4. Under "Organization name", give the organization a name.
-
-5. Under "Contact email," type the email address of a person who can be contacted for more information about the organization.
-6. Click **Create organization**.
diff --git a/content/admin/user-management/creating-teams.md b/content/admin/user-management/creating-teams.md
index b62f0cf36a2e..96c25bbb5a35 100644
--- a/content/admin/user-management/creating-teams.md
+++ b/content/admin/user-management/creating-teams.md
@@ -9,7 +9,7 @@ versions:
Teams are central to many of {% data variables.product.prodname_dotcom %}'s collaborative features, such as team @mentions to notify appropriate parties that you'd like to request their input or attention. For more information, see "[Permission levels for an organization repository](/enterprise/{{ currentVersion }}/user/articles/repository-permission-levels-for-an-organization/)".
-A team can represent a group within your company or include people with certain interests or expertise. For example, a team of accessibility experts on {% data variables.product.product_location_enterprise %} could comprise of people from several different departments. Teams can represent functional concerns that complement a company's existing divisional hierarchy.
+A team can represent a group within your company or include people with certain interests or expertise. For example, a team of accessibility experts on {% data variables.product.product_location %} could comprise of people from several different departments. Teams can represent functional concerns that complement a company's existing divisional hierarchy.
Organizations can create multiple levels of nested teams to reflect a company or group's hierarchy structure. For more information, see "[About teams](/enterprise/{{ currentVersion }}/user/articles/about-teams/#nested-teams)."
@@ -28,7 +28,7 @@ A prudent combination of teams is a powerful way to control repository access. F
### Creating teams with LDAP Sync enabled
-Instances using LDAP for user authentication can use LDAP Sync to manage a team's members. Setting the group's **Distinguished Name** (DN) in the **LDAP group** field will map a team to an LDAP group on your LDAP server. If you use LDAP Sync to manage a team's members, you won't be able to manage your team within {% data variables.product.product_location_enterprise %}. The mapped team will sync its members in the background and periodically at the interval configured when LDAP Sync is enabled. For more information, see "[Enabling LDAP Sync](/enterprise/admin/authentication/using-ldap#enabling-ldap-sync)."
+Instances using LDAP for user authentication can use LDAP Sync to manage a team's members. Setting the group's **Distinguished Name** (DN) in the **LDAP group** field will map a team to an LDAP group on your LDAP server. If you use LDAP Sync to manage a team's members, you won't be able to manage your team within {% data variables.product.product_location %}. The mapped team will sync its members in the background and periodically at the interval configured when LDAP Sync is enabled. For more information, see "[Enabling LDAP Sync](/enterprise/admin/authentication/using-ldap#enabling-ldap-sync)."
{% data reusables.enterprise_user_management.ldap-sync-nested-teams %}
diff --git a/content/admin/user-management/customizing-user-messages-on-your-instance.md b/content/admin/user-management/customizing-user-messages-for-your-enterprise.md
similarity index 73%
rename from content/admin/user-management/customizing-user-messages-on-your-instance.md
rename to content/admin/user-management/customizing-user-messages-for-your-enterprise.md
index de338b68953e..13c67d3865b4 100644
--- a/content/admin/user-management/customizing-user-messages-on-your-instance.md
+++ b/content/admin/user-management/customizing-user-messages-for-your-enterprise.md
@@ -1,15 +1,18 @@
---
-title: Customizing user messages on your instance
+title: Customizing user messages for your enterprise
redirect_from:
- /enterprise/admin/user-management/creating-a-custom-sign-in-message/
- /enterprise/admin/user-management/customizing-user-messages-on-your-instance
-intro: 'You can create custom messages that users will see on the sign in and sign out pages{% if currentVersion ver_gt "enterprise-server@2.21" %} or in an announcement banner at the top of every page{% endif %}.'
+ - /admin/user-management/customizing-user-messages-on-your-instance
+intro: 'You can create custom messages that users will see on the{% if enterpriseServerVersions contains currentVersion %} sign in and sign out pages{% else %} sign out page{% endif %}{% if currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %} or in an announcement banner at the top of every page{% endif %}.'
versions:
enterprise-server: '*'
+ github-ae: '*'
---
You can use Markdown to format your message. For more information, see "[About writing and formatting on {% data variables.product.prodname_dotcom %}](/articles/about-writing-and-formatting-on-github/)."
+{% if enterpriseServerVersions contains currentVersion %}
{% note %}
**Note:** If you are using SAML for authentication, the sign in page is presented by your identity provider and is not customizable via {% data variables.product.prodname_ghe_server %}.
@@ -18,8 +21,7 @@ You can use Markdown to format your message. For more information, see "[About w
### Creating a custom sign in message
-{% data reusables.enterprise_site_admin_settings.access-settings %}
-{% data reusables.enterprise_site_admin_settings.business %}
+{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.messages-tab %}
5. Under "Sign in page", click **Add message** or **Edit message**.
@@ -31,11 +33,11 @@ You can use Markdown to format your message. For more information, see "[About w
8. Review the rendered message.
{% data reusables.enterprise_site_admin_settings.save-changes %}
+{% endif %}
### Creating a custom sign out message
-{% data reusables.enterprise_site_admin_settings.access-settings %}
-{% data reusables.enterprise_site_admin_settings.business %}
+{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.messages-tab %}
5. Under "Sign out page", click **Add message** or **Edit message**.
@@ -48,15 +50,22 @@ You can use Markdown to format your message. For more information, see "[About w
{% data reusables.enterprise_site_admin_settings.save-changes %}
-{% if currentVersion ver_gt "enterprise-server@2.21" %}
+{% if currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}
### Creating a global announcement banner
You can set a global announcement banner to be displayed to all users at the top of every page.
+{% if currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
+
+You can also set an announcement banner{% if enterpriseServerVersions contains currentVersion %} in the administrative shell using a command line utility or{% endif %} using the API. For more information, see {% if enterpriseServerVersions contains currentVersion %}"[Command-line utilities](/enterprise/admin/configuration/command-line-utilities#ghe-announce)" and {% endif %}"[{% data variables.product.prodname_enterprise %} administration](/rest/reference/enterprise-admin#announcements)."
+
+{% else %}
+
You can also set an announcement banner in the administrative shell using a command line utility. For more information, see "[Command-line utilities](/enterprise/admin/configuration/command-line-utilities#ghe-announce)."
-{% data reusables.enterprise_site_admin_settings.access-settings %}
-{% data reusables.enterprise_site_admin_settings.business %}
+{% endif %}
+
+{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.messages-tab %}
1. Under "Announcement", click **Add announcement**.
diff --git a/content/admin/user-management/disabling-git-ssh-access-on-github-enterprise-server.md b/content/admin/user-management/disabling-git-ssh-access-on-your-enterprise.md
similarity index 87%
rename from content/admin/user-management/disabling-git-ssh-access-on-github-enterprise-server.md
rename to content/admin/user-management/disabling-git-ssh-access-on-your-enterprise.md
index 3271821eb9ed..1578faba94f5 100644
--- a/content/admin/user-management/disabling-git-ssh-access-on-github-enterprise-server.md
+++ b/content/admin/user-management/disabling-git-ssh-access-on-your-enterprise.md
@@ -1,5 +1,5 @@
---
-title: Disabling Git SSH access on GitHub Enterprise Server
+title: Disabling Git SSH access on your enterprise
redirect_from:
- /enterprise/admin/hidden/disabling-ssh-access-for-a-user-account/
- /enterprise/admin/articles/disabling-ssh-access-for-a-user-account/
@@ -12,9 +12,11 @@ redirect_from:
- /enterprise/admin/guides/installation/disabling-git-ssh-access-on-github-enterprise/
- /enterprise/admin/installation/disabling-git-ssh-access-on-github-enterprise-server
- /enterprise/admin/user-management/disabling-git-ssh-access-on-github-enterprise-server
-intro: 'You can prevent people from using Git over SSH for certain or all repositories on {% data variables.product.product_location_enterprise %}.'
+ - /admin/user-management/disabling-git-ssh-access-on-github-enterprise-server
+intro: 'You can prevent people from using Git over SSH for certain or all repositories on your enterprise.'
versions:
enterprise-server: '*'
+ github-ae: '*'
---
### Disabling Git SSH access to a specific repository
@@ -41,11 +43,10 @@ versions:
7. Under "Git SSH access", use the drop-down menu, and click **Disabled**. Then, select **Enforce on all repositories**.
-### Disabling Git SSH access to all repositories on an appliance
+### Disabling Git SSH access to all repositories in your enterprise
-{% data reusables.enterprise_site_admin_settings.access-settings %}
-{% data reusables.enterprise_site_admin_settings.business %}
-{% if currentVersion ver_gt "enterprise-server@2.21" %}
+{% data reusables.enterprise-accounts.access-enterprise %}
+{% if currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}
{% data reusables.enterprise-accounts.policies-tab %}
{% else %}
{% data reusables.enterprise-accounts.settings-tab %}
diff --git a/content/admin/user-management/exporting-migration-data-from-your-enterprise.md b/content/admin/user-management/exporting-migration-data-from-your-enterprise.md
index aec6a820ffc8..da606dbe919c 100644
--- a/content/admin/user-management/exporting-migration-data-from-your-enterprise.md
+++ b/content/admin/user-management/exporting-migration-data-from-your-enterprise.md
@@ -86,7 +86,7 @@ versions:
```
* {% data reusables.enterprise_migrations.specify-staging-path %}
-8. Close the connection to {% data variables.product.product_location_enterprise %}:
+8. Close the connection to {% data variables.product.product_location %}:
```shell
$ exit
> logout
diff --git a/content/admin/user-management/index.md b/content/admin/user-management/index.md
index 8a7ef8f23fd3..73f06725687e 100644
--- a/content/admin/user-management/index.md
+++ b/content/admin/user-management/index.md
@@ -1,15 +1,16 @@
---
title: 'Managing users, organizations, and repositories'
shortTitle: 'Managing users, organizations, and repositories'
+intro: 'This guide describes authentication methods for users signing in to your enterprise, how to create organizations and teams for repository access and collaboration, and suggested best practices for user security.'
redirect_from:
- /enterprise/admin/categories/user-management/
- /enterprise/admin/developer-workflow/using-webhooks-for-continuous-integration
- /enterprise/admin/migrations
- /enterprise/admin/clustering
- /enterprise/admin/user-management
-intro: 'This guide describes authentication methods for users signing in to your {% data variables.product.prodname_enterprise %} instance, how to create organizations and teams for repository access and collaboration, and suggested best practices for user security.'
versions:
enterprise-server: '*'
+ github-ae: '*'
---
@@ -18,17 +19,15 @@ versions:
{% topic_link_in_list /managing-users-in-your-enterprise %}
{% link_in_list /promoting-or-demoting-a-site-administrator %}
{% link_in_list /best-practices-for-user-security %}
- {% link_in_list /auditing-users-across-your-instance %}
+ {% link_in_list /auditing-users-across-your-enterprise %}
{% link_in_list /managing-dormant-users %}
{% link_in_list /suspending-and-unsuspending-users %}
{% link_in_list /placing-a-legal-hold-on-a-user-or-organization %}
{% link_in_list /auditing-ssh-keys %}
- {% link_in_list /customizing-user-messages-on-your-instance %}
- {% link_in_list /configuring-email-for-notifications %}
+ {% link_in_list /customizing-user-messages-for-your-enterprise %}
{% link_in_list /rebuilding-contributions-data %}
{% link_in_list /managing-global-webhooks %}
{% topic_link_in_list /managing-organizations-in-your-enterprise %}
- {% link_in_list /creating-organizations %}
{% link_in_list /configuring-visibility-for-organization-membership %}
{% link_in_list /preventing-users-from-creating-organizations %}
{% link_in_list /requiring-two-factor-authentication-for-an-organization %}
@@ -40,7 +39,7 @@ versions:
{% topic_link_in_list /managing-repositories-in-your-enterprise %}
{% link_in_list /configuring-git-large-file-storage-for-your-enterprise %}
{% link_in_list /migrating-to-internal-repositories %}
- {% link_in_list /disabling-git-ssh-access-on-github-enterprise-server %}
+ {% link_in_list /disabling-git-ssh-access-on-your-enterprise %}
{% link_in_list /troubleshooting-service-hooks %}
{% topic_link_in_list /monitoring-activity-in-your-enterprise %}
{% link_in_list /activity-dashboard %}
@@ -48,6 +47,7 @@ versions:
{% link_in_list /searching-the-audit-log %}
{% link_in_list /audited-actions %}
{% link_in_list /viewing-push-logs %}
+ {% link_in_list /log-forwarding %}
{% topic_link_in_list /migrating-data-to-and-from-your-enterprise %}
{% link_in_list /about-migrations %}
{% link_in_list /exporting-migration-data-from-your-enterprise %}
diff --git a/content/admin/user-management/log-forwarding.md b/content/admin/user-management/log-forwarding.md
new file mode 100644
index 000000000000..00ad4741f35e
--- /dev/null
+++ b/content/admin/user-management/log-forwarding.md
@@ -0,0 +1,47 @@
+---
+title: Log forwarding
+intro: '{% data variables.product.product_name %} uses `syslog-ng` to forward {% if enterpriseServerVersions contains currentVersion %}system{% elsif currentVersion == "github-ae@latest" %}Git{% endif %} and application logs to the server you specify.'
+redirect_from:
+ - /enterprise/admin/articles/log-forwarding/
+ - /enterprise/admin/installation/log-forwarding
+ - /enterprise/admin/enterprise-management/log-forwarding
+ - /admin/enterprise-management/log-forwarding
+versions:
+ enterprise-server: '*'
+ github-ae: '*'
+---
+Any log collection system that supports syslog-style log streams is supported (e.g., [Logstash](http://logstash.net/) and [Splunk](http://docs.splunk.com/Documentation/Splunk/latest/Data/Monitornetworkports)).
+
+### Enabling log forwarding
+
+{% if enterpriseServerVersions contains currentVersion %}
+1. On the {% data variables.enterprise.management_console %} settings page, in the left sidebar, click **Monitoring**.
+1. Select **Enable log forwarding**.
+1. In the **Server address** field, type the address of the server to which you want to forward logs. You can specify multiple addresses in a comma-separated list.
+1. In the Protocol drop-down menu, select the protocol to use to communicate with the log server. The protocol will apply to all specified log destinations.
+1. Select **Enable TLS**.
+1. Click **Choose File** and choose a CA certificate to encrypt communication between syslog endpoints. The entire certificate chain will be validated, and must terminate in a root certificate. For more information, see [TLS options in the syslog-ng documentation](https://support.oneidentity.com/technical-documents/syslog-ng-open-source-edition/3.16/administration-guide/56#TOPIC-956599).
+{% elsif currentVersion == "github-ae@latest" %}
+{% data reusables.enterprise-accounts.access-enterprise %}
+{% data reusables.enterprise-accounts.settings-tab %}
+1. Under {% octicon "gear" aria-label="The Settings gear" %} **Settings**, click **Log forwarding**.
+ 
+1. Under "Log forwarding", select **Enable log forwarding**.
+ 
+1. Under "Server address", enter the address of the server you want to forward logs to.
+ 
+1. Use the "Protocol" drop-down menu, and select a protocol.
+ 
+1. Optionally, to enable TLS encrypted communication between syslog endpoints, select **Enable TLS**.
+ 
+1. Under "Public certificate", paste your x509 certificate.
+ 
+1. Click **Save**.
+ 
+{% endif %}
+
+{% if enterpriseServerVersions contains currentVersion %}
+### Troubleshooting
+
+If you run into issues with log forwarding, contact {% data variables.contact.contact_ent_support %} and attach the output file from `http(s)://[hostname]/setup/diagnostics` to your email.
+{% endif %}
diff --git a/content/admin/user-management/managing-dormant-users.md b/content/admin/user-management/managing-dormant-users.md
index dce1f1f015e8..9aaaccfb90aa 100644
--- a/content/admin/user-management/managing-dormant-users.md
+++ b/content/admin/user-management/managing-dormant-users.md
@@ -5,16 +5,17 @@ redirect_from:
- /enterprise/admin/articles/viewing-dormant-users/
- /enterprise/admin/articles/determining-whether-a-user-account-is-dormant/
- /enterprise/admin/user-management/managing-dormant-users
-intro: A user account is considered to be dormant if it has not been active for at least a month. You may choose to suspend dormant users to free up user licenses.
+intro: A user account is considered to be dormant if it has not been active for at least a month.{% if enterpriseServerVersions contains currentVersion %} You may choose to suspend dormant users to free up user licenses.{% endif %}
versions:
enterprise-server: '*'
+ github-ae: '*'
---
"Activity" includes, but is not limited to:
-- Signing in to {% data variables.product.prodname_ghe_server %}.
+- Signing in to {% data variables.product.product_name %}.
- Commenting on issues and pull requests.
- Creating, deleting, watching, and starring repositories.
-- Pushing commits.{% if currentVersion ver_gt "enterprise-server@2.21" %}
+- Pushing commits.{% if currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}
- Accessing resources by using a personal access token or SSH key.{% endif %}
### Viewing dormant users
@@ -23,9 +24,9 @@ You can view a list of all dormant users who have not been suspended and who are
{% data reusables.enterprise_site_admin_settings.access-settings %}
3. In the left sidebar, click **Dormant users**.
-
+{% if enterpriseServerVersions contains currentVersion %}
4. To suspend all the dormant users in this list, at the top of the page, click **Suspend all**.
-
+{% endif %}
### Determining whether a user account is dormant
@@ -40,9 +41,8 @@ You can view a list of all dormant users who have not been suspended and who are
{% data reusables.enterprise_site_admin_settings.dormancy-threshold %}
-{% data reusables.enterprise_site_admin_settings.access-settings %}
-{% data reusables.enterprise_site_admin_settings.business %}
-{% if currentVersion ver_gt "enterprise-server@2.21" %}
+{% data reusables.enterprise-accounts.access-enterprise %}
+{% if currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}
{% data reusables.enterprise-accounts.policies-tab %}
{% else %}
{% data reusables.enterprise-accounts.settings-tab %}
diff --git a/content/admin/user-management/managing-global-webhooks.md b/content/admin/user-management/managing-global-webhooks.md
index d617a7e6e2c3..e34217f4ca5e 100644
--- a/content/admin/user-management/managing-global-webhooks.md
+++ b/content/admin/user-management/managing-global-webhooks.md
@@ -1,16 +1,17 @@
---
title: Managing global webhooks
-intro: 'Site administrators can view, add, edit, and delete global webhooks to track events at the instance level.'
+intro: 'Site administrators can view, add, edit, and delete global webhooks to track events for the enterprise.'
redirect_from:
- /enterprise/admin/user-management/about-global-webhooks
- /enterprise/admin/user-management/managing-global-webhooks
versions:
enterprise-server: '*'
+ github-ae: '*'
---
### About global webhooks
-You can use global webhooks to automatically monitor, respond to, or enforce rules for user and organization management on your instance. For example, you can configure your webhooks to execute whenever:
+You can use global webhooks to automatically monitor, respond to, or enforce rules for user and organization management for your enterprise. For example, you can configure your webhooks to execute whenever:
- A user account is created or deleted
- An organization is created or deleted
- A collaborator is added to or removed from a repository
@@ -20,11 +21,9 @@ You can use global webhooks to automatically monitor, respond to, or enforce rul
{% data reusables.enterprise_user_management.manage-global-webhooks-api %}
-
### Adding a global webhook
-{% data reusables.enterprise_site_admin_settings.access-settings %}
-{% data reusables.enterprise_site_admin_settings.business %}
+{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.hooks-tab %}
5. Click **Add webhook**.
@@ -55,8 +54,7 @@ You can use global webhooks to automatically monitor, respond to, or enforce rul
### Editing a global webhook
-{% data reusables.enterprise_site_admin_settings.access-settings %}
-{% data reusables.enterprise_site_admin_settings.business %}
+{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.hooks-tab %}
5. Next to the webhook you'd like to edit, click **Edit**.
@@ -66,8 +64,7 @@ You can use global webhooks to automatically monitor, respond to, or enforce rul
### Deleting a global webhook
-{% data reusables.enterprise_site_admin_settings.access-settings %}
-{% data reusables.enterprise_site_admin_settings.business %}
+{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.hooks-tab %}
5. Next to the webhook you'd like to delete, click **Delete**.
@@ -77,8 +74,7 @@ You can use global webhooks to automatically monitor, respond to, or enforce rul
### Viewing recent deliveries and responses
-{% data reusables.enterprise_site_admin_settings.access-settings %}
-{% data reusables.enterprise_site_admin_settings.business %}
+{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.hooks-tab %}
5. In the list of webhooks, click the webhook for which you'd like to see deliveries.
diff --git a/content/admin/user-management/managing-organizations-in-your-enterprise.md b/content/admin/user-management/managing-organizations-in-your-enterprise.md
index ab347216400a..46c6cec1ac63 100644
--- a/content/admin/user-management/managing-organizations-in-your-enterprise.md
+++ b/content/admin/user-management/managing-organizations-in-your-enterprise.md
@@ -9,5 +9,6 @@ intro: 'Organizations are great for creating distinct groups of users within you
mapTopic: true
versions:
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/admin/user-management/managing-repositories-in-your-enterprise.md b/content/admin/user-management/managing-repositories-in-your-enterprise.md
index 52831d237f78..4da07ed3b7a1 100644
--- a/content/admin/user-management/managing-repositories-in-your-enterprise.md
+++ b/content/admin/user-management/managing-repositories-in-your-enterprise.md
@@ -1,11 +1,12 @@
---
title: Managing repositories in your enterprise
-intro: 'You can manage the settings available to repository administrators on your {% data variables.product.prodname_ghe_server %} appliance.'
+intro: 'You can manage the settings available to repository administrators in your enterprise.'
redirect_from:
- /enterprise/admin/user-management/repositories
- /enterprise/admin/user-management/managing-repositories-in-your-enterprise
mapTopic: true
versions:
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/admin/user-management/managing-users-in-your-enterprise.md b/content/admin/user-management/managing-users-in-your-enterprise.md
index e89560fa5326..63a373005fbd 100644
--- a/content/admin/user-management/managing-users-in-your-enterprise.md
+++ b/content/admin/user-management/managing-users-in-your-enterprise.md
@@ -1,6 +1,6 @@
---
title: Managing users in your enterprise
-intro: 'Once users are able to authenticate to {% data variables.product.product_location_enterprise %}, they''ll want to set up a few basic custom profile settings like an avatar and email notifications.'
+intro: 'You can audit user activity and manage user settings.'
redirect_from:
- /enterprise/admin/guides/user-management/enabling-avatars-and-identicons/
- /enterprise/admin/user-management/basic-account-settings
@@ -9,5 +9,6 @@ redirect_from:
mapTopic: true
versions:
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/admin/user-management/migrating-data-to-and-from-your-enterprise.md b/content/admin/user-management/migrating-data-to-and-from-your-enterprise.md
index 51bb83534992..a3df463ac39c 100644
--- a/content/admin/user-management/migrating-data-to-and-from-your-enterprise.md
+++ b/content/admin/user-management/migrating-data-to-and-from-your-enterprise.md
@@ -1,6 +1,6 @@
---
title: Migrating data to and from your enterprise
-intro: 'You can export user, organization, and repository data from {% data variables.product.prodname_ghe_server %} or {% data variables.product.prodname_dotcom_the_website %}, then import that data into {% data variables.product.product_location_enterprise %}.'
+intro: 'You can export user, organization, and repository data from {% data variables.product.prodname_ghe_server %} or {% data variables.product.prodname_dotcom_the_website %}, then import that data into {% data variables.product.product_location %}.'
mapTopic: true
redirect_from:
- /enterprise/admin/articles/moving-a-repository-from-github-com-to-github-enterprise/
diff --git a/content/admin/user-management/migrating-to-internal-repositories.md b/content/admin/user-management/migrating-to-internal-repositories.md
index e5fe59af3707..fbd80a13f9a9 100644
--- a/content/admin/user-management/migrating-to-internal-repositories.md
+++ b/content/admin/user-management/migrating-to-internal-repositories.md
@@ -23,7 +23,7 @@ All public repositories owned by user accounts on your instance will become priv
Anonymous Git read access will be disabled for each public repository that becomes internal or private.
-If your current default visibility for repositories is public, the default will become internal. If the current default is private, the default will not change. You can change the default at any time. For more information, see "[Configuring the default visibility of new repositories on your appliance](/enterprise/admin/installation/configuring-the-default-visibility-of-new-repositories-on-your-appliance)."
+If your current default visibility for repositories is public, the default will become internal. If the current default is private, the default will not change. You can change the default at any time. For more information, see "[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#configuring-the-default-visibility-of-new-repositories-in-your-enterprise)."
The repository creation policy for the instance will change to disable public repositories and allow private and internal repositories. You can update the policy at any time. For more information, see "[Restricting repository creation in your instances](/enterprise/admin/user-management/restricting-repository-creation-in-your-instance)."
diff --git a/content/admin/user-management/monitoring-activity-in-your-enterprise.md b/content/admin/user-management/monitoring-activity-in-your-enterprise.md
index 991fef7abca5..a72fde4deb4f 100644
--- a/content/admin/user-management/monitoring-activity-in-your-enterprise.md
+++ b/content/admin/user-management/monitoring-activity-in-your-enterprise.md
@@ -6,5 +6,6 @@ redirect_from:
- /enterprise/admin/user-management/monitoring-activity-in-your-enterprise
versions:
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/admin/user-management/placing-a-legal-hold-on-a-user-or-organization.md b/content/admin/user-management/placing-a-legal-hold-on-a-user-or-organization.md
index 6efac8a11c15..20a81d080e50 100644
--- a/content/admin/user-management/placing-a-legal-hold-on-a-user-or-organization.md
+++ b/content/admin/user-management/placing-a-legal-hold-on-a-user-or-organization.md
@@ -1,10 +1,11 @@
---
title: Placing a legal hold on a user or organization
-intro: 'You can place a legal hold on a user or organization to ensure that repositories they own cannot be permanently removed from {% data variables.product.product_location_enterprise %}.'
+intro: 'You can place a legal hold on a user or organization to ensure that repositories they own cannot be permanently removed from your enterprise.'
redirect_from:
- /enterprise/admin/user-management/placing-a-legal-hold-on-a-user-or-organization
versions:
enterprise-server: '*'
+ github-ae: '*'
---
Usually, if someone deletes a repository, it will be available on disk for 90 days and can be restored via the site admin dashboard. After 90 days the repository is purged and deleted forever. If you place a legal hold on a user or organization, repositories they own are available for restore indefinitely.
diff --git a/content/admin/user-management/preventing-users-from-creating-organizations.md b/content/admin/user-management/preventing-users-from-creating-organizations.md
index d688e84fd008..1a1f09c7768e 100644
--- a/content/admin/user-management/preventing-users-from-creating-organizations.md
+++ b/content/admin/user-management/preventing-users-from-creating-organizations.md
@@ -4,14 +4,14 @@ redirect_from:
- /enterprise/admin/articles/preventing-users-from-creating-organizations/
- /enterprise/admin/hidden/preventing-users-from-creating-organizations/
- /enterprise/admin/user-management/preventing-users-from-creating-organizations
-intro: 'You can prevent users from creating organizations on your {% data variables.product.prodname_ghe_server %} appliance.'
+intro: 'You can prevent users from creating organizations in your enterprise.'
versions:
enterprise-server: '*'
+ github-ae: '*'
---
-{% data reusables.enterprise_site_admin_settings.access-settings %}
-{% data reusables.enterprise_site_admin_settings.business %}
-{% if currentVersion ver_gt "enterprise-server@2.21" %}
+{% data reusables.enterprise-accounts.access-enterprise %}
+{% if currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}
{% data reusables.enterprise-accounts.policies-tab %}
{% else %}
{% data reusables.enterprise-accounts.settings-tab %}
diff --git a/content/admin/user-management/promoting-or-demoting-a-site-administrator.md b/content/admin/user-management/promoting-or-demoting-a-site-administrator.md
index 3af2760d09c2..8370cad87091 100644
--- a/content/admin/user-management/promoting-or-demoting-a-site-administrator.md
+++ b/content/admin/user-management/promoting-or-demoting-a-site-administrator.md
@@ -19,8 +19,7 @@ For information about promoting a user to an organization owner, see the `ghe-or
### Promoting a user from the enterprise settings
-{% data reusables.enterprise_site_admin_settings.access-settings %}
-{% data reusables.enterprise_site_admin_settings.business %}
+{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.people-tab %}
{% data reusables.enterprise-accounts.administrators-tab %}
5. In the upper-right corner of the page, click **Add owner**.
@@ -30,8 +29,7 @@ For information about promoting a user to an organization owner, see the `ghe-or
### Demoting a site administrator from the enterprise settings
-{% data reusables.enterprise_site_admin_settings.access-settings %}
-{% data reusables.enterprise_site_admin_settings.business %}
+{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.people-tab %}
{% data reusables.enterprise-accounts.administrators-tab %}
1. In the upper-left corner of the page, in the "Find an administrator" search field, type the username of the person you want to demote.
@@ -54,4 +52,4 @@ For information about promoting a user to an organization owner, see the `ghe-or
2. Run [ghe-user-demote](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-user-demote) with the username to demote.
```shell
$ ghe-user-demote username
- ```
+ ```
\ No newline at end of file
diff --git a/content/admin/user-management/requiring-two-factor-authentication-for-an-organization.md b/content/admin/user-management/requiring-two-factor-authentication-for-an-organization.md
index ad3fed407f6f..32cff3f262c0 100644
--- a/content/admin/user-management/requiring-two-factor-authentication-for-an-organization.md
+++ b/content/admin/user-management/requiring-two-factor-authentication-for-an-organization.md
@@ -7,11 +7,11 @@ versions:
enterprise-server: '*'
---
-When using LDAP or built-in authentication, two-factor authentication is supported on the {% data variables.product.prodname_ghe_server %} appliance. Organization administrators can require members to have two-factor authentication enabled.
+When using LDAP or built-in authentication, two-factor authentication is supported on {% data variables.product.product_location %}. Organization administrators can require members to have two-factor authentication enabled.
{% data reusables.enterprise_user_management.external_auth_disables_2fa %}
-For more information, see [this chart on authentication methods that support 2FA](/enterprise/{{ currentVersion }}/user/articles/about-two-factor-authentication/#authentication-methods-that-support-2fa).
+For more information, see "[About two-factor authentication](/github/authenticating-to-github/about-two-factor-authentication)."
### Requirements for enforcing two-factor authentication
diff --git a/content/admin/user-management/searching-the-audit-log.md b/content/admin/user-management/searching-the-audit-log.md
index 82772ace4caf..9495d0dc5c9c 100644
--- a/content/admin/user-management/searching-the-audit-log.md
+++ b/content/admin/user-management/searching-the-audit-log.md
@@ -1,12 +1,13 @@
---
title: Searching the audit log
-intro: 'Site administrators can search an extensive list of [audited actions](/enterprise/{{ currentVersion }}/admin/guides/installation/audited-actions) on {% data variables.product.product_location_enterprise %}.'
+intro: 'Site administrators can search an extensive list of audited actions on the enterprise.'
redirect_from:
- /enterprise/admin/articles/searching-the-audit-log/
- /enterprise/admin/installation/searching-the-audit-log
- /enterprise/admin/user-management/searching-the-audit-log
versions:
enterprise-server: '*'
+ github-ae: '*'
---
### Search query syntax
@@ -18,7 +19,7 @@ Key | Value
`actor_id` | ID of the user account that initiated the action
`actor` | Name of the user account that initiated the action
`oauth_app_id` | ID of the OAuth application associated with the action
-`action` | Name of the [audited action](/enterprise/{{ currentVersion }}/admin/guides/installation/audited-actions)
+`action` | Name of the audited action
`user_id` | ID of the user affected by the action
`user` | Name of the user affected by the action
`repo_id` | ID of the repository affected by the action (if applicable)
@@ -34,12 +35,11 @@ For example, to see all actions that have affected the repository `octocat/Spoon
`repo:"octocat/Spoon-Knife" AND created_at:[2017-01-01 TO *]`
-For a full list of actions, see "[Audited actions](/enterprise/{{ currentVersion }}/admin/guides/installation/audited-actions)."
+For a full list of actions, see "[Audited actions](/admin/user-management/audited-actions)."
### Searching the audit log
-{% data reusables.enterprise_site_admin_settings.access-settings %}
-{% data reusables.enterprise_site_admin_settings.business %}
+{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.audit-log-tab %}
4. Type a search query.
diff --git a/content/admin/user-management/suspending-and-unsuspending-users.md b/content/admin/user-management/suspending-and-unsuspending-users.md
index 022376d0d907..b2c381fe2ea1 100644
--- a/content/admin/user-management/suspending-and-unsuspending-users.md
+++ b/content/admin/user-management/suspending-and-unsuspending-users.md
@@ -7,7 +7,7 @@ redirect_from:
- /enterprise/admin/articles/suspended-users/
- /enterprise/admin/articles/suspending-and-unsuspending-users/
- /enterprise/admin/user-management/suspending-and-unsuspending-users
-intro: 'If a user leaves or moves to a different part of the company, you should remove or modify their ability to access {% data variables.product.product_location_enterprise %}.'
+intro: 'If a user leaves or moves to a different part of the company, you should remove or modify their ability to access {% data variables.product.product_location %}.'
versions:
enterprise-server: '*'
---
@@ -26,7 +26,7 @@ Before suspending site administrators, you must demote them to regular users. Fo
{% tip %}
-**Note:** If [LDAP Sync is enabled](/enterprise/admin/authentication/using-ldap#enabling-ldap-sync) for {% data variables.product.product_location_enterprise %}, users are automatically suspended when they're removed from the LDAP directory server. When LDAP Sync is enabled for your instance, normal user suspension methods are disabled.
+**Note:** If [LDAP Sync is enabled](/enterprise/admin/authentication/using-ldap#enabling-ldap-sync) for {% data variables.product.product_location %}, users are automatically suspended when they're removed from the LDAP directory server. When LDAP Sync is enabled for your instance, normal user suspension methods are disabled.
{% endtip %}
@@ -70,8 +70,7 @@ As when suspending a user, unsuspending a user takes effect immediately. The use
You can create a custom message that suspended users will see when attempting to sign in.
-{% data reusables.enterprise_site_admin_settings.access-settings %}
-{% data reusables.enterprise_site_admin_settings.business %}
+{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.messages-tab %}
5. Click **Add message**.
diff --git a/content/admin/user-management/troubleshooting-service-hooks.md b/content/admin/user-management/troubleshooting-service-hooks.md
index 7beb9f00fccf..3ae71bf8105e 100644
--- a/content/admin/user-management/troubleshooting-service-hooks.md
+++ b/content/admin/user-management/troubleshooting-service-hooks.md
@@ -7,6 +7,7 @@ redirect_from:
- /enterprise/admin/user-management/troubleshooting-service-hooks
versions:
enterprise-server: '*'
+ github-ae: '*'
---
### Getting information on deliveries
diff --git a/content/admin/user-management/viewing-push-logs.md b/content/admin/user-management/viewing-push-logs.md
index fdcf4302d538..932900f18d73 100644
--- a/content/admin/user-management/viewing-push-logs.md
+++ b/content/admin/user-management/viewing-push-logs.md
@@ -1,12 +1,13 @@
---
title: Viewing push logs
-intro: 'Site administrators can view a list of Git push operations for any repository on {% data variables.product.product_location_enterprise %}.'
+intro: 'Site administrators can view a list of Git push operations for any repository on the enterprise.'
redirect_from:
- /enterprise/admin/articles/viewing-push-logs/
- /enterprise/admin/installation/viewing-push-logs
- /enterprise/admin/user-management/viewing-push-logs
versions:
enterprise-server: '*'
+ github-ae: '*'
---
Push log entries show:
@@ -27,6 +28,7 @@ Push log entries show:
4. In the left sidebar, click **Push Log**.
+{% if enterpriseServerVersions contains currentVersion %}
### Viewing a repository's push logs on the command-line
1. SSH into your appliance. For more information, see "[Accessing the administrative shell (SSH)](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-administrative-shell-ssh/)."
@@ -34,3 +36,4 @@ Push log entries show:
```shell
ghe-repo owner/repository -c "less audit_log"
```
+{% endif %}
\ No newline at end of file
diff --git a/content/desktop/installing-and-configuring-github-desktop/creating-your-first-repository-using-github-desktop.md b/content/desktop/installing-and-configuring-github-desktop/creating-your-first-repository-using-github-desktop.md
index 758428325edf..fc00f154bd32 100644
--- a/content/desktop/installing-and-configuring-github-desktop/creating-your-first-repository-using-github-desktop.md
+++ b/content/desktop/installing-and-configuring-github-desktop/creating-your-first-repository-using-github-desktop.md
@@ -92,13 +92,8 @@ Now that you've created and published your repository, you're ready to make chan
4. At the bottom of the **Changes** list, enter a commit message. To the right of your profile picture, type a short description of the commit. Since we're changing the _README.md_ file, "Add information about purpose of project" would be a good commit summary. Below the summary, you'll see a "Description" text field where you can type a longer description of the changes in the commit, which is helpful when looking back at the history of a project and understanding why changes were made. Since you're making a basic update of a _README.md_ file, you can skip the description.
-<<<<<<< HEAD
5. Click **Commit to BRANCH NAME**. The commit button shows your current branch so you can be sure to commit to the branch you want.
-=======
-5. Click **Commit to master**. The commit button shows your current branch, which in this case is `master`, so that you know which branch you are making a commit to.
- 
->>>>>>> master
6. To push your changes to the remote repository on {% data variables.product.product_name %}, click **Push origin**.
- The **Push origin** button is the same one that you clicked to publish your repository to {% data variables.product.product_name %}. This button changes contextually based on where you are at in the Git workflow. It should now say `Push origin` with a `1` next to it, indicating that there is one commit that has not been pushed up to {% data variables.product.product_name %}.
diff --git a/content/developers/apps/about-apps.md b/content/developers/apps/about-apps.md
index e6e9095396b2..010cd5c2e688 100644
--- a/content/developers/apps/about-apps.md
+++ b/content/developers/apps/about-apps.md
@@ -1,6 +1,6 @@
---
title: About apps
-intro: 'You can build integrations with the {% data variables.product.prodname_dotcom %} APIs to add flexibility and reduce friction in your own workflow. You can also share integrations with others on [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace).'
+intro: 'You can build integrations with the {% data variables.product.prodname_dotcom %} APIs to add flexibility and reduce friction in your own workflow.{% if currentVersion == "free-pro-team@latest" %} You can also share integrations with others on [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace).{% endif %}'
redirect_from:
- /apps/building-integrations/setting-up-a-new-integration/
- /apps/building-integrations/
@@ -9,6 +9,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Apps on {% data variables.product.prodname_dotcom %} allow you to automate and improve your workflow. You can build apps to improve your workflow.{% if currentVersion == "free-pro-team@latest" %} You can also share or sell apps in [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace). To learn how to list an app on {% data variables.product.prodname_marketplace %}, see "[Getting started with GitHub Marketplace](/marketplace/getting-started/)."{% endif %}
diff --git a/content/developers/apps/authenticating-with-github-apps.md b/content/developers/apps/authenticating-with-github-apps.md
index 17c124e29c80..3e6cb121759f 100644
--- a/content/developers/apps/authenticating-with-github-apps.md
+++ b/content/developers/apps/authenticating-with-github-apps.md
@@ -8,9 +8,10 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
{% data reusables.pre-release-program.machine-man-preview %}
{% data reusables.pre-release-program.api-preview-warning %}
{% endif %}
@@ -94,7 +95,7 @@ Use your {% data variables.product.prodname_github_app %}'s identifier (`YOUR_AP
After creating the JWT, set it in the `Header` of the API request:
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
```shell
$ curl -i -H "Authorization: Bearer YOUR_JWT" -H "Accept: application/vnd.github.machine-man-preview+json" {% data variables.product.api_url_pre %}/app
```
@@ -129,7 +130,7 @@ By default, installation access tokens are scoped to all the repositories that a
To create an installation access token, include the JWT [generated above](#jwt-payload) in the Authorization header in the API request:
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
```shell
$ curl -i -X POST \
-H "Authorization: Bearer YOUR_JWT" \
@@ -149,7 +150,7 @@ The response will include your installation access token, the expiration date, t
To authenticate with an installation access token, include it in the Authorization header in the API request:
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
```shell
$ curl -i \
-H "Authorization: token YOUR_INSTALLATION_ACCESS_TOKEN" \
diff --git a/content/developers/apps/authorizing-oauth-apps.md b/content/developers/apps/authorizing-oauth-apps.md
index 87f8be697567..bbd0d6f1e997 100644
--- a/content/developers/apps/authorizing-oauth-apps.md
+++ b/content/developers/apps/authorizing-oauth-apps.md
@@ -11,13 +11,14 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
-{% data variables.product.product_name %}'s OAuth implementation supports the standard [authorization code grant type](https://tools.ietf.org/html/rfc6749#section-4.1){% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} and the OAuth 2.0 [Device Authorization Grant](https://tools.ietf.org/html/rfc8628) for apps that don't have access to a web browser{% endif %}.
+{% data variables.product.product_name %}'s OAuth implementation supports the standard [authorization code grant type](https://tools.ietf.org/html/rfc6749#section-4.1){% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %} and the OAuth 2.0 [Device Authorization Grant](https://tools.ietf.org/html/rfc8628) for apps that don't have access to a web browser{% endif %}.
If you want to skip authorizing your app in the standard way, such as when testing your app, you can use the [non-web application flow](#non-web-application-flow).
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}
To authorize your OAuth app, consider which authorization flow best fits your app.
@@ -111,7 +112,7 @@ For example, in curl you can set the Authorization header like this:
curl -H "Authorization: token OAUTH-TOKEN" {% data variables.product.api_url_pre %}/user
```
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}
### Device flow
{% note %}
@@ -235,6 +236,7 @@ For more information, see the "[OAuth 2.0 Device Authorization Grant](https://to
Non-web authentication is available for limited situations like testing. If you need to, you can use [Basic Authentication](/v3/auth#basic-authentication) to create a personal access token using your [Personal access tokens settings page](/articles/creating-an-access-token-for-command-line-use). This technique enables the user to revoke access at any time.
+{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
{% note %}
**Note:** When using the non-web application flow to create an OAuth2 token, make sure to understand how to [work with
@@ -242,6 +244,7 @@ two-factor authentication](/v3/auth/#working-with-two-factor-authentication) if
you or your users have two-factor authentication enabled.
{% endnote %}
+{% endif %}
### Redirect URLs
@@ -299,6 +302,6 @@ To build this link, you'll need your OAuth Apps `client_id` that you received fr
* "[Troubleshooting authorization request errors](/apps/managing-oauth-apps/troubleshooting-authorization-request-errors)"
* "[Troubleshooting OAuth App access token request errors](/apps/managing-oauth-apps/troubleshooting-oauth-app-access-token-request-errors)"
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}
* "[Device flow errors](#errors-for-the-device-flow)"
{% endif %}
diff --git a/content/developers/apps/building-github-apps.md b/content/developers/apps/building-github-apps.md
index a0868276380a..0012cdf9cef2 100644
--- a/content/developers/apps/building-github-apps.md
+++ b/content/developers/apps/building-github-apps.md
@@ -8,5 +8,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/developers/apps/building-oauth-apps.md b/content/developers/apps/building-oauth-apps.md
index 61e6a69762f8..92ea416d43fb 100644
--- a/content/developers/apps/building-oauth-apps.md
+++ b/content/developers/apps/building-oauth-apps.md
@@ -8,5 +8,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/developers/apps/creating-a-custom-badge-for-your-github-app.md b/content/developers/apps/creating-a-custom-badge-for-your-github-app.md
index e924771bac32..c39b720c268f 100644
--- a/content/developers/apps/creating-a-custom-badge-for-your-github-app.md
+++ b/content/developers/apps/creating-a-custom-badge-for-your-github-app.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
By default, a new GitHub App will have an automatically generated [identicon](https://github.com/blog/1586-identicons).
diff --git a/content/developers/apps/creating-a-custom-badge-for-your-oauth-app.md b/content/developers/apps/creating-a-custom-badge-for-your-oauth-app.md
index 3896c04b6851..9945833d00fc 100644
--- a/content/developers/apps/creating-a-custom-badge-for-your-oauth-app.md
+++ b/content/developers/apps/creating-a-custom-badge-for-your-oauth-app.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
By default, a new OAuth App will have an automatically generated [identicon](https://github.com/blog/1586-identicons).
diff --git a/content/developers/apps/creating-a-github-app-from-a-manifest.md b/content/developers/apps/creating-a-github-app-from-a-manifest.md
index 39e841d84c92..f68237c26a65 100644
--- a/content/developers/apps/creating-a-github-app-from-a-manifest.md
+++ b/content/developers/apps/creating-a-github-app-from-a-manifest.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
@@ -162,7 +163,7 @@ You must complete this step of the GitHub App Manifest flow within one hour.
{% endnote %}
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.21" %}
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.21" %}
{% data reusables.pre-release-program.fury-pre-release %}
{% data reusables.pre-release-program.api-preview-warning %}
{% endif %}
diff --git a/content/developers/apps/creating-a-github-app-using-url-parameters.md b/content/developers/apps/creating-a-github-app-using-url-parameters.md
index d718d3f89bdd..383af4790354 100644
--- a/content/developers/apps/creating-a-github-app-using-url-parameters.md
+++ b/content/developers/apps/creating-a-github-app-using-url-parameters.md
@@ -6,21 +6,22 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### About {% data variables.product.prodname_github_app %} URL parameters
You can add query parameters to these URLs to preselect the configuration of a {% data variables.product.prodname_github_app %} on a personal or organization account:
-* **User account:** `https://github.com/settings/apps/new`
-* **Organization account:** `https://github.com/organizations/:org/settings/apps/new`
+* **User account:** `{% data variables.product.oauth_host_code %}/settings/apps/new`
+* **Organization account:** `{% data variables.product.oauth_host_code %}/:org/settings/apps/new`
The person creating the app can edit the preselected values from the {% data variables.product.prodname_github_app %} registration page, before submitting the app. If you do not include required parameters in the URL query string, like `name`, the person creating the app will need to input a value before submitting the app.
The following URL creates a new public app called `octocat-github-app` with a preconfigured description and callback URL. This URL also selects read and write permissions for `checks`, subscribes to the `check_run` and `check_suite` webhook events, and selects the option to request user authorization (OAuth) during installation:
```
- https://github.com/settings/apps/new?name=octocat-github-app&description=An%20Octocat%20App&callback_url=https://example.com&request_oauth_on_install=true&public=true&checks=write&events[]=check_run&events[]=check_suite
+ {% data variables.product.oauth_host_code %}/settings/apps/new?name=octocat-github-app&description=An%20Octocat%20App&callback_url=https://example.com&request_oauth_on_install=true&public=true&checks=write&events[]=check_run&events[]=check_suite
```
The complete list of available query parameters, permissions, and events is listed in the sections below.
@@ -41,7 +42,8 @@ The complete list of available query parameters, permissions, and events is list
`webhook_secret` | `string` | You can specify a secret to secure your webhooks. See "[Securing your webhooks](/webhooks/securing/)" for more details.
`events` | `array of strings` | Webhook events. Some webhook events require `read` or `write` permissions for a resource before you can select the event when registering a new {% data variables.product.prodname_github_app %}. See the "[{% data variables.product.prodname_github_app %} webhook events](#github-app-webhook-events)" section for available events and their required permissions. You can select multiple events in a query string. For example, `events[]=public&events[]=label`.
`domain` | `string` | The URL of a content reference.
-`single_file_name` | `string` | When you grant `read` or `write` access to the `single_file` permission, this field provides the path to the single file your {% data variables.product.prodname_github_app %} will manage.
+`single_file_name` | `string` | This is a narrowly-scoped permission that allows the app to access a single file in any repository. When you set the `single_file` permission to `read` or `write`, this field provides the path to the single file your {% data variables.product.prodname_github_app %} will manage. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} If you need to manage multiple files, see `single_file_paths` below. {% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
+`single_file_paths` | `array of strings` | This allows the app to access up ten specified files in a repository. When you set the `single_file` permission to `read` or `write`, this array can store the paths for up to ten files that your {% data variables.product.prodname_github_app %} will manage. These files all receive the same permission set by `single_file`, and do not have separate individual permissions. When two or more files are configured, the API returns `multiple_single_files=true`, otherwise it returns `multiple_single_files=false`.{% endif %}
### {% data variables.product.prodname_github_app %} permissions
@@ -54,8 +56,8 @@ Permission | Description
[`checks`](/rest/reference/permissions-required-for-github-apps/#permission-on-checks) | Grants access to the [Checks API](/v3/checks/). Can be one of: `none`, `read`, or `write`.
`content_references` | Grants access to the "[Create a content attachment](/v3/apps/installations/#create-a-content-attachment)" endpoint. Can be one of: `none`, `read`, or `write`.
[`contents`](/rest/reference/permissions-required-for-github-apps/#permission-on-contents) | Grants access to various endpoints that allow you to modify repository contents. Can be one of: `none`, `read`, or `write`.
-[`deployments`](/rest/reference/permissions-required-for-github-apps/#permission-on-deployments) | Grants access to the [Deployments API](/rest/reference/repos#deployments). Can be one of: `none`, `read`, or `write`.
-[`emails`](/rest/reference/permissions-required-for-github-apps/#permission-on-emails) | Grants access to the [Emails API](/v3/users/emails/). Can be one of: `none`, `read`, or `write`.
+[`deployments`](/rest/reference/permissions-required-for-github-apps/#permission-on-deployments) | Grants access to the [Deployments API](/rest/reference/repos#deployments). Can be one of: `none`, `read`, or `write`.{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
+[`emails`](/rest/reference/permissions-required-for-github-apps/#permission-on-emails) | Grants access to the [Emails API](/v3/users/emails/). Can be one of: `none`, `read`, or `write`.{% endif %}
[`followers`](/rest/reference/permissions-required-for-github-apps/#permission-on-followers) | Grants access to the [Followers API](/v3/users/followers/). Can be one of: `none`, `read`, or `write`.
[`gpg_keys`](/rest/reference/permissions-required-for-github-apps/#permission-on-gpg-keys) | Grants access to the [GPG Keys API](/v3/users/gpg_keys/). Can be one of: `none`, `read`, or `write`.
[`issues`](/rest/reference/permissions-required-for-github-apps/#permission-on-issues) | Grants access to the [Issues API](/v3/issues/). Can be one of: `none`, `read`, or `write`.
diff --git a/content/developers/apps/creating-a-github-app.md b/content/developers/apps/creating-a-github-app.md
index 25acc191d810..054cc4493af9 100644
--- a/content/developers/apps/creating-a-github-app.md
+++ b/content/developers/apps/creating-a-github-app.md
@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% if currentVersion == "free-pro-team@latest" %}To learn how to use GitHub App Manifests, which allow people to create preconfigured GitHub Apps, see "[Creating GitHub Apps from a manifest](/apps/building-github-apps/creating-github-apps-from-a-manifest/)."{% endif %}
@@ -34,9 +35,18 @@ versions:
7. In "Homepage URL", type the full URL to your app's website.
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}
+8. In "Callback URL", type the full URL to redirect to after a user authorizes the installation. This URL is used if your app needs to identify and authorize user-to-server requests.
+
+ You can use **Add callback URL** to provide additional callback URLs, up to a maximum of 10.
+
+ 
+{% else %}
8. In "User authorization callback URL", type the full URL to redirect to after a user authorizes an installation. This URL is used if your app needs to identify and authorize user-to-server requests.
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
+
+{% endif %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}
9. By default, to improve your app's security, your app will use expiring user authorization tokens. To opt-out of using expiring user tokens, you must deselect "Expire user authorization tokens". To learn more about setting up a refresh token flow and the benefits of expiring user tokens, see "[Refreshing user-to-server access tokens](/apps/building-github-apps/refreshing-user-to-server-access-tokens/)."
{% endif %}
diff --git a/content/developers/apps/creating-an-oauth-app.md b/content/developers/apps/creating-an-oauth-app.md
index 25fcff288b48..c885dc21341f 100644
--- a/content/developers/apps/creating-an-oauth-app.md
+++ b/content/developers/apps/creating-an-oauth-app.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% if currentVersion == "free-pro-team@latest" %}
@@ -43,5 +44,12 @@ versions:
9. In "Authorization callback URL", type the callback URL of your app.
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}
+ {% note %}
+
+ **Note:** OAuth Apps cannot have multiple callback URLs, unlike {% data variables.product.prodname_github_apps %}.
+
+ {% endnote %}
+{% endif %}
10. Click **Register application**.
diff --git a/content/developers/apps/creating-ci-tests-with-the-checks-api.md b/content/developers/apps/creating-ci-tests-with-the-checks-api.md
index 47aac16abd91..dbe3fb274d86 100644
--- a/content/developers/apps/creating-ci-tests-with-the-checks-api.md
+++ b/content/developers/apps/creating-ci-tests-with-the-checks-api.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
@@ -133,7 +134,7 @@ The `requested` action requests a check run each time code is pushed to the repo
You'll add this new method as a [Sinatra helper](https://github.com/sinatra/sinatra#helpers) in case you want other routes to use it too. Under `helpers do`, add this `create_check_run` method:
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}
``` ruby
# Create a new check run with the status queued
def create_check_run
@@ -229,7 +230,7 @@ In this section, you're not going to kick off the CI test yet, but you'll walk t
Let's create the `initiate_check_run` method and update the status of the check run. Add the following code to the helpers section:
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}
``` ruby
# Start the CI process
def initiate_check_run
@@ -607,7 +608,7 @@ text = "Octo RuboCop version: #{@output['metadata']['rubocop_version']}"
Now you've got all the information you need to update your check run. In the [first half of this quickstart](#step-14-updating-a-check-run), you added this code to set the status of the check run to `success`:
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}
``` ruby
# Mark the check run as complete!
updated_check_run = @installation_client.patch(
@@ -639,7 +640,7 @@ updated_check_run = @installation_client.patch(
You'll need to update that code to use the `conclusion` variable you set based on the RuboCop results (to `success` or `neutral`). You can update the code with the following:
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}
``` ruby
# Mark the check run as complete! And if there are warnings, share them.
updated_check_run = @installation_client.patch(
@@ -835,7 +836,7 @@ Here are a few common problems and some suggested solutions. If you run into any
* **Q:** My app isn't pushing code to GitHub. I don't see the fixes that RuboCop automatically makes!
- **A:** Make sure you have **Read & write** permissions for "Repository contents," and that you are cloning the repository with your intallation token. See [Step 2.2. Cloning the repository](#step-22-cloning-the-repository) for details.
+ **A:** Make sure you have **Read & write** permissions for "Repository contents," and that you are cloning the repository with your installation token. See [Step 2.2. Cloning the repository](#step-22-cloning-the-repository) for details.
* **Q:** I see an error in the `template_server.rb` debug output related to cloning my repository.
diff --git a/content/developers/apps/deleting-a-github-app.md b/content/developers/apps/deleting-a-github-app.md
index 596a816bc197..6c32b8f7f9fd 100644
--- a/content/developers/apps/deleting-a-github-app.md
+++ b/content/developers/apps/deleting-a-github-app.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.user-settings.access_settings %}
diff --git a/content/developers/apps/deleting-an-oauth-app.md b/content/developers/apps/deleting-an-oauth-app.md
index d252eecd1847..cdf87e56e0f1 100644
--- a/content/developers/apps/deleting-an-oauth-app.md
+++ b/content/developers/apps/deleting-an-oauth-app.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.user-settings.access_settings %}
diff --git a/content/developers/apps/differences-between-github-apps-and-oauth-apps.md b/content/developers/apps/differences-between-github-apps-and-oauth-apps.md
index 1c0929cd718d..a4ad4f6f1cd1 100644
--- a/content/developers/apps/differences-between-github-apps-and-oauth-apps.md
+++ b/content/developers/apps/differences-between-github-apps-and-oauth-apps.md
@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Who can install GitHub Apps and authorize OAuth Apps?
@@ -56,7 +57,7 @@ An _authorized_ OAuth App has access to all of the user's or organization owner'
| An installation token identifies the app as the GitHub Apps bot, such as @jenkins-bot. | An access token identifies the app as the user who granted the token to the app, such as @octocat. |
| Installation tokens expire after a predefined amount of time (currently 1 hour). | OAuth tokens remain active until they're revoked by the customer. |
| {% data reusables.apps.api-rate-limits-non-ghec %}{% if currentVersion == "free-pro-team@latest" %} Higher rate limits apply for {% data variables.product.prodname_ghe_cloud %}. For more information, see "[Rate limits for GitHub Apps](/developers/apps/rate-limits-for-github-apps)."{% endif %} | OAuth tokens use the user's rate limit of 5,000 requests per hour. |
-| Rate limit increases can be granted both at the GitHub Apps level (affecting all installations) and at the individual installation level. | Rate limit increases are granted per OAuth App. Every token granted to that OAuth App gets the increased limit. |{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
+| Rate limit increases can be granted both at the GitHub Apps level (affecting all installations) and at the individual installation level. | Rate limit increases are granted per OAuth App. Every token granted to that OAuth App gets the increased limit. |{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}
| {% data variables.product.prodname_github_app %}s can authenticate on behalf of the user, which is called user-to-server requests. The flow to authorize is the same as the OAuth App authorization flow. User-to-server tokens can expire and be renewed with a refresh token. For more information, see "[Refreshing user-to-server access tokens](/apps/building-github-apps/refreshing-user-to-server-access-tokens/)" and "[Identifying and authorizing users for GitHub Apps](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)." | The OAuth flow used by {% data variables.product.prodname_oauth_app %}s authorizes an {% data variables.product.prodname_oauth_app %} on behalf of the user. This is the same flow used in {% data variables.product.prodname_github_app %} user-to-server authorization. |{% endif %}
### Requesting permission levels for resources
diff --git a/content/developers/apps/editing-a-github-apps-permissions.md b/content/developers/apps/editing-a-github-apps-permissions.md
index 81fff7a88b35..d57db219a1e6 100644
--- a/content/developers/apps/editing-a-github-apps-permissions.md
+++ b/content/developers/apps/editing-a-github-apps-permissions.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% note %}
diff --git a/content/developers/apps/getting-started-with-apps.md b/content/developers/apps/getting-started-with-apps.md
index 799c24985a28..d6bc3d7a0f13 100644
--- a/content/developers/apps/getting-started-with-apps.md
+++ b/content/developers/apps/getting-started-with-apps.md
@@ -5,5 +5,6 @@ mapTopic: true
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/developers/apps/guides.md b/content/developers/apps/guides.md
index 8c07bf37134b..1e90f02406a7 100644
--- a/content/developers/apps/guides.md
+++ b/content/developers/apps/guides.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/developers/apps/identifying-and-authorizing-users-for-github-apps.md b/content/developers/apps/identifying-and-authorizing-users-for-github-apps.md
index 95d7ec2ffca2..60a7f9be391f 100644
--- a/content/developers/apps/identifying-and-authorizing-users-for-github-apps.md
+++ b/content/developers/apps/identifying-and-authorizing-users-for-github-apps.md
@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
@@ -21,7 +22,7 @@ When your GitHub App acts on behalf of a user, it performs user-to-server reques
To authorize users for standard apps that run in the browser, use the [web application flow](#web-application-flow).
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}
To authorize users for headless apps without direct access to the browser, such as CLI tools or Git credential managers, use the [device flow](#device-flow). The device flow uses the OAuth 2.0 [Device Authorization Grant](https://tools.ietf.org/html/rfc8628).
{% endif %}
@@ -46,7 +47,7 @@ When your GitHub App specifies a `login` parameter, it prompts users with a spec
Name | Type | Description
-----|------|------------
`client_id` | `string` | **Required.** The client ID for your GitHub App. You can find this in your [GitHub App settings](https://github.com/settings/apps) when you select your app.
-`redirect_uri` | `string` | The URL in your application where users will be sent after authorization. This must be an exact match to the URL you provided in the **User authorization callback URL** field when setting up your GitHub App and can't contain any additional parameters.
+`redirect_uri` | `string` | The URL in your application where users will be sent after authorization. This must be an exact match to {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} one of the URLs you provided as a **Callback URL** {% else %} the URL you provided in the **User authorization callback URL** field{% endif %} when setting up your GitHub App and can't contain any additional parameters.
`state` | `string` | This should contain a random string to protect against forgery attacks and could contain any other arbitrary data.
`login` | `string` | Suggests a specific account to use for signing in and authorizing the app.
@@ -66,7 +67,7 @@ If the user accepts your request, GitHub redirects back to your site with a temp
{% endnote %}
-Exchange this `code` for an access token. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} When expiring tokens are enabled, the access token expires in 8 hours and the refresh token expires in 6 months. Every time you refresh the token, you get a new refresh token. For more information, see "[Refreshing user-to-server access tokens](/apps/building-github-apps/refreshing-user-to-server-access-tokens/)."
+Exchange this `code` for an access token. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %} When expiring tokens are enabled, the access token expires in 8 hours and the refresh token expires in 6 months. Every time you refresh the token, you get a new refresh token. For more information, see "[Refreshing user-to-server access tokens](/apps/building-github-apps/refreshing-user-to-server-access-tokens/)."
Expiring user tokens are currently part of the user-to-server token expiration beta and subject to change. To opt-in to the user-to-server token expiration beta feature, see "[Activating beta features for apps](/developers/apps/activating-beta-features-for-apps)."{% endif %}
@@ -79,12 +80,12 @@ Name | Type | Description
`client_id` | `string` | **Required.** The client ID for your GitHub App.
`client_secret` | `string` | **Required.** The client secret for your GitHub App.
`code` | `string` | **Required.** The code you received as a response to Step 1.
-`redirect_uri` | `string` | The URL in your application where users are sent after authorization.
+`redirect_uri` | `string` | The URL in your application where users will be sent after authorization. This must be an exact match to {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} one of the URLs you provided as a **Callback URL** {% else %} the URL you provided in the **User authorization callback URL** field{% endif %} when setting up your GitHub App and can't contain any additional parameters.
`state` | `string` | The unguessable random string you provided in Step 1.
##### Response
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}
By default, the response takes the following form. The response parameters `expires_in`, `refresh_token`, and `refresh_token_expires_in` are only returned when you enable the beta for expiring user-to-server access tokens.
@@ -119,7 +120,7 @@ For example, in curl you can set the Authorization header like this:
curl -H "Authorization: token OAUTH-TOKEN" {% data variables.product.api_url_pre %}/user
```
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}
### Device flow
{% note %}
@@ -136,7 +137,7 @@ For more information about authorizing users using the device flow, see "[Author
### Check which installation's resources a user can access
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
{% data reusables.pre-release-program.machine-man-preview %}
{% data reusables.pre-release-program.api-preview-warning %}
{% endif %}
@@ -249,7 +250,7 @@ While most of your API interaction should occur using your server-to-server inst
* [List deployments](/rest/reference/repos#list-deployments)
* [Create a deployment](/rest/reference/repos#create-a-deployment)
-* [Get a deployment](/rest/reference/repos#get-a-deployment){% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
+* [Get a deployment](/rest/reference/repos#get-a-deployment){% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}
* [Delete a deployment](/rest/reference/repos#delete-a-deployment){% endif %}
##### Events
@@ -422,7 +423,7 @@ While most of your API interaction should occur using your server-to-server inst
* [Convert an organization member to outside collaborator](/v3/orgs/outside_collaborators/#convert-an-organization-member-to-outside-collaborator)
* [Remove outside collaborator from an organization](/v3/orgs/outside_collaborators/#remove-outside-collaborator-from-an-organization)
-{% if currentVersion != "free-pro-team@latest" %}
+{% if enterpriseServerVersions contains currentVersion %}
##### Organization Pre Receive Hooks
* [List pre-receive hooks for an organization](/enterprise/user/rest/reference/enterprise-admin#list-pre-receive-hooks-for-an-organization)
@@ -431,7 +432,7 @@ While most of your API interaction should occur using your server-to-server inst
* [Remove pre-receive hook enforcement for an organization](/enterprise/user/rest/reference/enterprise-admin#remove-pre-receive-hook-enforcement-for-an-organization)
{% endif %}
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}
##### Organization Team Projects
* [List team projects](/v3/teams/#list-team-projects)
@@ -459,8 +460,8 @@ While most of your API interaction should occur using your server-to-server inst
* [List teams](/v3/teams/#list-teams)
* [Create a team](/v3/teams/#create-a-team)
-* [Get a team by name](/v3/teams/#get-a-team-by-name)
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.21" %}
+* [Get a team by name](/v3/teams/#get-a-team-by-name)
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.21" %}
* [Get a team](/v3/teams/#get-a-team)
{% endif %}
* [Update a team](/v3/teams/#update-a-team)
@@ -481,7 +482,7 @@ While most of your API interaction should occur using your server-to-server inst
* [Get an organization](/v3/orgs/#get-an-organization)
* [Update an organization](/v3/orgs/#update-an-organization)
* [List organization memberships for the authenticated user](/v3/orgs/members/#list-organization-memberships-for-the-authenticated-user)
-* [Get an organization membership for the authenticated user](/v3/orgs/members/#get-an-organization-membership-for-the-authenticated-user)
+* [Get an organization membership for the authenticated user](/v3/orgs/members/#get-an-organization-membership-for-the-authenticated-user)
* [Update an organization membership for the authenticated user](/v3/orgs/members/#update-an-organization-membership-for-the-authenticated-user)
* [List organizations for the authenticated user](/v3/orgs/#list-organizations-for-the-authenticated-user)
* [List organizations for a user](/v3/orgs/#list-organizations-for-a-user)
@@ -587,7 +588,7 @@ While most of your API interaction should occur using your server-to-server inst
##### Reactions
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}* [Delete a reaction](/v3/reactions/#delete-a-reaction-legacy){% else %}* [Delete a reaction](/v3/reactions/#delete-a-reaction){% endif %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}* [Delete a reaction](/v3/reactions/#delete-a-reaction-legacy){% else %}* [Delete a reaction](/v3/reactions/#delete-a-reaction){% endif %}
* [List reactions for a commit comment](/v3/reactions/#list-reactions-for-a-commit-comment)
* [Create reaction for a commit comment](/v3/reactions/#create-reaction-for-a-commit-comment)
* [List reactions for an issue](/v3/reactions/#list-reactions-for-an-issue)
@@ -599,7 +600,7 @@ While most of your API interaction should occur using your server-to-server inst
* [List reactions for a team discussion comment](/v3/reactions/#list-reactions-for-a-team-discussion-comment)
* [Create reaction for a team discussion comment](/v3/reactions/#create-reaction-for-a-team-discussion-comment)
* [List reactions for a team discussion](/v3/reactions/#list-reactions-for-a-team-discussion)
-* [Create reaction for a team discussion](/v3/reactions/#create-reaction-for-a-team-discussion){% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
+* [Create reaction for a team discussion](/v3/reactions/#create-reaction-for-a-team-discussion){% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}
* [Delete a commit comment reaction](/v3/reactions/#delete-a-commit-comment-reaction)
* [Delete an issue reaction](/v3/reactions/#delete-an-issue-reaction)
* [Delete a reaction to a commit comment](/v3/reactions/#delete-an-issue-comment-reaction)
@@ -661,7 +662,7 @@ While most of your API interaction should occur using your server-to-server inst
* [Create commit signature protection](/v3/repos/branches/#create-commit-signature-protection)
* [Delete commit signature protection](/v3/repos/branches/#delete-commit-signature-protection)
* [Get status checks protection](/v3/repos/branches/#get-status-checks-protection)
-* [Update status check potection](/v3/repos/branches/#update-status-check-potection)
+* [Update status check protection](/v3/repos/branches/#update-status-check-protection)
* [Remove status check protection](/v3/repos/branches/#remove-status-check-protection)
* [Get all status check contexts](/v3/repos/branches/#get-all-status-check-contexts)
* [Add status check contexts](/v3/repos/branches/#add-status-check-contexts)
@@ -719,7 +720,7 @@ While most of your API interaction should occur using your server-to-server inst
* [Get a repository README](/v3/repos/contents/#get-a-repository-readme)
* [Get the license for a repository](/v3/licenses/#get-the-license-for-a-repository)
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}
##### Repository Event Dispatches
* [Create a repository dispatch event](/v3/repos/#create-a-repository-dispatch-event)
@@ -762,7 +763,7 @@ While most of your API interaction should occur using your server-to-server inst
* [Get GitHub Pages build](/rest/reference/repos#get-github-pages-build)
* [Get latest pages build](/rest/reference/repos#get-latest-pages-build)
-{% if currentVersion != "free-pro-team@latest" %}
+{% if enterpriseServerVersions contains currentVersion %}
##### Repository Pre Receive Hooks
* [List pre-receive hooks for a repository](/enterprise/user/rest/reference/enterprise-admin#list-pre-receive-hooks-for-a-repository)
@@ -821,7 +822,7 @@ While most of your API interaction should occur using your server-to-server inst
* [List commit statuses for a reference](/v3/repos/statuses/#list-commit-statuses-for-a-reference)
* [Create a commit status](/v3/repos/statuses/#create-a-commit-status)
-##### Team Discussions
+##### Team Discussions
* [List discussions](/v3/teams/discussions/#list-discussions)
* [Create a discussion](/v3/teams/discussions/#create-a-discussion)
@@ -861,6 +862,7 @@ While most of your API interaction should occur using your server-to-server inst
* [Unblock a user](/v3/users/blocking/#unblock-a-user)
{% endif %}
+{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
##### User Emails
{% if currentVersion == "free-pro-team@latest" %}
@@ -870,6 +872,7 @@ While most of your API interaction should occur using your server-to-server inst
* [Add email address(es)](/v3/users/emails/#add-an-email-address-for-the-authenticated-user)
* [Delete email address(es)](/v3/users/emails/#delete-an-email-address-for-the-authenticated-user)
* [List public email addresses for the authenticated user](/v3/users/emails/#list-public-email-addresses-for-the-authenticated-user)
+{% endif %}
##### User Followers
diff --git a/content/developers/apps/index.md b/content/developers/apps/index.md
index 5032b671b3ff..1b6f13d10f32 100644
--- a/content/developers/apps/index.md
+++ b/content/developers/apps/index.md
@@ -12,6 +12,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% topic_link_in_list /getting-started-with-apps %}
diff --git a/content/developers/apps/installing-github-apps.md b/content/developers/apps/installing-github-apps.md
index efa6d27ffd17..3e54b9d62226 100644
--- a/content/developers/apps/installing-github-apps.md
+++ b/content/developers/apps/installing-github-apps.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% note %}
@@ -49,17 +50,17 @@ These steps assume you have [built a {% data variables.product.prodname_github_a
3. GitHub provides a landing page for your app that includes a link to your app's "Homepage URL." To visit the landing page on GitHub, copy the URL from "Public link" and paste it into a browser.
-4. Create a homepage for your app that includes the app installation URL: `https://github.com/apps//installations/new`.
+4. Create a homepage for your app that includes the app installation URL: `{% data variables.product.oauth_host_code %}/apps//installations/new`.
### Authorizing users during installation
You can simplify the authorization process by completing it during app installation. To do this, select **Request user authorization (OAuth) during installation** when creating or modifying your app in GitHub. See "[Creating a GitHub App](/apps/building-github-apps/creating-a-github-app/)" to learn more.
-Once someone has installed your app, you will need to get an access token for the user. See steps 2 and 3 in "[Identifying a users on your site](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site)" to learn more.
+Once someone has installed your app, you will need to get an access token for the user. See steps 2 and 3 in "[Identifying users on your site](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site)" to learn more.
### Preserving an application state during installation
You can provide a `state` parameter in an app's installation URL to preserve the state of the application page and return people back to that state after they install, authenticate, or accept updates to your GitHub App. For example, you could use the `state` to correlate an installation to a user or account.
To preserve a state, add it to the installation URL:
-`https://github.com/apps//installations/new?state=AB12t`
+`{% data variables.product.oauth_host_code %}/apps//installations/new?state=AB12t`
diff --git a/content/developers/apps/making-a-github-app-public-or-private.md b/content/developers/apps/making-a-github-app-public-or-private.md
index 7a37420d8694..779af339cb72 100644
--- a/content/developers/apps/making-a-github-app-public-or-private.md
+++ b/content/developers/apps/making-a-github-app-public-or-private.md
@@ -10,6 +10,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
For authentication information, see "[Authenticating with GitHub Apps](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation)."
diff --git a/content/developers/apps/managing-github-apps.md b/content/developers/apps/managing-github-apps.md
index b306976b4bf8..fb3b9c3934b7 100644
--- a/content/developers/apps/managing-github-apps.md
+++ b/content/developers/apps/managing-github-apps.md
@@ -8,5 +8,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/developers/apps/managing-oauth-apps.md b/content/developers/apps/managing-oauth-apps.md
index 87bf3cde9383..e1bf769dedc6 100644
--- a/content/developers/apps/managing-oauth-apps.md
+++ b/content/developers/apps/managing-oauth-apps.md
@@ -8,5 +8,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/developers/apps/migrating-oauth-apps-to-github-apps.md b/content/developers/apps/migrating-oauth-apps-to-github-apps.md
index 366b5d317602..b53a4c5a87a8 100644
--- a/content/developers/apps/migrating-oauth-apps-to-github-apps.md
+++ b/content/developers/apps/migrating-oauth-apps-to-github-apps.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
@@ -18,7 +19,7 @@ This article provides guidelines for existing integrators who are considering mi
- [Fine-grained permissions](/apps/differences-between-apps/#requesting-permission-levels-for-resources) target the specific information a GitHub App can access, allowing the app to be more widely used by people and organizations with security policies than OAuth Apps, which cannot be limited by permissions.
- [Short-lived tokens](/apps/differences-between-apps/#token-based-identification) provide a more secure authentication method over OAuth tokens. An OAuth token does not expire until the person who authorized the OAuth App revokes the token. GitHub Apps use tokens that expire quickly, creating a much smaller window of time for compromised tokens to be in use.
- [Built-in, centralized webhooks](/apps/differences-between-apps/#webhooks) receive events for all repositories and organizations the app can access. Conversely, OAuth Apps require configuring a webhook for each repository and organization accessible to the user.
-- [Bot accounts](/apps/differences-between-apps/#machine-vs-bot-accounts) don't consume a {% data variables.product.prodname_ghe_server %} seat and remain installed even when the person who initially installed the app leaves the organization.
+- [Bot accounts](/apps/differences-between-apps/#machine-vs-bot-accounts) don't consume a {% data variables.product.product_name %} seat and remain installed even when the person who initially installed the app leaves the organization.
- Built-in support for OAuth is still available to GitHub Apps using [user-to-server endpoints](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/).
- Dedicated [API rate limits](/apps/building-github-apps/understanding-rate-limits-for-github-apps/) for bot accounts scale with your integration.
- Repository owners can [install GitHub Apps](/apps/differences-between-apps/#who-can-install-github-apps-and-authorize-oauth-apps) on organization repositories. If a GitHub App's configuration has permissions that request an organization's resources, the org owner must approve the installation.
diff --git a/content/developers/apps/modifying-a-github-app.md b/content/developers/apps/modifying-a-github-app.md
index a50e97ce4cf8..47392e13f0d8 100644
--- a/content/developers/apps/modifying-a-github-app.md
+++ b/content/developers/apps/modifying-a-github-app.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.user-settings.access_settings %}
diff --git a/content/developers/apps/modifying-an-oauth-app.md b/content/developers/apps/modifying-an-oauth-app.md
index 2796101a6e40..73beec333732 100644
--- a/content/developers/apps/modifying-an-oauth-app.md
+++ b/content/developers/apps/modifying-an-oauth-app.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.user-settings.access_settings %}
diff --git a/content/developers/apps/rate-limits-for-github-apps.md b/content/developers/apps/rate-limits-for-github-apps.md
index 38affc94e201..e25d374ee18c 100644
--- a/content/developers/apps/rate-limits-for-github-apps.md
+++ b/content/developers/apps/rate-limits-for-github-apps.md
@@ -9,6 +9,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Server-to-server requests
@@ -45,7 +46,7 @@ Different user-to-server request rate limits apply to {% data variables.product.
{% endif %}
-User-to-server requests are rate limited at 5,000 requests per hour and per authenticated user. All OAuth applications authorized by that user, personal access tokens owned by that user, and requests authenticated with that user's username and password share the same quota of 5,000 requests per hour for that user.
+User-to-server requests are rate limited at 5,000 requests per hour and per authenticated user. All OAuth applications authorized by that user, personal access tokens owned by that user, and requests authenticated with that user's{% if currentVersion == "github-ae@latest" %} token{% else %} username and password{% endif %} share the same quota of 5,000 requests per hour for that user.
{% if currentVersion == "free-pro-team@latest" %}
diff --git a/content/developers/apps/refreshing-user-to-server-access-tokens.md b/content/developers/apps/refreshing-user-to-server-access-tokens.md
index f53e79a02ad3..232066f43f63 100644
--- a/content/developers/apps/refreshing-user-to-server-access-tokens.md
+++ b/content/developers/apps/refreshing-user-to-server-access-tokens.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '>=2.22'
+ github-ae: '*'
---
diff --git a/content/developers/apps/scopes-for-oauth-apps.md b/content/developers/apps/scopes-for-oauth-apps.md
index 35d6de82c16c..da1c5b3d569f 100644
--- a/content/developers/apps/scopes-for-oauth-apps.md
+++ b/content/developers/apps/scopes-for-oauth-apps.md
@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
When setting up an OAuth App on GitHub, requested scopes are displayed to the user on the authorization form.
@@ -18,7 +19,7 @@ When setting up an OAuth App on GitHub, requested scopes are displayed to the us
{% endnote %}
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}
If your {% data variables.product.prodname_oauth_app %} doesn't have access to a browser, such as a CLI tool, then you don't need to specify a scope for users to authenticate to your app. For more information, see "[Authorizing OAuth apps](/developers/apps/authorizing-oauth-apps#device-flow)."
{% endif %}
@@ -38,13 +39,13 @@ X-Accepted-OAuth-Scopes: user
Name | Description
-----|-----------|
-**`(no scope)`** | Grants read-only access to public information (includes public user profile info, public repository info, and gists){% if currentVersion != "free-pro-team@latest" %}
+**`(no scope)`** | Grants read-only access to public information (includes public user profile info, public repository info, and gists){% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
**`site_admin`** | Grants site administrators access to [{% data variables.product.prodname_ghe_server %} Administration API endpoints](/v3/enterprise-admin).{% endif %}
**`repo`** | Grants full access to private and public repositories. That includes read/write access to code, commit statuses, repository and organization projects, invitations, collaborators, adding team memberships, deployment statuses, and repository webhooks for public and private repositories and organizations. Also grants ability to manage user projects.
`repo:status`| Grants read/write access to public and private repository commit statuses. This scope is only necessary to grant other users or services access to private repository commit statuses *without* granting access to the code.
`repo_deployment`| Grants access to [deployment statuses](/v3/repos/deployments) for public and private repositories. This scope is only necessary to grant other users or services access to deployment statuses, *without* granting access to the code.
`public_repo`| Limits access to public repositories. That includes read/write access to code, commit statuses, repository projects, collaborators, and deployment statuses for public repositories and organizations. Also required for starring public repositories.
- `repo:invite` | Grants accept/decline abilities for invitations to collaborate on a repository. This scope is only necessary to grant other users or services access to invites *without* granting access to the code.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21"%}
+ `repo:invite` | Grants accept/decline abilities for invitations to collaborate on a repository. This scope is only necessary to grant other users or services access to invites *without* granting access to the code.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest"%}
`security_events` | Grants read and write access to security events in the [{% data variables.product.prodname_code_scanning %} API](/v3/code-scanning).{% endif %}
**`admin:repo_hook`** | Grants read, write, ping, and delete access to repository hooks in public and private repositories. The `repo` and `public_repo` scopes grants full access to repositories, including repository hooks. Use the `admin:repo_hook` scope to limit access to only repository hooks.
`write:repo_hook` | Grants read, write, and ping access to hooks in public or private repositories.
diff --git a/content/developers/apps/setting-permissions-for-github-apps.md b/content/developers/apps/setting-permissions-for-github-apps.md
index aea8157d923e..f63d641cdbf1 100644
--- a/content/developers/apps/setting-permissions-for-github-apps.md
+++ b/content/developers/apps/setting-permissions-for-github-apps.md
@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
When you create a GitHub App, you can select the permissions it needs to access end user data. Permissions can also be added and removed. For more information, see "[Editing a GitHub App's permissions](/apps/managing-github-apps/editing-a-github-app-s-permissions/)."
diff --git a/content/developers/apps/setting-up-your-development-environment-to-create-a-github-app.md b/content/developers/apps/setting-up-your-development-environment-to-create-a-github-app.md
index 4cfc2fca6f93..56485e1550f0 100644
--- a/content/developers/apps/setting-up-your-development-environment-to-create-a-github-app.md
+++ b/content/developers/apps/setting-up-your-development-environment-to-create-a-github-app.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
@@ -261,7 +262,7 @@ Before you can use the Octokit.rb library to make API calls, you'll need to init
# Instantiate an Octokit client authenticated as a GitHub App.
# GitHub App authentication requires that you construct a
# JWT (https://jwt.io/introduction/) signed with the app's private key,
-# so GitHub can be sure that it came from the app an not altererd by
+# so GitHub can be sure that it came from the app an not altered by
# a malicious third party.
def authenticate_app
payload = {
diff --git a/content/developers/apps/transferring-ownership-of-a-github-app.md b/content/developers/apps/transferring-ownership-of-a-github-app.md
index 64f7e13978b8..118908599d38 100644
--- a/content/developers/apps/transferring-ownership-of-a-github-app.md
+++ b/content/developers/apps/transferring-ownership-of-a-github-app.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.user-settings.access_settings %}
diff --git a/content/developers/apps/transferring-ownership-of-an-oauth-app.md b/content/developers/apps/transferring-ownership-of-an-oauth-app.md
index a3c259d2c922..59d1b1adc382 100644
--- a/content/developers/apps/transferring-ownership-of-an-oauth-app.md
+++ b/content/developers/apps/transferring-ownership-of-an-oauth-app.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.user-settings.access_settings %}
diff --git a/content/developers/apps/troubleshooting-authorization-request-errors.md b/content/developers/apps/troubleshooting-authorization-request-errors.md
index 8eab22a7fa18..4620a4aa352b 100644
--- a/content/developers/apps/troubleshooting-authorization-request-errors.md
+++ b/content/developers/apps/troubleshooting-authorization-request-errors.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Application suspended
diff --git a/content/developers/apps/troubleshooting-oauth-app-access-token-request-errors.md b/content/developers/apps/troubleshooting-oauth-app-access-token-request-errors.md
index 379e602307eb..c6b54ed2b21b 100644
--- a/content/developers/apps/troubleshooting-oauth-app-access-token-request-errors.md
+++ b/content/developers/apps/troubleshooting-oauth-app-access-token-request-errors.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% note %}
diff --git a/content/developers/apps/using-content-attachments.md b/content/developers/apps/using-content-attachments.md
index fcf93d4a351e..ec1478e69371 100644
--- a/content/developers/apps/using-content-attachments.md
+++ b/content/developers/apps/using-content-attachments.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.pre-release-program.content-attachments-public-beta %}
diff --git a/content/developers/apps/using-the-github-api-in-your-app.md b/content/developers/apps/using-the-github-api-in-your-app.md
index ebf3bfea0bbe..c27a05e03c1c 100644
--- a/content/developers/apps/using-the-github-api-in-your-app.md
+++ b/content/developers/apps/using-the-github-api-in-your-app.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/developers/github-marketplace/rest-endpoints-for-the-github-marketplace-api.md b/content/developers/github-marketplace/rest-endpoints-for-the-github-marketplace-api.md
index ffbc4c69fc03..5ad1d2f177c6 100644
--- a/content/developers/github-marketplace/rest-endpoints-for-the-github-marketplace-api.md
+++ b/content/developers/github-marketplace/rest-endpoints-for-the-github-marketplace-api.md
@@ -1,6 +1,6 @@
---
title: REST endpoints for the GitHub Marketplace API
-intro: 'To help manage your app on {% data variables.product.prodname_marketplace %}, use these {% data variables.product.prodname_marketplace %} API endoints.'
+intro: 'To help manage your app on {% data variables.product.prodname_marketplace %}, use these {% data variables.product.prodname_marketplace %} API endpoints.'
redirect_from:
- /apps/marketplace/github-marketplace-api-endpoints/
- /apps/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-rest-api-endpoints/
diff --git a/content/developers/index.md b/content/developers/index.md
index cd9dc830ba50..81987f268f6f 100644
--- a/content/developers/index.md
+++ b/content/developers/index.md
@@ -4,6 +4,7 @@ intro: 'Go deeper with {% data variables.product.prodname_dotcom %} by integrati
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% link_with_intro /overview %}
diff --git a/content/developers/overview/about-githubs-apis.md b/content/developers/overview/about-githubs-apis.md
index 4d21a0f8419f..39e74b19f1e3 100644
--- a/content/developers/overview/about-githubs-apis.md
+++ b/content/developers/overview/about-githubs-apis.md
@@ -6,26 +6,15 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt '2.9' %}
-
There are two stable versions of the GitHub API: the [REST API](/v3/) and the [GraphQL API](/v4/).
-{% else %}
-
-The latest stable version of the GitHub API is the [REST API](/v3/).
-
-{% endif %}
-
When using the REST API, we encourage you to [request v3 via the `Accept` header](/v3/media/#request-specific-version).
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt '2.9' %}
-
For information on using the GraphQL API, see the [v4 docs](/v4/).
-{% endif %}
-
## Deprecated versions
### beta
diff --git a/content/developers/overview/github-developer-program.md b/content/developers/overview/github-developer-program.md
index 343241fd6fcc..8ecaa853aa7c 100644
--- a/content/developers/overview/github-developer-program.md
+++ b/content/developers/overview/github-developer-program.md
@@ -19,7 +19,7 @@ Build your own tools that seamlessly integrate with the place you push code ever
## Take on the enterprise
-[Obtain developer licenses](http://github.com/contact?form%5Bsubject%5D=Development+licenses) to build and test your application against {% data variables.product.prodname_ghe_server %}.
+[Obtain developer licenses](http://github.com/contact?form%5Bsubject%5D=Development+licenses) to build and test your application against {% data variables.product.prodname_ghe_server %} or {% data variables.product.prodname_ghe_managed %}.
## Have an integration that works with GitHub?
diff --git a/content/developers/overview/index.md b/content/developers/overview/index.md
index 344dda0b0155..3e6bb65ca283 100644
--- a/content/developers/overview/index.md
+++ b/content/developers/overview/index.md
@@ -1,9 +1,10 @@
---
title: Overview
-intro: 'Learn about {% data variables.product.prodname_dotcom %}''s APIs, secure your deployments, and join {% data variables.product.prodname_dotcom %}''s Developer Program.'
+intro: 'Learn about {% data variables.product.prodname_dotcom %}''s APIs{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} and secure your deployments.{% else %}, secure your deployments, and join {% data variables.product.prodname_dotcom %}''s Developer Program.{% endif %}'
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Table of Contents
diff --git a/content/developers/overview/managing-deploy-keys.md b/content/developers/overview/managing-deploy-keys.md
index 790d9bdf2dd7..cb08aae7043f 100644
--- a/content/developers/overview/managing-deploy-keys.md
+++ b/content/developers/overview/managing-deploy-keys.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/developers/overview/replacing-github-services.md b/content/developers/overview/replacing-github-services.md
index eb1925fc9e60..878a316bd5b2 100644
--- a/content/developers/overview/replacing-github-services.md
+++ b/content/developers/overview/replacing-github-services.md
@@ -29,7 +29,7 @@ As an alternative to the email service, you can now start using email notificati
GitHub Services (sometimes referred to as Service Hooks) is the legacy method of integrating where GitHub hosted a portion of our integrator’s services via [the `github-services` repository](https://github.com/github/github-services). Actions performed on GitHub trigger these services, and you can use these services to trigger actions outside of GitHub.
-{% if currentVersion != "free-pro-team@latest" %}
+{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
### Finding repositories that use GitHub Services
We provide a command-line script that helps you identify which repositories on your appliance use GitHub Services. For more information, see [ghe-legacy-github-services-report](/enterprise/{{currentVersion}}/admin/articles/command-line-utilities/#ghe-legacy-github-services-report).{% endif %}
diff --git a/content/developers/overview/using-ssh-agent-forwarding.md b/content/developers/overview/using-ssh-agent-forwarding.md
index 2cc54b180822..81b5ffbd5f04 100644
--- a/content/developers/overview/using-ssh-agent-forwarding.md
+++ b/content/developers/overview/using-ssh-agent-forwarding.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
@@ -21,10 +22,10 @@ Check out [Steve Friedl's Tech Tips guide][tech-tips] for a more detailed explan
Ensure that your own SSH key is set up and working. You can use [our guide on generating SSH keys][generating-keys] if you've not done this yet.
-You can test that your local key works by entering `ssh -T git@github.com` in the terminal:
+You can test that your local key works by entering `ssh -T git@{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}hostname{% else %}github.com{% endif %}` in the terminal:
```shell
-$ ssh -T git@github.com
+$ ssh -T git@{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}hostname{% else %}github.com{% endif %}
# Attempt to SSH in to github
> Hi username! You've successfully authenticated, but GitHub does not provide
> shell access.
@@ -47,7 +48,7 @@ We're off to a great start. Let's set up SSH to allow agent forwarding to your s
### Testing SSH agent forwarding
-To test that agent forwarding is working with your server, you can SSH into your server and run `ssh -T git@github.com` once more. If all is well, you'll get back the same prompt as you did locally.
+To test that agent forwarding is working with your server, you can SSH into your server and run `ssh -T git@{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}hostname{% else %}github.com{% endif %}` once more. If all is well, you'll get back the same prompt as you did locally.
If you're unsure if your local key is being used, you can also inspect the `SSH_AUTH_SOCK` variable on your server:
@@ -63,7 +64,7 @@ If the variable is not set, it means that agent forwarding is not working:
$ echo "$SSH_AUTH_SOCK"
# Print out the SSH_AUTH_SOCK variable
> [No output]
-$ ssh -T git@github.com
+$ ssh -T git@{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}hostname{% else %}github.com{% endif %}
# Try to SSH to github
> Permission denied (publickey).
```
@@ -78,7 +79,7 @@ SSH forwarding only works with SSH URLs, not HTTP(s) URLs. Check the *.git/confi
```shell
[remote "origin"]
- url = git@github.com:yourAccount/yourProject.git
+ url = git@{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}hostname{% else %}github.com{% endif %}:yourAccount/yourProject.git
fetch = +refs/heads/*:refs/remotes/origin/*
```
diff --git a/content/developers/webhooks-and-events/about-webhooks.md b/content/developers/webhooks-and-events/about-webhooks.md
index 64b973bcf586..5287299c6133 100644
--- a/content/developers/webhooks-and-events/about-webhooks.md
+++ b/content/developers/webhooks-and-events/about-webhooks.md
@@ -6,14 +6,15 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Webhooks allow you to build or set up integrations, such as [{% data variables.product.prodname_github_app %}s](/apps/building-github-apps/) or [{% data variables.product.prodname_oauth_app %}s](/apps/building-oauth-apps/), which subscribe to certain events on GitHub.com. When one of those events is triggered, we'll send a HTTP POST payload to the webhook's configured URL. Webhooks can be used to update an external issue tracker, trigger CI builds, update a backup mirror, or even deploy to your production server. You're only limited by your imagination.
-Webhooks can be installed on{% if currentVersion != "free-pro-team@latest" %} a [{% data variables.product.prodname_ghe_server %} instance](/rest/reference/enterprise-admin#global-webhooks/),{% endif %} an [organization][org-hooks], a specific [repository][repo-hooks], or a {% data variables.product.prodname_github_app %}. Once installed, the webhook will be sent each time one or more subscribed events occurs.
+Webhooks can be installed on{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} [{% data variables.product.prodname_enterprise %}](/rest/reference/enterprise-admin#global-webhooks/),{% endif %} an [organization][org-hooks], a specific [repository][repo-hooks], or a {% data variables.product.prodname_github_app %}. Once installed, the webhook will be sent each time one or more subscribed events occurs.
-You can create up to {% if currentVersion != "free-pro-team@latest" %}250{% else %}20{% endif %} webhooks for each event on each installation target {% if currentVersion != "free-pro-team@latest" %}({% data variables.product.prodname_ghe_server %} instance, specific organization, or specific repository).{% else %}(specific organization or specific repository).{% endif %}
+You can create up to {% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}250{% else %}20{% endif %} webhooks for each event on each installation target {% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}({% data variables.product.prodname_ghe_server %} instance, specific organization, or specific repository).{% else %}(specific organization or specific repository).{% endif %}
### Events
diff --git a/content/developers/webhooks-and-events/configuring-your-server-to-receive-payloads.md b/content/developers/webhooks-and-events/configuring-your-server-to-receive-payloads.md
index f1d83bf5705f..c4787dcc97ce 100644
--- a/content/developers/webhooks-and-events/configuring-your-server-to-receive-payloads.md
+++ b/content/developers/webhooks-and-events/configuring-your-server-to-receive-payloads.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/developers/webhooks-and-events/creating-webhooks.md b/content/developers/webhooks-and-events/creating-webhooks.md
index 675e45372dbc..c3723d70a3c0 100644
--- a/content/developers/webhooks-and-events/creating-webhooks.md
+++ b/content/developers/webhooks-and-events/creating-webhooks.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
@@ -14,6 +15,9 @@ Now that we understand [the basics of webhooks][webhooks-overview], let's go thr
Creating a webhook is a two-step process. You'll first need to set up how you want your webhook to behave through {% data variables.product.product_name %}--what events should it listen to. After that, you'll set up your server to receive and manage the payload.
+
+{% data reusables.webhooks.webhooks-rest-api-links %}
+
### Setting up a Webhook
You can install webhooks on an organization or on a specific repository.
diff --git a/content/developers/webhooks-and-events/events.md b/content/developers/webhooks-and-events/events.md
index 141a624843ab..6fead511c2a3 100644
--- a/content/developers/webhooks-and-events/events.md
+++ b/content/developers/webhooks-and-events/events.md
@@ -5,5 +5,6 @@ mapTopic: true
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/developers/webhooks-and-events/github-event-types.md b/content/developers/webhooks-and-events/github-event-types.md
index 4d0dd43258ff..59e03010adb9 100644
--- a/content/developers/webhooks-and-events/github-event-types.md
+++ b/content/developers/webhooks-and-events/github-event-types.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
@@ -28,13 +29,13 @@ The event objects returned from the Events API endpoints have the same structure
| `actor.id` | The unique identifier for the actor. |
| `actor.login` | The username of the actor. |
| `actor.display_login` | The specific display format of the username. |
-| `actor.gravatar_id` | The unique indentifier of the Gravatar profile for the actor. |
+| `actor.gravatar_id` | The unique identifier of the Gravatar profile for the actor. |
| `actor.url` | The REST API URL used to retrieve the user object, which includes additional user information. |
| `actor.avatar_url` | The URL of the actor's profile image. |
| `repo` | The repository object where the event occurred. |
| `repo.id` | The unique identifier of the repository. |
| `repo.name` | The name of the repository, which includes the owner and repository name. For example, `octocat/hello-world` is the name of the `hello-world` repository owned by the `octocat` user account. |
-| `repo.url` | The REST API URL used to retrive the repository object, which includes additional repository information. |
+| `repo.url` | The REST API URL used to retrieve the repository object, which includes additional repository information. |
| `payload` | The event payload object is unique to the event type. See the event type below for the event API `payload` object. |
#### Example WatchEvent event object
diff --git a/content/developers/webhooks-and-events/index.md b/content/developers/webhooks-and-events/index.md
index b8799959352e..8fe5ba3cd8d9 100644
--- a/content/developers/webhooks-and-events/index.md
+++ b/content/developers/webhooks-and-events/index.md
@@ -4,6 +4,7 @@ intro: 'You can set up, test, and secure webhooks so your integrations can subsc
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Table of Contents
diff --git a/content/developers/webhooks-and-events/issue-event-types.md b/content/developers/webhooks-and-events/issue-event-types.md
index ec26edefe7ae..9e36461b96ec 100644
--- a/content/developers/webhooks-and-events/issue-event-types.md
+++ b/content/developers/webhooks-and-events/issue-event-types.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
@@ -229,7 +230,7 @@ Name | Type | Description
-----|------|--------------
`actor` | `object` | The person who generated the event.
`created_at` | `string` | The timestamp indicating when the cross-reference was added.
-`updated_at` | `string` | The timestamp indicating when the cross-refererence was updated or created, if the cross-reference is never updated.
+`updated_at` | `string` | The timestamp indicating when the cross-reference was updated or created, if the cross-reference is never updated.
`source` | `object` | The issue or pull request that added a cross-reference.
`source[type]` | `string` | This value will always be `"issue"` because pull requests are of type issue. Only cross-reference events triggered by issues or pull requests are returned in the Timeline Events API. To determine if the issue that triggered the event is a pull request, you can check if the `source[issue][pull_request` object exists.
`source[issue]` | `object` | The `issue` object that added the cross-reference.
@@ -348,7 +349,7 @@ The issue or pull request was locked.
#### Event object properties
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
{% data reusables.pre-release-program.sailor-v-preview %}
{% data reusables.pre-release-program.api-preview-warning %}
{% endif %}
@@ -668,7 +669,7 @@ The issue was unlocked.
#### Event object properties
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
{% data reusables.pre-release-program.sailor-v-preview %}
{% data reusables.pre-release-program.api-preview-warning %}
{% endif %}
diff --git a/content/developers/webhooks-and-events/securing-your-webhooks.md b/content/developers/webhooks-and-events/securing-your-webhooks.md
index 4cbe3ab69618..9061e6ff10ad 100644
--- a/content/developers/webhooks-and-events/securing-your-webhooks.md
+++ b/content/developers/webhooks-and-events/securing-your-webhooks.md
@@ -6,12 +6,14 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Once your server is configured to receive payloads, it'll listen for any payload sent to the endpoint you configured. For security reasons, you probably want to limit requests to those coming from GitHub. There are a few ways to go about this--for example, you could opt to allow requests from GitHub's IP address--but a far easier method is to set up a secret token and validate the information.
+{% data reusables.webhooks.webhooks-rest-api-links %}
### Setting your secret token
@@ -34,9 +36,9 @@ $ export SECRET_TOKEN=your_token
### Validating payloads from GitHub
-When your secret token is set, {% data variables.product.product_name %} uses it to create a hash signature with each payload. This hash signature is included with the headers of each request as {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "private-instances@latest" %}`X-Hub-Signature-256`{% else if currentVersion ver_lt "enterprise-server@2.23" %}`X-Hub-Signature`{% endif %}.
+When your secret token is set, {% data variables.product.product_name %} uses it to create a hash signature with each payload. This hash signature is included with the headers of each request as {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}`X-Hub-Signature-256`{% elsif currentVersion ver_lt "enterprise-server@2.23" %}`X-Hub-Signature`{% endif %}.
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "private-instances@latest" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
{% note %}
**Note:** For backward-compatibility, we also include the `X-Hub-Signature` header that is generated using the SHA-1 hash function. If possible, we recommend that you use the `X-Hub-Signature-256` header for improved security. The example below demonstrate using the `X-Hub-Signature-256` header.
@@ -67,11 +69,11 @@ post '/payload' do
"I got some JSON: #{push.inspect}"
end
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "private-instances@latest" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}
def verify_signature(payload_body)
signature = 'sha256=' + OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'), ENV['SECRET_TOKEN'], payload_body)
return halt 500, "Signatures didn't match!" unless Rack::Utils.secure_compare(signature, request.env['HTTP_X_HUB_SIGNATURE_2'])
-end{% else if currentVersion ver_lt "enterprise-server@2.23" %}
+end{% elsif currentVersion ver_lt "enterprise-server@2.23" %}
def verify_signature(payload_body)
signature = 'sha1=' + OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha1'), ENV['SECRET_TOKEN'], payload_body)
return halt 500, "Signatures didn't match!" unless Rack::Utils.secure_compare(signature, request.env['HTTP_X_HUB_SIGNATURE'])
@@ -80,7 +82,7 @@ end{% endif %}
Your language and server implementations may differ from this example code. However, there are a number of very important things to point out:
-* No matter which implementation you use, the hash signature starts with {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or "private-instances@latest" %}`sha256=`{% else if currentVersion ver_lt "enterprise-server@2.23" %}`sha1=`{% endif %}, using the key of your secret token and your payload body.
+* No matter which implementation you use, the hash signature starts with {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or "github-ae@latest" %}`sha256=`{% elsif currentVersion ver_lt "enterprise-server@2.23" %}`sha1=`{% endif %}, using the key of your secret token and your payload body.
* Using a plain `==` operator is **not advised**. A method like [`secure_compare`][secure_compare] performs a "constant time" string comparison, which helps mitigate certain timing attacks against regular equality operators.
diff --git a/content/developers/webhooks-and-events/testing-webhooks.md b/content/developers/webhooks-and-events/testing-webhooks.md
index 0c6913ce586b..37357733633b 100644
--- a/content/developers/webhooks-and-events/testing-webhooks.md
+++ b/content/developers/webhooks-and-events/testing-webhooks.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/developers/webhooks-and-events/webhook-events-and-payloads.md b/content/developers/webhooks-and-events/webhook-events-and-payloads.md
index 41f03e44d1f1..ee273ce0d1bb 100644
--- a/content/developers/webhooks-and-events/webhook-events-and-payloads.md
+++ b/content/developers/webhooks-and-events/webhook-events-and-payloads.md
@@ -9,6 +9,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
@@ -47,10 +48,10 @@ HTTP POST payloads that are delivered to your webhook's configured URL endpoint
Header | Description
-------|-------------|
`X-GitHub-Event`| Name of the event that triggered the delivery.
-`X-GitHub-Delivery`| A [GUID](http://en.wikipedia.org/wiki/Globally_unique_identifier) to identify the delivery.{% if currentVersion != "free-pro-team@latest" %}
+`X-GitHub-Delivery`| A [GUID](http://en.wikipedia.org/wiki/Globally_unique_identifier) to identify the delivery.{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
`X-GitHub-Enterprise-Version` | The version of the {% data variables.product.prodname_ghe_server %} instance that sent the HTTP POST payload.
-`X-GitHub-Enterprise-Host` | The hostname of the {% data variables.product.prodname_ghe_server %} instance that sent the HTTP POST payload.{% endif %}{% if currentVersion != "private-instances@latest" %}
-`X-Hub-Signature`| This header is sent if the webhook is configured with a [`secret`](/v3/repos/hooks/#create-hook-config-params). This is the HMAC hex digest of the request body, and is generated using the SHA-1 hash function and the `secret` as the HMAC `key`.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} `X-Hub-Signature` is provided for compatibility with existing integrations, and we recommend that you use the more secure `X-Hub-Signature-256` instead.{% endif %}{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "private-instances@latest" %}
+`X-GitHub-Enterprise-Host` | The hostname of the {% data variables.product.prodname_ghe_server %} instance that sent the HTTP POST payload.{% endif %}{% if currentVersion != "github-ae@latest" %}
+`X-Hub-Signature`| This header is sent if the webhook is configured with a [`secret`](/v3/repos/hooks/#create-hook-config-params). This is the HMAC hex digest of the request body, and is generated using the SHA-1 hash function and the `secret` as the HMAC `key`.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} `X-Hub-Signature` is provided for compatibility with existing integrations, and we recommend that you use the more secure `X-Hub-Signature-256` instead.{% endif %}{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}
`X-Hub-Signature-256`| This header is sent if the webhook is configured with a [`secret`](/v3/repos/hooks/#create-hook-config-params). This is the HMAC hex digest of the request body, and is generated using the SHA-256 hash function and the `secret` as the HMAC `key`.{% endif %}
Also, the `User-Agent` for the requests will have the prefix `GitHub-Hookshot/`.
@@ -61,10 +62,10 @@ Also, the `User-Agent` for the requests will have the prefix `GitHub-Hookshot/`.
> POST /payload HTTP/1.1
> Host: localhost:4567
-> X-GitHub-Delivery: 72d3162e-cc78-11e3-81ab-4c9367dc0958{% if currentVersion != "free-pro-team@latest" %}
+> X-GitHub-Delivery: 72d3162e-cc78-11e3-81ab-4c9367dc0958{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
> X-GitHub-Enterprise-Version: 2.15.0
-> X-GitHub-Enterprise-Host: example.com{% endif %}{% if currentVersion != "private-instances@latest" %}
-> X-Hub-Signature: sha1=7d38cdd689735b008b3c702edd92eea23791c5f6{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "private-instances@latest" %}
+> X-GitHub-Enterprise-Host: example.com{% endif %}{% if currentVersion != "github-ae@latest" %}
+> X-Hub-Signature: sha1=7d38cdd689735b008b3c702edd92eea23791c5f6{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}
> X-Hub-Signature-256: sha256=d57c68ca6f92289e6987922ff26938930f6e66a2d161ef06abdf1859230aa23c{% endif %}
> User-Agent: GitHub-Hookshot/044aadd
> Content-Type: application/json
@@ -144,7 +145,7 @@ Also, the `User-Agent` for the requests will have the prefix `GitHub-Hookshot/`.
{{ webhookPayloadsForCurrentVersion.check_suite.completed }}
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}
### code_scanning_alert
{% data reusables.webhooks.code_scanning_alert_event_short_desc %}
@@ -291,7 +292,7 @@ Only {% data variables.product.prodname_github_app %}s can receive this event. {
#### Webhook payload object
Key | Type | Description
-----|------|-------------{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
+----|------|-------------{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}
`action` |`string` | The action performed. Can be `created`.{% endif %}
`deployment` |`object` | The [deployment](/rest/reference/repos#list-deployments).
{% data reusables.webhooks.repo_desc %}
@@ -316,7 +317,7 @@ Key | Type | Description
#### Webhook payload object
Key | Type | Description
-----|------|-------------{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
+----|------|-------------{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}
`action` |`string` | The action performed. Can be `created`.{% endif %}
`deployment_status` |`object` | The [deployment status](/rest/reference/repos#list-deployment-statuses).
`deployment_status["state"]` |`string` | The new state. Can be `pending`, `success`, `failure`, or `error`.
@@ -332,7 +333,7 @@ Key | Type | Description
{{ webhookPayloadsForCurrentVersion.deployment_status }}
-{% if currentVersion != "free-pro-team@latest" %}
+{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
### enterprise
@@ -429,7 +430,7 @@ Key | Type | Description
{% endnote %}
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}
{% note %}
**Note:** {% data reusables.pre-release-program.suspend-installation-beta %} For more information, see "[Suspending a {% data variables.product.prodname_github_app %} installation](/apps/managing-github-apps/suspending-a-github-app-installation/)."
@@ -617,7 +618,7 @@ For a detailed description of this payload and the payload for each type of `act
### meta
-The webhook this event is configured on was deleted. This event will only listen for changes to the particular hook the event is installed on. Therefore, it must be selected for each hook that you'd like to recieve meta events for.
+The webhook this event is configured on was deleted. This event will only listen for changes to the particular hook the event is installed on. Therefore, it must be selected for each hook that you'd like to receive meta events for.
#### Availability
@@ -667,7 +668,7 @@ Key | Type | Description
#### Availability
-{% if currentVersion != "free-pro-team@latest" %}
+{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
- GitHub Enterprise webhooks only receive `created` and `deleted` events. For more information, "[Global webhooks](/rest/reference/enterprise-admin#global-webhooks/).{% endif %}
- Organization webhooks only receive the `deleted`, `added`, `removed`, `renamed`, and `invited` events
- {% data variables.product.prodname_github_app %}s with the `members` permission
@@ -676,7 +677,7 @@ Key | Type | Description
Key | Type | Description
----|------|-------------
-`action` |`string` | The action that was performed. Can be one of:{% if currentVersion != "free-pro-team@latest" %} `created`,{% endif %} `deleted`, `renamed`, `member_added`, `member_removed`, or `member_invited`.
+`action` |`string` | The action that was performed. Can be one of:{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} `created`,{% endif %} `deleted`, `renamed`, `member_added`, `member_removed`, or `member_invited`.
`invitation` |`object` | The invitation for the user or email if the action is `member_invited`.
`membership` |`object` | The membership between the user and the organization. Not present when the action is `member_invited`.
{% data reusables.webhooks.org_desc %}
@@ -973,13 +974,17 @@ Key | Type | Description
`before`|`string` | The SHA of the most recent commit on `ref` before the push.
`after`|`string` | The SHA of the most recent commit on `ref` after the push.
`commits`|`array` | An array of commit objects describing the pushed commits. (The array includes a maximum of 20 commits. If necessary, you can use the [Commits API](/v3/repos/commits/) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.)
-`commits[][sha]`|`string` | The SHA of the commit.
+`commits[][id]`|`string` | The SHA of the commit.
+`commits[][timestamp]`|`string` | The ISO 8601 timestamp of the commit.
`commits[][message]`|`string` | The commit message.
`commits[][author]`|`object` | The git author of the commit.
`commits[][author][name]`|`string` | The git author's name.
`commits[][author][email]`|`string` | The git author's email address.
`commits[][url]`|`url` | URL that points to the commit API resource.
`commits[][distinct]`|`boolean` | Whether this commit is distinct from any that have been pushed before.
+`commits[][added]`|`array` | An array of files added in the commit.
+`commits[][modified]`|`array` | An array of files modified by the commit.
+`commits[][removed]`|`array` | An array of files removed in the commit.
`pusher` | `object` | The user who pushed the commits.
{% data reusables.webhooks.repo_desc %}
{% data reusables.webhooks.org_desc %}
@@ -1013,7 +1018,7 @@ Key | Type | Description
{{ webhookPayloadsForCurrentVersion.release.published }}
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}
### repository_dispatch
This event occurs when a {% data variables.product.prodname_github_app %} sends a `POST` request to the "[Create a repository dispatch event](/v3/repos/#create-a-repository-dispatch-event)" endpoint.
@@ -1041,7 +1046,7 @@ This event occurs when a {% data variables.product.prodname_github_app %} sends
Key | Type | Description
----|------|-------------
-`action` |`string` | The action that was performed. This can be one of:- `created` - A repository is created.
- `deleted` - A repository is deleted. This event type is only available to [organization hooks](/rest/reference/orgs#webhooks/)
- `archived` - A repository is archived.
- `unarchived` - A repository is unarchived.
{% if currentVersion != "free-pro-team@latest" %}- `anonymous_access_enabled` - A repository is [enabled for anonymous Git access](/v3/previews/#anonymous-git-access-to-repositories), `anonymous_access_disabled` - A repository is [disabled for anonymous Git access](/v3/previews/#anonymous-git-access-to-repositories)
{% endif %}- `edited` - A repository's information is edited.
- `renamed` - A repository is renamed.
- `transferred` - A repository is transferred.
- `publicized` - A repository is made public.
- `privatized` - A repository is made private.
+`action` |`string` | The action that was performed. This can be one of:- `created` - A repository is created.
- `deleted` - A repository is deleted. This event type is only available to [organization hooks](/rest/reference/orgs#webhooks/)
- `archived` - A repository is archived.
- `unarchived` - A repository is unarchived.
{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}- `anonymous_access_enabled` - A repository is [enabled for anonymous Git access](/v3/previews/#anonymous-git-access-to-repositories), `anonymous_access_disabled` - A repository is [disabled for anonymous Git access](/v3/previews/#anonymous-git-access-to-repositories)
{% endif %}- `edited` - A repository's information is edited.
- `renamed` - A repository is renamed.
- `transferred` - A repository is transferred.
- `publicized` - A repository is made public.
- `privatized` - A repository is made private.
{% data reusables.webhooks.repo_desc %}
{% data reusables.webhooks.org_desc %}
{% data reusables.webhooks.app_desc %}
@@ -1243,7 +1248,7 @@ Key | Type | Description
{{ webhookPayloadsForCurrentVersion.team_add }}
-{% if currentVersion != "free-pro-team@latest" %}
+{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
### user
diff --git a/content/developers/webhooks-and-events/webhooks.md b/content/developers/webhooks-and-events/webhooks.md
index 7187f705569c..ce6641349041 100644
--- a/content/developers/webhooks-and-events/webhooks.md
+++ b/content/developers/webhooks-and-events/webhooks.md
@@ -5,5 +5,6 @@ mapTopic: true
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/administering-a-repository/about-branch-restrictions.md b/content/github/administering-a-repository/about-branch-restrictions.md
index 1222abce4995..b203bb268630 100644
--- a/content/github/administering-a-repository/about-branch-restrictions.md
+++ b/content/github/administering-a-repository/about-branch-restrictions.md
@@ -1,12 +1,13 @@
---
title: About branch restrictions
-intro: 'Branches within repositories that belong to organizations can be configured so that only certain users{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.18" %},{% else %} or{% endif %} teams{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.18" %}, or apps{% endif %} can push to the branch.'
+intro: 'Branches within repositories that belong to organizations can be configured so that only certain users, teams, or apps can push to the branch.'
product: '{% data reusables.gated-features.branch-restrictions %}'
redirect_from:
- /articles/about-branch-restrictions
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
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.
diff --git a/content/github/administering-a-repository/about-github-dependabot-version-updates.md b/content/github/administering-a-repository/about-dependabot-version-updates.md
similarity index 51%
rename from content/github/administering-a-repository/about-github-dependabot-version-updates.md
rename to content/github/administering-a-repository/about-dependabot-version-updates.md
index 167fff0c42c7..faa1362b55e0 100644
--- a/content/github/administering-a-repository/about-github-dependabot-version-updates.md
+++ b/content/github/administering-a-repository/about-dependabot-version-updates.md
@@ -1,8 +1,10 @@
---
-title: About GitHub Dependabot version updates
+title: About Dependabot version updates
intro: 'You can use {% data variables.product.prodname_dependabot %} to keep the packages you use updated to the latest versions.'
redirect_from:
- - /github/administering-a-repository/about-github-dependabot
+ - /github/administering-a-repository/about-dependabot
+ - /github/administering-a-repository/about-github-dependabot-version-updates
+
versions:
free-pro-team: '*'
---
@@ -13,11 +15,11 @@ versions:
{% data variables.product.prodname_dependabot %} takes the effort out of maintaining your dependencies. You can use it to ensure that your repository automatically keeps up with the latest releases of the packages and applications it depends on.
-You enable {% data variables.product.prodname_dependabot_version_updates %} by checking a configuration file in to your repository. The configuration file specifies the location of the manifest, or other package definition files, stored in your repository. {% data variables.product.prodname_dependabot_short %} uses this information to check for outdated packages and applications. {% data variables.product.prodname_dependabot_short %} determines if there is a new version of a dependency by looking at the semantic versioning ([semver](https://semver.org/)) of the dependency to decide whether it should update to that version. For certain package managers, {% data variables.product.prodname_dependabot_version_updates %} also supports vendoring. Vendored (or cached) dependencies are dependencies that are checked in to a specific directory in a repository, rather than referenced in a manifest. Vendored dependencies are available at build time even if package servers are unavailable. {% data variables.product.prodname_dependabot_version_updates %} can be configured to check vendored dependencies for new versions and update them if necessary.
+You enable {% data variables.product.prodname_dependabot_version_updates %} by checking a configuration file in to your repository. The configuration file specifies the location of the manifest, or other package definition files, stored in your repository. {% data variables.product.prodname_dependabot %} uses this information to check for outdated packages and applications. {% data variables.product.prodname_dependabot %} determines if there is a new version of a dependency by looking at the semantic versioning ([semver](https://semver.org/)) of the dependency to decide whether it should update to that version. For certain package managers, {% data variables.product.prodname_dependabot_version_updates %} also supports vendoring. Vendored (or cached) dependencies are dependencies that are checked in to a specific directory in a repository, rather than referenced in a manifest. Vendored dependencies are available at build time even if package servers are unavailable. {% data variables.product.prodname_dependabot_version_updates %} can be configured to check vendored dependencies for new versions and update them if necessary.
-When {% data variables.product.prodname_dependabot_short %} identifies an outdated dependency, it raises a pull request to update the manifest to the latest version of the dependency. For vendored dependencies, {% data variables.product.prodname_dependabot_short %} raises a pull request to directly replace the outdated dependency with the new version. You check that your tests pass, review the changelog and release notes included in the pull request summary, and then merge it. For more information, see "[Enabling and disabling version updates](/github/administering-a-repository/enabling-and-disabling-version-updates)."
+When {% data variables.product.prodname_dependabot %} identifies an outdated dependency, it raises a pull request to update the manifest to the latest version of the dependency. For vendored dependencies, {% data variables.product.prodname_dependabot %} raises a pull request to directly replace the outdated dependency with the new version. You check that your tests pass, review the changelog and release notes included in the pull request summary, and then merge it. For more information, see "[Enabling and disabling version updates](/github/administering-a-repository/enabling-and-disabling-version-updates)."
-If you enable security updates, {% data variables.product.prodname_dependabot %} also raises pull requests to update vulnerable dependencies. For more information, see "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-github-dependabot-security-updates)."
+If you enable security updates, {% data variables.product.prodname_dependabot %} also raises pull requests to update vulnerable dependencies. For more information, see "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)."
{% data reusables.dependabot.dependabot-tos %}
@@ -27,7 +29,7 @@ You specify how often to check each ecosystem for new versions in the configurat
{% data reusables.dependabot.initial-updates %}
-If you've enabled security updates, you'll sometimes see extra pull requests for security updates. These are triggered by a {% data variables.product.prodname_dependabot_short %} alert for a dependency on your default branch. {% data variables.product.prodname_dependabot %} automatically raises a pull request to update the vulnerable dependency.
+If you've enabled security updates, you'll sometimes see extra pull requests for security updates. These are triggered by a {% data variables.product.prodname_dependabot %} alert for a dependency on your default branch. {% data variables.product.prodname_dependabot %} automatically raises a pull request to update the vulnerable dependency.
### Supported repositories and ecosystems
diff --git a/content/github/administering-a-repository/about-email-notifications-for-pushes-to-your-repository.md b/content/github/administering-a-repository/about-email-notifications-for-pushes-to-your-repository.md
index 468edaaa1c74..9a23885797d8 100644
--- a/content/github/administering-a-repository/about-email-notifications-for-pushes-to-your-repository.md
+++ b/content/github/administering-a-repository/about-email-notifications-for-pushes-to-your-repository.md
@@ -10,9 +10,10 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
-{% if currentVersion != "free-pro-team@latest" %}{% data reusables.notifications.outbound_email_tip %}{% endif %}
+{% data reusables.notifications.outbound_email_tip %}
Each email notification for a push to a repository lists the new commits and links to a diff containing just those commits. In the email notification you'll see:
@@ -24,7 +25,7 @@ Each email notification for a push to a repository lists the new commits and lin
- The files that were changed as part of the commit
- The commit message
-You can filter email notifications you receive for pushes to a repository. For more information, see {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}"[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#filtering-email-notifications){% else %}"[About notification emails](/github/receiving-notifications-about-activity-on-github/about-email-notifications)." You can also turn off email notifications for pushes. For more information, see "[Choosing the delivery method for your notifications](/enterprise/{{ currentVersion }}/user/github/receiving-notifications-about-activity-on-github/choosing-the-delivery-method-for-your-notifications){% endif %}."
+You can filter email notifications you receive for pushes to a repository. For more information, see {% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.20" %}"[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#filtering-email-notifications){% else %}"[About notification emails](/github/receiving-notifications-about-activity-on-github/about-email-notifications)." You can also turn off email notifications for pushes. For more information, see "[Choosing the delivery method for your notifications](/enterprise/{{ currentVersion }}/user/github/receiving-notifications-about-activity-on-github/choosing-the-delivery-method-for-your-notifications){% endif %}."
### Enabling email notifications for pushes to your repository
@@ -39,7 +40,7 @@ You can filter email notifications you receive for pushes to a repository. For m
### Further reading
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
- "[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications)"
{% else %}
- "[About notifications](/enterprise/{{ currentVersion }}/user/github/receiving-notifications-about-activity-on-github/about-notifications)"
diff --git a/content/github/administering-a-repository/about-merge-methods-on-github.md b/content/github/administering-a-repository/about-merge-methods-on-github.md
index 91a47e1fac48..02d653158a2f 100644
--- a/content/github/administering-a-repository/about-merge-methods-on-github.md
+++ b/content/github/administering-a-repository/about-merge-methods-on-github.md
@@ -6,13 +6,14 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.pull_requests.configure_pull_request_merges_intro %} You can enforce one type of merge method, such as commit squashing or rebasing, by only enabling the desired method for your repository.
{% data reusables.pull_requests.default_merge_option %}
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
The default merge method creates a merge commit. You can prevent anyone from pushing merge commits to a protected branch by enforcing a linear commit history. For more information, see "[Requiring a linear commit history](/github/administering-a-repository/requiring-a-linear-commit-history)."{% endif %}
### Squashing your merge commits
diff --git a/content/github/administering-a-repository/about-protected-branches.md b/content/github/administering-a-repository/about-protected-branches.md
index a6f876c4124a..d67809249aec 100644
--- a/content/github/administering-a-repository/about-protected-branches.md
+++ b/content/github/administering-a-repository/about-protected-branches.md
@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.pull_requests.about-protected-branches %} You can choose to enforce restrictions on how a pull request is merged into your repository.
diff --git a/content/github/administering-a-repository/about-releases.md b/content/github/administering-a-repository/about-releases.md
index ef5a803f11a4..96354c437af3 100644
--- a/content/github/administering-a-repository/about-releases.md
+++ b/content/github/administering-a-repository/about-releases.md
@@ -10,6 +10,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### About releases
@@ -20,16 +21,16 @@ Releases are deployable software iterations you can package and make available f
Releases are based on [Git tags](https://git-scm.com/book/en/Git-Basics-Tagging), which mark a specific point in your repository's history. A tag date may be different than a release date since they can be created at different times. For more information about viewing your existing tags, see "[Viewing your repository's releases and tags](/github/administering-a-repository/viewing-your-repositorys-releases-and-tags)."
-You can receive notifications when new releases are published in a repository without receiving notifications about other updates to the repository. For more information, see {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}"[Viewing your subscriptions](/github/managing-subscriptions-and-notifications-on-github/viewing-your-subscriptions){% else %}"[Watching and unwatching releases for a repository](/github/receiving-notifications-about-activity-on-github/watching-and-unwatching-releases-for-a-repository){% endif %}."
+You can receive notifications when new releases are published in a repository without receiving notifications about other updates to the repository. For more information, see {% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.20" %}"[Viewing your subscriptions](/github/managing-subscriptions-and-notifications-on-github/viewing-your-subscriptions){% else %}"[Watching and unwatching releases for a repository](/github/receiving-notifications-about-activity-on-github/watching-and-unwatching-releases-for-a-repository){% endif %}."
Anyone with read access to a repository can view and compare releases, but only people with write permissions to a repository can manage releases. For more information, see "[Managing releases in a repository](/github/administering-a-repository/managing-releases-in-a-repository)."
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}
People with admin permissions to a repository can choose whether {% data variables.large_files.product_name_long %} ({% data variables.large_files.product_name_short %}) objects are included in the ZIP files and tarballs that {% data variables.product.product_name %} creates for each release. For more information, see "[Managing {% data variables.large_files.product_name_short %} objects in archives of your repository](/github/administering-a-repository/managing-git-lfs-objects-in-archives-of-your-repository)."
{% endif %}
{% if currentVersion == "free-pro-team@latest" %}
-If a release fixes a security vulnerability, you should publish a security advisory in your repository. {% data variables.product.prodname_dotcom %} reviews each published security advisory and may use it to send {% data variables.product.prodname_dependabot_short %} alerts to affected repositories. For more information, see "[About GitHub Security Advisories](/github/managing-security-vulnerabilities/about-github-security-advisories)."
+If a release fixes a security vulnerability, you should publish a security advisory in your repository. {% data variables.product.prodname_dotcom %} reviews each published security advisory and may use it to send {% data variables.product.prodname_dependabot_alerts %} to affected repositories. For more information, see "[About GitHub Security Advisories](/github/managing-security-vulnerabilities/about-github-security-advisories)."
You can view the **Dependents** tab of the dependency graph to see which repositories and packages depend on code in your repository, and may therefore be affected by a new release. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)."
{% endif %}
diff --git a/content/github/administering-a-repository/about-required-commit-signing.md b/content/github/administering-a-repository/about-required-commit-signing.md
index f3572384411d..4b6825567245 100644
--- a/content/github/administering-a-repository/about-required-commit-signing.md
+++ b/content/github/administering-a-repository/about-required-commit-signing.md
@@ -7,11 +7,12 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
If you've enforced branch protections in your repository, you can set up required commit signing. For more information, see "[Configuring protected branches](/articles/configuring-protected-branches/)."
-When you enable required commit signing on a branch, contibutors {% if currentVersion == "free-pro-team@latest" %}and bots{% endif %} can only push commits that have been signed and verified to the branch. For more information, see "[About commit signature verification](/articles/about-commit-signature-verification)."
+When you enable required commit signing on a branch, contributors {% if currentVersion == "free-pro-team@latest" %}and bots{% endif %} can only push commits that have been signed and verified to the branch. For more information, see "[About commit signature verification](/articles/about-commit-signature-verification)."
You can always push local commits to the branch if the commits are signed and verified. {% if currentVersion == "free-pro-team@latest" %}You can also merge signed and verified commits into the branch using a pull request on {% data variables.product.product_name %}. However, you cannot squash and merge a pull request into the branch on {% data variables.product.product_name %} unless you are the author of the pull request.{% else %} However, you cannot merge pull requests into the branch on {% data variables.product.product_name %}.{% endif %} You can {% if currentVersion == "free-pro-team@latest" %}squash and {% endif %}merge pull requests locally. For more information, see "[Checking out pull requests locally](/github/collaborating-with-issues-and-pull-requests/checking-out-pull-requests-locally)."{% if currentVersion == "free-pro-team@latest" %} For more information about merge methods, see "[About merge methods on {% data variables.product.prodname_dotcom %}](/github/administering-a-repository/about-merge-methods-on-github)."{% endif %}
diff --git a/content/github/administering-a-repository/about-required-reviews-for-pull-requests.md b/content/github/administering-a-repository/about-required-reviews-for-pull-requests.md
index fa6f323ce865..512a9ed8a663 100644
--- a/content/github/administering-a-repository/about-required-reviews-for-pull-requests.md
+++ b/content/github/administering-a-repository/about-required-reviews-for-pull-requests.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
If you've enforced branch protections in your repository, you can set up required reviews. For more information about enforcing branch protections, see "[Configuring protected branches](/articles/configuring-protected-branches/)." For more information about setting up required reviews, see "[Enabling required reviews for pull requests](/articles/enabling-required-reviews-for-pull-requests)."
diff --git a/content/github/administering-a-repository/about-required-status-checks.md b/content/github/administering-a-repository/about-required-status-checks.md
index 7d2b61d93266..0781a22e606d 100644
--- a/content/github/administering-a-repository/about-required-status-checks.md
+++ b/content/github/administering-a-repository/about-required-status-checks.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### About required status checks
@@ -59,7 +60,7 @@ remote: error: Required status check "ci-build" is failing
{% endnote %}
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
Sometimes, the results of the status checks for the test merge commit and head commit will conflict. If the test merge commit has a status, it must pass. Otherwise, the status of the head commit must pass before you can merge the branch. For more information about test merge commits, see "[Pull Requests](/v3/pulls/#response-1)."
diff --git a/content/github/administering-a-repository/about-securing-your-repository.md b/content/github/administering-a-repository/about-securing-your-repository.md
index dcce1ad09ebe..9965531c8eee 100644
--- a/content/github/administering-a-repository/about-securing-your-repository.md
+++ b/content/github/administering-a-repository/about-securing-your-repository.md
@@ -21,10 +21,14 @@ The first step to securing a repository is to set up who can see and modify your
Privately discuss and fix security vulnerabilities in your repository's code. You can then publish a security advisory to alert your community to the vulnerability and encourage them to upgrade. For more information, see "[About {% data variables.product.prodname_security_advisories %}](/github/managing-security-vulnerabilities/about-github-security-advisories)."
-- **{% data variables.product.prodname_dependabot_short %} alerts**
+- **{% data variables.product.prodname_dependabot_alerts %} and security updates**
- View alerts about dependencies that are known to contain security vulnerabilities, and choose whether to have pull requests generated automatically to update these dependencies. For more information, see "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)"
- and "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-github-dependabot-security-updates)."
+ View alerts about dependencies that are known to contain security vulnerabilities, and choose whether to have pull requests generated automatically to update these dependencies. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)"
+ and "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)."
+
+- **{% data variables.product.prodname_dependabot %} version updates**
+
+ Use {% data variables.product.prodname_dependabot %} to automatically raise pull requests to keep your dependencies up-to-date. This helps reduce your exposure to older versions of dependencies. Using newer versions makes it easier to apply patches if security vulnerabilities are discovered, and also makes it easier for {% data variables.product.prodname_dependabot_security_updates %} to successfully raise pull requests to upgrade vulnerable dependencies. For more information, see "[About {% data variables.product.prodname_dependabot_version_updates %}](/github/administering-a-repository/about-dependabot-version-updates)."
- **{% data variables.product.prodname_code_scanning_capc %} alerts**
@@ -40,6 +44,6 @@ The first step to securing a repository is to set up who can see and modify your
* Ecosystems and packages that your repository depends on
* Repositories and packages that depend on your repository
-You must enable the dependency graph before {% data variables.product.prodname_dotcom %} can generate {% data variables.product.prodname_dependabot_short %} alerts for dependencies with security vulnerabilities.
+You must enable the dependency graph before {% data variables.product.prodname_dotcom %} can generate {% data variables.product.prodname_dependabot_alerts %} for dependencies with security vulnerabilities.
You can find the dependency graph on the **Insights** tab for your repository. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)."
diff --git a/content/github/administering-a-repository/automation-for-release-forms-with-query-parameters.md b/content/github/administering-a-repository/automation-for-release-forms-with-query-parameters.md
index 9be76a8de042..a24e1145b917 100644
--- a/content/github/administering-a-repository/automation-for-release-forms-with-query-parameters.md
+++ b/content/github/administering-a-repository/automation-for-release-forms-with-query-parameters.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Query parameters are optional parts of a URL you can customize to share a specific web page view, such as search filter results, an issue template, or the release form page on {% data variables.product.prodname_dotcom %}. To create your own query parameters, you must match the key and value pair.
diff --git a/content/github/administering-a-repository/changing-the-default-branch.md b/content/github/administering-a-repository/changing-the-default-branch.md
index 7e1a1c11352c..f9f3660e8441 100644
--- a/content/github/administering-a-repository/changing-the-default-branch.md
+++ b/content/github/administering-a-repository/changing-the-default-branch.md
@@ -5,6 +5,7 @@ permissions: People with admin permissions to a repository can change the defaul
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
redirect_from:
- /github/administering-a-repository/setting-the-default-branch
- /articles/setting-the-default-branch
@@ -14,13 +15,15 @@ redirect_from:
You can choose the default branch for a repository. The default branch is the base branch for pull requests and code commits. For more information about the default branch, see "[About branches](/github/collaborating-with-issues-and-pull-requests/about-branches#about-the-default-branch)."
+{% if currentVersion != "github-ae@latest" %}
{% note %}
**Note**: If you use the Git-Subversion bridge, changing the default branch will affect your `trunk` branch contents and the `HEAD` you see when you list references for the remote repository. For more information, see "[Support for Subversion clients](/github/importing-your-projects-to-github/support-for-subversion-clients)" and [git-ls-remote](https://git-scm.com/docs/git-ls-remote.html) in the Git documentation.
{% endnote %}
+{% endif %}
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}
{% data reusables.branches.set-default-branch %}
@@ -32,7 +35,7 @@ To change the default branch, your repository must have more than one branch. Fo
### Changing the default branch
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-settings %}
diff --git a/content/github/administering-a-repository/classifying-your-repository-with-topics.md b/content/github/administering-a-repository/classifying-your-repository-with-topics.md
index 1adf59df661f..3558507856a0 100644
--- a/content/github/administering-a-repository/classifying-your-repository-with-topics.md
+++ b/content/github/administering-a-repository/classifying-your-repository-with-topics.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### About topics
@@ -27,7 +28,7 @@ You can search for repositories that are associated with a particular topic. For
### Adding topics to your repository
-{% data reusables.repositories.navigate-to-repo %}{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
+{% data reusables.repositories.navigate-to-repo %}{% if currentVersion ver_lt "enterprise-server@2.22" %}
2. Under your repository description, click **Add topics**.
3. Type the topic you want to add to your repository, then type a space.
diff --git a/content/github/administering-a-repository/comparing-releases.md b/content/github/administering-a-repository/comparing-releases.md
index f4b3f65f5ed5..7e57598c486d 100644
--- a/content/github/administering-a-repository/comparing-releases.md
+++ b/content/github/administering-a-repository/comparing-releases.md
@@ -5,6 +5,7 @@ permissions: People with read access to a repository can view and compare releas
versions:
free-pro-team: '*'
enterprise-server: '>=2.21'
+ github-ae: '*'
---
{% data reusables.repositories.navigate-to-repo %}
diff --git a/content/github/administering-a-repository/configuration-options-for-dependency-updates.md b/content/github/administering-a-repository/configuration-options-for-dependency-updates.md
index f7601804ccda..ef1a16e28832 100644
--- a/content/github/administering-a-repository/configuration-options-for-dependency-updates.md
+++ b/content/github/administering-a-repository/configuration-options-for-dependency-updates.md
@@ -12,7 +12,7 @@ versions:
The {% data variables.product.prodname_dependabot %} configuration file, *dependabot.yml*, uses YAML syntax. If you're new to YAML and want to learn more, see "[Learn YAML in five minutes](https://www.codeproject.com/Articles/1214409/Learn-YAML-in-five-minutes)."
-You must store this file in the `.github` directory of your repository. When you add or update the *dependabot.yml* file, this triggers an immediate check for version updates. Any options that also affect security updates are used the next time a security alert triggers a pull request with for security update. For more information, see "[Enabling and disabling version updates](/github/administering-a-repository/enabling-and-disabling-version-updates)" and "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-github-dependabot-security-updates)."
+You must store this file in the `.github` directory of your repository. When you add or update the *dependabot.yml* file, this triggers an immediate check for version updates. Any options that also affect security updates are used the next time a security alert triggers a pull request for a security update. For more information, see "[Enabling and disabling version updates](/github/administering-a-repository/enabling-and-disabling-version-updates)" and "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-dependabot-security-updates)."
### Configuration options for *dependabot.yml*
@@ -56,13 +56,13 @@ In addition, the [`open-pull-requests-limit`](#open-pull-requests-limit) option
Security updates are raised for vulnerable package manifests only on the default branch. When configuration options are set for the same branch (true unless you use `target-branch`), and specify a `package-ecosystem` and `directory` for the vulnerable manifest, then pull requests for security updates use relevant options.
-In general, security updates use any configuration options that affect pull requests, for example, adding metadata or changing their behavior. For more information about security updates, see "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-github-dependabot-security-updates)."
+In general, security updates use any configuration options that affect pull requests, for example, adding metadata or changing their behavior. For more information about security updates, see "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-dependabot-security-updates)."
{% endnote %}
### `package-ecosystem`
-**Required** You add one `package-ecosystem` element for each package manager that you want {% data variables.product.prodname_dependabot_short %} to monitor for new versions. The repository must also contain a dependency manifest or lock file for each of these package managers. If you want to enable vendoring for a package manager that supports it, the vendored dependencies must be located in the required directory. For more information, see [`vendor`](#vendor) below.
+**Required** You add one `package-ecosystem` element for each package manager that you want {% data variables.product.prodname_dependabot %} to monitor for new versions. The repository must also contain a dependency manifest or lock file for each of these package managers. If you want to enable vendoring for a package manager that supports it, the vendored dependencies must be located in the required directory. For more information, see [`vendor`](#vendor) below.
{% data reusables.dependabot.supported-package-managers %}
@@ -308,7 +308,7 @@ updates:
{% note %}
-**Note**: {% data variables.product.prodname_dependabot_version_updates %} can't run version updates for any dependencies in manifests containing private git dependencies or private git registries, even if you add the private dependencies to the `ignore` option of your configuration file. For more information, see "[About {% data variables.product.prodname_dependabot_version_updates %}](/github/administering-a-repository/about-github-dependabot#supported-repositories-and-ecosystems)."
+**Note**: {% data variables.product.prodname_dependabot_version_updates %} can't run version updates for any dependencies in manifests containing private git dependencies or private git registries, even if you add the private dependencies to the `ignore` option of your configuration file. For more information, see "[About {% data variables.product.prodname_dependabot_version_updates %}](/github/administering-a-repository/about-dependabot#supported-repositories-and-ecosystems)."
{% endnote %}
@@ -544,13 +544,7 @@ updates:
### `vendor`
-Use the `vendor` option to tell {% data variables.product.prodname_dependabot_short %} to vendor dependencies when updating them.
-
-{% note %}
-
-Currently, {% data variables.product.prodname_dependabot_short %} only supports vendoring dependencies for Bundler.
-
-{% endnote %}
+Use the `vendor` option to tell {% data variables.product.prodname_dependabot %} to vendor dependencies when updating them.
```yaml
# Configure version updates for both dependencies defined in manifests and vendored dependencies
@@ -565,7 +559,13 @@ updates:
interval: "weekly"
```
-{% data variables.product.prodname_dependabot_short %} only updates the vendored dependencies located in specific directories in a repository. For Bundler, the dependencies must be in the _vendor/cache_ directory. Other file paths are not supported. For more information, see the [`bundle cache` documentation](https://bundler.io/man/bundle-cache.1.html).
+{% data variables.product.prodname_dependabot %} only updates the vendored dependencies located in specific directories in a repository.
+
+| Package manager | Required file path for vendored dependencies | More information |
+ |------------------|-------------------------------|--------|
+ | `bundler` | The dependencies must be in the _vendor/cache_ directory.Other file paths are not supported. | [`bundle cache` documentation](https://bundler.io/man/bundle-cache.1.html) |
+ | `gomod` | No path requirement (dependencies are usually located in the _vendor_ directory) | [`go mod vendor` documentation](https://golang.org/ref/mod#go-mod-vendor) |
+
### `versioning-strategy`
diff --git a/content/github/administering-a-repository/configuring-autolinks-to-reference-external-resources.md b/content/github/administering-a-repository/configuring-autolinks-to-reference-external-resources.md
index 67f2446f02df..dafdd7d9e58c 100644
--- a/content/github/administering-a-repository/configuring-autolinks-to-reference-external-resources.md
+++ b/content/github/administering-a-repository/configuring-autolinks-to-reference-external-resources.md
@@ -7,9 +7,10 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
-Anyone with admin permissions to a repository can configure autolink references to link issues, pull requests,{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} commit messages, and release descriptions{% else %} and commit messages{% endif %} to external third-party services.
+Anyone with admin permissions to a repository can configure autolink references to link issues, pull requests,{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.21" %} commit messages, and release descriptions{% else %} and commit messages{% endif %} to external third-party services.
If you use Zendesk to track user-reported tickets, for example, you can reference a ticket number in the pull request you open to fix the issue.
diff --git a/content/github/administering-a-repository/configuring-commit-rebasing-for-pull-requests.md b/content/github/administering-a-repository/configuring-commit-rebasing-for-pull-requests.md
index c75c9aa0a96f..eb2944629f7c 100644
--- a/content/github/administering-a-repository/configuring-commit-rebasing-for-pull-requests.md
+++ b/content/github/administering-a-repository/configuring-commit-rebasing-for-pull-requests.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.pull_requests.configure_pull_request_merges_intro %}
diff --git a/content/github/administering-a-repository/configuring-commit-squashing-for-pull-requests.md b/content/github/administering-a-repository/configuring-commit-squashing-for-pull-requests.md
index 4712cab45a48..8a3a1cde8cd8 100644
--- a/content/github/administering-a-repository/configuring-commit-squashing-for-pull-requests.md
+++ b/content/github/administering-a-repository/configuring-commit-squashing-for-pull-requests.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.pull_requests.configure_pull_request_merges_intro %}
diff --git a/content/github/administering-a-repository/configuring-protected-branches.md b/content/github/administering-a-repository/configuring-protected-branches.md
index 680230c3a57a..6672a47dfe34 100644
--- a/content/github/administering-a-repository/configuring-protected-branches.md
+++ b/content/github/administering-a-repository/configuring-protected-branches.md
@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/administering-a-repository/configuring-pull-request-merges.md b/content/github/administering-a-repository/configuring-pull-request-merges.md
index 575be048b725..6a34fe2d0d6a 100644
--- a/content/github/administering-a-repository/configuring-pull-request-merges.md
+++ b/content/github/administering-a-repository/configuring-pull-request-merges.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/administering-a-repository/customizing-dependency-updates.md b/content/github/administering-a-repository/customizing-dependency-updates.md
index 26f64bba2178..95340f31d2d8 100644
--- a/content/github/administering-a-repository/customizing-dependency-updates.md
+++ b/content/github/administering-a-repository/customizing-dependency-updates.md
@@ -20,7 +20,7 @@ After you've enabled version updates, you can customize how {% data variables.pr
For more information about the configuration options, see "[Configuration options for dependency updates](/github/administering-a-repository/configuration-options-for-dependency-updates)."
-When you update the *dependabot.yml* file in your repository, {% data variables.product.prodname_dependabot %} runs an immediate check with the new configuration. Within minutes you will see an updated list of dependencies on the **{% data variables.product.prodname_dependabot_short %}** tab, this may take longer if the repository has many dependencies. You may also see new pull requests for version updates. For more information, see "[Listing dependencies configured for version updates](/github/administering-a-repository/listing-dependencies-configured-for-version-updates)."
+When you update the *dependabot.yml* file in your repository, {% data variables.product.prodname_dependabot %} runs an immediate check with the new configuration. Within minutes you will see an updated list of dependencies on the **{% data variables.product.prodname_dependabot %}** tab, this may take longer if the repository has many dependencies. You may also see new pull requests for version updates. For more information, see "[Listing dependencies configured for version updates](/github/administering-a-repository/listing-dependencies-configured-for-version-updates)."
### Impact of configuration changes on security updates
diff --git a/content/github/administering-a-repository/customizing-how-changed-files-appear-on-github.md b/content/github/administering-a-repository/customizing-how-changed-files-appear-on-github.md
index 8d24cc87936a..77d1e3d332f3 100644
--- a/content/github/administering-a-repository/customizing-how-changed-files-appear-on-github.md
+++ b/content/github/administering-a-repository/customizing-how-changed-files-appear-on-github.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Use a *.gitattributes* file to mark files that match a given "pattern" with the specified attributes. A *.gitattributes* file uses the same rules for matching as _.gitignore_ files. For more information, see [PATTERN FORMAT](https://www.git-scm.com/docs/gitignore#_pattern_format) in the Git documentation.
diff --git a/content/github/administering-a-repository/customizing-your-repositorys-social-media-preview.md b/content/github/administering-a-repository/customizing-your-repositorys-social-media-preview.md
index a804bc15c0d5..3c61f2eb0ed4 100644
--- a/content/github/administering-a-repository/customizing-your-repositorys-social-media-preview.md
+++ b/content/github/administering-a-repository/customizing-your-repositorys-social-media-preview.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Until you add an image, repository links expand to show basic information about the repository and the owner's avatar. Adding an image to your repository can help identify your project across various social platforms.
diff --git a/content/github/administering-a-repository/defining-the-mergeability-of-pull-requests.md b/content/github/administering-a-repository/defining-the-mergeability-of-pull-requests.md
index 6e38b75407be..ddf52fc18cef 100644
--- a/content/github/administering-a-repository/defining-the-mergeability-of-pull-requests.md
+++ b/content/github/administering-a-repository/defining-the-mergeability-of-pull-requests.md
@@ -10,5 +10,6 @@ mapTopic: true
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/administering-a-repository/deleting-a-repository.md b/content/github/administering-a-repository/deleting-a-repository.md
index 510325ccbe49..635138d60634 100644
--- a/content/github/administering-a-repository/deleting-a-repository.md
+++ b/content/github/administering-a-repository/deleting-a-repository.md
@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.organizations.owners-and-admins-can %} delete an organization repository. If **Allow members to delete or transfer repositories for this organization** has been disabled, only organization owners can delete organization repositories. {% data reusables.organizations.new-repo-permissions-more-info %}
diff --git a/content/github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request.md b/content/github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request.md
index b8251368ce85..69b1689383e3 100644
--- a/content/github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request.md
+++ b/content/github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request.md
@@ -9,6 +9,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Deleting a branch used for a pull request
diff --git a/content/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository.md b/content/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository.md
index 928f96e2619e..3ae328181f75 100644
--- a/content/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository.md
+++ b/content/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository.md
@@ -17,13 +17,13 @@ You can enable {% data variables.product.prodname_actions %} for your repository
Alternatively, you can enable {% data variables.product.prodname_actions %} in your repository but limit the actions a workflow can run. {% data reusables.github-actions.enabled-local-github-actions %}
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.23" %}
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.23" %}
### Managing {% data variables.product.prodname_actions %} permissions for your repository
{% note %}
-**Note:** You might not be able to manage these settings if your organization has an overriding policy or is managed by an enterprise that has overriding policy. For more information, see "[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/github/setting-up-and-managing-organizations-and-teams/disabling-or-limiting-github-actions-for-your-organization)" or {% if currentVersion == "free-pro-team@latest" %}"[Enforcing {% data variables.product.prodname_actions %} policies in your enterprise account](/github/setting-up-and-managing-your-enterprise-account/enforcing-github-actions-policies-in-your-enterprise-account)."{% else if currentVersion ver_gt "enterprise-server@2.21"%}"[Enforcing {% data variables.product.prodname_actions %} policies for your enterprise](/enterprise/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise)."{% endif %}
+**Note:** You might not be able to manage these settings if your organization has an overriding policy or is managed by an enterprise that has overriding policy. For more information, see "[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/github/setting-up-and-managing-organizations-and-teams/disabling-or-limiting-github-actions-for-your-organization)" or {% if currentVersion == "free-pro-team@latest" %}"[Enforcing {% data variables.product.prodname_actions %} policies in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-github-actions-policies-in-your-enterprise-account)."{% elsif currentVersion ver_gt "enterprise-server@2.21"%}"[Enforcing {% data variables.product.prodname_actions %} policies for your enterprise](/enterprise/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise)."{% endif %}
{% endnote %}
@@ -39,15 +39,15 @@ Alternatively, you can enable {% data variables.product.prodname_actions %} in y
### Managing {% data variables.product.prodname_actions %} permissions for your repository
-You can disable all workflows for a repository or set a policy that configures which actions can be used in a repository.
+You can disable all workflows for a repository or set a policy that configures which actions can be used in a repository.
{% data reusables.actions.actions-use-policy-settings %}
{% note %}
-**Note:** You might not be able to manage these settings if your organization has an overriding policy or is managed by an enterprise that has overriding policy. For more information, see "[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/github/setting-up-and-managing-organizations-and-teams/disabling-or-limiting-github-actions-for-your-organization)" or {% if currentVersion == "free-pro-team@latest" %}"[Enforcing {% data variables.product.prodname_actions %} policies in your enterprise account](/github/setting-up-and-managing-your-enterprise-account/enforcing-github-actions-policies-in-your-enterprise-account)."{% else if currentVersion ver_gt "enterprise-server@2.21" %}"[Enforcing {% data variables.product.prodname_actions %} policies for your enterprise](/enterprise/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise)."
+**Note:** You might not be able to manage these settings if your organization has an overriding policy or is managed by an enterprise that has overriding policy. For more information, see "[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/github/setting-up-and-managing-organizations-and-teams/disabling-or-limiting-github-actions-for-your-organization)" or {% if currentVersion == "free-pro-team@latest" %}"[Enforcing {% data variables.product.prodname_actions %} policies in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-github-actions-policies-in-your-enterprise-account)."{% elsif currentVersion ver_gt "enterprise-server@2.21" %}"[Enforcing {% data variables.product.prodname_actions %} policies for your enterprise](/enterprise/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise)."
-{% endif %}
+{% endif %}
{% endnote %}
@@ -65,7 +65,7 @@ You can disable all workflows for a repository or set a policy that configures w
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-settings %}
{% data reusables.repositories.settings-sidebar-actions %}
-1. Under **Actions permissions**, select **Allow specific actions** and add your required actions to the list.
+1. Under **Actions permissions**, select **Allow select actions** and add your required actions to the list.
2. Click **Save**.
{% endif %}
diff --git a/content/github/administering-a-repository/enabling-and-disabling-version-updates.md b/content/github/administering-a-repository/enabling-and-disabling-version-updates.md
index c3e997f0dc74..51734816e398 100644
--- a/content/github/administering-a-repository/enabling-and-disabling-version-updates.md
+++ b/content/github/administering-a-repository/enabling-and-disabling-version-updates.md
@@ -10,7 +10,7 @@ versions:
### About version updates for dependencies
-You enable {% data variables.product.prodname_dependabot_version_updates %} by checking a *dependabot.yml* configuration file in to your repository's `.github` directory. {% data variables.product.prodname_dependabot_short %} then raises pull requests to keep the dependencies you configure up-to-date. For each package manager's dependencies that you want to update, you must specify the location of the package manifest files and how often to check for updates to the dependencies listed in those files. For information about enabling security updates, see "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-github-dependabot-security-updates)."
+You enable {% data variables.product.prodname_dependabot_version_updates %} by checking a *dependabot.yml* configuration file in to your repository's `.github` directory. {% data variables.product.prodname_dependabot %} then raises pull requests to keep the dependencies you configure up-to-date. For each package manager's dependencies that you want to update, you must specify the location of the package manifest files and how often to check for updates to the dependencies listed in those files. For information about enabling security updates, see "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-dependabot-security-updates)."
{% data reusables.dependabot.initial-updates %} For more information, see "[Customizing dependency updates](/github/administering-a-repository/customizing-dependency-updates)."
@@ -72,7 +72,7 @@ On a fork, you also need to explicitly enable {% data variables.product.prodname
### Checking the status of version updates
-After you enable version updates, you'll see a new **Dependabot** tab in the dependency graph for the repository. This tab shows which package managers {% data variables.product.prodname_dependabot %} is configured to monitor and when {% data variables.product.prodname_dependabot_short %} last checked for new versions.
+After you enable version updates, you'll see a new **Dependabot** tab in the dependency graph for the repository. This tab shows which package managers {% data variables.product.prodname_dependabot %} is configured to monitor and when {% data variables.product.prodname_dependabot %} last checked for new versions.
diff --git a/content/github/administering-a-repository/enabling-anonymous-git-read-access-for-a-repository.md b/content/github/administering-a-repository/enabling-anonymous-git-read-access-for-a-repository.md
index cd39c77f53c0..b545853af46e 100644
--- a/content/github/administering-a-repository/enabling-anonymous-git-read-access-for-a-repository.md
+++ b/content/github/administering-a-repository/enabling-anonymous-git-read-access-for-a-repository.md
@@ -5,11 +5,12 @@ redirect_from:
- /articles/enabling-anonymous-git-read-access-for-a-repository
versions:
enterprise-server: '*'
+ github-ae: '*'
---
Repository administrators can change the anonymous Git read access setting for a specific repository if:
- A site administrator has enabled private mode and anonymous Git read access.
-- The repository is public on the instance and is not a fork.
+- The repository is public on the enterprise and is not a fork.
- A site administrator has not disabled anonymous Git read access for the repository.
{% data reusables.enterprise_user_management.exceptions-for-enabling-anonymous-git-read-access %}
diff --git a/content/github/administering-a-repository/enabling-branch-restrictions.md b/content/github/administering-a-repository/enabling-branch-restrictions.md
index 6357b53cd78f..f00d5de0a505 100644
--- a/content/github/administering-a-repository/enabling-branch-restrictions.md
+++ b/content/github/administering-a-repository/enabling-branch-restrictions.md
@@ -1,12 +1,13 @@
---
title: Enabling branch restrictions
-intro: 'You can enforce branch restrictions so that only certain users{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.18" %},{% else %} or{% endif %} teams{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.18" %}, or apps{% endif %} can push to a protected branch in repositories owned by your organization.'
+intro: 'You can enforce branch restrictions so that only certain users, teams, or apps can push to a protected branch in repositories owned by your organization.'
product: '{% data reusables.gated-features.branch-restrictions %}'
redirect_from:
- /articles/enabling-branch-restrictions
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Anyone with admin permissions to an organization-owned repository can enable branch restrictions.
diff --git a/content/github/administering-a-repository/enabling-deletion-of-a-protected-branch.md b/content/github/administering-a-repository/enabling-deletion-of-a-protected-branch.md
index eb08be107dcb..baf6b1021173 100644
--- a/content/github/administering-a-repository/enabling-deletion-of-a-protected-branch.md
+++ b/content/github/administering-a-repository/enabling-deletion-of-a-protected-branch.md
@@ -5,6 +5,7 @@ product: '{% data reusables.gated-features.protected-branches %}'
versions:
free-pro-team: '*'
enterprise-server: '>=2.20'
+ github-ae: '*'
---
Anyone with admin permissions to a repository can enable branch deletions.
diff --git a/content/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch.md b/content/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch.md
index 3cb9b4f7ebf3..efb82441a0dc 100644
--- a/content/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch.md
+++ b/content/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch.md
@@ -5,6 +5,7 @@ product: '{% data reusables.gated-features.protected-branches %}'
versions:
free-pro-team: '*'
enterprise-server: '>=2.20'
+ github-ae: '*'
---
Anyone with admin permissions to a repository can enable force pushes.
@@ -15,7 +16,7 @@ By default, force pushes are blocked on all protected branches. When you enable
Enabling force pushes will not override any other branch protection rules. For example, if a branch requires a linear commit history, you cannot force push merge commits to that branch.
-{% if currentVersion != "free-pro-team@latest" %}You cannot enable force pushes for a protected branch if a site administrator has blocked force pushes to all branches in your repository. For more information, see "[Blocking force pushes to repositories owned by a user account or organization](/enterprise/{{ currentVersion }}/admin/developer-workflow/blocking-force-pushes-to-repositories-owned-by-a-user-account-or-organization)."
+{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}You cannot enable force pushes for a protected branch if a site administrator has blocked force pushes to all branches in your repository. For more information, see "[Blocking force pushes to repositories owned by a user account or organization](/enterprise/{{ currentVersion }}/admin/developer-workflow/blocking-force-pushes-to-repositories-owned-by-a-user-account-or-organization)."
If a site administrator has blocked force pushes to the default branch only, you can still enable force pushes for any other protected branch.{% endif %}
diff --git a/content/github/administering-a-repository/enabling-required-commit-signing.md b/content/github/administering-a-repository/enabling-required-commit-signing.md
index 8aa09e9816e8..44f1fca1ef8c 100644
--- a/content/github/administering-a-repository/enabling-required-commit-signing.md
+++ b/content/github/administering-a-repository/enabling-required-commit-signing.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Before enabling required commit signing on a branch, you must first set the branch up as a protected branch. For more information, see "[Configuring protected branches](/github/administering-a-repository/configuring-protected-branches)."
diff --git a/content/github/administering-a-repository/enabling-required-reviews-for-pull-requests.md b/content/github/administering-a-repository/enabling-required-reviews-for-pull-requests.md
index cec2af37d2eb..0f693b524f77 100644
--- a/content/github/administering-a-repository/enabling-required-reviews-for-pull-requests.md
+++ b/content/github/administering-a-repository/enabling-required-reviews-for-pull-requests.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Before enabling required reviews on a branch, you must first set the branch up as a protected branch. For more information, see "[Configuring protected branches](/github/administering-a-repository/configuring-protected-branches)."
diff --git a/content/github/administering-a-repository/enabling-required-status-checks.md b/content/github/administering-a-repository/enabling-required-status-checks.md
index 3a2fb10f28f7..4d99fc163fa0 100644
--- a/content/github/administering-a-repository/enabling-required-status-checks.md
+++ b/content/github/administering-a-repository/enabling-required-status-checks.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.repositories.protected-branches-options %}
diff --git a/content/github/administering-a-repository/index.md b/content/github/administering-a-repository/index.md
index 74ba6512fb47..ecae8ec4f0f0 100644
--- a/content/github/administering-a-repository/index.md
+++ b/content/github/administering-a-repository/index.md
@@ -5,6 +5,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
@@ -26,7 +27,7 @@ versions:
{% link_in_list /viewing-deployment-activity-for-your-repository %}
{% link_in_list /managing-the-forking-policy-for-your-repository %}
-
+
{% link_in_list /configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository %}
{% link_in_list /disabling-or-limiting-github-actions-for-a-repository %}
{% link_in_list /managing-git-lfs-objects-in-archives-of-your-repository %}
@@ -90,11 +91,11 @@ versions:
{% topic_link_in_list /keeping-your-dependencies-updated-automatically %}
- {% link_in_list /about-github-dependabot-version-updates %}
+ {% link_in_list /about-dependabot-version-updates %}
{% link_in_list /enabling-and-disabling-version-updates %}
{% link_in_list /listing-dependencies-configured-for-version-updates %}
{% link_in_list /managing-pull-requests-for-dependency-updates %}
{% link_in_list /customizing-dependency-updates %}
{% link_in_list /configuration-options-for-dependency-updates %}
- {% link_in_list /keeping-your-actions-up-to-date-with-github-dependabot %}
+ {% link_in_list /keeping-your-actions-up-to-date-with-dependabot %}
diff --git a/content/github/administering-a-repository/keeping-your-actions-up-to-date-with-github-dependabot.md b/content/github/administering-a-repository/keeping-your-actions-up-to-date-with-dependabot.md
similarity index 70%
rename from content/github/administering-a-repository/keeping-your-actions-up-to-date-with-github-dependabot.md
rename to content/github/administering-a-repository/keeping-your-actions-up-to-date-with-dependabot.md
index 408911429a75..e489fec42f88 100644
--- a/content/github/administering-a-repository/keeping-your-actions-up-to-date-with-github-dependabot.md
+++ b/content/github/administering-a-repository/keeping-your-actions-up-to-date-with-dependabot.md
@@ -1,6 +1,8 @@
---
-title: Keeping your actions up to date with GitHub Dependabot
+title: Keeping your actions up to date with Dependabot
intro: 'You can use {% data variables.product.prodname_dependabot %} to keep the actions you use updated to the latest versions.'
+redirect_from:
+ - /github/administering-a-repository/keeping-your-actions-up-to-date-with-github-dependabot
versions:
free-pro-team: '*'
---
@@ -9,7 +11,7 @@ versions:
### About {% data variables.product.prodname_dependabot_version_updates %} for actions
-Actions are often updated with bug fixes and new features to make automated processes more reliable, faster, and safer. When you enable {% data variables.product.prodname_dependabot_version_updates %} for {% data variables.product.prodname_actions %}, {% data variables.product.prodname_dependabot %} will help ensure that references to actions in a repository's *workflow.yml* file are kept up to date. For each action in the file, {% data variables.product.prodname_dependabot_short %} checks the action's reference (typically a version number or commit identifier associated with the action) against the latest version. If a more recent version of the action is available, {% data variables.product.prodname_dependabot_short %} will send you a pull request that updates the reference in the workflow file to the latest version. For more information about {% data variables.product.prodname_dependabot_version_updates %}, see "[About {% data variables.product.prodname_dependabot_version_updates %}](/github/administering-a-repository/about-github-dependabot-version-updates)." For more information about configuring workflows for {% data variables.product.prodname_actions %}, see "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)."
+Actions are often updated with bug fixes and new features to make automated processes more reliable, faster, and safer. When you enable {% data variables.product.prodname_dependabot_version_updates %} for {% data variables.product.prodname_actions %}, {% data variables.product.prodname_dependabot %} will help ensure that references to actions in a repository's *workflow.yml* file are kept up to date. For each action in the file, {% data variables.product.prodname_dependabot %} checks the action's reference (typically a version number or commit identifier associated with the action) against the latest version. If a more recent version of the action is available, {% data variables.product.prodname_dependabot %} will send you a pull request that updates the reference in the workflow file to the latest version. For more information about {% data variables.product.prodname_dependabot_version_updates %}, see "[About {% data variables.product.prodname_dependabot_version_updates %}](/github/administering-a-repository/about-dependabot-version-updates)." For more information about configuring workflows for {% data variables.product.prodname_actions %}, see "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)."
### Enabling {% data variables.product.prodname_dependabot_version_updates %} for actions
@@ -23,7 +25,7 @@ You can also enable {% data variables.product.prodname_dependabot_version_update
#### Example *dependabot.yml* file for {% data variables.product.prodname_actions %}
-The example *dependabot.yml* file below configures version updates for {% data variables.product.prodname_actions %}. The `directory` must be set to `"/"` to check for workflow files in `.github/workflows`. The `schedule.interval` is set to `"daily"`. After this file has been checked in or updated, {% data variables.product.prodname_dependabot %} checks for new versions of your actions. {% data variables.product.prodname_dependabot_short %} will raise pull requests for version updates for any outdated actions that it finds. After the initial version updates, {% data variables.product.prodname_dependabot_short %} will continue to check for outdated versions of actions once a day.
+The example *dependabot.yml* file below configures version updates for {% data variables.product.prodname_actions %}. The `directory` must be set to `"/"` to check for workflow files in `.github/workflows`. The `schedule.interval` is set to `"daily"`. After this file has been checked in or updated, {% data variables.product.prodname_dependabot %} checks for new versions of your actions. {% data variables.product.prodname_dependabot %} will raise pull requests for version updates for any outdated actions that it finds. After the initial version updates, {% data variables.product.prodname_dependabot %} will continue to check for outdated versions of actions once a day.
```yaml
# Set update schedule for GitHub Actions
diff --git a/content/github/administering-a-repository/linking-to-releases.md b/content/github/administering-a-repository/linking-to-releases.md
index 56cf14ce69f6..8d87615b86cc 100644
--- a/content/github/administering-a-repository/linking-to-releases.md
+++ b/content/github/administering-a-repository/linking-to-releases.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.repositories.navigate-to-repo %}
diff --git a/content/github/administering-a-repository/listing-dependencies-configured-for-version-updates.md b/content/github/administering-a-repository/listing-dependencies-configured-for-version-updates.md
index 00fe9a059c1e..19a0c93aee15 100644
--- a/content/github/administering-a-repository/listing-dependencies-configured-for-version-updates.md
+++ b/content/github/administering-a-repository/listing-dependencies-configured-for-version-updates.md
@@ -9,7 +9,7 @@ versions:
### Viewing dependencies monitored by {% data variables.product.prodname_dependabot %}
-After you've enabled version updates, you can confirm that your configuration is correct using the **{% data variables.product.prodname_dependabot_short %}** tab in the dependency graph for the repository. For more information, see "[Enabling and disabling version updates](/github/administering-a-repository/enabling-and-disabling-version-updates)."
+After you've enabled version updates, you can confirm that your configuration is correct using the **{% data variables.product.prodname_dependabot %}** tab in the dependency graph for the repository. For more information, see "[Enabling and disabling version updates](/github/administering-a-repository/enabling-and-disabling-version-updates)."
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.accessing-repository-graphs %}
@@ -22,7 +22,7 @@ If any dependencies are missing, check the log files for errors. If any package
### Viewing {% data variables.product.prodname_dependabot %} log files
-1. On the **{% data variables.product.prodname_dependabot_short %}** tab, click **Last checked *TIME* ago** to see the log file that {% data variables.product.prodname_dependabot %} generated during the last check for version updates.
+1. On the **{% data variables.product.prodname_dependabot %}** tab, click **Last checked *TIME* ago** to see the log file that {% data variables.product.prodname_dependabot %} generated during the last check for version updates.
2. Optionally, to rerun the version check, click **Check for updates**.
diff --git a/content/github/administering-a-repository/managing-branches-in-your-repository.md b/content/github/administering-a-repository/managing-branches-in-your-repository.md
index 649ce43f079d..2688f35f9e52 100644
--- a/content/github/administering-a-repository/managing-branches-in-your-repository.md
+++ b/content/github/administering-a-repository/managing-branches-in-your-repository.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/administering-a-repository/managing-git-lfs-objects-in-archives-of-your-repository.md b/content/github/administering-a-repository/managing-git-lfs-objects-in-archives-of-your-repository.md
index f34f34e16480..b47a802e67b2 100644
--- a/content/github/administering-a-repository/managing-git-lfs-objects-in-archives-of-your-repository.md
+++ b/content/github/administering-a-repository/managing-git-lfs-objects-in-archives-of-your-repository.md
@@ -6,13 +6,16 @@ permissions: 'People with admin permissions for a repository can manage whether
versions:
free-pro-team: '*'
enterprise-server: '=>2.23'
+ github-ae: '*'
---
### About {% data variables.large_files.product_name_short %} objects in archives
{% data variables.product.product_name %} creates source code archives of your repository in the form of ZIP files and tarballs. People can download these archives on the main page of your repository or as release assets. By default, {% data variables.large_files.product_name_short %} objects are not included in these archives, only the pointer files to these objects. To improve the usability of archives for your repository, you can choose to include the {% data variables.large_files.product_name_short %} objects instead.
+{% if currentVersion != "github-ae@latest" %}
If you choose to include {% data variables.large_files.product_name_short %} objects in archives of your repository, every download of those archives will count towards bandwidth usage for your account. Each account receives {% data variables.large_files.initial_bandwidth_quota %} per month of bandwidth for free, and you can pay for additional usage. For more information, see "[About storage and bandwidth usage](/github/managing-large-files/about-storage-and-bandwidth-usage)" and "[Managing billing for {% data variables.large_files.product_name_long %}](/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-git-large-file-storage)."
+{% endif %}
### Managing {% data variables.large_files.product_name_short %} objects in archives
diff --git a/content/github/administering-a-repository/managing-pull-requests-for-dependency-updates.md b/content/github/administering-a-repository/managing-pull-requests-for-dependency-updates.md
index d59bf97cc322..ebe089535a7f 100644
--- a/content/github/administering-a-repository/managing-pull-requests-for-dependency-updates.md
+++ b/content/github/administering-a-repository/managing-pull-requests-for-dependency-updates.md
@@ -9,9 +9,9 @@ versions:
### About {% data variables.product.prodname_dependabot %} pull requests
-{% data variables.product.prodname_dependabot %} raises pull requests to update dependencies. Depending on how your repository is configured, {% data variables.product.prodname_dependabot_short %} may raise pull requests for version updates and/or for security updates. You manage these pull requests in the same way as any other pull request, but there are also some extra commands available. For information about enabling {% data variables.product.prodname_dependabot %} dependency updates, see "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-github-dependabot-security-updates)" and "[Enabling and disabling version updates](/github/administering-a-repository/enabling-and-disabling-version-updates)."
+{% data reusables.dependabot.pull-request-introduction %}
-When {% data variables.product.prodname_dependabot %} raises a pull request, you're notified by your chosen method for the repository. Each pull request contains detailed information about the proposed change, taken from the package management system. These pull requests follow the normal checks and tests defined in your repository. In addition, where enough information is available, you'll see a compatibility score. This may also help you decide whether or not to merge the change. For information about this score, see "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-github-dependabot-security-updates)."
+When {% data variables.product.prodname_dependabot %} raises a pull request, you're notified by your chosen method for the repository. Each pull request contains detailed information about the proposed change, taken from the package manager. These pull requests follow the normal checks and tests defined in your repository. In addition, where enough information is available, you'll see a compatibility score. This may also help you decide whether or not to merge the change. For information about this score, see "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)."
If you have many dependencies to manage, you may want to customize the configuration for each package manager so that pull requests have specific reviewers, assignees, and labels. For more information, see "[Customizing dependency updates](/github/administering-a-repository/customizing-dependency-updates)."
diff --git a/content/github/administering-a-repository/managing-releases-in-a-repository.md b/content/github/administering-a-repository/managing-releases-in-a-repository.md
index 18ba6a41cf8a..32977281b8fc 100644
--- a/content/github/administering-a-repository/managing-releases-in-a-repository.md
+++ b/content/github/administering-a-repository/managing-releases-in-a-repository.md
@@ -12,17 +12,18 @@ permissions: 'Repository collaborators and people with write access to a reposit
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### About release management
You can also publish an action from a specific release in {% data variables.product.prodname_marketplace %}. For more information, see "Publishing an action in the {% data variables.product.prodname_marketplace %}."
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}
You can choose whether {% data variables.large_files.product_name_long %} ({% data variables.large_files.product_name_short %}) objects are included in the ZIP files and tarballs that {% data variables.product.product_name %} creates for each release. For more information, see "[Managing {% data variables.large_files.product_name_short %} objects in archives of your repository](/github/administering-a-repository/managing-git-lfs-objects-in-archives-of-your-repository)."
{% endif %}
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
{% tip %}
**Tip**: You can also manage releases using the {% data variables.product.prodname_cli %}. For more information, see "[`gh release`](https://cli.github.com/manual/gh_release)" in the {% data variables.product.prodname_cli %} documentation.
diff --git a/content/github/administering-a-repository/managing-repository-settings.md b/content/github/administering-a-repository/managing-repository-settings.md
index 467c6b67b6d3..240e40b6ede2 100644
--- a/content/github/administering-a-repository/managing-repository-settings.md
+++ b/content/github/administering-a-repository/managing-repository-settings.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/administering-a-repository/managing-the-automatic-deletion-of-branches.md b/content/github/administering-a-repository/managing-the-automatic-deletion-of-branches.md
index 2a4b191a32bf..f165dc498635 100644
--- a/content/github/administering-a-repository/managing-the-automatic-deletion-of-branches.md
+++ b/content/github/administering-a-repository/managing-the-automatic-deletion-of-branches.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Anyone with admin permissions to a repository can enable or disable the automatic deletion of branches.
diff --git a/content/github/administering-a-repository/managing-the-forking-policy-for-your-repository.md b/content/github/administering-a-repository/managing-the-forking-policy-for-your-repository.md
index 637aa5546ba2..94e4afbdf937 100644
--- a/content/github/administering-a-repository/managing-the-forking-policy-for-your-repository.md
+++ b/content/github/administering-a-repository/managing-the-forking-policy-for-your-repository.md
@@ -1,6 +1,6 @@
---
title: Managing the forking policy for your repository
-intro: 'You can allow or prevent the forking of a specific private{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} or internal{% endif %} repository owned by an organization.'
+intro: 'You can allow or prevent the forking of a specific private{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %} or internal{% endif %} repository owned by an organization.'
redirect_from:
- /articles/allowing-people-to-fork-a-private-repository-owned-by-your-organization
- /github/administering-a-repository/allowing-people-to-fork-a-private-repository-owned-by-your-organization
@@ -8,9 +8,10 @@ permissions: People with admin permissions for a repository can manage the forki
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
-An organization owner must allow forks of private{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} and internal{% endif %} repositories on the organization level before you can allow or disallow forks for a specific repository. For more information, see "[Managing the forking policy for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-the-forking-policy-for-your-organization)."
+An organization owner must allow forks of private{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %} and internal{% endif %} repositories on the organization level before you can allow or disallow forks for a specific repository. For more information, see "[Managing the forking policy for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-the-forking-policy-for-your-organization)."
{% data reusables.organizations.internal-repos-enterprise %}
diff --git a/content/github/administering-a-repository/releasing-projects-on-github.md b/content/github/administering-a-repository/releasing-projects-on-github.md
index 0751f42269f0..372ed4cafcba 100644
--- a/content/github/administering-a-repository/releasing-projects-on-github.md
+++ b/content/github/administering-a-repository/releasing-projects-on-github.md
@@ -8,5 +8,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/administering-a-repository/renaming-a-repository.md b/content/github/administering-a-repository/renaming-a-repository.md
index 5393db41466f..49b2a1bb3015 100644
--- a/content/github/administering-a-repository/renaming-a-repository.md
+++ b/content/github/administering-a-repository/renaming-a-repository.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
When you rename a repository, all existing information, with the exception of project site URLs, is automatically redirected to the new name, including:
diff --git a/content/github/administering-a-repository/requiring-a-linear-commit-history.md b/content/github/administering-a-repository/requiring-a-linear-commit-history.md
index a2a5e5d3d097..8ed5e87cb88f 100644
--- a/content/github/administering-a-repository/requiring-a-linear-commit-history.md
+++ b/content/github/administering-a-repository/requiring-a-linear-commit-history.md
@@ -5,6 +5,7 @@ product: '{% data reusables.gated-features.protected-branches %}'
versions:
free-pro-team: '*'
enterprise-server: '>=2.20'
+ github-ae: '*'
---
Anyone with admin permissions to a repository can require a linear commit history.
diff --git a/content/github/administering-a-repository/setting-repository-visibility.md b/content/github/administering-a-repository/setting-repository-visibility.md
index b76e50413465..22824f780728 100644
--- a/content/github/administering-a-repository/setting-repository-visibility.md
+++ b/content/github/administering-a-repository/setting-repository-visibility.md
@@ -9,6 +9,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### About repository visibility changes
@@ -19,18 +20,18 @@ We recommend reviewing the following caveats before you change the visibility of
#### Making a repository private
- * {% data variables.product.prodname_dotcom %} will detach public forks of the public repository and put them into a new network. Public forks are not made private. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}If you change a repository's visibility from internal to private, {% data variables.product.prodname_dotcom %} will remove forks that belong to any user without access to the newly private repository.{% endif %} For more information, see "[What happens to forks when a repository is deleted or changes visibility?](/articles/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility#changing-a-public-repository-to-a-private-repository)"
+ * {% data variables.product.prodname_dotcom %} will detach public forks of the public repository and put them into a new network. Public forks are not made private. {% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}If you change a repository's visibility from internal to private, {% data variables.product.prodname_dotcom %} will remove forks that belong to any user without access to the newly private repository.{% endif %} For more information, see "[What happens to forks when a repository is deleted or changes visibility?](/articles/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility#changing-a-public-repository-to-a-private-repository)"
{% if currentVersion == "free-pro-team@latest" %}* If you're using {% data variables.product.prodname_free_user %} for user accounts or organizations, some features won't be available in the repository after you change the visibility to private. {% data reusables.gated-features.more-info %}
* Any published {% data variables.product.prodname_pages %} site will be automatically unpublished. If you added a custom domain to the {% data variables.product.prodname_pages %} site, you should remove or update your DNS records before making the repository private, to avoid the risk of a domain takeover. For more information, see "[Managing a custom domain for your {% data variables.product.prodname_pages %} site](/articles/managing-a-custom-domain-for-your-github-pages-site)."
* {% data variables.product.prodname_dotcom %} will no longer included the repository in the {% data variables.product.prodname_archive %}. For more information, see "[About archiving content and data on {% data variables.product.prodname_dotcom %}](/github/creating-cloning-and-archiving-repositories/about-archiving-content-and-data-on-github#about-the-github-archive-program)."{% endif %}
- {% if currentVersion != "free-pro-team@latest" %}* Anonymous Git read access is no longer available. For more information, see "[Enabling anonymous Git read access for a repository](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository)."{% endif %}
+ {% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}* Anonymous Git read access is no longer available. For more information, see "[Enabling anonymous Git read access for a repository](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository)."{% endif %}
#### Making a repository public
* {% data variables.product.prodname_dotcom %} will detach private forks and turn them into a standalone private repository. For more information, see "[What happens to forks when a repository is deleted or changes visibility?](/articles/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility#changing-a-private-repository-to-a-public-repository)"
* If you're converting your private repository to a public repository as part of a move toward creating an open source project, see the [Open Source Guides](http://opensource.guide) for helpful tips and guidelines.{% if currentVersion == "free-pro-team@latest" %} You can also take a free course on managing an open source project with [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}). Once your repository is public, you can also view your repository's community profile to see whether your project meets best practices for supporting contributors. For more information, see "[Viewing your community profile](/articles/viewing-your-community-profile)."{% endif %}
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
### Changing a repository's visibility
diff --git a/content/github/administering-a-repository/transferring-a-repository.md b/content/github/administering-a-repository/transferring-a-repository.md
index 04755d4a0bbd..95343d8a7a69 100644
--- a/content/github/administering-a-repository/transferring-a-repository.md
+++ b/content/github/administering-a-repository/transferring-a-repository.md
@@ -15,6 +15,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### About repository transfers
diff --git a/content/github/administering-a-repository/types-of-required-status-checks.md b/content/github/administering-a-repository/types-of-required-status-checks.md
index a40ae5287e4a..df99212ac796 100644
--- a/content/github/administering-a-repository/types-of-required-status-checks.md
+++ b/content/github/administering-a-repository/types-of-required-status-checks.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
| Type of required status check | Setting | Merge requirements | Considerations |
diff --git a/content/github/administering-a-repository/viewing-branches-in-your-repository.md b/content/github/administering-a-repository/viewing-branches-in-your-repository.md
index 521cc0a94927..b6df1553e534 100644
--- a/content/github/administering-a-repository/viewing-branches-in-your-repository.md
+++ b/content/github/administering-a-repository/viewing-branches-in-your-repository.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.navigate-to-branches %}
diff --git a/content/github/administering-a-repository/viewing-deployment-activity-for-your-repository.md b/content/github/administering-a-repository/viewing-deployment-activity-for-your-repository.md
index 46f338c0640b..9c6758f8c145 100644
--- a/content/github/administering-a-repository/viewing-deployment-activity-for-your-repository.md
+++ b/content/github/administering-a-repository/viewing-deployment-activity-for-your-repository.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% note %}
diff --git a/content/github/administering-a-repository/viewing-your-repositorys-releases-and-tags.md b/content/github/administering-a-repository/viewing-your-repositorys-releases-and-tags.md
index b24a833e6ab6..e11d111666d8 100644
--- a/content/github/administering-a-repository/viewing-your-repositorys-releases-and-tags.md
+++ b/content/github/administering-a-repository/viewing-your-repositorys-releases-and-tags.md
@@ -8,9 +8,10 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
{% tip %}
**Tip**: You can also view a release using the {% data variables.product.prodname_cli %}. For more information, see "[`gh release view`](https://cli.github.com/manual/gh_release_view)" in the {% data variables.product.prodname_cli %} documentation.
diff --git a/content/github/authenticating-to-github/about-authentication-to-github.md b/content/github/authenticating-to-github/about-authentication-to-github.md
index 49c1b2434ab8..c7d1f21a1a11 100644
--- a/content/github/authenticating-to-github/about-authentication-to-github.md
+++ b/content/github/authenticating-to-github/about-authentication-to-github.md
@@ -4,27 +4,29 @@ intro: 'You can securely access your account''s resources by authenticating to {
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### About authentication to {% data variables.product.prodname_dotcom %}
-To keep your account secure, you must authenticate before you can access certain resources on {% data variables.product.product_name %}. When you authenticate to {% data variables.product.product_name %}, you supply or confirm credentials that are unique to you to prove that you are exactly who you declare to be.
+To keep your account secure, you must authenticate before you can access{% if currentVersion != "github-ae@latest" %} certain{% endif %} resources on {% data variables.product.product_name %}. When you authenticate to {% data variables.product.product_name %}, you supply or confirm credentials that are unique to you to prove that you are exactly who you declare to be.
You can access your resources in {% data variables.product.product_name %} in a variety of ways: in the browser, via {% data variables.product.prodname_desktop %} or another desktop application, with the API, or via the command line. Each way of accessing {% data variables.product.product_name %} supports different modes of authentication.
-- Username and password with two-factor authentication
+- {% if currentVersion == "github-ae@latest" %}Your identity provider (IdP){% else %}Username and password with two-factor authentication{% endif %}
- Personal access token
- SSH key
### Authenticating in your browser
-You can authenticate to {% data variables.product.product_name %} in your browser in different ways.
+You can authenticate to {% data variables.product.product_name %} in your browser {% if currentVersion == "github-ae@latest" %}using your IdP. For more information, see "[About authentication with SAML single sign-on](/github/authenticating-to-github/about-authentication-with-saml-single-sign-on)."{% else %}in different ways.
- **Username and password only**
- You'll create a password when you create your user account on {% data variables.product.product_name %}. We recommend that you use a password manager to generate a random and unique password. For more information, see "[Creating a strong password](/github/authenticating-to-github/creating-a-strong-password)."
- **Two-factor authentication (2FA)** (recommended)
- If you enable 2FA, we'll also prompt you to provide a code that's generated by an application on your mobile device or sent as a text message (SMS) after you successfully enter your username and password. For more information, see "[Accessing {% data variables.product.prodname_dotcom %} using two-factor authentication](/github/authenticating-to-github/accessing-github-using-two-factor-authentication#providing-a-2fa-code-when-signing-in-to-the-website)."
- In addition to authentication with a mobile application or a text message, you can optionally add a secondary method of authentication with a security key using WebAuthn. For more information, see "[Configuring two-factor authentication using a security key](/github/authenticating-to-github/configuring-two-factor-authentication#configuring-two-factor-authentication-using-a-security-key)."
+{% endif %}
### Authenticating with {% data variables.product.prodname_desktop %}
@@ -32,7 +34,7 @@ You can authenticate with {% data variables.product.prodname_desktop %} using yo
### Authenticating with the API
-You can authenticate with the {% data variables.product.product_name %} API in different ways.
+You can authenticate with the API in different ways.
- **Personal access tokens**
- In limited situations, such as testing, you can use a personal access token to access the API. Using a personal access token enables you to revoke access at any time. For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)."
diff --git a/content/github/authenticating-to-github/about-authentication-with-saml-single-sign-on.md b/content/github/authenticating-to-github/about-authentication-with-saml-single-sign-on.md
index 99699ecc9b56..fd16a10fdedc 100644
--- a/content/github/authenticating-to-github/about-authentication-with-saml-single-sign-on.md
+++ b/content/github/authenticating-to-github/about-authentication-with-saml-single-sign-on.md
@@ -1,13 +1,26 @@
---
title: About authentication with SAML single sign-on
-intro: 'You can access an organization that uses SAML single sign-on (SSO) by authenticating through an identity provider (IdP). To authenticate with the API or Git on the command line when an organization enforces SAML SSO, you must authorize your personal access token or SSH key.'
+intro: 'You can access {% if currentVersion == "github-ae@latest" %}{% data variables.product.product_location %}{% elsif currentVersion == "free-pro-team@latest" %}an organization that uses SAML single sign-on (SSO){% endif %} by authenticating {% if currentVersion == "github-ae@latest" %}with SAML single sign-on (SSO) {% endif %}through an identity provider (IdP).{% if currentVersion == "free-pro-team@latest" %}To authenticate with the API or Git on the command line when an organization enforces SAML SSO, you must authorize your personal access token or SSH key.{% endif %}'
product: '{% data reusables.gated-features.saml-sso %}'
redirect_from:
- /articles/about-authentication-with-saml-single-sign-on
versions:
free-pro-team: '*'
+ github-ae: '*'
---
+{% if currentVersion == "github-ae@latest" %}
+
+SAML SSO allows an enterprise owner to centrally control and secure access to {% data variables.product.product_name %} from a SAML IdP. When you visit {% data variables.product.product_location %} in a browser, {% data variables.product.product_name %} will redirect you to your IdP to authenticate. After you successfully authenticate with an account on the IdP, the IdP redirects you back to {% data variables.product.product_location %}. {% data variables.product.product_name %} validates the response from your IdP, then grants access.
+
+{% data reusables.saml.you-must-periodically-authenticate %}
+
+If you can't access {% data variables.product.product_name %}, contact your local enterprise owner or administrator for {% data variables.product.product_name %}. You may be able to locate contact information for your enterprise by clicking **Support** at the bottom of any page on {% data variables.product.product_name %}. {% data variables.product.company_short %} and {% data variables.contact.github_support %} do not have access to your IdP, and cannot troubleshoot authentication problems.
+
+{% endif %}
+
+{% if currentVersion == "free-pro-team@latest" %}
+
{% data reusables.saml.dotcom-saml-explanation %} Organization owners can invite your user account on {% data variables.product.prodname_dotcom %} to join their organization that uses SAML SSO, which allows you to contribute to the organization and retain your existing identity and contributions on {% data variables.product.prodname_dotcom %}.
When you access resources within an organization that uses SAML SSO, {% data variables.product.prodname_dotcom %} will redirect you to the organization's SAML IdP to authenticate. After you successfully authenticate with your account on the IdP, the IdP redirects you back to {% data variables.product.prodname_dotcom %}, where you can access the organization's resources.
@@ -16,7 +29,7 @@ When you access resources within an organization that uses SAML SSO, {% data var
If you have recently authenticated with your organization's SAML IdP in your browser, you are automatically authorized when you access a {% data variables.product.prodname_dotcom %} organization that uses SAML SSO. If you haven't recently authenticated with your organization's SAML IdP in your browser, you must authenticate at the SAML IdP before you can access the organization.
-You must periodically authenticate with your SAML IdP to authenticate and gain access to the organization's resources on {% data variables.product.prodname_dotcom %}. The duration of this login period is specified by your IdP and is generally 24 hours. This periodic login requirement limits the length of access and requires you to re-identify yourself to continue. You can view and manage your active SAML sessions in your security settings. For more information, see "[Viewing and managing your active SAML sessions](/articles/viewing-and-managing-your-active-saml-sessions)."
+{% data reusables.saml.you-must-periodically-authenticate %}
To use the API or Git on the command line to access protected content in an organization that uses SAML SSO, you will need to use an authorized personal access token over HTTPS or an authorized SSH key. {% data variables.product.prodname_oauth_app %} access tokens are authorized by default.
@@ -26,6 +39,9 @@ To use a new or existing personal access token or SSH key with an organization t
You must have an active SAML session each time you authorize an {% data variables.product.prodname_oauth_app %}.
+{% endif %}
+
### Further reading
-- "[About identity and access management with SAML single sign-on](/github/setting-up-and-managing-organizations-and-teams/about-identity-and-access-management-with-saml-single-sign-on)"
+{% if currentVersion == "free-pro-team@latest" %}- "[About identity and access management with SAML single sign-on](/github/setting-up-and-managing-organizations-and-teams/about-identity-and-access-management-with-saml-single-sign-on)"{% endif %}
+{% if currentVersion == "github-ae@latest" %}- "[About identity and access management for your enterprise](/admin/authentication/about-identity-and-access-management-for-your-enterprise)"{% endif %}
diff --git a/content/github/authenticating-to-github/about-commit-signature-verification.md b/content/github/authenticating-to-github/about-commit-signature-verification.md
index 1eba3788d22f..164e84774828 100644
--- a/content/github/authenticating-to-github/about-commit-signature-verification.md
+++ b/content/github/authenticating-to-github/about-commit-signature-verification.md
@@ -1,6 +1,6 @@
---
title: About commit signature verification
-intro: 'Using GPG{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.14" %} or S/MIME{% endif %}, you can sign tags and commits locally. These tags or commits are marked as verified on {% data variables.product.product_name %} so other people can trust that the changes come from a trusted source.'
+intro: 'Using GPG or S/MIME, you can sign tags and commits locally. These tags or commits are marked as verified on {% data variables.product.product_name %} so other people can trust that the changes come from a trusted source.'
redirect_from:
- /articles/about-gpg-commit-and-tag-signatures/
- /articles/about-gpg/
@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### About commit signature verification
diff --git a/content/github/authenticating-to-github/about-ssh.md b/content/github/authenticating-to-github/about-ssh.md
index 9004595bdd55..e6d03cbea3ab 100644
--- a/content/github/authenticating-to-github/about-ssh.md
+++ b/content/github/authenticating-to-github/about-ssh.md
@@ -1,11 +1,12 @@
---
title: About SSH
-intro: 'Using the SSH protocol, you can connect and authenticate to remote servers and services. With SSH keys, you can connect to {% data variables.product.product_name %} without supplying your username or password at each visit.'
+intro: 'Using the SSH protocol, you can connect and authenticate to remote servers and services. With SSH keys, you can connect to {% data variables.product.product_name %} without supplying your username and personal access token at each visit.'
redirect_from:
- /articles/about-ssh
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
When you set up SSH, you'll [generate an SSH key and add it to the ssh-agent](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) and then [add the key to your {% data variables.product.product_name %} account](/articles/adding-a-new-ssh-key-to-your-github-account). Adding the SSH key to the ssh-agent ensures that your SSH key has an extra layer of security through the use of a passphrase. For more information, see "[Working with SSH key passphrases](/articles/working-with-ssh-key-passphrases)."
diff --git a/content/github/authenticating-to-github/adding-a-new-gpg-key-to-your-github-account.md b/content/github/authenticating-to-github/adding-a-new-gpg-key-to-your-github-account.md
index a0d8f40f837f..e8c4ba5e23c0 100644
--- a/content/github/authenticating-to-github/adding-a-new-gpg-key-to-your-github-account.md
+++ b/content/github/authenticating-to-github/adding-a-new-gpg-key-to-your-github-account.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Before adding a new GPG key to your {% data variables.product.product_name %} account, you should have:
diff --git a/content/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account.md b/content/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account.md
index 92956427aba8..6c1db79b1b4d 100644
--- a/content/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account.md
+++ b/content/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Before adding a new SSH key to your {% data variables.product.product_name %} account, you should have:
diff --git a/content/github/authenticating-to-github/associating-an-email-with-your-gpg-key.md b/content/github/authenticating-to-github/associating-an-email-with-your-gpg-key.md
index 61632f56c75f..6e3825004905 100644
--- a/content/github/authenticating-to-github/associating-an-email-with-your-gpg-key.md
+++ b/content/github/authenticating-to-github/associating-an-email-with-your-gpg-key.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% note %}
diff --git a/content/github/authenticating-to-github/authenticating-with-saml-single-sign-on.md b/content/github/authenticating-to-github/authenticating-with-saml-single-sign-on.md
index 7aef5dbc735a..e1cc60930123 100644
--- a/content/github/authenticating-to-github/authenticating-with-saml-single-sign-on.md
+++ b/content/github/authenticating-to-github/authenticating-with-saml-single-sign-on.md
@@ -1,11 +1,13 @@
---
title: Authenticating with SAML single sign-on
-intro: 'You can authenticate to a {% data variables.product.product_name %} organization with SAML single sign-on (SSO) and view your active sessions.'
+intro: 'You can authenticate to {% if currentVersion == "free-pro-team@latest" %}a {% data variables.product.product_name %} organization {% elsif currentVersion == "github-ae@latest" %}{% data variables.product.product_location %} {% endif %}with SAML single sign-on (SSO){% if currentVersion == "free-pro-team@latest" %} and view your active sessions{% endif %}.'
mapTopic: true
+product: '{% data reusables.gated-features.saml-sso %}'
redirect_from:
- /articles/authenticating-to-a-github-organization-with-saml-single-sign-on/
- /articles/authenticating-with-saml-single-sign-on
versions:
free-pro-team: '*'
+ github-ae: '*'
---
diff --git a/content/github/authenticating-to-github/authorizing-oauth-apps.md b/content/github/authenticating-to-github/authorizing-oauth-apps.md
index eba3bcec9b15..a63b81f18057 100644
--- a/content/github/authenticating-to-github/authorizing-oauth-apps.md
+++ b/content/github/authenticating-to-github/authorizing-oauth-apps.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
When an {% data variables.product.prodname_oauth_app %} wants to identify you by your {% data variables.product.product_name %} account, you'll see a page with the app's developer contact information and a list of the specific data that's being requested.
diff --git a/content/github/authenticating-to-github/checking-for-existing-gpg-keys.md b/content/github/authenticating-to-github/checking-for-existing-gpg-keys.md
index 4abf9e60c93c..1ffc22df36a8 100644
--- a/content/github/authenticating-to-github/checking-for-existing-gpg-keys.md
+++ b/content/github/authenticating-to-github/checking-for-existing-gpg-keys.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.gpg.supported-gpg-key-algorithms %}
diff --git a/content/github/authenticating-to-github/checking-for-existing-ssh-keys.md b/content/github/authenticating-to-github/checking-for-existing-ssh-keys.md
index 5fce820e48c9..9a95a12d6b61 100644
--- a/content/github/authenticating-to-github/checking-for-existing-ssh-keys.md
+++ b/content/github/authenticating-to-github/checking-for-existing-ssh-keys.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.ssh.dsa-support %}
diff --git a/content/github/authenticating-to-github/checking-your-commit-and-tag-signature-verification-status.md b/content/github/authenticating-to-github/checking-your-commit-and-tag-signature-verification-status.md
index 4959f73dda8f..2e7403a50fc8 100644
--- a/content/github/authenticating-to-github/checking-your-commit-and-tag-signature-verification-status.md
+++ b/content/github/authenticating-to-github/checking-your-commit-and-tag-signature-verification-status.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Checking your commit signature verification status
diff --git a/content/github/authenticating-to-github/connecting-to-github-with-ssh.md b/content/github/authenticating-to-github/connecting-to-github-with-ssh.md
index 948ffa9f63bc..2f82f7db52d3 100644
--- a/content/github/authenticating-to-github/connecting-to-github-with-ssh.md
+++ b/content/github/authenticating-to-github/connecting-to-github-with-ssh.md
@@ -14,5 +14,6 @@ mapTopic: true
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/authenticating-to-github/connecting-with-third-party-applications.md b/content/github/authenticating-to-github/connecting-with-third-party-applications.md
index 15b7c3bc35b4..e792daf5ec5f 100644
--- a/content/github/authenticating-to-github/connecting-with-third-party-applications.md
+++ b/content/github/authenticating-to-github/connecting-with-third-party-applications.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
When a third-party application wants to identify you by your {% data variables.product.product_name %} login, you'll see a page with the developer contact information and a list of the specific data that's being requested.
@@ -54,10 +55,10 @@ There are several types of data that applications can request.
| Type of data | Description |
| --- | --- |
| Commit status | You can grant access for a third-party application to report your commit status. Commit status access allows applications to determine if a build is a successful against a specific commit. Applications won't have access to your code, but they can read and write status information against a specific commit. |
-| Deployments | Deployment status access allows applicationss to determine if a deployment is successful against a specific commit for public and private repositories. Applicationss won't have access to your code. |
+| Deployments | Deployment status access allows applications to determine if a deployment is successful against a specific commit for public and private repositories. Applications won't have access to your code. |
| Gists | [Gist](https://gist.github.com) access allows applications to read or write to both your public and secret Gists. |
| Hooks | [Webhooks](/webhooks) access allows applications to read or write hook configurations on repositories you manage. |
-| Notifications | Notification access allows applicationss to read your {% data variables.product.product_name %} notifications, such as comments on issues and pull requests. However, applications remain unable to access anything in your repositories. |
+| Notifications | Notification access allows applications to read your {% data variables.product.product_name %} notifications, such as comments on issues and pull requests. However, applications remain unable to access anything in your repositories. |
| Organizations and teams | Organization and teams access allows apps to access and manage organization and team membership. |
| Personal user data | User data includes information found in your user profile, like your name, e-mail address, and location. |
| Repositories | Repository information includes the names of contributors, the branches you've created, and the actual files within your repository. Applications can request access for either public or private repositories on a user-wide level. |
diff --git a/content/github/authenticating-to-github/creating-a-personal-access-token.md b/content/github/authenticating-to-github/creating-a-personal-access-token.md
index 7561198c565e..e416dbd916e8 100644
--- a/content/github/authenticating-to-github/creating-a-personal-access-token.md
+++ b/content/github/authenticating-to-github/creating-a-personal-access-token.md
@@ -9,6 +9,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Personal access tokens (PATs) are an alternative to using passwords for authentication to {% data variables.product.product_name %} when using the [GitHub API](/v3/auth/#via-oauth-and-personal-access-tokens) or the [command line](#using-a-token-on-the-command-line).
diff --git a/content/github/authenticating-to-github/error-agent-admitted-failure-to-sign.md b/content/github/authenticating-to-github/error-agent-admitted-failure-to-sign.md
index 95b6f3df8579..ad63b888c36e 100644
--- a/content/github/authenticating-to-github/error-agent-admitted-failure-to-sign.md
+++ b/content/github/authenticating-to-github/error-agent-admitted-failure-to-sign.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
When trying to SSH into {% data variables.product.product_location %} on a Linux computer, you may see the following message in your terminal:
diff --git a/content/github/authenticating-to-github/error-bad-file-number.md b/content/github/authenticating-to-github/error-bad-file-number.md
index fa1ee2bcf580..af70808b4358 100644
--- a/content/github/authenticating-to-github/error-bad-file-number.md
+++ b/content/github/authenticating-to-github/error-bad-file-number.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
When running remote Git commands or SSH, your connection might time out:
diff --git a/content/github/authenticating-to-github/error-key-already-in-use.md b/content/github/authenticating-to-github/error-key-already-in-use.md
index e26e44ea86ee..2e4c52a8bf33 100644
--- a/content/github/authenticating-to-github/error-key-already-in-use.md
+++ b/content/github/authenticating-to-github/error-key-already-in-use.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Finding where the key has been used
diff --git a/content/github/authenticating-to-github/error-permission-denied-publickey.md b/content/github/authenticating-to-github/error-permission-denied-publickey.md
index 75af14ce4136..6057153d6bde 100644
--- a/content/github/authenticating-to-github/error-permission-denied-publickey.md
+++ b/content/github/authenticating-to-github/error-permission-denied-publickey.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Should the `sudo` command be used with Git?
@@ -51,7 +52,7 @@ $ ssh -T git@{% data variables.command_line.codeblock %}
{% mac %}
{% data reusables.command_line.open_the_multi_os_terminal %}
-2. Verify that you have a private key generated and loaded into SSH. {% if currentVersion ver_lt "enterprise-server@2.23" %}If you're using OpenSSH 6.7 or older:
+2. Verify that you have a private key generated and loaded into SSH. {% if currentVersion ver_lt "enterprise-server@3.0" %}If you're using OpenSSH 6.7 or older:
```shell
# start the ssh-agent in the background
$ eval "$(ssh-agent -s)"
@@ -86,7 +87,7 @@ $ ssh -T git@{% data variables.command_line.codeblock %}
1. {% data reusables.desktop.windows_git_bash_turn_on_ssh_agent %}
{% data reusables.desktop.windows_git_for_windows_turn_on_ssh_agent %}
-2. Verify that you have a private key generated and loaded into SSH. {% if currentVersion ver_lt "enterprise-server@2.23" %}If you're using OpenSSH 6.7 or older:
+2. Verify that you have a private key generated and loaded into SSH. {% if currentVersion ver_lt "enterprise-server@3.0" %}If you're using OpenSSH 6.7 or older:
```shell
$ ssh-add -l
> 2048 a0:dd:42:3c:5a:9d:e4:2a:21:52:4e:78:07:6e:c8:4d /Users/you/.ssh/id_rsa (RSA)
@@ -108,7 +109,7 @@ $ ssh -T git@{% data variables.command_line.codeblock %}
{% linux %}
{% data reusables.command_line.open_the_multi_os_terminal %}
-2. Verify that you have a private key generated and loaded into SSH. {% if currentVersion ver_lt "enterprise-server@2.23" %}If you're using OpenSSH 6.7 or older:
+2. Verify that you have a private key generated and loaded into SSH. {% if currentVersion ver_lt "enterprise-server@3.0" %}If you're using OpenSSH 6.7 or older:
```shell
# start the ssh-agent in the background
$ eval "$(ssh-agent -s)"
@@ -186,7 +187,7 @@ You must provide your public key to {% data variables.product.product_name %} to
$ eval "$(ssh-agent -s)"
> Agent pid 59566
```
-3. Find and take a note of your public key fingerprint. {% if currentVersion ver_lt "enterprise-server@2.23" %}If you're using OpenSSH 6.7 or older:
+3. Find and take a note of your public key fingerprint. {% if currentVersion ver_lt "enterprise-server@3.0" %}If you're using OpenSSH 6.7 or older:
```shell
$ ssh-add -l
> 2048 a0:dd:42:3c:5a:9d:e4:2a:21:52:4e:78:07:6e:c8:4d /Users/USERNAME/.ssh/id_rsa (RSA)
@@ -218,7 +219,7 @@ You must provide your public key to {% data variables.product.product_name %} to
$ ssh-agent -s
> Agent pid 59566
```
-3. Find and take a note of your public key fingerprint. {% if currentVersion ver_lt "enterprise-server@2.23" %}If you're using OpenSSH 6.7 or older:
+3. Find and take a note of your public key fingerprint. {% if currentVersion ver_lt "enterprise-server@3.0" %}If you're using OpenSSH 6.7 or older:
```shell
$ ssh-add -l
> 2048 a0:dd:42:3c:5a:9d:e4:2a:21:52:4e:78:07:6e:c8:4d /Users/USERNAME/.ssh/id_rsa (RSA)
diff --git a/content/github/authenticating-to-github/error-permission-to-userrepo-denied-to-other-user.md b/content/github/authenticating-to-github/error-permission-to-userrepo-denied-to-other-user.md
index 6d40fe7226e7..f45e846a3edb 100644
--- a/content/github/authenticating-to-github/error-permission-to-userrepo-denied-to-other-user.md
+++ b/content/github/authenticating-to-github/error-permission-to-userrepo-denied-to-other-user.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
To fix this, the owner of the repository (`user`) needs to add your account (`other-user`) as a collaborator on the repository or to a team that has write access to the repository.
diff --git a/content/github/authenticating-to-github/error-permission-to-userrepo-denied-to-userother-repo.md b/content/github/authenticating-to-github/error-permission-to-userrepo-denied-to-userother-repo.md
index a7f02b479ce0..dda09ea92a69 100644
--- a/content/github/authenticating-to-github/error-permission-to-userrepo-denied-to-userother-repo.md
+++ b/content/github/authenticating-to-github/error-permission-to-userrepo-denied-to-userother-repo.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
To fix this, remove the deploy key from the repository, and [add the key to your user account](/articles/adding-a-new-ssh-key-to-your-github-account) instead.
diff --git a/content/github/authenticating-to-github/error-ssh-add-illegal-option----k.md b/content/github/authenticating-to-github/error-ssh-add-illegal-option----k.md
index 50d561cd99ff..3d9d3e3fad74 100644
--- a/content/github/authenticating-to-github/error-ssh-add-illegal-option----k.md
+++ b/content/github/authenticating-to-github/error-ssh-add-illegal-option----k.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
The `-K` option is in Apple's standard version of `ssh-add`, which stores the passphrase in your keychain for you when you add an ssh key to the ssh-agent. If you have installed a different version of `ssh-add`, it may lack support for `-K`.
diff --git a/content/github/authenticating-to-github/error-were-doing-an-ssh-key-audit.md b/content/github/authenticating-to-github/error-were-doing-an-ssh-key-audit.md
index 2a2016ae6c0c..3ca153f2dfba 100644
--- a/content/github/authenticating-to-github/error-were-doing-an-ssh-key-audit.md
+++ b/content/github/authenticating-to-github/error-were-doing-an-ssh-key-audit.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
When using an unverified key to perform Git operations, you will be prompted to perform an audit of your SSH keys.
diff --git a/content/github/authenticating-to-github/generating-a-new-gpg-key.md b/content/github/authenticating-to-github/generating-a-new-gpg-key.md
index 55a749b8f15d..b02d4f0cefdd 100644
--- a/content/github/authenticating-to-github/generating-a-new-gpg-key.md
+++ b/content/github/authenticating-to-github/generating-a-new-gpg-key.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.gpg.supported-gpg-key-algorithms %}
@@ -29,7 +30,7 @@ versions:
```shell
$ gpg --default-new-key-algo rsa4096 --gen-key
```
-4. At the prompt, specify the kind of key you want, or press `Enter` to accept the default `RSA and DSA`.
+4. At the prompt, specify the kind of key you want, or press `Enter` to accept the default `RSA and RSA`.
5. Enter the desired key size. Your key must be at least `4096` bits.
6. Enter the length of time the key should be valid. Press `Enter` to specify the default selection, indicating that the key doesn't expire.
7. Verify that your selections are correct.
diff --git a/content/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md b/content/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md
index 5997d0816d0a..bb0910cc2b0e 100644
--- a/content/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md
+++ b/content/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md
@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
If you don't already have an SSH key, you must [generate a new SSH key](#generating-a-new-ssh-key). If you're unsure whether you already have an SSH key, check for [existing keys](/articles/checking-for-existing-ssh-keys).
@@ -19,18 +20,26 @@ If you don't want to reenter your passphrase every time you use your SSH key, yo
{% data reusables.command_line.open_the_multi_os_terminal %}
2. Paste the text below, substituting in your {% data variables.product.product_name %} email address.
```shell
- $ ssh-keygen -t rsa -b 4096 -C "your_email@example.com"
+ $ ssh-keygen -t ed25519 -C "your_email@example.com"
```
+ {% note %}
+
+ **Note:** If you are using a legacy system that doesn't support the Ed25519 algorithm, use:
+ ```shell
+ $ ssh-keygen -t rsa -b 4096 -C "your_email@example.com"
+ ```
+
+ {% endnote %}
This creates a new ssh key, using the provided email as a label.
```shell
- > Generating public/private rsa key pair.
+ > Generating public/private ed25519 key pair.
```
3. When you're prompted to "Enter a file in which to save the key," press Enter. This accepts the default file location.
{% mac %}
```shell
- > Enter a file in which to save the key (/Users/you/.ssh/id_rsa): [Press enter]
+ > Enter a file in which to save the key (/Users/you/.ssh/id_ed25519): [Press enter]
```
{% endmac %}
@@ -38,7 +47,7 @@ If you don't want to reenter your passphrase every time you use your SSH key, yo
{% windows %}
```shell
- > Enter a file in which to save the key (/c/Users/you/.ssh/id_rsa):[Press enter]
+ > Enter a file in which to save the key (/c/Users/you/.ssh/id_ed25519):[Press enter]
```
{% endwindows %}
@@ -46,7 +55,7 @@ If you don't want to reenter your passphrase every time you use your SSH key, yo
{% linux %}
```shell
- > Enter a file in which to save the key (/home/you/.ssh/id_rsa): [Press enter]
+ > Enter a file in which to save the key (/home/you/.ssh/id_ed25519): [Press enter]
```
{% endlinux %}
@@ -80,18 +89,18 @@ Before adding a new SSH key to the ssh-agent to manage your keys, you should hav
$ touch ~/.ssh/config
```
- * Open your `~/.ssh/config` file, then modify the file, replacing ` ~/.ssh/id_rsa` if you are not using the default location and name for your `id_rsa` key.
+ * Open your `~/.ssh/config` file, then modify the file, replacing ` ~/.ssh/id_ed25519` if you are not using the default location and name for your `id_ed25519` key.
```
Host *
AddKeysToAgent yes
UseKeychain yes
- IdentityFile ~/.ssh/id_rsa
+ IdentityFile ~/.ssh/id_ed25519
```
3. Add your SSH private key to the ssh-agent and store your passphrase in the keychain. {% data reusables.ssh.add-ssh-key-to-ssh-agent %}
```shell
- $ ssh-add -K ~/.ssh/id_rsa
+ $ ssh-add -K ~/.ssh/id_ed25519
```
{% note %}
diff --git a/content/github/authenticating-to-github/githubs-ssh-key-fingerprints.md b/content/github/authenticating-to-github/githubs-ssh-key-fingerprints.md
index 007a22af6d04..309b4e69c182 100644
--- a/content/github/authenticating-to-github/githubs-ssh-key-fingerprints.md
+++ b/content/github/authenticating-to-github/githubs-ssh-key-fingerprints.md
@@ -9,12 +9,7 @@ versions:
free-pro-team: '*'
---
-These are {% data variables.product.prodname_dotcom %}'s public key fingerprints (in hexadecimal format):
-
-- `16:27:ac:a5:76:28:2d:36:63:1b:56:4d:eb:df:a6:48` (RSA)
-- `ad:1c:08:a4:40:e3:6f:9c:f5:66:26:5d:4b:33:5d:8c` (DSA)
-
-These are the SHA256 hashes shown in OpenSSH 6.8 and newer (in base64 format):
+These are {% data variables.product.prodname_dotcom %}'s public key fingerprints:
- `SHA256:nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8` (RSA)
- `SHA256:br9IjFspm1vxR3iA35FWE+4VTyz1hYVLIE2t1/CeyWQ` (DSA)
diff --git a/content/github/authenticating-to-github/index.md b/content/github/authenticating-to-github/index.md
index d48b7ccdbc97..1ea2f31cb2b8 100644
--- a/content/github/authenticating-to-github/index.md
+++ b/content/github/authenticating-to-github/index.md
@@ -1,7 +1,7 @@
---
title: Authenticating to GitHub
shortTitle: Authentication
-intro: 'Keep your account and data secure with features like two-factor authentication, SSH, and commit signature verification.'
+intro: 'Keep your account and data secure with features like {% if currentVersion != "github-ae@latest" %}two-factor authentication, {% endif %}SSH{% if currentVersion != "github-ae@latest" %},{% endif %} and commit signature verification.'
redirect_from:
- /categories/56/articles/
- /categories/ssh/
@@ -16,6 +16,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/authenticating-to-github/keeping-your-account-and-data-secure.md b/content/github/authenticating-to-github/keeping-your-account-and-data-secure.md
index 134c5fd438fa..183fecb7f34f 100644
--- a/content/github/authenticating-to-github/keeping-your-account-and-data-secure.md
+++ b/content/github/authenticating-to-github/keeping-your-account-and-data-secure.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/authenticating-to-github/managing-commit-signature-verification.md b/content/github/authenticating-to-github/managing-commit-signature-verification.md
index 064f8efc010b..da61d7119659 100644
--- a/content/github/authenticating-to-github/managing-commit-signature-verification.md
+++ b/content/github/authenticating-to-github/managing-commit-signature-verification.md
@@ -1,6 +1,6 @@
---
title: Managing commit signature verification
-intro: 'You can sign your work locally using GPG{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.14" %} or S/MIME{% endif %}. {% data variables.product.product_name %} will verify these signatures so other people will know that your commits come from a trusted source.{% if currentVersion == "free-pro-team@latest" %} {% data variables.product.product_name %} will automatically sign commits you make using the {% data variables.product.product_name %} web interface.{% endif %}'
+intro: 'You can sign your work locally using GPG or S/MIME. {% data variables.product.product_name %} will verify these signatures so other people will know that your commits come from a trusted source.{% if currentVersion == "free-pro-team@latest" %} {% data variables.product.product_name %} will automatically sign commits you make using the {% data variables.product.product_name %} web interface.{% endif %}'
redirect_from:
- /articles/generating-a-gpg-key/
- /articles/signing-commits-with-gpg/
@@ -9,5 +9,6 @@ mapTopic: true
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/authenticating-to-github/recovering-your-ssh-key-passphrase.md b/content/github/authenticating-to-github/recovering-your-ssh-key-passphrase.md
index 3bb14b222896..fc251cc1e1b6 100644
--- a/content/github/authenticating-to-github/recovering-your-ssh-key-passphrase.md
+++ b/content/github/authenticating-to-github/recovering-your-ssh-key-passphrase.md
@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% mac %}
diff --git a/content/github/authenticating-to-github/removing-sensitive-data-from-a-repository.md b/content/github/authenticating-to-github/removing-sensitive-data-from-a-repository.md
index c6c01f545620..96185410bb1f 100644
--- a/content/github/authenticating-to-github/removing-sensitive-data-from-a-repository.md
+++ b/content/github/authenticating-to-github/removing-sensitive-data-from-a-repository.md
@@ -9,6 +9,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
The `git filter-branch` command and the BFG Repo-Cleaner rewrite your repository's history, which changes the SHAs for existing commits that you alter and any dependent commits. Changed commit SHAs may affect open pull requests in your repository. We recommend merging or closing all open pull requests before removing files from your repository.
@@ -134,7 +135,7 @@ To illustrate how `git filter-branch` works, we'll show you how to remove your f
{% endnote %}
-## Avoiding accidental commits in the future
+### Avoiding accidental commits in the future
There are a few simple tricks to avoid committing things you don't want committed:
@@ -145,5 +146,5 @@ There are a few simple tricks to avoid committing things you don't want committe
### Further reading
-- [`git filter-branch` main page](https://git-scm.com/docs/git-filter-branch)
+- [`git filter-branch` man page](https://git-scm.com/docs/git-filter-branch)
- [Pro Git: Git Tools - Rewriting History](https://git-scm.com/book/en/Git-Tools-Rewriting-History)
diff --git a/content/github/authenticating-to-github/reviewing-your-authorized-applications-oauth.md b/content/github/authenticating-to-github/reviewing-your-authorized-applications-oauth.md
index 34088755d1bb..ce1fd85a5736 100644
--- a/content/github/authenticating-to-github/reviewing-your-authorized-applications-oauth.md
+++ b/content/github/authenticating-to-github/reviewing-your-authorized-applications-oauth.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.user_settings.access_settings %}
diff --git a/content/github/authenticating-to-github/reviewing-your-authorized-integrations.md b/content/github/authenticating-to-github/reviewing-your-authorized-integrations.md
index 53bb20685dd9..6bbe5801e191 100644
--- a/content/github/authenticating-to-github/reviewing-your-authorized-integrations.md
+++ b/content/github/authenticating-to-github/reviewing-your-authorized-integrations.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Reviewing your authorized {% data variables.product.prodname_oauth_app %}s
diff --git a/content/github/authenticating-to-github/reviewing-your-deploy-keys.md b/content/github/authenticating-to-github/reviewing-your-deploy-keys.md
index 930ea94e69d2..85eba969b973 100644
--- a/content/github/authenticating-to-github/reviewing-your-deploy-keys.md
+++ b/content/github/authenticating-to-github/reviewing-your-deploy-keys.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.repositories.navigate-to-repo %}
diff --git a/content/github/authenticating-to-github/reviewing-your-security-log.md b/content/github/authenticating-to-github/reviewing-your-security-log.md
index 38e933477191..264a3a22b0a1 100644
--- a/content/github/authenticating-to-github/reviewing-your-security-log.md
+++ b/content/github/authenticating-to-github/reviewing-your-security-log.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Accessing your security log
@@ -13,7 +14,7 @@ versions:
The security log lists all actions performed within the last 90 days{% if currentVersion ver_lt "enterprise-server@2.20" %}, up to 50{% endif %}.
{% data reusables.user_settings.access_settings %}
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
2. In the user settings sidebar, click **Security log**.
{% else %}
@@ -24,7 +25,7 @@ The security log lists all actions performed within the last 90 days{% if curren
{% endif %}
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
### Searching your security log
{% data reusables.audit_log.audit-log-search %}
@@ -48,9 +49,9 @@ Actions listed in your security log are grouped within the following categories:
| `project` | Contains all activities related to project boards.
| `public_key` | Contains all activities related to [your public SSH keys](/articles/adding-a-new-ssh-key-to-your-github-account).
| `repo` | Contains all activities related to the repositories you own.{% if currentVersion == "free-pro-team@latest" %}
-| `sponsors` | Contains all events related to {% data variables.product.prodname_sponsors %} and sponsor buttons (see "[About {% data variables.product.prodname_sponsors %}](/articles/about-github-sponsors)" and "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)"){% endif %}{% if currentVersion != "free-pro-team@latest" %}
-| `team` | Contains all activities related to teams you are a part of.{% endif %}
-| `two_factor_authentication` | Contains all activities related to [two-factor authentication](/articles/securing-your-account-with-two-factor-authentication-2fa).
+| `sponsors` | Contains all events related to {% data variables.product.prodname_sponsors %} and sponsor buttons (see "[About {% data variables.product.prodname_sponsors %}](/articles/about-github-sponsors)" and "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)"){% endif %}{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
+| `team` | Contains all activities related to teams you are a part of.{% endif %}{% if currentVersion != "github-ae@latest" %}
+| `two_factor_authentication` | Contains all activities related to [two-factor authentication](/articles/securing-your-account-with-two-factor-authentication-2fa).{% endif %}
| `user` | Contains all activities related to your account.
A description of the events within these categories is listed below.
@@ -142,7 +143,7 @@ A description of the events within these categories is listed below.
| access | Triggered when you a repository you own is [switched from "private" to "public"](/articles/making-a-private-repository-public) (or vice versa).
| add_member | Triggered when a {% data variables.product.product_name %} user is {% if currentVersion == "free-pro-team@latest" %}[invited to have collaboration access](/articles/inviting-collaborators-to-a-personal-repository){% else %}[given collaboration access](/articles/inviting-collaborators-to-a-personal-repository){% endif %} to a repository.
| add_topic | Triggered when a repository owner [adds a topic](/articles/classifying-your-repository-with-topics) to a repository.
-| archived | Triggered when a repository owner [archives a repository](/articles/about-archiving-repositories).{% if currentVersion != "free-pro-team@latest" %}
+| archived | Triggered when a repository owner [archives a repository](/articles/about-archiving-repositories).{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
| config.disable_anonymous_git_access | Triggered when [anonymous Git read access is disabled](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository) in a public repository.
| config.enable_anonymous_git_access | Triggered when [anonymous Git read access is enabled](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository) in a public repository.
| config.lock_anonymous_git_access | Triggered when a repository's [anonymous Git read access setting is locked](/enterprise/{{ currentVersion }}/admin/guides/user-management/preventing-users-from-changing-anonymous-git-read-access).
@@ -191,7 +192,7 @@ A description of the events within these categories is listed below.
| revoke | Triggered when you revoke a succession invitation (see "[Maintaining ownership continuity of your user account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)")
{% endif %}
-{% if currentVersion != "free-pro-team@latest" %}
+{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
#### The `team` category
@@ -206,26 +207,28 @@ A description of the events within these categories is listed below.
{% endif %}
+{% if currentVersion != "github-ae@latest" %}
#### The `two_factor_authentication` category
| Action | Description
|------------------|-------------------
| enabled | Triggered when [two-factor authentication](/articles/securing-your-account-with-two-factor-authentication-2fa) is enabled.
| disabled | Triggered when two-factor authentication is disabled.
+{% endif %}
#### The `user` category
| Action | Description
|--------------------|---------------------
-| add_email | Triggered when you [add a new email address](/articles/changing-your-primary-email-address).
+| add_email | Triggered when you {% if currentVersion != "github-ae@latest" %}[add a new email address](/articles/changing-your-primary-email-address){% else %}add a new email address{% endif %}.
| create | Triggered when you create a new user account.
| remove_email | Triggered when you remove an email address.
-| rename | Triggered when you rename your account.
+| rename | Triggered when you rename your account.{% if currentVersion != "github-ae@latest" %}
| change_password | Triggered when you change your password.
-| forgot_password | Triggered when you ask for [a password reset](/articles/how-can-i-reset-my-password).
+| forgot_password | Triggered when you ask for [a password reset](/articles/how-can-i-reset-my-password).{% endif %}
| login | Triggered when you log in to {% data variables.product.product_location %}.
-| failed_login | Triggered when you failed to log in successfully.
-| two_factor_requested | Triggered when {% data variables.product.product_name %} asks you for [your two-factor authentication code](/articles/accessing-github-using-two-factor-authentication).
+| failed_login | Triggered when you failed to log in successfully.{% if currentVersion != "github-ae@latest" %}
+| two_factor_requested | Triggered when {% data variables.product.product_name %} asks you for [your two-factor authentication code](/articles/accessing-github-using-two-factor-authentication).{% endif %}
| show_private_contributions_count | Triggered when you [publicize private contributions on your profile](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile).
| hide_private_contributions_count | Triggered when you [hide private contributions on your profile](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile).{% if currentVersion == "free-pro-team@latest" %}
| report_content | Triggered when you [report an issue or pull request, or a comment on an issue, pull request, or commit](/articles/reporting-abuse-or-spam).{% endif %}
diff --git a/content/github/authenticating-to-github/reviewing-your-ssh-keys.md b/content/github/authenticating-to-github/reviewing-your-ssh-keys.md
index 71ea5e3d0586..ba3e70593d86 100644
--- a/content/github/authenticating-to-github/reviewing-your-ssh-keys.md
+++ b/content/github/authenticating-to-github/reviewing-your-ssh-keys.md
@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
You can delete unauthorized (or possibly compromised) SSH keys to ensure that an attacker no longer has access to your repositories. You can also approve existing SSH keys that are valid.
@@ -29,7 +30,7 @@ You can delete unauthorized (or possibly compromised) SSH keys to ensure that an
5. {% data reusables.command_line.start_ssh_agent %}
-6. Find and take a note of your public key fingerprint. {% if currentVersion ver_lt "enterprise-server@2.23" %}If you're using OpenSSH 6.7 or older:
+6. Find and take a note of your public key fingerprint. {% if currentVersion ver_lt "enterprise-server@3.0" %}If you're using OpenSSH 6.7 or older:
```shell
$ ssh-add -l
> 2048 a0:dd:42:3c:5a:9d:e4:2a:21:52:4e:78:07:6e:c8:4d /Users/USERNAME/.ssh/id_rsa (RSA)
@@ -69,7 +70,7 @@ You can delete unauthorized (or possibly compromised) SSH keys to ensure that an
{% data reusables.desktop.windows_git_for_windows_turn_on_ssh_agent %}
-6. Find and take a note of your public key fingerprint. {% if currentVersion ver_lt "enterprise-server@2.23" %}If you're using OpenSSH 6.7 or older:
+6. Find and take a note of your public key fingerprint. {% if currentVersion ver_lt "enterprise-server@3.0" %}If you're using OpenSSH 6.7 or older:
```shell
$ ssh-add -l
> 2048 a0:dd:42:3c:5a:9d:e4:2a:21:52:4e:78:07:6e:c8:4d /Users/USERNAME/.ssh/id_rsa (RSA)
@@ -107,7 +108,7 @@ You can delete unauthorized (or possibly compromised) SSH keys to ensure that an
5. {% data reusables.command_line.start_ssh_agent %}
-6. Find and take a note of your public key fingerprint. {% if currentVersion ver_lt "enterprise-server@2.23" %}If you're using OpenSSH 6.7 or older:
+6. Find and take a note of your public key fingerprint. {% if currentVersion ver_lt "enterprise-server@3.0" %}If you're using OpenSSH 6.7 or older:
```shell
$ ssh-add -l
> 2048 a0:dd:42:3c:5a:9d:e4:2a:21:52:4e:78:07:6e:c8:4d /Users/USERNAME/.ssh/id_rsa (RSA)
diff --git a/content/github/authenticating-to-github/signing-commits.md b/content/github/authenticating-to-github/signing-commits.md
index 2641bee468af..fe4fefa5cb8a 100644
--- a/content/github/authenticating-to-github/signing-commits.md
+++ b/content/github/authenticating-to-github/signing-commits.md
@@ -1,6 +1,6 @@
---
title: Signing commits
-intro: 'You can sign commits locally using GPG{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.14" %} or S/MIME{% endif %}.'
+intro: You can sign commits locally using GPG or S/MIME.
redirect_from:
- /articles/signing-commits-and-tags-using-gpg/
- /articles/signing-commits-using-gpg/
@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.gpg.desktop-support-for-commit-signing %}
diff --git a/content/github/authenticating-to-github/signing-tags.md b/content/github/authenticating-to-github/signing-tags.md
index 33712c5877ca..79240214457f 100644
--- a/content/github/authenticating-to-github/signing-tags.md
+++ b/content/github/authenticating-to-github/signing-tags.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.gpg.desktop-support-for-commit-signing %}
diff --git a/content/github/authenticating-to-github/telling-git-about-your-signing-key.md b/content/github/authenticating-to-github/telling-git-about-your-signing-key.md
index 0c77fd081e33..70780cac456c 100644
--- a/content/github/authenticating-to-github/telling-git-about-your-signing-key.md
+++ b/content/github/authenticating-to-github/telling-git-about-your-signing-key.md
@@ -1,12 +1,13 @@
---
title: Telling Git about your signing key
-intro: 'To sign commits locally, you need to inform Git that there''s a GPG{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.14" %} or X.509{% endif %} key you''d like to use.'
+intro: "To sign commits locally, you need to inform Git that there's a GPG or X.509 key you'd like to use."
redirect_from:
- /articles/telling-git-about-your-gpg-key/
- /articles/telling-git-about-your-signing-key
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% mac %}
diff --git a/content/github/authenticating-to-github/testing-your-ssh-connection.md b/content/github/authenticating-to-github/testing-your-ssh-connection.md
index b70b2278b2af..12b3e26732f7 100644
--- a/content/github/authenticating-to-github/testing-your-ssh-connection.md
+++ b/content/github/authenticating-to-github/testing-your-ssh-connection.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Before testing your SSH connection, you should have:
@@ -24,14 +25,6 @@ When you test your connection, you'll need to authenticate this action using you
You may see a warning like this:
- ```shell
- > The authenticity of host '{% data variables.command_line.codeblock %} (IP ADDRESS)' can't be established.
- > RSA key fingerprint is 16:27:ac:a5:76:28:2d:36:63:1b:56:4d:eb:df:a6:48.
- > Are you sure you want to continue connecting (yes/no)?
- ```
-
- or like this:
-
```shell
> The authenticity of host '{% data variables.command_line.codeblock %} (IP ADDRESS)' can't be established.
> RSA key fingerprint is SHA256:nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8.
diff --git a/content/github/authenticating-to-github/troubleshooting-commit-signature-verification.md b/content/github/authenticating-to-github/troubleshooting-commit-signature-verification.md
index ed9cff02dd79..eaf728188e2b 100644
--- a/content/github/authenticating-to-github/troubleshooting-commit-signature-verification.md
+++ b/content/github/authenticating-to-github/troubleshooting-commit-signature-verification.md
@@ -8,5 +8,6 @@ mapTopic: true
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/authenticating-to-github/troubleshooting-ssh.md b/content/github/authenticating-to-github/troubleshooting-ssh.md
index 0d891260e135..6e0edc68220e 100644
--- a/content/github/authenticating-to-github/troubleshooting-ssh.md
+++ b/content/github/authenticating-to-github/troubleshooting-ssh.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/authenticating-to-github/updating-an-expired-gpg-key.md b/content/github/authenticating-to-github/updating-an-expired-gpg-key.md
index 0135468b41db..15a8a860a3c4 100644
--- a/content/github/authenticating-to-github/updating-an-expired-gpg-key.md
+++ b/content/github/authenticating-to-github/updating-an-expired-gpg-key.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
If your key is expired, you must [update the expiration](https://www.gnupg.org/gph/en/manual/c235.html#AEN328), export the new key, delete the expired key in your GitHub account, and [upload the new key to GitHub](/articles/adding-a-new-gpg-key-to-your-github-account/). Your previous commits and tags will show as verified, as long as the key meets all other verification requirements.
diff --git a/content/github/authenticating-to-github/updating-your-github-access-credentials.md b/content/github/authenticating-to-github/updating-your-github-access-credentials.md
index c24d87025e89..75214d3ae805 100644
--- a/content/github/authenticating-to-github/updating-your-github-access-credentials.md
+++ b/content/github/authenticating-to-github/updating-your-github-access-credentials.md
@@ -1,6 +1,6 @@
---
title: Updating your GitHub access credentials
-intro: '{% data variables.product.product_name %} credentials include not only your password, but also the access tokens, SSH keys, and application API tokens you use to communicate with {% data variables.product.product_name %}. Should you have the need, you can reset all of these access credentials yourself.'
+intro: '{% data variables.product.product_name %} credentials include{% if currentVersion != "github-ae@latest" %} not only your password, but also{% endif %} the access tokens, SSH keys, and application API tokens you use to communicate with {% data variables.product.product_name %}. Should you have the need, you can reset all of these access credentials yourself.'
redirect_from:
- /articles/rolling-your-credentials/
- /articles/how-can-i-reset-my-password/
@@ -8,8 +8,10 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
+{% if currentVersion != "github-ae@latest" %}
### Requesting a new password
1. To request a new password, visit {% if currentVersion == "free-pro-team@latest" %}https://{% data variables.product.product_url %}/password_reset{% else %}`https://{% data variables.product.product_url %}/password_reset`{% endif %}.
@@ -40,7 +42,7 @@ To avoid losing your password in the future, we suggest using a secure password
For greater security, enable two-factor authentication in addition to changing your password. See [About two-factor authentication](/articles/about-two-factor-authentication) for more details.
{% endtip %}
-
+{% endif %}
### Updating your access tokens
See "[Reviewing your authorized integrations](/articles/reviewing-your-authorized-integrations)" for instructions on reviewing and deleting access tokens. To generate new access tokens, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)."
@@ -53,6 +55,8 @@ See "[Reviewing your SSH keys](/articles/reviewing-your-ssh-keys)" for instructi
If you have any applications registered with {% data variables.product.product_name %}, you'll want to reset their OAuth tokens. For more information, see the "[Reset an authorization](/rest/reference/apps#reset-an-authorization)" endpoint.
+{% if currentVersion != "github-ae@latest" %}
### Preventing unauthorized access
For more tips on securing your account and preventing unauthorized access, see "[Preventing unauthorized access](/articles/preventing-unauthorized-access)."
+{% endif %}
diff --git a/content/github/authenticating-to-github/using-a-verified-email-address-in-your-gpg-key.md b/content/github/authenticating-to-github/using-a-verified-email-address-in-your-gpg-key.md
index bd27424d835c..e215b0d4b566 100644
--- a/content/github/authenticating-to-github/using-a-verified-email-address-in-your-gpg-key.md
+++ b/content/github/authenticating-to-github/using-a-verified-email-address-in-your-gpg-key.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% if currentVersion == "free-pro-team@latest" %}
diff --git a/content/github/authenticating-to-github/viewing-and-managing-your-active-saml-sessions.md b/content/github/authenticating-to-github/viewing-and-managing-your-active-saml-sessions.md
index 0d70a1eaad38..4b3d9b9288ef 100644
--- a/content/github/authenticating-to-github/viewing-and-managing-your-active-saml-sessions.md
+++ b/content/github/authenticating-to-github/viewing-and-managing-your-active-saml-sessions.md
@@ -24,4 +24,4 @@ versions:
### Further reading
-- "[About authentication with SAML SSO](/github/authenticating-to-github/about-authentication-with-saml-single-sign-on)"
+- "[About authentication with SAML SSO](/github/authenticating-to-github/about-authentication-with-saml-single-sign-on)"
\ No newline at end of file
diff --git a/content/github/authenticating-to-github/working-with-ssh-key-passphrases.md b/content/github/authenticating-to-github/working-with-ssh-key-passphrases.md
index cc3890009c75..899f0ce2b7e8 100644
--- a/content/github/authenticating-to-github/working-with-ssh-key-passphrases.md
+++ b/content/github/authenticating-to-github/working-with-ssh-key-passphrases.md
@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
With SSH keys, if someone gains access to your computer, they also gain access to every system that uses that key. To add an extra layer of security, you can add a passphrase to your SSH key. You can use `ssh-agent` to securely save your passphrase so you don't have to reenter it.
diff --git a/content/github/building-a-strong-community/about-issue-and-pull-request-templates.md b/content/github/building-a-strong-community/about-issue-and-pull-request-templates.md
index 72da39e4d2d7..c45a6e764fc6 100644
--- a/content/github/building-a-strong-community/about-issue-and-pull-request-templates.md
+++ b/content/github/building-a-strong-community/about-issue-and-pull-request-templates.md
@@ -6,11 +6,12 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
After you create issue and pull request templates in your repository, contributors can use the templates to open issues or describe the proposed changes in their pull requests according to the repository's contributing guidelines. For more information about adding contributing guidelines to a repository, see "[Setting guidelines for repository contributors](/articles/setting-guidelines-for-repository-contributors)."
-You can create default issue and pull request templates for your organization{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} or user account{% endif %}. For more information, see "[Creating a default community health file](/github/building-a-strong-community/creating-a-default-community-health-file)."
+You can create default issue and pull request templates for your organization{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %} or user account{% endif %}. For more information, see "[Creating a default community health file](/github/building-a-strong-community/creating-a-default-community-health-file)."
### Issue templates
@@ -20,7 +21,7 @@ When you create issue templates for your repository using the issue template bui
Using the template builder, you can specify a title and description for each template, add the template content, and either commit the template to the default branch or open a pull request in the repository. The template builder automatically adds the YAML front matter markup that is required for the template to show on the new issue page. For more information, see "[Configuring issue templates for your repository](/articles/configuring-issue-templates-for-your-repository)."
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
{% data reusables.repositories.issue-template-config %} For more information, see "[Configuring issue templates for your repository](/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser)."
{% endif %}
diff --git a/content/github/building-a-strong-community/about-team-discussions.md b/content/github/building-a-strong-community/about-team-discussions.md
index 5f0eb86e2937..6bf572b9e9ec 100644
--- a/content/github/building-a-strong-community/about-team-discussions.md
+++ b/content/github/building-a-strong-community/about-team-discussions.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.organizations.team-discussions-purpose %}
@@ -26,7 +27,7 @@ When someone posts or replies to a public discussion on a team's page, members o
{% tip %}
-**Tip:** Depending on your notification settings, you'll receive updates by email, the web notifications page on {% data variables.product.product_name %}, or both. For more information, see {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}"[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications){% else %}"[About email notifications](/github/receiving-notifications-about-activity-on-github/about-email-notifications)" and "[About web notifications](/github/receiving-notifications-about-activity-on-github/about-web-notifications){% endif %}."
+**Tip:** Depending on your notification settings, you'll receive updates by email, the web notifications page on {% data variables.product.product_name %}, or both. For more information, see {% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.20" %}"[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications){% else %}"[About email notifications](/github/receiving-notifications-about-activity-on-github/about-email-notifications)" and "[About web notifications](/github/receiving-notifications-about-activity-on-github/about-web-notifications){% endif %}."
{% endtip %}
@@ -34,7 +35,7 @@ By default, if your username is mentioned in a team discussion, you'll receive n
To turn off notifications for team discussions, you can unsubscribe to a specific discussion post or change your notification settings to unwatch or completely ignore a specific team's discussions. You can subscribe to notifications for a specific discussion post even if you're unwatching that team's discussions.
-For more information, see {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}"[Viewing your subscriptions](/github/managing-subscriptions-and-notifications-on-github/viewing-your-subscriptions){% else %}"[Subscribing to and unsubscribing from notifications](/github/receiving-notifications-about-activity-on-github/subscribing-to-and-unsubscribing-from-notifications){% endif %}" and "[Nested teams](/articles/about-teams/#nested-teams)."
+For more information, see {% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.20" %}"[Viewing your subscriptions](/github/managing-subscriptions-and-notifications-on-github/viewing-your-subscriptions){% else %}"[Subscribing to and unsubscribing from notifications](/github/receiving-notifications-about-activity-on-github/subscribing-to-and-unsubscribing-from-notifications){% endif %}" and "[Nested teams](/articles/about-teams/#nested-teams)."
### Further reading
diff --git a/content/github/building-a-strong-community/about-wikis.md b/content/github/building-a-strong-community/about-wikis.md
index e8b8c13d3565..a1dc3a268cc4 100644
--- a/content/github/building-a-strong-community/about-wikis.md
+++ b/content/github/building-a-strong-community/about-wikis.md
@@ -8,6 +8,7 @@ product: '{% data reusables.gated-features.wikis %}'
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Every {% data variables.product.product_name %} repository comes equipped with a section for hosting documentation, called a wiki. You can use your repository's wiki to share long-form content about your project, such as how to use it, how you designed it, or its core principles. A README file quickly tells what your project can do, while you can use a wiki to provide additional documentation. For more information, see "[About READMEs](/articles/about-readmes)."
diff --git a/content/github/building-a-strong-community/adding-a-license-to-a-repository.md b/content/github/building-a-strong-community/adding-a-license-to-a-repository.md
index 6c97f9063cc5..b9a2d6880caf 100644
--- a/content/github/building-a-strong-community/adding-a-license-to-a-repository.md
+++ b/content/github/building-a-strong-community/adding-a-license-to-a-repository.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
If you include a detectable license in your repository, people who visit your repository will see it at the top of the repository page. To read the entire license file, click the license name.
@@ -35,7 +36,7 @@ Open source licenses enable others to freely use, change, and distribute the pro
{% endif %}
-{% if currentVersion != "free-pro-team@latest" %}
+{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.files.add-file %}
diff --git a/content/github/building-a-strong-community/adding-or-editing-wiki-pages.md b/content/github/building-a-strong-community/adding-or-editing-wiki-pages.md
index 342f1a04b532..62ae60514647 100644
--- a/content/github/building-a-strong-community/adding-or-editing-wiki-pages.md
+++ b/content/github/building-a-strong-community/adding-or-editing-wiki-pages.md
@@ -11,6 +11,7 @@ product: '{% data reusables.gated-features.wikis %}'
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Adding wiki pages
diff --git a/content/github/building-a-strong-community/adding-support-resources-to-your-project.md b/content/github/building-a-strong-community/adding-support-resources-to-your-project.md
index ec53e761abe0..f927ec1c7c28 100644
--- a/content/github/building-a-strong-community/adding-support-resources-to-your-project.md
+++ b/content/github/building-a-strong-community/adding-support-resources-to-your-project.md
@@ -6,12 +6,13 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
To direct people to specific support resources, you can add a SUPPORT file to your repository's root, `docs`, or `.github` folder. When someone creates an issue in your repository, they will see a link to your project's SUPPORT file.
-You can create default support resources for your organization{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} or user account{% endif %}. For more information, see "[Creating a default community health file](/github/building-a-strong-community/creating-a-default-community-health-file)."
+You can create default support resources for your organization{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %} or user account{% endif %}. For more information, see "[Creating a default community health file](/github/building-a-strong-community/creating-a-default-community-health-file)."
{% tip %}
diff --git a/content/github/building-a-strong-community/blocking-a-user-from-your-personal-account.md b/content/github/building-a-strong-community/blocking-a-user-from-your-personal-account.md
index 6cdae5472924..5b35b38b9283 100644
--- a/content/github/building-a-strong-community/blocking-a-user-from-your-personal-account.md
+++ b/content/github/building-a-strong-community/blocking-a-user-from-your-personal-account.md
@@ -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
diff --git a/content/github/building-a-strong-community/changing-access-permissions-for-wikis.md b/content/github/building-a-strong-community/changing-access-permissions-for-wikis.md
index a6d5f9d90779..3cd1846dba09 100644
--- a/content/github/building-a-strong-community/changing-access-permissions-for-wikis.md
+++ b/content/github/building-a-strong-community/changing-access-permissions-for-wikis.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.repositories.navigate-to-repo %}
diff --git a/content/github/building-a-strong-community/collaborating-with-your-team.md b/content/github/building-a-strong-community/collaborating-with-your-team.md
index 1743381137e4..6e17a6cece58 100644
--- a/content/github/building-a-strong-community/collaborating-with-your-team.md
+++ b/content/github/building-a-strong-community/collaborating-with-your-team.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/building-a-strong-community/configuring-issue-templates-for-your-repository.md b/content/github/building-a-strong-community/configuring-issue-templates-for-your-repository.md
index 5c1163730c46..8aff6c8ab3ad 100644
--- a/content/github/building-a-strong-community/configuring-issue-templates-for-your-repository.md
+++ b/content/github/building-a-strong-community/configuring-issue-templates-for-your-repository.md
@@ -7,11 +7,12 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.repositories.default-issue-templates %}
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
### Creating issue templates
{% endif %}
@@ -35,7 +36,7 @@ versions:
11. Click **Commit changes**. Once these changes are merged into the default branch, the template will be available for contributors to use when they open new issues in the repository.
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
### Configuring the template chooser
{% data reusables.repositories.issue-template-config %}
diff --git a/content/github/building-a-strong-community/creating-a-default-community-health-file.md b/content/github/building-a-strong-community/creating-a-default-community-health-file.md
index bab64b27eba2..b73a1545dc2b 100644
--- a/content/github/building-a-strong-community/creating-a-default-community-health-file.md
+++ b/content/github/building-a-strong-community/creating-a-default-community-health-file.md
@@ -7,31 +7,32 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### About default community health files
-You can add default community health files to the root of a public repository called `.github` that is owned by an organization{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} or user account{% endif %}.
+You can add default community health files to the root of a public repository called `.github` that is owned by an organization{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %} or user account{% endif %}.
{% data variables.product.product_name %} will use and display default files for any public repository owned by the account that does not have its own file of that type in any of the following places:
- the root of the repository
- the `.github` folder
- the `docs` folder
-For example, anyone who creates an issue or pull request in a public repository that does not have its own CONTRIBUTING file will see a link to the default CONTRIBUTING file. If a repository has any files in its own `.github/ISSUE_TEMPLATE` folder{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}, including issue templates or a *config.yml* file,{% endif %} none of the contents of the default `.github/ISSUE_TEMPLATE` folder will be used.
+For example, anyone who creates an issue or pull request in a public repository that does not have its own CONTRIBUTING file will see a link to the default CONTRIBUTING file. If a repository has any files in its own `.github/ISSUE_TEMPLATE` folder{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}, including issue templates or a *config.yml* file,{% endif %} none of the contents of the default `.github/ISSUE_TEMPLATE` folder will be used.
Default files are not included in clones, packages, or downloads of individual repositories because they are stored only in the `.github` repository.
### Supported file types
-You can create defaults in your organization{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} or user account{% endif %} for the following community health files:
+You can create defaults in your organization{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %} or user account{% endif %} for the following community health files:
Community health file | Description
--- | ---{% if currentVersion == "free-pro-team@latest" %}
*CODE_OF_CONDUCT.md* | A CODE_OF_CONDUCT file defines standards for how to engage in a community. For more information, see "[Adding a code of conduct to your project](/articles/adding-a-code-of-conduct-to-your-project/)."{% endif %}
*CONTRIBUTING.md* | A CONTRIBUTING file communicates how people should contribute to your project. For more information, see "[Setting guidelines for repository contributors](/articles/setting-guidelines-for-repository-contributors/)."{% if currentVersion == "free-pro-team@latest" %}
*FUNDING.yml* | A FUNDING file displays a sponsor button in your repository to increase the visibility of funding options for your open source project. For more information, see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)."{% endif %}
-Issue and pull request templates{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} and *config.yml*{% endif %} | Issue and pull request templates customize and standardize the information you'd like contributors to include when they open issues and pull requests in your repository. For more information, see "[About issue and pull request templates](/articles/about-issue-and-pull-request-templates/)."{% if currentVersion == "free-pro-team@latest" %}
+Issue and pull request templates{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %} and *config.yml*{% endif %} | Issue and pull request templates customize and standardize the information you'd like contributors to include when they open issues and pull requests in your repository. For more information, see "[About issue and pull request templates](/articles/about-issue-and-pull-request-templates/)."{% if currentVersion == "free-pro-team@latest" %}
*SECURITY.md* | A SECURITY file gives instructions for how to responsibly report a security vulnerability in your project. For more information, see "[Adding a security policy to your repository](/articles/adding-a-security-policy-to-your-repository)."{% endif %}
*SUPPORT.md* | A SUPPORT file lets people know about ways to get help with your project. For more information, see "[Adding support resources to your project](/articles/adding-support-resources-to-your-project/)."
@@ -40,7 +41,7 @@ You cannot create a default license file. License files must be added to individ
### Creating a repository for default files
{% data reusables.repositories.create_new %}
-2. Use the **Owner** drop-down menu, and select the organization{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} or user account{% endif %} you want to create default files for.
+2. Use the **Owner** drop-down menu, and select the organization{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %} or user account{% endif %} you want to create default files for.
3. Type **.github** as the name for your repository, and an optional description.
@@ -48,4 +49,4 @@ You cannot create a default license file. License files must be added to individ
{% data reusables.repositories.initialize-with-readme %}
{% data reusables.repositories.create-repo %}
-7. In the repository, create one of the supported community health files. Issue templates{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} and their configuration file{% endif %} must be in a folder called `.github/ISSUE_TEMPLATE`. All other supported files must be in the root of the repository. For more information, see "[Creating new files](/articles/creating-new-files/)."
+7. In the repository, create one of the supported community health files. Issue templates{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %} and their configuration file{% endif %} must be in a folder called `.github/ISSUE_TEMPLATE`. All other supported files must be in the root of the repository. For more information, see "[Creating new files](/articles/creating-new-files/)."
diff --git a/content/github/building-a-strong-community/creating-a-footer-or-sidebar-for-your-wiki.md b/content/github/building-a-strong-community/creating-a-footer-or-sidebar-for-your-wiki.md
index 8c9cabb20698..5e725a84aa9e 100644
--- a/content/github/building-a-strong-community/creating-a-footer-or-sidebar-for-your-wiki.md
+++ b/content/github/building-a-strong-community/creating-a-footer-or-sidebar-for-your-wiki.md
@@ -9,6 +9,7 @@ product: '{% data reusables.gated-features.wikis %}'
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Creating a footer
diff --git a/content/github/building-a-strong-community/creating-a-pull-request-template-for-your-repository.md b/content/github/building-a-strong-community/creating-a-pull-request-template-for-your-repository.md
index df8b539e61fe..76ed5c1e4446 100644
--- a/content/github/building-a-strong-community/creating-a-pull-request-template-for-your-repository.md
+++ b/content/github/building-a-strong-community/creating-a-pull-request-template-for-your-repository.md
@@ -6,13 +6,14 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
For more information, see "[About issue and pull request templates](/articles/about-issue-and-pull-request-templates)."
You can create a *PULL_REQUEST_TEMPLATE/* subdirectory in any of the supported folders to contain multiple pull request templates, and use the `template` query parameter to specify the template that will fill the pull request body. For more information, see "[About automation for issues and pull requests with query parameters](/articles/about-automation-for-issues-and-pull-requests-with-query-parameters)."
-You can create default pull request templates for your organization{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} or user account{% endif %}. For more information, see "[Creating a default community health file](/github/building-a-strong-community/creating-a-default-community-health-file)."
+You can create default pull request templates for your organization{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %} or user account{% endif %}. For more information, see "[Creating a default community health file](/github/building-a-strong-community/creating-a-default-community-health-file)."
### Adding a pull request template
diff --git a/content/github/building-a-strong-community/creating-a-team-discussion.md b/content/github/building-a-strong-community/creating-a-team-discussion.md
index a02801475ad6..0481b6502b14 100644
--- a/content/github/building-a-strong-community/creating-a-team-discussion.md
+++ b/content/github/building-a-strong-community/creating-a-team-discussion.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.organizations.team-discussions-permissions %} For more information, see "[About team discussions](/articles/about-team-discussions)."
diff --git a/content/github/building-a-strong-community/disabling-wikis.md b/content/github/building-a-strong-community/disabling-wikis.md
index 11af2834a4a7..1dc9587157ea 100644
--- a/content/github/building-a-strong-community/disabling-wikis.md
+++ b/content/github/building-a-strong-community/disabling-wikis.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
When you turn off a wiki, the content is hidden, but not erased. If you choose to re-enable wikis later, your previous pages will be restored.
diff --git a/content/github/building-a-strong-community/documenting-your-project-with-wikis.md b/content/github/building-a-strong-community/documenting-your-project-with-wikis.md
index 10a95a72dfa6..db5793db24a8 100644
--- a/content/github/building-a-strong-community/documenting-your-project-with-wikis.md
+++ b/content/github/building-a-strong-community/documenting-your-project-with-wikis.md
@@ -10,5 +10,6 @@ mapTopic: true
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/building-a-strong-community/editing-or-deleting-a-team-discussion.md b/content/github/building-a-strong-community/editing-or-deleting-a-team-discussion.md
index e01537057f36..ba567880e8f5 100644
--- a/content/github/building-a-strong-community/editing-or-deleting-a-team-discussion.md
+++ b/content/github/building-a-strong-community/editing-or-deleting-a-team-discussion.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.profile.access_profile %}
diff --git a/content/github/building-a-strong-community/editing-wiki-content.md b/content/github/building-a-strong-community/editing-wiki-content.md
index 7cd671d5e313..d592597dd6bf 100644
--- a/content/github/building-a-strong-community/editing-wiki-content.md
+++ b/content/github/building-a-strong-community/editing-wiki-content.md
@@ -14,6 +14,7 @@ product: '{% data reusables.gated-features.wikis %}'
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Adding links
diff --git a/content/github/building-a-strong-community/index.md b/content/github/building-a-strong-community/index.md
index b148e86f2f33..854d6d0950e9 100644
--- a/content/github/building-a-strong-community/index.md
+++ b/content/github/building-a-strong-community/index.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
@@ -36,6 +37,7 @@ versions:
{% link_in_list /managing-disruptive-comments %}
{% link_in_list /locking-conversations %}
{% link_in_list /limiting-interactions-in-your-repository %}
+ {% link_in_list /limiting-interactions-for-your-user-account %}
{% link_in_list /limiting-interactions-in-your-organization %}
{% link_in_list /tracking-changes-in-a-comment %}
{% link_in_list /managing-how-contributors-report-abuse-in-your-organizations-repository %}
diff --git a/content/github/building-a-strong-community/limiting-interactions-for-your-user-account.md b/content/github/building-a-strong-community/limiting-interactions-for-your-user-account.md
new file mode 100644
index 000000000000..6c01ed2e084a
--- /dev/null
+++ b/content/github/building-a-strong-community/limiting-interactions-for-your-user-account.md
@@ -0,0 +1,27 @@
+---
+title: Limiting interactions for your user account
+intro: 'You can temporarily enforce a period of limited activity for certain users in all public repositories owned by your user account.'
+versions:
+ free-pro-team: '*'
+permissions: Anyone can limit interactions for their own user account.
+---
+
+### About temporary interaction limits
+
+Limiting interactions for your user account enables temporary interaction limits for all public repositories owned by your user account. {% data reusables.community.interaction-limits-restrictions %}
+
+{% data reusables.community.interaction-limits-duration %} After the duration of your limit passes, users can resume normal activity in your public repositories.
+
+{% data reusables.community.types-of-interaction-limits %}
+
+When you enable user-wide activity limitations, you can't enable or disable interaction limits on individual repositories. For more information on limiting activity for an individual repository, see "[Limiting interactions in your repository](/articles/limiting-interactions-in-your-repository)."
+
+You can also block users. For more information, see "[Blocking a user from your personal account](/github/building-a-strong-community/blocking-a-user-from-your-personal-account)."
+
+### Limiting interactions for your user account
+
+{% data reusables.user_settings.access_settings %}
+1. In your user settings sidebar, under "Moderation settings", click **Interaction limits**.
+ 
+{% data reusables.community.set-interaction-limit %}
+ 
\ No newline at end of file
diff --git a/content/github/building-a-strong-community/limiting-interactions-in-your-organization.md b/content/github/building-a-strong-community/limiting-interactions-in-your-organization.md
index f820de44a599..8c96c2630243 100644
--- a/content/github/building-a-strong-community/limiting-interactions-in-your-organization.md
+++ b/content/github/building-a-strong-community/limiting-interactions-in-your-organization.md
@@ -1,31 +1,39 @@
---
title: Limiting interactions in your organization
-intro: 'Organization owners can temporarily restrict certain users from commenting, opening issues, or creating pull requests in the organization''s public repositories to enforce a period of limited activity.'
+intro: 'You can temporarily enforce a period of limited activity for certain users in all public repositories owned by your organization.'
redirect_from:
- /github/setting-up-and-managing-organizations-and-teams/limiting-interactions-in-your-organization
- /articles/limiting-interactions-in-your-organization
versions:
free-pro-team: '*'
+permissions: Organization owners can limit interactions in an organization.
---
-After 24 hours, users can resume normal activity in your organization's public repositories. When you enable organization-wide activity limitations, you can't enable or disable interaction limits on individual repositories. For more information on per-repository activity limitation, see "[Limiting interactions in your repository](/articles/limiting-interactions-in-your-repository)."
+### About temporary interaction limits
-{% tip %}
+Limiting interactions in your organization enables temporary interaction limits for all public repositories owned by the organization. {% data reusables.community.interaction-limits-restrictions %}
-**Tip:** Organization owners can also block users for a specific amount of time. After the block expires, the user is automatically unblocked. For more information, see "[Blocking a user from your organization](/articles/blocking-a-user-from-your-organization)."
+{% data reusables.community.interaction-limits-duration %} After the duration of your limit passes, users can resume normal activity in your organization's public repositories.
-{% endtip %}
+{% data reusables.community.types-of-interaction-limits %}
+
+Members of the organization are not affected by any of the limit types.
+
+When you enable organization-wide activity limitations, you can't enable or disable interaction limits on individual repositories. For more information on limiting activity for an individual repository, see "[Limiting interactions in your repository](/articles/limiting-interactions-in-your-repository)."
+
+Organization owners can also block users for a specific amount of time. After the block expires, the user is automatically unblocked. For more information, see "[Blocking a user from your organization](/articles/blocking-a-user-from-your-organization)."
+
+### Limiting interactions in your organization
{% data reusables.profile.access_profile %}
{% data reusables.profile.access_org %}
{% data reusables.organizations.org_settings %}
-4. In your organization's Settings sidebar, click **Interaction limits**.
-
-5. Under "Temporary interaction limits", click one or more options.
+1. In the organization settings sidebar, click **Moderation settings**.
+ 
+1. Under "Moderation settings", click **Interaction limits**.
+ 
+{% data reusables.community.set-interaction-limit %}
- - **Limit to existing users**: Limits activity for organization users with accounts that are less than 24 hours old who do not have prior contributions and are not collaborators.
- - **Limit to prior contributors**: Limits activity for organization users who have not previously contributed and are not collaborators.
- - **Limit to repository collaborators**: Limits activity for organization users who do not have write access or are not collaborators.
### Further reading
- "[Reporting abuse or spam](/articles/reporting-abuse-or-spam)"
diff --git a/content/github/building-a-strong-community/limiting-interactions-in-your-repository.md b/content/github/building-a-strong-community/limiting-interactions-in-your-repository.md
index de9ccb7c28ac..da85594b43ba 100644
--- a/content/github/building-a-strong-community/limiting-interactions-in-your-repository.md
+++ b/content/github/building-a-strong-community/limiting-interactions-in-your-repository.md
@@ -1,30 +1,34 @@
---
title: Limiting interactions in your repository
-intro: 'People with owner or admin access can temporarily restrict certain users from commenting, opening issues, or creating pull requests in your public repository to enforce a period of limited activity.'
+intro: 'You can temporarily enforce a period of limited activity for certain users on a public repository.'
redirect_from:
- /articles/limiting-interactions-with-your-repository/
- /articles/limiting-interactions-in-your-repository
versions:
free-pro-team: '*'
+permissions: People with admin permissions to a repository can temporarily limit interactions in that repository.
---
-After 24 hours, users can resume normal activity in your repository.
+### About temporary interaction limits
-{% tip %}
+{% data reusables.community.interaction-limits-restrictions %}
-**Tip:** Organization owners can enable organization-wide activity limitations. If organization-wide activity limitations are enabled, you can't limit activity for individual repositories. For more information, see "[Limiting interactions in your organization](/articles/limiting-interactions-in-your-organization)."
+{% data reusables.community.interaction-limits-duration %} After the duration of your limit passes, users can resume normal activity in your repository.
-{% endtip %}
+{% data reusables.community.types-of-interaction-limits %}
+
+You can also enable activity limitations on all repositories owned by your user account or an organization. If a user-wide or organization-wide limit is enabled, you can't limit activity for individual repositories owned by the account. For more information, see "[Limiting interactions for your user account](/github/building-a-strong-community/limiting-interactions-for-your-user-account)" and "[Limiting interactions in your organization](/github/building-a-strong-community/limiting-interactions-in-your-organization)."
+
+### Limiting interactions in your repository
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-settings %}
-3. In your repository's Settings sidebar, click **Interaction limits**.
-
-4. Under "Temporary interaction limits", click one or more options:
+1. In the left sidebar, click **Moderation settings**.
+ 
+1. Under "Moderation settings", click **Interaction limits**.
+ 
+{% data reusables.community.set-interaction-limit %}
- - **Limit to existing users**: Limits activity for users with accounts that are less than 24 hours old who do not have prior contributions and are not collaborators.
- - **Limit to prior contributors**: Limits activity for users who have not previously contributed and are not collaborators.
- - **Limit to repository collaborators**: Limits activity for users who do not have write access or are not collaborators.
### Further reading
- "[Reporting abuse or spam](/articles/reporting-abuse-or-spam)"
diff --git a/content/github/building-a-strong-community/locking-conversations.md b/content/github/building-a-strong-community/locking-conversations.md
index 5e86b60383ee..382b02f7d6f7 100644
--- a/content/github/building-a-strong-community/locking-conversations.md
+++ b/content/github/building-a-strong-community/locking-conversations.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
It's appropriate to lock a conversation when the entire conversation is not constructive or violates your community's code of conduct{% if currentVersion == "free-pro-team@latest" %} or GitHub's [Community Guidelines](/articles/github-community-guidelines){% endif %}. When you lock a conversation, you can also specify a reason, which is publicly visible.
diff --git a/content/github/building-a-strong-community/managing-disruptive-comments.md b/content/github/building-a-strong-community/managing-disruptive-comments.md
index 809825ccfb66..16acb1360ccb 100644
--- a/content/github/building-a-strong-community/managing-disruptive-comments.md
+++ b/content/github/building-a-strong-community/managing-disruptive-comments.md
@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Hiding a comment
diff --git a/content/github/building-a-strong-community/manually-creating-a-single-issue-template-for-your-repository.md b/content/github/building-a-strong-community/manually-creating-a-single-issue-template-for-your-repository.md
index 45248cb09ab4..11a2016dcc50 100644
--- a/content/github/building-a-strong-community/manually-creating-a-single-issue-template-for-your-repository.md
+++ b/content/github/building-a-strong-community/manually-creating-a-single-issue-template-for-your-repository.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.repositories.legacy-issue-template-tip %}
@@ -28,7 +29,7 @@ assignees: octocat
```
{% note %}
-**Note:** You must put YAML-reserved characters such as `:` in quotes. For example, `":bug: Bug"`.
+**Note:** If a front matter value includes a YAML-reserved character such as `:` , you must put the whole value in quotes. For example, `":bug: Bug"` or `":new: triage needed, :bug: bug"`.
{% endnote %}
diff --git a/content/github/building-a-strong-community/moderating-comments-and-conversations.md b/content/github/building-a-strong-community/moderating-comments-and-conversations.md
index c3baa99c569a..6b02dc83f3b8 100644
--- a/content/github/building-a-strong-community/moderating-comments-and-conversations.md
+++ b/content/github/building-a-strong-community/moderating-comments-and-conversations.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/building-a-strong-community/pinning-a-team-discussion.md b/content/github/building-a-strong-community/pinning-a-team-discussion.md
index f2c944fd89e5..77726b13994a 100644
--- a/content/github/building-a-strong-community/pinning-a-team-discussion.md
+++ b/content/github/building-a-strong-community/pinning-a-team-discussion.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.profile.access_profile %}
diff --git a/content/github/building-a-strong-community/setting-guidelines-for-repository-contributors.md b/content/github/building-a-strong-community/setting-guidelines-for-repository-contributors.md
index e9437a2ba134..9b6bb2be0980 100644
--- a/content/github/building-a-strong-community/setting-guidelines-for-repository-contributors.md
+++ b/content/github/building-a-strong-community/setting-guidelines-for-repository-contributors.md
@@ -7,6 +7,7 @@ intro: You can create guidelines to communicate how people should contribute to
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
To help your project contributors do good work, you can add a file with contribution guidelines to your project repository's root, `docs`, or `.github` folder. When someone opens a pull request or creates an issue, they will see a link to that file.
@@ -19,7 +20,7 @@ For contributors, the guidelines help them verify that they're submitting well-f
For both owners and contributors, contribution guidelines save time and hassle caused by improperly created pull requests or issues that have to be rejected and re-submitted.
-You can create default contribution guidelines for your organization{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} or user account{% endif %}. For more information, see "[Creating a default community health file](/github/building-a-strong-community/creating-a-default-community-health-file)."
+You can create default contribution guidelines for your organization{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %} or user account{% endif %}. For more information, see "[Creating a default community health file](/github/building-a-strong-community/creating-a-default-community-health-file)."
{% tip %}
diff --git a/content/github/building-a-strong-community/setting-up-your-project-for-healthy-contributions.md b/content/github/building-a-strong-community/setting-up-your-project-for-healthy-contributions.md
index d8dc115b1c1c..4779c2e8c9f6 100644
--- a/content/github/building-a-strong-community/setting-up-your-project-for-healthy-contributions.md
+++ b/content/github/building-a-strong-community/setting-up-your-project-for-healthy-contributions.md
@@ -8,5 +8,6 @@ mapTopic: true
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/building-a-strong-community/tracking-changes-in-a-comment.md b/content/github/building-a-strong-community/tracking-changes-in-a-comment.md
index 90e74ff0479d..0af05d43554d 100644
--- a/content/github/building-a-strong-community/tracking-changes-in-a-comment.md
+++ b/content/github/building-a-strong-community/tracking-changes-in-a-comment.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Viewing a comment's edit history details
diff --git a/content/github/building-a-strong-community/unblocking-a-user-from-your-personal-account.md b/content/github/building-a-strong-community/unblocking-a-user-from-your-personal-account.md
index 7d608ee27203..f62dd1c2acbb 100644
--- a/content/github/building-a-strong-community/unblocking-a-user-from-your-personal-account.md
+++ b/content/github/building-a-strong-community/unblocking-a-user-from-your-personal-account.md
@@ -23,7 +23,7 @@ You can unblock a user in your account settings or from the user's profile page.
### Unblocking a user from their profile page
{% data reusables.profile.user_profile_page_navigation %}
-2. In the left sidebar, under the user's profile picture, click **Unblock or report user**.
+2. In the left sidebar, under the user's profile picture, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}, then click **Unblock or report user**.
3. Click **Unblock user**.
diff --git a/content/github/building-a-strong-community/using-templates-to-encourage-useful-issues-and-pull-requests.md b/content/github/building-a-strong-community/using-templates-to-encourage-useful-issues-and-pull-requests.md
index 2463d8891ffb..3435c8fa32ac 100644
--- a/content/github/building-a-strong-community/using-templates-to-encourage-useful-issues-and-pull-requests.md
+++ b/content/github/building-a-strong-community/using-templates-to-encourage-useful-issues-and-pull-requests.md
@@ -9,5 +9,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/building-a-strong-community/viewing-a-wikis-history-of-changes.md b/content/github/building-a-strong-community/viewing-a-wikis-history-of-changes.md
index e99d199b47c9..caaad4013d08 100644
--- a/content/github/building-a-strong-community/viewing-a-wikis-history-of-changes.md
+++ b/content/github/building-a-strong-community/viewing-a-wikis-history-of-changes.md
@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Viewing wiki history
diff --git a/content/github/collaborating-with-issues-and-pull-requests/about-branches.md b/content/github/collaborating-with-issues-and-pull-requests/about-branches.md
index d1db7475299b..82f62108562d 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/about-branches.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/about-branches.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
@@ -24,11 +25,11 @@ You must have write access to a repository to create a branch, open a pull reque
{% data reusables.branches.new-repo-default-branch %} The default branch is the branch that {% data variables.product.prodname_dotcom %} displays when anyone visits your repository. The default branch is also the initial branch that Git checks out locally out when someone clones the repository. {% data reusables.branches.default-branch-automatically-base-branch %}
-By default, {% data variables.product.product_name %} names the default branch {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.23" %}`main`{% else %}`master`{% endif %} in any new repository.
+By default, {% data variables.product.product_name %} names the default branch {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}`main`{% else %}`master`{% endif %} in any new repository.
{% data reusables.branches.change-default-branch %}
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}
{% data reusables.branches.set-default-branch %}
@@ -40,7 +41,7 @@ Once you're satisfied with your work, you can open a pull request to merge the c
After a pull request has been merged, or closed, you can delete the head branch as this is no longer needed. You must have write access in the repository to delete branches. You can't delete branches that are directly associated with open pull requests. For more information, see "[Deleting and restoring branches in a pull request](/github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request)"
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
{% data reusables.pull_requests.retargeted-on-branch-deletion %}
The following diagrams illustrate this.
@@ -73,7 +74,7 @@ When a branch is protected:
- If required status checks are enabled on the branch, you won't be able to merge changes into the branch until all of the required CI tests pass. For more information, see "[About status checks](/articles/about-status-checks)."
- If required pull request reviews are enabled on the branch, you won't be able to merge changes into the branch until all requirements in the pull request review policy have been met. For more information, see "[Merging a pull request](/articles/merging-a-pull-request)."
- If required review from a code owner is enabled on a branch, and a pull request modifies code that has an owner, a code owner must approve the pull request before it can be merged. For more information, see "[About code owners](/articles/about-code-owners)."
-- If required commit signing is enabled on a branch, you won't be able to push any commits to the branch that are not signed and verified. For more information, see "[About commit signature verification](/articles/about-commit-signature-verification)" and "[About required commit signing](/articles/about-required-commit-signing)."{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
+- If required commit signing is enabled on a branch, you won't be able to push any commits to the branch that are not signed and verified. For more information, see "[About commit signature verification](/articles/about-commit-signature-verification)" and "[About required commit signing](/articles/about-required-commit-signing)."{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
- If you use {% data variables.product.prodname_dotcom %} 's conflict editor to fix conflicts for a pull request that you created from a protected branch, {% data variables.product.prodname_dotcom %} helps you to create an alternative branch for the pull request, so that your resolution of the conflicts can be merged. For more information, see "[Resolving a merge conflict on {% data variables.product.prodname_dotcom %}](/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-on-github)."{% endif %}
### Further reading
diff --git a/content/github/collaborating-with-issues-and-pull-requests/about-collaborative-development-models.md b/content/github/collaborating-with-issues-and-pull-requests/about-collaborative-development-models.md
index 34f8582714bf..732530448233 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/about-collaborative-development-models.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/about-collaborative-development-models.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
There are two main types of development models with which you'd use pull requests. In the *fork and pull model*, anyone can fork an existing repository and push changes to their personal fork. You do not need permission to the source repository to push to a user-owned fork. The changes can be pulled into the source repository by the project maintainer. When you open a pull request proposing changes from your user-owned fork to a branch in the source (upstream) repository, you can allow anyone with push access to the upstream repository to make changes to your pull request. This model is popular with open source projects as it reduces the amount of friction for new contributors and allows people to work independently without upfront coordination.
diff --git a/content/github/collaborating-with-issues-and-pull-requests/about-comparing-branches-in-pull-requests.md b/content/github/collaborating-with-issues-and-pull-requests/about-comparing-branches-in-pull-requests.md
index c66689d29b11..0627d850b09a 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/about-comparing-branches-in-pull-requests.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/about-comparing-branches-in-pull-requests.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% note %}
diff --git a/content/github/collaborating-with-issues-and-pull-requests/about-conversations-on-github.md b/content/github/collaborating-with-issues-and-pull-requests/about-conversations-on-github.md
index b46797d67b25..8e21b6d214cf 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/about-conversations-on-github.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/about-conversations-on-github.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Discussions on {% data variables.product.product_name %}
@@ -19,7 +20,7 @@ Issues are useful for discussing specific details of a project such as bug repor
### Reacting to ideas in comments
-You can show your support or dissent for an idea in a conversation. When you add a reaction to a comment or the body of a team discussion, issue, or pull request, people subscribed to the conversation won't receive a notification. For more information about subscriptions, see {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}"[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications){% else %}"[Subscribing to and unsubscribing from notifications](/github/receiving-notifications-about-activity-on-github/subscribing-to-and-unsubscribing-from-notifications){% endif %}."
+You can show your support or dissent for an idea in a conversation. When you add a reaction to a comment or the body of a team discussion, issue, or pull request, people subscribed to the conversation won't receive a notification. For more information about subscriptions, see {% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.20" %}"[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications){% else %}"[Subscribing to and unsubscribing from notifications](/github/receiving-notifications-about-activity-on-github/subscribing-to-and-unsubscribing-from-notifications){% endif %}."
diff --git a/content/github/collaborating-with-issues-and-pull-requests/about-forks.md b/content/github/collaborating-with-issues-and-pull-requests/about-forks.md
index 81a8981bbed0..c7acbb201e03 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/about-forks.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/about-forks.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Forking a repository is similar to copying a repository, with two major differences:
diff --git a/content/github/collaborating-with-issues-and-pull-requests/about-merge-conflicts.md b/content/github/collaborating-with-issues-and-pull-requests/about-merge-conflicts.md
index d35d7142016e..8e10ed8b964c 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/about-merge-conflicts.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/about-merge-conflicts.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Git can often resolve differences between branches and merge them automatically. Usually, the changes are on different lines, or even in different files, which makes the merge simple for computers to understand. However, sometimes there are competing changes that Git can't resolve without your help. Often, merge conflicts happen when people make different changes to the same line of the same file, or when one person edits a file and another person deletes the same file.
diff --git a/content/github/collaborating-with-issues-and-pull-requests/about-pull-request-merges.md b/content/github/collaborating-with-issues-and-pull-requests/about-pull-request-merges.md
index 5208e81726e1..140097bc99b6 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/about-pull-request-merges.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/about-pull-request-merges.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.pull_requests.default_merge_option %}
diff --git a/content/github/collaborating-with-issues-and-pull-requests/about-pull-request-reviews.md b/content/github/collaborating-with-issues-and-pull-requests/about-pull-request-reviews.md
index 426a98eba6cc..fd7f06c5b619 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/about-pull-request-reviews.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/about-pull-request-reviews.md
@@ -6,13 +6,14 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### About pull request reviews
After a pull request is opened, anyone with *read* access can review and comment on the changes it proposes. You can also suggest specific changes to lines of code, which the author can apply directly from the pull request. For more information, see "[Reviewing proposed changes in a pull request](/articles/reviewing-proposed-changes-in-a-pull-request)."
-Repository owners and collaborators can request a pull request review from a specific person. Organization members can also request a pull request review from a team with read access to the repository. For more information, see "[Requesting a pull request review](/articles/requesting-a-pull-request-review)." {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}You can specify a subset of team members to be automatically assigned in the place of the whole team. For more information, see "[Managing code review assignment for your team](/github/setting-up-and-managing-organizations-and-teams/managing-code-review-assignment-for-your-team)."{% endif %}
+Repository owners and collaborators can request a pull request review from a specific person. Organization members can also request a pull request review from a team with read access to the repository. For more information, see "[Requesting a pull request review](/articles/requesting-a-pull-request-review)." {% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}You can specify a subset of team members to be automatically assigned in the place of the whole team. For more information, see "[Managing code review assignment for your team](/github/setting-up-and-managing-organizations-and-teams/managing-code-review-assignment-for-your-team)."{% endif %}
Reviews allow for discussion of proposed changes and help ensure that the changes meet the repository's contributing guidelines and other quality standards. You can define which individuals or teams own certain types or areas of code in a CODEOWNERS file. When a pull request modifies code that has a defined owner, that individual or team will automatically be requested as a reviewer. For more information, see "[About code owners](/articles/about-code-owners/)."
@@ -37,6 +38,10 @@ You can view all of the reviews a pull request has received in the Conversation
{% data reusables.pull_requests.resolving-conversations %}
+### Re-requesting a review
+
+{% data reusables.pull_requests.re-request-review %}
+
### Required reviews
{% data reusables.pull_requests.required-reviews-for-prs-summary %}
diff --git a/content/github/collaborating-with-issues-and-pull-requests/about-pull-requests.md b/content/github/collaborating-with-issues-and-pull-requests/about-pull-requests.md
index 0345e2af7d9e..ffba2f58cfda 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/about-pull-requests.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/about-pull-requests.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### About pull requests
diff --git a/content/github/collaborating-with-issues-and-pull-requests/about-status-checks.md b/content/github/collaborating-with-issues-and-pull-requests/about-status-checks.md
index dacac35e51df..7acf9caa1041 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/about-status-checks.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/about-status-checks.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Status checks are based on external processes, such as continuous integration builds, which run for each push you make to a repository. You can see the *pending*, *passing*, or *failing* state of status checks next to individual commits in your pull request.
diff --git a/content/github/collaborating-with-issues-and-pull-requests/addressing-merge-conflicts.md b/content/github/collaborating-with-issues-and-pull-requests/addressing-merge-conflicts.md
index 4796d0c19943..496b92edd073 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/addressing-merge-conflicts.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/addressing-merge-conflicts.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork.md b/content/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork.md
index 027319e06f19..e84de9cf65e9 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork.md
@@ -7,6 +7,7 @@ permissions: People with push access to the upstream repository of a fork owned
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Only pull request authors can give upstream repository maintainers, or those with push access to the upstream repository, permission to make commits to their pull request's compare branch in a user-owned fork. To learn more about upstream repositories, see "[About forks](/articles/about-forks)."
diff --git a/content/github/collaborating-with-issues-and-pull-requests/approving-a-pull-request-with-required-reviews.md b/content/github/collaborating-with-issues-and-pull-requests/approving-a-pull-request-with-required-reviews.md
index ec0f2b6c1d49..66fd1846e460 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/approving-a-pull-request-with-required-reviews.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/approving-a-pull-request-with-required-reviews.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
For more information about required reviews, see "[About required reviews for pull requests](/articles/about-required-reviews-for-pull-requests)."
diff --git a/content/github/collaborating-with-issues-and-pull-requests/changing-the-base-branch-of-a-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/changing-the-base-branch-of-a-pull-request.md
index 49a6a3706c7a..2e5cf86f52c8 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/changing-the-base-branch-of-a-pull-request.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/changing-the-base-branch-of-a-pull-request.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% warning %}
@@ -20,6 +21,12 @@ versions:
4. In the base branch drop-down menu, select the base branch you'd like to [compare changes against](/github/committing-changes-to-your-project/comparing-commits#comparing-branches). 
5. Read the information about changing the base branch and click **Change base**. 
+{% tip %}
+
+**Tip:** When you open a pull request, {% data variables.product.product_name %} will set the base to the commit that branch references. If the branch is updated in the future, {% data variables.product.product_name %} will not update the base branch's commit.
+
+{% endtip %}
+
### Further reading
- "[Creating a pull request](/articles/creating-a-pull-request)"
diff --git a/content/github/collaborating-with-issues-and-pull-requests/changing-the-stage-of-a-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/changing-the-stage-of-a-pull-request.md
index 4d3707edab93..c8c46903c489 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/changing-the-stage-of-a-pull-request.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/changing-the-stage-of-a-pull-request.md
@@ -1,6 +1,6 @@
---
title: Changing the stage of a pull request
-intro: 'You can mark a draft pull request as ready for review{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %} or convert a pull request to a draft{% endif %}.'
+intro: 'You can mark a draft pull request as ready for review{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.20" %} or convert a pull request to a draft{% endif %}.'
permissions: People with write permissions to a repository and pull request authors can change the stage of a pull request.
product: '{% data reusables.gated-features.draft-prs %}'
redirect_from:
@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Marking a pull request as ready for review
@@ -19,7 +20,7 @@ versions:
3. In the merge box, click **Ready for review**.
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
### Converting a pull request to a draft
diff --git a/content/github/collaborating-with-issues-and-pull-requests/checking-out-pull-requests-locally.md b/content/github/collaborating-with-issues-and-pull-requests/checking-out-pull-requests-locally.md
index 5a17c2db0091..4ed1a97a601a 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/checking-out-pull-requests-locally.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/checking-out-pull-requests-locally.md
@@ -7,6 +7,7 @@ permissions: Anyone with write access to a repository can pull a remote pull req
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% note %}
diff --git a/content/github/collaborating-with-issues-and-pull-requests/closing-a-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/closing-a-pull-request.md
index 070612bd21c3..a6acb76c97dd 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/closing-a-pull-request.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/closing-a-pull-request.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% tip %}
diff --git a/content/github/collaborating-with-issues-and-pull-requests/collaborating-on-repositories-with-code-quality-features.md b/content/github/collaborating-with-issues-and-pull-requests/collaborating-on-repositories-with-code-quality-features.md
index 95ca378e1e12..e185d0a0cf41 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/collaborating-on-repositories-with-code-quality-features.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/collaborating-on-repositories-with-code-quality-features.md
@@ -1,6 +1,6 @@
---
title: Collaborating on repositories with code quality features
-intro: 'Workflow quality features like statuses, {% if currentVersion != "free-pro-team@latest" %}pre-receive hooks, {% endif %}protected branches, and required status checks help collaborators make contributions that meet conditions set by organization and repository administrators.'
+intro: 'Workflow quality features like statuses, {% if enterpriseServerVersions contains currentVersion %}pre-receive hooks, {% endif %}protected branches, and required status checks help collaborators make contributions that meet conditions set by organization and repository administrators.'
mapTopic: true
redirect_from:
- /articles/collaborating-on-repositories-with-code-quality-features-enabled/
@@ -8,5 +8,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request.md
index a8d2506a6e78..2f109a79d619 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request.md
@@ -9,6 +9,7 @@ intro: 'After you open a pull request in a repository, collaborators or team mem
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### About pull request comments
diff --git a/content/github/collaborating-with-issues-and-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork.md b/content/github/collaborating-with-issues-and-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork.md
index 99e4880038af..9b15276e4e2b 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
You can only make commits on pull request branches that:
diff --git a/content/github/collaborating-with-issues-and-pull-requests/configuring-a-remote-for-a-fork.md b/content/github/collaborating-with-issues-and-pull-requests/configuring-a-remote-for-a-fork.md
index 846528296ee6..357da89aedba 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/configuring-a-remote-for-a-fork.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/configuring-a-remote-for-a-fork.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.command_line.open_the_multi_os_terminal %}
2. List the current configured remote repository for your fork.
diff --git a/content/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork.md b/content/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork.md
index 1300ef6b46fc..273d30d6a360 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork.md
@@ -7,6 +7,7 @@ permissions: Anyone with write access to a repository can create a pull request
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
You can also give the upstream repository's maintainers permission to push commits to a user-owned fork. If your pull request compares your topic branch with a branch in the upstream repository as the base branch, then your topic branch is also called the compare branch of the pull request. For more information about pull request branches, including examples, see "[Creating a pull request](/articles/creating-a-pull-request/#changing-the-branch-range-and-destination-repository)."
diff --git a/content/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request.md
index dbad56a3a137..501339a84f64 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Anyone with read permissions to a repository can create a pull request, but you must have write permissions to create a branch. If you want to create a new branch for your pull request and don't have write permissions to the repository, you can fork the repository first. For more information, see "[Creating a pull request from a fork](/articles/creating-a-pull-request-from-a-fork)" and "[About forks](/articles/about-forks)."
diff --git a/content/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository.md b/content/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository.md
index 8049c3962c3c..83924a4a5860 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Creating a branch
@@ -33,7 +34,7 @@ If the branch you want to delete is associated with an open pull request, you mu
1. Scroll to the branch that you want to delete, then click {% octicon "trashcan" aria-label="The trashcan icon to delete the branch" %}.
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
{% data reusables.pull_requests.retargeted-on-branch-deletion %}
{% endif %}
For more information, see "[About branches](/github/collaborating-with-issues-and-pull-requests/about-branches#working-with-branches)."
diff --git a/content/github/collaborating-with-issues-and-pull-requests/dismissing-a-pull-request-review.md b/content/github/collaborating-with-issues-and-pull-requests/dismissing-a-pull-request-review.md
index cfc3eefbaada..273e360041fe 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/dismissing-a-pull-request-review.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/dismissing-a-pull-request-review.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.pull_requests.dismiss_review %}
diff --git a/content/github/collaborating-with-issues-and-pull-requests/filtering-files-in-a-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/filtering-files-in-a-pull-request.md
index 0eebf38056a9..8abfc72cb184 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/filtering-files-in-a-pull-request.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/filtering-files-in-a-pull-request.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
You can filter files in a pull request by file extension type, such as `.html` or `.js`, lack of an extension, code ownership, or dotfiles.
diff --git a/content/github/collaborating-with-issues-and-pull-requests/finding-changed-methods-and-functions-in-a-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/finding-changed-methods-and-functions-in-a-pull-request.md
index 75d5287ca024..5b1ea925dc15 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/finding-changed-methods-and-functions-in-a-pull-request.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/finding-changed-methods-and-functions-in-a-pull-request.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Anyone with read access to a repository can see a summary list of the functions and methods changes in certain files of a pull request.
diff --git a/content/github/collaborating-with-issues-and-pull-requests/github-flow.md b/content/github/collaborating-with-issues-and-pull-requests/github-flow.md
index 74cb2abee77f..a80707f0bc4f 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/github-flow.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/github-flow.md
@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Following the GitHub flow
diff --git a/content/github/collaborating-with-issues-and-pull-requests/incorporating-changes-from-a-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/incorporating-changes-from-a-pull-request.md
index c27882c312ef..0caba244c67b 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/incorporating-changes-from-a-pull-request.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/incorporating-changes-from-a-pull-request.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request.md
index 421cb8250643..68bcb96e4a6a 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Applying suggested changes
@@ -28,6 +29,10 @@ Each person who suggested a change included in the commit will be a co-author of
5. Click **Commit changes.**
+### Re-requesting a review
+
+{% data reusables.pull_requests.re-request-review %}
+
### Opening an issue for an out-of-scope suggestion
If someone suggests changes to your pull request and the changes are out of the pull request's scope, you can open a new issue to track the feedback. For more information, see "[Opening an issue from a comment](/github/managing-your-work-on-github/opening-an-issue-from-a-comment)."
diff --git a/content/github/collaborating-with-issues-and-pull-requests/index.md b/content/github/collaborating-with-issues-and-pull-requests/index.md
index 96b1e50d2211..fe2b997f7701 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/index.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/index.md
@@ -10,6 +10,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
@@ -28,7 +29,7 @@ versions:
{% link_in_list /what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility %}
{% topic_link_in_list /collaborating-on-repositories-with-code-quality-features %}
{% link_in_list /about-status-checks %}
-
+
{% link_in_list /working-with-pre-receive-hooks %}
{% topic_link_in_list /proposing-changes-to-your-work-with-pull-requests %}
diff --git a/content/github/collaborating-with-issues-and-pull-requests/merging-a-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/merging-a-pull-request.md
index 2e3d0f54367a..415b3bc26263 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/merging-a-pull-request.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/merging-a-pull-request.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
@@ -45,12 +46,18 @@ If you decide you don't want the changes in a topic branch to be merged to the u
{% data reusables.files.choose-commit-email %}
+ {% note %}
+
+ **Note:** The email selector is not available for rebase merges, which do not create a merge commit, or for squash merges, which credit the user who created the pull request as the author of the squashed commit.
+
+ {% endnote %}
+
6. Click **Confirm merge**, **Confirm squash and merge**, or **Confirm rebase and merge**.
6. Optionally, [delete the branch](/articles/deleting-unused-branches). This keeps the list of branches in your repository tidy.
-
+
The repository may be configured so that the head branch for a pull request is automatically deleted when you merge a pull request. For more information, see "[Managing the automatic deletion of branches](/github/administering-a-repository/managing-the-automatic-deletion-of-branches)."
- {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
+ {% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
{% note %}
**Note:** {% data reusables.pull_requests.retargeted-on-branch-deletion %}
diff --git a/content/github/collaborating-with-issues-and-pull-requests/merging-an-upstream-repository-into-your-fork.md b/content/github/collaborating-with-issues-and-pull-requests/merging-an-upstream-repository-into-your-fork.md
index 52c1a63c1a13..4463aa1477b9 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/merging-an-upstream-repository-into-your-fork.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/merging-an-upstream-repository-into-your-fork.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.command_line.open_the_multi_os_terminal %}
2. Change the current working directory to your local project.
diff --git a/content/github/collaborating-with-issues-and-pull-requests/overview.md b/content/github/collaborating-with-issues-and-pull-requests/overview.md
index 298beb20bc44..816072556fd1 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/overview.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/overview.md
@@ -5,5 +5,6 @@ mapTopic: true
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests.md b/content/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests.md
index eeee79dbdd41..913990858c73 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/collaborating-with-issues-and-pull-requests/requesting-a-pull-request-review.md b/content/github/collaborating-with-issues-and-pull-requests/requesting-a-pull-request-review.md
index 57272d628c4c..65ebb3844c73 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/requesting-a-pull-request-review.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/requesting-a-pull-request-review.md
@@ -6,11 +6,12 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Owners and collaborators on a repository owned by a user account can assign pull request reviews. Organization members with triage permissions to a repository can assign a pull request review.
-Owners or collaborators can assign a pull request review to any person that has been explicitly granted [read access](/articles/access-permissions-on-github) to a user-owned repository. Organization members can assign a pull request review to any person or team with read access to a repository. The requested reviewer or team will receive a notification that you asked them to review the pull request. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}If you request a review from a team and code review assignment is enabled, specific members will be requested and the team will be removed as a reviewer. For more information, see "[Managing code review assignment for your team](/github/setting-up-and-managing-organizations-and-teams/managing-code-review-assignment-for-your-team)."{% endif %}
+Owners or collaborators can assign a pull request review to any person that has been explicitly granted [read access](/articles/access-permissions-on-github) to a user-owned repository. Organization members can assign a pull request review to any person or team with read access to a repository. The requested reviewer or team will receive a notification that you asked them to review the pull request. {% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}If you request a review from a team and code review assignment is enabled, specific members will be requested and the team will be removed as a reviewer. For more information, see "[Managing code review assignment for your team](/github/setting-up-and-managing-organizations-and-teams/managing-code-review-assignment-for-your-team)."{% endif %}
{% note %}
diff --git a/content/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-on-github.md b/content/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-on-github.md
index 1b9ed3f8d809..ec47c6933b68 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-on-github.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-on-github.md
@@ -6,11 +6,12 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
You can only resolve merge conflicts on {% data variables.product.product_name %} that are caused by competing line changes, such as when people make different changes to the same line of the same file on different branches in your Git repository. For all other types of merge conflicts, you must resolve the conflict locally on the command line. For more information, see "[Resolving a merge conflict using the command line](/articles/resolving-a-merge-conflict-using-the-command-line/)."
-{% if currentVersion != "free-pro-team@latest" %}
+{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
If a site administrator disables the merge conflict editor for pull requests between repositories, you cannot use the conflict editor on {% data variables.product.product_name %} and must resolve merge conflicts on the command line. For example, if the merge conflict editor is disabled, you cannot use it on a pull request between a fork and upstream repository.
{% endif %}
@@ -31,7 +32,7 @@ If a site administrator disables the merge conflict editor for pull requests bet
{% tip %}
- **Tip:** If the **Resolve conflicts** button is deactivated, your pull request's merge conflict is too complex to resolve on {% data variables.product.product_name %}{% if currentVersion != "free-pro-team@latest" %} or the site administrator has disabled the conflict editor for pull requests between repositories{% endif %}. You must resolve the merge conflict using an alternative Git client, or by using Git on the command line. For more information see "[Resolving a merge conflict using the command line](/articles/resolving-a-merge-conflict-using-the-command-line)."
+ **Tip:** If the **Resolve conflicts** button is deactivated, your pull request's merge conflict is too complex to resolve on {% data variables.product.product_name %}{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} or the site administrator has disabled the conflict editor for pull requests between repositories{% endif %}. You must resolve the merge conflict using an alternative Git client, or by using Git on the command line. For more information see "[Resolving a merge conflict using the command line](/articles/resolving-a-merge-conflict-using-the-command-line)."
{% endtip %}
{% data reusables.pull_requests.decide-how-to-resolve-competing-line-change-merge-conflict %}
diff --git a/content/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-using-the-command-line.md b/content/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-using-the-command-line.md
index cc9216b99e49..c6ce42751821 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-using-the-command-line.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-using-the-command-line.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Merge conflicts occur when competing changes are made to the same line of a file, or when one person edits a file and another person deletes the same file. For more information, see "[About merge conflicts](/articles/about-merge-conflicts/)."
diff --git a/content/github/collaborating-with-issues-and-pull-requests/reverting-a-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/reverting-a-pull-request.md
index 636d09b53c8c..dd7b4b5df1be 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/reverting-a-pull-request.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/reverting-a-pull-request.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### About reverting a pull request
diff --git a/content/github/collaborating-with-issues-and-pull-requests/reviewing-changes-in-pull-requests.md b/content/github/collaborating-with-issues-and-pull-requests/reviewing-changes-in-pull-requests.md
index c93e774980ef..83cbe9154986 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/reviewing-changes-in-pull-requests.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/reviewing-changes-in-pull-requests.md
@@ -8,5 +8,6 @@ mapTopic: true
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/collaborating-with-issues-and-pull-requests/reviewing-proposed-changes-in-a-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/reviewing-proposed-changes-in-a-pull-request.md
index a35e7f5ca345..b69a71eb46ee 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/reviewing-proposed-changes-in-a-pull-request.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/reviewing-proposed-changes-in-a-pull-request.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### About reviewing pull requests
diff --git a/content/github/collaborating-with-issues-and-pull-requests/syncing-a-fork.md b/content/github/collaborating-with-issues-and-pull-requests/syncing-a-fork.md
index 458bfa66d631..affc3dd844ad 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/syncing-a-fork.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/syncing-a-fork.md
@@ -6,13 +6,14 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Before you can sync your fork with an upstream repository, you must [configure a remote that points to the upstream repository](/articles/configuring-a-remote-for-a-fork) in Git.
{% data reusables.command_line.open_the_multi_os_terminal %}
2. Change the current working directory to your local project.
-3. Fetch the branches and their respective commits from the upstream repository. Commits to `master` will be stored in a local branch, `upstream/master`.
+3. Fetch the branches and their respective commits from the upstream repository. Commits to `BRANCHNAME` will be stored in the local branch `upstream/BRANCHNAME`.
```shell
$ git fetch upstream
> remote: Counting objects: 75, done.
@@ -20,16 +21,16 @@ Before you can sync your fork with an upstream repository, you must [configure a
> remote: Total 62 (delta 27), reused 44 (delta 9)
> Unpacking objects: 100% (62/62), done.
> From https://{% data variables.command_line.codeblock %}/ORIGINAL_OWNER/ORIGINAL_REPOSITORY
- > * [new branch] master -> upstream/master
+ > * [new branch] main -> upstream/main
```
-4. Check out your fork's local `master` branch.
+4. Check out your fork's local default branch - in this case, we use `main`.
```shell
- $ git checkout master
- > Switched to branch 'master'
+ $ git checkout main
+ > Switched to branch 'main'
```
-5. Merge the changes from `upstream/master` into your local `master` branch. This brings your fork's `master` branch into sync with the upstream repository, without losing your local changes.
+5. Merge the changes from the upstream default branch - in this case, `upstream/main` - into your local default branch. This brings your fork's default branch into sync with the upstream repository, without losing your local changes.
```shell
- $ git merge upstream/master
+ $ git merge upstream/main
> Updating a422352..5fdff0f
> Fast-forward
> README | 9 -------
@@ -39,7 +40,7 @@ Before you can sync your fork with an upstream repository, you must [configure a
> create mode 100644 README.md
``` If your local branch didn't have any unique commits, Git will instead perform a "fast-forward":
```shell
- $ git merge upstream/master
+ $ git merge upstream/main
> Updating 34e91da..16c56ad
> Fast-forward
> README.md | 5 +++--
diff --git a/content/github/collaborating-with-issues-and-pull-requests/viewing-a-pull-request-review.md b/content/github/collaborating-with-issues-and-pull-requests/viewing-a-pull-request-review.md
index 4e48d17874f5..6beac4889529 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/viewing-a-pull-request-review.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/viewing-a-pull-request-review.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.search.requested_reviews_search %}
diff --git a/content/github/collaborating-with-issues-and-pull-requests/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md b/content/github/collaborating-with-issues-and-pull-requests/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md
index 34317ea79147..7517b5f72187 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.repositories.deleted_forks_from_private_repositories_warning %}
@@ -29,7 +30,7 @@ If a public repository is made private, its public forks are split off into a ne
In other words, a public repository's forks will remain public in their own separate repository network even after the parent repository is made private. This allows the fork owners to continue to work and collaborate without interruption. If public forks were not moved into a separate network in this way, the owners of those forks would need to get the appropriate [access permissions](/articles/access-permissions-on-github) to pull changes from and submit pull requests to the (now private) parent repository—even though they didn't need those permissions before.
-{% if currentVersion != "free-pro-team@latest" %}
+{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
If a public repository has anonymous Git read access enabled and the repository is made private, all of the repository's forks will lose anonymous Git read access and return to the default disabled setting. If a forked repository is made public, repository administrators can re-enable anonymous Git read access. For more information, see "[Enabling anonymous Git read access for a repository](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository)."
{% endif %}
diff --git a/content/github/collaborating-with-issues-and-pull-requests/working-with-forks.md b/content/github/collaborating-with-issues-and-pull-requests/working-with-forks.md
index 5dcdcd1b0a2c..fef659dd91ef 100644
--- a/content/github/collaborating-with-issues-and-pull-requests/working-with-forks.md
+++ b/content/github/collaborating-with-issues-and-pull-requests/working-with-forks.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/committing-changes-to-your-project/about-commits.md b/content/github/committing-changes-to-your-project/about-commits.md
index ecca717bcb62..66cf2c561040 100644
--- a/content/github/committing-changes-to-your-project/about-commits.md
+++ b/content/github/committing-changes-to-your-project/about-commits.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### About commits
diff --git a/content/github/committing-changes-to-your-project/changing-a-commit-message.md b/content/github/committing-changes-to-your-project/changing-a-commit-message.md
index 7f55accc3eae..fc8c90f54f0e 100644
--- a/content/github/committing-changes-to-your-project/changing-a-commit-message.md
+++ b/content/github/committing-changes-to-your-project/changing-a-commit-message.md
@@ -7,6 +7,7 @@ intro: 'If a commit message contains unclear, incorrect, or sensitive informatio
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Rewriting the most recent commit message
diff --git a/content/github/committing-changes-to-your-project/commit-branch-and-tag-labels.md b/content/github/committing-changes-to-your-project/commit-branch-and-tag-labels.md
index e4685d213c42..97a0a9ae2ea3 100644
--- a/content/github/committing-changes-to-your-project/commit-branch-and-tag-labels.md
+++ b/content/github/committing-changes-to-your-project/commit-branch-and-tag-labels.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
If your commit is not on the default branch, an indicator will show the branches which contain the commit. If the commit is part of an unmerged pull request, it will show a link.
diff --git a/content/github/committing-changes-to-your-project/commit-exists-on-github-but-not-in-my-local-clone.md b/content/github/committing-changes-to-your-project/commit-exists-on-github-but-not-in-my-local-clone.md
index f01c3927a965..92263b2fff3f 100644
--- a/content/github/committing-changes-to-your-project/commit-exists-on-github-but-not-in-my-local-clone.md
+++ b/content/github/committing-changes-to-your-project/commit-exists-on-github-but-not-in-my-local-clone.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
When you use `git show` to view a specific commit on the command line, you may get a fatal error.
diff --git a/content/github/committing-changes-to-your-project/comparing-commits.md b/content/github/committing-changes-to-your-project/comparing-commits.md
index e350494c34de..a94067a842d0 100644
--- a/content/github/committing-changes-to-your-project/comparing-commits.md
+++ b/content/github/committing-changes-to-your-project/comparing-commits.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
You can compare the state of your repository across branches, tags, commits, and dates. To compare different versions of your repository, append `/compare` to your repository's path.
@@ -26,10 +27,10 @@ Here's an example of a [comparison between two branches](https://github.com/octo
### Comparing tags
-Comparing release tags will show you changes to your repository since the last release. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
+Comparing release tags will show you changes to your repository since the last release. {% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
For more information, see "[Comparing releases](/github/administering-a-repository/comparing-releases)."{% endif %}
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}To compare tags, you can select a tag name from the `compare` drop-down menu at the top of the page.{% else %} Instead of typing a branch name, type the name of your tag in the `compare` drop down menu.{% endif %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.20" %}To compare tags, you can select a tag name from the `compare` drop-down menu at the top of the page.{% else %} Instead of typing a branch name, type the name of your tag in the `compare` drop down menu.{% endif %}
Here's an example of a [comparison between two tags](https://github.com/octocat/linguist/compare/v2.2.0...octocat:v2.3.3).
diff --git a/content/github/committing-changes-to-your-project/creating-a-commit-with-multiple-authors.md b/content/github/committing-changes-to-your-project/creating-a-commit-with-multiple-authors.md
index 079e81663f51..e0e23bf5804f 100644
--- a/content/github/committing-changes-to-your-project/creating-a-commit-with-multiple-authors.md
+++ b/content/github/committing-changes-to-your-project/creating-a-commit-with-multiple-authors.md
@@ -1,11 +1,12 @@
---
title: Creating a commit with multiple authors
-intro: 'You can attribute a commit to more than one author by adding one or more `Co-authored-by` trailers to the commit''s message. Co-authored commits are visible on {% data variables.product.product_name %}{% if currentVersion != "free-pro-team@latest" %} and can be included in the profile contributions graph and the repository''s statistics{% endif %}.'
+intro: 'You can attribute a commit to more than one author by adding one or more `Co-authored-by` trailers to the commit''s message. Co-authored commits are visible on {% data variables.product.product_name %}{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} and can be included in the profile contributions graph and the repository''s statistics{% endif %}.'
redirect_from:
- /articles/creating-a-commit-with-multiple-authors
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Required co-author information
@@ -68,7 +69,7 @@ After you've made changes in a file using the web editor on {% data variables.pr
The new commit and message will appear on {% data variables.product.product_location %}.
### Further reading
-{% if currentVersion != "free-pro-team@latest" %}
+{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
- "[Viewing contributions on your profile](/articles/viewing-contributions-on-your-profile)"
- "[Why are my contributions not showing up on my profile?](/articles/why-are-my-contributions-not-showing-up-on-my-profile)"{% endif %}
- "[Viewing a summary of repository activity](/articles/viewing-a-summary-of-repository-activity)"
diff --git a/content/github/committing-changes-to-your-project/creating-and-editing-commits.md b/content/github/committing-changes-to-your-project/creating-and-editing-commits.md
index 59c9a7e12e8d..be7efbd5c3d8 100644
--- a/content/github/committing-changes-to-your-project/creating-and-editing-commits.md
+++ b/content/github/committing-changes-to-your-project/creating-and-editing-commits.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/committing-changes-to-your-project/differences-between-commit-views.md b/content/github/committing-changes-to-your-project/differences-between-commit-views.md
index f8f0dd08f2b8..fdcddb2ca6d2 100644
--- a/content/github/committing-changes-to-your-project/differences-between-commit-views.md
+++ b/content/github/committing-changes-to-your-project/differences-between-commit-views.md
@@ -5,6 +5,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
On {% data variables.product.product_name %}, you can see the commit history of a repository by:
diff --git a/content/github/committing-changes-to-your-project/index.md b/content/github/committing-changes-to-your-project/index.md
index b35dd61831cd..6a0d69b0c684 100644
--- a/content/github/committing-changes-to-your-project/index.md
+++ b/content/github/committing-changes-to-your-project/index.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/committing-changes-to-your-project/troubleshooting-commits.md b/content/github/committing-changes-to-your-project/troubleshooting-commits.md
index e9c329d4372b..1533d63eea6a 100644
--- a/content/github/committing-changes-to-your-project/troubleshooting-commits.md
+++ b/content/github/committing-changes-to-your-project/troubleshooting-commits.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/committing-changes-to-your-project/viewing-and-comparing-commits.md b/content/github/committing-changes-to-your-project/viewing-and-comparing-commits.md
index 137945c6cb97..9cf47bd2627b 100644
--- a/content/github/committing-changes-to-your-project/viewing-and-comparing-commits.md
+++ b/content/github/committing-changes-to-your-project/viewing-and-comparing-commits.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/committing-changes-to-your-project/why-are-my-commits-linked-to-the-wrong-user.md b/content/github/committing-changes-to-your-project/why-are-my-commits-linked-to-the-wrong-user.md
index 5f44701f6c58..ed96783b9065 100644
--- a/content/github/committing-changes-to-your-project/why-are-my-commits-linked-to-the-wrong-user.md
+++ b/content/github/committing-changes-to-your-project/why-are-my-commits-linked-to-the-wrong-user.md
@@ -3,10 +3,11 @@ title: Why are my commits linked to the wrong user?
redirect_from:
- /articles/how-do-i-get-my-commits-to-link-to-my-github-account/
- /articles/why-are-my-commits-linked-to-the-wrong-user
-intro: '{% data variables.product.product_name %} uses the email address in the commit header to link the commit to a GitHub user. If your commits are being linked to another user, or not linked to a user at all, you may need to change your local Git configuration settings, add an email address to your account email settings, or do both.'
+intro: '{% data variables.product.product_name %} uses the email address in the commit header to link the commit to a GitHub user. If your commits are being linked to another user, or not linked to a user at all, you may need to change your local Git configuration settings{% if currentVersion != "github-ae@latest" %}, add an email address to your account email settings, or do both{% endif %}.'
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
@@ -18,10 +19,10 @@ versions:
### Commits are linked to another user
-If your commits are linked to another user, that means the user has added the email address in your local Git configuration settings to their {% data variables.product.product_name %} account. In this case, you can change the email in your local Git configuration settings and add the new email address to your {% data variables.product.product_name %} account to link future commits to your account.
+If your commits are linked to another user, that means the email address in your local Git configuration settings is connected to that user's account on {% data variables.product.product_name %}. In this case, you can change the email in your local Git configuration settings{% if currentVersion == "github-ae@latest" %} to the address associated with your account on {% data variables.product.product_name %} to link your future commits. Old commits will not be linked. For more information, see "[Setting your commit email address](/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address#setting-your-commit-email-address-in-git)."{% else %} and add the new email address to your {% data variables.product.product_name %} account to link future commits to your account.
-1. To change the email address in your local Git configuration, follow the steps in "[Setting your commit email address in Git](/articles/setting-your-commit-email-address)". If you work on multiple machines, you will need to change this setting on each one.
-2. Add the email address from step 2 to your account settings by following the steps in "[Adding an email address to your GitHub account](/articles/adding-an-email-address-to-your-github-account)".
+1. To change the email address in your local Git configuration, follow the steps in "[Setting your commit email address](/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address#setting-your-commit-email-address-in-git)". If you work on multiple machines, you will need to change this setting on each one.
+2. Add the email address from step 2 to your account settings by following the steps in "[Adding an email address to your GitHub account](/articles/adding-an-email-address-to-your-github-account)".{% endif %}
Commits you make from this point forward will be linked to your account.
@@ -36,9 +37,13 @@ To check the email address used for those commits and connect commits to your ac
2. To read a message about why the commit is not linked, hover over the blue {% octicon "question" aria-label="Question mark" %} to the right of the username.
- - **Unrecognized author (with email address)** If you see this message with an email address, it means the address has not been added to your account settings. To link your commits, [add the email address to your GitHub email settings](/articles/adding-an-email-address-to-your-github-account). If your email address has a Gravatar associated with it, the Gravatar will be displayed next to your username, rather than the default gray Octocat.
- - **Unrecognized author (no email address)** If you see this message without an email address, it means you used a generic email address that can't be added to your email settings. You will need to [set your commit email address in Git](/articles/setting-your-commit-email-address), then [add the new address to your GitHub email settings](/articles/adding-an-email-address-to-your-github-account) to link your future commits. Old commits will not be linked.
- - **Invalid email** This means the email address in your local Git configuration settings is either blank or not formatted as an email address. You will need to [set your commit email address in Git](/articles/setting-your-commit-email-address), then [add the new address to your GitHub email settings](/articles/adding-an-email-address-to-your-github-account) to link your future commits. Old commits will not be linked.
+ - **Unrecognized author (with email address)** If you see this message with an email address, the address you used to author the commit is not connected to your account on {% data variables.product.product_name %}. {% if currentVersion != "github-ae@latest" %}To link your commits, [add the email address to your GitHub email settings](/articles/adding-an-email-address-to-your-github-account).{% endif %} If the email address has a Gravatar associated with it, the Gravatar will be displayed next to the commit, rather than the default gray Octocat.
+ - **Unrecognized author (no email address)** If you see this message without an email address, you used a generic email address that can't be connected to your account on {% data variables.product.product_name %}.{% if currentVersion != "github-ae@latest" %} You will need to [set your commit email address in Git](/articles/setting-your-commit-email-address), then [add the new address to your GitHub email settings](/articles/adding-an-email-address-to-your-github-account) to link your future commits. Old commits will not be linked.{% endif %}
+ - **Invalid email** The email address in your local Git configuration settings is either blank or not formatted as an email address.{% if currentVersion != "github-ae@latest" %} You will need to [set your commit email address in Git](/articles/setting-your-commit-email-address), then [add the new address to your GitHub email settings](/articles/adding-an-email-address-to-your-github-account) to link your future commits. Old commits will not be linked.{% endif %}
+
+{% if currentVersion == "github-ae@latest" %}
+You can change the email in your local Git configuration settings to the address associated with your account to link your future commits. Old commits will not be linked. For more information, see "[Setting your commit email address](/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address#setting-your-commit-email-address-in-git)."
+{% endif %}
{% warning %}
diff --git a/content/github/creating-cloning-and-archiving-repositories/about-archiving-repositories.md b/content/github/creating-cloning-and-archiving-repositories/about-archiving-repositories.md
index 9e87c1f42cf1..51d0fc1e328c 100644
--- a/content/github/creating-cloning-and-archiving-repositories/about-archiving-repositories.md
+++ b/content/github/creating-cloning-and-archiving-repositories/about-archiving-repositories.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% if currentVersion == "free-pro-team@latest" %}
diff --git a/content/github/creating-cloning-and-archiving-repositories/about-code-owners.md b/content/github/creating-cloning-and-archiving-repositories/about-code-owners.md
index 146dee968204..732c4043188c 100644
--- a/content/github/creating-cloning-and-archiving-repositories/about-code-owners.md
+++ b/content/github/creating-cloning-and-archiving-repositories/about-code-owners.md
@@ -8,6 +8,7 @@ product: '{% data reusables.gated-features.code-owners %}'
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
People with admin or owner permissions can set up a CODEOWNERS file in a repository.
@@ -20,9 +21,9 @@ Code owners are automatically requested for review when someone opens a pull req
When someone with admin or owner permissions has enabled required reviews, they also can optionally require approval from a code owner before the author can merge a pull request in the repository. For more information, see "[Enabling required reviews for pull requests](/github/administering-a-repository/enabling-required-reviews-for-pull-requests)."
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}If a team has enabled code review assignments, the individual approvals won't satisfy the requirement for code owner approval in a protected branch. For more information, see "[Managing code review assignment for your team](/github/setting-up-and-managing-organizations-and-teams/managing-code-review-assignment-for-your-team)."{% endif %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}If a team has enabled code review assignments, the individual approvals won't satisfy the requirement for code owner approval in a protected branch. For more information, see "[Managing code review assignment for your team](/github/setting-up-and-managing-organizations-and-teams/managing-code-review-assignment-for-your-team)."{% endif %}
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
If a file has a code owner, you can see who the code owner is before you open a pull request. In the repository, you can browse to the file and hover over {% octicon "shield-lock" aria-label="The edit icon" %}.
diff --git a/content/github/creating-cloning-and-archiving-repositories/about-readmes.md b/content/github/creating-cloning-and-archiving-repositories/about-readmes.md
index 941ea80297f0..14791400d7cf 100644
--- a/content/github/creating-cloning-and-archiving-repositories/about-readmes.md
+++ b/content/github/creating-cloning-and-archiving-repositories/about-readmes.md
@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
A README file, along with {% if currentVersion == "free-pro-team@latest" %}a [repository license](/articles/licensing-a-repository), [contribution guidelines](/articles/setting-guidelines-for-repository-contributors), and a [code of conduct](/articles/adding-a-code-of-conduct-to-your-project){% else %}a [repository license](/articles/licensing-a-repository) and [contribution guidelines](/articles/setting-guidelines-for-repository-contributors){% endif %}, helps you communicate expectations for and manage contributions to your project.
@@ -23,7 +24,7 @@ If you put your README file in your repository's root, `docs`, or hidden `.githu
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
{% data reusables.profile.profile-readme %}
diff --git a/content/github/creating-cloning-and-archiving-repositories/about-repositories.md b/content/github/creating-cloning-and-archiving-repositories/about-repositories.md
index 8ea218ce1dc1..4279042e520f 100644
--- a/content/github/creating-cloning-and-archiving-repositories/about-repositories.md
+++ b/content/github/creating-cloning-and-archiving-repositories/about-repositories.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
You can own repositories individually, or you can share ownership of repositories with other people in an organization.
diff --git a/content/github/creating-cloning-and-archiving-repositories/about-repository-languages.md b/content/github/creating-cloning-and-archiving-repositories/about-repository-languages.md
index d172c0367e52..94d1f82eb31b 100644
--- a/content/github/creating-cloning-and-archiving-repositories/about-repository-languages.md
+++ b/content/github/creating-cloning-and-archiving-repositories/about-repository-languages.md
@@ -11,6 +11,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data variables.product.product_name %} uses the open source [Linguist library](https://github.com/github/linguist) to
determine file languages for syntax highlighting and repository statistics. Language statistics will update after you push changes to your default branch.
diff --git a/content/github/creating-cloning-and-archiving-repositories/about-repository-visibility.md b/content/github/creating-cloning-and-archiving-repositories/about-repository-visibility.md
index d8c3f2ea37c5..9e2fc6a4ec4f 100644
--- a/content/github/creating-cloning-and-archiving-repositories/about-repository-visibility.md
+++ b/content/github/creating-cloning-and-archiving-repositories/about-repository-visibility.md
@@ -1,22 +1,29 @@
---
title: About repository visibility
-intro: 'You can restrict who has access to a repository by choosing a repository''s visibility: {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}public, internal, or private{% else %} public or private{% endif %}.'
+intro: 'You can restrict who has access to a repository by choosing a repository''s visibility: {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}public, internal, or private{% elsif currentVersion == "github-ae@latest" %}private or internal{% else %} public or private{% endif %}.'
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### About repository visibility
-When you create a repository, you can choose to make the repository public or private. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}If you're creating the repository in an organization{% if currentVersion == "free-pro-team@latest" %} that is owned by an enterprise account{% endif %}, you can also choose to make the repository internal.{% endif %}
+{% if currentVersion == "github-ae@latest" %}When you create a repository owned by your user account, the repository is always private. When you create a repository owned by an organization, you can choose to make the repository private or internal.{% else %}When you create a repository, you can choose to make the repository public or private.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} If you're creating the repository in an organization{% if currentVersion == "free-pro-team@latest" %} that is owned by an enterprise account{% endif %}, you can also choose to make the repository internal.{% endif %}{% endif %}
-{% if currentVersion != "free-pro-team@latest" %}If {% data variables.product.product_location_enterprise %} is not in private mode or behind a firewall, p{% else %}P{% endif %}ublic repositories are accessible to everyone on the internet.{% if currentVersion != "free-pro-team@latest" %} Otherwise, public repositories are available to everyone using {% data variables.product.product_location_enterprise %}, including outside collaborators.{% endif %} Private repositories are only accessible to you, people you explicitly share access with, and, for organization repositories, [certain organization members](/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization). {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}Internal repositories are accessible to {% if currentVersion == "free-pro-team@latest" %}members of your enterprise account{% else %}members of any organization on your instance{% endif %}. For more information, see "[About internal repositories](#about-internal-repositories)."{% endif %}
+{% if enterpriseServerVersions contains currentVersion %}
+If {% data variables.product.product_location %} is not in private mode or behind a firewall, public repositories are accessible to everyone on the internet. Otherwise, public repositories are available to everyone using {% data variables.product.product_location %}, including outside collaborators. Private repositories are only accessible to you, people you explicitly share access with, and, for organization repositories, certain organization members. {% if currentVersion ver_gt "enterprise-server@2.19" %} Internal repositories are accessible to enterprise members. For more information, see "[About internal repositories](#about-internal-repositories)."{% endif %}
+{% elsif currentVersion == "github-ae@latest" %}
+Private repositories are only accessible to you, people you explicitly share access with, and, for organization repositories, certain organization members. Internal repositories are accessible to all enterprise members. For more information, see "[About internal repositories](#about-internal-repositories)."
+{% else %}
+Public repositories are accessible to everyone on the internet. Private repositories are only accessible to you, people you explicitly share access with, and, for organization repositories, certain organization members. Internal repositories are accessible to enterprise members. For more information, see "[About internal repositories](#about-internal-repositories)."
+{% endif %}
Organization owners always have access to every repository created in an organization. For more information, see "[Repository permission levels for an organization](/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization)."
People with admin permissions for a repository can change an existing repository's visibility. For more information, see "[Setting repository visibility](/github/administering-a-repository/setting-repository-visibility)."
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
### About internal repositories
{% note %}
@@ -27,9 +34,9 @@ People with admin permissions for a repository can change an existing repository
{% data reusables.repositories.about-internal-repos %} For more information on innersource, see {% data variables.product.prodname_dotcom %}'s whitepaper "[An introduction to innersource](https://resources.github.com/whitepapers/introduction-to-innersource/)."
-All {% if currentVersion == "free-pro-team@latest" %}enterprise members{% else %}organization members{% endif %} have read permissions to the internal repository, but internal repositories are not visible to people {% if currentVersion == "free-pro-team@latest" %}outside of the enterprise account{% else %}who are not members of an organization{% endif %}, including outside collaborators on organization repositories. For more information, see {% if currentVersion == "free-pro-team@latest" %}"[Roles for an enterprise account](/articles/roles-for-an-enterprise-account#enterprise-members)" and {% endif %}"[Repository permission levels for an organization](/articles/repository-permission-levels-for-an-organization)."
+All enterprise members have read permissions to the internal repository, but internal repositories are not visible to people {% if currentVersion == "free-pro-team@latest" %}outside of the enterprise{% else %}who are not members of an organization{% endif %}, including outside collaborators on organization repositories. For more information, see {% if currentVersion == "free-pro-team@latest" or "github-ae@latest" %}"[Roles in an enterprise](/github/setting-up-and-managing-your-enterprise/roles-in-an-enterprise#enterprise-members)" and {% endif %}"[Repository permission levels for an organization](/articles/repository-permission-levels-for-an-organization)."
{% data reusables.repositories.internal-repo-default %}
-If a user is removed from {% if currentVersion == "free-pro-team@latest" %}an enterprise account{% else %}all organizations on the instance{% endif %}, that user's forks of internal repositories are removed automatically.
+If a user is removed from all organizations owned by the enterprise, that user's forks of internal repositories are removed automatically.
{% endif %}
diff --git a/content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository.md b/content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository.md
index f61b7497d7ef..bb9d9e01a712 100644
--- a/content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository.md
+++ b/content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository.md
@@ -9,5 +9,6 @@ mapTopic: true
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/creating-cloning-and-archiving-repositories/archiving-repositories.md b/content/github/creating-cloning-and-archiving-repositories/archiving-repositories.md
index 4fb7e1f1c51d..8a8f7b9bdf35 100644
--- a/content/github/creating-cloning-and-archiving-repositories/archiving-repositories.md
+++ b/content/github/creating-cloning-and-archiving-repositories/archiving-repositories.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.repositories.archiving-repositories-recommendation %}
diff --git a/content/github/creating-cloning-and-archiving-repositories/backing-up-a-repository.md b/content/github/creating-cloning-and-archiving-repositories/backing-up-a-repository.md
index 5364873fbeb0..f7fc86c5ee79 100644
--- a/content/github/creating-cloning-and-archiving-repositories/backing-up-a-repository.md
+++ b/content/github/creating-cloning-and-archiving-repositories/backing-up-a-repository.md
@@ -1,11 +1,12 @@
---
title: Backing up a repository
-intro: 'You can use{% if currentVersion != "free-pro-team@latest" %} Git and{% endif %} the API {% if currentVersion == "free-pro-team@latest" %}or a third-party tool {% endif %}to back up your repository.'
+intro: 'You can use{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} Git and{% endif %} the API {% if currentVersion == "free-pro-team@latest" %}or a third-party tool {% endif %}to back up your repository.'
redirect_from:
- /articles/backing-up-a-repository
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% if currentVersion == "free-pro-team@latest" %}
@@ -30,7 +31,7 @@ When you clone a repository or wiki, only Git data, such as project files and co
- [Projects](/v3/projects/#list-repository-projects)
{% endif %}
-Once you have {% if currentVersion != "free-pro-team@latest" %}a local version of all the content you want to back up, you can create a zip archive and {% else %}downloaded your archive, you can {% endif %}copy it to an external hard drive and/or upload it to a cloud-based backup service such as [Google Drive](https://www.google.com/drive/) or [Dropbox](https://www.dropbox.com/).
+Once you have {% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}a local version of all the content you want to back up, you can create a zip archive and {% else %}downloaded your archive, you can {% endif %}copy it to an external hard drive and/or upload it to a cloud-based backup service such as [Google Drive](https://www.google.com/drive/) or [Dropbox](https://www.dropbox.com/).
{% if currentVersion == "free-pro-team@latest" %}
### Third-party backup tools
diff --git a/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github.md b/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github.md
index d2b0973d49de..8272d98dcb29 100644
--- a/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github.md
+++ b/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository.md b/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository.md
index 0d12be6f0bf8..0dc66db59f6f 100644
--- a/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository.md
+++ b/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### About cloning a repository
@@ -16,7 +17,7 @@ Cloning a repository pulls down a full copy of all the repository data that {% d
You can clone your existing repository or clone another person's existing repository to contribute to a project.
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
{% tip %}
**Tip**: You can also clone a repository using the {% data variables.product.prodname_cli %}. For more information, see "[`gh repo clone`](https://cli.github.com/manual/gh_repo_clone)" in the {% data variables.product.prodname_cli %} documentation.
diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-new-repository.md b/content/github/creating-cloning-and-archiving-repositories/creating-a-new-repository.md
index a228c3615036..fbd4af8d7b03 100644
--- a/content/github/creating-cloning-and-archiving-repositories/creating-a-new-repository.md
+++ b/content/github/creating-cloning-and-archiving-repositories/creating-a-new-repository.md
@@ -12,6 +12,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% tip %}
@@ -20,17 +21,17 @@ versions:
{% endtip %}
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
{% tip %}
-**Tip**: You can also create a repository using the {% data variables.product.prodname_cli %}. For more information, see "[`gh repo create`](https://cli.github.com/manual/gh_repo_create)" in the {% data variables.product.product_location %} documentation.
+**Tip**: You can also create a repository using the {% data variables.product.prodname_cli %}. For more information, see "[`gh repo create`](https://cli.github.com/manual/gh_repo_create)" in the {% data variables.product.prodname_cli %} documentation.
{% endtip %}
{% endif %}
{% data reusables.repositories.create_new %}
2. Optionally, to create a repository with the directory structure and files of an existing repository, use the **Choose a template** drop-down and select a template repository. You'll see template repositories that are owned by you and organizations you're a member of or that you've used before. For more information, see "[Creating a repository from a template](/articles/creating-a-repository-from-a-template)."
- {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
+ {% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
3. Optionally, if you chose to use a template, to include the directory structure and files from all branches in the template, and not just the default branch, select **Include all branches**.
{% endif %}
3. In the Owner drop-down, select the account you wish to create the repository on.
diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template.md b/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template.md
index 33f0f1a1f05a..c8174a611ee4 100644
--- a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template.md
+++ b/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template.md
@@ -6,21 +6,22 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### About repository templates
Anyone with read permissions to a template repository can create a repository from that template. For more information, see "[Creating a template repository](/articles/creating-a-template-repository)."
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
{% tip %}
-**Tip**: You can also create a repository from a template using the {% data variables.product.prodname_cli %}. For more information, see "[`gh repo create`](https://cli.github.com/manual/gh_repo_create)" in the {% data variables.product.product_location %} documentation.
+**Tip**: You can also create a repository from a template using the {% data variables.product.prodname_cli %}. For more information, see "[`gh repo create`](https://cli.github.com/manual/gh_repo_create)" in the {% data variables.product.prodname_cli %} documentation.
{% endtip %}
{% endif %}
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
You can choose to include the directory structure and files from only the default branch of the template repository or to include all branches.
{% endif %}
@@ -38,7 +39,7 @@ For more information about forks, see "[About forks](/articles/about-forks)."
{% data reusables.repositories.owner-drop-down %}
{% data reusables.repositories.repo-name %}
-{% data reusables.repositories.choose-repo-visibility %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
+{% data reusables.repositories.choose-repo-visibility %}{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
6. Optionally, to include the directory structure and files from all branches in the template, and not just the default branch, select **Include all branches**.
{% endif %}
{% data reusables.repositories.select-marketplace-apps %}
diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github.md b/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github.md
index 4c0813bb8841..ca3e328a934b 100644
--- a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github.md
+++ b/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-template-repository.md b/content/github/creating-cloning-and-archiving-repositories/creating-a-template-repository.md
index 985918901d8d..39778d159c4d 100644
--- a/content/github/creating-cloning-and-archiving-repositories/creating-a-template-repository.md
+++ b/content/github/creating-cloning-and-archiving-repositories/creating-a-template-repository.md
@@ -1,20 +1,26 @@
---
title: Creating a template repository
-intro: 'You can make an existing repository a template, so you and others can generate new repositories with the same directory structure{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}, branches,{% endif %} and files.'
+intro: 'You can make an existing repository a template, so you and others can generate new repositories with the same directory structure{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.20" %}, branches,{% endif %} and files.'
+permissions: Anyone with admin permissions to a repository can make the repository a template.
redirect_from:
- /articles/creating-a-template-repository
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
-Anyone with admin permissions to a repository can make the repository a template.
+{% note %}
+
+**Note**: Your template repository cannot include files stored using {% data variables.large_files.product_name_short %}.
+
+{% endnote %}
To create a template repository, you must create a repository, then make the repository a template. For more information about creating a repository, see "[Creating a new repository](/articles/creating-a-new-repository)."
-After you make your repository a template, anyone with access to the repository can generate a new repository with the same directory structure and files as your default branch.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %} They can also choose to include all the other branches in your repository.{% endif %} For more information, see "[Creating a repository from a template](/articles/creating-a-repository-from-a-template)."
+After you make your repository a template, anyone with access to the repository can generate a new repository with the same directory structure and files as your default branch.{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.20" %} They can also choose to include all the other branches in your repository.{% endif %} For more information, see "[Creating a repository from a template](/articles/creating-a-repository-from-a-template)."
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-settings %}
-3. Select **Template repository**.
+1. Select **Template repository**.
diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-an-issues-only-repository.md b/content/github/creating-cloning-and-archiving-repositories/creating-an-issues-only-repository.md
index 446cc09af424..29b1a39280de 100644
--- a/content/github/creating-cloning-and-archiving-repositories/creating-an-issues-only-repository.md
+++ b/content/github/creating-cloning-and-archiving-repositories/creating-an-issues-only-repository.md
@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
1. Create a **private** repository to host the source code from your project.
diff --git a/content/github/creating-cloning-and-archiving-repositories/duplicating-a-repository.md b/content/github/creating-cloning-and-archiving-repositories/duplicating-a-repository.md
index a68e3749e8e7..bff96eedc7c9 100644
--- a/content/github/creating-cloning-and-archiving-repositories/duplicating-a-repository.md
+++ b/content/github/creating-cloning-and-archiving-repositories/duplicating-a-repository.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Before you can duplicate a repository and push to your new copy, or _mirror_, of the repository, you must [create the new repository](/articles/creating-a-new-repository) on {% data variables.product.product_location %}. In these examples, `exampleuser/new-repository` or `exampleuser/mirrored` are the mirrors.
diff --git a/content/github/creating-cloning-and-archiving-repositories/error-remote-head-refers-to-nonexistent-ref-unable-to-checkout.md b/content/github/creating-cloning-and-archiving-repositories/error-remote-head-refers-to-nonexistent-ref-unable-to-checkout.md
index d027c119f891..f1854f8be8ff 100644
--- a/content/github/creating-cloning-and-archiving-repositories/error-remote-head-refers-to-nonexistent-ref-unable-to-checkout.md
+++ b/content/github/creating-cloning-and-archiving-repositories/error-remote-head-refers-to-nonexistent-ref-unable-to-checkout.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Detecting this error is simple; Git will warn you when you try to clone the repository:
diff --git a/content/github/creating-cloning-and-archiving-repositories/error-repository-not-found.md b/content/github/creating-cloning-and-archiving-repositories/error-repository-not-found.md
index 02c63ba3b360..55b0e571ce69 100644
--- a/content/github/creating-cloning-and-archiving-repositories/error-repository-not-found.md
+++ b/content/github/creating-cloning-and-archiving-repositories/error-repository-not-found.md
@@ -1,11 +1,12 @@
---
title: 'Error: Repository not found'
-intro: '{% if currentVersion == "free-pro-team@latest" %}If you see this error when cloning a repository, it means that the repository does not exist or you do not have permission to access it. There are a few solutions to this error, depending on the cause.{% else %}If you see this error when cloning a repository, it means that the repository does not exist, you do not have permission to access it, or your GitHub Enterprise instance is in private mode. There are a few solutions to this error, depending on the cause.{% endif %}'
+intro: '{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" %}If you see this error when cloning a repository, it means that the repository does not exist or you do not have permission to access it.{% else %}If you see this error when cloning a repository, it means that the repository does not exist, you do not have permission to access it, or {% data variables.product.product_location %} is in private mode.{% endif %} There are a few solutions to this error, depending on the cause.'
redirect_from:
- /articles/error-repository-not-found
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Check your spelling
@@ -43,12 +44,10 @@ If the repository belongs to an organization and you're using an SSH key generat
For more information, see [Adding a new SSH key to your GitHub account](/articles/adding-a-new-ssh-key-to-your-github-account).
-{% if currentVersion != "free-pro-team@latest" %}
-
+{% if enterpriseServerVersions contains currentVersion %}
### Check if your instance is in private mode
If your site administrator has enabled private mode on your GitHub Enterprise instance, anonymous clones over `git://` will be disabled. If you are unable to clone a repository, contact your site administrator.
-
{% endif %}
### Check that the repository really exists
diff --git a/content/github/creating-cloning-and-archiving-repositories/https-cloning-errors.md b/content/github/creating-cloning-and-archiving-repositories/https-cloning-errors.md
index 5dbc98f75bcb..0ed3fc6791ec 100644
--- a/content/github/creating-cloning-and-archiving-repositories/https-cloning-errors.md
+++ b/content/github/creating-cloning-and-archiving-repositories/https-cloning-errors.md
@@ -10,6 +10,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Here's an example of an HTTPS error you might receive:
@@ -72,7 +73,7 @@ When prompted for a username and password, make sure you use an account that has
{% tip %}
-**Tip**: If you don't want to enter your credentials every time you interact with the remote repository, you can turn on [credential caching](/github/using-git/caching-your-github-credentials-in-git).
+**Tip**: If you don't want to enter your credentials every time you interact with the remote repository, you can turn on [credential caching](/github/using-git/caching-your-github-credentials-in-git). If you are already using credential caching, please make sure that your computer has the correct credentials cached. Incorrect or out of date credentials will cause authentication to fail.
{% endtip %}
diff --git a/content/github/creating-cloning-and-archiving-repositories/index.md b/content/github/creating-cloning-and-archiving-repositories/index.md
index 41fc0849515f..c3f6d3e54dd0 100644
--- a/content/github/creating-cloning-and-archiving-repositories/index.md
+++ b/content/github/creating-cloning-and-archiving-repositories/index.md
@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/creating-cloning-and-archiving-repositories/licensing-a-repository.md b/content/github/creating-cloning-and-archiving-repositories/licensing-a-repository.md
index 1e702964b182..91371047eaf1 100644
--- a/content/github/creating-cloning-and-archiving-repositories/licensing-a-repository.md
+++ b/content/github/creating-cloning-and-archiving-repositories/licensing-a-repository.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Choosing the right license
diff --git a/content/github/creating-cloning-and-archiving-repositories/limits-for-viewing-content-and-diffs-in-a-repository.md b/content/github/creating-cloning-and-archiving-repositories/limits-for-viewing-content-and-diffs-in-a-repository.md
index fc160231c600..0a5310093a9e 100644
--- a/content/github/creating-cloning-and-archiving-repositories/limits-for-viewing-content-and-diffs-in-a-repository.md
+++ b/content/github/creating-cloning-and-archiving-repositories/limits-for-viewing-content-and-diffs-in-a-repository.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Most of the limits below affect both {% data variables.product.product_name %} and the API.
diff --git a/content/github/developing-online-with-codespaces/configuring-codespaces-for-your-project.md b/content/github/developing-online-with-codespaces/configuring-codespaces-for-your-project.md
index 9b692c800fb6..bae90e2db4cf 100644
--- a/content/github/developing-online-with-codespaces/configuring-codespaces-for-your-project.md
+++ b/content/github/developing-online-with-codespaces/configuring-codespaces-for-your-project.md
@@ -61,7 +61,6 @@ You can use configuration keys supported by {% data variables.product.prodname_c
- `settings`
- `extensions`
- `forwardPorts`
-- `devPort`
- `postCreateCommand`
#### Docker, Dockerfile, or image settings
@@ -73,13 +72,9 @@ You can use configuration keys supported by {% data variables.product.prodname_c
- `remoteEnv`
- `containerUser`
- `remoteUser`
-- `updateRemoteUserUID`
- `mounts`
-- `workspaceMount`
-- `workspaceFolder`
- `runArgs`
- `overrideCommand`
-- `shutdownAction`
- `dockerComposeFile`
For more information about the available settings for `devcontainer.json`, see [devcontainer.json reference](https://aka.ms/vscode-remote/devcontainer.json) in the {% data variables.product.prodname_vscode %} documentation.
diff --git a/content/github/developing-online-with-codespaces/personalizing-codespaces-for-your-account.md b/content/github/developing-online-with-codespaces/personalizing-codespaces-for-your-account.md
index 155e958d021a..e157b686f597 100644
--- a/content/github/developing-online-with-codespaces/personalizing-codespaces-for-your-account.md
+++ b/content/github/developing-online-with-codespaces/personalizing-codespaces-for-your-account.md
@@ -32,7 +32,7 @@ If none of these files are found, then any files or folders in `dotfiles` starti
Any changes to your `dotfiles` repository will apply only to each new codespace, and do not affect any existing codespace.
-For more information, see [Personalizing](https://docs.microsoft.com/en-us/visualstudio/online/reference/personalizing) in the {% data variables.product.prodname_vscode %} documentation.
+For more information, see [Personalizing](https://docs.microsoft.com/visualstudio/online/reference/personalizing) in the {% data variables.product.prodname_vscode %} documentation.
{% note %}
diff --git a/content/github/extending-github/about-webhooks.md b/content/github/extending-github/about-webhooks.md
index 51dd07f0f6d2..d37ecb1b53f3 100644
--- a/content/github/extending-github/about-webhooks.md
+++ b/content/github/extending-github/about-webhooks.md
@@ -9,6 +9,7 @@ intro: Webhooks provide a way for notifications to be delivered to an external w
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% tip %}
diff --git a/content/github/extending-github/getting-started-with-the-api.md b/content/github/extending-github/getting-started-with-the-api.md
index c2c7b0d9a09b..ea7eccfeb110 100644
--- a/content/github/extending-github/getting-started-with-the-api.md
+++ b/content/github/extending-github/getting-started-with-the-api.md
@@ -5,6 +5,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
To automate common tasks, back up your data, or create integrations that extend {% data variables.product.product_name %}, you can use the {% data variables.product.product_name %} API.
diff --git a/content/github/extending-github/git-automation-with-oauth-tokens.md b/content/github/extending-github/git-automation-with-oauth-tokens.md
index bdd15c3b9fc8..74c38e3c299d 100644
--- a/content/github/extending-github/git-automation-with-oauth-tokens.md
+++ b/content/github/extending-github/git-automation-with-oauth-tokens.md
@@ -8,6 +8,7 @@ intro: 'You can use OAuth tokens to interact with {% data variables.product.prod
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Step 1: Get an OAuth token
diff --git a/content/github/extending-github/index.md b/content/github/extending-github/index.md
index 3531b949408b..be6bb7646630 100644
--- a/content/github/extending-github/index.md
+++ b/content/github/extending-github/index.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning.md
index af2300e7a3c5..0cc08d5b3c84 100644
--- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning.md
+++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning.md
@@ -48,7 +48,7 @@ By default, the {% data variables.product.prodname_codeql_workflow %} uses the `
#### Scanning pull requests
-The default {% data variables.product.prodname_codeql_workflow %} uses the `pull_request` event to trigger a code scan on the `HEAD` commit of a pull request against the default branch. {% if currentVersion ver_gt "enterprise-server@2.21" %}The `pull_request` event is not triggered if the pull request was opened from a private fork.{% else %}If a pull request is from a private fork, the `pull_request` event will only be triggered if you've selected the "Run workflows from fork pull requests" option in the repository settings. For more information, see "[Disabling or limiting {% data variables.product.prodname_actions %} for a repository](/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository#enabling-workflows-for-private-repository-forks)."{% endif %}
+The default {% data variables.product.prodname_codeql_workflow %} uses the `pull_request` event to trigger a code scan on pull requests targeted against the default branch. {% if currentVersion ver_gt "enterprise-server@2.21" %}The `pull_request` event is not triggered if the pull request was opened from a private fork.{% else %}If a pull request is from a private fork, the `pull_request` event will only be triggered if you've selected the "Run workflows from fork pull requests" option in the repository settings. For more information, see "[Disabling or limiting {% data variables.product.prodname_actions %} for a repository](/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository#enabling-workflows-for-private-repository-forks)."{% endif %}
For more information about the `pull_request` event, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestbranchestags)."
@@ -150,8 +150,6 @@ jobs:
steps:
- name: Checkout repository
uses: actions/checkout@v2
- with:
- fetch-depth: 2
- name: Set up Python
uses: actions/setup-python@v2
with:
@@ -165,8 +163,6 @@ jobs:
# Set the `CODEQL-PYTHON` environment variable to the Python executable
# that includes the dependencies
echo "::set-env name=CODEQL_PYTHON::$(which python)"
- - run: git checkout HEAD^2
- if: ${{ github.event_name == 'pull_request' }}
- name: Initialize CodeQL
uses: github/codeql-action/init@v1
with:
diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-the-codeql-workflow-for-compiled-languages.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-the-codeql-workflow-for-compiled-languages.md
index 62932f450f0d..ee17b9a2abb0 100644
--- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-the-codeql-workflow-for-compiled-languages.md
+++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-the-codeql-workflow-for-compiled-languages.md
@@ -3,7 +3,7 @@ title: Configuring the CodeQL workflow for compiled languages
shortTitle: Configuring for compiled languages
intro: 'You can configure how {% data variables.product.prodname_dotcom %} uses the {% data variables.product.prodname_codeql_workflow %} to scan code written in compiled languages for vulnerabilities and errors.'
product: '{% data reusables.gated-features.code-scanning %}'
-permissions: 'People with write permissions to a repository can configure {% data variables.product.prodname_code_scanning %} for the repository.'
+permissions: 'If you have write permissions to a repository, you can configure {% data variables.product.prodname_code_scanning %} for that repository.'
redirect_from:
- /github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning-for-compiled-languages
- /github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-the-codeql-action-for-compiled-languages
diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/enabling-code-scanning-for-a-repository.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/enabling-code-scanning-for-a-repository.md
index f4cabb2462b7..d44cd2e445b5 100644
--- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/enabling-code-scanning-for-a-repository.md
+++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/enabling-code-scanning-for-a-repository.md
@@ -3,7 +3,7 @@ title: Enabling code scanning for a repository
shortTitle: Enabling code scanning
intro: 'You can enable {% data variables.product.prodname_code_scanning %} for your project''s repository.'
product: '{% data reusables.gated-features.code-scanning %}'
-permissions: 'People with write permissions to a repository can enable {% data variables.product.prodname_code_scanning %} for the repository.'
+permissions: 'If you have write permissions to a repository, you can enable {% data variables.product.prodname_code_scanning %} for that repository.'
redirect_from:
- /github/managing-security-vulnerabilities/configuring-automated-code-scanning
- /github/finding-security-vulnerabilities-and-errors-in-your-code/enabling-code-scanning
@@ -42,7 +42,7 @@ You decide how you generate {% data variables.product.prodname_code_scanning %}
8. Click **Commit new file** or **Propose new file**.
-In the default {% data variables.product.prodname_codeql_workflow %}, {% data variables.product.prodname_code_scanning %} is configured to analyze your code each time you either push a change to the default branch or any protected branches, or raise a pull request against the default branch or any protected branches. As a result, {% data variables.product.prodname_code_scanning %} will now commence.
+In the default {% data variables.product.prodname_codeql_workflow %}, {% data variables.product.prodname_code_scanning %} is configured to analyze your code each time you either push a change to the default branch or any protected branches, or raise a pull request against the default branch. As a result, {% data variables.product.prodname_code_scanning %} will now commence.
### Viewing the logging output from {% data variables.product.prodname_code_scanning %}
@@ -90,7 +90,7 @@ After {% data variables.product.prodname_code_scanning %} has analyzed the code
There are other situations where there may be no analysis for the latest commit to the base branch for a pull request. These include:
-* The pull request has been raised against a branch other than the default branch or a protected branch, and this branch hasn't been analyzed.
+* The pull request has been raised against a branch other than the default branch, and this branch hasn't been analyzed.
To check whether a branch has been scanned, go to the {% data variables.product.prodname_code_scanning_capc %} page, click the **Branch** drop-down and select the relevant branch.
diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/index.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/index.md
index 381f829b52b0..f5742510b70a 100644
--- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/index.md
+++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/index.md
@@ -1,5 +1,6 @@
---
title: Finding security vulnerabilities and errors in your code
+shortTitle: Finding vulnerabilities and coding errors
product: '{% data reusables.gated-features.code-scanning %}'
redirect_from:
- /github/managing-security-vulnerabilities/finding-security-vulnerabilities-in-your-projects-code
diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository.md
index 6a118dcce60b..4dd31e54ebf4 100644
--- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository.md
+++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository.md
@@ -1,9 +1,9 @@
---
title: Managing code scanning alerts for your repository
shortTitle: Managing alerts
-intro: 'You can view, fix, dismiss, or delete alerts for potential vulnerabilities or errors in your project''s code.'
+intro: 'You can view, fix, {% if currentVersion == "enterprise-server@2.22" %}or close{% else %}dismiss, or delete{% endif %} alerts for potential vulnerabilities or errors in your project''s code.'
product: '{% data reusables.gated-features.code-scanning %}'
-permissions: 'People with write permission to a repository can manage {% data variables.product.prodname_code_scanning %} alerts for the repository.'
+permissions: 'If you have write permission to a repository you can manage {% data variables.product.prodname_code_scanning %} alerts for that repository.'
versions:
free-pro-team: '*'
enterprise-server: '>=2.22'
@@ -28,7 +28,7 @@ Each alert highlights a problem with the code and the name of the tool that iden
If you enable {% data variables.product.prodname_code_scanning %} using {% data variables.product.prodname_codeql %}, this can also detect data-flow problems in your code. Data-flow analysis finds potential security issues in code, such as: using data insecurely, passing dangerous arguments to functions, and leaking sensitive information.
-When {% data variables.product.prodname_code_scanning_capc %} reports data-flow alerts, {% data variables.product.prodname_dotcom %} shows you how data moves through the code. {% data variables.product.prodname_code_scanning_capc %} allows you to identify the areas of your code that leak sensitive information, and that could be the entry point for attacks by malicious users.
+When {% data variables.product.prodname_code_scanning %} reports data-flow alerts, {% data variables.product.prodname_dotcom %} shows you how data moves through the code. {% data variables.product.prodname_code_scanning_capc %} allows you to identify the areas of your code that leak sensitive information, and that could be the entry point for attacks by malicious users.
### Viewing an alert
@@ -37,7 +37,7 @@ Anyone with read permission for a repository can see {% data variables.product.p
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-security %}
{% data reusables.repositories.sidebar-code-scanning-alerts %}
-1. Under "{% data variables.product.prodname_code_scanning %}," click the alert you'd like to explore.
+1. Under "{% data variables.product.prodname_code_scanning_capc %}," click the alert you'd like to explore.
1. Optionally, if the alert highlights a problem with data flow, click **Show paths** to display the path from the data source to the sink where it's used.
@@ -48,15 +48,23 @@ Anyone with read permission for a repository can see {% data variables.product.p
Anyone with write permission for a repository can fix an alert by committing a correction to the code. If the repository has {% data variables.product.prodname_code_scanning %} scheduled to run on pull requests, it's best to raise a pull request with your correction. This will trigger {% data variables.product.prodname_code_scanning %} analysis of the changes and test that your fix doesn't introduce any new problems. For more information, see "[Configuring {% data variables.product.prodname_code_scanning %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning)" and "[Triaging {% data variables.product.prodname_code_scanning %} alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests)."
-If you have write permission for a repository, you can view fixed alerts by viewing the summary of alerts and clicking **Closed**. For more information, see "[Viewing an alert](#viewing-an-alert)." The "Closed" list shows fixed alerts and alerts that users have dismissed.
+If you have write permission for a repository, you can view fixed alerts by viewing the summary of alerts and clicking **Closed**. For more information, see "[Viewing an alert](#viewing-an-alert)." The "Closed" list shows fixed alerts and alerts that users have {% if currentVersion == "enterprise-server@2.22" %}closed{% else %}dismissed{% endif %}.
Alerts may be fixed in one branch but not in another. You can use the "Branch" drop-down menu, on the summary of alerts, to check whether an alert is fixed in a particular branch.
+{% if currentVersion == "enterprise-server@2.22" %}
+
+### Closing an alert
+
+Closing an alert is a way to resolve an alert that you don't think needs to be fixed. {% data reusables.code-scanning.close-alert-examples %}
+
+{% else %}
+
### Dismissing or deleting alerts
-There are two ways of closing an alert. You can fix the problem in the code, or you can dismiss the alert. Alternatively, you can delete alerts. Deleting alerts is useful in situations where you have enabled a {% data variables.product.prodname_code_scanning %} tool and then decided to remove it, or where you have enabled {% data variables.product.prodname_codeql %} analysis with a larger set of queries than you want to continue using, and you've then removed some queries from the tool. In both cases, deleting alerts allows you to clean up your {% data variables.product.prodname_code_scanning %} results. You can delete alerts from the summary list within the **Security** tab.
+There are two ways of closing an alert. You can fix the problem in the code, or you can dismiss the alert. Alternatively, if you have admin permissions for the repository, you can delete alerts. Deleting alerts is useful in situations where you have enabled a {% data variables.product.prodname_code_scanning %} tool and then decided to remove it, or where you have enabled {% data variables.product.prodname_codeql %} analysis with a larger set of queries than you want to continue using, and you've then removed some queries from the tool. In both cases, deleting alerts allows you to clean up your {% data variables.product.prodname_code_scanning %} results. You can delete alerts from the summary list within the **Security** tab.
Dismissing an alert is a way of closing an alert that you don't think needs to be fixed. {% data reusables.code-scanning.close-alert-examples %} You can dismiss alerts from {% data variables.product.prodname_code_scanning %} annotations in code, or from the summary list within the **Security** tab.
@@ -77,11 +85,21 @@ When you delete an alert:
To dismiss or delete alerts:
+{% endif %}
+
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-security %}
{% data reusables.repositories.sidebar-code-scanning-alerts %}
+{% if currentVersion == "enterprise-server@2.22" %}
+{% data reusables.code-scanning.click-alert-in-list %}
+1. Select the **Close** drop-down menu and click a reason for closing the alert.
+ 
+
+{% data reusables.code-scanning.false-positive-fix-codeql %}
-1. If you want to delete alerts for this {% data variables.product.prodname_code_scanning %} tool, select some or all of the check boxes and click **Delete**.
+{% else %}
+
+1. If you have admin permissions for the repository, and you want to delete alerts for this {% data variables.product.prodname_code_scanning %} tool, select some or all of the check boxes and click **Delete**.
@@ -104,6 +122,8 @@ To dismiss or delete alerts:
If a project has multiple alerts that you want to dismiss for the same reason, you can bulk dismiss them from the summary of alerts. Typically, you'll want to filter the list and then dismiss all of the matching alerts. For example, you might want to dismiss all of the current alerts in the project that have been tagged for a particular Common Weakness Enumeration (CWE) vulnerability.
+{% endif %}
+
### Further reading
- "[Triaging {% data variables.product.prodname_code_scanning %} alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests)"
diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-a-container.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-a-container.md
index 5e2f6c6598f8..d32e59c2c270 100644
--- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-a-container.md
+++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-a-container.md
@@ -1,5 +1,5 @@
---
-title: 'Running CodeQL code scanning in a container'
+title: Running CodeQL code scanning in a container
shortTitle: '{% data variables.product.prodname_code_scanning_capc %} in a container'
intro: 'You can run {% data variables.product.prodname_code_scanning %} in a container by ensuring that all processes run in the same container.'
product: '{% data reusables.gated-features.code-scanning %}'
@@ -66,4 +66,4 @@ jobs:
make
- name: Perform {% data variables.product.prodname_codeql %} Analysis
uses: github/codeql-action/analyze@v1
-```
\ No newline at end of file
+```
diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-your-ci-system.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-your-ci-system.md
index 5b7faf0e62b0..30b3bdd81f77 100644
--- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-your-ci-system.md
+++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-your-ci-system.md
@@ -9,6 +9,7 @@ versions:
free-pro-team: '*'
enterprise-server: '>=2.22'
---
+
{% data reusables.code-scanning.beta-codeql-runner %}
{% data reusables.code-scanning.beta %}
@@ -65,7 +66,7 @@ The options for providing access to the {% data variables.product.prodname_codeq
1. Allow the CI servers access to {% data variables.product.prodname_dotcom_the_website %} so that the {% data variables.product.prodname_codeql_runner %} can download the bundle automatically.
1. Manually download/extract the bundle, store it with other central resources, and use the `--codeql-path` flag to specify the location of the bundle in calls to initialize the {% data variables.product.prodname_codeql_runner %}.
-{% if currentVersion != "free-pro-team@latest" %}
+{% if enterpriseServerVersions contains currentVersion %}
1. You can mirror the `github/codeql-action` repository on {% data variables.product.product_location %}. Unless you specify the `--codeql-path` flag, the runner automatically checks for the bundle in this location and on {% data variables.product.prodname_dotcom_the_website %}.{% endif %}
### Calling the {% data variables.product.prodname_codeql_runner %}
@@ -75,7 +76,7 @@ You should call the {% data variables.product.prodname_codeql_runner %} from the
1. `init` required to initialize the runner and create a {% data variables.product.prodname_codeql %} database for each language to be analyzed. These databases are populated and analyzed by subsequent commands.
1. `analyze` required to populate the {% data variables.product.prodname_codeql %} databases, analyze them, and upload results to {% data variables.product.product_location %}.
-For both commands, you must specify the URL of {% data variables.product.product_location %}, the repository *OWNER/NAME*, and the GitHub Apps or personal access token to use for authentication. You also need to specify the location of the CodeQL bundle unless the CI server has access to download it directly from the `github/codeql-action` repository on {% data variables.product.prodname_dotcom_the_website %}{% if currentVersion != "free-pro-team@latest" %} or mirrored on {% data variables.product.product_location %}{% endif %}.
+For both commands, you must specify the URL of {% data variables.product.product_location %}, the repository *OWNER/NAME*, and the GitHub Apps or personal access token to use for authentication. You also need to specify the location of the CodeQL bundle unless the CI server has access to download it directly from the `github/codeql-action` repository on {% data variables.product.prodname_dotcom_the_website %}{% if enterpriseServerVersions contains currentVersion %} or mirrored on {% data variables.product.product_location %}{% endif %}.
You can configure where the {% data variables.product.prodname_codeql_runner %} stores the CodeQL bundle for future analysis on a server using the `--tools-dir` flag and where it stores temporary files during analysis using `--temp-dir` .
@@ -109,7 +110,7 @@ This example runs {% data variables.product.prodname_codeql %} analysis on a Lin
> Successfully uploaded results
```
-The server has access to download the {% data variables.product.prodname_codeql %} bundle directly from the `github/codeql-action` repository on {% data variables.product.prodname_dotcom_the_website %}{% if currentVersion != "free-pro-team@latest" %} or mirrored on {% data variables.product.product_location %}{% endif %}, so there is no need to use the `--codeql-path` flag. When the analysis is complete, the {% data variables.product.prodname_codeql_runner %} uploads the results to the {% data variables.product.prodname_code_scanning %} view. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository)."
+The server has access to download the {% data variables.product.prodname_codeql %} bundle directly from the `github/codeql-action` repository on {% data variables.product.prodname_dotcom_the_website %}{% if enterpriseServerVersions contains currentVersion %} or mirrored on {% data variables.product.product_location %}{% endif %}, so there is no need to use the `--codeql-path` flag. When the analysis is complete, the {% data variables.product.prodname_codeql_runner %} uploads the results to the {% data variables.product.prodname_code_scanning %} view. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository)."
#### Compiled language example
diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/sarif-support-for-code-scanning.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/sarif-support-for-code-scanning.md
index ab7f73887242..b43bd29294a5 100644
--- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/sarif-support-for-code-scanning.md
+++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/sarif-support-for-code-scanning.md
@@ -36,6 +36,8 @@ If you upload a SARIF file without fingerprint data using the `/code-scanning/sa
### Validating your SARIF file
+
+
You can check a SARIF file is compatible with {% data variables.product.prodname_code_scanning %} by testing it against the {% data variables.product.prodname_dotcom %} ingestion rules. For more information, visit the [Microsoft SARIF validator](https://sarifweb.azurewebsites.net/).
### Supported SARIF output file properties
diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests.md
index 2d8be1c7dcd3..0013b8b96bb9 100644
--- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests.md
+++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests.md
@@ -3,7 +3,7 @@ title: Triaging code scanning alerts in pull requests
shortTitle: Triaging alerts in pull requests
intro: 'When {% data variables.product.prodname_code_scanning %} identifies a problem in a pull request, you can review the highlighted code and resolve the alert.'
product: '{% data reusables.gated-features.code-scanning %}'
-permissions: 'People with write permission to a repository can resolve {% data variables.product.prodname_code_scanning %} alerts.'
+permissions: 'If you have write permission to a repository, you can resolve {% data variables.product.prodname_code_scanning %} alerts for that repository.'
versions:
free-pro-team: '*'
enterprise-server: '>=2.22'
@@ -13,9 +13,9 @@ versions:
### About {% data variables.product.prodname_code_scanning %} results on pull requests
-In repositories where {% data variables.product.prodname_code_scanning %} is configured as a pull request check, {% data variables.product.prodname_code_scanning %} checks the code in the pull request. By default, this is limited to pull requests that target the default branch or protected branches, but you can change this configuration within {% data variables.product.prodname_actions %} or in a third-party CI/CD system. If merging the changes would introduce new {% data variables.product.prodname_code_scanning %} alerts to the target branch, these are reported as check results in the pull request. The alerts are also shown as annotations in the **Files changed** tab of the pull request. If you have write permission for the repository, you can see any existing {% data variables.product.prodname_code_scanning %} alerts on the **Security** tab. For information about repository alerts, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository)."
+In repositories where {% data variables.product.prodname_code_scanning %} is configured as a pull request check, {% data variables.product.prodname_code_scanning %} checks the code in the pull request. By default, this is limited to pull requests that target the default branch, but you can change this configuration within {% data variables.product.prodname_actions %} or in a third-party CI/CD system. If merging the changes would introduce new {% data variables.product.prodname_code_scanning %} alerts to the target branch, these are reported as check results in the pull request. The alerts are also shown as annotations in the **Files changed** tab of the pull request. If you have write permission for the repository, you can see any existing {% data variables.product.prodname_code_scanning %} alerts on the **Security** tab. For information about repository alerts, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository)."
-If {% data variables.product.prodname_code_scanning %} has any results with a severity of `error`, the check fails and the error is reported in the check results. If all the results found by {% data variables.product.prodname_code_scanning %} have lower severities, the alerts are treated as warnings or notices and the check succeeds. If your pull request targets a protected branch, and the repository owner has configured required status checks, then you must either fix or dismiss all error alerts before the pull request can be merged. For more information, see "[About required status checks](/github/administering-a-repository/about-required-status-checks)."
+If {% data variables.product.prodname_code_scanning %} has any results with a severity of `error`, the check fails and the error is reported in the check results. If all the results found by {% data variables.product.prodname_code_scanning %} have lower severities, the alerts are treated as warnings or notices and the check succeeds. If your pull request targets a protected branch that has been enabled for {% data variables.product.prodname_code_scanning %}, and the repository owner has configured required status checks, then you must either fix or {% if currentVersion == "enterprise-server@2.22" %}close{% else %}dismiss{% endif %} all error alerts before the pull request can be merged. For more information, see "[About required status checks](/github/administering-a-repository/about-required-status-checks)."
@@ -39,10 +39,18 @@ In the detailed view for an alert, some {% data variables.product.prodname_code_
-### Fixing an alert on your pull request
+### {% if currentVersion == "enterprise-server@2.22" %}Resolving{% else %}Fixing{% endif %} an alert on your pull request
Anyone with write permission for a repository can fix a {% data variables.product.prodname_code_scanning %} alert that's identified on a pull request. If you commit changes to the pull request this triggers a new run of the pull request checks. If your changes fix the problem, the alert is closed and the annotation removed.
+{% if currentVersion == "enterprise-server@2.22" %}
+
+If you don't think that an alert needs to be fixed, you can close the alert manually. {% data reusables.code-scanning.close-alert-examples %} The **Close** button is available in annotations and in the alerts view if you have write permission for the repository.
+
+{% data reusables.code-scanning.false-positive-fix-codeql %}
+
+{% else %}
+
### Dismissing an alert on your pull request
An alternative way of closing an alert is to dismiss it. You can dismiss an alert if you don't think it needs to be fixed. {% data reusables.code-scanning.close-alert-examples %} If you have write permission for the repository, the **Dismiss** button is available in code annotations and in the alerts summary. When you click **Dismiss** you will be prompted to choose a reason for closing the alert.
@@ -53,4 +61,6 @@ An alternative way of closing an alert is to dismiss it. You can dismiss an aler
{% data reusables.code-scanning.false-positive-fix-codeql %}
-For more information about dismissing alerts, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#dismissing-or-deleting-alerts)."
\ No newline at end of file
+For more information about dismissing alerts, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#dismissing-or-deleting-alerts)."
+
+{% endif %}
\ No newline at end of file
diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-the-codeql-workflow.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-the-codeql-workflow.md
index 310a10b23c1c..9dd5a07a9074 100644
--- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-the-codeql-workflow.md
+++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-the-codeql-workflow.md
@@ -126,4 +126,4 @@ If you are analyzing code written in Python, you may see different results depen
On GitHub-hosted runners that use Linux, the {% data variables.product.prodname_codeql_workflow %} tries to install and analyze Python dependencies, which could lead to more results. To disable the auto-install, add `setup-python-dependencies: false` to the "Initialize CodeQL" step of the workflow. For more information about configuring the analysis of Python dependencies, see "[Analyzing Python dependencies](/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#analyzing-python-dependencies)."
-{% endif %}
\ No newline at end of file
+{% endif %}
diff --git a/content/github/getting-started-with-github/access-permissions-on-github.md b/content/github/getting-started-with-github/access-permissions-on-github.md
index 614cda294151..b2483b1986ea 100644
--- a/content/github/getting-started-with-github/access-permissions-on-github.md
+++ b/content/github/getting-started-with-github/access-permissions-on-github.md
@@ -9,6 +9,7 @@ intro: 'While you can grant read/write access to collaborators on a personal rep
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Personal user accounts
@@ -27,7 +28,7 @@ Organization members can have *owner*{% if currentVersion == "free-pro-team@late
### Enterprise accounts
-*Enterprise owners* have ultimate power over the enterprise account and can take every action in the enterprise account. *Billing managers* can manage your enterprise account's billing settings. Members and outside collaborators of organizations owned by your enterprise account are automatically members of the enterprise account, although they have no access to the enterprise account itself or its settings. For more information, see "[Roles for an enterprise account](/articles/roles-for-an-enterprise-account)."
+*Enterprise owners* have ultimate power over the enterprise account and can take every action in the enterprise account. *Billing managers* can manage your enterprise account's billing settings. Members and outside collaborators of organizations owned by your enterprise account are automatically members of the enterprise account, although they have no access to the enterprise account itself or its settings. For more information, see "[Roles in an enterprise](/github/setting-up-and-managing-your-enterprise/roles-in-an-enterprise)."
{% data reusables.gated-features.enterprise-accounts %}
diff --git a/content/github/getting-started-with-github/be-social.md b/content/github/getting-started-with-github/be-social.md
index 4ec38ef2713e..d326445068bf 100644
--- a/content/github/getting-started-with-github/be-social.md
+++ b/content/github/getting-started-with-github/be-social.md
@@ -7,6 +7,7 @@ intro: 'You can interact with people, repositories, and organizations on {% data
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
To learn about accessing your personal dashboard, see "[About your personal dashboard](/articles/about-your-personal-dashboard)."
@@ -21,7 +22,7 @@ Click **Follow** on a person's profile page to follow them.
### Watching a repository
-You can watch a repository to receive notifications for new pull requests and issues. When the owner updates the repository, you'll see the changes in your personal dashboard. For more information see {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}"[Viewing your subscriptions](/github/managing-subscriptions-and-notifications-on-github/viewing-your-subscriptions){% else %}"[Watching and unwatching repositories](/github/receiving-notifications-about-activity-on-github/watching-and-unwatching-repositories){% endif %}."
+You can watch a repository to receive notifications for new pull requests and issues. When the owner updates the repository, you'll see the changes in your personal dashboard. For more information see {% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.20" %}"[Viewing your subscriptions](/github/managing-subscriptions-and-notifications-on-github/viewing-your-subscriptions){% else %}"[Watching and unwatching repositories](/github/receiving-notifications-about-activity-on-github/watching-and-unwatching-repositories){% endif %}."
Click **Watch** at the top of a repository to watch it.
diff --git a/content/github/getting-started-with-github/create-a-repo.md b/content/github/getting-started-with-github/create-a-repo.md
index 086e99f8d784..12537a730ac5 100644
--- a/content/github/getting-started-with-github/create-a-repo.md
+++ b/content/github/getting-started-with-github/create-a-repo.md
@@ -7,6 +7,7 @@ intro: 'To put your project up on {% data variables.product.product_location %},
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
You can store a variety of projects in {% data variables.product.product_name %} repositories, including open source projects. With [open source projects](http://opensource.org/about), you can share code to make better, more reliable software.
@@ -28,7 +29,7 @@ You can store a variety of projects in {% data variables.product.product_name %}
Congratulations! You've successfully created your first repository, and initialized it with a *README* file.
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %}
{% tip %}
**Tip**: You can also create repositories using the {% data variables.product.prodname_cli %}. For more information, see "[`gh repo create`](https://cli.github.com/manual/gh_repo_create)" in the {% data variables.product.prodname_cli %} documentation.
diff --git a/content/github/getting-started-with-github/exploring-projects-on-github.md b/content/github/getting-started-with-github/exploring-projects-on-github.md
index 0b272a1e6114..796214bfb518 100644
--- a/content/github/getting-started-with-github/exploring-projects-on-github.md
+++ b/content/github/getting-started-with-github/exploring-projects-on-github.md
@@ -10,5 +10,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github.md b/content/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github.md
index a609dda17d90..d1b5e3c6c9a4 100644
--- a/content/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github.md
+++ b/content/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github.md
@@ -32,14 +32,14 @@ Some open-source projects provide mirrors on {% data variables.product.prodname_
Here are a few prominent repositories that are mirrored on {% data variables.product.prodname_dotcom_the_website %}:
-- [android](https://github.com/android)
+- [Android Open Source Project](https://github.com/aosp-mirror)
- [The Apache Software Foundation](https://github.com/apache)
- [The Chromium Project](https://github.com/chromium)
-- [The Eclipse Foundation](https://github.com/eclipse)
+- [Eclipse Foundation](https://github.com/eclipse)
- [The FreeBSD Project](https://github.com/freebsd)
-- [The Glasgow Haskell Compiler](https://github.com/ghc)
+- [Glasgow Haskell Compiler](https://github.com/ghc)
- [GNOME](https://github.com/GNOME)
-- [The Linux kernel source tree](https://github.com/torvalds/linux)
+- [Linux kernel source tree](https://github.com/torvalds/linux)
- [Qt](https://github.com/qt)
To set up your own mirror, you can configure [a post-receive hook](https://git-scm.com/book/en/Customizing-Git-Git-Hooks) on your official project repository to automatically push commits to a mirror repository on {% data variables.product.product_name %}.
diff --git a/content/github/getting-started-with-github/following-people.md b/content/github/getting-started-with-github/following-people.md
index a1c615b7cb2e..cbf380c4a01c 100644
--- a/content/github/getting-started-with-github/following-people.md
+++ b/content/github/getting-started-with-github/following-people.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
When you follow people, you'll see their public activity in the activity view of your news feed.{% if currentVersion == "free-pro-team@latest" %} If someone you follow stars a public repository, {% data variables.product.product_name %} may recommend the repository to you in the discovery view of your news feed.{% endif %} To follow someone, visit their profile page and click **Follow** under their profile image.
diff --git a/content/github/getting-started-with-github/fork-a-repo.md b/content/github/getting-started-with-github/fork-a-repo.md
index 6078dec82df8..4f2cec1e6b91 100644
--- a/content/github/getting-started-with-github/fork-a-repo.md
+++ b/content/github/getting-started-with-github/fork-a-repo.md
@@ -8,6 +8,7 @@ intro: A fork is a copy of a repository. Forking a repository allows you to free
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Most commonly, forks are used to either propose changes to someone else's project or to use someone else's project as a starting point for your own idea.
@@ -34,7 +35,7 @@ When creating your public repository from a fork of someone's project, make sure
{% endnote %}
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %}
{% tip %}
**Tip**: You can also fork a repository using the {% data variables.product.prodname_cli %}. For more information, see "[`gh repo fork`](https://cli.github.com/manual/gh_repo_fork)" in the {% data variables.product.prodname_cli %} documentation.
diff --git a/content/github/getting-started-with-github/git-and-github-learning-resources.md b/content/github/getting-started-with-github/git-and-github-learning-resources.md
index cadc22c5b34f..27fb88e0986d 100644
--- a/content/github/getting-started-with-github/git-and-github-learning-resources.md
+++ b/content/github/getting-started-with-github/git-and-github-learning-resources.md
@@ -8,6 +8,7 @@ intro: 'There are a lot of helpful Git and {% data variables.product.product_nam
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Using Git
diff --git a/content/github/getting-started-with-github/git-cheatsheet.md b/content/github/getting-started-with-github/git-cheatsheet.md
index 003ca4688b9b..8a236299646d 100644
--- a/content/github/getting-started-with-github/git-cheatsheet.md
+++ b/content/github/getting-started-with-github/git-cheatsheet.md
@@ -5,6 +5,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Learning all available Git commands at once can be a daunting task. Keep one of our [Git Cheat Sheets](https://services.github.com/on-demand/resources/cheatsheets/) nearby for reference. The Using Git Cheat Sheet is available in several languages. For more information, see the [resources page on the GitHub Services website](https://services.github.com/on-demand/resources/).
diff --git a/content/github/getting-started-with-github/github-cli.md b/content/github/getting-started-with-github/github-cli.md
index a436208618e1..9abdb3615951 100644
--- a/content/github/getting-started-with-github/github-cli.md
+++ b/content/github/getting-started-with-github/github-cli.md
@@ -4,6 +4,7 @@ intro: 'The {% data variables.product.prodname_cli %} is a command-line tool for
versions:
free-pro-team: '*'
enterprise-server: '>2.19'
+ github-ae: '*'
---
### About {% data variables.product.prodname_cli %}
diff --git a/content/github/getting-started-with-github/github-desktop.md b/content/github/getting-started-with-github/github-desktop.md
index 30e8b10acf6e..bce85ea84e85 100644
--- a/content/github/getting-started-with-github/github-desktop.md
+++ b/content/github/getting-started-with-github/github-desktop.md
@@ -4,6 +4,7 @@ intro: '{% data variables.product.prodname_desktop %} extends and simplifies you
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### About {% data variables.product.prodname_desktop %}
diff --git a/content/github/getting-started-with-github/github-for-mobile.md b/content/github/getting-started-with-github/github-for-mobile.md
index 44ec853d1065..a3735d167840 100644
--- a/content/github/getting-started-with-github/github-for-mobile.md
+++ b/content/github/getting-started-with-github/github-for-mobile.md
@@ -43,8 +43,9 @@ To re-enable Universal Links, long-press any {% data variables.product.prodname_
### Sharing feedback
-If you have feedback or feature requests for {% data variables.product.prodname_mobile %}, you can email us at mobilefeedback@github.com.
+If you find a bug in {% data variables.product.prodname_mobile %}, you can email us at mobilefeedback@github.com.
+You can submit feature requests or other feedback for {% data variables.product.prodname_mobile %} [on GitHub Discussions](https://github.com/github/feedback/discussions?discussions_q=category%3A%22Mobile+Feedback%22).
### Opting out of beta releases for iOS
diff --git a/content/github/getting-started-with-github/github-glossary.md b/content/github/getting-started-with-github/github-glossary.md
index 64003c73607e..a949c7a0eb35 100644
--- a/content/github/getting-started-with-github/github-glossary.md
+++ b/content/github/getting-started-with-github/github-glossary.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% for term in site.data.glossaries.external %}
diff --git a/content/github/getting-started-with-github/githubs-products.md b/content/github/getting-started-with-github/githubs-products.md
index 441315fb55b2..3735db6d8132 100644
--- a/content/github/getting-started-with-github/githubs-products.md
+++ b/content/github/getting-started-with-github/githubs-products.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data variables.product.prodname_dotcom %} offers free and paid products. You can see pricing and a full list of features for each product at <{% data variables.product.pricing_url %}>. {% data reusables.products.product-roadmap %}
@@ -83,10 +84,10 @@ In addition to the features available with {% data variables.product.prodname_te
- {% data variables.contact.enterprise_support %}. For more information, see "{% data variables.product.prodname_ghe_cloud %} support" and "{% data variables.product.prodname_ghe_cloud %} Addendum."
- 50,000 {% data variables.product.prodname_actions %} minutes
- 50GB {% data variables.product.prodname_registry %} storage
-- A service level agreement for 99.95% monthly uptime
+- A service level agreement for 99.9% monthly uptime
- The option to centrally manage policy and billing for multiple {% data variables.product.prodname_dotcom_the_website %} organizations with an enterprise account. For more information, see "About enterprise accounts."
-You can set up a trial to evaluate {% data variables.product.prodname_ghe_cloud %}. For more information, see "[Setting up a trial of {% data variables.product.prodname_ghe_cloud %}](/articles/setting-up-a-trial-of-github-enterprise-cloud)."
+You can set up a trial to evaluate {% data variables.product.prodname_ghe_cloud %}. For more information, see "Setting up a trial of {% data variables.product.prodname_ghe_cloud %}."
For more information about hosting your own instance of [{% data variables.product.prodname_ghe_server %}](https://enterprise.github.com), contact {% data variables.contact.contact_enterprise_sales %}. {% data reusables.enterprise_installation.request-a-trial %}
@@ -96,7 +97,7 @@ For more information about hosting your own instance of [{% data variables.produ
- {% data variables.contact.github_support %} {% data variables.product.premium_plus_support_plan %}
- {% data variables.product.prodname_insights %}
-- {% data variables.product.prodname_advanced_security %}{% if currentVersion == "free-pro-team@latest" %}. For more information, see "[About {% data variables.product.prodname_code_scanning %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning)" and "[About {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/about-secret-scanning) (beta)."{% endif %}{% if currentVersion != "free-pro-team@latest" and currentVersion ver_gt "enterprise-server@2.21" %}. For more information, see "[About {% data variables.product.prodname_code_scanning %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning) (beta)."{% endif %}
+- {% data variables.product.prodname_advanced_security %}{% if currentVersion == "free-pro-team@latest" %}. For more information, see "[About {% data variables.product.prodname_code_scanning %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning)" and "[About {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/about-secret-scanning) (beta)."{% endif %}{% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" %}. For more information, see "[About {% data variables.product.prodname_code_scanning %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning) (beta)."{% endif %}
- [{% data variables.product.prodname_learning %} for organizations](https://lab.github.com/organizations)
For more information about signing up for {% data variables.product.prodname_ghe_one %}, contact [{% data variables.product.product_name %}'s Sales team](https://enterprise.github.com/contact).
diff --git a/content/github/getting-started-with-github/index.md b/content/github/getting-started-with-github/index.md
index 9a08419bdd32..58792d38bcfa 100644
--- a/content/github/getting-started-with-github/index.md
+++ b/content/github/getting-started-with-github/index.md
@@ -15,6 +15,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/getting-started-with-github/keyboard-shortcuts.md b/content/github/getting-started-with-github/keyboard-shortcuts.md
index 28fe3ea08a01..a5c927908e62 100644
--- a/content/github/getting-started-with-github/keyboard-shortcuts.md
+++ b/content/github/getting-started-with-github/keyboard-shortcuts.md
@@ -9,6 +9,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
@@ -23,7 +24,7 @@ Below is a list of some of the available keyboard shortcuts.
| Keyboard shortcut | Description
|-----------|------------
|s or / | Focus the search bar. For more information, see "[About searching on {% data variables.product.company_short %}](/articles/about-searching-on-github)."
-|g n | Go to your notifications. For more information, see {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}"[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications){% else %}"[About notifications](/github/receiving-notifications-about-activity-on-github/about-notifications){% endif %}."
+|g n | Go to your notifications. For more information, see {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}"[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications){% else %}"[About notifications](/github/receiving-notifications-about-activity-on-github/about-notifications){% endif %}."
|esc | When focused on a user, issue, or pull request hovercard, closes the hovercard and refocuses on the element the hovercard is in
### Repositories
@@ -32,7 +33,7 @@ Below is a list of some of the available keyboard shortcuts.
|-----------|------------
|g c | Go to the **Code** tab
|g i | Go to the **Issues** tab. For more information, see "[About issues](/articles/about-issues)."
-|g p | Go to the **Pull requests** tab. For more information, see "[About pull requests](/articles/about-pull-requests)."{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
+|g p | Go to the **Pull requests** tab. For more information, see "[About pull requests](/articles/about-pull-requests)."{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}
|g a | Go to the **Actions** tab. For more information, see "[About Actions](/actions/getting-started-with-github-actions/about-github-actions)."{% endif %}
|g b | Go to the **Projects** tab. For more information, see "[About project boards](/articles/about-project-boards)."
|g w | Go to the **Wiki** tab. For more information, see "[About wikis](/articles/about-wikis)."
@@ -109,7 +110,7 @@ For more keyboard shortcuts, see the [CodeMirror documentation](https://codemirr
|j | Move selection down in the list
|k | Move selection up in the list
| cmd + shift + enter | Add a single comment on a pull request diff |
-| alt and click | Toggle between collapsing and expanding all outdated review comments in a pull request by holding down `alt` and clicking **Show outdated** or **Hide outdated**.|{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
+| alt and click | Toggle between collapsing and expanding all outdated review comments in a pull request by holding down `alt` and clicking **Show outdated** or **Hide outdated**.|{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}
| Click, then shift and click | Comment on multiple lines of a pull request by clicking a line number, holding shift, then clicking another line number. For more information, see "[Commenting on a pull request](/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)."|{% endif %}
### Project boards
@@ -163,7 +164,7 @@ For more keyboard shortcuts, see the [CodeMirror documentation](https://codemirr
### Notifications
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}
| Keyboard shortcut | Description
|-----------|------------
|e | Mark as done
diff --git a/content/github/getting-started-with-github/learning-about-github.md b/content/github/getting-started-with-github/learning-about-github.md
index 735caea92fa2..8c94a8491f1c 100644
--- a/content/github/getting-started-with-github/learning-about-github.md
+++ b/content/github/getting-started-with-github/learning-about-github.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/getting-started-with-github/quickstart.md b/content/github/getting-started-with-github/quickstart.md
index 1684bfd1fac3..77de003bdf25 100644
--- a/content/github/getting-started-with-github/quickstart.md
+++ b/content/github/getting-started-with-github/quickstart.md
@@ -5,5 +5,6 @@ mapTopic: true
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/getting-started-with-github/saving-repositories-with-stars.md b/content/github/getting-started-with-github/saving-repositories-with-stars.md
index 0951e3c9b715..993595cb4ebd 100644
--- a/content/github/getting-started-with-github/saving-repositories-with-stars.md
+++ b/content/github/getting-started-with-github/saving-repositories-with-stars.md
@@ -1,6 +1,6 @@
---
title: Saving repositories with stars
-intro: 'You can star repositories{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.16" %} and topics{% endif %} to keep track of projects you find interesting{% if currentVersion == "free-pro-team@latest" %} and discover related content in your news feed{% endif %}.'
+intro: 'You can star repositories and topics to keep track of projects you find interesting{% if currentVersion == "free-pro-team@latest" %} and discover related content in your news feed{% endif %}.'
redirect_from:
- /articles/stars/
- /articles/about-stars/
@@ -10,6 +10,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
You can search, sort, and filter your starred repositories and topics on your {% data variables.explore.your_stars_page %}.'
diff --git a/content/github/getting-started-with-github/set-up-git.md b/content/github/getting-started-with-github/set-up-git.md
index 7964ca6bf18e..3e1169f8e418 100644
--- a/content/github/getting-started-with-github/set-up-git.md
+++ b/content/github/getting-started-with-github/set-up-git.md
@@ -14,9 +14,10 @@ intro: 'At the heart of {% data variables.product.product_name %} is an open sou
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
-To use Git on the command line, you'll need to download, install, and configure Git on your computer. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} You can also install {% data variables.product.prodname_cli %} to use {% data variables.product.product_name %} from the command line. For more information on {% data variables.product.prodname_cli %}, see the [{% data variables.product.prodname_cli %}](https://cli.github.com/manual/) documentation.{% endif %}
+To use Git on the command line, you'll need to download, install, and configure Git on your computer. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %} You can also install {% data variables.product.prodname_cli %} to use {% data variables.product.product_name %} from the command line. For more information on {% data variables.product.prodname_cli %}, see the [{% data variables.product.prodname_cli %}](https://cli.github.com/manual/) documentation.{% endif %}
If you want to work with Git locally, but don't want to use the command line, you can instead download and install the [{% data variables.product.prodname_desktop %}]({% data variables.product.desktop_link %}) client. For more information, see "[Installing and configuring {% data variables.product.prodname_desktop %}](/desktop/installing-and-configuring-github-desktop/)."
diff --git a/content/github/getting-started-with-github/setting-up-a-trial-of-github-enterprise-server.md b/content/github/getting-started-with-github/setting-up-a-trial-of-github-enterprise-server.md
index dc421e3439b3..52e4315c74ac 100644
--- a/content/github/getting-started-with-github/setting-up-a-trial-of-github-enterprise-server.md
+++ b/content/github/getting-started-with-github/setting-up-a-trial-of-github-enterprise-server.md
@@ -13,7 +13,7 @@ versions:
You can request a 45-day trial to evaluate {% data variables.product.prodname_ghe_server %}. Your trial will be installed as a virtual appliance, with options for on-premises or cloud deployment. For a list of supported visualization platforms, see "[Setting up a GitHub Enterprise Server instance](/enterprise/admin/installation/setting-up-a-github-enterprise-server-instance)."
-{% if currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_short %}{% else %}Security{% endif %} alerts and {% data variables.product.prodname_github_connect %} are not currently available in trials of {% data variables.product.prodname_ghe_server %}. For a demonstration of these features, contact {% data variables.contact.contact_enterprise_sales %}. For more information about these features, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)" and "[Connecting {% data variables.product.prodname_ghe_server %} to {% data variables.product.prodname_dotcom_the_website %}](/enterprise/admin/installation/connecting-github-enterprise-server-to-github-enterprise-cloud)."
+{% if currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot %}{% else %}Security{% endif %} alerts and {% data variables.product.prodname_github_connect %} are not currently available in trials of {% data variables.product.prodname_ghe_server %}. For a demonstration of these features, contact {% data variables.contact.contact_enterprise_sales %}. For more information about these features, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)" and "[Connecting {% data variables.product.prodname_ghe_server %} to {% data variables.product.prodname_dotcom_the_website %}](/enterprise/admin/installation/connecting-github-enterprise-server-to-github-enterprise-cloud)."
Trials are also available for {% data variables.product.prodname_ghe_cloud %}. For more information, see "[Setting up a trial of {% data variables.product.prodname_ghe_cloud %}](/articles/setting-up-a-trial-of-github-enterprise-cloud)."
@@ -36,7 +36,7 @@ To get the most out of your trial, follow these steps:
- [Quick start guide to {% data variables.product.prodname_dotcom %}](https://resources.github.com/webcasts/Quick-start-guide-to-GitHub/) webcast
- [Understanding the {% data variables.product.prodname_dotcom %} flow](https://guides.github.com/introduction/flow/) in {% data variables.product.prodname_dotcom %} Guides
- [Hello World](https://guides.github.com/activities/hello-world/) in {% data variables.product.prodname_dotcom %} Guides
-3. To configure your instance to meet your organization's needs, see "[Configuring the {% data variables.product.prodname_ghe_server %} appliance](/enterprise/admin/installation/configuring-the-github-enterprise-server-appliance)."
+3. To configure your instance to meet your organization's needs, see "[Configuring your enterprise](/admin/configuration/configuring-your-enterprise)."
4. To integrate {% data variables.product.prodname_ghe_server %} with your identity provider, see "[Using SAML](/enterprise/admin/user-management/using-saml)" and "[Using LDAP](/enterprise/admin/authentication/using-ldap)."
5. Invite an unlimited number of people to join your trial.
- Add users to your {% data variables.product.prodname_ghe_server %} instance using built-in authentication or your configured identity provider. For more information, see "[Using built in authentication](/enterprise/admin/user-management/using-built-in-authentication)."
diff --git a/content/github/getting-started-with-github/signing-up-for-github.md b/content/github/getting-started-with-github/signing-up-for-github.md
index 2456e174326f..540b8e845c80 100644
--- a/content/github/getting-started-with-github/signing-up-for-github.md
+++ b/content/github/getting-started-with-github/signing-up-for-github.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/getting-started-with-github/supported-browsers.md b/content/github/getting-started-with-github/supported-browsers.md
index 57d8e0ab96cb..f9b73d354972 100644
--- a/content/github/getting-started-with-github/supported-browsers.md
+++ b/content/github/getting-started-with-github/supported-browsers.md
@@ -4,10 +4,11 @@ redirect_from:
- /articles/why-doesn-t-graphs-work-with-ie-8/
- /articles/why-don-t-graphs-work-with-ie8/
- /articles/supported-browsers
-intro: 'We design {% data variables.product.product_name %} to support the latest web browsers. We support the current versions of [Chrome](https://www.google.com/chrome/), [Firefox](http://www.mozilla.org/firefox/), [Safari](http://www.apple.com/safari/), {% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.16" %}Internet Explorer 11, {% endif %}and [Microsoft Edge](https://www.microsoft.com/en-us/windows/microsoft-edge).'
+intro: 'We design {% data variables.product.product_name %} to support the latest web browsers. We support the current versions of [Chrome](https://www.google.com/chrome/), [Firefox](http://www.mozilla.org/firefox/), [Safari](http://www.apple.com/safari/), and [Microsoft Edge](https://www.microsoft.com/en-us/windows/microsoft-edge).'
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Firefox Extended Support Release
diff --git a/content/github/getting-started-with-github/types-of-github-accounts.md b/content/github/getting-started-with-github/types-of-github-accounts.md
index e439bfa65adb..17235a24551f 100644
--- a/content/github/getting-started-with-github/types-of-github-accounts.md
+++ b/content/github/getting-started-with-github/types-of-github-accounts.md
@@ -10,6 +10,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% if currentVersion == "free-pro-team@latest" %}
diff --git a/content/github/getting-started-with-github/using-github.md b/content/github/getting-started-with-github/using-github.md
index 204cc817de81..8bcb138febf1 100644
--- a/content/github/getting-started-with-github/using-github.md
+++ b/content/github/getting-started-with-github/using-github.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/importing-your-projects-to-github/adding-an-existing-project-to-github-using-the-command-line.md b/content/github/importing-your-projects-to-github/adding-an-existing-project-to-github-using-the-command-line.md
index a2caca65584c..cde638a77d06 100644
--- a/content/github/importing-your-projects-to-github/adding-an-existing-project-to-github-using-the-command-line.md
+++ b/content/github/importing-your-projects-to-github/adding-an-existing-project-to-github-using-the-command-line.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.repositories.migrating-from-codeplex %}
@@ -26,7 +27,7 @@ versions:
3. Change the current working directory to your local project.
4. Initialize the local directory as a Git repository.
```shell
- $ git init
+ $ git init -b main
```
5. Add the files in your new local repository. This stages them for the first commit.
```shell
@@ -63,7 +64,7 @@ versions:
3. Change the current working directory to your local project.
4. Initialize the local directory as a Git repository.
```shell
- $ git init
+ $ git init -b main
```
5. Add the files in your new local repository. This stages them for the first commit.
```shell
@@ -100,7 +101,7 @@ versions:
3. Change the current working directory to your local project.
4. Initialize the local directory as a Git repository.
```shell
- $ git init
+ $ git init -b main
```
5. Add the files in your new local repository. This stages them for the first commit.
```shell
diff --git a/content/github/importing-your-projects-to-github/importing-a-git-repository-using-the-command-line.md b/content/github/importing-your-projects-to-github/importing-a-git-repository-using-the-command-line.md
index 59d97501f62c..8c4366a5d66e 100644
--- a/content/github/importing-your-projects-to-github/importing-a-git-repository-using-the-command-line.md
+++ b/content/github/importing-your-projects-to-github/importing-a-git-repository-using-the-command-line.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Before you start, make sure you know:
diff --git a/content/github/importing-your-projects-to-github/importing-source-code-to-github.md b/content/github/importing-your-projects-to-github/importing-source-code-to-github.md
index 3af8b5d9a687..8b79baa6754f 100644
--- a/content/github/importing-your-projects-to-github/importing-source-code-to-github.md
+++ b/content/github/importing-your-projects-to-github/importing-source-code-to-github.md
@@ -11,5 +11,6 @@ mapTopic: true
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/importing-your-projects-to-github/index.md b/content/github/importing-your-projects-to-github/index.md
index 59215646f20e..1ebc5ad0d32d 100644
--- a/content/github/importing-your-projects-to-github/index.md
+++ b/content/github/importing-your-projects-to-github/index.md
@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/importing-your-projects-to-github/source-code-migration-tools.md b/content/github/importing-your-projects-to-github/source-code-migration-tools.md
index c51158a24908..b27dd344433d 100644
--- a/content/github/importing-your-projects-to-github/source-code-migration-tools.md
+++ b/content/github/importing-your-projects-to-github/source-code-migration-tools.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% if currentVersion == "free-pro-team@latest" %}
diff --git a/content/github/index.md b/content/github/index.md
index 5eb9f6603864..768349e16a24 100644
--- a/content/github/index.md
+++ b/content/github/index.md
@@ -8,6 +8,7 @@ intro: 'Documentation, guides, and help topics for software developers, designer
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% link_in_list /getting-started-with-github %}
@@ -31,7 +32,7 @@ versions:
{% link_in_list /setting-up-and-managing-organizations-and-teams %}
-{% link_in_list /setting-up-and-managing-your-enterprise-account %}
+{% link_in_list /setting-up-and-managing-your-enterprise %}
diff --git a/content/github/managing-files-in-a-repository/3d-file-viewer.md b/content/github/managing-files-in-a-repository/3d-file-viewer.md
index 5f7bee340c4b..c203f9b71da1 100644
--- a/content/github/managing-files-in-a-repository/3d-file-viewer.md
+++ b/content/github/managing-files-in-a-repository/3d-file-viewer.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data variables.product.product_name %} can host and render 3D files with the *.stl* extension.
diff --git a/content/github/managing-files-in-a-repository/adding-a-file-to-a-repository-using-the-command-line.md b/content/github/managing-files-in-a-repository/adding-a-file-to-a-repository-using-the-command-line.md
index a8d5fe1770bb..2f0fc63c9abd 100644
--- a/content/github/managing-files-in-a-repository/adding-a-file-to-a-repository-using-the-command-line.md
+++ b/content/github/managing-files-in-a-repository/adding-a-file-to-a-repository-using-the-command-line.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% tip %}
diff --git a/content/github/managing-files-in-a-repository/adding-a-file-to-a-repository.md b/content/github/managing-files-in-a-repository/adding-a-file-to-a-repository.md
index fa0bc1f24deb..2b87bdf54e4f 100644
--- a/content/github/managing-files-in-a-repository/adding-a-file-to-a-repository.md
+++ b/content/github/managing-files-in-a-repository/adding-a-file-to-a-repository.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Files that you add to a repository via a browser are limited to {% data variables.large_files.max_github_browser_size %} per file. You can add larger files, up to {% data variables.large_files.max_github_size %} each, via the command line. For more information, see "[Adding a file to a repository using the command line](/articles/adding-a-file-to-a-repository-using-the-command-line)."
@@ -19,7 +20,7 @@ Files that you add to a repository via a browser are limited to {% data variable
{% endtip %}
{% data reusables.repositories.navigate-to-repo %}
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
2. Under your repository name, click **Upload files**.
{% else %}
diff --git a/content/github/managing-files-in-a-repository/creating-new-files.md b/content/github/managing-files-in-a-repository/creating-new-files.md
index b06ca4cb0b5e..4f625eff349a 100644
--- a/content/github/managing-files-in-a-repository/creating-new-files.md
+++ b/content/github/managing-files-in-a-repository/creating-new-files.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
When creating a file on {% data variables.product.product_name %}, consider the following:
diff --git a/content/github/managing-files-in-a-repository/deleting-files.md b/content/github/managing-files-in-a-repository/deleting-files.md
index 0ea1952c1add..d527c18f0f55 100644
--- a/content/github/managing-files-in-a-repository/deleting-files.md
+++ b/content/github/managing-files-in-a-repository/deleting-files.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% tip %}
diff --git a/content/github/managing-files-in-a-repository/editing-files-in-another-users-repository.md b/content/github/managing-files-in-a-repository/editing-files-in-another-users-repository.md
index 3075ff02ff9f..dc10c8e09f9e 100644
--- a/content/github/managing-files-in-a-repository/editing-files-in-another-users-repository.md
+++ b/content/github/managing-files-in-a-repository/editing-files-in-another-users-repository.md
@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
1. In another user's repository, browse to the folder that contains the file you want to edit. Click the name of the file you want to edit.
diff --git a/content/github/managing-files-in-a-repository/editing-files-in-your-repository.md b/content/github/managing-files-in-a-repository/editing-files-in-your-repository.md
index 4c1abd9ad4ab..5de63217e7dc 100644
--- a/content/github/managing-files-in-a-repository/editing-files-in-your-repository.md
+++ b/content/github/managing-files-in-a-repository/editing-files-in-your-repository.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% tip %}
diff --git a/content/github/managing-files-in-a-repository/getting-permanent-links-to-files.md b/content/github/managing-files-in-a-repository/getting-permanent-links-to-files.md
index 46d734b674cd..756ff937e075 100644
--- a/content/github/managing-files-in-a-repository/getting-permanent-links-to-files.md
+++ b/content/github/managing-files-in-a-repository/getting-permanent-links-to-files.md
@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% tip %}
diff --git a/content/github/managing-files-in-a-repository/index.md b/content/github/managing-files-in-a-repository/index.md
index 84f709d11b02..ebc35dd973bc 100644
--- a/content/github/managing-files-in-a-repository/index.md
+++ b/content/github/managing-files-in-a-repository/index.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/managing-files-in-a-repository/managing-files-on-github.md b/content/github/managing-files-in-a-repository/managing-files-on-github.md
index d65f8cfca977..da52349c22ee 100644
--- a/content/github/managing-files-in-a-repository/managing-files-on-github.md
+++ b/content/github/managing-files-in-a-repository/managing-files-on-github.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/managing-files-in-a-repository/managing-files-using-the-command-line.md b/content/github/managing-files-in-a-repository/managing-files-using-the-command-line.md
index 68ff00ddf1b6..1badad1949c8 100644
--- a/content/github/managing-files-in-a-repository/managing-files-using-the-command-line.md
+++ b/content/github/managing-files-in-a-repository/managing-files-using-the-command-line.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/managing-files-in-a-repository/mapping-geojson-files-on-github.md b/content/github/managing-files-in-a-repository/mapping-geojson-files-on-github.md
index 7327210c49ee..863ba4e52d30 100644
--- a/content/github/managing-files-in-a-repository/mapping-geojson-files-on-github.md
+++ b/content/github/managing-files-in-a-repository/mapping-geojson-files-on-github.md
@@ -5,6 +5,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data variables.product.product_name %} supports rendering geoJSON and topoJSON map files within {% data variables.product.product_name %} repositories. Simply commit the file as you would normally using a `.geojson` or `.topojson` extension. Files with a `.json` extension are also supported, but only if `type` is set to `FeatureCollection`, `GeometryCollection`, or `topology`. Then, navigate to the path of the geoJSON file on GitHub.com.
diff --git a/content/github/managing-files-in-a-repository/moving-a-file-to-a-new-location-using-the-command-line.md b/content/github/managing-files-in-a-repository/moving-a-file-to-a-new-location-using-the-command-line.md
index f2796b3bfb70..7479f992315a 100644
--- a/content/github/managing-files-in-a-repository/moving-a-file-to-a-new-location-using-the-command-line.md
+++ b/content/github/managing-files-in-a-repository/moving-a-file-to-a-new-location-using-the-command-line.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Many files can be [moved directly on {% data variables.product.product_name %}](/articles/moving-a-file-to-a-new-location), but some files, such as images, require that you move them from the command line.
diff --git a/content/github/managing-files-in-a-repository/moving-a-file-to-a-new-location.md b/content/github/managing-files-in-a-repository/moving-a-file-to-a-new-location.md
index b78e58dd1f6c..c628d6408075 100644
--- a/content/github/managing-files-in-a-repository/moving-a-file-to-a-new-location.md
+++ b/content/github/managing-files-in-a-repository/moving-a-file-to-a-new-location.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
In addition to changing the file location, you can also [update the contents of your file](/articles/editing-files-in-your-repository), or [give it a new name](/articles/renaming-a-file) in the same commit.
diff --git a/content/github/managing-files-in-a-repository/navigating-code-on-github.md b/content/github/managing-files-in-a-repository/navigating-code-on-github.md
index 2980fad6fc0e..d32b1b5bacc3 100644
--- a/content/github/managing-files-in-a-repository/navigating-code-on-github.md
+++ b/content/github/managing-files-in-a-repository/navigating-code-on-github.md
@@ -10,6 +10,7 @@ versions:
### About navigating code on {% data variables.product.prodname_dotcom %}
Navigating code functions use the open source library [`semantic`](https://github.com/github/semantic). The following languages are supported:
+- C#
- CodeQL
- Go
- Java
diff --git a/content/github/managing-files-in-a-repository/renaming-a-file-using-the-command-line.md b/content/github/managing-files-in-a-repository/renaming-a-file-using-the-command-line.md
index 196e8f64f177..213d83c12459 100644
--- a/content/github/managing-files-in-a-repository/renaming-a-file-using-the-command-line.md
+++ b/content/github/managing-files-in-a-repository/renaming-a-file-using-the-command-line.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Many files can be [renamed directly on {% data variables.product.product_name %}](/articles/renaming-a-file), but some files, such as images, require that you rename them from the command line.
diff --git a/content/github/managing-files-in-a-repository/renaming-a-file.md b/content/github/managing-files-in-a-repository/renaming-a-file.md
index c5d9adfd902c..c516722bcb0e 100644
--- a/content/github/managing-files-in-a-repository/renaming-a-file.md
+++ b/content/github/managing-files-in-a-repository/renaming-a-file.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% tip %}
diff --git a/content/github/managing-files-in-a-repository/rendering-and-diffing-images.md b/content/github/managing-files-in-a-repository/rendering-and-diffing-images.md
index 291b82b701c8..5f4a5868b0ca 100644
--- a/content/github/managing-files-in-a-repository/rendering-and-diffing-images.md
+++ b/content/github/managing-files-in-a-repository/rendering-and-diffing-images.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% note %}
diff --git a/content/github/managing-files-in-a-repository/rendering-csv-and-tsv-data.md b/content/github/managing-files-in-a-repository/rendering-csv-and-tsv-data.md
index 6b0cd29be94c..15f545ecfbdb 100644
--- a/content/github/managing-files-in-a-repository/rendering-csv-and-tsv-data.md
+++ b/content/github/managing-files-in-a-repository/rendering-csv-and-tsv-data.md
@@ -5,6 +5,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
GitHub supports rendering tabular data in the form of *.csv* (comma-separated) and .*tsv* (tab-separated) files.
diff --git a/content/github/managing-files-in-a-repository/rendering-differences-in-prose-documents.md b/content/github/managing-files-in-a-repository/rendering-differences-in-prose-documents.md
index d164e05f84e7..1f3c59ad2082 100644
--- a/content/github/managing-files-in-a-repository/rendering-differences-in-prose-documents.md
+++ b/content/github/managing-files-in-a-repository/rendering-differences-in-prose-documents.md
@@ -5,6 +5,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Commits and pull requests that include prose documents have the ability to represent those documents with *source* and *rendered* views.
diff --git a/content/github/managing-files-in-a-repository/rendering-pdf-documents.md b/content/github/managing-files-in-a-repository/rendering-pdf-documents.md
index 2ed0c1f98fbe..5e13b3f24ad1 100644
--- a/content/github/managing-files-in-a-repository/rendering-pdf-documents.md
+++ b/content/github/managing-files-in-a-repository/rendering-pdf-documents.md
@@ -5,6 +5,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
GitHub supports rendering of PDF documents.
diff --git a/content/github/managing-files-in-a-repository/tracking-changes-in-a-file.md b/content/github/managing-files-in-a-repository/tracking-changes-in-a-file.md
index 142558f638e1..99fb0d7b548d 100644
--- a/content/github/managing-files-in-a-repository/tracking-changes-in-a-file.md
+++ b/content/github/managing-files-in-a-repository/tracking-changes-in-a-file.md
@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
With the blame view, you can view the line-by-line revision history for an entire file, or view the revision history of a single line within a file by clicking {% octicon "versions" aria-label="The prior blame icon" %}. Each time you click {% octicon "versions" aria-label="The prior blame icon" %}, you'll see the previous revision information for that line, including who committed the change and when.
diff --git a/content/github/managing-files-in-a-repository/working-with-jupyter-notebook-files-on-github.md b/content/github/managing-files-in-a-repository/working-with-jupyter-notebook-files-on-github.md
index 9181f6845840..be3704331a5c 100644
--- a/content/github/managing-files-in-a-repository/working-with-jupyter-notebook-files-on-github.md
+++ b/content/github/managing-files-in-a-repository/working-with-jupyter-notebook-files-on-github.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/managing-files-in-a-repository/working-with-non-code-files.md b/content/github/managing-files-in-a-repository/working-with-non-code-files.md
index e3890a9107dc..2fb771ab505a 100644
--- a/content/github/managing-files-in-a-repository/working-with-non-code-files.md
+++ b/content/github/managing-files-in-a-repository/working-with-non-code-files.md
@@ -8,5 +8,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/managing-large-files/about-git-large-file-storage.md b/content/github/managing-large-files/about-git-large-file-storage.md
index 64855270e908..886db29c1fb6 100644
--- a/content/github/managing-large-files/about-git-large-file-storage.md
+++ b/content/github/managing-large-files/about-git-large-file-storage.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data variables.large_files.product_name_short %} handles large files by storing references to the file in the repository, but not the actual file itself. To work around Git's architecture, {% data variables.large_files.product_name_short %} creates a pointer file which acts as a reference to the actual file (which is stored somewhere else). {% data variables.product.product_name %} manages this pointer file in your repository. When you clone the repository down, {% data variables.product.product_name %} uses the pointer file as a map to go and find the large file for you.
@@ -39,11 +40,13 @@ size 84977953
It tracks the `version` of {% data variables.large_files.product_name_short %} you're using, followed by a unique identifier for the file (`oid`). It also stores the `size` of the final file.
-{% tip %}
+{% note %}
-**Tip**: {% data variables.large_files.product_name_short %} cannot be used with {% data variables.product.prodname_pages %} sites.
-
-{% endtip %}
+**Notes**:
+- {% data variables.large_files.product_name_short %} cannot be used with {% data variables.product.prodname_pages %} sites.
+- {% data variables.large_files.product_name_short %} cannot be used with template repositories.
+
+{% endnote %}
### Further reading
diff --git a/content/github/managing-large-files/collaboration-with-git-large-file-storage.md b/content/github/managing-large-files/collaboration-with-git-large-file-storage.md
index e2ad6093dc2f..b2410e63a1f3 100644
--- a/content/github/managing-large-files/collaboration-with-git-large-file-storage.md
+++ b/content/github/managing-large-files/collaboration-with-git-large-file-storage.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
If collaborators on your repository don't have {% data variables.large_files.product_name_short %} installed, they won't have access to the original large file. If they attempt to clone your repository, they will only fetch the pointer files, and won't have access to any of the actual data.
diff --git a/content/github/managing-large-files/conditions-for-large-files.md b/content/github/managing-large-files/conditions-for-large-files.md
index 3daf4fef53dc..b04c98500546 100644
--- a/content/github/managing-large-files/conditions-for-large-files.md
+++ b/content/github/managing-large-files/conditions-for-large-files.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.large_files.use_lfs_tip %}
@@ -16,4 +17,4 @@ If you attempt to add or update a file that is larger than {% data variables.lar
### Blocked pushes for large files
-{% if currentVersion != "free-pro-team@latest" %}By default, {% endif %}{% data variables.product.product_name %} blocks pushes that exceed {% data variables.large_files.max_github_size %}. {% if currentVersion != "free-pro-team@latest" %}However, a site administrator can configure a different limit for your {% data variables.product.prodname_ghe_server %} instance. For more information, see "[Setting Git push limits](/enterprise/{{ currentVersion }}/admin/guides/installation/setting-git-push-limits)".{% endif %}
+{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}By default, {% endif %}{% data variables.product.product_name %} blocks pushes that exceed {% data variables.large_files.max_github_size %}. {% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}However, a site administrator can configure a different limit for {% data variables.product.product_location %}. For more information, see "[Setting Git push limits](/enterprise/{{ currentVersion }}/admin/guides/installation/setting-git-push-limits)".{% endif %}
diff --git a/content/github/managing-large-files/configuring-git-large-file-storage.md b/content/github/managing-large-files/configuring-git-large-file-storage.md
index b1f922970b99..815168de1ad3 100644
--- a/content/github/managing-large-files/configuring-git-large-file-storage.md
+++ b/content/github/managing-large-files/configuring-git-large-file-storage.md
@@ -7,17 +7,18 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
If there are existing files in your repository that you'd like to use {% data variables.product.product_name %} with, you need to first remove them from the repository and then add them to {% data variables.large_files.product_name_short %} locally. For more information, see "[Moving a file in your repository to {% data variables.large_files.product_name_short %}](/articles/moving-a-file-in-your-repository-to-git-large-file-storage)."
{% data reusables.large_files.resolving-upload-failures %}
-{% if currentVersion != "free-pro-team@latest" %}
+{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
{% tip %}
-**Note:** Before trying to push a large file to {% data variables.product.product_name %}, make sure that you've enabled {% data variables.large_files.product_name_short %} on your appliance. For more information, see "[Configuring Git Large File Storage on GitHub Enterprise Server](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-git-large-file-storage-on-github-enterprise-server/)."
+**Note:** Before trying to push a large file to {% data variables.product.product_name %}, make sure that you've enabled {% data variables.large_files.product_name_short %} on your enterprise. For more information, see "[Configuring Git Large File Storage on GitHub Enterprise Server](/enterprise/{{ currentVersion }}/admin/guides/installation/configuring-git-large-file-storage-on-github-enterprise-server/)."
{% endtip %}
@@ -58,5 +59,5 @@ If there are existing files in your repository that you'd like to use {% data va
### Further reading
-- "[Collaboration with {% data variables.large_files.product_name_long %}](/articles/collaboration-with-git-large-file-storage/)"{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
+- "[Collaboration with {% data variables.large_files.product_name_long %}](/articles/collaboration-with-git-large-file-storage/)"{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}
- "[Managing {% data variables.large_files.product_name_short %} objects in archives of your repository](/github/administering-a-repository/managing-git-lfs-objects-in-archives-of-your-repository)"{% endif %}
diff --git a/content/github/managing-large-files/distributing-large-binaries.md b/content/github/managing-large-files/distributing-large-binaries.md
index b8c70aae9e79..dd94dbe0a2de 100644
--- a/content/github/managing-large-files/distributing-large-binaries.md
+++ b/content/github/managing-large-files/distributing-large-binaries.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
If you need to distribute large files within your repository, you can create releases on {% data variables.product.product_location %}. Releases allow you to package software, release notes, and links to binary files, for other people to use. For more information, visit "[About releases](/github/administering-a-repository/about-releases)."
diff --git a/content/github/managing-large-files/index.md b/content/github/managing-large-files/index.md
index f1a474f3752f..bc1db5f76246 100644
--- a/content/github/managing-large-files/index.md
+++ b/content/github/managing-large-files/index.md
@@ -5,6 +5,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/managing-large-files/installing-git-large-file-storage.md b/content/github/managing-large-files/installing-git-large-file-storage.md
index 1f5faeaf424d..f035c593111f 100644
--- a/content/github/managing-large-files/installing-git-large-file-storage.md
+++ b/content/github/managing-large-files/installing-git-large-file-storage.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% mac %}
diff --git a/content/github/managing-large-files/moving-a-file-in-your-repository-to-git-large-file-storage.md b/content/github/managing-large-files/moving-a-file-in-your-repository-to-git-large-file-storage.md
index ac0d0da9d8db..685de77d5212 100644
--- a/content/github/managing-large-files/moving-a-file-in-your-repository-to-git-large-file-storage.md
+++ b/content/github/managing-large-files/moving-a-file-in-your-repository-to-git-large-file-storage.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
After installing {% data variables.large_files.product_name_short %} and configuring {% data variables.large_files.product_name_short %} tracking, you can move files from Git's regular tracking to {% data variables.large_files.product_name_short %}. For more information, see "[Installing {% data variables.large_files.product_name_long %}](/github/managing-large-files/installing-git-large-file-storage)" and "[Configuring {% data variables.large_files.product_name_long %}](/github/managing-large-files/configuring-git-large-file-storage)."
diff --git a/content/github/managing-large-files/removing-files-from-a-repositorys-history.md b/content/github/managing-large-files/removing-files-from-a-repositorys-history.md
index 35ebb9600e64..e0b980ab1f3e 100644
--- a/content/github/managing-large-files/removing-files-from-a-repositorys-history.md
+++ b/content/github/managing-large-files/removing-files-from-a-repositorys-history.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% warning %}
@@ -15,10 +16,6 @@ versions:
{% endwarning %}
-### Removing a file that was added in an earlier commit
-
-If you added a file in an earlier commit, you need to remove it from the repository's history. To remove files from the repository's history, you can use the BFG Repo-Cleaner or the `git filter-branch` command. For more information see "[Removing sensitive data from a repository](/github/authenticating-to-github/removing-sensitive-data-from-a-repository)."
-
### Removing a file added in the most recent unpushed commit
If the file was added with your most recent commit, and you have not pushed to {% data variables.product.product_location %}, you can delete the file and amend the commit:
@@ -42,3 +39,7 @@ If the file was added with your most recent commit, and you have not pushed to {
$ git push
# Push our rewritten, smaller commit
```
+
+### Removing a file that was added in an earlier commit
+
+If you added a file in an earlier commit, you need to remove it from the repository's history. To remove files from the repository's history, you can use the BFG Repo-Cleaner or the `git filter-branch` command. For more information see "[Removing sensitive data from a repository](/github/authenticating-to-github/removing-sensitive-data-from-a-repository)."
diff --git a/content/github/managing-large-files/removing-files-from-git-large-file-storage.md b/content/github/managing-large-files/removing-files-from-git-large-file-storage.md
index 9290d04394dc..c90bdd36df99 100644
--- a/content/github/managing-large-files/removing-files-from-git-large-file-storage.md
+++ b/content/github/managing-large-files/removing-files-from-git-large-file-storage.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Removing a single file
diff --git a/content/github/managing-large-files/resolving-git-large-file-storage-upload-failures.md b/content/github/managing-large-files/resolving-git-large-file-storage-upload-failures.md
index 3cbe3c445e3a..4c867d464e8a 100644
--- a/content/github/managing-large-files/resolving-git-large-file-storage-upload-failures.md
+++ b/content/github/managing-large-files/resolving-git-large-file-storage-upload-failures.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
The {% data variables.large_files.product_name_short %} integrity check ensures that all referenced {% data variables.large_files.product_name_short %} files in a push have been uploaded properly. If the check detects referenced files that have not been uploaded, you will receive an error message and your push will be blocked.
diff --git a/content/github/managing-large-files/versioning-large-files.md b/content/github/managing-large-files/versioning-large-files.md
index 5aca3fe7d421..434d4adc2c51 100644
--- a/content/github/managing-large-files/versioning-large-files.md
+++ b/content/github/managing-large-files/versioning-large-files.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/managing-large-files/working-with-large-files.md b/content/github/managing-large-files/working-with-large-files.md
index 58f80962498b..24673d6b90a8 100644
--- a/content/github/managing-large-files/working-with-large-files.md
+++ b/content/github/managing-large-files/working-with-large-files.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies.md b/content/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies.md
index 0ce617f2fdb2..c0f46c36576b 100644
--- a/content/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies.md
+++ b/content/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies.md
@@ -17,7 +17,7 @@ When your code depends on a package that has a security vulnerability, this vuln
### Detection of vulnerable dependencies
- {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot %} detects vulnerable dependencies and sends {% data variables.product.prodname_dependabot_short %} alerts{% else %}{% data variables.product.product_name %} detects vulnerable dependencies and sends security alerts{% endif %} when:
+ {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot %} detects vulnerable dependencies and sends {% data variables.product.prodname_dependabot_alerts %}{% else %}{% data variables.product.product_name %} detects vulnerable dependencies and sends security alerts{% endif %} when:
{% if currentVersion == "free-pro-team@latest" %}
- A new vulnerability is added to the {% data variables.product.prodname_advisory_database %}. For more information, see "[Browsing security vulnerabilities in the {% data variables.product.prodname_advisory_database %}](/github/managing-security-vulnerabilities/browsing-security-vulnerabilities-in-the-github-advisory-database)."
@@ -41,71 +41,48 @@ For a list of the ecosystems that {% data variables.product.product_name %} can
{% data reusables.repositories.enable-security-alerts %}
-{% if currentVersion == "free-pro-team@latest" %}{% data variables.product.prodname_dotcom %} detects and alerts users to vulnerable dependencies in _public_ repositories by default. Owners of private repositories, or people with admin access, can enable {% data variables.product.prodname_dependabot_alerts %} by enabling the dependency graph and {% data variables.product.prodname_dependabot_alerts %} for their repositories.
+{% if currentVersion == "free-pro-team@latest" %}{% data variables.product.prodname_dotcom %} detects vulnerable dependencies in _public_ repositories and generates {% data variables.product.prodname_dependabot_alerts %} by default. Owners of private repositories, or people with admin access, can enable {% data variables.product.prodname_dependabot_alerts %} by enabling the dependency graph and {% data variables.product.prodname_dependabot_alerts %} for their repositories.
-You can also enable or disable {% data variables.product.prodname_dependabot %} alerts for all repositories owned by your user account or organization. For more information, see "[Managing security and analysis settings for your user account](/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account)" or "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)."
+You can also enable or disable {% data variables.product.prodname_dependabot_alerts %} for all repositories owned by your user account or organization. For more information, see "[Managing security and analysis settings for your user account](/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account)" or "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)."
-{% data variables.product.product_name %} starts generating the dependency graph immediately and sends alerts for any vulnerable dependencies as soon as they are identified. The graph is usually populated within minutes but this may take longer for repositories with many dependencies. For more information, see "[Managing data use settings for your private repository](/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository)."
+{% data variables.product.product_name %} starts generating the dependency graph immediately and generates alerts for any vulnerable dependencies as soon as they are identified. The graph is usually populated within minutes but this may take longer for repositories with many dependencies. For more information, see "[Managing data use settings for your private repository](/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository)."
{% endif %}
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
-When {% data variables.product.product_name %} identifies a vulnerable dependency, we send a {% data variables.product.prodname_dependabot_short %} alert to the maintainers of affected repositories with details of the vulnerability, a link to the affected file in the project, and information about a fixed version. {% if currentVersion == "free-pro-team@latest" %}For repositories that have enabled {% data variables.product.prodname_dependabot_security_updates %}, the alert also contains a link to a pull request to update the manifest or lock file to the minimum version that resolves the vulnerability. For more information, see "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-github-dependabot-security-updates)."{% endif %}
+When {% data variables.product.product_name %} identifies a vulnerable dependency, we generate a {% data variables.product.prodname_dependabot %} alert and display it on the Security tab for the repository. The alert includes a link to the affected file in the project, and information about a fixed version. {% data variables.product.product_name %} also notifies the maintainers of affected repositories about the new alert according to their notification preferences. For more information, see "[Configuring notifications for vulnerable dependencies](/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies)."
{% endif %}
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
+{% if currentVersion == "free-pro-team@latest" %}
+For repositories where {% data variables.product.prodname_dependabot_security_updates %} are enabled, the alert may also contain a link to a pull request to update the manifest or lock file to the minimum version that resolves the vulnerability. For more information, see "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)."
+{% endif %}
+
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
When {% data variables.product.product_name %} identifies a vulnerable dependency, we send a security alert to the maintainers of affected repositories with details of the vulnerability, a link to the affected file in the project, and information about a fixed version.
{% endif %}
{% warning %}
-**Note**: {% data variables.product.product_name %}'s security features do not claim to catch all vulnerabilities. Though we are always trying to update our vulnerability database and alert you with our most up-to-date information, we will not be able to catch everything or alert you to known vulnerabilities within a guaranteed time frame. These features are not substitutes for human review of each dependency for potential vulnerabilities or any other issues, and we recommend consulting with a security service or conducting a thorough vulnerability review when necessary.
+**Note**: {% data variables.product.product_name %}'s security features do not claim to catch all vulnerabilities. Though we are always trying to update our vulnerability database and generate alerts with our most up-to-date information, we will not be able to catch everything or tell you about known vulnerabilities within a guaranteed time frame. These features are not substitutes for human review of each dependency for potential vulnerabilities or any other issues, and we recommend consulting with a security service or conducting a thorough vulnerability review when necessary.
{% endwarning %}
-### Access to {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_short %}{% else %}security{% endif %} alerts
+### Access to {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot %}{% else %}security{% endif %} alerts
You can see all of the alerts that affect a particular project{% if currentVersion == "free-pro-team@latest" %} on the repository's Security tab or{% endif %} in the repository's dependency graph.{% if currentVersion == "free-pro-team@latest" %} For more information, see "[Viewing and updating vulnerable dependencies in your repository](/articles/viewing-and-updating-vulnerable-dependencies-in-your-repository)."{% endif %}
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
-We send {% data variables.product.prodname_dependabot_short %} alerts to people with admin permissions in the affected repositories by default. {% data variables.product.product_name %} never publicly discloses identified vulnerabilities for any repository.{% if currentVersion == "free-pro-team@latest" %} You can also enable {% data variables.product.prodname_dependabot_short %} alerts for additional people or teams working repositories that you own or have admin permissions for. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-github-dependabot-alerts)."{% endif %}
+By default, we notify people with admin permissions in the affected repositories about new {% data variables.product.prodname_dependabot_alerts %}.{% endif %} {% if currentVersion == "free-pro-team@latest" %}{% data variables.product.product_name %} never publicly discloses identified vulnerabilities for any repository. You can also make {% data variables.product.prodname_dependabot_alerts %} visible to additional people or teams working repositories that you own or have admin permissions for. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-dependabot-alerts)."
{% endif %}
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
We send security alerts to people with admin permissions in the affected repositories by default. {% data variables.product.product_name %} never publicly discloses identified vulnerabilities for any repository.
{% endif %}
-### Configuring notifications for {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %}
-
-{% if currentVersion == "free-pro-team@latest" %}
-By default, you will receive {% data variables.product.prodname_dependabot_alerts %} by email, grouped by the specific vulnerability. You can also choose to receive {% data variables.product.prodname_dependabot_alerts %} in a weekly email summarizing alerts for up to 10 of your repositories, in your web notifications, or in the {% data variables.product.product_name %} user interface. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#github-dependabot-alerts-notification-options)."
-{% endif %}
-
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_gt "enterprise-server@2.21" %}
-By default, if your site administrator has configured email for notifications on your instance, you will receive {% data variables.product.prodname_dependabot_alerts %} by email. You can also choose to receive {% data variables.product.prodname_dependabot_alerts %} in a weekly email summarizing alerts for up to 10 of your repositories, in your web notifications, or in the {% data variables.product.product_name %} user interface. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#github-dependabot-alerts-notification-options)."
-{% endif %}
-
-{% if currentVersion != "free-pro-team@latest" and currentVersion == "enterprise-server@2.21" %}
-By default, if your site administrator has configured email for notifications on your instance, you will receive security alerts by email. You can also choose to receive security alerts in a weekly email summarizing alerts for up to 10 of your repositories, in your web notifications, or in the {% data variables.product.product_name %} user interface. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#security-alert-notification-options)."
-{% endif %}
-
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.21" %}
-By default, if your site administrator has configured email for notifications on your instance, you will receive security alerts by email. You can also choose to receive security alerts in a weekly email summarizing alerts for up to 10 of your repositories, in your web notifications, or in the {% data variables.product.product_name %} user interface. For more information, see "[Choosing the delivery method for your notifications
-](/github/receiving-notifications-about-activity-on-github/choosing-the-delivery-method-for-your-notifications)."
-{% endif %}
-
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_gt "enterprise-server@2.20" % %}
-
-{% if currentVersion ver_gt "enterprise-server@2.21" %}Site administrators can also enable {% data variables.product.prodname_dependabot_alerts %} without notifications. For more information, see "[Enabling {% data variables.product.prodname_dependabot_short %} alerts for vulnerable dependencies on {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server)."{% endif %}
-
-{% if currentVersion ver_lt "enterprise-server@2.22" %}Site administrators can also enable security alerts without notifications. For more information, see "[Enabling security alerts for vulnerable dependencies on {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server)."{% endif %}
-
-{% endif %}
-
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" % %}{% data reusables.repositories.security-alerts-x-github-severity %} For more information, see {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}"[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#filtering-email-notifications){% else %}"[About email notifications](/github/receiving-notifications-about-activity-on-github/about-email-notifications){% endif %}."{% endif %}
+{% data reusables.notifications.vulnerable-dependency-notification-delivery-method-customization %}{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.21" %} For more information, see "[Choosing the delivery method for your notifications](/github/receiving-notifications-about-activity-on-github/choosing-the-delivery-method-for-your-notifications)."{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %} For more information, see "[Configuring notifications for vulnerable dependencies](/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies)."{% endif %}
{% if currentVersion == "free-pro-team@latest" %}
### Further reading
-- "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-github-dependabot-security-updates)"
+- "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)"
- "[Viewing and updating vulnerable dependencies in your repository](/articles/viewing-and-updating-vulnerable-dependencies-in-your-repository)"
- "[Understanding how {% data variables.product.product_name %} uses and protects your data](/categories/understanding-how-github-uses-and-protects-your-data)"{% endif %}
diff --git a/content/github/managing-security-vulnerabilities/about-dependabot-security-updates.md b/content/github/managing-security-vulnerabilities/about-dependabot-security-updates.md
new file mode 100644
index 000000000000..1d01216b97ff
--- /dev/null
+++ b/content/github/managing-security-vulnerabilities/about-dependabot-security-updates.md
@@ -0,0 +1,35 @@
+---
+title: About Dependabot security updates
+intro: '{% data variables.product.prodname_dependabot %} can fix vulnerable dependencies for you by raising pull requests with security updates.'
+shortTitle: About Dependabot security updates
+redirect_from:
+ - /github/managing-security-vulnerabilities/about-github-dependabot-security-updates
+versions:
+ free-pro-team: '*'
+---
+
+### About {% data variables.product.prodname_dependabot_security_updates %}
+
+{% data variables.product.prodname_dependabot_security_updates %} make it easier for you to fix vulnerable dependencies in your repository. If you enable this feature, when a {% data variables.product.prodname_dependabot %} alert is raised for a vulnerable dependency in the dependency graph of your repository, {% data variables.product.prodname_dependabot %} automatically tries to fix it. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)" and "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-dependabot-security-updates)."
+
+{% data variables.product.prodname_dependabot %} checks whether it's possible to upgrade the vulnerable dependency to a fixed version without disrupting the dependency graph for the repository. Then {% data variables.product.prodname_dependabot %} raises a pull request to update the dependency to the minimum version that includes the patch and links the pull request to the {% data variables.product.prodname_dependabot %} alert, or reports an error on the alert. For more information, see "[Troubleshooting {% data variables.product.prodname_dependabot %} errors](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors)."
+
+{% note %}
+
+**Note**
+
+The {% data variables.product.prodname_dependabot_security_updates %} feature is available for repositories where you have enabled the dependency graph and {% data variables.product.prodname_dependabot_alerts %}. You will see a {% data variables.product.prodname_dependabot %} alert for every vulnerable dependency identified in your full dependency graph. However, security updates are triggered only for dependencies that are specified in a manifest or lock file. {% data variables.product.prodname_dependabot %} is unable to update an indirect or transitive dependency that is not explicitly defined. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#dependencies-included)."
+
+{% endnote %}
+
+### About pull requests for security updates
+
+Each pull request contains everything you need to quickly and safely review and merge a proposed fix into your project. This includes information about the vulnerability like release notes, changelog entries, and commit details. Details of which vulnerability a pull request resolves are hidden from anyone who does not have access to {% data variables.product.prodname_dependabot_alerts %} for the repository.
+
+When you merge a pull request that contains a security update, the corresponding {% data variables.product.prodname_dependabot %} alert is marked as resolved for your repository. For more information about {% data variables.product.prodname_dependabot %} pull requests, see "[Managing pull requests for dependency updates](/github/administering-a-repository/managing-pull-requests-for-dependency-updates)."
+
+{% data reusables.dependabot.automated-tests-note %}
+
+### About compatibility scores
+
+{% data variables.product.prodname_dependabot_security_updates %} may include compatibility scores to let you know whether updating a vulnerability could cause breaking changes to your project. These are calculated from CI tests in other public repositories where the same security update has been generated. An update's compatibility score is the percentage of CI runs that passed when updating between specific versions of the dependency.
diff --git a/content/github/managing-security-vulnerabilities/browsing-security-vulnerabilities-in-the-github-advisory-database.md b/content/github/managing-security-vulnerabilities/browsing-security-vulnerabilities-in-the-github-advisory-database.md
index 19e110d291ff..4b58d7b89790 100644
--- a/content/github/managing-security-vulnerabilities/browsing-security-vulnerabilities-in-the-github-advisory-database.md
+++ b/content/github/managing-security-vulnerabilities/browsing-security-vulnerabilities-in-the-github-advisory-database.md
@@ -1,6 +1,7 @@
---
title: Browsing security vulnerabilities in the GitHub Advisory Database
intro: 'The {% data variables.product.prodname_advisory_database %} allows you to browse or search for vulnerabilities that affect open source projects on {% data variables.product.company_short %}.'
+shortTitle: Browsing the Advisory Database
versions:
free-pro-team: '*'
---
diff --git a/content/github/managing-security-vulnerabilities/configuring-github-dependabot-security-updates.md b/content/github/managing-security-vulnerabilities/configuring-dependabot-security-updates.md
similarity index 55%
rename from content/github/managing-security-vulnerabilities/configuring-github-dependabot-security-updates.md
rename to content/github/managing-security-vulnerabilities/configuring-dependabot-security-updates.md
index 990601c5bf82..a834954969c5 100644
--- a/content/github/managing-security-vulnerabilities/configuring-github-dependabot-security-updates.md
+++ b/content/github/managing-security-vulnerabilities/configuring-dependabot-security-updates.md
@@ -1,34 +1,21 @@
---
-title: Configuring GitHub Dependabot security updates
+title: Configuring Dependabot security updates
intro: 'You can use {% data variables.product.prodname_dependabot_security_updates %} or manual pull requests to easily update vulnerable dependencies.'
+shortTitle: Configuring Dependabot security updates
redirect_from:
- /articles/configuring-automated-security-fixes
- /github/managing-security-vulnerabilities/configuring-automated-security-fixes
- /github/managing-security-vulnerabilities/configuring-automated-security-updates
+ - /github/managing-security-vulnerabilities/configuring-github-dependabot-security-updates
versions:
free-pro-team: '*'
---
-### About {% data variables.product.prodname_dependabot_security_updates %}
+### About configuring {% data variables.product.prodname_dependabot_security_updates %}
-{% data variables.product.prodname_dependabot_short %} monitors security advisories such as the {% data variables.product.prodname_advisory_database %} and [WhiteSource](https://www.whitesourcesoftware.com/vulnerability-database) and automatically triggers a pull request when it detects a new vulnerable dependency in the dependency graph of repositories. For more information about the {% data variables.product.prodname_advisory_database %}, see "[About the {% data variables.product.prodname_advisory_database %}](/github/managing-security-vulnerabilities/browsing-security-vulnerabilities-in-the-github-advisory-database#about-the-github-advisory-database)."
+You can enable {% data variables.product.prodname_dependabot_security_updates %} for any repository that uses {% data variables.product.prodname_dependabot_alerts %} and the dependency graph. For more information, see "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)."
-{% data reusables.dependabot.upgrade-dependency-to-minimum-secure-version %}
-
-{% data variables.product.prodname_dependabot_short %} includes a link to the pull request in the alert for the vulnerable dependency. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)" and "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)."
-
-Each security update contains everything you need to quickly and safely review and merge a proposed fix into your project. This includes information about the vulnerability like release notes, changelog entries, and commit details. Details of which vulnerability a pull request resolves are hidden from anyone who does not have access to {% data variables.product.prodname_dependabot_short %} alerts for the repository.
-
-When you merge a pull request that contains a security update, the corresponding alert is marked as resolved for your repository.
-
-{% note %}
-
-**Note**
-{% data variables.product.prodname_dependabot_security_updates %} only resolve security vulnerabilities in the dependencies tracked by your dependency graph. Security updates are not created to resolve vulnerabilities in private registries or packages hosted in private repositories. However, indirect or transitive dependencies are included if they are explicitly defined in a lock file, or similar. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)." Additionally, it's important to highlight that {% data variables.product.prodname_dependabot_security_updates %} automatically create pulls requests with proposed fixes to the lock files, for the dependencies detected as vulnerable.
-
-{% endnote %}
-
-You can enable {% data variables.product.prodname_dependabot_security_updates %} for any repository that uses {% data variables.product.prodname_dependabot_short %} alerts and the dependency graph. You can disable {% data variables.product.prodname_dependabot_security_updates %} for an individual repository or for all repositories owned by your user account or organization. For more information, see "[Managing {% data variables.product.prodname_dependabot_security_updates %} for your repositories](#managing-github-dependabot-security-updates-for-your-repositories)" below.
+You can disable {% data variables.product.prodname_dependabot_security_updates %} for an individual repository or for all repositories owned by your user account or organization. For more information, see "[Managing {% data variables.product.prodname_dependabot_security_updates %} for your repositories](#managing-dependabot-security-updates-for-your-repositories)" below.
{% data reusables.dependabot.dependabot-tos %}
@@ -38,7 +25,7 @@ You can enable {% data variables.product.prodname_dependabot_security_updates %}
{% note %}
-**Note**: You can manually enable {% data variables.product.prodname_dependabot_security_updates %}, even if the repository doesn't meet some of the prerequisites below. For example, you can enable {% data variables.product.prodname_dependabot_security_updates %} on a fork, or for a package manager that isn't directly supported by following the instructions in "[Managing {% data variables.product.prodname_dependabot_security_updates %} for your repositories](#managing-github-dependabot-security-updates-for-your-repositories)."
+**Note**: You can manually enable {% data variables.product.prodname_dependabot_security_updates %}, even if the repository doesn't meet some of the prerequisites below. For example, you can enable {% data variables.product.prodname_dependabot_security_updates %} on a fork, or for a package manager that isn't directly supported by following the instructions in "[Managing {% data variables.product.prodname_dependabot_security_updates %} for your repositories](#managing-dependabot-security-updates-for-your-repositories)."
{% endnote %}
@@ -48,15 +35,11 @@ You can enable {% data variables.product.prodname_dependabot_security_updates %}
| Repository is not archived | "[Archiving repositories](/github/creating-cloning-and-archiving-repositories/archiving-repositories)" |
| Repository is public, or repository is private and you have enabled read-only analysis by {% data variables.product.prodname_dotcom %}, dependency graph, and vulnerability alerts in the repository's settings | "[Managing data use settings for your private repository](/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository)." |
| Repository contains dependency manifest file from a package ecosystem that {% data variables.product.prodname_dotcom %} supports | "[Supported package ecosystems](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#supported-package-ecosystems)" |
-| {% data variables.product.prodname_dependabot_security_updates %} are not disabled for the repository | "[Managing {% data variables.product.prodname_dependabot_security_updates %} for your repository](#managing-github-dependabot-security-updates-for-your-repositories)" |
+| {% data variables.product.prodname_dependabot_security_updates %} are not disabled for the repository | "[Managing {% data variables.product.prodname_dependabot_security_updates %} for your repository](#managing-dependabot-security-updates-for-your-repositories)" |
| Repository is not already using an integration for dependency management | "[About integrations](/github/customizing-your-github-workflow/about-integrations)" |
If security updates are not enabled for your repository and you don't know why, first try enabling them using the instructions given in the procedural sections below. If security updates are still not working, you can [contact support](https://support.github.com/contact).
-### About compatibility scores
-
-{% data variables.product.prodname_dependabot_security_updates %} also include compatibility scores to let you know whether updating a vulnerability could cause breaking changes to your project. We look at previously-passing CI tests from public repositories where we've generated a given security update to learn whether the update causes tests to fail. An update's compatibility score is the percentage of CI runs that passed when updating between relevant versions of the dependency.
-
### Managing {% data variables.product.prodname_dependabot_security_updates %} for your repositories
You can enable or disable {% data variables.product.prodname_dependabot_security_updates %} for an individual repository.
@@ -68,7 +51,7 @@ You can also enable or disable {% data variables.product.prodname_dependabot_sec
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-security %}
{% data reusables.repositories.sidebar-dependabot-alerts %}
-1. Above the list of alerts, use the drop-down menu and select or unselect **{% data variables.product.prodname_dependabot_short %} security updates**.
+1. Above the list of alerts, use the drop-down menu and select or unselect **{% data variables.product.prodname_dependabot %} security updates**.
### Further reading
diff --git a/content/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies.md b/content/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies.md
new file mode 100644
index 000000000000..2b322348118f
--- /dev/null
+++ b/content/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies.md
@@ -0,0 +1,56 @@
+---
+title: Configuring notifications for vulnerable dependencies
+shortTitle: Configuring notifications
+intro: 'Optimize how you receive notifications about {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot %}{% else %}security{% endif %} alerts.'
+versions:
+ free-pro-team: '*'
+ enterprise-server: '>=2.21'
+---
+
+### About notifications for vulnerable dependencies
+
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}When {% data variables.product.prodname_dependabot %} detects vulnerable dependencies in your repositories, we generate a {% data variables.product.prodname_dependabot %} alert and display it on the Security tab for the repository. {% data variables.product.product_name %} notifies the maintainers of affected repositories about the new alert according to their notification preferences.{% else %}When {% data variables.product.product_name %} detects vulnerable dependencies in your repositories, it sends security alerts.{% endif %}{% if currentVersion == "free-pro-team@latest" %} {% data variables.product.prodname_dependabot %} is enabled by default on all public repositories. For {% data variables.product.prodname_dependabot_alerts %}, by default, you will receive {% data variables.product.prodname_dependabot_alerts %} by email, grouped by the specific vulnerability.
+{% endif %}
+
+{% if currentVersion == "free-pro-team@latest" %}If you're an organization owner, you can enable or disable {% data variables.product.prodname_dependabot_alerts %} for all repositories in your organization with one click. You can also set whether the detection of vulnerable dependencies will be enabled or disabled for newly-created repositories. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-features-for-new-repositories)."
+{% endif %}
+
+{% if enterpriseServerVersions contains currentVersion and currentVersion == "enterprise-server@2.21" %}
+Your site administrator needs to enable security alerts for vulnerable dependencies for {% data variables.product.product_location %} before you can use the feature. For more information, see "[Enabling alerts for vulnerable dependencies on {% data variables.product.prodname_ghe_server %}](/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server)."{% endif %}
+
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.20" %}
+By default, if your site administrator has configured email for notifications on your enterprise, you will receive {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %} by email.{% endif %}
+
+{% if currentVersion ver_gt "enterprise-server@2.21" %}Site administrators can also enable {% data variables.product.prodname_dependabot_alerts %} without notifications. For more information, see "[Enabling {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies on {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server)."{% endif %}
+
+{% if currentVersion ver_lt "enterprise-server@2.22" %}Site administrators can also enable security alerts without notifications. For more information, see "[Enabling security alerts for vulnerable dependencies on {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server)."{% endif %}
+
+### Configuring notifications for {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %}
+
+You can configure notification settings for yourself or your organization from the Manage notifications drop-down {% octicon "bell" aria-label="The notifications bell" %} shown at the top of each page. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#choosing-your-notification-settings)."
+
+{% data reusables.notifications.vulnerable-dependency-notification-delivery-method-customization %}
+{% data reusables.notifications.vulnerable-dependency-notification-options %}
+
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
+ 
+{% else %}
+ 
+{% endif %}
+
+{% note %}
+
+**Note:** You can filter your {% data variables.product.company_short %} inbox notifications to show {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot %}{% else %} security{% endif %} alerts. For more information, see "[Managing notifications from your inbox](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#supported-queries-for-custom-filters)."
+
+{% endnote %}
+
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" % %}{% data reusables.repositories.security-alerts-x-github-severity %} For more information, see {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}"[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#filtering-email-notifications){% else %}"[About email notifications](/github/receiving-notifications-about-activity-on-github/about-email-notifications){% endif %}."{% endif %}
+
+### How to reduce the noise from notifications for vulnerable dependencies
+
+If you are concerned about receiving too many notifications for {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %}, we recommend you opt into the weekly email digest, or turn off notifications while keeping {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %} enabled. You can still navigate to see your {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %} in your repository's Security tab.{% if currentVersion == "free-pro-team@latest" %} For more information, see "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)."{% endif %}
+
+### Further reading
+
+- "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications)"
+- "[Managing notifications from your inbox](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#supported-is-queries)"
diff --git a/content/github/managing-security-vulnerabilities/index.md b/content/github/managing-security-vulnerabilities/index.md
index a4285a6d86d7..819e4c4e2494 100644
--- a/content/github/managing-security-vulnerabilities/index.md
+++ b/content/github/managing-security-vulnerabilities/index.md
@@ -28,8 +28,11 @@ versions:
{% link_in_list /browsing-security-vulnerabilities-in-the-github-advisory-database %}
{% link_in_list /about-alerts-for-vulnerable-dependencies %}
+ {% link_in_list /configuring-notifications-for-vulnerable-dependencies %}
- {% link_in_list /configuring-github-dependabot-security-updates %}
+ {% link_in_list /about-dependabot-security-updates %}
+ {% link_in_list /configuring-dependabot-security-updates %}
{% link_in_list /viewing-and-updating-vulnerable-dependencies-in-your-repository %}
{% link_in_list /troubleshooting-the-detection-of-vulnerable-dependencies %}
+ {% link_in_list /troubleshooting-dependabot-errors %}
diff --git a/content/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors.md b/content/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors.md
new file mode 100644
index 000000000000..c33aa46aba6a
--- /dev/null
+++ b/content/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors.md
@@ -0,0 +1,84 @@
+---
+title: Troubleshooting Dependabot errors
+intro: 'Sometimes {% data variables.product.prodname_dependabot %} is unable to raise a pull request to update your dependencies. You can review the error and unblock {% data variables.product.prodname_dependabot %}.'
+shortTitle: Troubleshooting errors
+redirect_from:
+ - /github/managing-security-vulnerabilities/troubleshooting-github-dependabot-errors
+versions:
+ free-pro-team: '*'
+---
+
+{% data reusables.dependabot.beta-note %}
+
+### About {% data variables.product.prodname_dependabot %} errors
+
+{% data reusables.dependabot.pull-request-introduction %}
+
+If anything prevents {% data variables.product.prodname_dependabot %} from raising a pull request, this is reported as an error.
+
+### Investigating errors with {% data variables.product.prodname_dependabot_security_updates %}
+
+When {% data variables.product.prodname_dependabot %} is blocked from creating a pull request to fix a {% data variables.product.prodname_dependabot %} alert, it posts the error message on the alert. The {% data variables.product.prodname_dependabot_alerts %} view shows a list of any alerts that have not been resolved yet. To access the alerts view, click **{% data variables.product.prodname_dependabot_alerts %}** on the **Security** tab for the repository. Where a pull request that will fix the vulnerable dependency has been generated, the alert includes a link to that pull request.
+
+
+
+There are three reasons why an alert may have no pull request link:
+
+1. {% data variables.product.prodname_dependabot_security_updates %} are not enabled for the repository.
+1. The alert is for an indirect or transitive dependency that is not explicitly defined in a lock file.
+1. An error blocked {% data variables.product.prodname_dependabot %} from creating a pull request.
+
+If an error blocked {% data variables.product.prodname_dependabot %} from creating a pull request, you can display details of the error by clicking the alert.
+
+
+
+### Investigating errors with {% data variables.product.prodname_dependabot_version_updates %}
+
+When {% data variables.product.prodname_dependabot %} is blocked from creating a pull request to update a dependency in an ecosystem, it posts the error icon on the manifest file. The manifest files that are managed by {% data variables.product.prodname_dependabot %} are listed on the {% data variables.product.prodname_dependabot %} tab. To access this tab, on the **Insights** tab for the repository click **Dependency graph**, and then click the **{% data variables.product.prodname_dependabot %}** tab.
+
+
+
+To see the log file for any manifest file, click the **Last checked TIME ago** link. When you display the log file for a manifest that's shown with an error symbol (for example, Maven in the screenshot above), any errors are also displayed.
+
+
+
+### Understanding {% data variables.product.prodname_dependabot %} errors
+
+Pull requests for security updates act to upgrade a vulnerable dependency to the minimum version that includes a fix for the vulnerability. In contrast, pull requests for version updates act to upgrade a dependency to the latest version allowed by the package manifest and {% data variables.product.prodname_dependabot %} configuration files. Consequently, some errors are specific to one type of update.
+
+#### {% data variables.product.prodname_dependabot %} cannot update DEPENDENCY to a non-vulnerable version
+
+**Security updates only.** {% data variables.product.prodname_dependabot %} cannot create a pull request to update the vulnerable dependency to a secure version without breaking other dependencies in the dependency graph for this repository.
+
+Every application that has dependencies has a dependency graph, that is, a directed acyclic graph of every package version that the application directly or indirectly depends on. Every time a dependency is updated, this graph must resolve otherwise the application won't build. When an ecosystem has a deep and complex dependency graph, for example, npm and RubyGems, it is often impossible to upgrade a single dependency without upgrading the whole ecosystem.
+
+The best way to avoid this problem is to stay up to date with the most recently released versions, for example, by enabling version updates. This increases the likelihood that a vulnerability in one dependency can be resolved by a simple upgrade that doesn't break the dependency graph. For more information, see "[Enabling and disabling version updates](/github/administering-a-repository/enabling-and-disabling-version-updates)."
+
+#### {% data variables.product.prodname_dependabot %} cannot update to the required version as there is already an open pull request for the latest version
+
+**Security updates only.** {% data variables.product.prodname_dependabot %} will not create a pull request to update the vulnerable dependency to a secure version because there is already an open pull request to update this dependency. You will see this error when a vulnerability is detected in a single dependency and there's already an open pull request to update the dependency to the latest version.
+
+There are two options: you can review the open pull request and merge it as soon as you are confident that the change is safe, or close that pull request and trigger a new security update pull request. For more information, see "[Triggering a {% data variables.product.prodname_dependabot %} pull request manually](#triggering-a-dependabot-pull-request-manually)."
+
+#### {% data variables.product.prodname_dependabot %} timed out during its update
+
+{% data variables.product.prodname_dependabot %} took longer than the maximum time allowed to assess the update required and prepare a pull request. This error is usually seen only for large repositories with many manifest files, for example, npm or yarn monorepo projects with hundreds of *package.json* files. Updates to the Composer ecosystem also take longer to assess and may time out.
+
+This error is difficult to address. If a version update times out, you could specify the most important dependencies to update using the `allow` parameter or, alternatively, use the `ignore` parameter to exclude some dependencies from updates. Updating your configuration might allow {% data variables.product.prodname_dependabot %} to review the version update and generate the pull request in the time available.
+
+If a security update times out, you can reduce the chances of this happening by keeping the dependencies updated, for example, by enabling version updates. For more information, see "[Enabling and disabling version updates](/github/administering-a-repository/enabling-and-disabling-version-updates)."
+
+#### {% data variables.product.prodname_dependabot %} cannot open any more pull requests
+
+There's a limit on the number of open pull requests {% data variables.product.prodname_dependabot %} will generate. When this limit is reached, no new pull requests are opened and this error is reported. The best way to resolve this error is to review and merge some of the open pull requests.
+
+There are separate limits for security and version update pull requests, so that open version update pull requests cannot block the creation of a security update pull request. The limit for security update pull requests is 10. By default, the limit for version updates is 5 but you can change this using the `open-pull-requests-limit` parameter in the configuration file. For more information, see "[Configuration options for dependency updates](/github/administering-a-repository/configuration-options-for-dependency-updates#open-pull-requests-limit)."
+
+The best way to resolve this error is to merge or close some of the existing pull requests and trigger a new pull request manually. For more information, see "[Triggering a {% data variables.product.prodname_dependabot %} pull request manually](#triggering-a-dependabot-pull-request-manually)."
+
+### Triggering a {% data variables.product.prodname_dependabot %} pull request manually
+
+If you unblock {% data variables.product.prodname_dependabot %}, you can manually trigger a fresh attempt to create a pull request.
+
+- **Security updates**—display the {% data variables.product.prodname_dependabot %} alert that shows the error you have fixed and click **Create {% data variables.product.prodname_dependabot %} security update**.
+- **Version updates**—display the log file for the manifest that shows the error that you have fixed and click **Check for updates**.
diff --git a/content/github/managing-security-vulnerabilities/troubleshooting-the-detection-of-vulnerable-dependencies.md b/content/github/managing-security-vulnerabilities/troubleshooting-the-detection-of-vulnerable-dependencies.md
index 09109cb63f89..ce6fe1bc8eba 100644
--- a/content/github/managing-security-vulnerabilities/troubleshooting-the-detection-of-vulnerable-dependencies.md
+++ b/content/github/managing-security-vulnerabilities/troubleshooting-the-detection-of-vulnerable-dependencies.md
@@ -1,6 +1,7 @@
---
title: Troubleshooting the detection of vulnerable dependencies
intro: 'If the dependency information reported by {% data variables.product.product_name %} is not what you expected, there are a number of points to consider, and various things you can check.'
+shortTitle: Troubleshooting detection
versions:
free-pro-team: '*'
---
@@ -13,14 +14,14 @@ The results of dependency detection reported by {% data variables.product.produc
* {% data variables.product.prodname_advisory_database %} is one of the data sources that {% data variables.product.prodname_dotcom %} uses to identify vulnerable dependencies. It's a free, curated database of vulnerability information for common package ecosystems on {% data variables.product.prodname_dotcom %}. It includes both data reported directly to {% data variables.product.prodname_dotcom %} from {% data variables.product.prodname_security_advisories %}, as well as official feeds and community sources. This data is reviewed and curated by {% data variables.product.prodname_dotcom %} to ensure that false or unactionable information is not shared with the development community. For more information, see "[Browsing security vulnerabilities in the {% data variables.product.prodname_advisory_database %}](/github/managing-security-vulnerabilities/browsing-security-vulnerabilities-in-the-github-advisory-database)" and "[About {% data variables.product.prodname_security_advisories %}](/github/managing-security-vulnerabilities/about-github-security-advisories)."
* The dependency graph parses all known package manifest files in a user’s repository. For example, for npm it will parse the _package-lock.json_ file. It constructs a graph of all of the repository’s dependencies and public dependents. This happens when you enable the dependency graph and when anyone pushes to the default branch, and it includes commits that makes changes to a supported manifest format. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)."
-* {% data variables.product.prodname_dependabot_short %} scans any push, to the default branch, that contains a manifest file. When a new vulnerability record is added, it scans all existing repositories and generates an alert for each vulnerable repository. {% data variables.product.prodname_dependabot_short %} alerts are aggregated at the repository level, rather than creating one alert per vulnerability. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)."
-* {% data variables.product.prodname_dependabot_security_updates %} are triggered when you receive a security alert about a vulnerable dependency in your repository. {% data variables.product.prodname_dotcom %} automatically creates a pull request in your repository to upgrade the vulnerable dependency to the minimum possible secure version needed to avoid the vulnerability. For more information, see "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-github-dependabot-security-updates)."
+* {% data variables.product.prodname_dependabot %} scans any push, to the default branch, that contains a manifest file. When a new vulnerability record is added, it scans all existing repositories and generates an alert for each vulnerable repository. {% data variables.product.prodname_dependabot_alerts %} are aggregated at the repository level, rather than creating one alert per vulnerability. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)."
+* {% data variables.product.prodname_dependabot_security_updates %} are triggered when you receive an alert about a vulnerable dependency in your repository. Where possible, {% data variables.product.prodname_dependabot %} creates a pull request in your repository to upgrade the vulnerable dependency to the minimum possible secure version needed to avoid the vulnerability. For more information, see "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)" and "[Troubleshooting {% data variables.product.prodname_dependabot %} errors](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors)."
- {% data variables.product.prodname_dependabot_short %} doesn't scan repositories on a schedule, but rather when something changes. For example, a scan is triggered when a new dependency is added ({% data variables.product.prodname_dotcom %} checks for this on every push), or when a new vulnerability is discovered and added to the advisory database.
+ {% data variables.product.prodname_dependabot %} doesn't scan repositories for vulnerable dependencies on a schedule, but rather when something changes. For example, a scan is triggered when a new dependency is added ({% data variables.product.prodname_dotcom %} checks for this on every push), or when a new vulnerability is discovered and added to the advisory database.
### Why don't I get vulnerability alerts for some ecosystems?
-{% data variables.product.prodname_dotcom %} limits its support for vulnerability alerts to a set of ecosystems where we can provide high-quality, actionable data. Curated vulnerabilities in the {% data variables.product.prodname_advisory_database %}, the dependency graph, {% data variables.product.prodname_dependabot_short %} alerts, and {% data variables.product.prodname_dependabot_short %} security updates are provided for several ecosystems, including Java’s Maven, JavaScript’s npm and Yarn, .NET’s NuGet, Python’s pip, Ruby's RubyGems, and PHP’s Composer. We'll continue to add support for more ecosystems over time. For an overview of the package ecosystems that we support, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#supported-package-ecosystems)."
+{% data variables.product.prodname_dotcom %} limits its support for vulnerability alerts to a set of ecosystems where we can provide high-quality, actionable data. Curated vulnerabilities in the {% data variables.product.prodname_advisory_database %}, the dependency graph, {% data variables.product.prodname_dependabot_alerts %}, and {% data variables.product.prodname_dependabot %} security updates are provided for several ecosystems, including Java’s Maven, JavaScript’s npm and Yarn, .NET’s NuGet, Python’s pip, Ruby's RubyGems, and PHP’s Composer. We'll continue to add support for more ecosystems over time. For an overview of the package ecosystems that we support, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#supported-package-ecosystems)."
It's worth noting that [{% data variables.product.prodname_dotcom %} Security Advisories](/github/managing-security-vulnerabilities/about-github-security-advisories) may exist for other ecosystems. The information in a security advisory is provided by the maintainers of a particular repository. This data is not curated in the same way as information for the supported ecosystems.
@@ -30,7 +31,7 @@ It's worth noting that [{% data variables.product.prodname_dotcom %} Security Ad
The dependency graph includes information on dependencies that are explicitly declared in your environment. That is, dependencies that are specified in a manifest or a lockfile. The dependency graph generally also includes transitive dependencies, even when they aren't specified in a lockfile, by looking at the dependencies of the dependencies in a manifest file.
-{% data variables.product.prodname_dependabot_short %} alerts advise you about dependencies you should update, including transitive dependencies, where the version can be determined from a manifest or a lockfile. {% data variables.product.prodname_dependabot_short %} security updates only suggests a change where it can directly "fix" the dependency, that is, when these are:
+{% data variables.product.prodname_dependabot_alerts %} advise you about dependencies you should update, including transitive dependencies, where the version can be determined from a manifest or a lockfile. {% data variables.product.prodname_dependabot %} security updates only suggests a change where it can directly "fix" the dependency, that is, when these are:
* Direct dependencies explicitly declared in a manifest or lockfile
* Transitive dependencies declared in a lockfile
@@ -50,21 +51,21 @@ Yes, the dependency graph has two categories of limits:
1. **Processing limits**
- These affect the dependency graph displayed within {% data variables.product.prodname_dotcom %} and also prevent {% data variables.product.prodname_dependabot_short %} alerts being created.
+ These affect the dependency graph displayed within {% data variables.product.prodname_dotcom %} and also prevent {% data variables.product.prodname_dependabot_alerts %} being created.
- Manifests over 0.5 MB in size are only processed for enterprise accounts. For other accounts, manifests over 0.5 MB are ignored and will not create {% data variables.product.prodname_dependabot_short %} alerts.
+ Manifests over 0.5 MB in size are only processed for enterprise accounts. For other accounts, manifests over 0.5 MB are ignored and will not create {% data variables.product.prodname_dependabot_alerts %}.
- By default, {% data variables.product.prodname_dotcom %} will not process more than 20 manifests per repository. {% data variables.product.prodname_dependabot_short %} alerts are not be created for manifests beyond this limit. If you need to increase the limit, contact {% data variables.contact.contact_support %}.
+ By default, {% data variables.product.prodname_dotcom %} will not process more than 20 manifests per repository. {% data variables.product.prodname_dependabot_alerts %} are not be created for manifests beyond this limit. If you need to increase the limit, contact {% data variables.contact.contact_support %}.
2. **Visualization limits**
- These affect what's displayed in the dependency graph within {% data variables.product.prodname_dotcom %}. However, they don't affect the {% data variables.product.prodname_dependabot_short %} alerts that are created.
+ These affect what's displayed in the dependency graph within {% data variables.product.prodname_dotcom %}. However, they don't affect the {% data variables.product.prodname_dependabot_alerts %} that are created.
- The Dependencies view of the dependency graph for a repository only displays 100 manifests. Typically this is adequate as it is significantly higher than the processing limit described above. In situations where the processing limit is over 100, {% data variables.product.prodname_dependabot_short %} alerts are still created for any manifests that are not shown within {% data variables.product.prodname_dotcom %}.
+ The Dependencies view of the dependency graph for a repository only displays 100 manifests. Typically this is adequate as it is significantly higher than the processing limit described above. In situations where the processing limit is over 100, {% data variables.product.prodname_dependabot_alerts %} are still created for any manifests that are not shown within {% data variables.product.prodname_dotcom %}.
**Check**: Is the missing dependency in a manifest file that's over 0.5 MB, or in a repository with a large number of manifests?
-### Does {% data variables.product.prodname_dependabot_short %} generate alerts for vulnerabilities that have been known for many years?
+### Does {% data variables.product.prodname_dependabot %} generate alerts for vulnerabilities that have been known for many years?
The {% data variables.product.prodname_advisory_database %} was launched in November 2019, and initially back-filled to include vulnerability information for the supported ecosystems, starting from 2017. When adding CVEs to the database, we prioritize curating newer CVEs, and CVEs affecting newer versions of software.
@@ -76,19 +77,19 @@ Some information on older vulnerabilities is available, especially where these C
Some third-party tools use uncurated CVE data that isn't checked or filtered by a human. This means that CVEs with tagging or severity errors, or other quality issues, will cause more frequent, more noisy, and less useful alerts.
-Since {% data variables.product.prodname_dependabot_short %} uses curated data in the {% data variables.product.prodname_advisory_database %}, the volume of alerts may be lower, but the alerts you do receive will be accurate and relevant.
+Since {% data variables.product.prodname_dependabot %} uses curated data in the {% data variables.product.prodname_advisory_database %}, the volume of alerts may be lower, but the alerts you do receive will be accurate and relevant.
### Does each dependency vulnerability generate a separate alert?
When a dependency has multiple vulnerabilities, only one aggregated alert is generated for that dependency, instead of one alert per vulnerability.
-The {% data variables.product.prodname_dependabot_short %} alerts count in {% data variables.product.prodname_dotcom %} shows a total for the number of alerts, that is, the number of dependencies with vulnerabilities, not the number of vulnerabilities.
+The {% data variables.product.prodname_dependabot_alerts %} count in {% data variables.product.prodname_dotcom %} shows a total for the number of alerts, that is, the number of dependencies with vulnerabilities, not the number of vulnerabilities.
-
+
When you click to display the alert details, you can see how many vulnerabilities are included in the alert.
-
+
**Check**: If there is a discrepancy in the totals you are seeing, check that you are not comparing alert numbers with vulnerability numbers.
@@ -97,3 +98,4 @@ When you click to display the alert details, you can see how many vulnerabilitie
- "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)"
- "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)"
- "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)"
+- "[Troubleshooting {% data variables.product.prodname_dependabot %} errors](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors)"
diff --git a/content/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository.md b/content/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository.md
index bbb866e0cb9b..0dea3bd05c25 100644
--- a/content/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository.md
+++ b/content/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository.md
@@ -4,16 +4,17 @@ intro: 'If {% data variables.product.product_name %} discovers vulnerable depend
redirect_from:
- /articles/viewing-and-updating-vulnerable-dependencies-in-your-repository
permissions: Repository administrators and organization owners can view and update dependencies.
+shortTitle: Viewing and updating vulnerable dependencies
versions:
free-pro-team: '*'
---
Your repository's {% data variables.product.prodname_dependabot %} alerts tab lists all open and closed {% data variables.product.prodname_dependabot_alerts %} and corresponding {% data variables.product.prodname_dependabot_security_updates %}. You can sort the list of alerts using the drop-down menu, and you can click into specific alerts for more details. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)."
-You can enable automatic security updates for any repository that uses {% data variables.product.prodname_dependabot_alerts %} and the dependency graph. For more information, see "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-github-dependabot-security-updates)."
+You can enable automatic security updates for any repository that uses {% data variables.product.prodname_dependabot_alerts %} and the dependency graph. For more information, see "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)."
### About updates for vulnerable dependencies in your repository
-{% data variables.product.product_name %} sends {% data variables.product.prodname_dependabot_alerts %} when we detect vulnerabilities affecting your repository. For repositories where {% data variables.product.prodname_dependabot_security_updates %} are enabled, when {% data variables.product.product_name %} detects a vulnerable dependency {% data variables.product.prodname_dependabot_short %} creates a pull request to fix it. {% data reusables.dependabot.upgrade-dependency-to-minimum-secure-version %}
+{% data variables.product.product_name %} generates {% data variables.product.prodname_dependabot_alerts %} when we detect vulnerabilities affecting your repository. For repositories where {% data variables.product.prodname_dependabot_security_updates %} are enabled, when {% data variables.product.product_name %} detects a vulnerable dependency {% data variables.product.prodname_dependabot %} creates a pull request to fix it. The pull request will upgrade the dependency to the minimum possible secure version needed to avoid the vulnerability.
### Viewing and updating vulnerable dependencies
@@ -23,15 +24,16 @@ You can enable automatic security updates for any repository that uses {% data v
1. Click the alert you'd like to view.
1. Review the details of the vulnerability and, if available, the pull request containing the automated security update.
-1. Optionally, if there isn't already a {% data variables.product.prodname_dependabot_security_updates %} update for the alert, to create a pull request to resolve the vulnerability, click **Create {% data variables.product.prodname_dependabot_short %} security update**.
- 
-1. When you're ready to update your dependency and resolve the vulnerability, merge the pull request. Each pull request raised by {% data variables.product.prodname_dependabot_short %} includes information on commands you can use to control {% data variables.product.prodname_dependabot_short %}. For more information, see "[Managing pull requests for dependency updates](/github/administering-a-repository/managing-pull-requests-for-dependency-updates#managing-github-dependabot-pull-requests-with-comment-commands)."
+1. Optionally, if there isn't already a {% data variables.product.prodname_dependabot_security_updates %} update for the alert, to create a pull request to resolve the vulnerability, click **Create {% data variables.product.prodname_dependabot %} security update**.
+ 
+1. When you're ready to update your dependency and resolve the vulnerability, merge the pull request. Each pull request raised by {% data variables.product.prodname_dependabot %} includes information on commands you can use to control {% data variables.product.prodname_dependabot %}. For more information, see "[Managing pull requests for dependency updates](/github/administering-a-repository/managing-pull-requests-for-dependency-updates#managing-dependabot-pull-requests-with-comment-commands)."
1. Optionally, if the alert is being fixed, if it's incorrect, or located in unused code, use the "Dismiss" drop-down, and click a reason for dismissing the alert.
### Further reading
- "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)"
-- "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-github-dependabot-security-updates)"
+- "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-dependabot-security-updates)"
- "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)"
- "[Troubleshooting the detection of vulnerable dependencies](/github/managing-security-vulnerabilities/troubleshooting-the-detection-of-vulnerable-dependencies)"
+- "[Troubleshooting {% data variables.product.prodname_dependabot %} errors](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors)"
diff --git a/content/github/managing-subscriptions-and-notifications-on-github/about-notifications.md b/content/github/managing-subscriptions-and-notifications-on-github/about-notifications.md
index 217afbb26ed9..afbefd70ab5c 100644
--- a/content/github/managing-subscriptions-and-notifications-on-github/about-notifications.md
+++ b/content/github/managing-subscriptions-and-notifications-on-github/about-notifications.md
@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '>=2.21'
+ github-ae: '*'
---
### Notifications and subscriptions
diff --git a/content/github/managing-subscriptions-and-notifications-on-github/configuring-notifications.md b/content/github/managing-subscriptions-and-notifications-on-github/configuring-notifications.md
index 5c2b46dcb569..d7d72cd23eab 100644
--- a/content/github/managing-subscriptions-and-notifications-on-github/configuring-notifications.md
+++ b/content/github/managing-subscriptions-and-notifications-on-github/configuring-notifications.md
@@ -16,6 +16,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '>=2.21'
+ github-ae: '*'
---
### Notification delivery options
@@ -108,9 +109,9 @@ Email notifications from {% data variables.product.product_name %} contain the f
| Header | Information |
| --- | --- |
| `From` address | This address will always be {% if currentVersion == "free-pro-team@latest" %}'`notifications@github.com`'{% else %}'the no-reply email address configured by your site administrator'{% endif %}. |
-| `To` field | This field connects directly to the thread. If you reply to the email, you'll add a new comment to the conversation. |
-| `Cc` address | {% data variables.product.product_name %} will `Cc` you if you're subscribed to a conversation. The second `Cc` email address matches the notification reason. The suffix for these notification reasons is {% data variables.notifications.cc_address %}. The possible notification reasons are: - `assign`: You were assigned to an issue or pull request.
- `author`: You created an issue or pull request.
- `comment`: You commented on an issue or pull request.
- `manual`: There was an update to an issue or pull request you manually subscribed to.
- `mention`: You were mentioned on an issue or pull request.
- `push`: Someone committed to a pull request you're subscribed to.
- `review_requested`: You or a team you're a member of was requested to review a pull request.
- `security_alert`: {% data variables.product.prodname_dotcom %} detected a vulnerability in a repository you receive alerts for.
- `state_change`: An issue or pull request you're subscribed to was either closed or opened.
- `subscribed`: There was an update in a repository you're watching.
- `team_mention`: A team you belong to was mentioned on an issue or pull request.
- `your_activity`: You opened, commented on, or closed an issue or pull request.
|
-| `mailing list` field | This field identifies the name of the repository and its owner. The format of this address is always `..{% data variables.command_line.backticks %}`. |{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" % %}
+| `To` field | This field connects directly to the thread.{% if currentVersion != "github-ae@latest" %} If you reply to the email, you'll add a new comment to the conversation.{% endif %} |
+| `Cc` address | {% data variables.product.product_name %} will `Cc` you if you're subscribed to a conversation. The second `Cc` email address matches the notification reason. The suffix for these notification reasons is {% data variables.notifications.cc_address %}. The possible notification reasons are: - `assign`: You were assigned to an issue or pull request.
- `author`: You created an issue or pull request.
- `comment`: You commented on an issue or pull request.
- `manual`: There was an update to an issue or pull request you manually subscribed to.
- `mention`: You were mentioned on an issue or pull request.
- `push`: Someone committed to a pull request you're subscribed to.
- `review_requested`: You or a team you're a member of was requested to review a pull request.
{% if currentVersion != "github-ae@latest" %}- `security_alert`: {% data variables.product.prodname_dotcom %} detected a vulnerability in a repository you receive alerts for.
{% endif %}- `state_change`: An issue or pull request you're subscribed to was either closed or opened.
- `subscribed`: There was an update in a repository you're watching.
- `team_mention`: A team you belong to was mentioned on an issue or pull request.
- `your_activity`: You opened, commented on, or closed an issue or pull request.
|
+| `mailing list` field | This field identifies the name of the repository and its owner. The format of this address is always `..{% data variables.command_line.backticks %}`. |{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
| `X-GitHub-Severity` field | {% data reusables.repositories.security-alerts-x-github-severity %} The possible severity levels are:- `low`
- `moderate`
- `high`
- `critical`
For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." |{% endif %}
### Choosing your notification settings
@@ -120,7 +121,7 @@ Email notifications from {% data variables.product.product_name %} contain the f
3. On the notifications settings page, choose how you receive notifications when:
- There are updates in repositories or team discussions you're watching or in a conversation you're participating in. For more information, see "[About participating and watching notifications](#about-participating-and-watching-notifications)."
- You gain access to a new repository or you've joined a new team. For more information, see "[Automatic watching](#automatic-watching)."{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
- - There are new {% data variables.product.prodname_dependabot_alerts %} in your repository. For more information, see "[{% data variables.product.prodname_dependabot_alerts %} notification options](#github-dependabot-alerts-notification-options)." {% endif %}{% if currentVersion == "enterprise-server@2.21" %}
+ - There are new {% data variables.product.prodname_dependabot_alerts %} in your repository. For more information, see "[{% data variables.product.prodname_dependabot_alerts %} notification options](#dependabot-alerts-notification-options)." {% endif %}{% if currentVersion == "enterprise-server@2.21" %}
- There are new security alerts in your repository. For more information, see "[Security alert notification options](#security-alert-notification-options)." {% endif %} {% if currentVersion == "free-pro-team@latest" %}
- There are workflow runs updates on repositories set up with {% data variables.product.prodname_actions %}. For more information, see "[{% data variables.product.prodname_actions %} notification options](#github-actions-notification-options)."{% endif %}
@@ -152,39 +153,25 @@ If you are a member of more than one organization, you can configure each one to
{% data reusables.notifications-v2.manage-notifications %}
3. Under "Custom routing," find your organization's name in the list.
-4. Click **Edit** next to the email address you want to change.
+4. Click **Edit** next to the email address you want to change.
5. Select one of your verified email addresses, then click **Save**.
+{% if currentVersion != "github-ae@latest" %}
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
### {% data variables.product.prodname_dependabot_alerts %} notification options
{% else %}
### Security alert notification options
{% endif %}
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}Choose how you want to receive {% data variables.product.prodname_dependabot_alerts %} for repositories that you are watching. You can receive {% data variables.product.prodname_dependabot_alerts %} in your inbox, as a banner on {% data variables.product.product_name %}, on the command line, through email, or some combination of these options.
+{% data reusables.notifications.vulnerable-dependency-notification-delivery-method-customization %}
+{% data reusables.notifications.vulnerable-dependency-notification-options %}
-If you want to receive {% data variables.product.prodname_dependabot_alerts %} by email, choose whether you want a weekly email summary of vulnerabilities for up 10 repositories or a new email each time a vulnerability is detected. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)."{% endif %}
-
-{% if currentVersion == "enterprise-server@2.21" %}Choose how you want to receive security alerts for repositories that you are watching. You can receive security alerts in your inbox, as a banner on {% data variables.product.product_name %}, on the command line, through email, or some combination of these options.
-
-If you want to receive security alerts by email, choose whether you want a weekly email summary of vulnerabilities for up 10 repositories or a new email each time a vulnerability is detected. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)."{% endif %}
-
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
- 
-{% else %}
- 
+For more information about the notification delivery methods available to you, and advice on optimizing your notifications for {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %}, see "[Configuring notifications for vulnerable dependencies](/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies)."
{% endif %}
-{% note %}
-
-**Note:** You can filter your {% data variables.product.company_short %} inbox notifications by {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_short %}{% else %} security{% endif %} alerts. For more information, see "[Managing notifications from your inbox](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#supported-queries-for-custom-filters)."
-
-{% endnote %}
-
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
-
### {% data variables.product.prodname_actions %} notification options
Choose how you want to receive workflow run updates for repositories that you are watching that are set up with {% data variables.product.prodname_actions %}. You can also choose to only receive notifications for failed workflow runs.
@@ -194,7 +181,6 @@ Choose how you want to receive workflow run updates for repositories that you ar
{% endif %}
{% if currentVersion == "free-pro-team@latest" %}
-
### Enabling push notifications with {% data variables.product.prodname_mobile %}
When you install {% data variables.product.prodname_mobile %}, you will automatically be opted into web notifications. You can then enable push notifications for direct mentions within the app.
diff --git a/content/github/managing-subscriptions-and-notifications-on-github/customizing-a-workflow-for-triaging-your-notifications.md b/content/github/managing-subscriptions-and-notifications-on-github/customizing-a-workflow-for-triaging-your-notifications.md
index 39ecfecef48e..8a458d1456c1 100644
--- a/content/github/managing-subscriptions-and-notifications-on-github/customizing-a-workflow-for-triaging-your-notifications.md
+++ b/content/github/managing-subscriptions-and-notifications-on-github/customizing-a-workflow-for-triaging-your-notifications.md
@@ -4,6 +4,7 @@ intro: 'To create an ideal workflow for triaging your notifications, you can ada
versions:
free-pro-team: '*'
enterprise-server: '>=2.21'
+ github-ae: '*'
---
### Starting your inbox triage
diff --git a/content/github/managing-subscriptions-and-notifications-on-github/index.md b/content/github/managing-subscriptions-and-notifications-on-github/index.md
index 9bd9f13b0a8b..ed54e4ee58c3 100644
--- a/content/github/managing-subscriptions-and-notifications-on-github/index.md
+++ b/content/github/managing-subscriptions-and-notifications-on-github/index.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '>=2.21'
+ github-ae: '*'
---
### Table of Contents
diff --git a/content/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox.md b/content/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox.md
index 940fb73c593a..01b445461a63 100644
--- a/content/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox.md
+++ b/content/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '>=2.21'
+ github-ae: '*'
---
### About your inbox
@@ -81,6 +82,7 @@ Custom filters do not currently support:
- Distinguishing between the `is:issue`, `is:pr`, and `is:pull-request` query filters. These queries will return both issues and pull requests.
- Creating more than 15 custom filters.
- Changing the default filters or their order.
+ - Search [exclusion](/github/searching-for-information-on-github/understanding-the-search-syntax#exclude-certain-results) using `NOT` or `-QUALIFIER`.
### Supported queries for custom filters
@@ -104,26 +106,30 @@ To filter notifications by why you've received an update, you can use the `reaso
| `reason:invitation` | When you're invited to a team, organization, or repository.
| `reason:manual` | When you click **Subscribe** on an issue or pull request you weren't already subscribed to.
| `reason:mention` | You were directly @mentioned.
-| `reason:review-requested` | You or a team you're on have been requested to review a pull request.
-| `reason:security-alert` | When a security alert is issued for a repository.
+| `reason:review-requested` | You or a team you're on have been requested to review a pull request.{% if currentVersion != "github-ae@latest" %}
+| `reason:security-alert` | When a security alert is issued for a repository.{% endif %}
| `reason:state-change` | When the state of a pull request or issue is changed. For example, an issue is closed or a pull request is merged.
| `reason:team-mention` | When a team you're a member of is @mentioned.
| `reason:ci-activity` | When a repository has a CI update, such as a new workflow run status.
#### Supported `is:` queries
-To filter notifications for specific activity on {% data variables.product.product_name %}, you can use the `is` query. For example, to only see repository invitation updates, use `is:repository-invitation`, and to only see {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_short %}{% else %} security{% endif %} alerts, use `is:repository-vulnerability-alert`.
+To filter notifications for specific activity on {% data variables.product.product_name %}, you can use the `is` query. For example, to only see repository invitation updates, use `is:repository-invitation`{% if currentVersion != "github-ae@latest" %}, and to only see {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot %}{% else %} security{% endif %} alerts, use `is:repository-vulnerability-alert`.{% endif %}
- `is:check-suite`
- `is:commit`
- `is:gist`
- `is:issue-or-pull-request`
- `is:release`
-- `is:repository-invitation`
+- `is:repository-invitation`{% if currentVersion != "github-ae@latest" %}
- `is:repository-vulnerability-alert`
-- `is:repository-advisory`
+- `is:repository-advisory`{% endif %}
- `is:team-discussion`
+{% if currentVersion != "github-ae@latest" %}
+For information about reducing noise from notifications for {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %}, see "[Configuring notifications for vulnerable dependencies](/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies)."
+{% endif %}
+
You can also use the `is:` query to describe how the notification was triaged.
- `is:saved`
diff --git a/content/github/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github.md b/content/github/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github.md
index 414c69beff47..57f54410c0a4 100644
--- a/content/github/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github.md
+++ b/content/github/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github.md
@@ -5,5 +5,6 @@ mapTopic: true
versions:
free-pro-team: '*'
enterprise-server: '>=2.21'
+ github-ae: '*'
---
diff --git a/content/github/managing-subscriptions-and-notifications-on-github/managing-your-subscriptions.md b/content/github/managing-subscriptions-and-notifications-on-github/managing-your-subscriptions.md
index e9253f1908bd..61c76056d9ec 100644
--- a/content/github/managing-subscriptions-and-notifications-on-github/managing-your-subscriptions.md
+++ b/content/github/managing-subscriptions-and-notifications-on-github/managing-your-subscriptions.md
@@ -4,6 +4,7 @@ intro: 'To help you manage your notifications efficiently, there are several way
versions:
free-pro-team: '*'
enterprise-server: '>=2.21'
+ github-ae: '*'
---
To help you understand your subscriptions and decide whether to unsubscribe, see "[Viewing your subscriptions](/github/managing-subscriptions-and-notifications-on-github/viewing-your-subscriptions)."
@@ -38,7 +39,7 @@ When you unsubscribe from notifications in your inbox, they will automatically d
{% data reusables.notifications.access_notifications %}
1. From the notifications inbox, select the notifications you want to unsubscribe to.
-2. Use the the **selected** {% octicon "triangle-down" aria-label="The down triangle icon" %} drop-down to click **Unsubscribe.**
+2. Use the **selected** {% octicon "triangle-down" aria-label="The down triangle icon" %} drop-down to click **Unsubscribe.**
### Unsubscribing from notifications on the subscriptions page
diff --git a/content/github/managing-subscriptions-and-notifications-on-github/setting-up-notifications.md b/content/github/managing-subscriptions-and-notifications-on-github/setting-up-notifications.md
index 0d776b57fa0d..ba87f0c7c00f 100644
--- a/content/github/managing-subscriptions-and-notifications-on-github/setting-up-notifications.md
+++ b/content/github/managing-subscriptions-and-notifications-on-github/setting-up-notifications.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '>=2.21'
+ github-ae: '*'
---
diff --git a/content/github/managing-subscriptions-and-notifications-on-github/triaging-a-single-notification.md b/content/github/managing-subscriptions-and-notifications-on-github/triaging-a-single-notification.md
index 2c47e8caa0d4..a6210db1b2d4 100644
--- a/content/github/managing-subscriptions-and-notifications-on-github/triaging-a-single-notification.md
+++ b/content/github/managing-subscriptions-and-notifications-on-github/triaging-a-single-notification.md
@@ -4,6 +4,7 @@ intro: 'When you review and investigate a single notification, you have several
versions:
free-pro-team: '*'
enterprise-server: '>=2.21'
+ github-ae: '*'
---
### Saving a single notification
diff --git a/content/github/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications.md b/content/github/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications.md
index bd243beb39a9..761e8487ea03 100644
--- a/content/github/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications.md
+++ b/content/github/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications.md
@@ -8,5 +8,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '>=2.21'
+ github-ae: '*'
---
diff --git a/content/github/managing-subscriptions-and-notifications-on-github/viewing-your-subscriptions.md b/content/github/managing-subscriptions-and-notifications-on-github/viewing-your-subscriptions.md
index c1b0c11b7c19..309dce41815a 100644
--- a/content/github/managing-subscriptions-and-notifications-on-github/viewing-your-subscriptions.md
+++ b/content/github/managing-subscriptions-and-notifications-on-github/viewing-your-subscriptions.md
@@ -17,6 +17,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '>=2.21'
+ github-ae: '*'
---
You receive notifications for your subscriptions of ongoing activity on {% data variables.product.product_name %}. There are many reasons you can be subscribed to a conversation. For more information, see "[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications#notifications-and-subscriptions)."
diff --git a/content/github/managing-your-work-on-github/about-automation-for-issues-and-pull-requests-with-query-parameters.md b/content/github/managing-your-work-on-github/about-automation-for-issues-and-pull-requests-with-query-parameters.md
index f2ce265a2a58..39b913c7c21c 100644
--- a/content/github/managing-your-work-on-github/about-automation-for-issues-and-pull-requests-with-query-parameters.md
+++ b/content/github/managing-your-work-on-github/about-automation-for-issues-and-pull-requests-with-query-parameters.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Query parameters are optional parts of a URL you can customize to share a specific web page view, such as search filter results or an issue template on {% data variables.product.prodname_dotcom %}. To create your own query parameters, you must match the key and value pair.
diff --git a/content/github/managing-your-work-on-github/about-automation-for-project-boards.md b/content/github/managing-your-work-on-github/about-automation-for-project-boards.md
index a98102fe88d8..1a6b04071ace 100644
--- a/content/github/managing-your-work-on-github/about-automation-for-project-boards.md
+++ b/content/github/managing-your-work-on-github/about-automation-for-project-boards.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.project-management.automate-project-board-permissions %} For more information, see "[Project board permissions for an organization](/articles/project-board-permissions-for-an-organization)."
@@ -29,7 +30,10 @@ Project board automation can also help teams develop a shared understanding of a
| Done | - Move all closed issues here
- Move all merged pull requests here
- Move all closed, unmerged pull requests here
|
### Project progress tracking
-Project board automation enables progress tracking by default. Cards in columns with the "To do", "In progress", or "Done" presets count toward the overall project progress. {% data reusables.project-management.project-progress-locations %}
+
+You can track the progress on your project board. Cards in the "To do", "In progress", or "Done" columns count toward the overall project progress. {% data reusables.project-management.project-progress-locations %}
+
+For more information, see "[Tracking progress on your project board](/github/managing-your-work-on-github/tracking-progress-on-your-project-board)."
### Further reading
- "[Configuring automation for project boards](/articles/configuring-automation-for-project-boards)"{% if currentVersion == "free-pro-team@latest" %}
diff --git a/content/github/managing-your-work-on-github/about-duplicate-issues-and-pull-requests.md b/content/github/managing-your-work-on-github/about-duplicate-issues-and-pull-requests.md
index 7baddee437f6..f1b544a09405 100644
--- a/content/github/managing-your-work-on-github/about-duplicate-issues-and-pull-requests.md
+++ b/content/github/managing-your-work-on-github/about-duplicate-issues-and-pull-requests.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
For a "marked as duplicate" timeline event to appear, the user who creates the duplicate reference comment must have write access to the repository where they create the comment.
diff --git a/content/github/managing-your-work-on-github/about-issues.md b/content/github/managing-your-work-on-github/about-issues.md
index 8d4533765bbc..dfabe37b53f2 100644
--- a/content/github/managing-your-work-on-github/about-issues.md
+++ b/content/github/managing-your-work-on-github/about-issues.md
@@ -7,13 +7,14 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
You can collect user feedback, report software bugs, and organize tasks you'd like to accomplish with issues in a repository. Issues can act as more than just a place to report software bugs.
{% data reusables.pull_requests.close-issues-using-keywords %}
-To stay updated on the most recent comments in an issue, you can watch an issue to receive notifications about the latest comments. For more information, see {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}"[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications){% else %}"[About notifications](/github/receiving-notifications-about-activity-on-github/about-notifications){% endif %}."
+To stay updated on the most recent comments in an issue, you can watch an issue to receive notifications about the latest comments. For more information, see {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}"[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications){% else %}"[About notifications](/github/receiving-notifications-about-activity-on-github/about-notifications){% endif %}."
To quickly find links to recently updated issues you're subscribed to, visit your dashboard. For more information, see "[About your personal dashboard](/articles/about-your-personal-dashboard)."
diff --git a/content/github/managing-your-work-on-github/about-labels.md b/content/github/managing-your-work-on-github/about-labels.md
index 9e98a8398f2c..a31b995ee4b1 100644
--- a/content/github/managing-your-work-on-github/about-labels.md
+++ b/content/github/managing-your-work-on-github/about-labels.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Labels are tied to the repository they are created in. Once a label exists, you can use it on any issue or pull request within that repository. For more information, see "[Creating a label](/articles/creating-a-label/)."
@@ -30,7 +31,7 @@ Label | Description
Default labels are included in every new repository when the repository is created, but you can edit or delete the labels later. For more information, see "[Deleting a label](/articles/deleting-a-label/)."
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %}
Organization owners can customize the default labels for repositories in their organization. For more information, see "[Managing default labels for repositories in your organization](/articles/managing-default-labels-for-repositories-in-your-organization)."
{% endif %}
diff --git a/content/github/managing-your-work-on-github/about-milestones.md b/content/github/managing-your-work-on-github/about-milestones.md
index 53a9aed276b9..27238a9b7314 100644
--- a/content/github/managing-your-work-on-github/about-milestones.md
+++ b/content/github/managing-your-work-on-github/about-milestones.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
When you [create a milestone](/articles/creating-and-editing-milestones-for-issues-and-pull-requests), you can [associate it with issues and pull requests](/articles/associating-milestones-with-issues-and-pull-requests).
diff --git a/content/github/managing-your-work-on-github/about-project-boards.md b/content/github/managing-your-work-on-github/about-project-boards.md
index c780b431841b..da22dbe57969 100644
--- a/content/github/managing-your-work-on-github/about-project-boards.md
+++ b/content/github/managing-your-work-on-github/about-project-boards.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Project boards are made up of issues, pull requests, and notes that are categorized as cards in columns of your choosing. You can drag and drop or use keyboard shortcuts to reorder cards within a column, move cards from column to column, and change the order of columns.
diff --git a/content/github/managing-your-work-on-github/about-task-lists.md b/content/github/managing-your-work-on-github/about-task-lists.md
index f2a69ea030b4..250c4684a9e2 100644
--- a/content/github/managing-your-work-on-github/about-task-lists.md
+++ b/content/github/managing-your-work-on-github/about-task-lists.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Task lists render with clickable checkboxes in comments. You can select or unselect the checkboxes to mark them as complete or incomplete.
diff --git a/content/github/managing-your-work-on-github/adding-issues-and-pull-requests-to-a-project-board.md b/content/github/managing-your-work-on-github/adding-issues-and-pull-requests-to-a-project-board.md
index d0616988bf24..028e0c50317c 100644
--- a/content/github/managing-your-work-on-github/adding-issues-and-pull-requests-to-a-project-board.md
+++ b/content/github/managing-your-work-on-github/adding-issues-and-pull-requests-to-a-project-board.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
You can add issue or pull request cards to your project board by:
diff --git a/content/github/managing-your-work-on-github/adding-notes-to-a-project-board.md b/content/github/managing-your-work-on-github/adding-notes-to-a-project-board.md
index 7f4f491ddc75..87761cc8b8e4 100644
--- a/content/github/managing-your-work-on-github/adding-notes-to-a-project-board.md
+++ b/content/github/managing-your-work-on-github/adding-notes-to-a-project-board.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% tip %}
diff --git a/content/github/managing-your-work-on-github/applying-labels-to-issues-and-pull-requests.md b/content/github/managing-your-work-on-github/applying-labels-to-issues-and-pull-requests.md
index dcf5a01db9b3..e570888b7f41 100644
--- a/content/github/managing-your-work-on-github/applying-labels-to-issues-and-pull-requests.md
+++ b/content/github/managing-your-work-on-github/applying-labels-to-issues-and-pull-requests.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% tip %}
diff --git a/content/github/managing-your-work-on-github/archiving-cards-on-a-project-board.md b/content/github/managing-your-work-on-github/archiving-cards-on-a-project-board.md
index 7e09861ea93f..cc7eb1dd665b 100644
--- a/content/github/managing-your-work-on-github/archiving-cards-on-a-project-board.md
+++ b/content/github/managing-your-work-on-github/archiving-cards-on-a-project-board.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Automation in your project board does not apply to archived project board cards. For example, if you close an issue in a project board's archive, the archived card does not automatically move to the "Done" column. When you restore a card from the project board archive, the card will return to the column where it was archived.
diff --git a/content/github/managing-your-work-on-github/assigning-issues-and-pull-requests-to-other-github-users.md b/content/github/managing-your-work-on-github/assigning-issues-and-pull-requests-to-other-github-users.md
index d99e105d35f5..8983b241033a 100644
--- a/content/github/managing-your-work-on-github/assigning-issues-and-pull-requests-to-other-github-users.md
+++ b/content/github/managing-your-work-on-github/assigning-issues-and-pull-requests-to-other-github-users.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Anyone with write permissions to a repository can assign issues and pull requests.
diff --git a/content/github/managing-your-work-on-github/associating-milestones-with-issues-and-pull-requests.md b/content/github/managing-your-work-on-github/associating-milestones-with-issues-and-pull-requests.md
index a82d0901e0b6..73f110edabfc 100644
--- a/content/github/managing-your-work-on-github/associating-milestones-with-issues-and-pull-requests.md
+++ b/content/github/managing-your-work-on-github/associating-milestones-with-issues-and-pull-requests.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.repositories.navigate-to-repo %}
diff --git a/content/github/managing-your-work-on-github/changing-project-board-visibility.md b/content/github/managing-your-work-on-github/changing-project-board-visibility.md
index b59a210e1b56..18b20011579c 100644
--- a/content/github/managing-your-work-on-github/changing-project-board-visibility.md
+++ b/content/github/managing-your-work-on-github/changing-project-board-visibility.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.project-management.project-board-visibility %}
diff --git a/content/github/managing-your-work-on-github/closing-a-project-board.md b/content/github/managing-your-work-on-github/closing-a-project-board.md
index 8543304b3f6a..57b8586d7121 100644
--- a/content/github/managing-your-work-on-github/closing-a-project-board.md
+++ b/content/github/managing-your-work-on-github/closing-a-project-board.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
When you close a project board, any configured workflow automation will pause by default.
diff --git a/content/github/managing-your-work-on-github/configuring-automation-for-project-boards.md b/content/github/managing-your-work-on-github/configuring-automation-for-project-boards.md
index 1bfa483df632..037b6efa7c6d 100644
--- a/content/github/managing-your-work-on-github/configuring-automation-for-project-boards.md
+++ b/content/github/managing-your-work-on-github/configuring-automation-for-project-boards.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.project-management.automate-project-board-permissions %} For more information, see "[About automation for project boards](/articles/about-automation-for-project-boards)."
diff --git a/content/github/managing-your-work-on-github/creating-a-label.md b/content/github/managing-your-work-on-github/creating-a-label.md
index e7f553d3ac0c..bbfaf42065fb 100644
--- a/content/github/managing-your-work-on-github/creating-a-label.md
+++ b/content/github/managing-your-work-on-github/creating-a-label.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% tip %}
@@ -29,6 +30,6 @@ versions:
- "[About labels](/articles/about-labels)"
- "[Applying labels to issues and pull requests](/articles/applying-labels-to-issues-and-pull-requests)"
- "[Editing a label](/articles/editing-a-label)"
-- "[Filtering issues and pull requests by labels](/articles/filtering-issues-and-pull-requests-by-labels)"{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
+- "[Filtering issues and pull requests by labels](/articles/filtering-issues-and-pull-requests-by-labels)"{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %}
- "[Managing default labels for repositories in your organization](/articles/managing-default-labels-for-repositories-in-your-organization)"
{% endif %}
diff --git a/content/github/managing-your-work-on-github/creating-a-permanent-link-to-a-code-snippet.md b/content/github/managing-your-work-on-github/creating-a-permanent-link-to-a-code-snippet.md
index b78c327682e3..283530bf8d14 100644
--- a/content/github/managing-your-work-on-github/creating-a-permanent-link-to-a-code-snippet.md
+++ b/content/github/managing-your-work-on-github/creating-a-permanent-link-to-a-code-snippet.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
This type of permanent link will render as a code snippet only in the repository it originated in. In other repositories, the permalink code snippet will render as a URL.
diff --git a/content/github/managing-your-work-on-github/creating-a-project-board.md b/content/github/managing-your-work-on-github/creating-a-project-board.md
index b51d09c72fa5..3821c173b07c 100644
--- a/content/github/managing-your-work-on-github/creating-a-project-board.md
+++ b/content/github/managing-your-work-on-github/creating-a-project-board.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.project-management.use-automated-template %}
diff --git a/content/github/managing-your-work-on-github/creating-an-issue.md b/content/github/managing-your-work-on-github/creating-an-issue.md
index ae499dea3bbf..ece31e824492 100644
--- a/content/github/managing-your-work-on-github/creating-an-issue.md
+++ b/content/github/managing-your-work-on-github/creating-an-issue.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.repositories.create-issue-in-public-repository %}
@@ -13,7 +14,7 @@ You can open a new issue based on code from an existing pull request. For more i
You can open a new issue directly from a comment in an issue or a pull request review. For more information, see "[Opening an issue from a comment](/github/managing-your-work-on-github/opening-an-issue-from-a-comment)."
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %}
{% tip %}
**Tip**: You can also create an issue using the {% data variables.product.prodname_cli %}. For more information, see "[`gh issue create`](https://cli.github.com/manual/gh_issue_create)" in the {% data variables.product.prodname_cli %} documentation.
diff --git a/content/github/managing-your-work-on-github/creating-and-editing-milestones-for-issues-and-pull-requests.md b/content/github/managing-your-work-on-github/creating-and-editing-milestones-for-issues-and-pull-requests.md
index ee343b1d3d84..0524cf92373c 100644
--- a/content/github/managing-your-work-on-github/creating-and-editing-milestones-for-issues-and-pull-requests.md
+++ b/content/github/managing-your-work-on-github/creating-and-editing-milestones-for-issues-and-pull-requests.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.repositories.navigate-to-repo %}
diff --git a/content/github/managing-your-work-on-github/deleting-a-label.md b/content/github/managing-your-work-on-github/deleting-a-label.md
index 903d75e012ce..94744ed88209 100644
--- a/content/github/managing-your-work-on-github/deleting-a-label.md
+++ b/content/github/managing-your-work-on-github/deleting-a-label.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Deleting a label will remove the label from any issues or pull requests where it's been applied.
@@ -18,6 +19,6 @@ Deleting a label will remove the label from any issues or pull requests where it
### Further reading
- "[Applying labels to issues and pull requests](/articles/applying-labels-to-issues-and-pull-requests)"
-- "[Filtering issues and pull requests by labels](/articles/filtering-issues-and-pull-requests-by-labels)"{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
+- "[Filtering issues and pull requests by labels](/articles/filtering-issues-and-pull-requests-by-labels)"{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %}
- "[Managing default labels for repositories in your organization](/articles/managing-default-labels-for-repositories-in-your-organization)"
{% endif %}
diff --git a/content/github/managing-your-work-on-github/deleting-a-project-board.md b/content/github/managing-your-work-on-github/deleting-a-project-board.md
index 4ea51ddbedcd..365d7a03bc48 100644
--- a/content/github/managing-your-work-on-github/deleting-a-project-board.md
+++ b/content/github/managing-your-work-on-github/deleting-a-project-board.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% tip %}
diff --git a/content/github/managing-your-work-on-github/deleting-an-issue.md b/content/github/managing-your-work-on-github/deleting-an-issue.md
index 7da9879a358f..705f41ff5a38 100644
--- a/content/github/managing-your-work-on-github/deleting-an-issue.md
+++ b/content/github/managing-your-work-on-github/deleting-an-issue.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
You can only delete issues in a repository owned by your user account. You cannot delete issues in a repository owned by another user account, even if you are a collaborator there.
diff --git a/content/github/managing-your-work-on-github/disabling-issues.md b/content/github/managing-your-work-on-github/disabling-issues.md
index 4fed2082744c..469bd2bac89e 100644
--- a/content/github/managing-your-work-on-github/disabling-issues.md
+++ b/content/github/managing-your-work-on-github/disabling-issues.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-settings %}
diff --git a/content/github/managing-your-work-on-github/disabling-project-boards-in-a-repository.md b/content/github/managing-your-work-on-github/disabling-project-boards-in-a-repository.md
index 1da9ba210786..5a3d679fd65d 100644
--- a/content/github/managing-your-work-on-github/disabling-project-boards-in-a-repository.md
+++ b/content/github/managing-your-work-on-github/disabling-project-boards-in-a-repository.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
When you disable project boards, you will no longer see project board information in timelines or [audit logs](/articles/reviewing-your-security-log/).
diff --git a/content/github/managing-your-work-on-github/disabling-project-boards-in-your-organization.md b/content/github/managing-your-work-on-github/disabling-project-boards-in-your-organization.md
index 43947e58879f..6b5579d3b658 100644
--- a/content/github/managing-your-work-on-github/disabling-project-boards-in-your-organization.md
+++ b/content/github/managing-your-work-on-github/disabling-project-boards-in-your-organization.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
After you disable organization-wide project boards, it won’t be possible to create new project boards at the organization level, and any existing organization-level project boards will become inaccessible at their previous URLs. Project boards in repositories in the organization are not affected.
diff --git a/content/github/managing-your-work-on-github/editing-a-label.md b/content/github/managing-your-work-on-github/editing-a-label.md
index f90533325f07..9b8ae1262fb0 100644
--- a/content/github/managing-your-work-on-github/editing-a-label.md
+++ b/content/github/managing-your-work-on-github/editing-a-label.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.repositories.navigate-to-repo %}
@@ -23,6 +24,6 @@ versions:
- "[Creating a label](/articles/creating-a-label)"
- "[Deleting a label](/articles/deleting-a-label)"
- "[Applying labels to issues and pull requests](/articles/applying-labels-to-issues-and-pull-requests)"
-- "[Filtering issues and pull requests by labels](/articles/filtering-issues-and-pull-requests-by-labels)"{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
+- "[Filtering issues and pull requests by labels](/articles/filtering-issues-and-pull-requests-by-labels)"{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %}
- "[Managing default labels for repositories in your organization](/articles/managing-default-labels-for-repositories-in-your-organization)"
{% endif %}
diff --git a/content/github/managing-your-work-on-github/editing-a-project-board.md b/content/github/managing-your-work-on-github/editing-a-project-board.md
index 268a8cab4615..0f9e5c977cae 100644
--- a/content/github/managing-your-work-on-github/editing-a-project-board.md
+++ b/content/github/managing-your-work-on-github/editing-a-project-board.md
@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% tip %}
diff --git a/content/github/managing-your-work-on-github/file-attachments-on-issues-and-pull-requests.md b/content/github/managing-your-work-on-github/file-attachments-on-issues-and-pull-requests.md
index 53a67879b052..892032e8c390 100644
--- a/content/github/managing-your-work-on-github/file-attachments-on-issues-and-pull-requests.md
+++ b/content/github/managing-your-work-on-github/file-attachments-on-issues-and-pull-requests.md
@@ -7,10 +7,11 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% warning %}
-**Warning:** If you add an image to a pull request or issue comment, anyone can view the anonymized image URL without authentication, even if the pull request is in a private repository{% if currentVersion != "free-pro-team@latest" %}, or if private mode is enabled{% endif %}. To keep sensitive images private, serve them from a private network or server that requires authentication. {% if currentVersion == "free-pro-team@latest" %}For more information on anonymized URLs see "[About anonymized image URLs](/articles/about-anonymized-image-urls)".{% endif %}
+**Warning:** If you add an image to a pull request or issue comment, anyone can view the anonymized image URL without authentication, even if the pull request is in a private repository{% if enterpriseServerVersions contains currentVersion %}, or if private mode is enabled{% endif %}. To keep sensitive images private, serve them from a private network or server that requires authentication. {% if currentVersion == "free-pro-team@latest" %}For more information on anonymized URLs see "[About anonymized image URLs](/articles/about-anonymized-image-urls)".{% endif %}
{% endwarning %}
@@ -20,7 +21,7 @@ To attach a file to an issue or pull request conversation, drag and drop it into
{% tip %}
-**Tip:** If you're using Chrome, you can also copy-and-paste images directly into the box.
+**Tip:** In many browsers, you can copy-and-paste images directly into the box.
{% endtip %}
diff --git a/content/github/managing-your-work-on-github/filtering-cards-on-a-project-board.md b/content/github/managing-your-work-on-github/filtering-cards-on-a-project-board.md
index 359033b08dfb..a4a1ee3f6f88 100644
--- a/content/github/managing-your-work-on-github/filtering-cards-on-a-project-board.md
+++ b/content/github/managing-your-work-on-github/filtering-cards-on-a-project-board.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
On a card, you can click any assignee, milestone, or label to filter the project board by that qualifier. To clear the search, you can click the same assignee, milestone, or label again.
@@ -21,7 +22,7 @@ You can also use the "Filter cards" search bar at the top of each project board
- Filter by check status using `status:pending`, `status:success`, or `status:failure`
- Filter cards by type using `type:issue`, `type:pr`, or `type:note`
- Filter cards by state and type using `is:open`, `is:closed`, or `is:merged`; and `is:issue`, `is:pr`, or `is:note`
-- Filter cards by issues that are linked to a pull request by a closing reference using `linked:pr`{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
+- Filter cards by issues that are linked to a pull request by a closing reference using `linked:pr`{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}
- Filter cards by repository in an organization-wide project board using `repo:ORGANIZATION/REPOSITORY`{% endif %}
1. Navigate to the project board that contains the cards you want to filter.
diff --git a/content/github/managing-your-work-on-github/filtering-issues-and-pull-requests-by-assignees.md b/content/github/managing-your-work-on-github/filtering-issues-and-pull-requests-by-assignees.md
index 62efeb547e0b..e04db9f3124f 100644
--- a/content/github/managing-your-work-on-github/filtering-issues-and-pull-requests-by-assignees.md
+++ b/content/github/managing-your-work-on-github/filtering-issues-and-pull-requests-by-assignees.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.cli.filter-issues-and-pull-requests-tip %}
diff --git a/content/github/managing-your-work-on-github/filtering-issues-and-pull-requests-by-labels.md b/content/github/managing-your-work-on-github/filtering-issues-and-pull-requests-by-labels.md
index 4273b2e6ce79..d0ad982702d1 100644
--- a/content/github/managing-your-work-on-github/filtering-issues-and-pull-requests-by-labels.md
+++ b/content/github/managing-your-work-on-github/filtering-issues-and-pull-requests-by-labels.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.cli.filter-issues-and-pull-requests-tip %}
diff --git a/content/github/managing-your-work-on-github/filtering-issues-and-pull-requests-by-milestone.md b/content/github/managing-your-work-on-github/filtering-issues-and-pull-requests-by-milestone.md
index 753238cbd162..d6c96b95d776 100644
--- a/content/github/managing-your-work-on-github/filtering-issues-and-pull-requests-by-milestone.md
+++ b/content/github/managing-your-work-on-github/filtering-issues-and-pull-requests-by-milestone.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% tip %}
diff --git a/content/github/managing-your-work-on-github/filtering-issues-and-pull-requests.md b/content/github/managing-your-work-on-github/filtering-issues-and-pull-requests.md
index 789bfd9eadc5..8459b5dd4d79 100644
--- a/content/github/managing-your-work-on-github/filtering-issues-and-pull-requests.md
+++ b/content/github/managing-your-work-on-github/filtering-issues-and-pull-requests.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.search.requested_reviews_search %}
diff --git a/content/github/managing-your-work-on-github/filtering-pull-requests-by-review-status.md b/content/github/managing-your-work-on-github/filtering-pull-requests-by-review-status.md
index b67528e51a12..d712514da7fe 100644
--- a/content/github/managing-your-work-on-github/filtering-pull-requests-by-review-status.md
+++ b/content/github/managing-your-work-on-github/filtering-pull-requests-by-review-status.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
You can filter a repository's list of pull requests to find:
diff --git a/content/github/managing-your-work-on-github/finding-information-in-a-repository.md b/content/github/managing-your-work-on-github/finding-information-in-a-repository.md
index 5e2309c96f19..ccc776aa0ec7 100644
--- a/content/github/managing-your-work-on-github/finding-information-in-a-repository.md
+++ b/content/github/managing-your-work-on-github/finding-information-in-a-repository.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/managing-your-work-on-github/index.md b/content/github/managing-your-work-on-github/index.md
index a0903774e057..c6f2a858e068 100644
--- a/content/github/managing-your-work-on-github/index.md
+++ b/content/github/managing-your-work-on-github/index.md
@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/managing-your-work-on-github/labeling-issues-and-pull-requests.md b/content/github/managing-your-work-on-github/labeling-issues-and-pull-requests.md
index 662c3128dd3c..0d6730752ebb 100644
--- a/content/github/managing-your-work-on-github/labeling-issues-and-pull-requests.md
+++ b/content/github/managing-your-work-on-github/labeling-issues-and-pull-requests.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue.md b/content/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue.md
index 2c2aa3d5da5c..e99658d64f03 100644
--- a/content/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue.md
+++ b/content/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue.md
@@ -1,6 +1,6 @@
---
title: Linking a pull request to an issue
-intro: 'You can link a pull request to an issue to{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.18" %} show that a fix is in progress and to{% endif %} automatically close the issue when the pull request is merged.'
+intro: 'You can link a pull request to an issue to show that a fix is in progress and to automatically close the issue when the pull request is merged.'
redirect_from:
- /articles/closing-issues-via-commit-message/
- /articles/closing-issues-via-commit-messages/
@@ -9,6 +9,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% note %}
@@ -19,13 +20,13 @@ versions:
### About linked issues and pull requests
-You can link an issue to a pull request {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}manually or {% endif %}using a supported keyword in the pull request description.
+You can link an issue to a pull request {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}manually or {% endif %}using a supported keyword in the pull request description.
When you link a pull request to the issue the pull request addresses, collaborators can see that someone is working on the issue. {% if currentVersion ver_lt "enterprise-server@2.21" %}If the pull request and the issue are in different repositories, {% data variables.product.product_name %} will display the link after the pull request is merged, if the person who merges the pull request also has permission to close the issue.{% endif %}
When you merge a linked pull request into the default branch of a repository, its linked issue is automatically closed. For more information about the default branch, see "[Changing the default branch](/github/administering-a-repository/changing-the-default-branch)."
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}
### Manually linking a pull request to an issue
Anyone with write permissions to a repository can manually link a pull request to an issue.
@@ -63,7 +64,7 @@ Issue in the same repository | *KEYWORD* #*ISSUE-NUMBER* | `Closes #10`
Issue in a different repository | *KEYWORD* *OWNER*/*REPOSITORY*#*ISSUE-NUMBER* | `Fixes octo-org/octo-repo#100`
Multiple issues | Use full syntax for each issue | `Resolves #10, resolves #123, resolves octo-org/octo-repo#100`
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}Only manually linked pull requests can be manually unlinked. To unlink an issue that you linked using a keyword, you must edit the pull request description to remove the keyword.{% endif %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}Only manually linked pull requests can be manually unlinked. To unlink an issue that you linked using a keyword, you must edit the pull request description to remove the keyword.{% endif %}
You can also use closing keywords in a commit message. The issue will be closed when you merge the commit into the default branch, but the pull request that contains the commit will not be listed as a linked pull request.
diff --git a/content/github/managing-your-work-on-github/linking-a-repository-to-a-project-board.md b/content/github/managing-your-work-on-github/linking-a-repository-to-a-project-board.md
index e6710c6fc4bf..c10c705036ef 100644
--- a/content/github/managing-your-work-on-github/linking-a-repository-to-a-project-board.md
+++ b/content/github/managing-your-work-on-github/linking-a-repository-to-a-project-board.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% note %}
diff --git a/content/github/managing-your-work-on-github/managing-project-boards.md b/content/github/managing-your-work-on-github/managing-project-boards.md
index b2f9ef87f031..4ecbcf476f6b 100644
--- a/content/github/managing-your-work-on-github/managing-project-boards.md
+++ b/content/github/managing-your-work-on-github/managing-project-boards.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/managing-your-work-on-github/managing-your-work-with-issues.md b/content/github/managing-your-work-on-github/managing-your-work-with-issues.md
index b7d767d5bb4a..199739179ed0 100644
--- a/content/github/managing-your-work-on-github/managing-your-work-with-issues.md
+++ b/content/github/managing-your-work-on-github/managing-your-work-with-issues.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/managing-your-work-on-github/opening-an-issue-from-a-comment.md b/content/github/managing-your-work-on-github/opening-an-issue-from-a-comment.md
index 105db0a3a948..79dc68a5219e 100644
--- a/content/github/managing-your-work-on-github/opening-an-issue-from-a-comment.md
+++ b/content/github/managing-your-work-on-github/opening-an-issue-from-a-comment.md
@@ -4,6 +4,7 @@ intro: You can open a new issue from a specific comment in an issue or pull requ
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
When you open an issue from a comment, the issue contains a snippet showing where the comment was originally posted.
diff --git a/content/github/managing-your-work-on-github/opening-an-issue-from-code.md b/content/github/managing-your-work-on-github/opening-an-issue-from-code.md
index 612990be7226..1d66820184c9 100644
--- a/content/github/managing-your-work-on-github/opening-an-issue-from-code.md
+++ b/content/github/managing-your-work-on-github/opening-an-issue-from-code.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
When you open an issue from code, the issue contains a snippet showing the line or range of code you chose. You can only open an issue in the same repository where the code is stored.
diff --git a/content/github/managing-your-work-on-github/pinning-an-issue-to-your-repository.md b/content/github/managing-your-work-on-github/pinning-an-issue-to-your-repository.md
index 765810fa990d..6786f5add270 100644
--- a/content/github/managing-your-work-on-github/pinning-an-issue-to-your-repository.md
+++ b/content/github/managing-your-work-on-github/pinning-an-issue-to-your-repository.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/managing-your-work-on-github/reopening-a-closed-project-board.md b/content/github/managing-your-work-on-github/reopening-a-closed-project-board.md
index 8a1575dbd473..4ddda31852d3 100644
--- a/content/github/managing-your-work-on-github/reopening-a-closed-project-board.md
+++ b/content/github/managing-your-work-on-github/reopening-a-closed-project-board.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
When you close a project board, any workflow automation that was configured for the project board will pause by default. For more information, see "[Closing a project board](/articles/closing-a-project-board)."
diff --git a/content/github/managing-your-work-on-github/sharing-filters.md b/content/github/managing-your-work-on-github/sharing-filters.md
index 7c0b5a86afb5..deaa2e4d84e6 100644
--- a/content/github/managing-your-work-on-github/sharing-filters.md
+++ b/content/github/managing-your-work-on-github/sharing-filters.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
You can send the URL that issues generates to any user, and they'll be able to see the same filter view that you see.
diff --git a/content/github/managing-your-work-on-github/sorting-issues-and-pull-requests.md b/content/github/managing-your-work-on-github/sorting-issues-and-pull-requests.md
index f58d6916aff4..0137ba5be29c 100644
--- a/content/github/managing-your-work-on-github/sorting-issues-and-pull-requests.md
+++ b/content/github/managing-your-work-on-github/sorting-issues-and-pull-requests.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
You can sort any filtered view by:
diff --git a/content/github/managing-your-work-on-github/tracking-progress-on-your-project-board.md b/content/github/managing-your-work-on-github/tracking-progress-on-your-project-board.md
index 09cd421ca092..dd4915bbee4c 100644
--- a/content/github/managing-your-work-on-github/tracking-progress-on-your-project-board.md
+++ b/content/github/managing-your-work-on-github/tracking-progress-on-your-project-board.md
@@ -1,16 +1,17 @@
---
title: Tracking progress on your project board
-intro: 'By default, when you enable automation on a project board, the overall progress of the project is tracked in a progress bar.'
+intro: You can see the overall progress of your project in a progress bar.
redirect_from:
- /articles/tracking-progress-on-your-project-board
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.project-management.project-progress-locations %}
-1. Navigate to the project board where you want to disable project progress tracking.
+1. Navigate to the project board where you want to enable or disable project progress tracking.
{% data reusables.project-management.click-menu %}
-{% data reusables.project-management.access-collaboration-settings %}
-4. Unselect **Track project progress**.
+{% data reusables.project-management.click-edit-sidebar-menu-project-board %}
+4. Select or deselect **Track project progress**.
diff --git a/content/github/managing-your-work-on-github/tracking-the-progress-of-your-work-with-milestones.md b/content/github/managing-your-work-on-github/tracking-the-progress-of-your-work-with-milestones.md
index 8438a8e63a2e..289f06851cee 100644
--- a/content/github/managing-your-work-on-github/tracking-the-progress-of-your-work-with-milestones.md
+++ b/content/github/managing-your-work-on-github/tracking-the-progress-of-your-work-with-milestones.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/managing-your-work-on-github/tracking-the-progress-of-your-work-with-project-boards.md b/content/github/managing-your-work-on-github/tracking-the-progress-of-your-work-with-project-boards.md
index de603b6d9329..6bdc39989500 100644
--- a/content/github/managing-your-work-on-github/tracking-the-progress-of-your-work-with-project-boards.md
+++ b/content/github/managing-your-work-on-github/tracking-the-progress-of-your-work-with-project-boards.md
@@ -8,5 +8,6 @@ mapTopic: true
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/managing-your-work-on-github/transferring-an-issue-to-another-repository.md b/content/github/managing-your-work-on-github/transferring-an-issue-to-another-repository.md
index 703d521b353f..be47140ea227 100644
--- a/content/github/managing-your-work-on-github/transferring-an-issue-to-another-repository.md
+++ b/content/github/managing-your-work-on-github/transferring-an-issue-to-another-repository.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
To transfer an open issue to another repository, you must have write permissions on the repository the issue is in and the repository you're transferring the issue to. For more information, see "[Repository permission levels for an organization](/articles/repository-permission-levels-for-an-organization)."
diff --git a/content/github/managing-your-work-on-github/using-search-to-filter-issues-and-pull-requests.md b/content/github/managing-your-work-on-github/using-search-to-filter-issues-and-pull-requests.md
index 4dcfd8eb26c1..fcb3518947a6 100644
--- a/content/github/managing-your-work-on-github/using-search-to-filter-issues-and-pull-requests.md
+++ b/content/github/managing-your-work-on-github/using-search-to-filter-issues-and-pull-requests.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
The issues and pull requests search bar allows you to define your own custom filters and sort by a wide variety of criteria. You can find the search bar on each repository's **Issues** and **Pull requests** tabs and on your [Issues and Pull requests dashboards](/articles/viewing-all-of-your-issues-and-pull-requests).
@@ -25,7 +26,7 @@ With issue and pull request search terms, you can:
- Filter issues and pull requests by assignee: `state:open type:issue assignee:octocat`
- Filter issues and pull requests by label: `state:open type:issue label:"bug"`
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}
For issues, you can also use search to:
- Filter for issues that are linked to a pull request by a closing reference: `linked:pr`
@@ -39,7 +40,7 @@ For pull requests, you can also use search to:
- Filter pull requests in which a reviewer has asked for changes: `state:open type:pr review:changes_requested`
- Filter pull requests by [reviewer](/articles/about-pull-request-reviews/): `state:open type:pr reviewed-by:octocat`
- Filter pull requests by the specific user [requested for review](/articles/requesting-a-pull-request-review): `state:open type:pr review-requested:octocat`
-- Filter pull requests by the team requested for review: `state:open type:pr team-review-requested:github/atom`{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
+- Filter pull requests by the team requested for review: `state:open type:pr team-review-requested:github/atom`{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}
- Filter for pull requests that are linked to an issue that the pull request may close: `linked:issue`{% endif %}
### Further reading
diff --git a/content/github/managing-your-work-on-github/viewing-all-of-your-issues-and-pull-requests.md b/content/github/managing-your-work-on-github/viewing-all-of-your-issues-and-pull-requests.md
index aa457913a7bc..289597f46baa 100644
--- a/content/github/managing-your-work-on-github/viewing-all-of-your-issues-and-pull-requests.md
+++ b/content/github/managing-your-work-on-github/viewing-all-of-your-issues-and-pull-requests.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Your issues and pull request dashboards are available at the top of any page. On each dashboard, you can filter the list to find issues or pull requests you created, that are assigned to you, or in which you're mentioned. You can also find pull requests that you've been asked to review.
@@ -17,4 +18,4 @@ Your issues and pull request dashboards are available at the top of any page. On
### Further reading
-- {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}”[Viewing your subscriptions](/github/managing-subscriptions-and-notifications-on-github/viewing-your-subscriptions#reviewing-repositories-that-youre-watching){% else %}”[Listing the repositories you're watching](/github/receiving-notifications-about-activity-on-github/listing-the-repositories-youre-watching){% endif %}"
+- {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}”[Viewing your subscriptions](/github/managing-subscriptions-and-notifications-on-github/viewing-your-subscriptions#reviewing-repositories-that-youre-watching){% else %}”[Listing the repositories you're watching](/github/receiving-notifications-about-activity-on-github/listing-the-repositories-youre-watching){% endif %}"
diff --git a/content/github/managing-your-work-on-github/viewing-your-milestones-progress.md b/content/github/managing-your-work-on-github/viewing-your-milestones-progress.md
index 34b5a15f4eb0..0fc56efbff2f 100644
--- a/content/github/managing-your-work-on-github/viewing-your-milestones-progress.md
+++ b/content/github/managing-your-work-on-github/viewing-your-milestones-progress.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.repositories.navigate-to-repo %}
diff --git a/content/github/searching-for-information-on-github/about-searching-on-github.md b/content/github/searching-for-information-on-github/about-searching-on-github.md
index 5639534bd93c..e902d8182722 100644
--- a/content/github/searching-for-information-on-github/about-searching-on-github.md
+++ b/content/github/searching-for-information-on-github/about-searching-on-github.md
@@ -11,6 +11,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
You can search globally across all of {% data variables.product.product_name %}, or scope your search to a particular repository or organization.
@@ -54,6 +55,7 @@ The {% data variables.search.advanced_url %} provides a visual interface for con
+{% if currentVersion != "github-ae@latest" %}
### Searching across {% data variables.product.prodname_enterprise %} and {% data variables.product.prodname_dotcom_the_website %} simultaneously
If you use {% data variables.product.prodname_enterprise %} and you're a member of a {% data variables.product.prodname_dotcom_the_website %} organization using {% data variables.product.prodname_ghe_cloud %}, your {% data variables.product.prodname_enterprise %} site administrator can enable {% data variables.product.prodname_github_connect %} so that you can search across both environments at the same time. For more information, see "[Enabling {% data variables.product.prodname_unified_search %} between {% data variables.product.prodname_enterprise %} and {% data variables.product.prodname_dotcom_the_website %}](/enterprise/admin/guides/developer-workflow/enabling-unified-search-between-github-enterprise-server-and-github-com)."
@@ -63,6 +65,7 @@ You can only search across both environments from {% data variables.product.prod
Your {% data variables.product.prodname_enterprise %} site administrator can enable {% data variables.product.prodname_unified_search %} for all public repositories, all private repositories, or only certain private repositories in the connected {% data variables.product.prodname_ghe_cloud %} organization.
If your site administrator enables {% data variables.product.prodname_unified_search %} in private repositories, you can only search in the private repositories that the administrator enabled {% data variables.product.prodname_unified_search %} for and that you have access to in the connected {% data variables.product.prodname_dotcom_the_website %} organization. Your {% data variables.product.prodname_enterprise %} administrators and organization owners on {% data variables.product.prodname_dotcom_the_website %} cannot search private repositories owned by your account. To search the applicable private repositories, you must enable private repository search for your personal accounts on {% data variables.product.prodname_dotcom_the_website %} and {% data variables.product.prodname_enterprise %}. For more information, see "[Enabling private {% data variables.product.prodname_dotcom_the_website %} repository search in your {% data variables.product.prodname_enterprise %} account](/articles/enabling-private-github-com-repository-search-in-your-github-enterprise-server-account)."
+{% endif %}
### Further reading
diff --git a/content/github/searching-for-information-on-github/finding-files-on-github.md b/content/github/searching-for-information-on-github/finding-files-on-github.md
index 2ef690ac3d59..b5f1b9d22b90 100644
--- a/content/github/searching-for-information-on-github/finding-files-on-github.md
+++ b/content/github/searching-for-information-on-github/finding-files-on-github.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% tip %}
@@ -18,7 +19,7 @@ versions:
{% endtip %}
{% data reusables.repositories.navigate-to-repo %}
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
+{% if currentVersion ver_lt "enterprise-server@2.22" %}
2. Under your repository name, click **Find file**.
{% else %}
diff --git a/content/github/searching-for-information-on-github/getting-started-with-searching-on-github.md b/content/github/searching-for-information-on-github/getting-started-with-searching-on-github.md
index 8711ba12b993..75b823525a9f 100644
--- a/content/github/searching-for-information-on-github/getting-started-with-searching-on-github.md
+++ b/content/github/searching-for-information-on-github/getting-started-with-searching-on-github.md
@@ -6,5 +6,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/searching-for-information-on-github/index.md b/content/github/searching-for-information-on-github/index.md
index ea8b735f6f54..1c417eade87e 100644
--- a/content/github/searching-for-information-on-github/index.md
+++ b/content/github/searching-for-information-on-github/index.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/searching-for-information-on-github/searching-code.md b/content/github/searching-for-information-on-github/searching-code.md
index ea42305587d8..9430b2524b6a 100644
--- a/content/github/searching-for-information-on-github/searching-code.md
+++ b/content/github/searching-for-information-on-github/searching-code.md
@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
You can search for code globally across all of {% data variables.product.product_name %}, or search for code within a particular repository or organization. To search for code across all public repositories, you must be signed in to a {% data variables.product.product_name %} account. For more information, see "[About searching on GitHub](/articles/about-searching-on-github)."
diff --git a/content/github/searching-for-information-on-github/searching-commits.md b/content/github/searching-for-information-on-github/searching-commits.md
index b9830828ca22..a178848dae45 100644
--- a/content/github/searching-for-information-on-github/searching-commits.md
+++ b/content/github/searching-for-information-on-github/searching-commits.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
You can search for commits globally across all of {% data variables.product.product_name %}, or search for commits within a particular repository or organization. For more information, see "[About searching on {% data variables.product.company_short %}](/articles/about-searching-on-github)."
diff --git a/content/github/searching-for-information-on-github/searching-for-packages.md b/content/github/searching-for-information-on-github/searching-for-packages.md
index e251db21e4c9..908a5b758fb9 100644
--- a/content/github/searching-for-information-on-github/searching-for-packages.md
+++ b/content/github/searching-for-information-on-github/searching-for-packages.md
@@ -6,6 +6,7 @@ permissions: Anyone can search for packages they have access to.
versions:
free-pro-team: '*'
enterprise-server: '>=2.22'
+ github-ae: '*'
---
{% data reusables.package_registry.packages-ghes-release-stage %}
@@ -14,8 +15,8 @@ versions:
You can search for packages globally across all of {% data variables.product.product_name %}, or search for packages within a particular organization. For more information, see "[About searching on {% data variables.product.prodname_dotcom %}](/articles/about-searching-on-github)."
-{% if currentVersion != "free-pro-team@latest" %}
-You can only search for packages on {% data variables.product.product_location_enterprise %}, not {% data variables.product.prodname_dotcom_the_website %}, even if {% data variables.product.prodname_github_connect %} is enabled.
+{% if enterpriseServerVersions contains currentVersion %}
+You can only search for packages on {% data variables.product.product_name %}, not {% data variables.product.prodname_dotcom_the_website %}, even if {% data variables.product.prodname_github_connect %} is enabled.
{% endif %}
{% data reusables.search.syntax_tips %}
diff --git a/content/github/searching-for-information-on-github/searching-for-repositories.md b/content/github/searching-for-information-on-github/searching-for-repositories.md
index 2303d7f0e4b8..c93f2fc9c4db 100644
--- a/content/github/searching-for-information-on-github/searching-for-repositories.md
+++ b/content/github/searching-for-information-on-github/searching-for-repositories.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
You can search for repositories globally across all of {% data variables.product.product_name %}, or search for repositories within a particular organization. For more information, see "[About searching on {% data variables.product.prodname_dotcom %}](/articles/about-searching-on-github)."
diff --git a/content/github/searching-for-information-on-github/searching-in-forks.md b/content/github/searching-for-information-on-github/searching-in-forks.md
index 207c5072d42f..00f94f10b15b 100644
--- a/content/github/searching-for-information-on-github/searching-in-forks.md
+++ b/content/github/searching-for-information-on-github/searching-in-forks.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
To show forks in [repository search](/articles/searching-for-repositories) results, add `fork:true` or `fork:only` to your query.
diff --git a/content/github/searching-for-information-on-github/searching-issues-and-pull-requests.md b/content/github/searching-for-information-on-github/searching-issues-and-pull-requests.md
index 2024d3226406..abb6c57f6d04 100644
--- a/content/github/searching-for-information-on-github/searching-issues-and-pull-requests.md
+++ b/content/github/searching-for-information-on-github/searching-issues-and-pull-requests.md
@@ -7,14 +7,15 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
You can search for issues and pull requests globally across all of {% data variables.product.product_name %}, or search for issues and pull requests within a particular organization. For more information, see "[About searching on {% data variables.product.company_short %}](/articles/about-searching-on-github)."
{% tip %}
-**Tips:**{% if currentVersion != "free-pro-team@latest" %}
- - This article contains example searches on the {% data variables.product.prodname_dotcom %}.com website, but you can use the same search filters on {% data variables.product.product_location_enterprise %}.{% endif %}
+**Tips:**{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
+ - This article contains example searches on the {% data variables.product.prodname_dotcom %}.com website, but you can use the same search filters on {% data variables.product.product_location %}.{% endif %}
- For a list of search syntaxes that you can add to any search qualifier to further improve your results, see "[Understanding the search syntax](/articles/understanding-the-search-syntax)".
- Use quotations around multi-word search terms. For example, if you want to search for issues with the label "In progress," you'd search for `label:"in progress"`. Search is not case sensitive.
- {% data reusables.search.search_issues_and_pull_requests_shortcut %}
@@ -124,7 +125,7 @@ You can use the `involves` qualifier to find issues that in some way involve a c
| involves:USERNAME | **[involves:defunkt involves:jlord](https://github.com/search?q=involves%3Adefunkt+involves%3Ajlord&type=Issues)** matches issues either @defunkt or @jlord are involved in.
| | [**NOT bootstrap in:body involves:mdo**](https://github.com/search?q=NOT+bootstrap+in%3Abody+involves%3Amdo&type=Issues) matches issues @mdo is involved in that do not contain the word "bootstrap" in the body.
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}
### Search for linked issues and pull requests
You can narrow your results to only include issues that are linked to a pull request by a closing reference, or pull requests that are linked to an issue that the pull request may close.
@@ -230,7 +231,7 @@ You can filter issues and pull requests by the number of reactions using the `re
You can filter for draft pull requests. For more information, see "[About pull requests](/articles/about-pull-requests#draft-pull-requests)."
| Qualifier | Example
-| ------------- | -------------{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
+| ------------- | -------------{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}
| `draft:true` | [**draft:true**](https://github.com/search?q=draft%3Atrue) matches draft pull requests.
| `draft:false` | [**draft:false**](https://github.com/search?q=draft%3Afalse) matches pull requests that are ready for review.{% else %}
| `is:draft` | [**is:draft**](https://github.com/search?q=is%3Adraft) matches draft pull requests.{% endif %}
diff --git a/content/github/searching-for-information-on-github/searching-on-github.md b/content/github/searching-for-information-on-github/searching-on-github.md
index 9eebbac9a383..26639b46a16b 100644
--- a/content/github/searching-for-information-on-github/searching-on-github.md
+++ b/content/github/searching-for-information-on-github/searching-on-github.md
@@ -6,5 +6,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/searching-for-information-on-github/searching-topics.md b/content/github/searching-for-information-on-github/searching-topics.md
index 35f5b7b3dc41..fb8ab431b04d 100644
--- a/content/github/searching-for-information-on-github/searching-topics.md
+++ b/content/github/searching-for-information-on-github/searching-topics.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Search {% data variables.product.product_name %} for topics
diff --git a/content/github/searching-for-information-on-github/searching-users.md b/content/github/searching-for-information-on-github/searching-users.md
index aa0323d75355..325fe570e9fa 100644
--- a/content/github/searching-for-information-on-github/searching-users.md
+++ b/content/github/searching-for-information-on-github/searching-users.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
You can search for users globally across all of {% data variables.product.product_name %}. For more information, see "[About searching on {% data variables.product.company_short %}](/articles/about-searching-on-github)."
diff --git a/content/github/searching-for-information-on-github/searching-wikis.md b/content/github/searching-for-information-on-github/searching-wikis.md
index f5007dc1b824..20e4ea13be2c 100644
--- a/content/github/searching-for-information-on-github/searching-wikis.md
+++ b/content/github/searching-for-information-on-github/searching-wikis.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
You can search wikis globally across all of {% data variables.product.product_name %}, or search wikis within a particular repository or organization. For more information, see "[About searching on {% data variables.product.company_short %}](/articles/about-searching-on-github)."
diff --git a/content/github/searching-for-information-on-github/sorting-search-results.md b/content/github/searching-for-information-on-github/sorting-search-results.md
index a2924b9b036a..63a87f4ea828 100644
--- a/content/github/searching-for-information-on-github/sorting-search-results.md
+++ b/content/github/searching-for-information-on-github/sorting-search-results.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Use the Sort menu to sort results by relevance, number of stars, number of forks, and how recently the items were updated.
diff --git a/content/github/searching-for-information-on-github/troubleshooting-search-queries.md b/content/github/searching-for-information-on-github/troubleshooting-search-queries.md
index 9c28e4d72a3d..1ef53215997e 100644
--- a/content/github/searching-for-information-on-github/troubleshooting-search-queries.md
+++ b/content/github/searching-for-information-on-github/troubleshooting-search-queries.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Potential timeouts
diff --git a/content/github/searching-for-information-on-github/understanding-the-search-syntax.md b/content/github/searching-for-information-on-github/understanding-the-search-syntax.md
index a94568f062d5..917ed579ab7a 100644
--- a/content/github/searching-for-information-on-github/understanding-the-search-syntax.md
+++ b/content/github/searching-for-information-on-github/understanding-the-search-syntax.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Query for values greater or less than another value
@@ -80,7 +81,7 @@ If your search query contains whitespace, you will need to surround it with quot
Some non-alphanumeric symbols, such as spaces, are dropped from code search queries within quotation marks, so results can be unexpected.
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}
### Queries with usernames
If your search query contains a qualifier that requires a username, such as `user`, `actor`, or `assignee`, you can use any {% data variables.product.product_name %} username, to specify a specific person, or `@me`, to specify the current user.
diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-actions.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-actions.md
index 3c0da17daa1b..b3562de79920 100644
--- a/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-actions.md
+++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-actions.md
@@ -51,7 +51,7 @@ The number of jobs you can run concurrently across all repositories in your user
At the end of the month, {% data variables.product.prodname_dotcom %} calculates the cost of minutes and storage used over the amount included in your account. For example, if your organization uses {% data variables.product.prodname_team %} and allows unlimited spending, using 15,000 minutes could have a total storage and minute overage cost of $56, depending on the operating systems used to run jobs.
- 5,000 (3,000 Linux and 2,000 Windows) minutes = $56 ($24 + $32).
- - 3,000 Linux minutes at $0.008 per = $24.
+ - 3,000 Linux minutes at $0.008 per minute = $24.
- 2,000 Windows minutes at $0.016 per minute = $32.
At the end of the month, {% data variables.product.prodname_dotcom %} rounds your data transfer to the nearest GB.
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/about-identity-and-access-management-with-saml-single-sign-on.md b/content/github/setting-up-and-managing-organizations-and-teams/about-identity-and-access-management-with-saml-single-sign-on.md
index 6a63cdaa869c..cecd46522073 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/about-identity-and-access-management-with-saml-single-sign-on.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/about-identity-and-access-management-with-saml-single-sign-on.md
@@ -14,7 +14,7 @@ versions:
After you configure SAML SSO, members of your {% data variables.product.prodname_dotcom %} organization will continue to log into their user accounts on {% data variables.product.prodname_dotcom %}. When a member accesses resources within your organization that uses SAML SSO, {% data variables.product.prodname_dotcom %} redirects the member to your IdP to authenticate. After successful authentication, your IdP redirects the member back to {% data variables.product.prodname_dotcom %}, where the member can access your organization's resources.
-Enterprise owners can also enforce SAML SSO for all organizations in an enterprise account. For more information, see "[Enforcing security settings in your enterprise account](/github/setting-up-and-managing-your-enterprise-account/enforcing-security-settings-in-your-enterprise-account#enabling-saml-single-sign-on-for-organizations-in-your-enterprise-account)."
+Enterprise owners can also enforce SAML SSO for all organizations in an enterprise account. For more information, see "[Enforcing security settings in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-security-settings-in-your-enterprise-account#enabling-saml-single-sign-on-for-organizations-in-your-enterprise-account)."
{% data reusables.saml.outside-collaborators-exemption %}
@@ -26,7 +26,7 @@ Members must periodically authenticate with your IdP to authenticate and gain ac
To access the organization's protected resources using the API and Git on the command line, members must authorize and authenticate with a personal access token or SSH key. For more information, see "[Authorizing a personal access token for use with SAML single sign-on](/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)" and "[Authorizing an SSH key for use with SAML single sign-on](/github/authenticating-to-github/authorizing-an-ssh-key-for-use-with-saml-single-sign-on)."
-The first time a member uses SAML SSO to access your organization, {% data variables.product.prodname_dotcom %} automatically creates a record that links your organization, the member's {% data variables.product.prodname_dotcom %} account, and the member's account on your IdP. You can view and revoke the linked SAML identity, active sessions, and authorized credentials for members of your organization or enterprise account. For more information, see "[Viewing and managing a member's SAML access to your organization](/github/setting-up-and-managing-organizations-and-teams/viewing-and-managing-a-members-saml-access-to-your-organization)" and "[Viewing and managing a user's 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)."
+The first time a member uses SAML SSO to access your organization, {% data variables.product.prodname_dotcom %} automatically creates a record that links your organization, the member's {% data variables.product.prodname_dotcom %} account, and the member's account on your IdP. You can view and revoke the linked SAML identity, active sessions, and authorized credentials for members of your organization or enterprise account. For more information, see "[Viewing and managing a member's SAML access to your organization](/github/setting-up-and-managing-organizations-and-teams/viewing-and-managing-a-members-saml-access-to-your-organization)" and "[Viewing and managing a user's SAML access to your enterprise account](/github/setting-up-and-managing-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise-account)."
If members are signed in with a SAML SSO session when they create a new repository, the default visibility of that repository is private. Otherwise, the default visibility is public. For more information on repository visibility, see "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility)."
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/about-organizations.md b/content/github/setting-up-and-managing-organizations-and-teams/about-organizations.md
index bd8cc042fa35..308abb2d5f46 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/about-organizations.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/about-organizations.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.organizations.organizations_include %}
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/about-scim.md b/content/github/setting-up-and-managing-organizations-and-teams/about-scim.md
index 8cabb2ee9f86..fde99bc4817e 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/about-scim.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/about-scim.md
@@ -17,7 +17,7 @@ These identity providers are compatible with the {% data variables.product.produ
- Okta
- OneLogin
-{% data reusables.scim.enterprise-account-scim %} For more information, see "[Enforcing security settings in your enterprise account](/github/setting-up-and-managing-your-enterprise-account/enforcing-security-settings-in-your-enterprise-account#managing-user-provisioning-for-organizations-in-your-enterprise-account)."
+{% data reusables.scim.enterprise-account-scim %} For more information, see "[Enforcing security settings in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-security-settings-in-your-enterprise-account#managing-user-provisioning-for-organizations-in-your-enterprise-account)."
### Further reading
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/about-ssh-certificate-authorities.md b/content/github/setting-up-and-managing-organizations-and-teams/about-ssh-certificate-authorities.md
index 46796cdfe1dc..6295d544418a 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/about-ssh-certificate-authorities.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/about-ssh-certificate-authorities.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
An SSH certificate is a mechanism for one SSH key to sign another SSH key. If you use an SSH certificate authority (CA) to provide your organization members with signed SSH certificates, you can add the CA to your enterprise account or organization to allow organization members to use their certificates to access organization resources. For more information, see "[Managing your organization's SSH certificate authorities](/articles/managing-your-organizations-ssh-certificate-authorities)."
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/about-teams.md b/content/github/setting-up-and-managing-organizations-and-teams/about-teams.md
index 8425374f6031..6d56d44867e1 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/about-teams.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/about-teams.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
@@ -19,9 +20,9 @@ For more information, see:
-{% if currentVersion != "free-pro-team@latest" %}
+{% if enterpriseServerVersions contains currentVersion %}
-You can also use LDAP Sync to synchronize {% data variables.product.product_location_enterprise %} team members and team roles against your established LDAP groups. This lets you establish role-based access control for users from your LDAP server instead of manually within {% data variables.product.product_location_enterprise %}. For more information, see "[Enabling LDAP Sync](/enterprise/admin/authentication/using-ldap#enabling-ldap-sync)."
+You can also use LDAP Sync to synchronize {% data variables.product.product_location %} team members and team roles against your established LDAP groups. This lets you establish role-based access control for users from your LDAP server instead of manually within {% data variables.product.product_location %}. For more information, see "[Enabling LDAP Sync](/enterprise/admin/authentication/using-ldap#enabling-ldap-sync)."
{% endif %}
@@ -55,12 +56,8 @@ To easily understand who shares a parent team's permissions and mentions, you ca
You can choose a parent when you create the team, or you can move a team in your organization's hierarchy later. For more information see, "[Moving a team in your organization’s hierarchy](/articles/moving-a-team-in-your-organization-s-hierarchy)."
-{% if currentVersion != "free-pro-team@latest" %}
-
{% data reusables.enterprise_user_management.ldap-sync-nested-teams %}
-{% endif %}
-
### Preparing to nest teams in your organization
If your organization already has existing teams, you should audit each team's repository access permissions before you nest teams above or below it. You should also consider the new structure you'd like to implement for your organization.
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/about-your-organization-dashboard.md b/content/github/setting-up-and-managing-organizations-and-teams/about-your-organization-dashboard.md
index 589383548545..4182fd11b568 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/about-your-organization-dashboard.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/about-your-organization-dashboard.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Accessing your organization dashboard
@@ -28,7 +29,7 @@ In the left sidebar of your dashboard, you can access your organization's top re
In the "All activity" section of your news feed, you can view updates from other teams and repositories in your organization.
-The "All activity" section shows all recent activity in the organization, including activity in repositories you're not subscribed to and of people you're not following. For more information, see {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}"About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications){% else %}"[Watching and unwatching repositories](/github/receiving-notifications-about-activity-on-github/watching-and-unwatching-repositories){% endif %}" and "[Following people](/articles/following-people)."
+The "All activity" section shows all recent activity in the organization, including activity in repositories you're not subscribed to and of people you're not following. For more information, see {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}"[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications){% else %}"[Watching and unwatching repositories](/github/receiving-notifications-about-activity-on-github/watching-and-unwatching-repositories){% endif %}" and "[Following people](/articles/following-people)."
For instance, the organization news feed shows updates when someone in the organization:
- Creates a new branch.
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/about-your-organizations-news-feed.md b/content/github/setting-up-and-managing-organizations-and-teams/about-your-organizations-news-feed.md
index d92f45ea2a46..22f71d1f178f 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/about-your-organizations-news-feed.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/about-your-organizations-news-feed.md
@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
An organization's news feed shows other people's activity on repositories owned by that organization. You can use your organization's news feed to see when someone opens, closes, or merges an issue or pull request, creates or deletes a branch, creates a tag or release, comments on an issue, pull request, or commit, or pushes new commits to {% data variables.product.product_name %}.
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/accessing-your-organizations-settings.md b/content/github/setting-up-and-managing-organizations-and-teams/accessing-your-organizations-settings.md
index 51ceb1e8f1f9..a3107304bdf9 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/accessing-your-organizations-settings.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/accessing-your-organizations-settings.md
@@ -12,6 +12,7 @@ intro: 'The organization account settings page provides several ways to manage t
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% if currentVersion == "free-pro-team@latest" %}
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/adding-an-outside-collaborator-to-a-project-board-in-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/adding-an-outside-collaborator-to-a-project-board-in-your-organization.md
index 29f601444880..f7b11a7a0f33 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/adding-an-outside-collaborator-to-a-project-board-in-your-organization.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/adding-an-outside-collaborator-to-a-project-board-in-your-organization.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
An outside collaborator is a person who isn't explicitly a member of your organization, but who has permissions to a project board in your organization.
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/adding-github-app-managers-in-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/adding-github-app-managers-in-your-organization.md
index 89eb7a381184..b548094db847 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/adding-github-app-managers-in-your-organization.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/adding-github-app-managers-in-your-organization.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
For more information about {% data variables.product.prodname_github_app %} manager permissions, see "[Permission levels for an organization](/articles/permission-levels-for-an-organization#github-app-managers)."
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/adding-organization-members-to-a-team.md b/content/github/setting-up-and-managing-organizations-and-teams/adding-organization-members-to-a-team.md
index 6b112565b6de..95eaedc29630 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/adding-organization-members-to-a-team.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/adding-organization-members-to-a-team.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.organizations.team-synchronization %}
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/adding-outside-collaborators-to-repositories-in-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/adding-outside-collaborators-to-repositories-in-your-organization.md
index cc2d31754829..e38a631a7fef 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/adding-outside-collaborators-to-repositories-in-your-organization.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/adding-outside-collaborators-to-repositories-in-your-organization.md
@@ -6,13 +6,16 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.organizations.owners-and-admins-can %} add outside collaborators to a repository, unless an organization owner has restricted the ability to invite collaborators. For more information, see "[Setting permissions for adding outside collaborators](/articles/setting-permissions-for-adding-outside-collaborators)."
{% data reusables.organizations.outside-collaborators-use-seats %}
+{% if currentVersion != "github-ae@latest" %}
If your organization [requires members and outside collaborators to use two-factor authentication](/articles/requiring-two-factor-authentication-in-your-organization), they must enable two-factor authentication before they can accept your invitation to collaborate on an organization repository.
+{% endif %}
{% data reusables.organizations.outside_collaborator_forks %}
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/adding-people-to-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/adding-people-to-your-organization.md
index a850f1ebfe63..dad0eb63df94 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/adding-people-to-your-organization.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/adding-people-to-your-organization.md
@@ -5,15 +5,13 @@ redirect_from:
- /articles/adding-people-to-your-organization
versions:
enterprise-server: '*'
+ github-ae: '*'
+permissions: 'Organization owners can add people to an organization.'
---
-{% tip %}
-
-**Tips**:
-- Only organization owners can add users to an organization. For more information, see "[Permission levels for an organization](/articles/permission-levels-for-an-organization)."
-- If your organization [requires members to use two-factor authentication](/articles/requiring-two-factor-authentication-in-your-organization), users must [enable two-factor authentication](/articles/securing-your-account-with-two-factor-authentication-2fa) before you can add them to the organization.
-
-{% endtip %}
+{% if currentVersion != "github-ae@latest" %}
+If your organization [requires members to use two-factor authentication](/articles/requiring-two-factor-authentication-in-your-organization), users must [enable two-factor authentication](/articles/securing-your-account-with-two-factor-authentication-2fa) before you can add them to the organization.
+{% endif %}
{% data reusables.profile.access_profile %}
{% data reusables.profile.access_org %}
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/allowing-people-to-delete-issues-in-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/allowing-people-to-delete-issues-in-your-organization.md
index cdbf9737821b..3a68f66481f0 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/allowing-people-to-delete-issues-in-your-organization.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/allowing-people-to-delete-issues-in-your-organization.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
By default, issues cannot be deleted in an organization's repositories. An organization owner must enable this feature for all of the organization's repositories first.
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/changing-team-visibility.md b/content/github/setting-up-and-managing-organizations-and-teams/changing-team-visibility.md
index f1fa1db05e77..d72bc2ee197c 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/changing-team-visibility.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/changing-team-visibility.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.organizations.types-of-team-visibility %}
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/collaborating-with-groups-in-organizations.md b/content/github/setting-up-and-managing-organizations-and-teams/collaborating-with-groups-in-organizations.md
index 68ca7cf9e997..d73f270e574d 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/collaborating-with-groups-in-organizations.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/collaborating-with-groups-in-organizations.md
@@ -8,5 +8,6 @@ mapTopic: true
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/configuring-saml-single-sign-on-and-scim-using-okta.md b/content/github/setting-up-and-managing-organizations-and-teams/configuring-saml-single-sign-on-and-scim-using-okta.md
index c9d2a68b163c..3e07739d062c 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/configuring-saml-single-sign-on-and-scim-using-okta.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/configuring-saml-single-sign-on-and-scim-using-okta.md
@@ -75,7 +75,7 @@ After you enable SCIM, the following provisioning features are available for any
### Further reading
-- "[Configuring SAML 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)"
+- "[Configuring SAML single sign-on and SCIM for your enterprise account using Okta](/github/setting-up-and-managing-your-enterprise/configuring-saml-single-sign-on-and-scim-for-your-enterprise-account-using-okta)"
- "[Managing team synchronization for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-team-synchronization-for-your-organization#enabling-team-synchronization-for-okta)"
- [Understanding SAML](https://developer.okta.com/docs/concepts/saml/) in the Okta documentation
- [Understanding SCIM](https://developer.okta.com/docs/concepts/scim/) in the Okta documentation
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/converting-an-organization-member-to-an-outside-collaborator.md b/content/github/setting-up-and-managing-organizations-and-teams/converting-an-organization-member-to-an-outside-collaborator.md
index 730865c88648..5e15884e40c1 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/converting-an-organization-member-to-an-outside-collaborator.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/converting-an-organization-member-to-an-outside-collaborator.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.organizations.owners-and-admins-can %} convert organization members into outside collaborators.
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/converting-an-outside-collaborator-to-an-organization-member.md b/content/github/setting-up-and-managing-organizations-and-teams/converting-an-outside-collaborator-to-an-organization-member.md
index be985f927923..55a11392c520 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/converting-an-outside-collaborator-to-an-organization-member.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/converting-an-outside-collaborator-to-an-organization-member.md
@@ -6,16 +6,15 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
+permissions: Organization owners can {% if currentVersion == "free-pro-team@latest" %}invite users to join{% else %}add users to{% endif %} an organization.
---
+{% if currentVersion == "free-pro-team@latest" %}
+If your organization is on a paid per-user subscription, an unused license must be available before you can invite a new member to join the organization or reinstate a former organization member. For more information, see "[About per-user pricing](/articles/about-per-user-pricing)." {% data reusables.organizations.org-invite-expiration %}{% endif %}
-{% tip %}
-
-**Tips**:
-- Only organization owners can {% if currentVersion == "free-pro-team@latest" %}invite users to join{% else %}add users to{% endif %} an organization. For more information, see "[Permission levels for an organization](/articles/permission-levels-for-an-organization)."{% if currentVersion == "free-pro-team@latest" %}
-- If your organization is on a paid per-user subscription, an unused license must be available before you can invite a new member to join the organization or reinstate a former organization member. For more information, see "[About per-user pricing](/articles/about-per-user-pricing)." {% data reusables.organizations.org-invite-expiration %}{% endif %}
-- If your organization [requires members to use two-factor authentication](/articles/requiring-two-factor-authentication-in-your-organization), users {% if currentVersion == "free-pro-team@latest" %}you invite must [enable two-factor authentication](/articles/securing-your-account-with-two-factor-authentication-2fa) before they can accept the invitation.{% else %}must [enable two-factor authentication](/articles/securing-your-account-with-two-factor-authentication-2fa) before you can add them to the organization.{% endif %}
-
-{% endtip %}
+{% if currentVersion != "github-ae@latest" %}
+If your organization [requires members to use two-factor authentication](/articles/requiring-two-factor-authentication-in-your-organization), users {% if currentVersion == "free-pro-team@latest" %}you invite must [enable two-factor authentication](/articles/securing-your-account-with-two-factor-authentication-2fa) before they can accept the invitation.{% else %}must [enable two-factor authentication](/articles/securing-your-account-with-two-factor-authentication-2fa) before you can add them to the organization.{% endif %}
+{% endif %}
{% data reusables.profile.access_profile %}
{% data reusables.profile.access_org %}
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/creating-a-new-organization-from-scratch.md b/content/github/setting-up-and-managing-organizations-and-teams/creating-a-new-organization-from-scratch.md
index 71ac9d38cbad..d1d3d1b650b6 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/creating-a-new-organization-from-scratch.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/creating-a-new-organization-from-scratch.md
@@ -1,11 +1,13 @@
---
title: Creating a new organization from scratch
intro: Create an organization to apply fine-grained access permissions to repositories.
-redirect_from:
- - /articles/creating-a-new-organization-from-scratch
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
+redirect_from:
+ - /articles/creating-a-new-organization-from-scratch
+ - /admin/user-management/creating-organizations
---
When you create a new organization from scratch, it doesn't have any repositories associated with it. For more information on adding repositories to your organization, see "[Creating a new repository](/articles/creating-a-new-repository)" and "[Transferring a repository](/articles/transferring-a-repository)."
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/creating-a-team.md b/content/github/setting-up-and-managing-organizations-and-teams/creating-a-team.md
index fa876319a47f..d29be64dc932 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/creating-a-team.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/creating-a-team.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Only organization owners and maintainers of a parent team can create a new child team under a parent. Owners can also restrict creation permissions for all teams in an organization. For more information, see "[Setting team creation permissions in your organization](/articles/setting-team-creation-permissions-in-your-organization)."
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/deleting-a-team.md b/content/github/setting-up-and-managing-organizations-and-teams/deleting-a-team.md
index e92b38617fe3..bee8b07a10a6 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/deleting-a-team.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/deleting-a-team.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% tip %}
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/deleting-an-organization-account.md b/content/github/setting-up-and-managing-organizations-and-teams/deleting-an-organization-account.md
index fdc78e09405e..fb55c8eb8c5e 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/deleting-an-organization-account.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/deleting-an-organization-account.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% if currentVersion == "free-pro-team@latest" %}
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/disabling-or-limiting-github-actions-for-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/disabling-or-limiting-github-actions-for-your-organization.md
index 08ea4e12fa03..5dc65ade412d 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/disabling-or-limiting-github-actions-for-your-organization.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/disabling-or-limiting-github-actions-for-your-organization.md
@@ -17,7 +17,7 @@ You can enable {% data variables.product.prodname_actions %} for all repositorie
Alternatively, you can enable {% data variables.product.prodname_actions %} for all repositories in your organization but limit the actions a workflow can run. {% data reusables.github-actions.enabled-local-github-actions %}
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.23" %}
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.23" %}
### Managing {% data variables.product.prodname_actions %} permissions for your organization
@@ -41,7 +41,7 @@ You can disable all workflows for an organization or set a policy that configure
{% note %}
-**Note:** You might not be able to manage these settings if your organization is managed by an enterprise that has overriding policy. For more information, {% if currentVersion == "free-pro-team@latest" %}"[Enforcing {% data variables.product.prodname_actions %} policies in your enterprise account](/github/setting-up-and-managing-your-enterprise-account/enforcing-github-actions-policies-in-your-enterprise-account)."{% else %}"[Enforcing {% data variables.product.prodname_actions %} policies for your enterprise](/enterprise/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise)."{% endif %}
+**Note:** You might not be able to manage these settings if your organization is managed by an enterprise that has overriding policy. For more information, {% if currentVersion == "free-pro-team@latest" %}"[Enforcing {% data variables.product.prodname_actions %} policies in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-github-actions-policies-in-your-enterprise-account)."{% else %}"[Enforcing {% data variables.product.prodname_actions %} policies for your enterprise](/enterprise/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise)."{% endif %}
{% endnote %}
@@ -61,7 +61,7 @@ You can disable all workflows for an organization or set a policy that configure
{% data reusables.profile.access_org %}
{% data reusables.organizations.org_settings %}
{% data reusables.organizations.settings-sidebar-actions %}
-1. Under **Policies**, select **Allow specific actions** and add your required actions to the list.
+1. Under **Policies**, select **Allow select actions** and add your required actions to the list.
1. Click **Save**.
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/disabling-publication-of-github-pages-sites-for-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/disabling-publication-of-github-pages-sites-for-your-organization.md
index f3231626ad45..02818ad3ab5c 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/disabling-publication-of-github-pages-sites-for-your-organization.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/disabling-publication-of-github-pages-sites-for-your-organization.md
@@ -6,13 +6,14 @@ product: '{% data reusables.gated-features.pages %}'
versions:
free-pro-team: '*'
enterprise-server: '>2.22'
+ github-ae: '*'
---
### About restrictions on publication of {% data variables.product.prodname_pages %} sites
You can control whether members of your organization can publish websites from repositories in your organization using {% data variables.product.prodname_pages %}. For more information about {% data variables.product.prodname_pages %}, see "[About {% data variables.product.prodname_pages %}](/github/working-with-github-pages/about-github-pages)."
-{% if currentVersion != "free-pro-team@latest" %}If your site administrator has enabled Public Pages, {% endif %}{% data variables.product.prodname_pages %} sites are publicly available on the internet, even if the repository for the site is private{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} or internal{% endif %}. For more information, see{% if currentVersion != "free-pro-team@latest" %} "[Configuring {% data variables.product.prodname_pages %} on your appliance](/enterprise/admin/installation/configuring-github-pages-on-your-appliance#making-github-pages-publicly-accessible)" and{% endif %} "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility)."
+{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}If your site administrator has enabled Public Pages, {% endif %}{% data variables.product.prodname_pages %} sites are publicly available on the internet, even if the repository for the site is private{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %} or internal{% endif %}. For more information, see{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} "[Configuring {% data variables.product.prodname_pages %} for your enterprise](/admin/configuration/configuring-github-pages-for-your-enterprise#enabling-public-sites-for-github-pages)" and{% endif %} "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility)."
### Disabling publication of {% data variables.product.prodname_pages %} sites
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/disabling-team-discussions-for-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/disabling-team-discussions-for-your-organization.md
index 2651918af97f..e4d9e8d55af1 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/disabling-team-discussions-for-your-organization.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/disabling-team-discussions-for-your-organization.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.organizations.team-discussions-default %} For more information on team discussions, see "[About team discussions](/articles/about-team-discussions)."
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/enforcing-saml-single-sign-on-for-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/enforcing-saml-single-sign-on-for-your-organization.md
index 1c1d291769df..d331a4ca1225 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/enforcing-saml-single-sign-on-for-your-organization.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/enforcing-saml-single-sign-on-for-your-organization.md
@@ -10,7 +10,7 @@ versions:
If you enforce SAML SSO in your organization, any members, including admins who have not authenticated via your SAML identity provider (IdP), will be removed from the organization and will receive an email notifying them about the removal. Bots and service accounts that do not have external identities set up in your organization's IdP will also be removed. For more information on bots and service accounts, see "[Managing bots and service accounts with SAML single sign-on](/articles/managing-bots-and-service-accounts-with-saml-single-sign-on)." You can restore organization members once they successfully complete single sign-on.
-If your organization is owned by an enterprise account, enabling SAML for the enterprise account will override your organization-level SAML configuration. For more information, see "[Enforcing security settings in your enterprise account](/github/setting-up-and-managing-your-enterprise-account/enforcing-security-settings-in-your-enterprise-account)."
+If your organization is owned by an enterprise account, enabling SAML for the enterprise account will override your organization-level SAML configuration. For more information, see "[Enforcing security settings in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-security-settings-in-your-enterprise-account)."
{% tip %}
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/giving-team-maintainer-permissions-to-an-organization-member.md b/content/github/setting-up-and-managing-organizations-and-teams/giving-team-maintainer-permissions-to-an-organization-member.md
index 47f1c3add97c..24808059f5a3 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/giving-team-maintainer-permissions-to-an-organization-member.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/giving-team-maintainer-permissions-to-an-organization-member.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.organizations.team_maintainers_can %}
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/index.md b/content/github/setting-up-and-managing-organizations-and-teams/index.md
index 771bfe8a8d43..51d361dd567d 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/index.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/index.md
@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
@@ -127,7 +128,7 @@ versions:
{% link_in_list /disabling-publication-of-github-pages-sites-for-your-organization %}
{% link_in_list /deleting-an-organization-account %}
{% link_in_list /converting-an-organization-into-a-user %}
-
+
{% link_in_list /integrating-jira-with-your-organization-project-board %}
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/integrating-jira-with-your-organization-project-board.md b/content/github/setting-up-and-managing-organizations-and-teams/integrating-jira-with-your-organization-project-board.md
index 64bca57a0782..6a3cf2daffcc 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/integrating-jira-with-your-organization-project-board.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/integrating-jira-with-your-organization-project-board.md
@@ -5,6 +5,7 @@ redirect_from:
- /articles/integrating-jira-with-your-organization-project-board
versions:
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.user_settings.access_settings %}
2. In the left sidebar under **Organization settings**, click the name of your organization.
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/keeping-your-organization-secure.md b/content/github/setting-up-and-managing-organizations-and-teams/keeping-your-organization-secure.md
index 16e6d269417b..ae816c4de75e 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/keeping-your-organization-secure.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/keeping-your-organization-secure.md
@@ -3,10 +3,11 @@ title: Keeping your organization secure
redirect_from:
- /articles/preventing-unauthorized-access-to-organization-information/
- /articles/keeping-your-organization-secure
-intro: 'Organization owners have several features to help them keep their projects and data secure. If you''re the owner of an organization, you should regularly review your organization''s audit log, member 2FA status, and application settings to ensure that no unauthorized or malicious activity has occurred.'
+intro: 'Organization owners have several features to help them keep their projects and data secure. If you''re the owner of an organization, you should regularly review your organization''s audit log{% if currentVersion != "github-ae@latest" %}, member 2FA status,{% endif %} and application settings to ensure that no unauthorized or malicious activity has occurred.'
mapTopic: true
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/maintaining-ownership-continuity-for-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/maintaining-ownership-continuity-for-your-organization.md
index b16c0a751b84..32645337654a 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/maintaining-ownership-continuity-for-your-organization.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/maintaining-ownership-continuity-for-your-organization.md
@@ -9,6 +9,7 @@ permissions: Organization owners can promote any member of an organization to an
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### About maintaining ownership continuity for your organization
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-a-project-board-for-organization-members.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-a-project-board-for-organization-members.md
index 12a3f78bf309..5d7ab225fdd9 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-a-project-board-for-organization-members.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-a-project-board-for-organization-members.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
By default, organization members have write access to their organization's project boards unless organization owners or project board admins set different permissions for specific project boards.
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-your-organizations-apps.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-your-organizations-apps.md
index 9624dfacdcb3..09b911c5fedd 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-your-organizations-apps.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-your-organizations-apps.md
@@ -8,5 +8,6 @@ mapTopic: true
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-your-organizations-project-boards.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-your-organizations-project-boards.md
index 8fbdd7b7b735..cd5110e35f1f 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-your-organizations-project-boards.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-your-organizations-project-boards.md
@@ -8,5 +8,6 @@ mapTopic: true
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-your-organizations-repositories.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-your-organizations-repositories.md
index 7cc178b24266..b6a9fa4057ea 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-your-organizations-repositories.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-access-to-your-organizations-repositories.md
@@ -9,5 +9,6 @@ mapTopic: true
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-allowed-ip-addresses-for-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-allowed-ip-addresses-for-your-organization.md
index fcef2f8ad171..d92c67df7d84 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/managing-allowed-ip-addresses-for-your-organization.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-allowed-ip-addresses-for-your-organization.md
@@ -16,7 +16,7 @@ You can restrict access to organization assets by configuring an allow list for
{% data reusables.identity-and-permissions.ip-allow-lists-enable %}
-You can also configure allowed IP addresses for the organizations in an enterprise account. For more information, see "[Enforcing security settings in your enterprise account](/github/setting-up-and-managing-your-enterprise-account/enforcing-security-settings-in-your-enterprise-account#managing-allowed-ip-addresses-for-organizations-in-your-enterprise-account)."
+You can also configure allowed IP addresses for the organizations in an enterprise account. For more information, see "[Enforcing security settings in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-security-settings-in-your-enterprise-account#managing-allowed-ip-addresses-for-organizations-in-your-enterprise-account)."
### Adding an allowed IP address
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-an-individuals-access-to-an-organization-project-board.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-an-individuals-access-to-an-organization-project-board.md
index fec9591097f5..cd5207d10275 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/managing-an-individuals-access-to-an-organization-project-board.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-an-individuals-access-to-an-organization-project-board.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% note %}
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-an-individuals-access-to-an-organization-repository.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-an-individuals-access-to-an-organization-repository.md
index a7be27aeaa12..194b8f4c9a08 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/managing-an-individuals-access-to-an-organization-repository.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-an-individuals-access-to-an-organization-repository.md
@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
People with admin permissions can manage the access of organization members and outside collaborators to an organization repository.
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-code-review-assignment-for-your-team.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-code-review-assignment-for-your-team.md
index e14c832cbc4e..750351b231e5 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/managing-code-review-assignment-for-your-team.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-code-review-assignment-for-your-team.md
@@ -5,6 +5,7 @@ product: '{% data reusables.gated-features.code-review-assignment %}'
versions:
free-pro-team: '*'
enterprise-server: '>=2.20'
+ github-ae: '*'
---
Team maintainers and organization owners can configure code review assignments.
@@ -17,7 +18,7 @@ When code owners are automatically requested for review, the team is still remov
### Routing algorithms
-Code review assignments automatically choose and assign reviewers based on one of two possible alogrithms.
+Code review assignments automatically choose and assign reviewers based on one of two possible algorithms.
The round robin algorithm chooses reviewers based on who's received the least recent review request, focusing on alternating between all members of the team regardless of the number of outstanding reviews they currently have.
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-default-labels-for-repositories-in-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-default-labels-for-repositories-in-your-organization.md
index f17ef2a497c3..cd54ddd0c96f 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/managing-default-labels-for-repositories-in-your-organization.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-default-labels-for-repositories-in-your-organization.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '>=2.20'
+ github-ae: '*'
---
Organization owners can manage default labels for repositories in the organization.
@@ -17,7 +18,7 @@ Default labels are included in every new repository in your organization, but an
{% data reusables.profile.access_profile %}
{% data reusables.profile.access_org %}
{% data reusables.organizations.org_settings %}
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}
{% data reusables.organizations.repository-defaults %}
{% else %}
{% data reusables.organizations.repository-labels %}
@@ -34,7 +35,7 @@ Default labels are included in every new repository in your organization, but an
{% data reusables.profile.access_profile %}
{% data reusables.profile.access_org %}
{% data reusables.organizations.org_settings %}
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}
{% data reusables.organizations.repository-defaults %}
{% else %}
{% data reusables.organizations.repository-labels %}
@@ -50,7 +51,7 @@ Default labels are included in every new repository in your organization, but an
{% data reusables.profile.access_profile %}
{% data reusables.profile.access_org %}
{% data reusables.organizations.org_settings %}
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}
{% data reusables.organizations.repository-defaults %}
{% else %}
{% data reusables.organizations.repository-labels %}
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-git-access-to-your-organizations-repositories.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-git-access-to-your-organizations-repositories.md
index 30b828ded294..168400ecde94 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/managing-git-access-to-your-organizations-repositories.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-git-access-to-your-organizations-repositories.md
@@ -9,5 +9,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-membership-in-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-membership-in-your-organization.md
index 5d6389602507..507ee1d40507 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/managing-membership-in-your-organization.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-membership-in-your-organization.md
@@ -8,5 +8,6 @@ mapTopic: true
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-organization-settings.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-organization-settings.md
index 2c62f0dc8492..18cf027e387a 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/managing-organization-settings.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-organization-settings.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-peoples-access-to-your-organization-with-roles.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-peoples-access-to-your-organization-with-roles.md
index 8028809214dc..f21057f972eb 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/managing-peoples-access-to-your-organization-with-roles.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-peoples-access-to-your-organization-with-roles.md
@@ -8,5 +8,6 @@ mapTopic: true
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-team-access-to-an-organization-project-board.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-team-access-to-an-organization-project-board.md
index a46a39d99933..d6800f974954 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/managing-team-access-to-an-organization-project-board.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-team-access-to-an-organization-project-board.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% warning %}
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-team-access-to-an-organization-repository.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-team-access-to-an-organization-repository.md
index 8fcbd4e96a41..54c73b2ab538 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/managing-team-access-to-an-organization-repository.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-team-access-to-an-organization-repository.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
People with admin access to a repository can manage team access to the repository. Team maintainers can remove a team's access to a repository.
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-team-synchronization-for-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-team-synchronization-for-your-organization.md
index 82303b3532c0..9688d5223db5 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/managing-team-synchronization-for-your-organization.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-team-synchronization-for-your-organization.md
@@ -24,7 +24,7 @@ You can enable team synchronization between your IdP and {% data variables.produ
{% data reusables.identity-and-permissions.sync-team-with-idp-group %}
-You can also enable team synchronization for organizations owned by an enterprise account. For more information, see "[Enforcing security settings in your enterprise account](/github/setting-up-and-managing-your-enterprise-account/enforcing-security-settings-in-your-enterprise-account)."
+You can also enable team synchronization for organizations owned by an enterprise account. For more information, see "[Enforcing security settings in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-security-settings-in-your-enterprise-account)."
### Enabling team synchronization
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-the-default-branch-name-for-repositories-in-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-the-default-branch-name-for-repositories-in-your-organization.md
index 8e70772f5bf0..97b52e84e989 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/managing-the-default-branch-name-for-repositories-in-your-organization.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-the-default-branch-name-for-repositories-in-your-organization.md
@@ -5,6 +5,7 @@ permissions: Organization owners can manage the default branch name for new repo
versions:
free-pro-team: '*'
enterprise-server: '>=2.23'
+ github-ae: '*'
---
### About management of the default branch name
@@ -13,6 +14,8 @@ When a member of your organization creates a new repository in your organization
{% data reusables.branches.change-default-branch %}
+If an enterprise owner has enforced a policy for the default branch name for your enterprise, you cannot set a default branch name for your organization. Instead, you can change the default branch for individual repositories. For more information, see {% if currentVersion == "free-pro-team@latest" %}"[Enforcing repository management policies in your enterprise](/github/setting-up-and-managing-your-enterprise/enforcing-repository-management-policies-in-your-enterprise-account#enforcing-a-policy-on-the-default-branch-name)"{% else %}"[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-on-the-default-branch-name)"{% endif %} and "[Changing the default branch](/github/administering-a-repository/changing-the-default-branch)."
+
### Setting the default branch name
{% data reusables.profile.access_profile %}
@@ -21,11 +24,6 @@ When a member of your organization creates a new repository in your organization
{% data reusables.organizations.repository-defaults %}
3. Under "Repository default branch", click **Change default branch name now**.
- {% note %}
-
- **Note:** If your enterprise owner has enforced a policy for the default name, you won't be able to change it here. You will be able to set the default branch on individual repositories. For more information, see "[Enforcing a policy on the default branch name](/github/setting-up-and-managing-your-enterprise-account/enforcing-repository-management-policies-in-your-enterprise-account#enforcing-a-policy-on-the-default-branch-name)" and "[Changing the default branch](/github/administering-a-repository/changing-the-default-branch)."
-
- {% endnote %}
4. Type the default name that you would like to use for new branches.
5. Click **Update**.
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-the-display-of-member-names-in-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-the-display-of-member-names-in-your-organization.md
index 23999ecf84d4..aadb68e9f9a2 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/managing-the-display-of-member-names-in-your-organization.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-the-display-of-member-names-in-your-organization.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Organization owners can manage the display of member names in an organization.
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-the-forking-policy-for-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-the-forking-policy-for-your-organization.md
index e277c6966d39..1a56221145b1 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/managing-the-forking-policy-for-your-organization.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-the-forking-policy-for-your-organization.md
@@ -1,6 +1,6 @@
---
title: Managing the forking policy for your organization
-intro: 'You can can allow or prevent the forking of any private{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} and internal{% endif %} repositories owned by your organization.'
+intro: 'You can can allow or prevent the forking of any private{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %} and internal{% endif %} repositories owned by your organization.'
redirect_from:
- /articles/allowing-people-to-fork-private-repositories-in-your-organization
- /github/setting-up-and-managing-organizations-and-teams/allowing-people-to-fork-private-repositories-in-your-organization
@@ -8,11 +8,12 @@ permissions: Organization owners can manage the forking policy for an organizati
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
-By default, new organizations are configured to disallow the forking of private{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} and internal{% endif %} repositories.
+By default, new organizations are configured to disallow the forking of private{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %} and internal{% endif %} repositories.
-If you allow forking of private{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} and internal{% endif %} repositories at the organization level, you can also configure the ability to fork a specific private{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} or internal{% endif %} repository. For more information, see "[Managing the forking policy for your repository](/github/administering-a-repository/managing-the-forking-policy-for-your-repository)."
+If you allow forking of private{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %} and internal{% endif %} repositories at the organization level, you can also configure the ability to fork a specific private{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %} or internal{% endif %} repository. For more information, see "[Managing the forking policy for your repository](/github/administering-a-repository/managing-the-forking-policy-for-your-repository)."
{% data reusables.organizations.internal-repos-enterprise %}
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-your-organizations-ssh-certificate-authorities.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-your-organizations-ssh-certificate-authorities.md
index b62b548e7bf7..9a2b443b6994 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/managing-your-organizations-ssh-certificate-authorities.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-your-organizations-ssh-certificate-authorities.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Organization owners can manage an organization's SSH certificate authorities (CA).
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/moving-a-team-in-your-organizations-hierarchy.md b/content/github/setting-up-and-managing-organizations-and-teams/moving-a-team-in-your-organizations-hierarchy.md
index 0607f850faf1..5229466db2f0 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/moving-a-team-in-your-organizations-hierarchy.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/moving-a-team-in-your-organizations-hierarchy.md
@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Organization owners can change the parent of any team. Team maintainers can change a team's parent if they are maintainers in both the child team and the parent team. Team maintainers without maintainer permissions in the child team can request to add a parent or child team. For more information, see "[Requesting to add or change a parent team](/articles/requesting-to-add-or-change-a-parent-team)" and "[Requesting to add a child team](/articles/requesting-to-add-a-child-team)."
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/organizing-members-into-teams.md b/content/github/setting-up-and-managing-organizations-and-teams/organizing-members-into-teams.md
index 81b9a2716ef8..fc2ca3c1f7a9 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/organizing-members-into-teams.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/organizing-members-into-teams.md
@@ -15,5 +15,6 @@ mapTopic: true
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/permission-levels-for-an-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/permission-levels-for-an-organization.md
index be3bf1afa965..6b04032d743a 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/permission-levels-for-an-organization.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/permission-levels-for-an-organization.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Permission levels for an organization
@@ -61,9 +62,9 @@ Organization members can have *owner*{% if currentVersion == "free-pro-team@late
| Manage an organization's SSH certificate authorities (see "[Managing your organization's SSH certificate authorities](/articles/managing-your-organizations-ssh-certificate-authorities)" for details) | **X** | | |
| Transfer repositories | **X** | | |
| Purchase, install, manage billing for, and cancel {% data variables.product.prodname_marketplace %} apps | **X** | | |
-| List apps in {% data variables.product.prodname_marketplace %} | **X** | | |
+| List apps in {% data variables.product.prodname_marketplace %} | **X** | | |{% if currentVersion != "github-ae@latest" %}
| Receive [{% data variables.product.prodname_dependabot_alerts %} about vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies) for all of an organization's repositories | **X** | | |
-| Manage {% data variables.product.prodname_dependabot_security_updates %} (see "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-github-dependabot-security-updates)") | **X** | | |
+| Manage {% data variables.product.prodname_dependabot_security_updates %} (see "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)") | **X** | | |{% endif %}
| [Manage the forking policy](/github/setting-up-and-managing-organizations-and-teams/managing-the-forking-policy-for-your-organization) | **X** | | |
| [Limit activity in public repositories in an organization](/articles/limiting-interactions-in-your-organization) | **X** | | |
| Pull (read), push (write), and clone (copy) *all repositories* in the organization | **X** | | |
@@ -84,7 +85,7 @@ Organization members can have *owner*{% if currentVersion == "free-pro-team@late
| Remove members from the organization | **X** | | |
| Reinstate former members to the organization | **X** | | |
| Add and remove people from **all teams** | **X** | |
-| Promote organization members to *team maintainer* | **X** | |{% if currentVersion ver_gt "enterprise-server@2.19" %}
+| Promote organization members to *team maintainer* | **X** | |{% if currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %}
| Configure code review assignments (see "[Managing code review assignment for your team](/github/setting-up-and-managing-organizations-and-teams/managing-code-review-assignment-for-your-team)") | **X** | |{% endif %}
| Add collaborators to **all repositories** | **X** | |
| Access the organization audit log | **X** | |
@@ -103,13 +104,13 @@ Organization members can have *owner*{% if currentVersion == "free-pro-team@late
| Edit and delete team discussions in **all teams** (for more information, see "[Managing disruptive comments](/articles/managing-disruptive-comments) | **X** | | |
| Hide comments on commits, pull requests, and issues (see "[Managing disruptive comments](/articles/managing-disruptive-comments/#hiding-a-comment)" for details) | **X** | **X** | **X** |
| Disable team discussions for an organization (see "[Disabling team discussions for your organization](/articles/disabling-team-discussions-for-your-organization)" for details) | **X** | | |
-| Set a team profile picture in **all teams** (see "[Setting your team's profile picture](/articles/setting-your-team-s-profile-picture)" for details) | **X** | | |{% if currentVersion ver_gt "enterprise-server@2.22" %}
+| Set a team profile picture in **all teams** (see "[Setting your team's profile picture](/articles/setting-your-team-s-profile-picture)" for details) | **X** | | |{% if currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}
| Disable publication of {% data variables.product.prodname_pages %} sites from repositories in the organization (see "[Disabling publication of {% data variables.product.prodname_pages %} sites for your organization](/github/setting-up-and-managing-organizations-and-teams/disabling-publication-of-github-pages-sites-for-your-organization)" for details) | **X** | | |{% endif %}
| [Move teams in an organization's hierarchy](/articles/moving-a-team-in-your-organization-s-hierarchy) | **X** | | |
| Pull (read), push (write), and clone (copy) *all repositories* in the organization | **X** | |
| Convert organization members to [outside collaborators](#outside-collaborators) | **X** | |
| [View people with access to an organization repository](/articles/viewing-people-with-access-to-your-repository) | **X** | |
-| [Export a list of people with access to an organization repository](/articles/viewing-people-with-access-to-your-repository/#exporting-a-list-of-people-with-access-to-your-repository) | **X** | |{% if currentVersion ver_gt "enterprise-server@2.19" %}
+| [Export a list of people with access to an organization repository](/articles/viewing-people-with-access-to-your-repository/#exporting-a-list-of-people-with-access-to-your-repository) | **X** | |{% if currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %}
| Manage default labels (see "[Managing default labels for repositories in your organization](/articles/managing-default-labels-for-repositories-in-your-organization)") | **X** | |{% endif %}
{% endif %}
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/project-board-permissions-for-an-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/project-board-permissions-for-an-organization.md
index 02b275cc4c3a..aba2d155aa11 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/project-board-permissions-for-an-organization.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/project-board-permissions-for-an-organization.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Permissions overview
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/reinstating-a-former-member-of-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/reinstating-a-former-member-of-your-organization.md
index 2db5ef11c624..7a8d714fa5dd 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/reinstating-a-former-member-of-your-organization.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/reinstating-a-former-member-of-your-organization.md
@@ -6,9 +6,13 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
+permissions: 'Organization owners can reinstate a former member of an organization.'
---
-If you [remove a user from your organization](/articles/removing-a-member-from-your-organization), [convert an organization member to an outside collaborator](/articles/converting-an-organization-member-to-an-outside-collaborator), or a user is removed from your organization because you've [required members and outside collaborators to enable two-factor authentication (2FA)](/articles/requiring-two-factor-authentication-in-your-organization), the user's access privileges and settings are saved for three months. You can restore the user's privileges if you {% if currentVersion =="free-pro-team@latest" %}invite{% else %}add{% endif %} them back to the organization within that time frame.
+### About member reinstatement
+
+If you [remove a user from your organization](/articles/removing-a-member-from-your-organization){% if currentVersion == "github-ae@latest" %} or{% else %},{% endif %} [convert an organization member to an outside collaborator](/articles/converting-an-organization-member-to-an-outside-collaborator){% if currentVersion != "github-ae@latest" %}, or a user is removed from your organization because you've [required members and outside collaborators to enable two-factor authentication (2FA)](/articles/requiring-two-factor-authentication-in-your-organization){% endif %}, the user's access privileges and settings are saved for three months. You can restore the user's privileges if you {% if currentVersion =="free-pro-team@latest" %}invite{% else %}add{% endif %} them back to the organization within that time frame.
{% data reusables.two_fa.send-invite-to-reinstate-user-before-2fa-is-enabled %}
@@ -21,21 +25,15 @@ When you reinstate a former organization member, you can restore:
- Issue assignments in the organization
- Repository subscriptions (notification settings for watching, not watching, or ignoring a repository's activity)
- {% tip %}
-
- {% if currentVersion == "free-pro-team@latest" %}
- **Tips**:
- - If an organization member was removed from the organization because they did not use two-factor authentication and your organization still requires members to use 2FA, the former member must enable two-factor authentication before you can reinstate their membership.
- - Only organization owners can invite users to join an organization. For more information, see "[Permission levels for an organization](/articles/permission-levels-for-an-organization)."
- - If your organization has a paid per-user subscription, an unused license must be available before you can reinstate a former organization member. For more information, see "[About per-user pricing](/articles/about-per-user-pricing)." {% data reusables.organizations.org-invite-expiration %}
+{% if enterpriseServerVersions contains currentVersion %}
+If an organization member was removed from the organization because they did not use two-factor authentication and your organization still requires members to use 2FA, the former member must enable two-factor authentication before you can reinstate their membership.
+{% endif %}
- {% else %}
- **Tips**:
- - If an organization member was removed from the organization because they did not use two-factor authentication and your organization still requires members to use 2FA, the former member must enable two-factor authentication before you can reinstate their membership.
- - Only organization owners can add users to an organization. For more information, see "[Permission levels for an organization](/articles/permission-levels-for-an-organization)."
- {% endif %}
+{% if currentVersion == "free-pro-team@latest" %}
+If your organization has a paid per-user subscription, an unused license must be available before you can reinstate a former organization member. For more information, see "[About per-user pricing](/articles/about-per-user-pricing)." {% data reusables.organizations.org-invite-expiration %}
+{% endif %}
- {% endtip %}
+### Reinstating a former member of your organization
{% data reusables.profile.access_profile %}
{% data reusables.profile.access_org %}
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/reinstating-a-former-outside-collaborators-access-to-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/reinstating-a-former-outside-collaborators-access-to-your-organization.md
index 90f63f350be0..3608669ae51d 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/reinstating-a-former-outside-collaborators-access-to-your-organization.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/reinstating-a-former-outside-collaborators-access-to-your-organization.md
@@ -1,15 +1,16 @@
---
title: Reinstating a former outside collaborator's access to your organization
-intro: 'If you required two-factor authentication in your organization and an outside collaborator was removed from the organization for not having 2FA enabled, you can reinstate a former outside collaborator''s access permissions for organization repositories, forks, and settings.'
+intro: "You can reinstate a former outside collaborator's access permissions for organization repositories, forks, and settings."
redirect_from:
- /articles/reinstating-a-former-outside-collaborator-s-access-to-your-organization
- /articles/reinstating-a-former-outside-collaborators-access-to-your-organization
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
-If an outside collaborator's access to your organization's private repositories is removed because you've [required members and outside collaborators to enable two-factor authentication](/articles/requiring-two-factor-authentication-in-your-organization), the user's access privileges and settings are saved for three months. You can restore the user's privileges if you {% if currentVersion == "free-pro-team@latest" %}invite{% else %}add{% endif %} them back to the organization within that time frame.
+When an outside collaborator's access to your organization's private repositories is removed, the user's access privileges and settings are saved for three months. You can restore the user's privileges if you {% if currentVersion == "free-pro-team@latest" %}invite{% else %}add{% endif %} them back to the organization within that time frame.
{% data reusables.two_fa.send-invite-to-reinstate-user-before-2fa-is-enabled %}
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/removing-a-member-from-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/removing-a-member-from-your-organization.md
index b6d5f8539bdd..69be72a9b536 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/removing-a-member-from-your-organization.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/removing-a-member-from-your-organization.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Only organization owners can remove members from an organization.
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/removing-an-outside-collaborator-from-an-organization-project-board.md b/content/github/setting-up-and-managing-organizations-and-teams/removing-an-outside-collaborator-from-an-organization-project-board.md
index f5f7470a9b3b..545cc8145f2e 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/removing-an-outside-collaborator-from-an-organization-project-board.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/removing-an-outside-collaborator-from-an-organization-project-board.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.profile.access_profile %}
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/removing-an-outside-collaborator-from-an-organization-repository.md b/content/github/setting-up-and-managing-organizations-and-teams/removing-an-outside-collaborator-from-an-organization-repository.md
index 512109d464a2..d46382fc5562 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/removing-an-outside-collaborator-from-an-organization-repository.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/removing-an-outside-collaborator-from-an-organization-repository.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% if currentVersion == "free-pro-team@latest" %}
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/removing-github-app-managers-from-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/removing-github-app-managers-from-your-organization.md
index 877dcba70816..832ccf3cf584 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/removing-github-app-managers-from-your-organization.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/removing-github-app-managers-from-your-organization.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
For more information about {% data variables.product.prodname_github_app %} manager permissions, see "[Permission levels for an organization](/articles/permission-levels-for-an-organization#github-app-managers)."
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/removing-organization-members-from-a-team.md b/content/github/setting-up-and-managing-organizations-and-teams/removing-organization-members-from-a-team.md
index 603eefba506c..87ec11f1c209 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/removing-organization-members-from-a-team.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/removing-organization-members-from-a-team.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.repositories.deleted_forks_from_private_repositories_warning %}
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/renaming-a-team.md b/content/github/setting-up-and-managing-organizations-and-teams/renaming-a-team.md
index 82ca81f4d002..8df660190981 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/renaming-a-team.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/renaming-a-team.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.profile.access_profile %}
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/renaming-an-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/renaming-an-organization.md
index 4208f6d3efbf..a0f04df3b932 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/renaming-an-organization.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/renaming-an-organization.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% tip %}
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization.md
index 6c1cde5ff864..3d052e45e8c0 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
People with admin permissions can manage individual and team access to an organization-owned repository.
@@ -68,7 +69,7 @@ In addition to managing organization-level settings, organization owners have ad
| [Lock conversations](/articles/locking-conversations) | | | **X** | **X** | **X** |
| Transfer issues (see "[Transferring an issue to another repository](/articles/transferring-an-issue-to-another-repository)" for details) | | | **X** | **X** | **X** |
| [Act as a designated code owner for a repository](/articles/about-code-owners) | | | **X** | **X** | **X** |
-| [Mark a draft pull request as ready for review](/articles/changing-the-stage-of-a-pull-request) | | | **X** | **X** | **X** |{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
+| [Mark a draft pull request as ready for review](/articles/changing-the-stage-of-a-pull-request) | | | **X** | **X** | **X** |{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}
| [Convert a pull request to a draft](/articles/changing-the-stage-of-a-pull-request) | | | **X** | **X** | **X** |{% endif %}
| Submit reviews that affect a pull request's mergeability | | | **X** | **X** | **X** |
| [Apply suggested changes](/articles/incorporating-feedback-in-your-pull-request) to pull requests | | | **X** | **X** | **X** |
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/requesting-to-add-a-child-team.md b/content/github/setting-up-and-managing-organizations-and-teams/requesting-to-add-a-child-team.md
index 1bd763c85513..82391df28140 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/requesting-to-add-a-child-team.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/requesting-to-add-a-child-team.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
When you request to add a team as a child, a request is sent to the maintainers of the child team. Once a maintainer of the child team approves your request, the child team is nested under the parent team in your organization's hierarchy.
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/requesting-to-add-or-change-a-parent-team.md b/content/github/setting-up-and-managing-organizations-and-teams/requesting-to-add-or-change-a-parent-team.md
index f3cd52274ad7..2f295775c4b1 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/requesting-to-add-or-change-a-parent-team.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/requesting-to-add-or-change-a-parent-team.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
When you request to add or change your team's parent, a request is sent to the maintainers of the parent team. When a maintainer of the new parent team approves your request, your team is nested as a child team under the parent team in your organization's hierarchy.
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/requiring-two-factor-authentication-in-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/requiring-two-factor-authentication-in-your-organization.md
index 62557ec9b2e5..81fb510f8f27 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/requiring-two-factor-authentication-in-your-organization.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/requiring-two-factor-authentication-in-your-organization.md
@@ -14,7 +14,7 @@ versions:
{% if currentVersion == "free-pro-team@latest" %}
-You can also require two-factor authentication for organizations in an enterprise. For more information, see "[Enforcing security settings in your enterprise account](/github/setting-up-and-managing-your-enterprise-account/enforcing-security-settings-in-your-enterprise-account#requiring-two-factor-authentication-for-organizations-in-your-enterprise-account)."
+You can also require two-factor authentication for organizations in an enterprise. For more information, see "[Enforcing security settings in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-security-settings-in-your-enterprise-account#requiring-two-factor-authentication-for-organizations-in-your-enterprise-account)."
{% endif %}
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization.md
index 9cee2b1023ca..1a23b5fc5c5a 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization.md
@@ -6,13 +6,14 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
You can choose whether members can create repositories in your organization. If you allow members to create repositories, you can choose which types of repositories members can create.{% if currentVersion == "free-pro-team@latest" %} To allow members to create private repositories only, your organization must use {% data variables.product.prodname_ghe_cloud %}.{% endif %} For more information, see "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility)."
Organization owners can always create any type of repository.
-{% if currentVersion == "free-pro-team@latest" %}Enterprise owners{% else %}Site administrators{% endif %} can restrict the options you have available for your organization's repository creation policy. For more information, see {% if currentVersion == "free-pro-team@latest" %}"[Enforcing repository management policies in your enterprise account](/github/setting-up-and-managing-your-enterprise-account/enforcing-repository-management-policies-in-your-enterprise-account)."{% else %}"[Restricting repository creation in your instance](/enterprise/admin/user-management/restricting-repository-creation-in-your-instance)."{% endif %}
+{% if currentVersion == "free-pro-team@latest" %}Enterprise owners{% else %}Site administrators{% endif %} can restrict the options you have available for your organization's repository creation policy. For more information, see {% if currentVersion == "free-pro-team@latest" %}"[Enforcing repository management policies in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-repository-management-policies-in-your-enterprise-account)."{% else %}"[Restricting repository creation in your enterprise](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#setting-a-policy-for-repository-creation)."{% endif %}
{% warning %}
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/restricting-repository-visibility-changes-in-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/restricting-repository-visibility-changes-in-your-organization.md
index 0af34b884ef1..1f4ab1f06ab4 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/restricting-repository-visibility-changes-in-your-organization.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/restricting-repository-visibility-changes-in-your-organization.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
You can restrict the ability to change repository visibility to organization owners only, or allow members with admin privileges for a repository to also change visibility from private to public or public to private.
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization.md
index b0029b8eeabf..61497be9a9dd 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Accessing the audit log
@@ -34,10 +35,10 @@ To search for specific events, use the `action` qualifier in your query. Actions
| `hook` | Contains all activities related to webhooks.
| `integration_installation_request` | Contains all activities related to organization member requests for owners to approve integrations for use in the organization. |{% if currentVersion == "free-pro-team@latest" %}
| `marketplace_agreement_signature` | Contains all activities related to signing the {% data variables.product.prodname_marketplace %} Developer Agreement.
-| `marketplace_listing` | Contains all activities related to listing apps in {% data variables.product.prodname_marketplace %}.{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
+| `marketplace_listing` | Contains all activities related to listing apps in {% data variables.product.prodname_marketplace %}.{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}
| `members_can_create_pages` | Contains all activities related to disabling the publication of {% data variables.product.prodname_pages %} sites for repositories in the organization. For more information, see "[Restricting publication of {% data variables.product.prodname_pages %} sites for your organization](/github/setting-up-and-managing-organizations-and-teams/disabling-publication-of-github-pages-sites-for-your-organization)." | {% endif %}
| `org` | Contains all activities related to organization membership{% if currentVersion == "free-pro-team@latest" %}
-| `org_credential_authorization` | Contains all activities related to authorizing credentials for use with SAML single sign-on.{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
+| `org_credential_authorization` | Contains all activities related to authorizing credentials for use with SAML single sign-on.{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %}
| `organization_label` | Contains all activities related to default labels for repositories in your organization.{% endif %}{% if currentVersion == "free-pro-team@latest" %}
| `payment_method` | Contains all activities related to how your organization pays for GitHub.{% endif %}
| `profile_picture` | Contains all activities related to your organization's profile picture.
@@ -45,9 +46,9 @@ To search for specific events, use the `action` qualifier in your query. Actions
| `protected_branch` | Contains all activities related to protected branches.
| `repo` | Contains all activities related to the repositories owned by your organization.{% if currentVersion == "free-pro-team@latest" %}
| `repository_content_analysis` | Contains all activities related to [enabling or disabling data use for a private repository](/articles/about-github-s-use-of-your-data).
-| `repository_dependency_graph` | Contains all activities related to [enabling or disabling the dependency graph for a private repository](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-and-dependents-of-a-repository).{% endif %}
-| `repository_vulnerability_alert` | Contains all activities related to [{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_short %}{% else %}security{% endif %} alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies).{% if currentVersion == "free-pro-team@latest" %}
-| `sponsors` | Contains all events related to sponsor buttons (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)"){% endif %}{% if currentVersion != "free-pro-team@latest" %}
+| `repository_dependency_graph` | Contains all activities related to [enabling or disabling the dependency graph for a private repository](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-and-dependents-of-a-repository).{% endif %}{% if currentVersion != "github-ae@latest" %}
+| `repository_vulnerability_alert` | Contains all activities related to [{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot %}{% else %}security{% endif %} alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies).{% endif %}{% if currentVersion == "free-pro-team@latest" %}
+| `sponsors` | Contains all events related to sponsor buttons (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)"){% endif %}{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
| `team` | Contains all activities related to teams in your organization.{% endif %}
| `team_discussions` | Contains activities related to managing team discussions for an organization.
@@ -71,10 +72,10 @@ This list describes the available categories and associated events:
- [The `integration_installation_request` category](#the-integration_installation_request-category)
- [The `issue` category](#the-issue-category){% if currentVersion == "free-pro-team@latest" %}
- [The `marketplace_agreement_signature` category](#the-marketplace_agreement_signature-category)
-- [The `marketplace_listing` category](#the-marketplace_listing-category){% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
+- [The `marketplace_listing` category](#the-marketplace_listing-category){% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}
- [The `members_can_create_pages` category](#the-members_can_create_pages-category){% endif %}
- [The `org` category](#the-org-category){% if currentVersion == "free-pro-team@latest" %}
-- [The `org_credential_authorization` category](#the-org_credential_authorization-category){% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
+- [The `org_credential_authorization` category](#the-org_credential_authorization-category){% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %}
- [The `organization_label` category](#the-organization_label-category){% endif %}
- [The `oauth_application` category](#the-oauth_application-category){% if currentVersion == "free-pro-team@latest" %}
- [The `payment_method` category](#the-payment_method-category){% endif %}
@@ -83,9 +84,9 @@ This list describes the available categories and associated events:
- [The `protected_branch` category](#the-protected_branch-category)
- [The `repo` category](#the-repo-category){% if currentVersion == "free-pro-team@latest" %}
- [The `repository_content_analysis` category](#the-repository_content_analysis-category)
-- [The `repository_dependency_graph` category](#the-repository_dependency_graph-category){% endif %}
-- [The `repository_vulnerability_alert` category](#the-repository_vulnerability_alert-category){% if currentVersion == "free-pro-team@latest" %}
-- [The `sponsors` category](#the-sponsors-category){% endif %}{% if currentVersion != "free-pro-team@latest" %}
+- [The `repository_dependency_graph` category](#the-repository_dependency_graph-category){% endif %}{% if currentVersion != "github-ae@latest" %}
+- [The `repository_vulnerability_alert` category](#the-repository_vulnerability_alert-category){% endif %}{% if currentVersion == "free-pro-team@latest" %}
+- [The `sponsors` category](#the-sponsors-category){% endif %}{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
- [The `team` category](#the-team-category){% endif %}
- [The `team_discussions` category](#the-team_discussions-category)
@@ -165,7 +166,7 @@ This list describes the available categories and associated events:
{% endif %}
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}
##### The `members_can_create_pages` category
@@ -184,25 +185,35 @@ For more information, see "[Restricting publication of {% data variables.product
|------------------|-------------------{% if currentVersion == "free-pro-team@latest"%}
| `audit_log_export` | Triggered when an organization admin [creates an export of the organization audit log](#exporting-the-audit-log). If the export included a query, the log will list the query used and the number of audit log entries matching that query.
| `block_user` | Triggered when an organization owner [blocks a user from accessing the organization's repositories](/articles/blocking-a-user-from-your-organization).
-| `cancel_invitation` | Triggered when an organization invitation has been revoked.
+| `cancel_invitation` | Triggered when an organization invitation has been revoked. {% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
+| `create_actions_secret` | Triggered when a organization admin [creates a {% data variables.product.prodname_actions %} secret](/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-an-organization).{% endif %} {% if currentVersion == "free-pro-team@latest"%}
| `disable_oauth_app_restrictions` | Triggered when an owner [disables {% data variables.product.prodname_oauth_app %} access restrictions](/articles/disabling-oauth-app-access-restrictions-for-your-organization) for your organization.
| `disable_saml` | Triggered when an organization admin disables SAML single sign-on for an organization.{% endif %}
-| `disable_member_team_creation_permission` | Triggered when an organization owner limits team creation to owners. For more information, see "[Setting team creation permissions in your organization](/articles/setting-team-creation-permissions-in-your-organization)." |
-| `disable_two_factor_requirement` | Triggered when an owner disables a two-factor authentication requirement for all members{% if currentVersion == "free-pro-team@latest" %}, billing managers,{% endif %} and outside collaborators in an organization.{% if currentVersion == "free-pro-team@latest" %}
+| `disable_member_team_creation_permission` | Triggered when an organization owner limits team creation to owners. For more information, see "[Setting team creation permissions in your organization](/articles/setting-team-creation-permissions-in-your-organization)." |{% if currentVersion != "github-ae@latest" %}
+| `disable_two_factor_requirement` | Triggered when an owner disables a two-factor authentication requirement for all members{% if currentVersion == "free-pro-team@latest" %}, billing managers,{% endif %} and outside collaborators in an organization.{% endif %}{% if currentVersion == "free-pro-team@latest" %}
| `enable_oauth_app_restrictions` | Triggered when an owner [enables {% data variables.product.prodname_oauth_app %} access restrictions](/articles/enabling-oauth-app-access-restrictions-for-your-organization) for your organization.
| `enable_saml` | Triggered when an organization admin [enables SAML single sign-on](/articles/enabling-and-testing-saml-single-sign-on-for-your-organization) for an organization.{% endif %}
-| `enable_member_team_creation_permission` | Triggered when an organization owner allows members to create teams. For more information, see "[Setting team creation permissions in your organization](/articles/setting-team-creation-permissions-in-your-organization)." |
-| `enable_two_factor_requirement` | Triggered when an owner requires two-factor authentication for all members{% if currentVersion == "free-pro-team@latest" %}, billing managers,{% endif %} and outside collaborators in an organization.
+| `enable_member_team_creation_permission` | Triggered when an organization owner allows members to create teams. For more information, see "[Setting team creation permissions in your organization](/articles/setting-team-creation-permissions-in-your-organization)." |{% if currentVersion != "github-ae@latest" %}
+| `enable_two_factor_requirement` | Triggered when an owner requires two-factor authentication for all members{% if currentVersion == "free-pro-team@latest" %}, billing managers,{% endif %} and outside collaborators in an organization.{% endif %}
| `invite_member` | Triggered when [a new user was invited to join your organization](/articles/adding-organization-members-to-a-team).{% if currentVersion == "free-pro-team@latest" %}
| `oauth_app_access_approved` | Triggered when an owner [grants organization access to an {% data variables.product.prodname_oauth_app %}](/articles/approving-oauth-apps-for-your-organization/).
| `oauth_app_access_denied` | Triggered when an owner [disables a previously approved {% data variables.product.prodname_oauth_app %}'s access](/articles/denying-access-to-a-previously-approved-oauth-app-for-your-organization) to your organization.
-| `oauth_app_access_requested` | Triggered when an organization member requests that an owner grant an {% data variables.product.prodname_oauth_app %} access to your organization.{% endif %}{% if currentVersion == "free-pro-team@latest" %}
+| `oauth_app_access_requested` | Triggered when an organization member requests that an owner grant an {% data variables.product.prodname_oauth_app %} access to your organization.{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
+| `register_self_hosted_runner` | Triggered when an organization owner [registers a new self-hosted runner](/actions/hosting-your-own-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-an-organization).
+| `remove_actions_secret` | Triggered when a organization admin removes a {% data variables.product.prodname_actions %} secret.{% endif %}{% if currentVersion == "free-pro-team@latest"%}
| `remove_billing_manager` | Triggered when an [owner removes a billing manager from an organization](/articles/removing-a-billing-manager-from-your-organization/) or when [two-factor authentication is required in an organization](/articles/requiring-two-factor-authentication-in-your-organization) and a billing manager doesn't use 2FA or disables 2FA. |{% endif %}
-| `remove_member` | Triggered when an [owner removes a member from an organization](/articles/removing-a-member-from-your-organization/) or when [two-factor authentication is required in an organization](/articles/requiring-two-factor-authentication-in-your-organization) and an organization member doesn't use 2FA or disables 2FA. Also triggered when an [organization member removes themselves](/articles/removing-yourself-from-an-organization/) from an organization.|
-| `remove_outside_collaborator` | Triggered when an owner removes an outside collaborator from an organization or when [two-factor authentication is required in an organization](/articles/requiring-two-factor-authentication-in-your-organization) and an outside collaborator does not use 2FA or disables 2FA. |{% if currentVersion == "free-pro-team@latest" %}
+| `remove_member` | Triggered when an [owner removes a member from an organization](/articles/removing-a-member-from-your-organization/){% if currentVersion != "github-ae@latest" %} or when [two-factor authentication is required in an organization](/articles/requiring-two-factor-authentication-in-your-organization) and an organization member doesn't use 2FA or disables 2FA{% endif %}. Also triggered when an [organization member removes themselves](/articles/removing-yourself-from-an-organization/) from an organization.|
+| `remove_outside_collaborator` | Triggered when an owner removes an outside collaborator from an organization{% if currentVersion != "github-ae@latest" %} or when [two-factor authentication is required in an organization](/articles/requiring-two-factor-authentication-in-your-organization) and an outside collaborator does not use 2FA or disables 2FA{% endif %}. |{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
+| `remove_self_hosted_runner` | Triggered when an organization owner [removes a self-hosted runner](/actions/hosting-your-own-runners/removing-self-hosted-runners#removing-a-runner-from-an-organization). {% endif %}{% if currentVersion == "free-pro-team@latest" %}
| `revoke_external_identity` | Triggered when an organization owner revokes a member's linked identity. For more information, see "[Viewing and managing a member's SAML access to your organization](/github/setting-up-and-managing-organizations-and-teams/viewing-and-managing-a-members-saml-access-to-your-organization#viewing-and-revoking-a-linked-identity)."
-| `revoke_sso_session` | Triggered when an organization owner revokes a member's SAML session. For more information, see "[Viewing and managing a member's SAML access to your organization](/github/setting-up-and-managing-organizations-and-teams/viewing-and-managing-a-members-saml-access-to-your-organization#viewing-and-revoking-a-linked-identity)."
-| `unblock_user` | Triggered when an organization owner [unblocks a user from an organization](/articles/unblocking-a-user-from-your-organization).{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
+| `revoke_sso_session` | Triggered when an organization owner revokes a member's SAML session. For more information, see "[Viewing and managing a member's SAML access to your organization](/github/setting-up-and-managing-organizations-and-teams/viewing-and-managing-a-members-saml-access-to-your-organization#viewing-and-revoking-a-linked-identity)." {% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
+| `runner_group_created` | Triggered when an organization admin [creates a self-hosted runner group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#creating-a-self-hosted-runner-group-for-an-organization).
+| `runner_group_removed` | Triggered when an organization admin removes a self-hosted runner group.
+| `runner_group_renamed` | Triggered when an organization admin renames a self-hosted runner group.
+| `runner_group_runners_added` | Triggered when an organization admin [adds a self-hosted runner to a group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#moving-a-self-hosted-runner-to-a-group).
+| `runner_group_runners_removed` | Triggered when an organization admin removes a self-hosted runner from a group. {% endif %}{% if currentVersion == "free-pro-team@latest"%}
+| `unblock_user` | Triggered when an organization owner [unblocks a user from an organization](/articles/unblocking-a-user-from-your-organization).{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
+| `update_actions_secret` | Triggered when a organization admin updates a {% data variables.product.prodname_actions %} secret.{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}
| `update_new_repository_default_branch_setting` | Triggered when an owner changes the name of the default branch for new repositories in the organization. For more information, see "[Managing the default branch name for repositories in your organization](/github/setting-up-and-managing-organizations-and-teams/managing-the-default-branch-name-for-repositories-in-your-organization)."{% endif %}
| `update_default_repository_permission` | Triggered when an owner changes the default repository permission level for organization members.
| `update_member` | Triggered when an owner changes a person's role from owner to member or member to owner.
@@ -221,7 +232,7 @@ For more information, see "[Restricting publication of {% data variables.product
{% endif %}
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %}
##### The `organization_label` category
| Action | Description
@@ -287,7 +298,7 @@ For more information, see "[Restricting publication of {% data variables.product
| `update_required_status_checks_enforcement_level ` | Triggered when enforcement of required status checks is updated on a branch.
| `update_strict_required_status_checks_policy` | Triggered when the requirement for a branch to be up to date before merging is changed.
| `rejected_ref_update ` | Triggered when a branch update attempt is rejected.
-| `policy_override ` | Triggered when a branch protection requirement is overridden by a repository administrator.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
+| `policy_override ` | Triggered when a branch protection requirement is overridden by a repository administrator.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %}
| `update_allow_force_pushes_enforcement_level ` | Triggered when force pushes are enabled or disabled for a protected branch.
| `update_allow_deletions_enforcement_level ` | Triggered when branch deletion is enabled or disabled for a protected branch.
| `update_linear_history_requirement_enforcement_level ` | Triggered when required linear commit history is enabled or disabled for a protected branch.
@@ -300,21 +311,26 @@ For more information, see "[Restricting publication of {% data variables.product
| `access` | Triggered when a repository owned by an organization is [switched from "private" to "public"](/articles/making-a-private-repository-public) (or vice versa).
| `add_member` | Triggered when a user accepts an [invitation to have collaboration access to a repository](/articles/inviting-collaborators-to-a-personal-repository).
| `add_topic` | Triggered when a repository admin [adds a topic](/articles/classifying-your-repository-with-topics) to a repository.
-| `archived` | Triggered when a repository admin [archives a repository](/articles/about-archiving-repositories).{% if currentVersion != "free-pro-team@latest" %}
+| `archived` | Triggered when a repository admin [archives a repository](/articles/about-archiving-repositories).{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
| `config.disable_anonymous_git_access` | Triggered when [anonymous Git read access is disabled](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository) in a public repository.
| `config.enable_anonymous_git_access` | Triggered when [anonymous Git read access is enabled](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository) in a public repository.
| `config.lock_anonymous_git_access` | Triggered when a repository's [anonymous Git read access setting is locked](/enterprise/{{ currentVersion }}/admin/guides/user-management/preventing-users-from-changing-anonymous-git-read-access).
| `config.unlock_anonymous_git_access` | Triggered when a repository's [anonymous Git read access setting is unlocked](/enterprise/{{ currentVersion }}/admin/guides/user-management/preventing-users-from-changing-anonymous-git-read-access).{% endif %}
-| `create` | Triggered when [a new repository is created](/articles/creating-a-new-repository).
+| `create` | Triggered when [a new repository is created](/articles/creating-a-new-repository).{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
+| `create_actions_secret` | Triggered when a repository admin [creates a {% data variables.product.prodname_actions %} secret](/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository).{% endif %}
| `destroy` | Triggered when [a repository is deleted](/articles/deleting-a-repository).{% if currentVersion == "free-pro-team@latest" %}
| `disable` | Triggered when a repository is disabled (e.g., for [insufficient funds](/articles/unlocking-a-locked-account)).{% endif %}
-| `enable` | Triggered when a repository is reenabled.
-| `remove_member` | Triggered when a user is [removed from a repository as a collaborator](/articles/removing-a-collaborator-from-a-personal-repository).
+| `enable` | Triggered when a repository is reenabled.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
+| `remove_actions_secret` | Triggered when a repository admin removes a {% data variables.product.prodname_actions %} secret.{% endif %}
+| `remove_member` | Triggered when a user is [removed from a repository as a collaborator](/articles/removing-a-collaborator-from-a-personal-repository).{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
+| `register_self_hosted_runner` | Triggered when a repository admin [registers a new self-hosted runner](/actions/hosting-your-own-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-a-repository).
+| `remove_self_hosted_runner` | Triggered when a repository admin [removes a self-hosted runner](/actions/hosting-your-own-runners/removing-self-hosted-runners#removing-a-runner-from-a-repository). {% endif %}
| `remove_topic` | Triggered when a repository admin removes a topic from a repository.
| `rename` | Triggered when [a repository is renamed](/articles/renaming-a-repository).
| `transfer` | Triggered when [a repository is transferred](/articles/how-to-transfer-a-repository).
| `transfer_start` | Triggered when a repository transfer is about to occur.
-| `unarchived` | Triggered when a repository admin unarchives a repository.
+| `unarchived` | Triggered when a repository admin unarchives a repository.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
+| `update_actions_secret` | Triggered when a repository admin updates a {% data variables.product.prodname_actions %} secret.{% endif %}
{% if currentVersion == "free-pro-team@latest" %}
@@ -333,14 +349,16 @@ For more information, see "[Restricting publication of {% data variables.product
| `disable` | Triggered when a repository owner or person with admin access to the repository [disables the dependency graph for a private repository](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-and-dependents-of-a-repository).
{% endif %}
+{% if currentVersion != "github-ae@latest" %}
##### The `repository_vulnerability_alert` category
| Action | Description
|------------------|-------------------
-| `create` | Triggered when {% data variables.product.product_name %} creates a [{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_short %}{% else %}security{% endif %} alert for a vulnerable dependency](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies) in a particular repository.
+| `create` | Triggered when {% data variables.product.product_name %} creates a [{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot %}{% else %}security{% endif %} alert for a vulnerable dependency](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies) in a particular repository.
| `resolve` | Triggered when someone with write access to a repository [pushes changes to update and resolve a vulnerability](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies) in a project dependency.
-| `dismiss` | Triggered when an organization owner or person with admin access to the repository dismisses a {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_short %}{% else %}security{% endif %} alert about a vulnerable dependency.{% if currentVersion == "free-pro-team@latest" %}
-| `authorized_users_teams` | Triggered when an organization owner or a member with admin permissions to the repository [updates the list of people or teams authorized to receive {% data variables.product.prodname_dependabot_short %} alerts](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-github-dependabot-alerts) for vulnerable dependencies in the repository.{% endif %}
+| `dismiss` | Triggered when an organization owner or person with admin access to the repository dismisses a {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot %}{% else %}security{% endif %} alert about a vulnerable dependency.{% if currentVersion == "free-pro-team@latest" %}
+| `authorized_users_teams` | Triggered when an organization owner or a member with admin permissions to the repository [updates the list of people or teams authorized to receive {% data variables.product.prodname_dependabot_alerts %}](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-dependabot-alerts) for vulnerable dependencies in the repository.{% endif %}
+{% endif %}
{% if currentVersion == "free-pro-team@latest" %}
##### The `sponsors` category
@@ -351,7 +369,7 @@ For more information, see "[Restricting publication of {% data variables.product
| repo_funding_links_file_action | Triggered when you change the FUNDING file in your repository (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)")
{% endif %}
-{% if currentVersion != "free-pro-team@latest" %}
+{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
##### The `team` category
| Action | Description
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/reviewing-your-organizations-installed-integrations.md b/content/github/setting-up-and-managing-organizations-and-teams/reviewing-your-organizations-installed-integrations.md
index 83bcbe3dd4f6..ac62de20d3b2 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/reviewing-your-organizations-installed-integrations.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/reviewing-your-organizations-installed-integrations.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.profile.access_profile %}
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/setting-base-permissions-for-an-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/setting-base-permissions-for-an-organization.md
index 78b830743ef4..10d1f5c9aa83 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/setting-base-permissions-for-an-organization.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/setting-base-permissions-for-an-organization.md
@@ -5,6 +5,7 @@ permissions: Organization owners can set base permissions for an organization.
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### About base permissions for an organization
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/setting-permissions-for-adding-outside-collaborators.md b/content/github/setting-up-and-managing-organizations-and-teams/setting-permissions-for-adding-outside-collaborators.md
index 9f038f84ec7b..e70f55bc64b2 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/setting-permissions-for-adding-outside-collaborators.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/setting-permissions-for-adding-outside-collaborators.md
@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Organization owners, and members with admin privileges for a repository, can invite outside collaborators to work on the repository. You can also restrict outside collaborator invite permissions to only organization owners.
@@ -18,7 +19,7 @@ Organization owners, and members with admin privileges for a repository, can inv
{% data reusables.profile.access_org %}
{% data reusables.organizations.org_settings %}
{% data reusables.organizations.member-privileges %}
-5. Under "Repository invitations", select **Allow members to invite outside collaborators to repositories for this organization**.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
+5. Under "Repository invitations", select **Allow members to invite outside collaborators to repositories for this organization**.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}
{% else %}
{% endif %}
6. Click **Save**.
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/setting-permissions-for-deleting-or-transferring-repositories.md b/content/github/setting-up-and-managing-organizations-and-teams/setting-permissions-for-deleting-or-transferring-repositories.md
index 9558d46a870a..8634dc39ecd7 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/setting-permissions-for-deleting-or-transferring-repositories.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/setting-permissions-for-deleting-or-transferring-repositories.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Owners can set permissions for deleting or transferring repositories in an organization.
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/setting-team-creation-permissions-in-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/setting-team-creation-permissions-in-your-organization.md
index e03a18920cd2..6e9c8a766802 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/setting-team-creation-permissions-in-your-organization.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/setting-team-creation-permissions-in-your-organization.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Organization owners can set team creation permissions.
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/setting-your-teams-profile-picture.md b/content/github/setting-up-and-managing-organizations-and-teams/setting-your-teams-profile-picture.md
index 0e6723cfd81e..2729775095f3 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/setting-your-teams-profile-picture.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/setting-your-teams-profile-picture.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Unless you set a profile picture for a team, the team profile picture will match the organization's profile picture.
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/synchronizing-a-team-with-an-identity-provider-group.md b/content/github/setting-up-and-managing-organizations-and-teams/synchronizing-a-team-with-an-identity-provider-group.md
index bc310f396946..e4d0144b2186 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/synchronizing-a-team-with-an-identity-provider-group.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/synchronizing-a-team-with-an-identity-provider-group.md
@@ -36,11 +36,11 @@ A removed team member can be added back to a team automatically once they have a
To avoid unintentionally removing team members, we recommend enforcing SAML SSO in your organization or enterprise account, creating new teams to synchronize membership data, and checking IdP group membership before synchronizing existing teams. For more information, see "[Enforcing SAML single sign-on for your organization](/articles/enforcing-saml-single-sign-on-for-your-organization)."
-If your organization is owned by an enterprise account, enabling team synchronization for the enterprise account will override your organization-level team synchronization settings. For more information, see "[Enforcing security settings in your enterprise account](/github/setting-up-and-managing-your-enterprise-account/enforcing-security-settings-in-your-enterprise-account#managing-team-synchronization-for-organizations-in-your-enterprise-account)."
+If your organization is owned by an enterprise account, enabling team synchronization for the enterprise account will override your organization-level team synchronization settings. For more information, see "[Enforcing security settings in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-security-settings-in-your-enterprise-account#managing-team-synchronization-for-organizations-in-your-enterprise-account)."
### Prerequisites
-Before you can connect a team with an identity provider group, an organization or enterprise owner must enable team synchronization for your organization or enterprise account. For more information, see "[Managing team synchronization for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-team-synchronization-for-your-organization)" and "[Enforcing security settings in your enterprise account](/github/setting-up-and-managing-your-enterprise-account/enforcing-security-settings-in-your-enterprise-account#managing-team-synchronization-for-organizations-in-your-enterprise-account)."
+Before you can connect a team with an identity provider group, an organization or enterprise owner must enable team synchronization for your organization or enterprise account. For more information, see "[Managing team synchronization for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-team-synchronization-for-your-organization)" and "[Enforcing security settings in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-security-settings-in-your-enterprise-account#managing-team-synchronization-for-organizations-in-your-enterprise-account)."
To avoid unintentionally removing team members, visit the administrative portal for your IdP and confirm that each current team member is also in the IdP groups that you want to connect to this team. If you don't have this access to your identity provider, you can reach out to your IdP administrator.
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/transferring-organization-ownership.md b/content/github/setting-up-and-managing-organizations-and-teams/transferring-organization-ownership.md
index 3a88bb32cd1a..8cb3565f9162 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/transferring-organization-ownership.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/transferring-organization-ownership.md
@@ -7,6 +7,7 @@ intro: 'To make someone else the owner of an organization account, you must add
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
1. If you're the only member with *owner* privileges, give another organization member the owner role. For more information, see "[Appointing an organization owner](/github/setting-up-and-managing-organizations-and-teams/maintaining-ownership-continuity-for-your-organization#appointing-an-organization-owner)."
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/viewing-and-managing-a-members-saml-access-to-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/viewing-and-managing-a-members-saml-access-to-your-organization.md
index 5806b481065f..d15e7fc8e228 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/viewing-and-managing-a-members-saml-access-to-your-organization.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/viewing-and-managing-a-members-saml-access-to-your-organization.md
@@ -55,4 +55,4 @@ You can view and revoke each member's linked identity, active sessions, and auth
### Further reading
- "[About identity and access management with SAML single sign-on](/articles/about-identity-and-access-management-with-saml-single-sign-on)"
-- "[Viewing and managing a user's 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)"
+- "[Viewing and managing a user's SAML access to your enterprise account](/github/setting-up-and-managing-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise-account)"
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/viewing-insights-for-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/viewing-insights-for-your-organization.md
index 2843057e4fc8..4e18a1b3a658 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/viewing-insights-for-your-organization.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/viewing-insights-for-your-organization.md
@@ -43,7 +43,7 @@ With dependency insights you can view vulnerabilities, licenses, and other impor
5. To view dependency insights for all your {% data variables.product.prodname_ghe_cloud %} organizations, click **My organizations**.
6. You can click the results in the **Open security advisories** and **Licenses** graphs to filter by a vulnerability status, a license, or a combination of the two.
- 
+ 
7. You can click on {% octicon "package" aria-label="The package icon" %} **dependents** next to each vulnerability to see which dependents in your organization are using each library.
@@ -52,4 +52,4 @@ With dependency insights you can view vulnerabilities, licenses, and other impor
- "[About organizations](/github/setting-up-and-managing-organizations-and-teams/about-organizations)"
- "[Exploring the dependencies of a repository](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository)"
- "[Changing the visibility of your organization's dependency insights](/github/setting-up-and-managing-organizations-and-teams/changing-the-visibility-of-your-organizations-dependency-insights)"
- - "[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)"
+ - "[Enforcing a policy on dependency insights in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-a-policy-on-dependency-insights-in-your-enterprise-account)"
diff --git a/content/github/setting-up-and-managing-organizations-and-teams/viewing-people-with-access-to-your-repository.md b/content/github/setting-up-and-managing-organizations-and-teams/viewing-people-with-access-to-your-repository.md
index 31cae8b7d195..9e67d7430757 100644
--- a/content/github/setting-up-and-managing-organizations-and-teams/viewing-people-with-access-to-your-repository.md
+++ b/content/github/setting-up-and-managing-organizations-and-teams/viewing-people-with-access-to-your-repository.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Administrators can use this information to help off-board people, gather data for compliance, and other general security checkups.
diff --git a/content/github/setting-up-and-managing-your-enterprise-account/roles-for-an-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise-account/roles-for-an-enterprise-account.md
deleted file mode 100644
index 767a7cc16d1f..000000000000
--- a/content/github/setting-up-and-managing-your-enterprise-account/roles-for-an-enterprise-account.md
+++ /dev/null
@@ -1,55 +0,0 @@
----
-title: Roles for an enterprise account
-intro: 'To control access to your enterprise account''s settings and data, you can give different roles to people in the enterprise account.'
-product: '{% data reusables.gated-features.enterprise-accounts %}'
-redirect_from:
- - /articles/permission-levels-for-a-business-account/
- - /articles/roles-for-an-enterprise-account
-versions:
- free-pro-team: '*'
- enterprise-server: '*'
----
-
-For more information about adding people to your enterprise account, see "[Inviting people to manage your enterprise account](/articles/inviting-people-to-manage-your-enterprise-account)."
-
-### About roles for an enterprise account
-
-Enterprise accounts come with a set of administrator roles that you can assign to users of your enterprise. Each administrator role maps to business functions and provides permissions to do specific tasks within the enterprise account.
-
-{% data reusables.enterprise-accounts.enterprise-administrators %}
-
-### Enterprise owner
-
-Enterprise owners have complete control over the enterprise account and can take every action, including:
-- Managing administrators
-- Adding and removing organizations to and from the enterprise
-- Managing enterprise settings
-- Enforcing policy across organizations
-- Managing billing settings
-
-Enterprise owners cannot access organization settings or content unless they are made an organization owner or given direct access to an organization-owned repository. Similarly, owners of organizations in your enterprise account do not have access to the enterprise account itself unless you make them enterprise owners.
-
-You can add as many enterprise owners as you'd like to your enterprise account. Enterprise owners must have a personal account on {% data variables.product.prodname_dotcom %}. As a best practice, we recommend making only a few people in your company enterprise owners, to reduce the risk to your business.
-
-### Enterprise members
-
-Members of organizations owned by your enterprise account are also automatically members of the enterprise account. Members can collaborate in organizations and may be organization owners, but members cannot access or configure enterprise account settings, including billing settings.
-
-People in your enterprise account may have different levels of access to the various organizations owned by your enterprise account and to repositories within those organizations. You can view the resources that each person has access to. For more information, see "[Viewing people in your enterprise account](/articles/viewing-people-in-your-enterprise-account)."
-
-For more information about organization-level permissions, see "[Permission levels for an organization](/articles/permission-levels-for-an-organization)."
-
-People with outside collaborator access to repositories owned by your organization are also listed in your enterprise account's People tab, but are not enterprise members and do not have any access to the enterprise account. For more information about outside collaborators, see "[Permission levels for an organization](/articles/permission-levels-for-an-organization#outside-collaborators)."
-
-### Billing manager
-
-Billing managers only have access to your enterprise account's billing settings. Billing managers for your enterprise account can:
-- View and manage user licenses, {% data variables.large_files.product_name_short %} packs and other billing settings
-- View a list of billing managers
-- Add or remove other billing managers
-
-Billing managers do not have access to organizations or repositories in your enterprise account, and cannot add or remove enterprise owners. Billing managers must have a personal account on {% data variables.product.prodname_dotcom %}.
-
-### Further reading
-
-- "[About enterprise accounts](/articles/about-enterprise-accounts)"
diff --git a/content/github/setting-up-and-managing-your-enterprise-account/viewing-people-in-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise-account/viewing-people-in-your-enterprise-account.md
deleted file mode 100644
index 15634af8e301..000000000000
--- a/content/github/setting-up-and-managing-your-enterprise-account/viewing-people-in-your-enterprise-account.md
+++ /dev/null
@@ -1,37 +0,0 @@
----
-title: Viewing people in your enterprise account
-intro: 'To audit access to enterprise-owned resources or user license usage, enterprise owners can view every administrator and member of the enterprise account.'
-product: '{% data reusables.gated-features.enterprise-accounts %}'
-redirect_from:
- - /articles/viewing-people-in-your-enterprise-account
-versions:
- free-pro-team: '*'
- enterprise-server: '*'
----
-
-### Viewing enterprise owners and billing managers
-
-You can view enterprise owners and billing managers, as well as a list of pending invitations to become owners and billing managers. You can filter the list of enterprise administrators by role. You can find a specific person by searching for their username or full name.
-
-{% data reusables.enterprise-accounts.access-enterprise %}
-{% data reusables.enterprise-accounts.people-tab %}
-{% data reusables.enterprise-accounts.administrators-tab %}
-1. Optionally, to view a list of pending invitations, click **_NUMBER_ pending**.
- 
-
-### Viewing members and outside collaborators
-
-You can view the number of pending members and outside collaborators. You can filter the list of members by deployment ({% data variables.product.prodname_ghe_cloud %} or {% data variables.product.prodname_ghe_server %}), role, and organization. You can filter the list of outside collaborators by the visibility of the repositories the collaborator has access to. You can find a specific person by searching for their username or display name.
-
-You can view all the {% data variables.product.prodname_ghe_cloud %} organizations and {% data variables.product.prodname_ghe_server %} instances that a member belongs to, and which repositories an outside collaborator has access to, by clicking on the person's name.
-
-{% data reusables.enterprise-accounts.access-enterprise %}
-{% data reusables.enterprise-accounts.people-tab %}
-1. Optionally, to view a list of outside collaborators rather than the list of members, click **Outside collaborators**.
- 
-1. Optionally, to view a list of pending invitations, click **_NUMBER_ pending**.
- 
-
-### Further reading
-
-- "[Roles for an enterprise account](/articles/roles-for-an-enterprise-account)"
diff --git a/content/github/setting-up-and-managing-your-enterprise/about-enterprise-accounts.md b/content/github/setting-up-and-managing-your-enterprise/about-enterprise-accounts.md
new file mode 100644
index 000000000000..bedbb2ace51b
--- /dev/null
+++ b/content/github/setting-up-and-managing-your-enterprise/about-enterprise-accounts.md
@@ -0,0 +1,45 @@
+---
+title: About enterprise accounts
+intro: 'With {% data variables.product.prodname_ghe_cloud %}, you can create an enterprise account to enable collaboration between your organizations, while giving administrators a single point of visibility and management.'
+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: '*'
+---
+
+### About enterprise accounts
+
+An enterprise account allows you to manage multiple {% data variables.product.prodname_dotcom %} organizations and {% data variables.product.prodname_ghe_server %} instances. Your enterprise account must have a handle, like an organization or personal account on {% data variables.product.prodname_dotcom %}. Enterprise administrators can manage settings and preferences, like:
+
+- Member access and management (organization members, outside collaborators)
+- Billing and usage ({% data variables.product.prodname_ghe_server %} instances, user licenses, {% data variables.large_files.product_name_short %} packs)
+- Security (single sign-on, two factor authentication)
+- Requests and support bundle sharing with {% data variables.contact.enterprise_support %}
+
+{% data reusables.enterprise-accounts.enterprise-accounts-billing %}
+
+For more information about the differences between {% data variables.product.prodname_ghe_cloud %} and {% data variables.product.prodname_ghe_server %}, see "[{% data variables.product.prodname_dotcom %}'s products](/articles/githubs-products)." To upgrade to {% data variables.product.prodname_enterprise %} or to get started with an enterprise account, contact {% data variables.contact.contact_enterprise_sales %}.
+
+For more information about member access and management, see "{% if currentVersion == "free-pro-team@latest" %}[Managing users in your enterprise](/github/setting-up-and-managing-your-enterprise/managing-users-in-your-enterprise){% elsif currentVersion == "enterprise-ae@latest" or enterpriseServerVersions contains currentVersion %}[Managing users, organizations, and repositories](/admin/user-management){% endif %}."
+
+For more information about managing enterprise accounts using the GraphQL API, see "[Enterprise accounts](/v4/guides/managing-enterprise-accounts)."
+
+{% if currentVersion == "free-pro-team@latest" %}
+
+### Managing organizations linked to your enterprise account
+
+Organizations are shared accounts where groups of people can collaborate across many projects at once. Owners can manage member access to the organization's data and projects with sophisticated security and administrative features. For more information, see "[About organizations](/articles/about-organizations)."
+
+Enterprise owners can create organizations and link them to the enterprise. After you add organizations to your enterprise account, you can manage and enforce the organizations' policies. Specific enforcement options vary by setting; generally, you can choose to enforce a single policy for every organization in your enterprise account or allow owners to set policy on the organization level.
+
+For more information, see "[Managing organizations in your enterprise account](/articles/managing-organizations-in-your-enterprise-account)" and "[Setting policies for organizations in your enterprise account](/articles/setting-policies-for-organizations-in-your-enterprise-account)."
+
+{% endif %}
+
+### Managing {% data variables.product.prodname_ghe_server %} licenses linked to your enterprise account
+
+{% data reusables.enterprise-accounts.admin-managing-licenses %}
diff --git a/content/github/setting-up-and-managing-your-enterprise-account/adding-organizations-to-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/adding-organizations-to-your-enterprise-account.md
similarity index 94%
rename from content/github/setting-up-and-managing-your-enterprise-account/adding-organizations-to-your-enterprise-account.md
rename to content/github/setting-up-and-managing-your-enterprise/adding-organizations-to-your-enterprise-account.md
index 044a76924f5e..893493f0008c 100644
--- a/content/github/setting-up-and-managing-your-enterprise-account/adding-organizations-to-your-enterprise-account.md
+++ b/content/github/setting-up-and-managing-your-enterprise/adding-organizations-to-your-enterprise-account.md
@@ -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: '*'
---
diff --git a/content/github/setting-up-and-managing-your-enterprise-account/configuring-saml-single-sign-on-and-scim-for-your-enterprise-account-using-okta.md b/content/github/setting-up-and-managing-your-enterprise/configuring-saml-single-sign-on-and-scim-for-your-enterprise-account-using-okta.md
similarity index 94%
rename from content/github/setting-up-and-managing-your-enterprise-account/configuring-saml-single-sign-on-and-scim-for-your-enterprise-account-using-okta.md
rename to content/github/setting-up-and-managing-your-enterprise/configuring-saml-single-sign-on-and-scim-for-your-enterprise-account-using-okta.md
index f92218422e8d..86ee087d2a5f 100644
--- a/content/github/setting-up-and-managing-your-enterprise-account/configuring-saml-single-sign-on-and-scim-for-your-enterprise-account-using-okta.md
+++ b/content/github/setting-up-and-managing-your-enterprise/configuring-saml-single-sign-on-and-scim-for-your-enterprise-account-using-okta.md
@@ -3,7 +3,8 @@ title: Configuring SAML single sign-on and SCIM for your enterprise account usin
intro: 'You can use Security Assertion Markup Language (SAML) single sign-on (SSO) and System for Cross-domain Identity Management (SCIM) with Okta to automatically manage access to your enterprise account on {% data variables.product.product_name %}.'
product: '{% data reusables.gated-features.enterprise-accounts %}'
redirect_from:
- - /github/setting-up-and-managing-your-enterprise-account/configuring-single-sign-on-and-scim-for-your-enterprise-account-using-okta
+ - /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: '*'
---
@@ -14,7 +15,7 @@ versions:
You can control access to your enterprise account in {% data variables.product.product_name %} and other web applications from one central interface by configuring the enterprise account to use SAML SSO and SCIM with Okta, an Identity Provider (IdP).
-SAML SSO controls and secures access to enterprise account resources like organizations, repositories, issues, and pull requests. SCIM automatically adds, manages, and removes members' access to organizations owned by your enterprise account when you make changes in Okta. For more information, see "[Enforcing security settings in your enterprise account](/github/setting-up-and-managing-your-enterprise-account/enforcing-security-settings-in-your-enterprise-account)."
+SAML SSO controls and secures access to enterprise account resources like organizations, repositories, issues, and pull requests. SCIM automatically adds, manages, and removes members' access to organizations owned by your enterprise account when you make changes in Okta. For more information, see "[Enforcing security settings in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-security-settings-in-your-enterprise-account)."
After you enable SCIM, the following provisioning features are available for any users that you assign your {% data variables.product.prodname_ghe_cloud %} application to in Okta.
@@ -55,7 +56,7 @@ After you enable SCIM, the following provisioning features are available for any
1. To the right of the drop-down menu, type `.*.*`.
1. Click **Save**.
{% data reusables.saml.okta-view-setup-instructions %}
-1. Enable SAML for your enterprise account using the information in the setup instructions. For more information, see "[Enforcing security settings in your enterprise account](/github/setting-up-and-managing-your-enterprise-account/enforcing-security-settings-in-your-enterprise-account#enabling-saml-single-sign-on-for-organizations-in-your-enterprise-account)."
+1. Enable SAML for your enterprise account using the information in the setup instructions. For more information, see "[Enforcing security settings in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-security-settings-in-your-enterprise-account#enabling-saml-single-sign-on-for-organizations-in-your-enterprise-account)."
### Creating groups in Okta
@@ -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 %}
diff --git a/content/github/setting-up-and-managing-your-enterprise/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-enterprise-account.md
new file mode 100644
index 000000000000..2bd1d3b7665f
--- /dev/null
+++ b/content/github/setting-up-and-managing-your-enterprise/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-enterprise-account.md
@@ -0,0 +1,21 @@
+---
+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: '*'
+ enterprise-server: '>=2.23'
+---
+
+{% data reusables.actions.about-artifact-log-retention %}
+
+## Setting the retention period for an enterprise
+
+{% data reusables.enterprise_site_admin_settings.access-settings %}
+{% data reusables.enterprise_site_admin_settings.business %}
+{% data reusables.enterprise-accounts.policies-tab %}
+{% data reusables.enterprise-accounts.actions-tab %}
+{% data reusables.github-actions.change-retention-period-for-artifacts-logs %}
diff --git a/content/github/setting-up-and-managing-your-enterprise-account/configuring-webhooks-for-organization-events-in-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/configuring-webhooks-for-organization-events-in-your-enterprise-account.md
similarity index 93%
rename from content/github/setting-up-and-managing-your-enterprise-account/configuring-webhooks-for-organization-events-in-your-enterprise-account.md
rename to content/github/setting-up-and-managing-your-enterprise/configuring-webhooks-for-organization-events-in-your-enterprise-account.md
index a0f7833340bc..9aeb15a046bf 100644
--- a/content/github/setting-up-and-managing-your-enterprise-account/configuring-webhooks-for-organization-events-in-your-enterprise-account.md
+++ b/content/github/setting-up-and-managing-your-enterprise/configuring-webhooks-for-organization-events-in-your-enterprise-account.md
@@ -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: '*'
---
diff --git a/content/github/setting-up-and-managing-your-enterprise-account/enforcing-a-policy-on-dependency-insights-in-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/enforcing-a-policy-on-dependency-insights-in-your-enterprise-account.md
similarity index 92%
rename from content/github/setting-up-and-managing-your-enterprise-account/enforcing-a-policy-on-dependency-insights-in-your-enterprise-account.md
rename to content/github/setting-up-and-managing-your-enterprise/enforcing-a-policy-on-dependency-insights-in-your-enterprise-account.md
index 52526f6a0429..036f99a19831 100644
--- a/content/github/setting-up-and-managing-your-enterprise-account/enforcing-a-policy-on-dependency-insights-in-your-enterprise-account.md
+++ b/content/github/setting-up-and-managing-your-enterprise/enforcing-a-policy-on-dependency-insights-in-your-enterprise-account.md
@@ -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: '*'
---
diff --git a/content/github/setting-up-and-managing-your-enterprise/enforcing-github-actions-policies-in-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/enforcing-github-actions-policies-in-your-enterprise-account.md
new file mode 100644
index 000000000000..7ef386c2ae98
--- /dev/null
+++ b/content/github/setting-up-and-managing-your-enterprise/enforcing-github-actions-policies-in-your-enterprise-account.md
@@ -0,0 +1,49 @@
+---
+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: '*'
+---
+
+### 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.
+
+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.
+
+{% data reusables.actions.actions-use-policy-settings %}
+
+{% data reusables.enterprise-accounts.access-enterprise %}
+{% data reusables.enterprise-accounts.policies-tab %}
+{% data reusables.enterprise-accounts.actions-tab %}
+{% data reusables.actions.enterprise-actions-permissions %}
+1. Click **Save**.
+
+### Allowing specific actions to run
+
+{% data reusables.actions.allow-specific-actions-intro %}
+
+{% data reusables.enterprise-accounts.access-enterprise %}
+{% data reusables.enterprise-accounts.policies-tab %}
+{% data reusables.enterprise-accounts.actions-tab %}
+1. Under **Policies**, select **Allow select actions** and add your required actions to the list.
+ 
+
+### Enabling workflows for private repository forks
+
+{% data reusables.github-actions.private-repository-forks-overview %}
+
+#### Configuring the private fork policy for your enterprise account
+
+{% data reusables.enterprise-accounts.access-enterprise %}
+{% data reusables.enterprise-accounts.policies-tab %}
+{% data reusables.enterprise-accounts.actions-tab %}
+{% data reusables.github-actions.private-repository-forks-configure %}
diff --git a/content/github/setting-up-and-managing-your-enterprise-account/enforcing-project-board-policies-in-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/enforcing-project-board-policies-in-your-enterprise-account.md
similarity index 95%
rename from content/github/setting-up-and-managing-your-enterprise-account/enforcing-project-board-policies-in-your-enterprise-account.md
rename to content/github/setting-up-and-managing-your-enterprise/enforcing-project-board-policies-in-your-enterprise-account.md
index 382e0c0a2922..2b1f5bec092d 100644
--- a/content/github/setting-up-and-managing-your-enterprise-account/enforcing-project-board-policies-in-your-enterprise-account.md
+++ b/content/github/setting-up-and-managing-your-enterprise/enforcing-project-board-policies-in-your-enterprise-account.md
@@ -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: '*'
---
diff --git a/content/github/setting-up-and-managing-your-enterprise-account/enforcing-repository-management-policies-in-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/enforcing-repository-management-policies-in-your-enterprise-account.md
similarity index 97%
rename from content/github/setting-up-and-managing-your-enterprise-account/enforcing-repository-management-policies-in-your-enterprise-account.md
rename to content/github/setting-up-and-managing-your-enterprise/enforcing-repository-management-policies-in-your-enterprise-account.md
index 1dae91bd4651..f5e9e4c08272 100644
--- a/content/github/setting-up-and-managing-your-enterprise-account/enforcing-repository-management-policies-in-your-enterprise-account.md
+++ b/content/github/setting-up-and-managing-your-enterprise/enforcing-repository-management-policies-in-your-enterprise-account.md
@@ -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.
### Enforcing a policy on changing repository visibility
diff --git a/content/github/setting-up-and-managing-your-enterprise-account/enforcing-security-settings-in-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/enforcing-security-settings-in-your-enterprise-account.md
similarity index 97%
rename from content/github/setting-up-and-managing-your-enterprise-account/enforcing-security-settings-in-your-enterprise-account.md
rename to content/github/setting-up-and-managing-your-enterprise/enforcing-security-settings-in-your-enterprise-account.md
index 1ebfe339c816..ca7c927f26e2 100644
--- a/content/github/setting-up-and-managing-your-enterprise-account/enforcing-security-settings-in-your-enterprise-account.md
+++ b/content/github/setting-up-and-managing-your-enterprise/enforcing-security-settings-in-your-enterprise-account.md
@@ -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: '*'
---
@@ -96,7 +97,7 @@ You can also configure allowed IP addresses for an individual organization. For
Enterprise owners can enable SAML SSO and centralized authentication through a SAML IdP across all organizations owned by an enterprise account. After you enable SAML SSO for your enterprise account, SAML SSO is enabled by default for all organizations owned by your enterprise account. All members will be required to authenticate using SAML SSO to gain access to the organizations where they are a member, and enterprise owners will be required to authenticate using SAML SSO when accessing an enterprise account.
-{% data reusables.saml.about-saml-access-enterprise-account %} For more information, see "[Viewing and managing a user's 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)."
+{% data reusables.saml.about-saml-access-enterprise-account %} For more information, see "[Viewing and managing a user's SAML access to your enterprise account](/github/setting-up-and-managing-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise-account)."
{% data reusables.saml.saml-supported-idps %}
@@ -108,7 +109,7 @@ Enterprise owners can enable SAML SSO and centralized authentication through a S
{% endnote %}
-For more detailed information about how to enable SAML using Okta, see "[Configuring SAML 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).
+For more detailed information about how to enable SAML using Okta, see "[Configuring SAML single sign-on and SCIM for your enterprise account using Okta](/github/setting-up-and-managing-your-enterprise/configuring-saml-single-sign-on-and-scim-for-your-enterprise-account-using-okta).
{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.settings-tab %}
@@ -148,9 +149,9 @@ For each SCIM call and, if you enable SAML deprovisioning, each SAML assertion,
- If the user is not a member of an IdP group that corresponds to an organization owned by your enterprise account, and the user is currently a member of that organization, remove the user from the organization.
-If deprovisioning removes the last remaining owner from an organization, the organization will become unowned. Enterprise owners can assume ownership of unowned organizations. For more information, see "[Managing unowned organizations in your enterprise account](/github/setting-up-and-managing-your-enterprise-account/managing-unowned-organizations-in-your-enterprise-account)."
+If deprovisioning removes the last remaining owner from an organization, the organization will become unowned. Enterprise owners can assume ownership of unowned organizations. For more information, see "[Managing unowned organizations in your enterprise account](/github/setting-up-and-managing-your-enterprise/managing-unowned-organizations-in-your-enterprise-account)."
-To enable user provisioning for your enterprise account using Okta, see "[Configuring SAML 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)."
+To enable user provisioning for your enterprise account using Okta, see "[Configuring SAML single sign-on and SCIM for your enterprise account using Okta](/github/setting-up-and-managing-your-enterprise/configuring-saml-single-sign-on-and-scim-for-your-enterprise-account-using-okta)."
### Managing team synchronization for organizations in your enterprise account
diff --git a/content/github/setting-up-and-managing-your-enterprise-account/enforcing-team-policies-in-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/enforcing-team-policies-in-your-enterprise-account.md
similarity index 93%
rename from content/github/setting-up-and-managing-your-enterprise-account/enforcing-team-policies-in-your-enterprise-account.md
rename to content/github/setting-up-and-managing-your-enterprise/enforcing-team-policies-in-your-enterprise-account.md
index 008d1a211536..6d95d38f9f24 100644
--- a/content/github/setting-up-and-managing-your-enterprise-account/enforcing-team-policies-in-your-enterprise-account.md
+++ b/content/github/setting-up-and-managing-your-enterprise/enforcing-team-policies-in-your-enterprise-account.md
@@ -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: '*'
---
diff --git a/content/github/setting-up-and-managing-your-enterprise-account/index.md b/content/github/setting-up-and-managing-your-enterprise/index.md
similarity index 82%
rename from content/github/setting-up-and-managing-your-enterprise-account/index.md
rename to content/github/setting-up-and-managing-your-enterprise/index.md
index 647d15530f21..54e9cb224115 100644
--- a/content/github/setting-up-and-managing-your-enterprise-account/index.md
+++ b/content/github/setting-up-and-managing-your-enterprise/index.md
@@ -1,12 +1,14 @@
---
-title: Setting up and managing your enterprise account
-shortTitle: Your enterprise account
+title: Setting up and managing your enterprise
+shortTitle: Your enterprise
product: '{% data reusables.gated-features.enterprise-accounts %}'
redirect_from:
+ - /github/setting-up-and-managing-your-enterprise-account
- /categories/setting-up-and-managing-your-enterprise-account
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
@@ -16,11 +18,11 @@ versions:
{% link_in_list /about-enterprise-accounts %}
{% link_in_list /viewing-the-subscription-and-usage-for-your-enterprise-account %}
{% link_in_list /managing-licenses-for-visual-studio-subscription-with-github-enterprise %}
-{% topic_link_in_list /managing-users-in-your-enterprise-account %}
- {% link_in_list /roles-for-an-enterprise-account %}
- {% link_in_list /inviting-people-to-manage-your-enterprise-account %}
- {% link_in_list /viewing-people-in-your-enterprise-account %}
- {% link_in_list /viewing-and-managing-a-users-saml-access-to-your-enterprise-account %}
+{% topic_link_in_list /managing-users-in-your-enterprise %}
+ {% link_in_list /roles-in-an-enterprise %}
+ {% link_in_list /inviting-people-to-manage-your-enterprise %}
+ {% link_in_list /viewing-people-in-your-enterprise %}
+ {% link_in_list /viewing-and-managing-a-users-saml-access-to-your-enterprise %}
{% topic_link_in_list /managing-organizations-in-your-enterprise-account %}
{% link_in_list /adding-organizations-to-your-enterprise-account %}
{% link_in_list /managing-unowned-organizations-in-your-enterprise-account %}
diff --git a/content/github/setting-up-and-managing-your-enterprise-account/inviting-people-to-manage-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/inviting-people-to-manage-your-enterprise.md
similarity index 91%
rename from content/github/setting-up-and-managing-your-enterprise-account/inviting-people-to-manage-your-enterprise-account.md
rename to content/github/setting-up-and-managing-your-enterprise/inviting-people-to-manage-your-enterprise.md
index 8258e32fc338..5f847dd348db 100644
--- a/content/github/setting-up-and-managing-your-enterprise-account/inviting-people-to-manage-your-enterprise-account.md
+++ b/content/github/setting-up-and-managing-your-enterprise/inviting-people-to-manage-your-enterprise.md
@@ -1,8 +1,9 @@
---
-title: Inviting people to manage your enterprise account
+title: Inviting people to manage your enterprise
intro: You can invite people to become enterprise owners or billing managers in your enterprise account. You can also remove enterprise owners or billing managers who no longer need access to the enterprise account.
product: '{% data reusables.gated-features.enterprise-accounts %}'
redirect_from:
+ - /github/setting-up-and-managing-your-enterprise-account/inviting-people-to-manage-your-enterprise-account
- /articles/inviting-people-to-collaborate-in-your-business-account/
- /articles/inviting-people-to-manage-your-enterprise-account
versions:
@@ -12,7 +13,7 @@ versions:
### About inviting people to manage your enterprise account
-{% data reusables.enterprise-accounts.enterprise-administrators %} For more information, see "[Roles for an enterprise account](/articles/roles-for-an-enterprise-account)."
+{% data reusables.enterprise-accounts.enterprise-administrators %} For more information, see "[Roles in an enterprise](/github/setting-up-and-managing-your-enterprise/roles-in-an-enterprise).
{% tip %}
@@ -47,7 +48,3 @@ Only enterprise owners can remove other enterprise administrators from the enter
{% data reusables.enterprise-accounts.people-tab %}
3. Next to the username of the person you'd like to remove, click {% octicon "gear" aria-label="The Settings gear" %}, then click **Remove owner** or **Remove billing manager**.
-
-### Further reading
-
-- "[Roles for an enterprise account](/articles/roles-for-an-enterprise-account)"
diff --git a/content/github/setting-up-and-managing-your-enterprise/managing-licenses-for-visual-studio-subscription-with-github-enterprise.md b/content/github/setting-up-and-managing-your-enterprise/managing-licenses-for-visual-studio-subscription-with-github-enterprise.md
new file mode 100644
index 000000000000..8e06d2793439
--- /dev/null
+++ b/content/github/setting-up-and-managing-your-enterprise/managing-licenses-for-visual-studio-subscription-with-github-enterprise.md
@@ -0,0 +1,43 @@
+---
+title: Managing licenses for Visual Studio subscription with GitHub Enterprise
+intro: 'You can manage {% data variables.product.prodname_enterprise %} licensing for {% data variables.product.prodname_vss_ghe %}.'
+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 %}
+
+{% 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.
+
+After you assign a license for {% data variables.product.prodname_vss_ghe %} to a subscriber, the subscriber will use the {% data variables.product.prodname_enterprise %} portion of the license by joining an organization in your enterprise account with a user account on {% data variables.product.prodname_dotcom_the_website %}.
+
+For more information about {% data variables.product.prodname_enterprise %}, see "[{% data variables.product.company_short %}'s products](/github/getting-started-with-github/githubs-products#github-enterprise)." For more information about accounts on {% data variables.product.prodname_dotcom_the_website %}, see "[Types of {% data variables.product.prodname_dotcom %} accounts](/github/getting-started-with-github/types-of-github-accounts)."
+
+### Prerequisites
+
+1. After you buy {% data variables.product.prodname_vss_ghe %}, contact {% data variables.contact.contact_enterprise_sales %} and mention "{% data variables.product.prodname_vss_ghe %}." You'll work with the Sales team to create an enterprise account on {% data variables.product.prodname_dotcom_the_website %}. If you already have an enterprise account on {% data variables.product.prodname_dotcom_the_website %}, or if you're not sure, please tell our Sales team.
+
+2. Assign licenses for {% data variables.product.prodname_vss_ghe %} to subscribers in {% data variables.product.prodname_vss_admin_portal_with_url %}. For more information about assigning licenses, see [Manage {% data variables.product.prodname_vs %} subscriptions with {% data variables.product.prodname_enterprise %}](https://docs.microsoft.com/visualstudio/subscriptions/assign-github) in the Microsoft Docs.
+
+3. On {% data variables.product.prodname_dotcom_the_website %}, create at least one organization owned by your enterprise account. For more information, see "[Adding organizations to your enterprise account](/github/setting-up-and-managing-your-enterprise/adding-organizations-to-your-enterprise-account)."
+
+4. The subscriber must create a user account on {% data variables.product.prodname_dotcom_the_website %}, and the email address for the account must be the same email address as the email address in the {% data variables.product.prodname_vs %} portal. For more information, see "[Signing up for {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github/signing-up-for-github)" and "[Managing email preferences](/github/setting-up-and-managing-your-github-user-account/managing-email-preferences)."
+
+### Inviting a subscriber to use {% data variables.product.prodname_enterprise %}
+
+To use the {% data variables.product.prodname_enterprise %} portion of the license, the subscriber must join an organization owned by your enterprise account on {% data variables.product.prodname_dotcom_the_website %}. Organization owners can invite new members to an organization. For more information, see "[Inviting users to join your organization](/github/setting-up-and-managing-organizations-and-teams/inviting-users-to-join-your-organization)."
+
+### Viewing {% data variables.product.prodname_enterprise %} licensing
+
+After assigning a license for {% data variables.product.prodname_vss_ghe %} in {% data variables.product.prodname_vss_admin_portal_with_url %}, you can view the number of {% data variables.product.prodname_enterprise %} licenses available to your enterprise account. For more information, see "[Viewing the subscription and usage for your enterprise account](/github/setting-up-and-managing-your-enterprise/viewing-the-subscription-and-usage-for-your-enterprise-account)."
+
+You can also see pending {% data variables.product.prodname_enterprise %} invitations to subscribers in {% data variables.product.prodname_vss_admin_portal_with_url %}. The list of pending invitations includes subscribers who are not yet members of at least one organization in your enterprise account. For more information, see "[Viewing people in your enterprise](/github/setting-up-and-managing-your-enterprise/viewing-people-in-your-enterprise#viewing-members-and-outside-collaborators)."
+
+### Further reading
+
+- [Introducing Visual Studio subscriptions with GitHub Enterprise](https://docs.microsoft.com/visualstudio/subscriptions/access-github) in the Microsoft Docs
diff --git a/content/github/setting-up-and-managing-your-enterprise/managing-organizations-in-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/managing-organizations-in-your-enterprise-account.md
new file mode 100644
index 000000000000..9045814fc600
--- /dev/null
+++ b/content/github/setting-up-and-managing-your-enterprise/managing-organizations-in-your-enterprise-account.md
@@ -0,0 +1,10 @@
+---
+title: Managing organizations in your enterprise account
+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: '*'
+---
diff --git a/content/github/setting-up-and-managing-your-enterprise-account/managing-unowned-organizations-in-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/managing-unowned-organizations-in-your-enterprise-account.md
similarity index 79%
rename from content/github/setting-up-and-managing-your-enterprise-account/managing-unowned-organizations-in-your-enterprise-account.md
rename to content/github/setting-up-and-managing-your-enterprise/managing-unowned-organizations-in-your-enterprise-account.md
index b25780dad298..feb1214b1059 100644
--- a/content/github/setting-up-and-managing-your-enterprise-account/managing-unowned-organizations-in-your-enterprise-account.md
+++ b/content/github/setting-up-and-managing-your-enterprise/managing-unowned-organizations-in-your-enterprise-account.md
@@ -3,11 +3,13 @@ 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: '*'
---
-If you enable user deprovisioning to manage organization membership in your enterprise account, you could end up with an organization that has no organization owners. For more information, see "[Enforcing security settings in your enterprise account](/github/setting-up-and-managing-your-enterprise-account/enforcing-security-settings-in-your-enterprise-account#managing-user-provisioning-for-organizations-in-your-enterprise-account)."
+If you enable user deprovisioning to manage organization membership in your enterprise account, you could end up with an organization that has no organization owners. For more information, see "[Enforcing security settings in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-security-settings-in-your-enterprise-account#managing-user-provisioning-for-organizations-in-your-enterprise-account)."
{% data reusables.enterprise-accounts.access-enterprise %}
2. To the right of the search field, click **X unowned**.
diff --git a/content/github/setting-up-and-managing-your-enterprise/managing-users-in-your-enterprise.md b/content/github/setting-up-and-managing-your-enterprise/managing-users-in-your-enterprise.md
new file mode 100644
index 000000000000..6ccf673df352
--- /dev/null
+++ b/content/github/setting-up-and-managing-your-enterprise/managing-users-in-your-enterprise.md
@@ -0,0 +1,14 @@
+---
+title: Managing users in your enterprise
+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:
+ free-pro-team: '*'
+ enterprise-server: '*'
+ github-ae: '*'
+---
diff --git a/content/github/setting-up-and-managing-your-enterprise-account/managing-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/managing-your-enterprise-account.md
similarity index 100%
rename from content/github/setting-up-and-managing-your-enterprise-account/managing-your-enterprise-account.md
rename to content/github/setting-up-and-managing-your-enterprise/managing-your-enterprise-account.md
diff --git a/content/github/setting-up-and-managing-your-enterprise/roles-in-an-enterprise.md b/content/github/setting-up-and-managing-your-enterprise/roles-in-an-enterprise.md
new file mode 100644
index 000000000000..a6d7bee5c517
--- /dev/null
+++ b/content/github/setting-up-and-managing-your-enterprise/roles-in-an-enterprise.md
@@ -0,0 +1,61 @@
+---
+title: Roles in an enterprise
+intro: 'Everyone in an enterprise is a member of the enterprise. To control access to your enterprise''s settings and data, you can assign different roles to members of your enterprise.'
+product: '{% data reusables.gated-features.enterprise-accounts %}'
+redirect_from:
+ - /github/setting-up-and-managing-your-enterprise-account/roles-for-an-enterprise-account
+ - /articles/permission-levels-for-a-business-account/
+ - /articles/roles-for-an-enterprise-account
+versions:
+ free-pro-team: '*'
+ enterprise-server: '*'
+ github-ae: '*'
+---
+
+### About roles in an enterprise
+
+Everyone in an enterprise is a member of the enterprise. You can also assign administrative roles to members of your enterprise. Each administrator role maps to business functions and provides permissions to do specific tasks within the enterprise.
+
+{% data reusables.enterprise-accounts.enterprise-administrators %}
+
+For more information about adding people to your enterprise, see "{% if currentVersion == "free-pro-team@latest" %}[Inviting people to manage your enterprise](/github/setting-up-and-managing-your-enterprise/inviting-people-to-manage-your-enterprise){% else %}[Authentication](/admin/authentication){% endif %}".
+
+### Enterprise owner
+
+Enterprise owners have complete control over the enterprise and can take every action, including:
+- Managing administrators
+- {% if currentVersion == "free-pro-team@latest" %}Adding and removing {% elsif currentVersion == "github-ae@latest" %}Managing{% endif %} organizations {% if currentVersion == "free-pro-team@latest" %}to and from {% elsif currentVersion == "github-ae@latest" %} in{% endif %} the enterprise
+- Managing enterprise settings
+- Enforcing policy across organizations
+{% if currentVersion == "free-pro-team@latest" %}- Managing billing settings{% endif %}
+
+Enterprise owners cannot access organization settings or content unless they are made an organization owner or given direct access to an organization-owned repository. Similarly, owners of organizations in your enterprise do not have access to the enterprise itself unless you make them enterprise owners.
+
+You can add as many enterprise owners as you'd like to your enterprise. {% if currentVersion == "free-pro-team@latest" %}Enterprise owners must have a personal account on {% data variables.product.prodname_dotcom %}.{% endif %} As a best practice, we recommend making only a few people in your company enterprise owners, to reduce the risk to your business.
+
+### Enterprise members
+
+Members of organizations owned by your enterprise are also automatically members of the enterprise. Members can collaborate in organizations and may be organization owners, but members cannot access or configure enterprise settings{% if currentVersion == "free-pro-team@latest" %}, including billing settings{% endif %}.
+
+People in your enterprise may have different levels of access to the various organizations owned by your enterprise and to repositories within those organizations. You can view the resources that each person has access to. For more information, see "[Viewing people in your enterprise](/github/setting-up-and-managing-your-enterprise/viewing-people-in-your-enterprise)."
+
+For more information about organization-level permissions, see "[Permission levels for an organization](/articles/permission-levels-for-an-organization)."
+
+People with outside collaborator access to repositories owned by your organization are also listed in your enterprise's People tab, but are not enterprise members and do not have any access to the enterprise. For more information about outside collaborators, see "[Permission levels for an organization](/articles/permission-levels-for-an-organization#outside-collaborators)."
+
+{% if currentVersion == "free-pro-team@latest" %}
+
+### Billing manager
+
+Billing managers only have access to your enterprise's billing settings. Billing managers for your enterprise can:
+- View and manage user licenses, {% data variables.large_files.product_name_short %} packs and other billing settings
+- View a list of billing managers
+- Add or remove other billing managers
+
+Billing managers do not have access to organizations or repositories in your enterprise, and cannot add or remove enterprise owners. Billing managers must have a personal account on {% data variables.product.prodname_dotcom %}.
+
+### Further reading
+
+- "[About enterprise accounts](/articles/about-enterprise-accounts)"
+
+{% endif %}
diff --git a/content/github/setting-up-and-managing-your-enterprise/setting-policies-for-organizations-in-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/setting-policies-for-organizations-in-your-enterprise-account.md
new file mode 100644
index 000000000000..27d125ccd8b9
--- /dev/null
+++ b/content/github/setting-up-and-managing-your-enterprise/setting-policies-for-organizations-in-your-enterprise-account.md
@@ -0,0 +1,10 @@
+---
+title: Setting policies for organizations in your enterprise account
+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: '*'
+---
diff --git a/content/github/setting-up-and-managing-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise.md b/content/github/setting-up-and-managing-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise.md
new file mode 100644
index 000000000000..560bdf10af60
--- /dev/null
+++ b/content/github/setting-up-and-managing-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise.md
@@ -0,0 +1,52 @@
+---
+title: Viewing and managing a user's SAML access to your enterprise
+intro: 'You can view and revoke an enterprise member''s linked identity, active sessions, and authorized credentials.'
+permissions: Enterprise owners can view and manage a member's SAML access to an organization.
+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: '*'
+---
+
+### About SAML access to your enterprise account
+
+When you enable SAML single sign-on for your enterprise account, each enterprise member can link their external identity on your identity provider (IdP) to their existing {% data variables.product.product_name %} account. {% data reusables.saml.about-saml-access-enterprise-account %}
+
+### Viewing and revoking a linked identity
+
+{% data reusables.saml.about-linked-identities %}
+
+{% data reusables.enterprise-accounts.access-enterprise %}
+{% data reusables.enterprise-accounts.people-tab %}
+{% data reusables.saml.click-person-revoke-identity %}
+{% data reusables.saml.saml-identity-linked %}
+{% data reusables.saml.view-sso-identity %}
+{% data reusables.saml.revoke-sso-identity %}
+{% data reusables.saml.confirm-revoke-identity %}
+
+### Viewing and revoking an active SAML session
+
+{% data reusables.enterprise-accounts.access-enterprise %}
+{% data reusables.enterprise-accounts.people-tab %}
+{% data reusables.saml.click-person-revoke-session %}
+{% data reusables.saml.saml-identity-linked %}
+{% data reusables.saml.view-saml-sessions %}
+{% data reusables.saml.revoke-saml-session %}
+
+### Viewing and revoking authorized credentials
+
+{% data reusables.saml.about-authorized-credentials %}
+
+{% data reusables.enterprise-accounts.access-enterprise %}
+{% data reusables.enterprise-accounts.people-tab %}
+{% data reusables.saml.click-person-revoke-credentials %}
+{% data reusables.saml.saml-identity-linked %}
+{% data reusables.saml.view-authorized-credentials %}
+{% data reusables.saml.revoke-authorized-credentials %}
+{% data reusables.saml.confirm-revoke-credentials %}
+
+### Further reading
+
+- "[Viewing and managing a member's SAML access to your organization](/github/setting-up-and-managing-organizations-and-teams/viewing-and-managing-a-members-saml-access-to-your-organization)"
diff --git a/content/github/setting-up-and-managing-your-enterprise/viewing-people-in-your-enterprise.md b/content/github/setting-up-and-managing-your-enterprise/viewing-people-in-your-enterprise.md
new file mode 100644
index 000000000000..ba548c7c1de7
--- /dev/null
+++ b/content/github/setting-up-and-managing-your-enterprise/viewing-people-in-your-enterprise.md
@@ -0,0 +1,39 @@
+---
+title: Viewing people in your enterprise
+intro: 'To audit access to enterprise-owned resources or user license usage, enterprise owners can view every administrator and member of the enterprise.'
+product: '{% data reusables.gated-features.enterprise-accounts %}'
+redirect_from:
+ - /github/setting-up-and-managing-your-enterprise-account/viewing-people-in-your-enterprise-account
+ - /articles/viewing-people-in-your-enterprise-account
+versions:
+ free-pro-team: '*'
+ enterprise-server: '*'
+ github-ae: '*'
+---
+
+### Viewing enterprise owners{% if currentVersion == "free-pro-team@latest" %} and billing managers{% endif %}
+
+You can view enterprise owners {% if currentVersion == "free-pro-team@latest" %} and billing managers, {% endif %}as well as a list of pending invitations to become owners{% if currentVersion == "free-pro-team@latest" %} and billing managers. You can filter the list of enterprise administrators by role{% endif %}. You can find a specific person by searching for their username or full name.
+
+{% data reusables.enterprise-accounts.access-enterprise %}
+{% data reusables.enterprise-accounts.people-tab %}
+{% data reusables.enterprise-accounts.administrators-tab %}
+{% if currentVersion == "free-pro-team@latest" %}1. Optionally, to view a list of pending invitations, click **_NUMBER_ pending**.
+ {% endif %}
+
+### Viewing members and outside collaborators
+
+You can view the number of pending members and outside collaborators. You can filter the list of members by {% if currentVersion == "free-pro-team@latest" %}deployment ({% data variables.product.prodname_ghe_cloud %} or {% data variables.product.prodname_ghe_server %}),{% endif %}role {% if currentVersion == "free-pro-team@latest" %}, and{% elsif currentVersion == "github-ae@latest" %}or {% endif %}organization. You can filter the list of outside collaborators by the visibility of the repositories the collaborator has access to. You can find a specific person by searching for their username or display name.
+
+You can view {% if currentVersion == "free-pro-team@latest" %}all the {% data variables.product.prodname_ghe_cloud %} organizations and {% data variables.product.prodname_ghe_server %} instances that a member belongs to, and {% endif %}which repositories an outside collaborator has access to{% if currentVersion == "free-pro-team@latest" %}, {% endif %} by clicking on the person's name.
+
+{% data reusables.enterprise-accounts.access-enterprise %}
+{% data reusables.enterprise-accounts.people-tab %}
+1. Optionally, to view a list of outside collaborators rather than the list of members, click **Outside collaborators**.
+ 
+{% if currentVersion == "free-pro-team@latest" %}1. Optionally, to view a list of pending invitations, click **_NUMBER_ pending**.
+ {% endif %}
+
+### Further reading
+
+- "[Roles in an enterprise](/github/setting-up-and-managing-your-enterprise/roles-in-an-enterprise)"
diff --git a/content/github/setting-up-and-managing-your-enterprise/viewing-the-audit-logs-for-organizations-in-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/viewing-the-audit-logs-for-organizations-in-your-enterprise-account.md
new file mode 100644
index 000000000000..b63394ccd3d8
--- /dev/null
+++ b/content/github/setting-up-and-managing-your-enterprise/viewing-the-audit-logs-for-organizations-in-your-enterprise-account.md
@@ -0,0 +1,26 @@
+---
+title: Viewing the audit logs for organizations in your enterprise account
+intro: Enterprise owners can view aggregated actions from all of the organizations owned by an enterprise account in its audit log.
+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: '*'
+---
+
+Each audit log entry shows applicable information about an event, such as:
+
+- The organization an action was performed in
+- The user who performed the action
+- Which repository an action was performed in
+- The action that was performed
+- Which country the action took place in
+- The date and time the action occurred
+
+You can search the audit log for specific events and export audit log data. For more information on searching the audit log and on specific organization events, see "[Reviewing the audit log for your organization](/articles/reviewing-the-audit-log-for-your-organization)."
+
+{% data reusables.enterprise-accounts.access-enterprise %}
+{% data reusables.enterprise-accounts.settings-tab %}
+{% data reusables.enterprise-accounts.audit-log-tab %}
diff --git a/content/github/setting-up-and-managing-your-enterprise-account/viewing-the-subscription-and-usage-for-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/viewing-the-subscription-and-usage-for-your-enterprise-account.md
similarity index 84%
rename from content/github/setting-up-and-managing-your-enterprise-account/viewing-the-subscription-and-usage-for-your-enterprise-account.md
rename to content/github/setting-up-and-managing-your-enterprise/viewing-the-subscription-and-usage-for-your-enterprise-account.md
index a439d17caeeb..6a6798a5cd8c 100644
--- a/content/github/setting-up-and-managing-your-enterprise-account/viewing-the-subscription-and-usage-for-your-enterprise-account.md
+++ b/content/github/setting-up-and-managing-your-enterprise/viewing-the-subscription-and-usage-for-your-enterprise-account.md
@@ -2,8 +2,9 @@
title: Viewing the subscription and usage for your enterprise account
intro: 'You can view the current subscription, license usage, invoices, payment history, and other billing information for your enterprise account.'
product: '{% data reusables.gated-features.enterprise-accounts %}'
-permissions: 'Enterprise owners and billing managers can access and manage all billing settings for enterprise accounts. For more information about managing billing managers, see "[Inviting people to manage your enterprise account](/articles/inviting-people-to-manage-your-enterprise-account)."'
+permissions: 'Enterprise owners and billing managers can access and manage all billing settings for enterprise accounts.'
redirect_from:
+ - /github/setting-up-and-managing-your-enterprise-account/viewing-the-subscription-and-usage-for-your-enterprise-account
- /articles/viewing-the-subscription-and-usage-for-your-enterprise-account
versions:
free-pro-team: '*'
@@ -14,6 +15,8 @@ versions:
Enterprise accounts are currently available to {% data variables.product.prodname_enterprise %} customers paying by invoice. Billing for all of the organizations and {% data variables.product.prodname_ghe_server %} instances connected to your enterprise account are aggregated into a single bill charge for all of your paid {% data variables.product.prodname_dotcom_the_website %} services (including paid licenses in organizations, {% data variables.large_files.product_name_long %} data packs, and subscriptions for {% data variables.product.prodname_marketplace %} apps).
+For more information about managing billing managers, see "[Inviting people to manage your enterprise](/github/setting-up-and-managing-your-enterprise/inviting-people-to-manage-your-enterprise)."
+
### Viewing the subscription and usage for your enterprise account
{% data reusables.enterprise-accounts.access-enterprise %}
diff --git a/content/github/setting-up-and-managing-your-github-profile/about-your-organizations-profile.md b/content/github/setting-up-and-managing-your-github-profile/about-your-organizations-profile.md
index 67c9c114f191..d5b5bcbbf26a 100644
--- a/content/github/setting-up-and-managing-your-github-profile/about-your-organizations-profile.md
+++ b/content/github/setting-up-and-managing-your-github-profile/about-your-organizations-profile.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
You can optionally choose to add a description, location, website, and email address for your organization, and pin important repositories to the top of the page.
diff --git a/content/github/setting-up-and-managing-your-github-profile/about-your-profile.md b/content/github/setting-up-and-managing-your-github-profile/about-your-profile.md
index e3fdb6223a22..308f7ed6ca8a 100644
--- a/content/github/setting-up-and-managing-your-github-profile/about-your-profile.md
+++ b/content/github/setting-up-and-managing-your-github-profile/about-your-profile.md
@@ -8,11 +8,12 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
You can add personal information about yourself in your bio, like previous places you've worked, projects you've contributed to, or interests you have that other people may like to know about. For more information, see "[Adding a bio to your profile](/articles/personalizing-your-profile/#adding-a-bio-to-your-profile)."
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}
{% data reusables.profile.profile-readme %}
diff --git a/content/github/setting-up-and-managing-your-github-profile/customizing-your-profile.md b/content/github/setting-up-and-managing-your-github-profile/customizing-your-profile.md
index 9f00c450b6f1..6a1a2d651a5b 100644
--- a/content/github/setting-up-and-managing-your-github-profile/customizing-your-profile.md
+++ b/content/github/setting-up-and-managing-your-github-profile/customizing-your-profile.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/setting-up-and-managing-your-github-profile/index.md b/content/github/setting-up-and-managing-your-github-profile/index.md
index 1d4f8bc8e85e..b6ef2bc55529 100644
--- a/content/github/setting-up-and-managing-your-github-profile/index.md
+++ b/content/github/setting-up-and-managing-your-github-profile/index.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile.md b/content/github/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile.md
index 54b894dfc3c6..e12a79ddba9c 100644
--- a/content/github/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile.md
+++ b/content/github/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/setting-up-and-managing-your-github-profile/managing-your-profile-readme.md b/content/github/setting-up-and-managing-your-github-profile/managing-your-profile-readme.md
index 77af5575d8fb..193f9c09f15d 100644
--- a/content/github/setting-up-and-managing-your-github-profile/managing-your-profile-readme.md
+++ b/content/github/setting-up-and-managing-your-github-profile/managing-your-profile-readme.md
@@ -4,6 +4,7 @@ intro: 'You can add a README to your {% data variables.product.prodname_dotcom %
versions:
free-pro-team: '*'
enterprise-server: '>=2.22'
+ github-ae: '*'
---
### About your profile README
diff --git a/content/github/setting-up-and-managing-your-github-profile/personalizing-your-profile.md b/content/github/setting-up-and-managing-your-github-profile/personalizing-your-profile.md
index 168e6472b4a0..d315a329baaf 100644
--- a/content/github/setting-up-and-managing-your-github-profile/personalizing-your-profile.md
+++ b/content/github/setting-up-and-managing-your-github-profile/personalizing-your-profile.md
@@ -11,6 +11,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Changing your profile picture
@@ -55,7 +56,7 @@ You can change the name that is displayed on your profile. This name may also be
Add a bio to your profile to share information about yourself with other {% data variables.product.product_name %} users. With the help of [@mentions](/articles/basic-writing-and-formatting-syntax) and emoji, you can include information about where you currently or have previously worked, what type of work you do, or even what kind of coffee you drink.
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}
For a longer-form and more prominent way of displaying customized information about yourself, you can also use a profile README. For more information on the profile README, see "[Managing your profile README](/github/setting-up-and-managing-your-github-profile/managing-your-profile-readme)."
diff --git a/content/github/setting-up-and-managing-your-github-profile/pinning-items-to-your-profile.md b/content/github/setting-up-and-managing-your-github-profile/pinning-items-to-your-profile.md
index d9f24592fa98..136f708e5683 100644
--- a/content/github/setting-up-and-managing-your-github-profile/pinning-items-to-your-profile.md
+++ b/content/github/setting-up-and-managing-your-github-profile/pinning-items-to-your-profile.md
@@ -1,12 +1,13 @@
---
title: Pinning items to your profile
-intro: 'You can pin {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.16" %}gists and {% endif %}repositories to your profile so other people can quickly see your best work.'
+intro: 'You can pin gists and repositories to your profile so other people can quickly see your best work.'
redirect_from:
- /articles/pinning-repositories-to-your-profile/
- /articles/pinning-items-to-your-profile
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
You can pin a public repository if you own the repository or you've made contributions to the repository. Commits to forks don't count as contributions, so you can't pin a fork that you don't own. For more information, see "[Why are my contributions not showing up on my profile?](/articles/why-are-my-contributions-not-showing-up-on-my-profile)"
diff --git a/content/github/setting-up-and-managing-your-github-profile/publicizing-or-hiding-your-private-contributions-on-your-profile.md b/content/github/setting-up-and-managing-your-github-profile/publicizing-or-hiding-your-private-contributions-on-your-profile.md
index ed167f98ec63..028756d4e8a4 100644
--- a/content/github/setting-up-and-managing-your-github-profile/publicizing-or-hiding-your-private-contributions-on-your-profile.md
+++ b/content/github/setting-up-and-managing-your-github-profile/publicizing-or-hiding-your-private-contributions-on-your-profile.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
If you publicize your private contributions, people without access to the private repositories you work in won't be able to see the details of your private contributions. Instead, they'll see the number of private contributions you made on any given day. Your public contributions will include detailed information. For more information, see "[Viewing contributions on your profile page](/articles/viewing-contributions-on-your-profile-page)".
diff --git a/content/github/setting-up-and-managing-your-github-profile/showing-an-overview-of-your-activity-on-your-profile.md b/content/github/setting-up-and-managing-your-github-profile/showing-an-overview-of-your-activity-on-your-profile.md
index 24978017454f..a7fc39ffc84e 100644
--- a/content/github/setting-up-and-managing-your-github-profile/showing-an-overview-of-your-activity-on-your-profile.md
+++ b/content/github/setting-up-and-managing-your-github-profile/showing-an-overview-of-your-activity-on-your-profile.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.profile.activity-overview-summary %} For more information, see "[Viewing contributions on your profile](/articles/viewing-contributions-on-your-profile)."
diff --git a/content/github/setting-up-and-managing-your-github-profile/troubleshooting-commits-on-your-timeline.md b/content/github/setting-up-and-managing-your-github-profile/troubleshooting-commits-on-your-timeline.md
index 5dba6e8d94b2..7ca1e14b678a 100644
--- a/content/github/setting-up-and-managing-your-github-profile/troubleshooting-commits-on-your-timeline.md
+++ b/content/github/setting-up-and-managing-your-github-profile/troubleshooting-commits-on-your-timeline.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Expected behavior to view commit details
diff --git a/content/github/setting-up-and-managing-your-github-profile/viewing-contributions-on-your-profile.md b/content/github/setting-up-and-managing-your-github-profile/viewing-contributions-on-your-profile.md
index 70469305f68b..9c6b4eaf31d4 100644
--- a/content/github/setting-up-and-managing-your-github-profile/viewing-contributions-on-your-profile.md
+++ b/content/github/setting-up-and-managing-your-github-profile/viewing-contributions-on-your-profile.md
@@ -8,13 +8,14 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Your contribution graph shows activity from public repositories. You can choose to show activity from both public and private repositories, with specific details of your activity in private repositories anonymized. For more information, see "[Publicizing or hiding your private contributions on your profile](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile)."
{% note %}
-**Note:** Commits will only appear on your contributions graph if you have [added the email address you used for your local Git configuration to your {% data variables.product.product_name %} email settings](/articles/adding-an-email-address-to-your-github-account). For more information, see "[Why are my contributions not showing up on my profile?](/articles/why-are-my-contributions-not-showing-up-on-my-profile#you-havent-added-your-local-git-commit-email-to-your-profile)"
+**Note:** Commits will only appear on your contributions graph if the email address you used to author the commits is connected to your account on {% data variables.product.product_name %}. For more information, see "[Why are my contributions not showing up on my profile?](/articles/why-are-my-contributions-not-showing-up-on-my-profile#your-local-git-commit-email-isnt-connected-to-your-account)"
{% endnote %}
@@ -25,7 +26,7 @@ On your profile page, certain actions count as contributions:
- Committing to a repository's default branch or `gh-pages` branch
- Opening an issue
- Proposing a pull request
-- Submitting a pull request review{% if currentVersion != "free-pro-team@latest" %}
+- Submitting a pull request review{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
- Co-authoring commits in a repository's default branch or `gh-pages` branch{% endif %}
{% data reusables.pull_requests.pull_request_merges_and_contributions %}
@@ -79,9 +80,11 @@ The contribution activity section includes a detailed timeline of your work, inc
+{% if currentVersion != "github-ae@latest" %}
### Viewing contributions from {% data variables.product.product_location_enterprise %} on {% data variables.product.prodname_dotcom_the_website %}
If your site administrator has enabled {% data variables.product.prodname_unified_contributions %}, you can send {% data variables.product.prodname_enterprise %} contribution counts to your {% data variables.product.prodname_dotcom_the_website %} profile. For more information, see "[Sending your {% data variables.product.prodname_ghe_server %} contributions to your {% data variables.product.prodname_dotcom_the_website %}](/articles/sending-your-github-enterprise-server-contributions-to-your-github-com-profile)."
+{% endif %}
### Further reading
diff --git a/content/github/setting-up-and-managing-your-github-profile/why-are-my-contributions-not-showing-up-on-my-profile.md b/content/github/setting-up-and-managing-your-github-profile/why-are-my-contributions-not-showing-up-on-my-profile.md
index d94a98b4a6c1..4c8132ffa5a4 100644
--- a/content/github/setting-up-and-managing-your-github-profile/why-are-my-contributions-not-showing-up-on-my-profile.md
+++ b/content/github/setting-up-and-managing-your-github-profile/why-are-my-contributions-not-showing-up-on-my-profile.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Contributions that are counted
@@ -29,18 +30,18 @@ In addition, **at least one** of the following must be true:
- You have forked the repository.
- You have opened a pull request or issue in the repository.
- You have starred the repository.
-{% if currentVersion != "free-pro-team@latest" %}
+
### Common reasons that contributions are not counted
-{% data reusables.pull_requests.pull_request_merges_and_contributions %}{% endif %}
+{% data reusables.pull_requests.pull_request_merges_and_contributions %}
#### Commit was made less than 24 hours ago
After making a commit that meets the requirements to count as a contribution, you may need to wait for up to 24 hours to see the contribution appear on your contributions graph.
-#### You haven't added your local Git commit email to your profile
+#### Your local Git commit email isn't connected to your account
-Commits must be made with an email address that has been added to your {% data variables.product.product_name %} account{% if currentVersion == "free-pro-team@latest" %}, or the {% data variables.product.product_name %}-provided `noreply` email address provided to you in your email settings,{% endif %} in order to appear on your contributions graph.{% if currentVersion == "free-pro-team@latest" %} For more information about `noreply` email addresses, see "[Setting your commit email address](/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address#about-commit-email-addresses)."{% endif %}
+Commits must be made with an email address that is connected to your account on {% data variables.product.product_name %}{% if currentVersion == "free-pro-team@latest" %}, or the {% data variables.product.product_name %}-provided `noreply` email address provided to you in your email settings,{% endif %} in order to appear on your contributions graph.{% if currentVersion == "free-pro-team@latest" %} For more information about `noreply` email addresses, see "[Setting your commit email address](/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address#about-commit-email-addresses)."{% endif %}
You can check the email address used for a commit by adding `.patch` to the end of a commit URL, e.g. https://github.com/octocat/octocat.github.io/commit/67c0afc1da354d8571f51b6f0af8f2794117fd10.patch:
@@ -53,7 +54,7 @@ Subject: [PATCH] updated index for better welcome message
The email address in the `From:` field is the address that was set in the [local git config settings](/articles/set-up-git). In this example, the email address used for the commit is `octocat@nowhere.com`.
-If the email address used for the commit hasn't been added to your {% data variables.product.product_name %} profile, you must [add the email address](/articles/adding-an-email-address-to-your-github-account) to your {% data variables.product.product_name %} account. Your contributions graph will be rebuilt automatically when you add the new address.
+If the email address used for the commit is not connected to your account on {% data variables.product.product_name %}, {% if currentVersion == "github-ae@latest" %}change the email address used to author commits in Git. For more information, see "[Setting your commit email address](/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address#setting-your-commit-email-address-in-git)."{% else %}you must [add the email address](/articles/adding-an-email-address-to-your-github-account) to your {% data variables.product.product_name %} account. Your contributions graph will be rebuilt automatically when you add the new address.{% endif %}
{% warning %}
diff --git a/content/github/setting-up-and-managing-your-github-user-account/about-organization-membership.md b/content/github/setting-up-and-managing-your-github-user-account/about-organization-membership.md
index 580ab54a5938..26871dae111a 100644
--- a/content/github/setting-up-and-managing-your-github-user-account/about-organization-membership.md
+++ b/content/github/setting-up-and-managing-your-github-user-account/about-organization-membership.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
An organization owner can invite you to join their organization as a member, billing manager, or owner. An organization owner or member with admin privileges for a repository can invite you to collaborate in one or more repositories as an outside collaborator. For more information, see "[Permission levels for an organization](/articles/permission-levels-for-an-organization)."
diff --git a/content/github/setting-up-and-managing-your-github-user-account/about-your-personal-dashboard.md b/content/github/setting-up-and-managing-your-github-user-account/about-your-personal-dashboard.md
index bb4bc6bfd6be..863031855b69 100644
--- a/content/github/setting-up-and-managing-your-github-user-account/about-your-personal-dashboard.md
+++ b/content/github/setting-up-and-managing-your-github-user-account/about-your-personal-dashboard.md
@@ -8,6 +8,7 @@ intro: 'You can visit your personal dashboard to keep track of issues and pull r
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Accessing your personal dashboard
@@ -28,6 +29,8 @@ In the left sidebar of your dashboard, you can access the top repositories and t
+The list of top repositories is automatically generated, and can include any repository you have interacted with, whether it's owned directly by your account or not. Interactions include making commits and opening or commenting on issues and pull requests. The list of top repositories cannot be edited, but repositories will drop off the list 4 months after you last interacted with them.
+
You can also find a list of your recently visited repositories, teams, and project boards when you click into the search bar at the top of any page on {% data variables.product.product_name %}.
### Staying updated with activity from the community
diff --git a/content/github/setting-up-and-managing-your-github-user-account/accessing-an-organization.md b/content/github/setting-up-and-managing-your-github-user-account/accessing-an-organization.md
index 4a8ceebe1893..d02c1a7a1b98 100644
--- a/content/github/setting-up-and-managing-your-github-user-account/accessing-an-organization.md
+++ b/content/github/setting-up-and-managing-your-github-user-account/accessing-an-organization.md
@@ -9,6 +9,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% tip %}
diff --git a/content/github/setting-up-and-managing-your-github-user-account/index.md b/content/github/setting-up-and-managing-your-github-user-account/index.md
index aaf38e64314a..19615ecffad7 100644
--- a/content/github/setting-up-and-managing-your-github-user-account/index.md
+++ b/content/github/setting-up-and-managing-your-github-user-account/index.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
@@ -24,7 +25,7 @@ versions:
{% link_in_list /managing-the-default-branch-name-for-your-repositories %}
{% link_in_list /managing-security-and-analysis-settings-for-your-user-account %}
{% link_in_list /managing-access-to-your-user-accounts-project-boards %}
-
+
{% link_in_list /integrating-jira-with-your-personal-projects %}
diff --git a/content/github/setting-up-and-managing-your-github-user-account/integrating-jira-with-your-personal-projects.md b/content/github/setting-up-and-managing-your-github-user-account/integrating-jira-with-your-personal-projects.md
index cc875645354a..c49dbcfc19eb 100644
--- a/content/github/setting-up-and-managing-your-github-user-account/integrating-jira-with-your-personal-projects.md
+++ b/content/github/setting-up-and-managing-your-github-user-account/integrating-jira-with-your-personal-projects.md
@@ -5,6 +5,7 @@ redirect_from:
- /articles/integrating-jira-with-your-personal-projects
versions:
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.user_settings.access_settings %}
diff --git a/content/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository.md b/content/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository.md
index 15498fdd7d42..a3d38e3aeaf7 100644
--- a/content/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository.md
+++ b/content/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository.md
@@ -9,11 +9,12 @@ product: '{% data reusables.gated-features.user-repo-collaborators %}'
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Repositories owned by an organization can grant more granular access. For more information, see "[Access permissions on {% data variables.product.product_name %}](/articles/access-permissions-on-github)."
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}
{% data reusables.organizations.org-invite-expiration %}
{% endif %}
diff --git a/content/github/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories.md b/content/github/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories.md
index 612400db5acf..4676b8aeaeac 100644
--- a/content/github/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories.md
+++ b/content/github/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories.md
@@ -10,5 +10,6 @@ mapTopic: true
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/setting-up-and-managing-your-github-user-account/managing-access-to-your-user-accounts-project-boards.md b/content/github/setting-up-and-managing-your-github-user-account/managing-access-to-your-user-accounts-project-boards.md
index 46dfb8488c74..ea304c8f150b 100644
--- a/content/github/setting-up-and-managing-your-github-user-account/managing-access-to-your-user-accounts-project-boards.md
+++ b/content/github/setting-up-and-managing-your-github-user-account/managing-access-to-your-user-accounts-project-boards.md
@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
A collaborator is a person who has permissions to a project board you own. A collaborator's permissions will default to read access. For more information, see "[Permission levels for user-owned project boards](/articles/permission-levels-for-user-owned-project-boards)."
diff --git a/content/github/setting-up-and-managing-your-github-user-account/managing-email-preferences.md b/content/github/setting-up-and-managing-your-github-user-account/managing-email-preferences.md
index 6f3b8e7cdc3c..b53a647506f4 100644
--- a/content/github/setting-up-and-managing-your-github-user-account/managing-email-preferences.md
+++ b/content/github/setting-up-and-managing-your-github-user-account/managing-email-preferences.md
@@ -8,5 +8,6 @@ mapTopic: true
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/setting-up-and-managing-your-github-user-account/managing-the-default-branch-name-for-your-repositories.md b/content/github/setting-up-and-managing-your-github-user-account/managing-the-default-branch-name-for-your-repositories.md
index da043351a156..0524ab40ce48 100644
--- a/content/github/setting-up-and-managing-your-github-user-account/managing-the-default-branch-name-for-your-repositories.md
+++ b/content/github/setting-up-and-managing-your-github-user-account/managing-the-default-branch-name-for-your-repositories.md
@@ -4,6 +4,7 @@ intro: 'You can set the default branch name new repositories that you create on
versions:
free-pro-team: '*'
enterprise-server: '>=2.23'
+ github-ae: '*'
---
### About management of the default branch name
diff --git a/content/github/setting-up-and-managing-your-github-user-account/managing-user-account-settings.md b/content/github/setting-up-and-managing-your-github-user-account/managing-user-account-settings.md
index 5a1e78519670..3e31dd28147a 100644
--- a/content/github/setting-up-and-managing-your-github-user-account/managing-user-account-settings.md
+++ b/content/github/setting-up-and-managing-your-github-user-account/managing-user-account-settings.md
@@ -9,5 +9,6 @@ mapTopic: true
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations.md b/content/github/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations.md
index 794b0a1255d1..80a10eb4a82e 100644
--- a/content/github/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations.md
+++ b/content/github/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/setting-up-and-managing-your-github-user-account/permission-levels-for-a-user-account-repository.md b/content/github/setting-up-and-managing-your-github-user-account/permission-levels-for-a-user-account-repository.md
index c6ebc8a604b9..22b6f45afc37 100644
--- a/content/github/setting-up-and-managing-your-github-user-account/permission-levels-for-a-user-account-repository.md
+++ b/content/github/setting-up-and-managing-your-github-user-account/permission-levels-for-a-user-account-repository.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% tip %}
@@ -28,8 +29,8 @@ The repository owner has full control of the repository. In addition to all the
- [Enable the dependency graph](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-and-dependents-of-a-repository) for a private repository{% endif %}{% if currentVersion == "free-pro-team@latest" %}
- Delete packages. For more information, see "[Deleting a package](/github/managing-packages-with-github-packages/deleting-a-package)."{% endif %}
- Create and edit repository social cards. For more information, see "[Customizing your repository's social media preview](/articles/customizing-your-repositorys-social-media-preview)."
-- Make the repository a template. For more information, see "[Creating a template repository](/articles/creating-a-template-repository)."
-- Receive [{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %} for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies) in a repository.{% if currentVersion == "free-pro-team@latest" %}
+- Make the repository a template. For more information, see "[Creating a template repository](/articles/creating-a-template-repository)."{% if currentVersion != "github-ae@latest" %}
+- Receive [{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %} for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies) in a repository.{% endif %}{% if currentVersion == "free-pro-team@latest" %}
- Dismiss {% data variables.product.prodname_dependabot_alerts %} in your repository. For more information, see "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)."
- [Manage data usage for your private repository](/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository){% endif %}
- [Define code owners for the repository](/articles/about-code-owners)
diff --git a/content/github/setting-up-and-managing-your-github-user-account/permission-levels-for-user-owned-project-boards.md b/content/github/setting-up-and-managing-your-github-user-account/permission-levels-for-user-owned-project-boards.md
index b16530c96474..7376a73b4512 100644
--- a/content/github/setting-up-and-managing-your-github-user-account/permission-levels-for-user-owned-project-boards.md
+++ b/content/github/setting-up-and-managing-your-github-user-account/permission-levels-for-user-owned-project-boards.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Permissions overview
diff --git a/content/github/setting-up-and-managing-your-github-user-account/publicizing-or-hiding-organization-membership.md b/content/github/setting-up-and-managing-your-github-user-account/publicizing-or-hiding-organization-membership.md
index 7d3262035053..5eda5de372d6 100644
--- a/content/github/setting-up-and-managing-your-github-user-account/publicizing-or-hiding-organization-membership.md
+++ b/content/github/setting-up-and-managing-your-github-user-account/publicizing-or-hiding-organization-membership.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/setting-up-and-managing-your-github-user-account/removing-a-collaborator-from-a-personal-repository.md b/content/github/setting-up-and-managing-your-github-user-account/removing-a-collaborator-from-a-personal-repository.md
index 8c168a2b2688..34e08f88859d 100644
--- a/content/github/setting-up-and-managing-your-github-user-account/removing-a-collaborator-from-a-personal-repository.md
+++ b/content/github/setting-up-and-managing-your-github-user-account/removing-a-collaborator-from-a-personal-repository.md
@@ -12,6 +12,7 @@ product: '{% data reusables.gated-features.user-repo-collaborators %}'
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Deleting forks of private repositories
diff --git a/content/github/setting-up-and-managing-your-github-user-account/removing-yourself-from-a-collaborators-repository.md b/content/github/setting-up-and-managing-your-github-user-account/removing-yourself-from-a-collaborators-repository.md
index c263df13c1ec..5a5c84520df8 100644
--- a/content/github/setting-up-and-managing-your-github-user-account/removing-yourself-from-a-collaborators-repository.md
+++ b/content/github/setting-up-and-managing-your-github-user-account/removing-yourself-from-a-collaborators-repository.md
@@ -11,6 +11,7 @@ product: '{% data reusables.gated-features.user-repo-collaborators %}'
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.user_settings.access_settings %}
diff --git a/content/github/setting-up-and-managing-your-github-user-account/removing-yourself-from-an-organization.md b/content/github/setting-up-and-managing-your-github-user-account/removing-yourself-from-an-organization.md
index ef2f03ca2ddd..0a90a82e5963 100644
--- a/content/github/setting-up-and-managing-your-github-user-account/removing-yourself-from-an-organization.md
+++ b/content/github/setting-up-and-managing-your-github-user-account/removing-yourself-from-an-organization.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% if currentVersion == "free-pro-team@latest" %}
diff --git a/content/github/setting-up-and-managing-your-github-user-account/setting-a-backup-email-address.md b/content/github/setting-up-and-managing-your-github-user-account/setting-a-backup-email-address.md
index 09094f778da1..e43a3ba4e462 100644
--- a/content/github/setting-up-and-managing-your-github-user-account/setting-a-backup-email-address.md
+++ b/content/github/setting-up-and-managing-your-github-user-account/setting-a-backup-email-address.md
@@ -1,11 +1,12 @@
---
title: Setting a backup email address
-intro: Use a backup email address to securely reset your password if you can no longer access your primary email address.
+intro: Use a backup email address as an additional destination for security-relevant account notifications{% if currentVersion != "github-ae@latest" %} and to securely reset your password if you can no longer access your primary email address{% endif %}.
redirect_from:
- /articles/setting-a-backup-email-address
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.user_settings.access_settings %}
diff --git a/content/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address.md b/content/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address.md
index e13f71ed91ad..efc2bc6f5848 100644
--- a/content/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address.md
+++ b/content/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address.md
@@ -1,6 +1,6 @@
---
title: Setting your commit email address
-intro: 'You can set a primary email address on {% data variables.product.product_name %} that''s associated with web-based Git operations you perform such as edits and merges.'
+intro: 'You can set the email address that is used to author commits on {% data variables.product.product_name %} and on your computer.'
redirect_from:
- /articles/keeping-your-email-address-private/
- /articles/setting-your-commit-email-address-on-github/
@@ -13,6 +13,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### About commit email addresses
@@ -37,7 +38,7 @@ For web-based Git operations, you can set your commit email address on {% data v
You can also choose to block commits you push from the command line that expose your personal email address. For more information, see "[Blocking command line pushes that expose your personal email](/articles/blocking-command-line-pushes-that-expose-your-personal-email-address)."{% endif %}
-To ensure that commits are attributed to you and appear in your contributions graph, use an email address that you've [added to your GitHub account](/articles/adding-an-email-address-to-your-github-account/){% if currentVersion == "free-pro-team@latest" %}, or the {% data variables.product.product_name %}-provided `noreply` email address provided to you in your email settings{% endif %}.
+To ensure that commits are attributed to you and appear in your contributions graph, use an email address that is connected to your {% data variables.product.product_name %} account{% if currentVersion == "free-pro-team@latest" %}, or the `noreply` email address provided to you in your email settings{% endif %}. {% if currentVersion != "github-ae@latest" %}For more information, see "[Adding an email address to your {% data variables.product.prodname_dotcom %} account](/github/setting-up-and-managing-your-github-user-account/adding-an-email-address-to-your-github-account)."{% endif %}
{% if currentVersion == "free-pro-team@latest" %}
diff --git a/content/github/setting-up-and-managing-your-github-user-account/viewing-peoples-roles-in-an-organization.md b/content/github/setting-up-and-managing-your-github-user-account/viewing-peoples-roles-in-an-organization.md
index f1a527db9e29..3e366d76a8aa 100644
--- a/content/github/setting-up-and-managing-your-github-user-account/viewing-peoples-roles-in-an-organization.md
+++ b/content/github/setting-up-and-managing-your-github-user-account/viewing-peoples-roles-in-an-organization.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% note %}
diff --git a/content/github/site-policy/github-additional-product-terms.md b/content/github/site-policy/github-additional-product-terms.md
index 38f8554b4e3c..e867345c0d19 100644
--- a/content/github/site-policy/github-additional-product-terms.md
+++ b/content/github/site-policy/github-additional-product-terms.md
@@ -4,9 +4,13 @@ versions:
free-pro-team: '*'
---
-When you create an Account, you're given access to lots of different features and products that are all a part of the Service. Because many of these features and products offer different functionality, they may require additional terms and conditions specific to that feature or product. Below, we've listed those features and products, along with the corresponding additional rules that apply to those parts of the Service.
+Version Effective Date: November 1, 2020
-Your use of GitHub is subject to your applicable terms (the "Agreement") as well as the following GitHub Additional Product Terms (the "Additional Terms"). By agreeing to the Agreement, and using additional products and features, you also agree to these Additional Terms. Any violation of the Additional Terms is a violation of the Agreement. Capitalized terms not defined in the Additional Terms will have the meaning given to them in the Agreement.
+When you create an Account, you're given access to lots of different features and products that are all a part of the Service. Because many of these features and products offer different functionality, they may require additional terms and conditions specific to that feature or product. Below, we've listed those features and products, along with the corresponding additional terms that apply to your use of them.
+
+Your use of the Service is subject to your applicable terms (the "Agreement"). By using additional products and features, you also agree to these Additional Product Terms. Any violation of the Additional Product Terms is a violation of the Agreement. Capitalized terms not defined in the Additional Product Terms will have the meaning given to them in the Agreement.
+
+If you are using GitHub AE, then you may only access the following features and products: Third Party Integrations, Git LFS Support, Pages.
### 1. Marketplace
@@ -35,14 +39,14 @@ If you enable Git Large File Storage ("Git LFS") on your Account, you'll be able
### 4. Pages
-Each GitHub Account comes with access to the [GitHub Pages static hosting service](/github/working-with-github-pages/about-github-pages). This hosting service is intended to host static web pages for All Users, but primarily as a showcase for personal and organizational projects. Some monetization efforts are permitted on Pages, such as donation buttons and crowdfunding links.
+Each Account comes with access to the [GitHub Pages static hosting service](/github/working-with-github-pages/about-github-pages). This hosting service is intended to host static web pages for All Users, but primarily as a showcase for personal and organizational projects. Some monetization efforts are permitted on Pages, such as donation buttons and crowdfunding links.
GitHub Pages are subject to some specific bandwidth and usage limits, and may not be appropriate for some high-bandwidth uses or other prohibited uses. Please see our [GitHub Pages guidelines](/github/working-with-github-pages/about-github-pages) for more information. GitHub reserves the right at all times to reclaim any GitHub subdomain without liability.
### 5. Actions and Packages
#### a. Actions Usage
-GitHub Actions enables you to create custom software development lifecycle workflows directly in your GitHub repository. Each Account comes with included compute and storage quantities for use with Actions, depending on your Account plan, which can be found in the [Actions documentation](/actions). Your Actions compute usage is displayed within [your Account settings](https://github.com/settings/billing), and you will be notified by email in advance of reaching the limit of your included quantities. If you want to use Actions beyond your included quantities, then you may [enable overages](/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-actions).
+GitHub Actions enables you to create custom software development lifecycle workflows directly in your GitHub repository. Each Account comes with included compute and storage quantities for use with Actions, depending on your Account plan, which can be found in the [Actions documentation](/actions). Your Actions compute usage is displayed within [your account settings](https://github.com/settings/billing), and you will be notified by email in advance of reaching the limit of your included quantities. If you want to use Actions beyond your included quantities, then you may [enable overages](/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-actions).
Compute usage for included and paid quantities is calculated in minutes based on the type of Actions you execute (e.g. Linux, Windows, macOS). The minutes used for each Action's job or task will be rounded up to the nearest minute. For included quantities and depending on the type of Action, a multiplier may be applied to the amount of time used to execute each job or task, prior to being rounded up to the nearest minute. Overage minutes are charged at the [stated per minute price](https://github.com/features/actions) based on the type of Actions you execute. Actions and Packages share storage, and your storage usage is displayed within your [account settings](https://github.com/settings/billing). For additional details about included quantity usage calculations, see the [Actions documentation](/actions).
@@ -58,9 +62,9 @@ In order to prevent violations of these limitations and abuse of GitHub Actions,
#### b. Packages Usage
GitHub Packages may be used to download, publish, and manage packages of Content. Each Account plan comes with included bandwidth and storage quantities for use with Packages, which can be found in the [Packages documentation](/github/managing-packages-with-github-package-registry/about-github-package-registry). Actions and Packages share storage between the two Service features. Storage and bandwidth usage are displayed within your [account settings](https://github.com/settings/billing), and you will be notified by email in advance of reaching the limit of your included quantities. If you want to use Packages beyond your included bandwidth and storage quantities, then you may [enable overages](/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-packages).
-Bandwidth usage is calculated based on the amount of data transferred out of your repositories through Packages, but package transfers through Actions will not count toward your included or paid quantities. Packages bandwidth usage is limited by the [Acceptable Use Policy](/github/site-policy/github-acceptable-use-policies#7-excessive-bandwidth-use), and included bandwidth quantities are determined by your [Account plan](https://github.com/pricing).
+Bandwidth usage is calculated based on the amount of data transferred out of your repositories through Packages, but package transfers through Actions will not count toward your included or paid quantities. Packages bandwidth usage is limited by the [Acceptable Use Policy](/github/site-policy/github-acceptable-use-policies#7-excessive-bandwidth-use), and included bandwidth quantities are determined by your [account plan](https://github.com/pricing).
-Actions and Packages storage usage is shared between the two Service features. Storage usage is calculated as a weighted average over the course of the month and does not reset each month. Public and private repositories have different included storage quantities, and the included quantities for private repositories depend on your [Account plan](https://github.com/pricing).
+Actions and Packages storage usage is shared between the two Service features. Storage usage is calculated as a weighted average over the course of the month and does not reset each month. Public and private repositories have different included storage quantities, and the included quantities for private repositories depend on your [account plan](https://github.com/pricing).
#### c. Payment and Billing for Actions and Packages
Billing for Actions and Packages is usage-based. Additional quantities of Actions or Packages cannot be purchased separately. For monthly-billed customers, you must have a payment method on file to choose to pay for additional quantities of these Service features. You will be charged on a monthly, recurring basis based on your usage in the preceding month, unless you are billed by invoice. For invoiced customers, you must pay the fees within thirty (30) days of the GitHub invoice date. For customers paying for Service feature overages in advance, unused prepaid minutes will not roll over to the next billing period and will not be refunded.
@@ -77,7 +81,7 @@ You can set a monthly spending limit in your [account settings](https://github.c
### 7. Connect
-In order to access GitHub Connect, Customer must have at least one (1) account on GitHub.com and one (1) licensed instance of the Software. GitHub Connect may be used for performing automated tasks. In addition, multiple Users may direct certain actions with GitHub Connect. Customer is responsible for actions that are performed on or through its accounts. GitHub may collect information about how Customer uses GitHub Connect to provide and improve the feature. By using GitHub Connect, Customer authorizes GitHub to collect protected data, which includes Private Repository data and User Personal Information (as defined in the GitHub Privacy Statement), from Customer’s GitHub Enterprise Server account. Customer also authorizes the transfer of identifying instance information to GitHub through GitHub Connect, which information is governed by the GitHub Privacy Statement.
+In order to access GitHub Connect, Customer must have at least one (1) Account on GitHub.com and one (1) licensed instance of the Software. Customer's access to and use of github.com through Connect is governed by its Agreement applicable to its use of the Service. GitHub Connect may be used for performing automated tasks. In addition, multiple Users may direct certain actions with GitHub Connect. Customer is responsible for actions that are performed on or through its Accounts. GitHub may collect information about how Customer uses GitHub Connect to provide and improve the feature. By using GitHub Connect, Customer authorizes GitHub to collect protected data, which includes Private Repository data and User Personal Information (as defined in the GitHub Privacy Statement), from Customer’s Accounts. Customer also authorizes the transfer of identifying instance information to GitHub through GitHub Connect, which information is governed by the GitHub Privacy Statement.
### 8. Sponsors Program
diff --git a/content/github/site-policy/github-ae-data-protection-agreement.md b/content/github/site-policy/github-ae-data-protection-agreement.md
new file mode 100644
index 000000000000..b73651630d77
--- /dev/null
+++ b/content/github/site-policy/github-ae-data-protection-agreement.md
@@ -0,0 +1,405 @@
+---
+title: GitHub AE Data Protection Agreement
+versions:
+ free-pro-team: '*'
+redirect_from:
+ - /github/site-policy/ghem-data-protection-addendum
+---
+
+Version Effective Date: November 1, 2020
+
+## INTRODUCTION
+
+The parties agree that the GitHub AE Data Protection Agreement and Security Exhibit (together, the “**Data Protection Agreement**” or “**DPA**”) set forth obligations with respect to the processing and security of Customer Personal Data in connection with GitHub AE (the “**Online Service**”). GitHub makes the commitments in this DPA to all customers using the Online Service.
+
+In the event of any conflict or inconsistency between the DPA and any other terms in Customer’s agreements with GitHub (“Agreement”), the DPA shall prevail. For clarity, consistent with Clause 10 of the Standard Contractual Clauses in Attachment 1, the Standard Contractual Clauses prevail over any other terms in the DPA.
+
+## GITHUB DATA PROTECTION AGREEMENT
+
+### 1. Definitions.
+
+1.1 “**Applicable Data Protection Laws**” means certain laws, regulations, regulatory frameworks, or other legislations relating to the processing and use of Customer Personal Data, as applicable to Customer’s use of the Online Services, including:
+
+ a. The EU General Data Protection Regulation 2016/679 (“**GDPR**”), along with any implementing or corresponding equivalent national laws or regulations; and
+
+ b. The California Consumer Privacy Act of 2018, Cal. Civ. Code §§1798.100 et seq. ("**CCPA**").
+
+1.2 “**Controller**,” “**Data Subject**,” “**Member State**,” “**Personal Data**,” “**Personal Data Breach**,” “**Processing**,” “**Processor**,” and “**Supervisory Authority**” have the meanings given to them in the Applicable Data Protection Laws. In the event of a conflict, the meanings given in the GDPR will supersede.
+
+1.3 “**Customer Personal Data**” means any Personal Data for which Customer is a Controller, whether supplied by Customer for processing by GitHub or generated by GitHub in the course of performing its obligations under the Agreement. It includes data such as billing information, IP addresses, corporate email addresses, and any other Personal Data for which Customer is a Controller.
+
+1.4 “**Customer Repository Data**” means any data or information that is uploaded or created by Customer into any of its Private Repositories.
+
+1.5 “**Data Breach**” means a Personal Data Breach or any other confirmed or reasonably suspected breach of Customer’s Protected Data.
+
+1.6 “**GitHub Legitimate Business Operations**” consist of the following, each as incident to delivery of the Service to Customer: (1) internal reporting and business modeling; (2) combating fraud, cybercrime, or cyber-attacks that may affect GitHub; (3) improving the core functionality of accessibility or privacy; and (4) financial reporting and compliance with legal obligations.
+
+1.7 “**End User**” means the Customers’ End Users such as employees, contractors, or collaborators.
+
+1.8 “**Permitted Purposes**” for data processing are those limited and specific purposes of providing the Online Service as set forth in the Agreement and this DPA, or the purposes for which a Data Subject has authorized the use of Customer Personal Data.
+
+1.9 “**Protected Data**” includes any Customer Personal Data and any Customer Repository Data processed by GitHub on behalf of Customer under the Agreement.
+
+1.10 “**Sensitive Data**” means any Personal Data revealing racial or ethnic origin; political opinions, religious or philosophical beliefs or trade union membership; processing of genetic data or biometric data for the purposes of uniquely identifying a natural person; data concerning health, a natural person’s sex life or sexual orientation; and data relating to offences, criminal convictions, or security measures.
+
+## 2. Status and Compliance.
+
+#### 2.1 Data Processing.
+GitHub acts as a Processor in regard to any Customer Personal Data it receives in connection with the Agreement, except where Customers acts as a Processor (in which case GitHub is a subprocessor). GitHub will process Customer Personal Data only for Permitted Purposes in accordance with Customer’s instructions as represented by the Agreement and other written communications. In the event that GitHub is unable to comply with Customer’s instructions, such as due to conflicts with the Applicable Data Protection Laws, or where processing is required by the Applicable Data Protection Laws or other legal requirements, GitHub will notify Customer to the extent permissible. GitHub processes all Customer Personal Data in the United States or in the European Union; however, GitHub’s subprocessors may process data outside of the United States or the European Union. Additionally, GitHub acts as a Processor for any Customer Repository Data.
+
+#### 2.2 Data Controllers.
+Customer is a Controller only for the Customer Personal Data it transfers directly to GitHub or through the use of the Online Service except: (a) when Customer acts as a Processor of Customer Personal Data (in which case GitHub is a subprocessor); or (b) to the extent GitHub uses or otherwise processes Customer Personal Data for GitHub’s Legitimate Business Operations. In which case, GitHub will comply with the obligation of an independent data controller under GDPR for such use.
+
+#### 2.3 GitHub Compliance; Data Transfers.
+GitHub will comply with Applicable Data Protection Laws in relation to the processing of Personal Data.
+
+All transfers of Customer Personal Data out of the European Union, European Economic Area, United Kingdom, and Switzerland to provide the Online Service shall be governed by the Standard Contractual Clauses in Attachment 1 (Standard Contractual Clauses).
+
+GitHub will abide by the requirements of European Economic Area and Swiss data protection law regarding the collection, use, transfer, retention, and other processing of Personal Data from the European Economic Area, United Kingdom, and Switzerland. All transfers of Personal Data to a third country or an international organization will be subject to appropriate safeguards as described in Article 46 of the GDPR and such transfers and safeguards will be documented according to Article 30(2) of the GDPR.
+
+In addition, GitHub is certified to the EU-U.S. and Swiss-U.S. Privacy Shield Frameworks and the commitments they entail, although GitHub does not rely on the EU-U.S. Privacy Shield Framework as a legal basis for transfers of Personal Data in light of the judgment of the Court of Justice of the EU in Case C-311/18. GitHub agrees to notify Customer if it makes a determination that it can no longer meet its obligation to provide the same level of protection as is required by the Privacy Shield principles.
+
+#### 2.4 Data Subject Rights; Assistance with Requests.
+GitHub will make available to Customer, in a manner consistent with the functionality of the Online Service and GitHub’s role as a processor of Customer Personal Data, the ability to fulfill data subject requests to exercise their rights under the Applicable Data Protection Laws, such as GDPR and CCPA. If GitHub receives a request from Customer’s data subject to exercise one or more of its rights in connection with the Online Service for which GitHub is a data processor or subprocessor, GitHub will redirect the data subject to make its request directly to Customer. Customer will be responsible for responding to any such request including, where necessary, by using the functionality or documentation provided by the Online Service. GitHub shall comply with reasonable requests by Customer to assist with Customer’s response to such a data subject request.
+
+### 3. Data Protection.
+
+#### 3.1 Purpose Limitation.
+GitHub will process and communicate the Protected Data only for Permitted Purposes, unless the Parties agree in writing to an expanded purpose.
+
+#### 3.2 Data Quality and Proportionality.
+GitHub will keep the Customer Personal Data accurate and up to date, or enable Customer to do so. GitHub will take commercially reasonable steps to ensure that any Protected Data it collects on Customer’s behalf is adequate, relevant, and not excessive in relation to the purposes for which it is transferred and processed. In no event will GitHub intentionally collect Sensitive Data on Customer’s behalf. Customer agrees that the Online Service are not intended for the storage of Sensitive Data; if Customer chooses to upload Sensitive Data to the Online Service, Customer must comply with Article 9 of the GDPR, or equivalent provisions in the Applicable Data Protection Laws.
+
+#### 3.3 Data Retention and Deletion.
+Upon Customer’s reasonable request, unless prohibited by law, GitHub will return, destroy, or deidentify all Customer Personal Data and related data at all locations where it is stored after it is no longer needed for the Permitted Purposes within thirty days of request. GitHub may retain Customer Personal Data and related data to the extent required by the Applicable Data Protection Laws, and only to the extent and for such period as required by the Applicable Data Protection Laws, provided that GitHub will ensure that Customer Personal Data is processed only as necessary for the purpose specified in the Applicable Data Protection Laws and no other purpose, and Customer Personal Data remains protected by the Applicable Data Protection Laws.
+
+#### 3.4 Data Processing.
+GitHub provides the following information, required by Article 28(3) of the GDPR, regarding its processing of Customer’s Protected Data:
+
+a. *The subject matter and duration of the processing* of Customer Personal Data are set out in the Agreement and the DPA.
+
+b. *The nature and purpose of the processing* of Customer Personal Data is described in Section 3.1 of the DPA.
+
+c. *The types of Customer Personal Data to be processed* are described in the Agreement, and include Customer Personal Data; or any type of Personal Data that Customer elects to include in Customer Personal Data. Customer may choose to supply GitHub with additional Customer Personal Data, such as in Customer’s profile settings or by uploading Customer Personal Data to its GitHub repositories.
+
+d. *The categories of Data Subject to whom the Customer Personal Data relates* are the Customer itself and its End Users.
+
+e. *The obligations and rights of Customer* are set out in the Agreement and the DPA.
+
+### 4. Security and Audit Obligations.
+
+#### 4.1 Technical and Organizational Security Measures.
+Taking into account the state of the art, the costs of implementation, and the nature, scope, context and purposes of processing as well as the risk of varying likelihood and severity for the rights and freedoms of natural persons, GitHub will implement appropriate technical and organizational measures to ensure a level of security appropriate to the risks, such as against accidental or unlawful destruction, or loss, alteration, unauthorized disclosure or access, presented by processing the Protected Data. GitHub will regularly monitor compliance with these measures and will continue to take appropriate safeguards throughout the duration of the Agreement. Please see Section 1.1 of the Security Exhibit (below) regarding GitHub’s responsibilities in relation to security safeguards.
+
+#### 4.2 Incident Response and Breach Notification.
+GitHub will comply with the Information Security obligations in the Security Exhibit and the Applicable Data Protection Laws, including Data Breach notification obligations. Please see Section 1.2 of the Security Exhibit regarding GitHub’s responsibilities in relation to Data Breach response and notification.
+
+#### 4.3 GitHub Personnel.
+GitHub represents and warrants that it will take reasonable steps to ensure that all GitHub personnel processing Protected Data have agreed to keep the Protected Data confidential and have received adequate training on compliance with the DPA and the Applicable Data Protection Laws.
+
+#### 4.4 Records.
+GitHub will maintain complete, accurate, and up to date written records of all categories of processing activities carried out on behalf of Customer containing the information required under the Applicable Data Protection Laws. To the extent that assistance does not risk the security of GitHub or the privacy rights of individual Data Subjects, GitHub will make these records available to Customer on request as reasonably required, such as to help Customer demonstrate its compliance under the Applicable Data Protection Laws. To learn more about GitHub’s requirements to provide assistance in the event of a security incident, please see Section 1.2 of the Security Exhibit.
+
+#### 4.5 Compliance Reporting.
+GitHub will provide security compliance reporting in accordance with Section 2.3 of the Security Exhibit. Customer agrees that any information and audit rights granted by the Applicable Data Protection Laws (including, where applicable, Article 28(3)(h) of the GDPR) will be satisfied by these compliance reports, and will only arise to the extent that GitHub’s provision of a compliance report does not provide sufficient information, or to the extent that Customer must respond to a regulatory or Supervisory Authority audit. Section 3.1 of the Security Exhibit describes the Parties’ responsibilities in relation to a regulatory or Supervisory Authority audit.
+
+#### 4.6 Assistance.
+GitHub will provide reasonable assistance to Customer with concerns such as data privacy impact assessments, Data Subject rights requests, consultations with Supervisory Authorities, and other similar matters, in each case solely in relation to the processing of Customer’s Personal Data and taking into account the nature of processing.
+
+### 5. Use and Disclosure of Protected Data.
+No Use in Marketing and CCPA. GitHub will not use the Protected Data for the purposes of advertising third-party content. If GitHub is processing Customer Personal Data within the scope of the CCPA, GitHub will not retain, use, or disclose that data for any purpose other than for the purposes set out in the DPA and as permitted under the CCPA, including under any “sale” exemption. In no event will GitHub sell any such data.
+
+### 6. Subprocessing and Onward Transfer.
+
+#### 6.1 Protection of Data.
+GitHub is liable for onward transfers of Protected Data to its subprocessors, such as its third-party payment processor. In the event that GitHub does transfer the Protected Data to a third-party subprocessor, or GitHub installs, uses, or enables a third party or third-party services to process the Protected Data on GitHub’s behalf, GitHub will ensure that the third-party subprocessor is bound by written agreement that requires them to provide at least the same level of confidentiality, security, and privacy protection as is required of GitHub by this DPA and the Applicable Data Protection Laws.
+
+#### 6.2 Acceptance of GitHub Subprocessors.
+Customer authorizes GitHub and its subprocesors to appoint and use subprocessors in accordance with this Section 6 and the Agreement.
+
+#### 6.3 General Consent for Onward Subprocessing.
+Customer provides a general consent for GitHub to engage onward subprocessors, conditional on GitHub’s compliance with the following requirements:
+
+a. Any onward subprocessor must agree in writing to only process data in a country that the European Commission has declared to have an “adequate” level of protection; or to only process data on terms equivalent to the Standard Contractual Clauses, or pursuant to a Binding Corporate Rules approval granted by competent European data protection authorities, or pursuant to compliant and valid EU-US Privacy Shield and Swiss-U.S. Privacy Shield certifications; and
+
+b. GitHub will restrict the onward subprocessor’s access to Customer Personal Data only to what is strictly necessary to perform its services, and GitHub will prohibit the subprocessor from processing the Customer Personal Data for any other purpose.
+
+#### 6.4 Disclosure of Subprocessor Agreements.
+GitHub maintains a list of onward subprocessors it has engaged to process Customer Personal Data on its website, including the categories of Customer Personal Data processed, a description of the type of processing the subprocessor performs, and the location of its processing. GitHub will, upon Customer’s written request, provide Customer with this list of subprocessors and the terms under which they process the Customer Personal Data. Pursuant to subprocessor confidentiality restrictions, GitHub may remove any confidential or commercially sensitive information before providing the list and the terms to Customer. In the event that GitHub cannot disclose confidential or sensitive information to Customer, the Parties agree that GitHub will provide all information it reasonably can in connection with its subprocessing agreements.
+
+#### 6.5 Objection to Subprocessors.
+GitHub will provide thirty days’ prior written notice of the addition or removal of any subprocessor, including the categories listed in Section 6.4, by announcing changes on its website. If Customer has a reasonable objection to GitHub’s engagement of a new subprocessor, Customer must notify GitHub promptly in writing. Where possible, GitHub will use commercially reasonable efforts to provide an alternative solution to the Online Services to avoid processing of data by the objectionable subprocessor. In the event that GitHub is unable to provide an alternative solution and the Parties cannot resolve the conflict within ninety days, Customer may terminate the Agreement.
+
+### 7. Termination.
+
+#### 7.1 Suspension.
+In the event that GitHub is in breach of its obligations to maintain an adequate level of security or privacy protection, Customer may temporarily suspend the transfer of all Customer Personal Data or prohibit collection and processing of Customer Personal Data on Customer’s behalf until the breach is repaired or the Agreement is terminated.
+
+#### 7.2 Termination with Cause.
+In addition to any termination rights Customer has under the Agreement, Customer may terminate the Agreement without prejudice to any other claims at law or in equity in the event that:
+
+a. GitHub notifies Customer that it can no longer meet its privacy obligations;
+
+b. the transfer, collection, or processing of all Customer Personal Data has been temporarily suspended for longer than one month pursuant to Section 7.1;
+
+c. GitHub is in substantial or persistent breach of any warranties or representations under the DPA;
+
+d. GitHub is no longer carrying on business, is dissolved, enters receivership, or a winding up order is made on behalf of GitHub; or
+
+e. Customer objects to a subprocessor pursuant to Section 6.5, and GitHub has not been able to provide an alternative solution within ninety days.
+
+#### 7.3 Breach.
+Failure to comply with the material provisions of the DPA is considered a material breach under the Agreement.
+
+#### 7.4 Failure to perform.
+In the event that changes in law or regulation render performance of the DPA impossible or commercially unreasonable, the Parties may renegotiate the DPA in good faith. If renegotiation would not cure the impossibility, or if the Parties cannot reach an agreement, the Parties may terminate the Agreement after thirty days.
+
+#### 7.5 Notification.
+In the event that GitHub determines that it can no longer meet its privacy obligations under the DPA, GitHub will notify Customer in writing immediately.
+
+#### 7.6 Modifications.
+GitHub may modify the DPA from time to time as required by the Applicable Data Protection Laws, with thirty days’ notice to Customer.
+
+#### 7.7 Termination Requirements.
+Upon Termination, GitHub must:
+
+a. take reasonable and appropriate steps to stop processing the Customer Personal Data;
+
+b. within ninety days of termination, delete or deidentify any Customer Personal Data GitHub stores on Customer’s behalf pursuant to Section 3.3; and
+
+c. provide Customer with reasonable assurance that GitHub has complied with its obligations in Section 7.7.
+
+### 8. Liability for Data Processing.
+
+#### 8.1 Limitations.
+Except as limited by the Applicable Data Protection Laws, any claims brought under the DPA will be subject to the terms of the Agreement regarding Limitations of Liability.
+
+## Attachment 1 – The Standard Contractual Clauses (Processors)
+Execution of the Agreement by Customer includes execution of this Attachment 1 to the GitHub Data Protection Addendum, which is countersigned by GitHub, Inc.
+
+In countries where regulatory approval is required for use of the Standard Contractual Clauses, the Standard Contractual Clauses cannot be relied upon under European Commission 2010/87/EU (of February 2010) to legitimize export of data from the country, unless Customer has the required regulatory approval.
+
+For the purposes of Article 46 (2) of the General Data Protection Regulation (EU 2016/679) for the transfer of personal data to processors established in third countries which do not ensure an adequate level of data protection, Customer (as data exporter) and GitHub (as data importer, whose signature appears below), each a “party,” together “the parties”, have agreed on the following Contractual Clauses (the “Clauses” or “Standard Contractual Clauses”) in order to adduce adequate safeguards with respect to the protection of privacy and fundamental rights and freedoms of individuals for the transfer by the data exporter to the data importer of the personal data specified in Appendix 1.
+
+#### Clause 1: Definitions
+(a) 'personal data', 'special categories of data', 'process/processing', 'controller', 'processor', 'data subject' and 'supervisory authority' shall have the same meaning as in the General Data Protection Regulation (EU 2016/679) on the protection of individuals with regard to the processing of personal data and on the free movement of such data;
+
+(b) 'the data exporter' means the controller who transfers the personal data;
+
+(c) 'the data importer' means the processor who agrees to receive from the data exporter personal data intended for processing on his behalf after the transfer in accordance with his instructions and the terms of the Clauses and who is not subject to a third country's system ensuring adequate protection within the meaning of Article 45(2) of the General Data Protection Regulation (EU 2016/679);
+
+(d) 'the subprocessor' means any processor engaged by the data importer or by any other subprocessor of the data importer who agrees to receive from the data importer or from any other subprocessor of the data importer personal data exclusively intended for processing activities to be carried out on behalf of the data exporter after the transfer in accordance with his instructions, the terms of the Clauses and the terms of the written subcontract;
+
+(e) 'the applicable data protection law' means the legislation protecting the fundamental rights and freedoms of individuals and, in particular, their right to privacy with respect to the processing of personal data applicable to a data controller in the Member State in which the data exporter is established;
+
+(f) 'technical and organisational security measures' means those measures aimed at protecting personal data against accidental or unlawful destruction or accidental loss, alteration, unauthorised disclosure or access, in particular where the processing involves the transmission of data over a network, and against all other unlawful forms of processing.
+
+#### Clause 2: Details of the transfer
+The details of the transfer and in particular the special categories of personal data where applicable are specified in Appendix 1 below which forms an integral part of the Clauses.
+
+#### Clause 3: Third-party beneficiary clause
+1. The data subject can enforce against the data exporter this Clause, Clause 4(b) to (i), Clause 5(a) to (e), and (g) to (j), Clause 6(1) and (2), Clause 7, Clause 8(2), and Clauses 9 to 12 as third-party beneficiary.
+
+2. The data subject can enforce against the data importer this Clause, Clause 5(a) to (e) and (g), Clause 6, Clause 7, Clause 8(2), and Clauses 9 to 12, in cases where the data exporter has factually disappeared or has ceased to exist in law unless any successor entity has assumed the entire legal obligations of the data exporter by contract or by operation of law, as a result of which it takes on the rights and obligations of the data exporter, in which case the data subject can enforce them against such entity.
+
+3. The data subject can enforce against the subprocessor this Clause, Clause 5(a) to (e) and (g), Clause 6, Clause 7, Clause 8(2), and Clauses 9 to 12, in cases where both the data exporter and the data importer have factually disappeared or ceased to exist in law or have become insolvent, unless any successor entity has assumed the entire legal obligations of the data exporter by contract or by operation of law as a result of which it takes on the rights and obligations of the data exporter, in which case the data subject can enforce them against such entity. Such third-party liability of the subprocessor shall be limited to its own processing operations under the Clauses.
+
+4. The parties do not object to a data subject being represented by an association or other body if the data subject so expressly wishes and if permitted by national law.
+
+#### Clause 4: Obligations of the data exporter
+The data exporter agrees and warrants:
+
+(a) that the processing, including the transfer itself, of the personal data has been and will continue to be carried out in accordance with the relevant provisions of the applicable data protection law (and, where applicable, has been notified to the relevant authorities of the Member State where the data exporter is established) and does not violate the relevant provisions of that State;
+
+(b) that it has instructed and throughout the duration of the personal data processing services will instruct the data importer to process the personal data transferred only on the data exporter's behalf and in accordance with the applicable data protection law and the Clauses;
+
+(c) that the data importer will provide sufficient guarantees in respect of the technical and organisational security measures specified in Appendix 2 below;
+
+(d) that after assessment of the requirements of the applicable data protection law, the security measures are appropriate to protect personal data against accidental or unlawful destruction or accidental loss, alteration, unauthorised disclosure or access, in particular where the processing involves the transmission of data over a network, and against all other unlawful forms of processing, and that these measures ensure a level of security appropriate to the risks presented by the processing and the nature of the data to be protected having regard to the state of the art and the cost of their implementation;
+
+(e) that it will ensure compliance with the security measures;
+
+(f) that, if the transfer involves special categories of data, the data subject has been informed or will be informed before, or as soon as possible after, the transfer that its data could be transmitted to a third country not providing adequate protection within the meaning of the General Data Protection Regulation (EU 2016/679);
+
+(g) to forward any notification received from the data importer or any subprocessor pursuant to Clause 5(b) and Clause 8(3) to the data protection supervisory authority if the data exporter decides to continue the transfer or to lift the suspension;
+
+(h) to make available to the data subjects upon request a copy of the Clauses, with the exception of Appendix 2, and a summary description of the security measures, as well as a copy of any contract for subprocessing services which has to be made in accordance with the Clauses, unless the Clauses or the contract contain commercial information, in which case it may remove such commercial information;
+
+(i) that, in the event of subprocessing, the processing activity is carried out in accordance with Clause 11 by a subprocessor providing at least the same level of protection for the personal data and the rights of data subject as the data importer under the Clauses; and
+
+(j) that it will ensure compliance with Clause 4(a) to (i).
+
+#### Clause 5: Obligations of the data importer
+The data importer agrees and warrants:
+
+(a) to process the personal data only on behalf of the data exporter and in compliance with its instructions and the Clauses; if it cannot provide such compliance for whatever reasons, it agrees to inform promptly the data exporter of its inability to comply, in which case the data exporter is entitled to suspend the transfer of data and/or terminate the contract;
+
+(b) that it has no reason to believe that the legislation applicable to it prevents it from fulfilling the instructions received from the data exporter and its obligations under the contract and that in the event of a change in this legislation which is likely to have a substantial adverse effect on the warranties and obligations provided by the Clauses, it will promptly notify the change to the data exporter as soon as it is aware, in which case the data exporter is entitled to suspend the transfer of data and/or terminate the contract;
+
+(c) that it has implemented the technical and organisational security measures specified in Appendix 2 before processing the personal data transferred;
+
+(d) that it will promptly notify the data exporter about:
+
+ (i) any legally binding request for disclosure of the personal data by a law enforcement authority unless otherwise prohibited, such as a prohibition under criminal law to preserve the confidentiality of a law enforcement investigation,
+
+ (ii) any accidental or unauthorised access, and
+
+ (iii) any request received directly from the data subjects without responding to that request, unless it has been otherwise authorised to do so;
+
+(e) to deal promptly and properly with all inquiries from the data exporter relating to its processing of the personal data subject to the transfer and to abide by the advice of the supervisory authority with regard to the processing of the data transferred;
+
+(f) at the request of the data exporter to submit its data processing facilities for audit of the processing activities covered by the Clauses which shall be carried out by the data exporter or an inspection body composed of independent members and in possession of the required professional qualifications bound by a duty of confidentiality, selected by the data exporter, where applicable, in agreement with the supervisory authority;
+
+(g) to make available to the data subject upon request a copy of the Clauses, or any existing contract for subprocessing, unless the Clauses or contract contain commercial information, in which case it may remove such commercial information, with the exception of Appendix 2 which shall be replaced by a summary description of the security measures in those cases where the data subject is unable to obtain a copy from the data exporter;
+
+(h) that, in the event of subprocessing, it has previously informed the data exporter and obtained its prior written consent;
+
+(i) that the processing services by the subprocessor will be carried out in accordance with Clause 11; and
+
+(j) to send promptly a copy of any subprocessor agreement it concludes under the Clauses to the data exporter.
+
+#### Clause 6: Liability
+1. The parties agree that any data subject who has suffered damage as a result of any breach of the obligations referred to in Clause 3 or in Clause 11 by any party or subprocessor is entitled to receive compensation from the data exporter for the damage suffered.
+
+2. If a data subject is not able to bring a claim for compensation in accordance with paragraph 1 against the data exporter, arising out of a breach by the data importer or his subprocessor of any of their obligations referred to in Clause 3 or in Clause 11, because the data exporter has factually disappeared or ceased to exist in law or has become insolvent, the data importer agrees that the data subject may issue a claim against the data importer as if it were the data exporter, unless any successor entity has assumed the entire legal obligations of the data exporter by contract of by operation of law, in which case the data subject can enforce its rights against such entity.
+
+The data importer may not rely on a breach by a subprocessor of its obligations in order to avoid its own liabilities.
+
+3. If a data subject is not able to bring a claim against the data exporter or the data importer referred to in paragraphs 1 and 2, arising out of a breach by the subprocessor of any of their obligations referred to in Clause 3 or in Clause 11 because both the data exporter and the data importer have factually disappeared or ceased to exist in law or have become insolvent, the subprocessor agrees that the data subject may issue a claim against the data subprocessor with regard to its own processing operations under the Clauses as if it were the data exporter or the data importer, unless any successor entity has assumed the entire legal obligations of the data exporter or data importer by contract or by operation of law, in which case the data subject can enforce its rights against such entity. The liability of the subprocessor shall be limited to its own processing operations under the Clauses.
+
+#### Clause 7: Mediation and jurisdiction
+1. The data importer agrees that if the data subject invokes against it third-party beneficiary rights and/or claims compensation for damages under the Clauses, the data importer will accept the decision of the data subject:
+
+(a) to refer the dispute to mediation, by an independent person or, where applicable, by the supervisory authority;
+
+(b) to refer the dispute to the courts in the Member State in which the data exporter is established.
+
+2. The parties agree that the choice made by the data subject will not prejudice its substantive or procedural rights to seek remedies in accordance with other provisions of national or international law.
+
+#### Clause 8: Cooperation with supervisory authorities
+1. The data exporter agrees to deposit a copy of this contract with the supervisory authority if it so requests or if such deposit is required under the applicable data protection law.
+
+2. The parties agree that the supervisory authority has the right to conduct an audit of the data importer, and of any subprocessor, which has the same scope and is subject to the same conditions as would apply to an audit of the data exporter under the applicable data protection law.
+
+3. The data importer shall promptly inform the data exporter about the existence of legislation applicable to it or any subprocessor preventing the conduct of an audit of the data importer, or any subprocessor, pursuant to paragraph 2. In such a case the data exporter shall be entitled to take the measures foreseen in Clause 5 (b).
+
+#### Clause 9: Governing Law.
+The Clauses shall be governed by the law of the Member State in which the data exporter is established.
+
+#### Clause 10: Variation of the contract
+The parties undertake not to vary or modify the Clauses. This does not preclude the parties from adding clauses on business related issues where required as long as they do not contradict the Clause.
+
+#### Clause 11: Subprocessing
+1. The data importer shall not subcontract any of its processing operations performed on behalf of the data exporter under the Clauses without the prior written consent of the data exporter. Where the data importer subcontracts its obligations under the Clauses, with the consent of the data exporter, it shall do so only by way of a written agreement with the subprocessor which imposes the same obligations on the subprocessor as are imposed on the data importer under the Clauses. Where the subprocessor fails to fulfil its data protection obligations under such written agreement the data importer shall remain fully liable to the data exporter for the performance of the subprocessor's obligations under such agreement.
+
+2. The prior written contract between the data importer and the subprocessor shall also provide for a third-party beneficiary clause as laid down in Clause 3 for cases where the data subject is not able to bring the claim for compensation referred to in paragraph 1 of Clause 6 against the data exporter or the data importer because they have factually disappeared or have ceased to exist in law or have become insolvent and no successor entity has assumed the entire legal obligations of the data exporter or data importer by contract or by operation of law. Such third-party liability of the subprocessor shall be limited to its own processing operations under the Clauses.
+
+3. The provisions relating to data protection aspects for subprocessing of the contract referred to in paragraph 1 shall be governed by the law of the Member State in which the data exporter is established.
+
+4. The data exporter shall keep a list of subprocessing agreements concluded under the Clauses and notified by the data importer pursuant to Clause 5 (j), which shall be updated at least once a year. The list shall be available to the data exporter's data protection supervisory authority.
+
+#### Clause 12: Obligation after the termination of personal data processing services
+1. The parties agree that on the termination of the provision of data processing services, the data importer and the subprocessor shall, at the choice of the data exporter, return all the personal data transferred and the copies thereof to the data exporter or shall destroy all the personal data and certify to the data exporter that it has done so, unless legislation imposed upon the data importer prevents it from returning or destroying all or part of the personal data transferred. In that case, the data importer warrants that it will guarantee the confidentiality of the personal data transferred and will not actively process the personal data transferred anymore.
+
+2. The data importer and the subprocessor warrant that upon request of the data exporter and/or of the supervisory authority, it will submit its data processing facilities for an audit of the measures referred to in paragraph 1.
+
+### Appendix 1 to the Standard Contractual Clauses
+Data exporter: Customer is the data exporter.
+
+**Data importer:** The data importer is GitHub, Inc., a global producer of software and services.
+
+**Data subjects:** Data subjects include the data exporter’s representatives and end-users including employees, contractors, collaborators, and customers of the data exporter. Data subjects may also include individuals attempting to communicate or transfer personal information to users of the services provided by data importer. GitHub acknowledges that, depending on Customer’s use of the Online Service, Customer may elect to include personal data from any of the following types of data subjects in the Customer Personal Data:
+
+- Employees, contractors and temporary workers (current, former, prospective) of data exporter;
+- Dependents of the above;
+- Data exporter's collaborators/contact persons (natural persons) or employees, contractors or temporary workers of legal entity collaborators/contact persons (current, prospective, former);
+- Users (e.g., customers, clients, patients, visitors, etc.) and other data subjects that are users of data exporter's services;
+- Partners, stakeholders or individuals who actively collaborate, communicate or otherwise interact with employees of the data exporter and/or use communication tools such as apps and websites provided by the data exporter;
+- Stakeholders or individuals who passively interact with data exporter (e.g., because they are the subject of an investigation, research or mentioned in documents or correspondence from or to the data exporter); or
+- Professionals with professional privilege (e.g., doctors, lawyers, notaries, religious workers, etc.).
+
+**Categories of data:** The personal data transferred that is included in e-mail, documents and other data in an electronic form in the context of the Online Service. GitHub acknowledges that, depending on Customer’s use of the Online Service, Customer may elect to include personal data from any of the following categories in the Customer Personal Data:
+- Authentication data (for example, username, email, password);
+- Contact information (for example, email);
+- Unique identification numbers and signatures (IP addresses, unique identifier in tracking cookies or similar technology).
+- Other unique identifying information. Data subjects may include more data such as real names, avatar images, and other personal information;
+
+**Special categories of data (if appropriate):** The data importer does not intentionally collect or process any special categories of data in carrying out its services to the data exporter.
+
+However, because the data importer provides storage services and does not control the categories of data it stores, the data exporter may choose to transfer special categories of data. Consequently, the data exporter is solely responsible for ensuring that it complies with all obligations imposed by applicable laws and regulations relating to the collection and processing of any special categories of data, including obtaining the explicit consent of the data subject prior to processing sensitive personal data.
+
+**Processing operations:** The personal data transferred will be subject to the following basic processing activities:
+GitHub uses personal data for the limited purposes set forth in the GitHub Privacy Statement, available at https://help.github.com/articles/github-privacy-statement/, and the “Data Processing” section of the DPA.
+
+**Subcontractors:** In accordance with the DPA, the data importer may hire other companies to provide limited services on data importer’s behalf, such as providing customer support. Any such subcontractors will be permitted to obtain Customer Personal Data only to deliver the services the data importer has retained them to provide, and they are prohibited from using Customer Personal Data for any other purpose.
+
+### Appendix 2 to the Standard Contractual Clauses
+Description of the technical and organizational security measures implemented by the data importer in accordance with Clauses 4(d) and 5(c):
+
+**1. Personnel.** Data importer’s personnel will not process Customer Personal Data without authorization. Personnel are obligated to maintain the confidentiality of any Customer Personal Data and this obligation continues even after their engagement ends.
+
+**2. Data Privacy Contact.** The data privacy officer of the data importer can be reached at the following address:
+GitHub, Inc.
+Attn: Privacy
+88 Colin P. Kelly Jr. Street
+San Francisco, CA 94107 USA
+
+**3. Technical and Organization Measures.** The data importer has implemented and will maintain appropriate technical and organizational measures, internal controls, and information security routines intended to protect Customer Personal Data, as defined in the GitHub Security Exhibit, against accidental loss, destruction, or alteration; unauthorized disclosure or access; or unlawful destruction as follows: The technical and organizational measures, internal controls, and information security routines set forth in the GitHub Security Exhibit are hereby incorporated into this Appendix 2 by this reference and are binding on the data importer as if they were set forth in this Appendix 2 in their entirety.
+Signature of GitHub, Inc. appears below.
+
+Signing the Standard Contractual Clauses, Appendix 1 and Appendix 2 on behalf of the data importer
+
+
+
+Lynn Hashimoto, Head of Product & Regulatory Legal
+
+GitHub, Inc.
+
+## SECURITY EXHIBIT
+
+### 1. Information Security Program.
+
+#### 1.1 Security Management.
+GitHub will implement and maintain appropriate technical and organizational measures to protect Customer Content and Protected Data against accidental or unlawful destruction, loss, alteration, unauthorized disclosure of, or access to, personal data transmitted, stored or otherwise processed (“**Security Program**”). Those measures shall be set forth in a GitHub Security Policy. GitHub will provide written descriptions of the security controls and other information reasonably requested by Customer regarding GitHub’s security practices and policies for the Online Service.
+
+a. Operational Policy. GitHub maintains security documents describing its security measures and the relevant procedures and responsibilities of its personnel who have access to Customer Content and Protected Data.
+
+b. Security Training. GitHub informs its personnel about relevant security procedures and their respective roles. GitHub also informs its personnel of possible consequences of breaching the security rules and procedures. GitHub will only use anonymous data in training.
+
+#### 1.2 Security Incident Management.
+GitHub will provide a Security incident management program for the Online Service as follows:
+
+a. Security Availability and Escalation. GitHub will maintain appropriate security contact and escalation processes on a 24-hours-per-day, 7-days-per-week basis to ensure customers and employees can submit issues to the GitHub Security team.
+
+b. Incident Response. If GitHub becomes aware of a breach of security leading to the accidental or unlawful destruction, loss, alteration, unauthorized disclosure of, or access to Customer Data or Personal Data (each a "Security Incident"), GitHub will promptly and without undue delay (1) notify Customer of the Security Incident; (2) investigate the Security Incident and provide Customer with detailed information about the Security Incident; (3) take reasonable steps to mitigate the effects and to minimize any damage resulting from the Security Incident.
+
+c. Notification. Notification(s) of Security Incidents will be delivered to one or more of Customer's administrators by any means GitHub selects. It is Customer's sole responsibility to ensure Customer's administrators monitor for and respond to any notifications. Customer is solely responsible for complying with its obligations under incident notification laws applicable to Customer and fulfilling any third-party notification obligations related to any Security Incident.
+
+d. Reasonable Assistance. GitHub will make commercially reasonable efforts to assist Customer in fulfilling Customer's obligation under applicable law or regulation to notify the relevant supervisory authority and data subjects about such Security Incident.
+
+#### 1.3 Due Diligence over Subcontractors and Vendors.
+GitHub will maintain appropriate due diligence when utilizing subcontractors and vendors. GitHub will maintain vendor assessment reports and any assessment work for a minimum of three years.
+
+#### 1.4 Physical and Environmental Safeguards.
+a. Physical Access to Facilities. GitHub limits access to facilities where information systems that process Customer Content and Protected Data are located to identified authorized individuals.
+
+b. Physical Access to Components. GitHub maintains records of the incoming and outgoing media containing Customer Content and Protected Data, including the kind of media, the authorized sender/recipients, date and time, the number of media and the types of Customer Content and Protected Data they contain.
+
+c. Protection from Disruptions. GitHub uses industry standard systems to protect against loss of data due to power supply failure or line interference.
+
+#### 2. Requests for Information.
+Upon Customer's written request and no more than once annually, GitHub will respond to one request for information to assess security and compliance risk-related information. The response will be provided in writing within thirty days of receipt of the request, pending needed clarifications of any request.
+
+#### 3. Cooperation with Regulatory Audits.
+Should Customer realize a regulatory audit or an audit in response to a Supervisory Authority that requires participation from GitHub, GitHub will fully cooperate with related requests by providing access to relevant knowledgeable personnel, documentation, and application software. Customer has the following responsibilities regarding any such regulatory or Supervisory Authority audits:
+
+a. Customer must ensure use of an independent third party (meaning the regulator or regulator's delegate), and that findings and data not relevant to Customer are restricted from Customer’s access.
+
+b. Notification of such audit must be written and provided to GitHub in a timely fashion, pending regulator notification, and in a manner that allows for appropriate personnel to be made available to assist. Where regulators provide no advance notice to Customer of audit or investigation, GitHub will respond in as timely a fashion as required by regulators.
+
+c. Any third party auditor must disclose to GitHub any findings and recommended actions where allowed by the regulator.
+
+d. In the event of a regulatory audit, access will be permitted only during regular business hours, Pacific time.
+
+e. To the extent permitted by law, Customer must keep confidential any information gathered through any such audit of GitHub that, by its nature, should be confidential.
+
diff --git a/content/github/site-policy/github-ae-product-specific-terms.md b/content/github/site-policy/github-ae-product-specific-terms.md
new file mode 100644
index 000000000000..52d39d2e3812
--- /dev/null
+++ b/content/github/site-policy/github-ae-product-specific-terms.md
@@ -0,0 +1,58 @@
+---
+title: GitHub AE Product Specific Terms
+versions:
+ free-pro-team: '*'
+redirect_from:
+ - /github/site-policy/ghem-supplemental-terms-for-microsoft-volume-licensing
+---
+
+Version Effective Date: November 1, 2020
+
+The Agreement consists of these GitHub AE Product Specific Terms, the General Terms that Customer accepted, and any additional terms GitHub or its Affiliates present when an order is placed.
+
+### 1. Accounts.
+
+**Account Responsibility.** Customer controls and is responsible for End User accounts and Content.
+
+**Account Security.** Customer is responsible for maintaining the security of its account login credentials.
+
+**Use Policies.** Customer’s End Users must comply with the Acceptable Use Policy.
+
+**Suspension.** GitHub may suspend use of the Online Service during any period of Customer’s material breach.
+
+**Access.** GitHub does not access Customer Content unless required for support matters or security purposes.
+
+**DMCA.** GitHub has a Digital Millennium Copyright Act (DMCA) Takedown Policy which applies to copyright infringement claims.
+
+### 2. Content.
+
+**Ownership of Content.** Customer owns Content it creates and will fully comply with any third-party licenses relating to Content that Customer posts.
+
+**License Grant to GitHub.** Unless Customer Content comes with a separate license granting GitHub the rights it needs to run the Online Service, Customer grants to GitHub the right to use Customer Content and make incidental copies as necessary to provide the Online Service or support, or for security reasons. In addition, GitHub may be compelled by law to disclose Customer Content.
+
+### 3. Non-GitHub Products.
+GitHub may make non-GitHub products available through the Online Service. If Customer uses any non-GitHub products with the Online Service, Customer may not do so in any way that would subject GitHub’s intellectual property to obligations beyond those expressly included in the Agreement. GitHub assumes no responsibility or liability for any non-GitHub products. Customer’s use of non-GitHub products is governed by the terms between Customer and the publisher of the non-GitHub products (if any).
+
+### 4. Support and SLA.
+The Online Service includes Support and the SLA.
+
+### 5. Data Protection and Security.
+The terms of the Data Protection Agreement apply to the Online Service.
+
+### 6. Notices.
+Notices to GitHub must be sent to: GitHub, Inc. Attn: Legal Dept., 88 Colin P. Kelly St, San Francisco, CA 94107 USA.
+
+### 7. Definitions.
+“**Acceptable Use Policy**” means, when purchasing from GitHub, the Acceptable Use Policy available on Site-Policy and when purchasing from Microsoft, the Acceptable Use Policy in the Microsoft Online Services Terms.
+
+“**Content**” means text, data, software, images and any other materials that are displayed or otherwise made available through the Online Service.
+
+“**Customer Content**” means Content that Customer creates, owns, or to which Customer holds the rights.
+
+“**Data Protection Agreement**” means the GitHub AE Data Protection Agreement, available on https://docs.github.com/github/site-policy.
+
+“**Digital Millennium Copyright Act Takedown Policy**” means GitHub’s process for handling notices of copyright infringement, available on https://docs.github.com/github/site-policy.
+
+“**SLA**” means GitHub’s uptime commitment for the Online Service, available on https://docs.github.com/github/site-policy.
+
+“**Support**” means GitHub’s Premium Plus Support program, further described on https://docs.github.com/github/site-policy.
diff --git a/content/github/site-policy/github-enterprise-subscription-agreement.md b/content/github/site-policy/github-enterprise-subscription-agreement.md
index 282aaae2b5e4..f7dd7bff7b43 100644
--- a/content/github/site-policy/github-enterprise-subscription-agreement.md
+++ b/content/github/site-policy/github-enterprise-subscription-agreement.md
@@ -330,7 +330,7 @@ The look and feel of the Service is copyright © GitHub, Inc. All rights reserve
#### 3.5.2 Copyright Infringement and DMCA Policy.
-If Customer is a copyright owner and believes that Content on the Service violates Customer’s copyright, Customer may contact GitHub in accordance with GitHub's [Digital Millenium Copyright Act Policy](https://github.com/contact/dmca) by notifying GitHub via its [DMCA Form](https://github.com/contact/dmca-notice) or by emailing copyright@github.com.
+If Customer is a copyright owner and believes that Content on the Service violates Customer’s copyright, Customer may contact GitHub in accordance with GitHub's [Digital Millennium Copyright Act Policy](https://github.com/contact/dmca) by notifying GitHub via its [DMCA Form](https://github.com/contact/dmca-notice) or by emailing copyright@github.com.
#### 3.5.3 GitHub Trademarks and Logos.
diff --git a/content/github/site-policy/github-insights-and-data-protection-for-your-organization.md b/content/github/site-policy/github-insights-and-data-protection-for-your-organization.md
index c079aa0894c1..52a69a7135ca 100644
--- a/content/github/site-policy/github-insights-and-data-protection-for-your-organization.md
+++ b/content/github/site-policy/github-insights-and-data-protection-for-your-organization.md
@@ -5,7 +5,6 @@ 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: '*'
---
diff --git a/content/github/site-policy/github-privacy-statement.md b/content/github/site-policy/github-privacy-statement.md
index 849628ab62ae..81ff6378d189 100644
--- a/content/github/site-policy/github-privacy-statement.md
+++ b/content/github/site-policy/github-privacy-statement.md
@@ -144,7 +144,7 @@ For more information about our disclosure in response to legal requests, see our
We may share User Personal Information if we are involved in a merger, sale, or acquisition of corporate entities or business units. If any such change of ownership happens, we will ensure that it is under terms that preserve the confidentiality of User Personal Information, and we will notify you on our Website or by email before any transfer of your User Personal Information. The organization receiving any User Personal Information will have to honor any promises we made in our Privacy Statement or Terms of Service.
#### Aggregate, non-personally identifying information
-We share certain aggregated, non-personally identifying information with others about how our users, collectively, use GitHub, or how our users respond to our other offerings, such as our conferences or events. For example, [we may compile statistics on the open source activity across GitHub](https://octoverse.github.com/).
+We share certain aggregated, non-personally identifying information with others about how our users, collectively, use GitHub, or how our users respond to our other offerings, such as our conferences or events.
We **do not** sell your User Personal Information for monetary or other consideration.
diff --git a/content/github/site-policy/github-supplemental-terms-for-microsoft-volume-licensing.md b/content/github/site-policy/github-supplemental-terms-for-microsoft-volume-licensing.md
index cd043311eff5..523adeb925c0 100644
--- a/content/github/site-policy/github-supplemental-terms-for-microsoft-volume-licensing.md
+++ b/content/github/site-policy/github-supplemental-terms-for-microsoft-volume-licensing.md
@@ -175,7 +175,7 @@ The look and feel of the Service is copyright © GitHub, Inc. All rights reserve
#### 2.5.2 Copyright Infringement and DMCA Policy.
-If Customer is a copyright owner and believes that Content on the Service violates Customer’s copyright, Customer may contact GitHub in accordance with GitHub's [Digital Millenium Copyright Act Policy](https://github.com/contact/dmca) by notifying GitHub via its [DMCA Form](https://github.com/contact/dmca-notice) or by emailing copyright@github.com.
+If Customer is a copyright owner and believes that Content on the Service violates Customer’s copyright, Customer may contact GitHub in accordance with GitHub's [Digital Millennium Copyright Act Policy](https://github.com/contact/dmca) by notifying GitHub via its [DMCA Form](https://github.com/contact/dmca-notice) or by emailing copyright@github.com.
#### 2.5.3 GitHub Trademarks and Logos.
diff --git a/content/github/site-policy/guidelines-for-legal-requests-of-user-data.md b/content/github/site-policy/guidelines-for-legal-requests-of-user-data.md
index 5336dba56411..110de95ccc2f 100644
--- a/content/github/site-policy/guidelines-for-legal-requests-of-user-data.md
+++ b/content/github/site-policy/guidelines-for-legal-requests-of-user-data.md
@@ -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
-
-
**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.
diff --git a/content/github/site-policy/index.md b/content/github/site-policy/index.md
index 7154afd2f75c..2fb09f3fabff 100644
--- a/content/github/site-policy/index.md
+++ b/content/github/site-policy/index.md
@@ -16,6 +16,8 @@ versions:
{% link_in_list /github-data-protection-addendum %}
{% link_in_list /global-privacy-practices %}
{% link_in_list /github-enterprise-server-license-agreement %}
+{% link_in_list /github-ae-data-protection-agreement %}
+{% link_in_list /github-ae-product-specific-terms %}
{% link_in_list /github-enterprise-service-level-agreement %}
{% link_in_list /github-connect-addendum-to-the-github-enterprise-license-agreement %}
{% link_in_list /github-supplemental-terms-for-microsoft-volume-licensing %}
diff --git a/content/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository.md b/content/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository.md
index fe736eb9c6dd..dc1c7cecd526 100644
--- a/content/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository.md
+++ b/content/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository.md
@@ -10,7 +10,7 @@ versions:
### About data use for your private repository
-When you enable data use for your private repository, you'll be able to access the dependency graph, where you can track your repository's dependencies and receive {% data variables.product.prodname_dependabot_short %} alerts when {% data variables.product.product_name %} detects vulnerable dependencies. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies#github-dependabot-alerts-for-vulnerable-dependencies)."
+When you enable data use for your private repository, you'll be able to access the dependency graph, where you can track your repository's dependencies and receive {% data variables.product.prodname_dependabot_alerts %} when {% data variables.product.product_name %} detects vulnerable dependencies. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies#dependabot-alerts-for-vulnerable-dependencies)."
### Enabling or disabling data use features
diff --git a/content/github/using-git/about-git-rebase.md b/content/github/using-git/about-git-rebase.md
index e3152f07bb9a..83cdd80be5cf 100644
--- a/content/github/using-git/about-git-rebase.md
+++ b/content/github/using-git/about-git-rebase.md
@@ -8,6 +8,7 @@ intro: 'The `git rebase` command allows you to easily change a series of commits
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/using-git/about-git-subtree-merges.md b/content/github/using-git/about-git-subtree-merges.md
index 65964f52f0e5..57a827365eb5 100644
--- a/content/github/using-git/about-git-subtree-merges.md
+++ b/content/github/using-git/about-git-subtree-merges.md
@@ -8,6 +8,7 @@ intro: 'If you need to manage multiple projects within a single repository, you
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Typically, a subtree merge is used to contain a repository within a repository. The "subrepository" is stored in a folder of the main repository.
@@ -104,5 +105,5 @@ $ git pull -s subtree spoon-knife main
### Further reading
-- [The "Subtree Merging" chapter from the _Pro Git_ book](https://git-scm.com/book/en/Git-Tools-Subtree-Merging)
+- [The "Advanced Merging" chapter from the _Pro Git_ book](https://git-scm.com/book/en/v2/Git-Tools-Advanced-Merging)
- "[How to use the subtree merge strategy](https://www.kernel.org/pub/software/scm/git/docs/howto/using-merge-subtree.html)"
diff --git a/content/github/using-git/about-remote-repositories.md b/content/github/using-git/about-remote-repositories.md
index befcceca2777..9706800ba8e7 100644
--- a/content/github/using-git/about-remote-repositories.md
+++ b/content/github/using-git/about-remote-repositories.md
@@ -8,6 +8,7 @@ intro: 'GitHub''s collaborative approach to development depends on publishing co
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
A remote URL is Git's fancy way of saying "the place where your code is stored."
diff --git a/content/github/using-git/adding-a-remote.md b/content/github/using-git/adding-a-remote.md
index 6edb29843060..ce69b353b00f 100644
--- a/content/github/using-git/adding-a-remote.md
+++ b/content/github/using-git/adding-a-remote.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
The `git remote add` command takes two arguments:
diff --git a/content/github/using-git/associating-text-editors-with-git.md b/content/github/using-git/associating-text-editors-with-git.md
index fa4e879af067..dbde6b4d3193 100644
--- a/content/github/using-git/associating-text-editors-with-git.md
+++ b/content/github/using-git/associating-text-editors-with-git.md
@@ -9,6 +9,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% mac %}
diff --git a/content/github/using-git/caching-your-github-credentials-in-git.md b/content/github/using-git/caching-your-github-credentials-in-git.md
index 4756ae184787..cf1e88cd495e 100644
--- a/content/github/using-git/caching-your-github-credentials-in-git.md
+++ b/content/github/using-git/caching-your-github-credentials-in-git.md
@@ -8,6 +8,7 @@ intro: 'If you''re [cloning {% data variables.product.product_name %} repositori
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
If you clone {% data variables.product.product_name %} repositories using SSH, then you authenticate using an SSH key instead of using other credentials. For information about setting up an SSH connection, see "[Generating an SSH Key](/articles/generating-an-ssh-key)."
diff --git a/content/github/using-git/changing-a-remotes-url.md b/content/github/using-git/changing-a-remotes-url.md
index cb19ad865f68..885cc6b798e3 100644
--- a/content/github/using-git/changing-a-remotes-url.md
+++ b/content/github/using-git/changing-a-remotes-url.md
@@ -7,6 +7,7 @@ intro: The `git remote set-url` command changes an existing remote repository UR
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% tip %}
@@ -50,10 +51,9 @@ git@{% data variables.command_line.codeblock %}:USERNAME/REPOSITORY
> origin https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY.git (push)
```
-The next time you `git fetch`, `git pull`, or `git push` to the remote repository, you'll be asked for your GitHub username and password.
+The next time you `git fetch`, `git pull`, or `git push` to the remote repository, you'll be asked for your GitHub username and password. {% data reusables.user_settings.password-authentication-deprecation %}
-- If you have [two-factor authentication](/articles/securing-your-account-with-two-factor-authentication-2fa) enabled, you must [create a personal access token](/github/authenticating-to-github/creating-a-personal-access-token) to use instead of your GitHub password.
-- You can [use a credential helper](/github/using-git/caching-your-github-credentials-in-git) so Git will remember your GitHub username and password every time it talks to GitHub.
+You can [use a credential helper](/github/using-git/caching-your-github-credentials-in-git) so Git will remember your GitHub username and personal access token every time it talks to GitHub.
### Switching remote URLs from HTTPS to SSH
diff --git a/content/github/using-git/configuring-git-to-handle-line-endings.md b/content/github/using-git/configuring-git-to-handle-line-endings.md
index 0c1601dab80d..0c4740c740bc 100644
--- a/content/github/using-git/configuring-git-to-handle-line-endings.md
+++ b/content/github/using-git/configuring-git-to-handle-line-endings.md
@@ -9,6 +9,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Every time you press return on your keyboard you insert an invisible character called a line ending. Different operating systems handle line endings differently.
diff --git a/content/github/using-git/dealing-with-non-fast-forward-errors.md b/content/github/using-git/dealing-with-non-fast-forward-errors.md
index 84fcb3d3c645..e1ed31f144a3 100644
--- a/content/github/using-git/dealing-with-non-fast-forward-errors.md
+++ b/content/github/using-git/dealing-with-non-fast-forward-errors.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
If another person has pushed to the same branch as you, Git won't be able to push your changes:
diff --git a/content/github/using-git/getting-changes-from-a-remote-repository.md b/content/github/using-git/getting-changes-from-a-remote-repository.md
index 653661d216d0..5512fda33b2e 100644
--- a/content/github/using-git/getting-changes-from-a-remote-repository.md
+++ b/content/github/using-git/getting-changes-from-a-remote-repository.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
These commands are very useful when interacting with [a remote repository](/articles/about-remote-repositories). `clone` and `fetch` download remote code from a repository's remote URL to your local computer, `merge` is used to merge different people's work together with yours, and `pull` is a combination of `fetch` and `merge`.
diff --git a/content/github/using-git/getting-started-with-git-and-github.md b/content/github/using-git/getting-started-with-git-and-github.md
index 4b31343ae613..416697aea39a 100644
--- a/content/github/using-git/getting-started-with-git-and-github.md
+++ b/content/github/using-git/getting-started-with-git-and-github.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/using-git/git-workflows.md b/content/github/using-git/git-workflows.md
index 136cbca51cdc..6c781948b864 100644
--- a/content/github/using-git/git-workflows.md
+++ b/content/github/using-git/git-workflows.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
You can adopt the {% data variables.product.prodname_dotcom %} flow method to standardize how your team functions and collaborates on {% data variables.product.prodname_dotcom %}. For more information, see "[GitHub flow](/github/collaborating-with-issues-and-pull-requests/github-flow)" and "[Understanding the GitHub flow](http://guides.github.com/overviews/flow/)" in the {% data variables.product.prodname_dotcom %} Guides.
diff --git a/content/github/using-git/ignoring-files.md b/content/github/using-git/ignoring-files.md
index 1339137d66be..bca201ffd3d0 100644
--- a/content/github/using-git/ignoring-files.md
+++ b/content/github/using-git/ignoring-files.md
@@ -8,6 +8,7 @@ intro: 'You can configure Git to ignore files you don''t want to check in to {%
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Configuring ignored files for a single repository
diff --git a/content/github/using-git/index.md b/content/github/using-git/index.md
index abe69c20f752..4c9e0f86c9a4 100644
--- a/content/github/using-git/index.md
+++ b/content/github/using-git/index.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/using-git/learning-about-git.md b/content/github/using-git/learning-about-git.md
index 538320413716..8fc7d4818e3c 100644
--- a/content/github/using-git/learning-about-git.md
+++ b/content/github/using-git/learning-about-git.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/using-git/managing-remote-repositories.md b/content/github/using-git/managing-remote-repositories.md
index bbcaba6f79b7..88eb0725486d 100644
--- a/content/github/using-git/managing-remote-repositories.md
+++ b/content/github/using-git/managing-remote-repositories.md
@@ -10,5 +10,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/using-git/pushing-commits-to-a-remote-repository.md b/content/github/using-git/pushing-commits-to-a-remote-repository.md
index 16c6cf98a083..d92003f955c1 100644
--- a/content/github/using-git/pushing-commits-to-a-remote-repository.md
+++ b/content/github/using-git/pushing-commits-to-a-remote-repository.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
The `git push` command takes two arguments:
@@ -110,3 +111,4 @@ For more information on working with forks, see "[Syncing a fork](/articles/sync
- [`git remote` man page](https://git-scm.com/docs/git-remote.html)
- "[Git cheatsheet](/articles/git-cheatsheet)"
- "[Git workflows](/articles/git-workflows)"
+- "[Git Handbook](https://guides.github.com/introduction/git-handbook/)"
diff --git a/content/github/using-git/removing-a-remote.md b/content/github/using-git/removing-a-remote.md
index e426d9c4e8ee..1c7337e7b2f7 100644
--- a/content/github/using-git/removing-a-remote.md
+++ b/content/github/using-git/removing-a-remote.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
The `git remote rm` command takes one argument:
diff --git a/content/github/using-git/renaming-a-remote.md b/content/github/using-git/renaming-a-remote.md
index b4f85e17b65a..12b50588bf76 100644
--- a/content/github/using-git/renaming-a-remote.md
+++ b/content/github/using-git/renaming-a-remote.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
The `git remote rename` command takes two arguments:
diff --git a/content/github/using-git/resolving-merge-conflicts-after-a-git-rebase.md b/content/github/using-git/resolving-merge-conflicts-after-a-git-rebase.md
index c1319bff007d..f50d74b9c6d3 100644
--- a/content/github/using-git/resolving-merge-conflicts-after-a-git-rebase.md
+++ b/content/github/using-git/resolving-merge-conflicts-after-a-git-rebase.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/using-git/setting-your-username-in-git.md b/content/github/using-git/setting-your-username-in-git.md
index 82e47d0917fc..6622992fa3f2 100644
--- a/content/github/using-git/setting-your-username-in-git.md
+++ b/content/github/using-git/setting-your-username-in-git.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
You can change the name that is associated with your Git commits using the `git config` command. The new name you set will be visible in any future commits you push to {% data variables.product.product_name %} from the command line. If you'd like to keep your real name private, you can use any text as your Git username.
diff --git a/content/github/using-git/splitting-a-subfolder-out-into-a-new-repository.md b/content/github/using-git/splitting-a-subfolder-out-into-a-new-repository.md
index 99e981512049..2182b563a992 100644
--- a/content/github/using-git/splitting-a-subfolder-out-into-a-new-repository.md
+++ b/content/github/using-git/splitting-a-subfolder-out-into-a-new-repository.md
@@ -7,6 +7,7 @@ intro: You can turn a folder within a Git repository into a brand new repository
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
If you create a new clone of the repository, you won't lose any of your Git history or changes when you split a folder into a separate repository.
diff --git a/content/github/using-git/updating-credentials-from-the-macos-keychain.md b/content/github/using-git/updating-credentials-from-the-macos-keychain.md
index 7dcf8250da2d..6e7675851231 100644
--- a/content/github/using-git/updating-credentials-from-the-macos-keychain.md
+++ b/content/github/using-git/updating-credentials-from-the-macos-keychain.md
@@ -1,12 +1,13 @@
---
title: Updating credentials from the macOS Keychain
-intro: 'You''ll need to update your saved credentials in the `git-credential-osxkeychain` helper if you change your username, password, or personal access token on {% data variables.product.product_name %}.'
+intro: 'You''ll need to update your saved credentials in the `git-credential-osxkeychain` helper if you change your{% if currentVersion != "github-ae@latest" %} username, password, or{% endif %} personal access token on {% data variables.product.product_name %}.'
redirect_from:
- /articles/updating-credentials-from-the-osx-keychain
- /github/using-git/updating-credentials-from-the-osx-keychain
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.user_settings.password-authentication-deprecation %}
@@ -17,15 +18,11 @@ versions:
2. In Keychain Access, search for **{% data variables.command_line.backticks %}**.
3. Find the "internet password" entry for `{% data variables.command_line.backticks %}`.
- 
4. Edit or delete the entry accordingly.
### Deleting your credentials via the command line
-Through the command line, you can use the credential helper directly to erase the
-keychain entry.
-
-To do this, type the following command:
+Through the command line, you can use the credential helper directly to erase the keychain entry.
```shell
$ git credential-osxkeychain erase
@@ -34,9 +31,7 @@ protocol=https
> [Press Return]
```
-If it's successful, nothing will print out. To test that it works, try and clone
-a repository from {% data variables.product.product_location %}. If you are prompted for a password, the keychain
-entry was deleted.
+If it's successful, nothing will print out. To test that it works, try and clone a repository from {% data variables.product.product_location %}. If you are prompted for a password, the keychain entry was deleted.
### Further reading
diff --git a/content/github/using-git/using-advanced-git-commands.md b/content/github/using-git/using-advanced-git-commands.md
index 8d389b6c675a..5a89791356fe 100644
--- a/content/github/using-git/using-advanced-git-commands.md
+++ b/content/github/using-git/using-advanced-git-commands.md
@@ -10,5 +10,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/using-git/using-common-git-commands.md b/content/github/using-git/using-common-git-commands.md
index 723eb414d7ad..8370d6f9d776 100644
--- a/content/github/using-git/using-common-git-commands.md
+++ b/content/github/using-git/using-common-git-commands.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/using-git/using-git-rebase-on-the-command-line.md b/content/github/using-git/using-git-rebase-on-the-command-line.md
index 2bdf61c4abf9..8e4f4be33043 100644
--- a/content/github/using-git/using-git-rebase-on-the-command-line.md
+++ b/content/github/using-git/using-git-rebase-on-the-command-line.md
@@ -7,6 +7,7 @@ intro: Here's a short tutorial on using `git rebase` on the command line.
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
In this example, we will cover all of the `git rebase` commands available, except for `exec`.
diff --git a/content/github/using-git/which-remote-url-should-i-use.md b/content/github/using-git/which-remote-url-should-i-use.md
index 1d90c78f9079..ea5b11d82042 100644
--- a/content/github/using-git/which-remote-url-should-i-use.md
+++ b/content/github/using-git/which-remote-url-should-i-use.md
@@ -7,6 +7,7 @@ intro: 'There are several ways to clone repositories available on {% data variab
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
When you view a repository while signed in to your account, the URLs you can use to clone the project onto your computer are available below the repository details:
@@ -47,7 +48,7 @@ When you `git clone`, `git fetch`, `git pull`, or `git push` to a remote reposit
{% endtip %}
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %}
### Cloning with {% data variables.product.prodname_cli %}
@@ -55,11 +56,13 @@ You can also install {% data variables.product.prodname_cli %} to use {% data va
{% endif %}
+{% if currentVersion != "github-ae@latest" %}
### Cloning with Subversion
You can also use a [Subversion](https://subversion.apache.org/) client to access any repository on {% data variables.product.prodname_dotcom %}. Subversion offers a different feature set than Git. For more information, see "[What are the differences between Subversion and Git?](/github/importing-your-projects-to-github/what-are-the-differences-between-subversion-and-git)"
You can also access repositories on {% data variables.product.prodname_dotcom %} from Subversion clients. For more information, see "[Support for Subversion clients](/github/importing-your-projects-to-github/support-for-subversion-clients)."
+{% endif %}
### Further reading
diff --git a/content/github/using-git/why-is-git-always-asking-for-my-password.md b/content/github/using-git/why-is-git-always-asking-for-my-password.md
index 300725069b9d..604935773617 100644
--- a/content/github/using-git/why-is-git-always-asking-for-my-password.md
+++ b/content/github/using-git/why-is-git-always-asking-for-my-password.md
@@ -6,14 +6,14 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
-Using an HTTPS remote URL has some advantages compared with using SSH. It's easier to set up than SSH, and usually works through strict firewalls and proxies. However, it also prompts you to enter your GitHub credentials every time you pull or push a repository.
+Using an HTTPS remote URL has some advantages compared with using SSH. It's easier to set up than SSH, and usually works through strict firewalls and proxies. However, it also prompts you to enter your {% data variables.product.product_name %} credentials every time you pull or push a repository.
-You can avoid being prompted for your password by configuring Git to [cache your credentials](/github/using-git/caching-your-github-credentials-in-git) for you. {% data reusables.user_settings.password-authentication-deprecation %}
-
-Once you've configured credential caching, Git automatically uses your cached personal access token in place of a password when you pull or push a repository using HTTPS.
+{% data reusables.user_settings.password-authentication-deprecation %}
+You can avoid being prompted for your password by configuring Git to [cache your credentials](/github/using-git/caching-your-github-credentials-in-git) for you. Once you've configured credential caching, Git automatically uses your cached personal access token when you pull or push a repository using HTTPS.
### Further reading
diff --git a/content/github/visualizing-repository-data-with-graphs/about-repository-graphs.md b/content/github/visualizing-repository-data-with-graphs/about-repository-graphs.md
index f536b35100ff..10a714d35b4c 100644
--- a/content/github/visualizing-repository-data-with-graphs/about-repository-graphs.md
+++ b/content/github/visualizing-repository-data-with-graphs/about-repository-graphs.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
A repository's graphs give you information on {% if currentVersion == "free-pro-team@latest" %} traffic, projects that depend on the repository,{% endif %} contributors and commits to the repository, and a repository's forks and network. If you maintain a repository, you can use this data to get a better understanding of who's using your repository and why they're using it.
diff --git a/content/github/visualizing-repository-data-with-graphs/about-the-dependency-graph.md b/content/github/visualizing-repository-data-with-graphs/about-the-dependency-graph.md
index 069c3b38eda2..ee6e10f5bcb4 100644
--- a/content/github/visualizing-repository-data-with-graphs/about-the-dependency-graph.md
+++ b/content/github/visualizing-repository-data-with-graphs/about-the-dependency-graph.md
@@ -47,9 +47,9 @@ You can use the dependency graph to:
{% if currentVersion == "free-pro-team@latest" %}To generate a dependency graph, {% data variables.product.product_name %} needs read-only access to the dependency manifest and lock files for a repository. The dependency graph is automatically generated for all public repositories and you can choose to enable it for private repositories. For information about enabling or disabling it for private repositories, see "[Exploring the dependencies of a repository](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository)."{% endif %}
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_gt "enterprise-server@2.21" %}If the dependency graph is not available in your system, your site administrator can enable the dependency graph and {% data variables.product.prodname_dependabot_short %} alerts. For more information, see "[Enabling alerts for vulnerable dependencies on {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server)."{% endif %}
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" %}If the dependency graph is not available in your system, your site administrator can enable the dependency graph and {% data variables.product.prodname_dependabot_alerts %}. For more information, see "[Enabling alerts for vulnerable dependencies on {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server)."{% endif %}
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %} If the dependency graph is not available in your system, your site administrator can enable the dependency graph and security alerts. For more information, see "[Enabling alerts for vulnerable dependencies on {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server)."
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %} If the dependency graph is not available in your system, your site administrator can enable the dependency graph and security alerts. For more information, see "[Enabling alerts for vulnerable dependencies on {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server)."
{% endif %}
diff --git a/content/github/visualizing-repository-data-with-graphs/accessing-basic-repository-data.md b/content/github/visualizing-repository-data-with-graphs/accessing-basic-repository-data.md
index 03f4ae908a19..bf325418e092 100644
--- a/content/github/visualizing-repository-data-with-graphs/accessing-basic-repository-data.md
+++ b/content/github/visualizing-repository-data-with-graphs/accessing-basic-repository-data.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/visualizing-repository-data-with-graphs/analyzing-changes-to-a-repositorys-content.md b/content/github/visualizing-repository-data-with-graphs/analyzing-changes-to-a-repositorys-content.md
index be9f00d68ed9..1bcc381a77d5 100644
--- a/content/github/visualizing-repository-data-with-graphs/analyzing-changes-to-a-repositorys-content.md
+++ b/content/github/visualizing-repository-data-with-graphs/analyzing-changes-to-a-repositorys-content.md
@@ -9,5 +9,6 @@ mapTopic: true
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository.md b/content/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository.md
index eb1a54e847e2..e06ac92e9a19 100644
--- a/content/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository.md
+++ b/content/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository.md
@@ -35,8 +35,8 @@ If vulnerabilities have been detected in the repository, these are shown at the
{% endif %}
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_gt "enterprise-server@2.21" %}
-Any direct and indirect dependencies that are specified in the repository's manifest or lock files are listed, grouped by ecosystem. If vulnerabilities have been detected in the repository, these are shown at the top of the view for users with access to {% data variables.product.prodname_dependabot_short %} alerts.
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" %}
+Any direct and indirect dependencies that are specified in the repository's manifest or lock files are listed, grouped by ecosystem. If vulnerabilities have been detected in the repository, these are shown at the top of the view for users with access to {% data variables.product.prodname_dependabot_alerts %}.
{% note %}
@@ -54,7 +54,7 @@ Any direct and indirect dependencies that are specified in the repository's mani
{% endif %}
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
Any direct and indirect dependencies that are specified in the repository's manifest or lock files are listed, grouped by ecosystem. If vulnerabilities have been detected in the repository, these are shown at the top of the view for users with access to security alerts.
{% note %}
diff --git a/content/github/visualizing-repository-data-with-graphs/index.md b/content/github/visualizing-repository-data-with-graphs/index.md
index ec458b1c5c0a..fb095cfc5fc9 100644
--- a/content/github/visualizing-repository-data-with-graphs/index.md
+++ b/content/github/visualizing-repository-data-with-graphs/index.md
@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/visualizing-repository-data-with-graphs/listing-the-forks-of-a-repository.md b/content/github/visualizing-repository-data-with-graphs/listing-the-forks-of-a-repository.md
index aeb0b6a6f103..efe4b1170c8f 100644
--- a/content/github/visualizing-repository-data-with-graphs/listing-the-forks-of-a-repository.md
+++ b/content/github/visualizing-repository-data-with-graphs/listing-the-forks-of-a-repository.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Forks are listed alphabetically by the username of the person who forked the repository. You can click on the username to be redirected to the user's {% data variables.product.product_name %} profile page or click on the fork name to be redirected to the specific fork of the repository.
diff --git a/content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories.md b/content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories.md
index 2b985da2fabe..3159e6eab6d7 100644
--- a/content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories.md
+++ b/content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/visualizing-repository-data-with-graphs/viewing-a-projects-contributors.md b/content/github/visualizing-repository-data-with-graphs/viewing-a-projects-contributors.md
index 37a8a757fc63..6075255a1f91 100644
--- a/content/github/visualizing-repository-data-with-graphs/viewing-a-projects-contributors.md
+++ b/content/github/visualizing-repository-data-with-graphs/viewing-a-projects-contributors.md
@@ -9,11 +9,12 @@ product: '{% data reusables.gated-features.repository-insights %}'
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### About contributors
-You can view the top 100 contributors to a repository{% if currentVersion != "free-pro-team@latest" %}, including commit co-authors,{% endif %} in the contributors graph. Merge commits and empty commits aren't counted as contributions for this graph.
+You can view the top 100 contributors to a repository{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}, including commit co-authors,{% endif %} in the contributors graph. Merge commits and empty commits aren't counted as contributions for this graph.
{% if currentVersion == "free-pro-team@latest" %}
You can also see a list of people who have contributed to the project's Python dependencies. To access this list of community contributors, visit `https://github.com/REPO-OWNER/REPO-NAME/community_contributors`.
@@ -33,7 +34,7 @@ You can also see a list of people who have contributed to the project's Python d
If you don't appear in a repository's contributors graph, it may be because:
- You aren't one of the top 100 contributors.
- Your commits haven't been merged into the default branch.
-- The email address you used to author the commits hasn't been added to your {% data variables.product.product_name %} account.
+- The email address you used to author the commits isn't connected to your account on {% data variables.product.product_name %}.
{% tip %}
@@ -43,4 +44,4 @@ If you don't appear in a repository's contributors graph, it may be because:
If all your commits in the repository are on non-default branches, you won't be in the contributors graph. For example, commits on the `gh-pages` branch aren't included in the graph unless `gh-pages` is the repository's default branch. To have your commits merged into the default branch, you can create a pull request. For more information, see "[About pull requests](/articles/about-pull-requests)."
-If the email address you used to author the commits has not been added to your {% data variables.product.product_name %} account, your commits won't be linked to your account, and you won't appear in the contributors graph. For more information, see "[Setting your commit email address](/articles/setting-your-commit-email-address)" and "[Adding an email address to your {% data variables.product.product_name %} account](/articles/adding-an-email-address-to-your-github-account)."
+If the email address you used to author the commits is not connected to your account on {% data variables.product.product_name %}, your commits won't be linked to your account, and you won't appear in the contributors graph. For more information, see "[Setting your commit email address](/articles/setting-your-commit-email-address){% if currentVersion != "github-ae@latest" %}" and "[Adding an email address to your {% data variables.product.product_name %} account](/articles/adding-an-email-address-to-your-github-account){% endif %}."
diff --git a/content/github/visualizing-repository-data-with-graphs/viewing-a-repositorys-network.md b/content/github/visualizing-repository-data-with-graphs/viewing-a-repositorys-network.md
index d7ff2fb82dc6..9227b4a81dee 100644
--- a/content/github/visualizing-repository-data-with-graphs/viewing-a-repositorys-network.md
+++ b/content/github/visualizing-repository-data-with-graphs/viewing-a-repositorys-network.md
@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/visualizing-repository-data-with-graphs/viewing-a-summary-of-repository-activity.md b/content/github/visualizing-repository-data-with-graphs/viewing-a-summary-of-repository-activity.md
index 920ce7163c11..e9bfbbaf20a0 100644
--- a/content/github/visualizing-repository-data-with-graphs/viewing-a-summary-of-repository-activity.md
+++ b/content/github/visualizing-repository-data-with-graphs/viewing-a-summary-of-repository-activity.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Commit co-authors are included in the commit activity summary if their commits were merged into the repository's default branch and they're in the top 15 users who have contributed the most commits.
diff --git a/content/github/visualizing-repository-data-with-graphs/visualizing-additions-and-deletions-to-content-in-a-repository.md b/content/github/visualizing-repository-data-with-graphs/visualizing-additions-and-deletions-to-content-in-a-repository.md
index 891553932bf7..547d43123b47 100644
--- a/content/github/visualizing-repository-data-with-graphs/visualizing-additions-and-deletions-to-content-in-a-repository.md
+++ b/content/github/visualizing-repository-data-with-graphs/visualizing-additions-and-deletions-to-content-in-a-repository.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% if currentVersion == "free-pro-team@latest" %}
diff --git a/content/github/visualizing-repository-data-with-graphs/visualizing-commits-in-a-repository.md b/content/github/visualizing-repository-data-with-graphs/visualizing-commits-in-a-repository.md
index 51eb201915a7..512af56ba8ff 100644
--- a/content/github/visualizing-repository-data-with-graphs/visualizing-commits-in-a-repository.md
+++ b/content/github/visualizing-repository-data-with-graphs/visualizing-commits-in-a-repository.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
The top graph shows commits for the entire year by week.
diff --git a/content/github/working-with-github-pages/about-github-pages-and-jekyll.md b/content/github/working-with-github-pages/about-github-pages-and-jekyll.md
index c411dae25336..07804937c639 100644
--- a/content/github/working-with-github-pages/about-github-pages-and-jekyll.md
+++ b/content/github/working-with-github-pages/about-github-pages-and-jekyll.md
@@ -21,13 +21,14 @@ product: '{% data reusables.gated-features.pages %}'
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### About Jekyll
Jekyll is a static site generator with built-in support for {% data variables.product.prodname_pages %} and a simplified build process. Jekyll takes Markdown and HTML files and creates a complete static website based on your choice of layouts. Jekyll supports Markdown and Liquid, a templating language that loads dynamic content on your site. For more information, see [Jekyll](https://jekyllrb.com/).
-Jekyll is not officially supported for Windows. For more information, see "[Jekyll on Windows](http://jekyllrb.com/docs/windows/#installation)" in the Jekyll documenation.
+Jekyll is not officially supported for Windows. For more information, see "[Jekyll on Windows](http://jekyllrb.com/docs/windows/#installation)" in the Jekyll documentation.
We recommend using Jekyll with {% data variables.product.prodname_pages %}. If you prefer, you can use other static site generators or customize your own build process locally or on another server. For more information, see "[About {% data variables.product.prodname_pages %}](/articles/about-github-pages#static-site-generators)."
diff --git a/content/github/working-with-github-pages/about-github-pages.md b/content/github/working-with-github-pages/about-github-pages.md
index 651184969598..c030e487fdbf 100644
--- a/content/github/working-with-github-pages/about-github-pages.md
+++ b/content/github/working-with-github-pages/about-github-pages.md
@@ -13,6 +13,7 @@ product: '{% data reusables.gated-features.pages %}'
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### About {% data variables.product.prodname_pages %}
@@ -25,7 +26,7 @@ You can host your site on {% data variables.product.prodname_dotcom %}'s `github
To get started, see "[Creating a {% data variables.product.prodname_pages %} site](/articles/creating-a-github-pages-site)."
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}
Organization owners can disable the publication of {% data variables.product.prodname_pages %} sites from the organization's repositories. For more information, see "[Disabling publication of {% data variables.product.prodname_pages %} sites for your organization](/github/setting-up-and-managing-organizations-and-teams/disabling-publication-of-github-pages-sites-for-your-organization)."
{% endif %}
@@ -33,23 +34,23 @@ Organization owners can disable the publication of {% data variables.product.pro
There are three types of {% data variables.product.prodname_pages %} sites: project, user, and organization. Project sites are connected to a specific project hosted on {% data variables.product.product_name %}, such as a JavaScript library or a recipe collection. User and organization sites are connected to a specific {% data variables.product.product_name %} account.
-To publish a user site, you must create a repository owned by your user account that's named {% if currentVersion == "free-pro-team@latest" %}`.github.io`{% else %}`.`{% endif %}. To publish an organization site, you must create a repository owned by an organization that's named {% if currentVersion == "free-pro-team@latest" %}`.github.io`{% else %}`.`{% endif %}. {% if currentVersion == "free-pro-team@latest" %}Unless you're using a custom domain, user and organization sites are available at `http(s)://.github.io` or `http(s)://.github.io`.{% endif %}
+To publish a user site, you must create a repository owned by your user account that's named {% if currentVersion == "free-pro-team@latest" %}`.github.io`{% else %}`.`{% endif %}. To publish an organization site, you must create a repository owned by an organization that's named {% if currentVersion == "free-pro-team@latest" %}`.github.io`{% else %}`.`{% endif %}. {% if currentVersion == "free-pro-team@latest" %}Unless you're using a custom domain, user and organization sites are available at `http(s)://.github.io` or `http(s)://.github.io`.{% elsif currentVersion == "github-ae@latest" %}User and organization sites are available at `http(s)://pages./` or `http(s)://pages./`.{% endif %}
-The source files for a project site are stored in the same repository as their project. {% if currentVersion == "free-pro-team@latest" %}Unless you're using a custom domain, project sites are available at `http(s)://.github.io/` or `http(s)://.github.io/`.{% endif %}
+The source files for a project site are stored in the same repository as their project. {% if currentVersion == "free-pro-team@latest" %}Unless you're using a custom domain, project sites are available at `http(s)://.github.io/` or `http(s)://.github.io/`.{% elsif currentVersion == "github-ae@latest" %}Project sites are available at `http(s)://pages.///` or `http(s)://pages.///`.{% endif %}
{% if currentVersion == "free-pro-team@latest" %}
For more information about how custom domains affect the URL for your site, see "[About custom domains and {% data variables.product.prodname_pages %}](/articles/about-custom-domains-and-github-pages)."
{% endif %}
-You can only create one user or organization site for each {% data variables.product.product_name %} account. Project sites, whether owned by an organization or a user account, are unlimited.
+You can only create one user or organization site for each account on {% data variables.product.product_name %}. Project sites, whether owned by an organization or a user account, are unlimited.
-{% if currentVersion != "free-pro-team@latest" %}
+{% if enterpriseServerVersions contains currentVersion %}
The URL where your site is available depends on whether subdomain isolation is enabled for {% data variables.product.product_location %}.
| Type of site | Subdomain isolation enabled | Subdomain isolation disabled |
| ------------ | --------------------------- | ---------------------------- |
-User | `http(s)://pages.///` | `http(s):///pages///` |
-Organization | `http(s)://pages.///` | `http(s):///pages///` |
+User | `http(s)://pages./` | `http(s):///pages/` |
+Organization | `http(s)://pages./` | `http(s):///pages/` |
Project site owned by user account | `http(s)://pages.///` | `http(s):///pages///`
Project site owned by organization account | `http(s)://pages.///` | `http(s):///pages///`
@@ -59,7 +60,7 @@ For more information, see "[Enabling subdomain isolation](/enterprise/{{ current
{% if currentVersion == "free-pro-team@latest" %}
{% note %}
-**Note:** Repositories using the legacy `.github.com` naming scheme will still be published, but visitors will be redirected from `http(s)://.github.com` to `http(s)://.github.io`. If both a `.github.com` and `.github.io` repository exist, only the `.github.io` repository will be published.
+**Note:** Repositories using the legacy `.github.com` naming scheme will still be published, but visitors will be redirected from `http(s)://.github.com` to `http(s)://.github.io`. If both a `.github.com` and `.github.io` repository exist, only the `.github.io` repository will be published.
{% endnote %}
{% endif %}
@@ -70,7 +71,7 @@ The publishing source for your {% data variables.product.prodname_pages %} site
{% data reusables.pages.private_pages_are_public_warning %}
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}
If the default publishing source exists in your repository, {% data variables.product.prodname_pages %} will automatically publish a site from that source. The default publishing source for user and organization sites is the root of the default branch for the repository. The default publishing source for project sites is the root of the `gh-pages` branch.
diff --git a/content/github/working-with-github-pages/about-jekyll-build-errors-for-github-pages-sites.md b/content/github/working-with-github-pages/about-jekyll-build-errors-for-github-pages-sites.md
index 046a4b845774..f3ca97d47102 100644
--- a/content/github/working-with-github-pages/about-jekyll-build-errors-for-github-pages-sites.md
+++ b/content/github/working-with-github-pages/about-jekyll-build-errors-for-github-pages-sites.md
@@ -9,6 +9,7 @@ product: '{% data reusables.gated-features.pages %}'
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### About Jekyll build errors
diff --git a/content/github/working-with-github-pages/adding-a-theme-to-your-github-pages-site-using-jekyll.md b/content/github/working-with-github-pages/adding-a-theme-to-your-github-pages-site-using-jekyll.md
index 8a6c5ece6ee8..203b8088ee74 100644
--- a/content/github/working-with-github-pages/adding-a-theme-to-your-github-pages-site-using-jekyll.md
+++ b/content/github/working-with-github-pages/adding-a-theme-to-your-github-pages-site-using-jekyll.md
@@ -9,6 +9,7 @@ product: '{% data reusables.gated-features.pages %}'
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
People with write permissions for a repository can add a theme to a {% data variables.product.prodname_pages %} site using Jekyll.
diff --git a/content/github/working-with-github-pages/adding-content-to-your-github-pages-site-using-jekyll.md b/content/github/working-with-github-pages/adding-content-to-your-github-pages-site-using-jekyll.md
index 703cf384d5f8..86af154fae79 100644
--- a/content/github/working-with-github-pages/adding-content-to-your-github-pages-site-using-jekyll.md
+++ b/content/github/working-with-github-pages/adding-content-to-your-github-pages-site-using-jekyll.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
People with write permissions for a repository can add content to a {% data variables.product.prodname_pages %} site using Jekyll.
diff --git a/content/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md b/content/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md
index f9185b9bff7e..03b0b70f083f 100644
--- a/content/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md
+++ b/content/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md
@@ -9,6 +9,7 @@ permissions: 'People with admin or maintainer permissions for a repository can c
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
For more information about publishing sources, see "[About {% data variables.product.prodname_pages %}](/articles/about-github-pages#publishing-sources-for-github-pages-sites)."
@@ -19,7 +20,7 @@ Before you configure a publishing source, make sure the branch{% if currentVersi
{% data reusables.pages.navigate-site-repo %}
{% data reusables.repositories.sidebar-settings %}
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}
3. Under "{% data variables.product.prodname_pages %}", use the **None** or **Branch** drop-down menu and select a publishing source.
4. Optionally, use the drop-down menu to select a folder for your publishing source.
@@ -35,4 +36,4 @@ Before you configure a publishing source, make sure the branch{% if currentVersi
{% data reusables.pages.admin-must-push %}
-If you choose the `docs` folder on {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}any{% else %}the `master`{% endif %} branch as your publishing source, then later remove the `/docs` folder from that branch in your repository, your site won't build and you'll get a page build error message for a missing `/docs` folder. For more information, see "[Troubleshooting Jekyll build errors for {% data variables.product.prodname_pages %} sites](/articles/troubleshooting-jekyll-build-errors-for-github-pages-sites#missing-docs-folder)."
+If you choose the `docs` folder on {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}any{% else %}the `master`{% endif %} branch as your publishing source, then later remove the `/docs` folder from that branch in your repository, your site won't build and you'll get a page build error message for a missing `/docs` folder. For more information, see "[Troubleshooting Jekyll build errors for {% data variables.product.prodname_pages %} sites](/articles/troubleshooting-jekyll-build-errors-for-github-pages-sites#missing-docs-folder)."
diff --git a/content/github/working-with-github-pages/creating-a-custom-404-page-for-your-github-pages-site.md b/content/github/working-with-github-pages/creating-a-custom-404-page-for-your-github-pages-site.md
index ee92972a1fe5..f5523b51a7d8 100644
--- a/content/github/working-with-github-pages/creating-a-custom-404-page-for-your-github-pages-site.md
+++ b/content/github/working-with-github-pages/creating-a-custom-404-page-for-your-github-pages-site.md
@@ -8,6 +8,7 @@ product: '{% data reusables.gated-features.pages %}'
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.pages.navigate-site-repo %}
diff --git a/content/github/working-with-github-pages/creating-a-github-pages-site-with-jekyll.md b/content/github/working-with-github-pages/creating-a-github-pages-site-with-jekyll.md
index 86907ab801db..c02beb7e31e8 100644
--- a/content/github/working-with-github-pages/creating-a-github-pages-site-with-jekyll.md
+++ b/content/github/working-with-github-pages/creating-a-github-pages-site-with-jekyll.md
@@ -8,6 +8,7 @@ permissions: 'People with admin permissions for a repository can create a {% dat
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Prerequisites
@@ -81,7 +82,7 @@ gem "github-pages", "~> VERSION", group: :jekyll_plugins
```
10. Save and close the Gemfile.
11. Optionally, test your site locally. For more information, see "[Testing your {% data variables.product.prodname_pages %} site locally with Jekyll](/articles/testing-your-github-pages-site-locally-with-jekyll)."
-12. Add your {% data variables.product.product_name %} repository as a remote, replacing {% if currentVersion != "free-pro-team@latest" %}_HOSTNAME_ with your appliance's hostname,{% endif %} _USER_ with the account that owns the repository{% if currentVersion != "free-pro-team@latest" %},{% endif %} and _REPOSITORY_ with the name of the repository.
+12. Add your {% data variables.product.product_name %} repository as a remote, replacing {% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}_HOSTNAME_ with your enterprise's hostname,{% endif %} _USER_ with the account that owns the repository{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %},{% endif %} and _REPOSITORY_ with the name of the repository.
```shell
{% if currentVersion == "free-pro-team@latest" %}
$ git remote add origin https://github.com/USER/REPOSITORY.git
diff --git a/content/github/working-with-github-pages/creating-a-github-pages-site.md b/content/github/working-with-github-pages/creating-a-github-pages-site.md
index 86ca01f26592..660a785a25e9 100644
--- a/content/github/working-with-github-pages/creating-a-github-pages-site.md
+++ b/content/github/working-with-github-pages/creating-a-github-pages-site.md
@@ -2,12 +2,16 @@
title: Creating a GitHub Pages site
intro: 'You can create a {% data variables.product.prodname_pages %} site in a new or existing repository.'
redirect_from:
+ - /articles/creating-pages-manually/
+ - /articles/creating-project-pages-manually/
+ - /articles/creating-project-pages-from-the-command-line/
- /articles/creating-project-pages-using-the-command-line/
- /articles/creating-a-github-pages-site
product: '{% data reusables.gated-features.pages %}'
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Creating a repository for your site
diff --git a/content/github/working-with-github-pages/getting-started-with-github-pages.md b/content/github/working-with-github-pages/getting-started-with-github-pages.md
index 8126a23b02d8..2c570f5de45a 100644
--- a/content/github/working-with-github-pages/getting-started-with-github-pages.md
+++ b/content/github/working-with-github-pages/getting-started-with-github-pages.md
@@ -10,5 +10,6 @@ mapTopic: true
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/working-with-github-pages/index.md b/content/github/working-with-github-pages/index.md
index 895e418ae330..55af53121ba8 100644
--- a/content/github/working-with-github-pages/index.md
+++ b/content/github/working-with-github-pages/index.md
@@ -14,6 +14,7 @@ product: '{% data reusables.gated-features.pages %}'
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site.md b/content/github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site.md
index e3d3015e50ea..722694a35882 100644
--- a/content/github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site.md
+++ b/content/github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site.md
@@ -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 `.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 `.github.io`. The `CNAME` file should always point to `.github.io` or `.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 `.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 `.github.io`. The `CNAME` file should always point to `.github.io` or `.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
diff --git a/content/github/working-with-github-pages/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md b/content/github/working-with-github-pages/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md
index bc5f4c9c7550..93c5e1e0d61d 100644
--- a/content/github/working-with-github-pages/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md
+++ b/content/github/working-with-github-pages/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md
@@ -9,11 +9,12 @@ product: '{% data reusables.gated-features.pages %}'
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
People with write permissions for a repository can set the Markdown processor for a {% data variables.product.prodname_pages %} site.
-{% data variables.product.prodname_pages %} supports two Markdown processors: [kramdown](http://kramdown.gettalong.org/) and {% data variables.product.prodname_dotcom %}'s own extended [CommonMark](https://commonmark.org/) processer, which is used to render {% data variables.product.prodname_dotcom %} Flavored Markdown throughout {% data variables.product.product_name %}. For more information, see "[About writing and formatting on {% data variables.product.prodname_dotcom %}](/articles/about-writing-and-formatting-on-github)."
+{% data variables.product.prodname_pages %} supports two Markdown processors: [kramdown](http://kramdown.gettalong.org/) and {% data variables.product.prodname_dotcom %}'s own extended [CommonMark](https://commonmark.org/) processor, which is used to render {% data variables.product.prodname_dotcom %} Flavored Markdown throughout {% data variables.product.product_name %}. For more information, see "[About writing and formatting on {% data variables.product.prodname_dotcom %}](/articles/about-writing-and-formatting-on-github)."
You can use {% data variables.product.prodname_dotcom %} Flavored Markdown with either processor, but only our CommonMark processor will always match the results you see on {% data variables.product.product_name %}.
diff --git a/content/github/working-with-github-pages/setting-up-a-github-pages-site-with-jekyll.md b/content/github/working-with-github-pages/setting-up-a-github-pages-site-with-jekyll.md
index f8f9aee79a79..b1ec8358fdfe 100644
--- a/content/github/working-with-github-pages/setting-up-a-github-pages-site-with-jekyll.md
+++ b/content/github/working-with-github-pages/setting-up-a-github-pages-site-with-jekyll.md
@@ -10,5 +10,6 @@ mapTopic: true
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/working-with-github-pages/testing-your-github-pages-site-locally-with-jekyll.md b/content/github/working-with-github-pages/testing-your-github-pages-site-locally-with-jekyll.md
index 15a99c3ae321..283cb86b68ba 100644
--- a/content/github/working-with-github-pages/testing-your-github-pages-site-locally-with-jekyll.md
+++ b/content/github/working-with-github-pages/testing-your-github-pages-site-locally-with-jekyll.md
@@ -9,6 +9,7 @@ product: '{% data reusables.gated-features.pages %}'
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Anyone with read permissions for a repository can test a {% data variables.product.prodname_pages %} site locally.
diff --git a/content/github/working-with-github-pages/troubleshooting-jekyll-build-errors-for-github-pages-sites.md b/content/github/working-with-github-pages/troubleshooting-jekyll-build-errors-for-github-pages-sites.md
index 1ed03b1e523d..3b2bb2212b1e 100644
--- a/content/github/working-with-github-pages/troubleshooting-jekyll-build-errors-for-github-pages-sites.md
+++ b/content/github/working-with-github-pages/troubleshooting-jekyll-build-errors-for-github-pages-sites.md
@@ -28,6 +28,7 @@ product: '{% data reusables.gated-features.pages %}'
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Troubleshooting build errors
@@ -182,6 +183,6 @@ To troubleshoot, make sure all output tags in the file in the error message are
This error means that your code contains an unrecognized Liquid tag.
-To troubleshoot, make sure all Liquid tags in the file in the error message match Jekyll's default variables and there are no typos in the tag names. For a list of default varibles, see "[Variables](https://jekyllrb.com/docs/variables/)" in the Jekyll documentation.
+To troubleshoot, make sure all Liquid tags in the file in the error message match Jekyll's default variables and there are no typos in the tag names. For a list of default variables, see "[Variables](https://jekyllrb.com/docs/variables/)" in the Jekyll documentation.
Unsupported plugins are a common source of unrecognized tags. If you use an unsupported plugin in your site by generating your site locally and pushing your static files to {% data variables.product.product_name %}, make sure the plugin is not introducing tags that are not in Jekyll's default variables. For a list of supported plugins, see "[About {% data variables.product.prodname_pages %} and Jekyll](/articles/about-github-pages-and-jekyll#plugins)."
diff --git a/content/github/working-with-github-pages/unpublishing-a-github-pages-site.md b/content/github/working-with-github-pages/unpublishing-a-github-pages-site.md
index c14a7abd1670..640f5244a511 100644
--- a/content/github/working-with-github-pages/unpublishing-a-github-pages-site.md
+++ b/content/github/working-with-github-pages/unpublishing-a-github-pages-site.md
@@ -12,6 +12,7 @@ permissions: 'People with admin or maintainer permissions for a repository can u
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Unpublishing a project site
diff --git a/content/github/writing-on-github/about-saved-replies.md b/content/github/writing-on-github/about-saved-replies.md
index 784907bee557..64f77d30bb33 100644
--- a/content/github/writing-on-github/about-saved-replies.md
+++ b/content/github/writing-on-github/about-saved-replies.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/writing-on-github/about-writing-and-formatting-on-github.md b/content/github/writing-on-github/about-writing-and-formatting-on-github.md
index 659dd42498ed..5a060c8d91f1 100644
--- a/content/github/writing-on-github/about-writing-and-formatting-on-github.md
+++ b/content/github/writing-on-github/about-writing-and-formatting-on-github.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
[Markdown](http://daringfireball.net/projects/markdown/) is an easy-to-read, easy-to-write syntax for formatting plain text.
diff --git a/content/github/writing-on-github/autolinked-references-and-urls.md b/content/github/writing-on-github/autolinked-references-and-urls.md
index b7978b5753f7..b0b44c255d98 100644
--- a/content/github/writing-on-github/autolinked-references-and-urls.md
+++ b/content/github/writing-on-github/autolinked-references-and-urls.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### URLs
diff --git a/content/github/writing-on-github/basic-writing-and-formatting-syntax.md b/content/github/writing-on-github/basic-writing-and-formatting-syntax.md
index 391f2e03eec5..4c0e0608898a 100644
--- a/content/github/writing-on-github/basic-writing-and-formatting-syntax.md
+++ b/content/github/writing-on-github/basic-writing-and-formatting-syntax.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Headings
@@ -170,7 +171,7 @@ For more information, see "[About task lists](/articles/about-task-lists)."
### Mentioning people and teams
-You can mention a person or [team](/articles/setting-up-teams/) on {% data variables.product.product_name %} by typing `@` plus their username or team name. This will trigger a notification and bring their attention to the conversation. People will also receive a notification if you edit a comment to mention their username or team name. For more information about notifications, see {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}"[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications){% else %}"[About notifications](/github/receiving-notifications-about-activity-on-github/about-notifications){% endif %}."
+You can mention a person or [team](/articles/setting-up-teams/) on {% data variables.product.product_name %} by typing `@` plus their username or team name. This will trigger a notification and bring their attention to the conversation. People will also receive a notification if you edit a comment to mention their username or team name. For more information about notifications, see {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}"[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications){% else %}"[About notifications](/github/receiving-notifications-about-activity-on-github/about-notifications){% endif %}."
`@github/support What do you think about these updates?`
diff --git a/content/github/writing-on-github/creating-a-saved-reply.md b/content/github/writing-on-github/creating-a-saved-reply.md
index 1acd0d4a20e8..1b57d5615c8d 100644
--- a/content/github/writing-on-github/creating-a-saved-reply.md
+++ b/content/github/writing-on-github/creating-a-saved-reply.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.user_settings.access_settings %}
diff --git a/content/github/writing-on-github/creating-and-highlighting-code-blocks.md b/content/github/writing-on-github/creating-and-highlighting-code-blocks.md
index df4e3379074b..b4f2b86418fe 100644
--- a/content/github/writing-on-github/creating-and-highlighting-code-blocks.md
+++ b/content/github/writing-on-github/creating-and-highlighting-code-blocks.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Fenced code blocks
diff --git a/content/github/writing-on-github/creating-gists.md b/content/github/writing-on-github/creating-gists.md
index f1722559c050..4082f31784e4 100644
--- a/content/github/writing-on-github/creating-gists.md
+++ b/content/github/writing-on-github/creating-gists.md
@@ -9,6 +9,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### About gists
@@ -17,9 +18,9 @@ Every gist is a Git repository, which means that it can be forked and cloned. If
Gists can be public or secret. Public gists show up in {% data variables.gists.discover_url %}, where people can browse new gists as they're created. They're also searchable, so you can use them if you'd like other people to find and see your work. {% data reusables.gist.cannot-convert-public-gists-to-secret %}
-Secret gists don't show up in {% data variables.gists.discover_url %}{% if currentVersion != "free-pro-team@latest" %},{% endif %} and are not searchable. {% data reusables.gist.cannot-convert-public-gists-to-secret %} Secret gists aren't private. If you send the URL of a secret gist to a friend, they'll be able to see it. However, if someone you don't know discovers the URL, they'll also be able to see your gist. If you need to keep your code away from prying eyes, you may want to [create a private repository](/articles/creating-a-new-repository) instead.
+Secret gists don't show up in {% data variables.gists.discover_url %} and are not searchable. {% data reusables.gist.cannot-convert-public-gists-to-secret %} Secret gists aren't private. If you send the URL of a secret gist to a friend, they'll be able to see it. However, if someone you don't know discovers the URL, they'll also be able to see your gist. If you need to keep your code away from prying eyes, you may want to [create a private repository](/articles/creating-a-new-repository) instead.
-{% if currentVersion != "free-pro-team@latest" %}
+{% if enterpriseServerVersions contains currentVersion %}
If your site administrator has disabled private mode, you can also use anonymous gists, which can be public or secret.
@@ -50,7 +51,7 @@ Gist supports mapping GeoJSON files. These maps are displayed in embedded gists,
You can also drag and drop a text file from your desktop directly into the gist editor.
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %}
{% note %}
You can also create a gist using the {% data variables.product.prodname_cli %}. For more information, see "[`gh gist create`](https://cli.github.com/manual/gh_gist_create)" in the {% data variables.product.prodname_cli %} documentation.
diff --git a/content/github/writing-on-github/deleting-a-saved-reply.md b/content/github/writing-on-github/deleting-a-saved-reply.md
index 23b543313b5c..cffdaac334d0 100644
--- a/content/github/writing-on-github/deleting-a-saved-reply.md
+++ b/content/github/writing-on-github/deleting-a-saved-reply.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.user_settings.access_settings %}
diff --git a/content/github/writing-on-github/editing-a-saved-reply.md b/content/github/writing-on-github/editing-a-saved-reply.md
index cf558d948cc3..d67e57980da7 100644
--- a/content/github/writing-on-github/editing-a-saved-reply.md
+++ b/content/github/writing-on-github/editing-a-saved-reply.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.user_settings.access_settings %}
diff --git a/content/github/writing-on-github/editing-and-sharing-content-with-gists.md b/content/github/writing-on-github/editing-and-sharing-content-with-gists.md
index bda6ba4d2692..290645090ff2 100644
--- a/content/github/writing-on-github/editing-and-sharing-content-with-gists.md
+++ b/content/github/writing-on-github/editing-and-sharing-content-with-gists.md
@@ -9,5 +9,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/writing-on-github/forking-and-cloning-gists.md b/content/github/writing-on-github/forking-and-cloning-gists.md
index 73b1c187127b..04f68e84c422 100644
--- a/content/github/writing-on-github/forking-and-cloning-gists.md
+++ b/content/github/writing-on-github/forking-and-cloning-gists.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Forking gists
diff --git a/content/github/writing-on-github/getting-started-with-writing-and-formatting-on-github.md b/content/github/writing-on-github/getting-started-with-writing-and-formatting-on-github.md
index b7cf7d34c76d..6932c966d166 100644
--- a/content/github/writing-on-github/getting-started-with-writing-and-formatting-on-github.md
+++ b/content/github/writing-on-github/getting-started-with-writing-and-formatting-on-github.md
@@ -9,5 +9,6 @@ mapTopic: true
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/writing-on-github/index.md b/content/github/writing-on-github/index.md
index 81ca75b5ccad..c6dbb7e3432d 100644
--- a/content/github/writing-on-github/index.md
+++ b/content/github/writing-on-github/index.md
@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/writing-on-github/organizing-information-with-tables.md b/content/github/writing-on-github/organizing-information-with-tables.md
index 775fc4fd3014..07a84b6ad6b8 100644
--- a/content/github/writing-on-github/organizing-information-with-tables.md
+++ b/content/github/writing-on-github/organizing-information-with-tables.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Creating a table
diff --git a/content/github/writing-on-github/using-saved-replies.md b/content/github/writing-on-github/using-saved-replies.md
index 8046f5f795df..ebb5f13485cd 100644
--- a/content/github/writing-on-github/using-saved-replies.md
+++ b/content/github/writing-on-github/using-saved-replies.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% data reusables.repositories.navigate-to-repo %}
diff --git a/content/github/writing-on-github/working-with-advanced-formatting.md b/content/github/writing-on-github/working-with-advanced-formatting.md
index 4825f59d040d..9a6240e60f5c 100644
--- a/content/github/writing-on-github/working-with-advanced-formatting.md
+++ b/content/github/writing-on-github/working-with-advanced-formatting.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/github/writing-on-github/working-with-saved-replies.md b/content/github/writing-on-github/working-with-saved-replies.md
index 5ca965c0aa67..7b85b6b27d59 100644
--- a/content/github/writing-on-github/working-with-saved-replies.md
+++ b/content/github/writing-on-github/working-with-saved-replies.md
@@ -7,5 +7,6 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/graphql/guides/forming-calls-with-graphql.md b/content/graphql/guides/forming-calls-with-graphql.md
index ff6b2e195a1a..fe2d6e65171d 100644
--- a/content/graphql/guides/forming-calls-with-graphql.md
+++ b/content/graphql/guides/forming-calls-with-graphql.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Authenticating with GraphQL
@@ -334,9 +335,9 @@ With the ID known, we can proceed with the mutation:
Let's examine this line:
- - `addReaction` is the name of the mutation.
- - `input` is the required argument key. This will always be `input` for a mutation.
- - `{subjectId:"MDU6SXNzdWUyMzEzOTE1NTE=",content:HOORAY}` is the required argument value. This will always be an [input object](/v4/input_object/) (hence the curly braces) composed of input fields (`subjectId` and `content` in this case) for a mutation.
+ - `addReaction` is the name of the mutation.
+ - `input` is the required argument key. This will always be `input` for a mutation.
+ - `{subjectId:"MDU6SXNzdWUyMzEzOTE1NTE=",content:HOORAY}` is the required argument value. This will always be an [input object](/v4/input_object/) (hence the curly braces) composed of input fields (`subjectId` and `content` in this case) for a mutation.
How do we know which value to use for the content? The [`addReaction` docs](/v4/mutation/addreaction/) tell us the `content` field has the type [`ReactionContent`](/v4/enum/reactioncontent/), which is an [enum](/v4/enum) because only certain emoji reactions are supported on GitHub issues. These are the allowed values for reactions (note some values differ from their corresponding emoji names):
diff --git a/content/graphql/guides/index.md b/content/graphql/guides/index.md
index 5877329311c4..1286ac37d739 100644
--- a/content/graphql/guides/index.md
+++ b/content/graphql/guides/index.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% link_in_list /introduction-to-graphql %}
diff --git a/content/graphql/guides/introduction-to-graphql.md b/content/graphql/guides/introduction-to-graphql.md
index b64e5be7a19e..6174e3aa01e1 100644
--- a/content/graphql/guides/introduction-to-graphql.md
+++ b/content/graphql/guides/introduction-to-graphql.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### GraphQL terminology
diff --git a/content/graphql/guides/managing-enterprise-accounts.md b/content/graphql/guides/managing-enterprise-accounts.md
index 198a91f46ac2..78342e3bd70f 100644
--- a/content/graphql/guides/managing-enterprise-accounts.md
+++ b/content/graphql/guides/managing-enterprise-accounts.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### About managing enterprise accounts with GraphQL
@@ -204,7 +205,7 @@ For more information about getting started with GraphQL, see "[Introduction to G
Here's an overview of the new queries, mutations, and schema defined types available for use with the Enterprise Accounts API.
-For more details about the new queries, mutations, and schema defined types available for use with the Enterprise Accounts API, see the sdiebar with detailed GraphQL definitions from any [GraphQL reference page](/v4/).
+For more details about the new queries, mutations, and schema defined types available for use with the Enterprise Accounts API, see the sidebar with detailed GraphQL definitions from any [GraphQL reference page](/v4/).
You can access the reference docs from within the GraphQL explorer on GitHub. For more information, see "[Using the explorer](/v4/guides/using-the-explorer#accessing-the-sidebar-docs)."
For other information, such as authentication and rate limit details, check out the [guides](/v4/guides).
diff --git a/content/graphql/guides/migrating-from-rest-to-graphql.md b/content/graphql/guides/migrating-from-rest-to-graphql.md
index f57ce4780bab..dbc64338ed6b 100644
--- a/content/graphql/guides/migrating-from-rest-to-graphql.md
+++ b/content/graphql/guides/migrating-from-rest-to-graphql.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Differences in API logic
diff --git a/content/graphql/guides/using-global-node-ids.md b/content/graphql/guides/using-global-node-ids.md
index 55c2c85aee76..77307ca9eb0c 100644
--- a/content/graphql/guides/using-global-node-ids.md
+++ b/content/graphql/guides/using-global-node-ids.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
You can access most objects in GitHub (users, issues, pull requests, etc.) using either the REST API or the GraphQL API. With a [recent update](https://developer.github.com/changes/2017-12-19-graphql-node-id/), you can find the **global node ID** of many objects from within the REST API and use these IDs in your GraphQL operations.
diff --git a/content/graphql/guides/using-the-explorer.md b/content/graphql/guides/using-the-explorer.md
index e4a6de3524bc..27502c719c0e 100644
--- a/content/graphql/guides/using-the-explorer.md
+++ b/content/graphql/guides/using-the-explorer.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
## About the GraphQL Explorer
diff --git a/content/graphql/index.md b/content/graphql/index.md
index 66b0ae9d42af..ba6c4847adb5 100644
--- a/content/graphql/index.md
+++ b/content/graphql/index.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% link_with_intro /overview %}
diff --git a/content/graphql/overview/about-the-graphql-api.md b/content/graphql/overview/about-the-graphql-api.md
index bd3e2fa36c3e..a2b02fc257c3 100644
--- a/content/graphql/overview/about-the-graphql-api.md
+++ b/content/graphql/overview/about-the-graphql-api.md
@@ -4,6 +4,7 @@ intro: 'The {% data variables.product.prodname_dotcom %} GraphQL API offers flex
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Overview
diff --git a/content/graphql/overview/breaking-changes.md b/content/graphql/overview/breaking-changes.md
index fd761309414f..f9fde6b0f628 100644
--- a/content/graphql/overview/breaking-changes.md
+++ b/content/graphql/overview/breaking-changes.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### About breaking changes
diff --git a/content/graphql/overview/changelog.md b/content/graphql/overview/changelog.md
index 5482e60e0f69..dbb8876a2bc9 100644
--- a/content/graphql/overview/changelog.md
+++ b/content/graphql/overview/changelog.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
Breaking changes include changes that will break existing queries or could affect the runtime behavior of clients. For a list of breaking changes and when they will occur, see our [breaking changes log](/v4/breaking_changes).
diff --git a/content/graphql/overview/explorer.md b/content/graphql/overview/explorer.md
index 3abd5345e6c8..f87b12b44eef 100644
--- a/content/graphql/overview/explorer.md
+++ b/content/graphql/overview/explorer.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
You can access GitHub's GraphQL Explorer at https://developer.github.com/v4/explorer.
diff --git a/content/graphql/overview/index.md b/content/graphql/overview/index.md
index 71732210ec99..0faacb78fa9a 100644
--- a/content/graphql/overview/index.md
+++ b/content/graphql/overview/index.md
@@ -4,6 +4,7 @@ intro: 'Learn about the {% data variables.product.prodname_dotcom %} GraphQL API
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% link_in_list /about-the-graphql-api %}
diff --git a/content/graphql/overview/public-schema.md b/content/graphql/overview/public-schema.md
index 3856de9a245d..0df87e765334 100644
--- a/content/graphql/overview/public-schema.md
+++ b/content/graphql/overview/public-schema.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
You can [perform introspection](/v4/guides/intro-to-graphql/#discovering-the-graphql-api) against the GraphQL API directly.
@@ -16,8 +17,16 @@ Alternatively, you can download the latest version of the public schema here:
[{% octicon "desktop-download" aria-label="The desktop download icon" %} `schema.docs.graphql`](/public/schema.docs.graphql)
-{% else %}
+{% endif %}
+
+{% if enterpriseServerVersions contains currentVersion %}
+
+[{% octicon "desktop-download" aria-label="The desktop download icon" %} `schema.docs-enterprise.graphql`](/public/ghes-{{ allVersions[currentVersion].currentRelease }}/schema.docs-enterprise.graphql) ({{ allVersions[currentVersion].versionTitle }})
+
+{% endif %}
+
+{% if currentVersion == "github-ae@latest" %}
-[{% octicon "desktop-download" aria-label="The desktop download icon" %} `schema.docs-enterprise.graphql`](/public/{{ currentVersion }}/schema.docs-enterprise.graphql) ({{ allVersions[currentVersion].versionTitle }})
+[{% octicon "desktop-download" aria-label="The desktop download icon" %} `schema.docs-ghae.graphql`](/public/ghae/schema.docs-ghae.graphql) ({{ allVersions[currentVersion].versionTitle }})
{% endif %}
diff --git a/content/graphql/overview/resource-limitations.md b/content/graphql/overview/resource-limitations.md
index 4c5f3c979a6c..761d44c0b8ad 100644
--- a/content/graphql/overview/resource-limitations.md
+++ b/content/graphql/overview/resource-limitations.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
## Node limit
diff --git a/content/graphql/overview/schema-previews.md b/content/graphql/overview/schema-previews.md
index 6d2666e53ade..b0b3a5e30f01 100644
--- a/content/graphql/overview/schema-previews.md
+++ b/content/graphql/overview/schema-previews.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### About schema previews
diff --git a/content/graphql/reference/enums.md b/content/graphql/reference/enums.md
index 48254c6ebd00..3cec114335ad 100644
--- a/content/graphql/reference/enums.md
+++ b/content/graphql/reference/enums.md
@@ -5,6 +5,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### About enums
diff --git a/content/graphql/reference/index.md b/content/graphql/reference/index.md
index 553212d49bd7..c31b4d6f754c 100644
--- a/content/graphql/reference/index.md
+++ b/content/graphql/reference/index.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% link_in_list /queries %}
diff --git a/content/graphql/reference/input-objects.md b/content/graphql/reference/input-objects.md
index dc17e9c4bb98..6726cfaf2ceb 100644
--- a/content/graphql/reference/input-objects.md
+++ b/content/graphql/reference/input-objects.md
@@ -5,6 +5,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### About input objects
diff --git a/content/graphql/reference/interfaces.md b/content/graphql/reference/interfaces.md
index fd4d5822cb75..0baee2c4677c 100644
--- a/content/graphql/reference/interfaces.md
+++ b/content/graphql/reference/interfaces.md
@@ -5,6 +5,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### About interfaces
diff --git a/content/graphql/reference/mutations.md b/content/graphql/reference/mutations.md
index 6018f29f57cb..9f6542ab7947 100644
--- a/content/graphql/reference/mutations.md
+++ b/content/graphql/reference/mutations.md
@@ -5,6 +5,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### About mutations
diff --git a/content/graphql/reference/objects.md b/content/graphql/reference/objects.md
index 08e8c9748da2..84cbbabfdfd8 100644
--- a/content/graphql/reference/objects.md
+++ b/content/graphql/reference/objects.md
@@ -5,6 +5,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### About objects
diff --git a/content/graphql/reference/queries.md b/content/graphql/reference/queries.md
index c121b670aa26..4d87cd2e254a 100644
--- a/content/graphql/reference/queries.md
+++ b/content/graphql/reference/queries.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### About queries
@@ -14,6 +15,12 @@ Every GraphQL schema has a root type for both queries and mutations. The [query
For more information, see "[About queries](/v4/guides/forming-calls#about-queries)."
+{% note %}
+
+**Note:** For [user-to-server](/developers/apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) {% data variables.product.prodname_github_app %} requests, you should use separate queries for issues and pull requests. For example, use the `is:issue` or `is:pull-request` filters and their equivalents. Using the `search` connection to return a combination of issues and pull requests in a single query will result in an empty set of nodes.
+
+{% endnote %}
+
## Connections
{% for item in graphql.schemaForCurrentVersion.queries.connections %}
diff --git a/content/graphql/reference/scalars.md b/content/graphql/reference/scalars.md
index 0fea4770afb0..0a37135d2c24 100644
--- a/content/graphql/reference/scalars.md
+++ b/content/graphql/reference/scalars.md
@@ -5,6 +5,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### About scalars
diff --git a/content/graphql/reference/unions.md b/content/graphql/reference/unions.md
index 7c016fd2aba2..95f5a9f6333c 100644
--- a/content/graphql/reference/unions.md
+++ b/content/graphql/reference/unions.md
@@ -5,6 +5,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### About unions
diff --git a/content/index.md b/content/index.md
index 1800e3661d03..c915b6dd27b7 100644
--- a/content/index.md
+++ b/content/index.md
@@ -1,16 +1,17 @@
---
title: '{% data variables.product.product_name %}{% if currentVersion == "free-pro-team@latest" %}.com{% endif %} Help Documentation'
-gettingStartedLinks:
- - /github/getting-started-with-github/set-up-git
- - /github/authenticating-to-github/connecting-to-github-with-ssh
- - /github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github
- - /github/writing-on-github/basic-writing-and-formatting-syntax
-popularLinks:
- - /github/collaborating-with-issues-and-pull-requests/about-pull-requests
- - /github/authenticating-to-github
- - /github/importing-your-projects-to-github/adding-an-existing-project-to-github-using-the-command-line
- - /github/using-git/managing-remote-repositories
- - /github/working-with-github-pages
+featuredLinks:
+ gettingStarted:
+ - /github/getting-started-with-github/set-up-git
+ - /github/authenticating-to-github/connecting-to-github-with-ssh
+ - /github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github
+ - /github/writing-on-github/basic-writing-and-formatting-syntax
+ popular:
+ - /github/collaborating-with-issues-and-pull-requests/about-pull-requests
+ - /github/authenticating-to-github
+ - /github/importing-your-projects-to-github/adding-an-existing-project-to-github-using-the-command-line
+ - /github/using-git/managing-remote-repositories
+ - /github/working-with-github-pages
versions: '*'
---
diff --git a/content/insights/index.md b/content/insights/index.md
index 552ed3fe31a7..068ac882f760 100644
--- a/content/insights/index.md
+++ b/content/insights/index.md
@@ -2,14 +2,15 @@
title: GitHub Insights Documentation
shortTitle: GitHub Insights
intro: 'Understand and improve your software delivery process through data with {% data variables.product.prodname_insights %}. You can view customized reports based on data from {% data variables.product.prodname_enterprise %}.'
-gettingStartedLinks:
- - /insights/installing-and-configuring-github-insights/about-github-insights
- - /insights/installing-and-configuring-github-insights/system-overview-for-github-insights
- - /insights/installing-and-configuring-github-insights/installing-github-insights
- - /insights/exploring-your-usage-of-github-enterprise/viewing-key-metrics-and-reports
-popularLinks:
- - /insights/installing-and-configuring-github-insights/about-data-in-github-insights
- - /insights/exploring-your-usage-of-github-enterprise/metrics-available-with-github-insights
+featuredLinks:
+ gettingStarted:
+ - /insights/installing-and-configuring-github-insights/about-github-insights
+ - /insights/installing-and-configuring-github-insights/system-overview-for-github-insights
+ - /insights/installing-and-configuring-github-insights/installing-github-insights
+ - /insights/exploring-your-usage-of-github-enterprise/viewing-key-metrics-and-reports
+ popular:
+ - /insights/installing-and-configuring-github-insights/about-data-in-github-insights
+ - /insights/exploring-your-usage-of-github-enterprise/metrics-available-with-github-insights
redirect_from:
- /github/installing-and-configuring-github-insights
versions:
diff --git a/content/insights/installing-and-configuring-github-insights/enabling-a-link-between-github-insights-and-github-enterprise.md b/content/insights/installing-and-configuring-github-insights/enabling-a-link-between-github-insights-and-github-enterprise.md
index 6997730e26c3..c69bf53c6087 100644
--- a/content/insights/installing-and-configuring-github-insights/enabling-a-link-between-github-insights-and-github-enterprise.md
+++ b/content/insights/installing-and-configuring-github-insights/enabling-a-link-between-github-insights-and-github-enterprise.md
@@ -18,8 +18,7 @@ After you enable the link, each user can navigate directly from {% data variable
ghe-config 'app.github.insights-available' 'true' && ghe-config-apply
```
3. Return to {% data variables.product.prodname_ghe_server %}.
-{% data reusables.enterprise_site_admin_settings.access-settings %}
-{% data reusables.enterprise_site_admin_settings.business %}
+{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.settings-tab %}
7. Under {% octicon "gear" aria-label="The Settings gear" %} **Settings**, click **{% data variables.product.prodname_insights %}**.
{% note %}
diff --git a/content/insights/installing-and-configuring-github-insights/installing-github-insights.md b/content/insights/installing-and-configuring-github-insights/installing-github-insights.md
index 6e4a019e2d3b..228c43c78418 100644
--- a/content/insights/installing-and-configuring-github-insights/installing-github-insights.md
+++ b/content/insights/installing-and-configuring-github-insights/installing-github-insights.md
@@ -67,7 +67,7 @@ To connect {% data variables.product.prodname_insights %} to {% data variables.p
- Team
-13. To enable the {% data variables.product.prodname_github_app %} to access data from any user or organization in {% data variables.product.product_location_enterprise %}, under "Where can this {% data variables.product.prodname_github_app %} be installed?", select **Any account**.
+13. To enable the {% data variables.product.prodname_github_app %} to access data from any user or organization in {% data variables.product.product_location %}, under "Where can this {% data variables.product.prodname_github_app %} be installed?", select **Any account**.
14. Click **Create {% data variables.product.prodname_github_app %}**.
diff --git a/content/insights/installing-and-configuring-github-insights/managing-contributors-and-teams.md b/content/insights/installing-and-configuring-github-insights/managing-contributors-and-teams.md
index 0fffd0737420..7c054d9bdbda 100644
--- a/content/insights/installing-and-configuring-github-insights/managing-contributors-and-teams.md
+++ b/content/insights/installing-and-configuring-github-insights/managing-contributors-and-teams.md
@@ -103,7 +103,7 @@ You can create and manage custom teams in {% data variables.product.prodname_ins
{% data reusables.github-insights.teams-tab %}
{% data reusables.github-insights.edit-team %}
3. Under "Contributors", use the drop-down menu and select a contributor.
- 
+ 
4. Click **Done**.
#### Removing a contributor from a custom team
diff --git a/content/insights/installing-and-configuring-github-insights/updating-github-insights.md b/content/insights/installing-and-configuring-github-insights/updating-github-insights.md
index df02d3fc47aa..e17b23f341d4 100644
--- a/content/insights/installing-and-configuring-github-insights/updating-github-insights.md
+++ b/content/insights/installing-and-configuring-github-insights/updating-github-insights.md
@@ -6,7 +6,6 @@ redirect_from:
- /github/installing-and-configuring-github-insights/updating-github-insights
permissions: 'People with read permissions to the `github/insights-releases` repository and administrative access to the application server can update {% data variables.product.prodname_insights %}.'
versions:
- free-pro-team: '*'
enterprise-server: '*'
---
diff --git a/content/packages/index.md b/content/packages/index.md
index 8fc138d8891e..e00d89f22a59 100644
--- a/content/packages/index.md
+++ b/content/packages/index.md
@@ -2,18 +2,19 @@
title: GitHub Packages Documentation
shortTitle: GitHub Packages
intro: 'Learn to safely publish and consume packages, store your packages alongside your code, and share your packages privately with your team or publicly with the open source community. You can also automate your packages with {% data variables.product.prodname_actions %}.'
-gettingStartedLinks:
- - /packages/publishing-and-managing-packages/about-github-packages
- - /packages/getting-started-with-github-container-registry/about-github-container-registry
- - /packages/getting-started-with-github-container-registry
- - /packages/managing-container-images-with-github-container-registry/pushing-and-pulling-docker-images
- - /packages/publishing-and-managing-packages/publishing-a-package
- - /packages/publishing-and-managing-packages/installing-a-package
-popularLinks:
- - /packages/using-github-packages-with-your-projects-ecosystem/configuring-npm-for-use-with-github-packages
- - /packages/using-github-packages-with-your-projects-ecosystem/configuring-docker-for-use-with-github-packages
- - /packages/managing-container-images-with-github-container-registry/pushing-and-pulling-docker-images
- - /packages/using-github-packages-with-your-projects-ecosystem/using-github-packages-with-github-actions
+featuredLinks:
+ gettingStarted:
+ - /packages/publishing-and-managing-packages/about-github-packages
+ - /packages/getting-started-with-github-container-registry/about-github-container-registry
+ - /packages/getting-started-with-github-container-registry
+ - /packages/managing-container-images-with-github-container-registry/pushing-and-pulling-docker-images
+ - /packages/publishing-and-managing-packages/publishing-a-package
+ - /packages/publishing-and-managing-packages/installing-a-package
+ popular:
+ - /packages/using-github-packages-with-your-projects-ecosystem/configuring-npm-for-use-with-github-packages
+ - /packages/using-github-packages-with-your-projects-ecosystem/configuring-docker-for-use-with-github-packages
+ - /packages/managing-container-images-with-github-container-registry/pushing-and-pulling-docker-images
+ - /packages/using-github-packages-with-your-projects-ecosystem/using-github-packages-with-github-actions
redirect_from:
- /github/managing-packages-with-github-packages
- /categories/managing-packages-with-github-package-registry
diff --git a/content/packages/publishing-and-managing-packages/about-github-packages.md b/content/packages/publishing-and-managing-packages/about-github-packages.md
index 2d87941b7427..32f561cf5286 100644
--- a/content/packages/publishing-and-managing-packages/about-github-packages.md
+++ b/content/packages/publishing-and-managing-packages/about-github-packages.md
@@ -85,15 +85,15 @@ For more information about the container support offered by {% data variables.pr
#### Support for package registries
{% if currentVersion == "free-pro-team@latest" %}
-Package registries use `PACKAGE-TYPE.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME` as the package host URL, replacing `PACKAGE-TYPE` with the Package namespace. For example, your Gemfile will be hosted at `rubygem.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME`.
+Package registries use `PACKAGE-TYPE.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME` as the package host URL, replacing `PACKAGE-TYPE` with the Package namespace. For example, your Gemfile will be hosted at `rubygems.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME`.
{% else %}
-The package types supported on {% data variables.product.product_location_enterprise %} may vary since your site administrator can enable or disable support for different package types. For more information, see "[Managing GitHub Packages for your enterprise](/enterprise/admin/packages)."
+The package types supported on {% data variables.product.product_location %} may vary since your site administrator can enable or disable support for different package types. For more information, see "[Managing GitHub Packages for your enterprise](/enterprise/admin/packages)."
-If {% data variables.product.product_location_enterprise %} has subdomain isolation enabled, then package registries will use `PACKAGE-TYPE.HOSTNAME/OWNER/REPOSITORY/IMAGE-NAME` as the package host URL, replacing `PACKAGE-TYPE` with the Package namespace. For example, your Dockerfile will be hosted at `docker.HOSTNAME/OWNER/REPOSITORY/IMAGE-NAME`.
+If {% data variables.product.product_location %} has subdomain isolation enabled, then package registries will use `PACKAGE-TYPE.HOSTNAME/OWNER/REPOSITORY/IMAGE-NAME` as the package host URL, replacing `PACKAGE-TYPE` with the Package namespace. For example, your Dockerfile will be hosted at `docker.HOSTNAME/OWNER/REPOSITORY/IMAGE-NAME`.
-If {% data variables.product.product_location_enterprise %} has subdomain isolation disabled, then package registries will use `HOSTNAME/_registry/PACKAGE-TYPE/OWNER/REPOSITORY/IMAGE-NAME` as the package host URL. For example, your Gemfile will be hosted at `HOSTNAME/_registry/rubygems/OWNER/REPOSITORY/IMAGE-NAME`, replacing *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance.
+If {% data variables.product.product_location %} has subdomain isolation disabled, then package registries will use `HOSTNAME/_registry/PACKAGE-TYPE/OWNER/REPOSITORY/IMAGE-NAME` as the package host URL. For example, your Gemfile will be hosted at `HOSTNAME/_registry/rubygems/OWNER/REPOSITORY/IMAGE-NAME`, replacing *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance.
{% endif %}
@@ -103,13 +103,13 @@ If {% data variables.product.product_location_enterprise %} has subdomain isolat
| --- | --- | --- | --- | --- |
| JavaScript | Node package manager | `package.json` | `npm` | `npm.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME`
| Ruby | RubyGems package manager | `Gemfile` | `gem` | `rubygems.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME`
-| Java | Apache Maven project management and comprehension tool | `pom.xml` | `mvn` | `maven.HOSTNAME/OWNER/REPOSITORY/IMAGE-NAME`
-| Java | Gradle build automation tool for Java | `build.gradle` or `build.gradle.kts` | `gradle` | `maven.HOSTNAME/OWNER/REPOSITORY/IMAGE-NAME`
-| .NET | NuGet package management for .NET | `nupkg` | `dotnet` CLI | nuget.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME`
+| Java | Apache Maven project management and comprehension tool | `pom.xml` | `mvn` | `maven.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME`
+| Java | Gradle build automation tool for Java | `build.gradle` or `build.gradle.kts` | `gradle` | `maven.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME`
+| .NET | NuGet package management for .NET | `nupkg` | `dotnet` CLI | `nuget.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME`
{% else %}
-With subdomain isolation enabled on {% data variables.product.product_location_enterprise %}:
+With subdomain isolation enabled on {% data variables.product.product_location %}:
| Language | Description | Package format | Package client | Package namespace |
| --- | --- | --- | --- | --- |
@@ -120,7 +120,7 @@ With subdomain isolation enabled on {% data variables.product.product_location_e
| .NET | NuGet package management for .NET | `nupkg` | `dotnet` CLI | `nuget.HOSTNAME/OWNER/REPOSITORY/IMAGE-NAME`
| N/A | Docker container management | `Dockerfile` | `Docker` | `docker.HOSTNAME/OWNER/REPOSITORY/IMAGE-NAME`
-With subdomain isolation disabled on {% data variables.product.product_location_enterprise %}:
+With subdomain isolation disabled on {% data variables.product.product_location %}:
| Language | Description | Package format | Package client | Package namespace |
| --- | --- | --- | --- | --- |
@@ -166,7 +166,7 @@ For more information, see "[Creating a personal access token](/github/authentica
To use or manage a package hosted by a package registry, you must use a token with the appropriate scope, and your user account must have appropriate permissions for that repository.
For example:
-- To download and install packages from a repository, your token must have the `read:packages` scope, and your user account must have read permissions for the repository. If the repository is private, your token must also have the `repo` scope.
+- To download and install packages from a repository, your token must have the `read:packages` scope, and your user account must have read permissions for the repository.
- To delete a specified version of a private package on {% data variables.product.product_name %}, your token must have the `delete:packages` and `repo` scope. Public packages cannot be deleted. For more information, see "[Deleting a package](/packages/publishing-and-managing-packages/deleting-a-package)."
| Scope | Description | Repository permissions |
@@ -174,7 +174,7 @@ For example:
|`read:packages`| Download and install packages from {% data variables.product.prodname_registry %} | read |
|`write:packages`| Upload and publish packages to {% data variables.product.prodname_registry %} | write |
| `delete:packages` | Delete specified versions of private packages from {% data variables.product.prodname_registry %} | admin |
-| `repo` | Install, upload, and delete certain packages in private repositories (along with `read:packages`, `write:packages`, or `delete:packages`) | read, write, or admin |
+| `repo` | Upload and delete packages (along with `write:packages`, or `delete:packages`) | write, or admin |
When you create a {% data variables.product.prodname_actions %} workflow, you can use the `GITHUB_TOKEN` to publish and install packages in {% data variables.product.prodname_registry %} without needing to store and manage a personal access token.
diff --git a/content/packages/publishing-and-managing-packages/deleting-a-package.md b/content/packages/publishing-and-managing-packages/deleting-a-package.md
index e43d8f4ca603..72db48bacf84 100644
--- a/content/packages/publishing-and-managing-packages/deleting-a-package.md
+++ b/content/packages/publishing-and-managing-packages/deleting-a-package.md
@@ -31,7 +31,7 @@ Under special circumstances, such as for legal reasons or to conform with GDPR s
{% else %}
-At this time, {% data variables.product.prodname_registry %} on {% data variables.product.product_location_enterprise %} does not support deleting public packages.
+At this time, {% data variables.product.prodname_registry %} on {% data variables.product.product_location %} does not support deleting public packages.
{% endif %}
diff --git a/content/packages/publishing-and-managing-packages/publishing-a-package.md b/content/packages/publishing-and-managing-packages/publishing-a-package.md
index 93fbdbffb4b7..68d69b2a592f 100644
--- a/content/packages/publishing-and-managing-packages/publishing-a-package.md
+++ b/content/packages/publishing-and-managing-packages/publishing-a-package.md
@@ -21,7 +21,7 @@ You can help people understand and use your package by providing a description a
{% data reusables.package_registry.package-immutability %}
{% if currentVersion == "free-pro-team@latest" %}
-If a new version of a package fixes a security vulnerability, you should publish a security advisory in your repository. {% data variables.product.prodname_dotcom %} reviews each published security advisory and may use it to send {% data variables.product.prodname_dependabot_short %} alerts to affected repositories. For more information, see "[About GitHub Security Advisories](/github/managing-security-vulnerabilities/about-github-security-advisories)."
+If a new version of a package fixes a security vulnerability, you should publish a security advisory in your repository. {% data variables.product.prodname_dotcom %} reviews each published security advisory and may use it to send {% data variables.product.prodname_dependabot_alerts %} to affected repositories. For more information, see "[About GitHub Security Advisories](/github/managing-security-vulnerabilities/about-github-security-advisories)."
{% endif %}
### Publishing a package
diff --git a/content/packages/using-github-packages-with-your-projects-ecosystem/configuring-apache-maven-for-use-with-github-packages.md b/content/packages/using-github-packages-with-your-projects-ecosystem/configuring-apache-maven-for-use-with-github-packages.md
index 13b5a865bcc4..9ac1b3572eb0 100644
--- a/content/packages/using-github-packages-with-your-projects-ecosystem/configuring-apache-maven-for-use-with-github-packages.md
+++ b/content/packages/using-github-packages-with-your-projects-ecosystem/configuring-apache-maven-for-use-with-github-packages.md
@@ -27,13 +27,13 @@ You can authenticate to {% data variables.product.prodname_registry %} with Apac
In the `servers` tag, add a child `server` tag with an `id`, replacing *USERNAME* with your {% data variables.product.prodname_dotcom %} username, and *TOKEN* with your personal access token.
-In the `repositories` tag, configure a repository by mapping the `id` of the repository to the `id` you added in the `server` tag containing your credentials. Replace {% if currentVersion != "free-pro-team@latest" %}*HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance, {% endif %}*REPOSITORY* with the name of the repository you'd like to publish a package to or install a package from, and *OWNER* with the name of the user or organization account that owns the repository. {% data reusables.package_registry.lowercase-name-field %}
+In the `repositories` tag, configure a repository by mapping the `id` of the repository to the `id` you added in the `server` tag containing your credentials. Replace {% if enterpriseServerVersions contains currentVersion %}*HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance, {% endif %}*REPOSITORY* with the name of the repository you'd like to publish a package to or install a package from, and *OWNER* with the name of the user or organization account that owns the repository. {% data reusables.package_registry.lowercase-name-field %}
If you want to interact with multiple repositories, you can add each repository to separate `repository` children in the `repositories` tag, mapping the `id` of each to the credentials in the `servers` tag.
{% data reusables.package_registry.apache-maven-snapshot-versions-supported %}
-{% if currentVersion != "free-pro-team@latest" %}
+{% if enterpriseServerVersions contains currentVersion %}
If your instance has subdomain isolation enabled:
{% endif %}
@@ -76,7 +76,7 @@ If your instance has subdomain isolation enabled:
```
-{% if currentVersion != "free-pro-team@latest" %}
+{% if enterpriseServerVersions contains currentVersion %}
If your instance has subdomain isolation disabled:
```
@@ -131,8 +131,8 @@ If you would like to publish multiple packages to the same repository, you can i
For more information on creating a package, see the [maven.apache.org documentation](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html).
-1. Edit the `distributionManagement` element of the *pom.xml* file located in your package directory, replacing {% if currentVersion != "free-pro-team@latest" %}*HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance, {% endif %}`OWNER` with the name of the user or organization account that owns the repository and `REPOSITORY` with the name of the repository containing your project.
- {% if currentVersion != "free-pro-team@latest" %}
+1. Edit the `distributionManagement` element of the *pom.xml* file located in your package directory, replacing {% if enterpriseServerVersions contains currentVersion %}*HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance, {% endif %}`OWNER` with the name of the user or organization account that owns the repository and `REPOSITORY` with the name of the repository containing your project.
+ {% if enterpriseServerVersions contains currentVersion %}
If your instance has subdomain isolation enabled:
{% endif %}
```
@@ -144,7 +144,7 @@ For more information on creating a package, see the [maven.apache.org documentat
```
- {% if currentVersion != "free-pro-team@latest" %}
+ {% if enterpriseServerVersions contains currentVersion %}
If your instance has subdomain isolation disabled:
```
diff --git a/content/packages/using-github-packages-with-your-projects-ecosystem/configuring-docker-for-use-with-github-packages.md b/content/packages/using-github-packages-with-your-projects-ecosystem/configuring-docker-for-use-with-github-packages.md
index 59c0d2c8b81b..a929dc86ee2e 100644
--- a/content/packages/using-github-packages-with-your-projects-ecosystem/configuring-docker-for-use-with-github-packages.md
+++ b/content/packages/using-github-packages-with-your-projects-ecosystem/configuring-docker-for-use-with-github-packages.md
@@ -21,9 +21,9 @@ versions:
When installing or publishing a docker image, {% data variables.product.prodname_registry %} does not currently support foreign layers, such as Windows images.
-{% if currentVersion != "free-pro-team@latest" %}
+{% if enterpriseServerVersions contains currentVersion %}
-Before you can use the Docker registry on {% data variables.product.prodname_registry %}, the site administrator for {% data variables.product.product_location_enterprise %} must enable Docker support and subdomain isolation for your instance. For more information, see "[Managing GitHub Packages for your enterprise](/enterprise/admin/packages)."
+Before you can use the Docker registry on {% data variables.product.prodname_registry %}, the site administrator for {% data variables.product.product_location %} must enable Docker support and subdomain isolation for your instance. For more information, see "[Managing GitHub Packages for your enterprise](/enterprise/admin/packages)."
{% endif %}
@@ -49,7 +49,7 @@ To keep your credentials secure, we recommend you save your personal access toke
{% endraw %}
{% endif %}
-{% if currentVersion != "free-pro-team@latest" %}
+{% if enterpriseServerVersions contains currentVersion %}
{% raw %}
```shell
$ cat ~/TOKEN.txt | docker login docker.HOSTNAME -u USERNAME --password-stdin
@@ -57,7 +57,7 @@ To keep your credentials secure, we recommend you save your personal access toke
{% endraw %}
{% endif %}
-To use this example login command, replace `USERNAME` with your {% data variables.product.product_name %} username{% if currentVersion != "free-pro-team@latest" %}, `HOSTNAME` with the URL for {% data variables.product.product_location_enterprise %},{% endif %} and `~/TOKEN.txt` with the file path to your personal access token for {% data variables.product.product_name %}.
+To use this example login command, replace `USERNAME` with your {% data variables.product.product_name %} username{% if enterpriseServerVersions contains currentVersion %}, `HOSTNAME` with the URL for {% data variables.product.product_location %},{% endif %} and `~/TOKEN.txt` with the file path to your personal access token for {% data variables.product.product_name %}.
For more information, see "[Docker login](https://docs.docker.com/engine/reference/commandline/login/#provide-a-password-using-stdin)."
@@ -82,7 +82,7 @@ For more information, see "[Docker login](https://docs.docker.com/engine/referen
> REPOSITORY TAG IMAGE ID CREATED SIZE
> IMAGE_NAME VERSION IMAGE_ID 4 weeks ago 1.11MB
```
-2. Using the Docker image ID, tag the docker image, replacing *OWNER* with the name of the user or organization account that owns the repository, *REPOSITORY* with the name of the repository containing your project, *IMAGE_NAME* with name of the package or image,{% if currentVersion != "free-pro-team@latest" %} *HOSTNAME* with the hostname of {% data variables.product.product_location_enterprise %},{% endif %} and *VERSION* with package version at build time.
+2. Using the Docker image ID, tag the docker image, replacing *OWNER* with the name of the user or organization account that owns the repository, *REPOSITORY* with the name of the repository containing your project, *IMAGE_NAME* with name of the package or image,{% if enterpriseServerVersions contains currentVersion %} *HOSTNAME* with the hostname of {% data variables.product.product_location %},{% endif %} and *VERSION* with package version at build time.
{% if currentVersion == "free-pro-team@latest" %}
```shell
$ docker tag IMAGE_ID docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:VERSION
@@ -92,7 +92,7 @@ For more information, see "[Docker login](https://docs.docker.com/engine/referen
$ docker tag IMAGE_ID docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION
```
{% endif %}
-3. If you haven't already built a docker image for the package, build the image, replacing *OWNER* with the name of the user or organization account that owns the repository, *REPOSITORY* with the name of the repository containing your project, *IMAGE_NAME* with name of the package or image, *VERSION* with package version at build time,{% if currentVersion != "free-pro-team@latest" %} *HOSTNAME* with the hostname of {% data variables.product.product_location_enterprise %},{% endif %} and *PATH* to the image if it isn't in the current working directory.s
+3. If you haven't already built a docker image for the package, build the image, replacing *OWNER* with the name of the user or organization account that owns the repository, *REPOSITORY* with the name of the repository containing your project, *IMAGE_NAME* with name of the package or image, *VERSION* with package version at build time,{% if enterpriseServerVersions contains currentVersion %} *HOSTNAME* with the hostname of {% data variables.product.product_location %},{% endif %} and *PATH* to the image if it isn't in the current working directory.
{% if currentVersion == "free-pro-team@latest" %}
```shell
$ docker build -t docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:VERSION PATH
@@ -182,7 +182,7 @@ $ docker push docker.HOSTNAME/octocat/octo-app/monalisa:1.0
{% data reusables.package_registry.docker_registry_deprecation_status %}
-You can use the `docker pull` command to install a docker image from {% data variables.product.prodname_registry %}, replacing *OWNER* with the name of the user or organization account that owns the repository, *REPOSITORY* with the name of the repository containing your project, *IMAGE_NAME* with name of the package or image,{% if currentVersion != "free-pro-team@latest" %}*HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance, {% endif %} and *TAG_NAME* with tag for the image you want to install. {% data reusables.package_registry.lowercase-name-field %}
+You can use the `docker pull` command to install a docker image from {% data variables.product.prodname_registry %}, replacing *OWNER* with the name of the user or organization account that owns the repository, *REPOSITORY* with the name of the repository containing your project, *IMAGE_NAME* with name of the package or image,{% if enterpriseServerVersions contains currentVersion %}*HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance, {% endif %} and *TAG_NAME* with tag for the image you want to install. {% data reusables.package_registry.lowercase-name-field %}
{% if currentVersion == "free-pro-team@latest" %}
```shell
diff --git a/content/packages/using-github-packages-with-your-projects-ecosystem/configuring-dotnet-cli-for-use-with-github-packages.md b/content/packages/using-github-packages-with-your-projects-ecosystem/configuring-dotnet-cli-for-use-with-github-packages.md
index 714d78f211ce..a5fa36cc7e53 100644
--- a/content/packages/using-github-packages-with-your-projects-ecosystem/configuring-dotnet-cli-for-use-with-github-packages.md
+++ b/content/packages/using-github-packages-with-your-projects-ecosystem/configuring-dotnet-cli-for-use-with-github-packages.md
@@ -29,7 +29,7 @@ To authenticate to {% data variables.product.prodname_registry %} with the `dotn
You must replace:
- `USERNAME` with the name of your user account on {% data variables.product.prodname_dotcom %}.
- `TOKEN` with your personal access token.
-- `OWNER` with the name of the user or organization account that owns the repository containing your project.{% if currentVersion != "free-pro-team@latest" %}
+- `OWNER` with the name of the user or organization account that owns the repository containing your project.{% if enterpriseServerVersions contains currentVersion %}
- `HOSTNAME` with the host name for your {% data variables.product.prodname_ghe_server %} instance.
If your instance has subdomain isolation enabled:
@@ -51,7 +51,7 @@ If your instance has subdomain isolation enabled:
```
-{% if currentVersion != "free-pro-team@latest" %}
+{% if enterpriseServerVersions contains currentVersion %}
If your instance has subdomain isolation disabled:
```xml
@@ -77,7 +77,7 @@ If your instance has subdomain isolation disabled:
### Publishing a package
-You can publish a package to {% data variables.product.prodname_registry %} by authenticating with a *nuget.config* file. When publishing, you need to use the same value for `OWNER` in your *csproj* file that you use in your *nuget.config* authentication file. Specify or increment the version number in your *.csproj* file, then use the `dotnet pack` command to create a *.nuspec* file for that version. For more information on creating your package, see "[Create and publish a package](https://docs.microsoft.com/en-us/nuget/quickstart/create-and-publish-a-package-using-the-dotnet-cli)" in the Microsoft documentation.
+You can publish a package to {% data variables.product.prodname_registry %} by authenticating with a *nuget.config* file. When publishing, you need to use the same value for `OWNER` in your *csproj* file that you use in your *nuget.config* authentication file. Specify or increment the version number in your *.csproj* file, then use the `dotnet pack` command to create a *.nuspec* file for that version. For more information on creating your package, see "[Create and publish a package](https://docs.microsoft.com/nuget/quickstart/create-and-publish-a-package-using-the-dotnet-cli)" in the Microsoft documentation.
{% data reusables.package_registry.viewing-packages %}
@@ -89,7 +89,7 @@ You can publish a package to {% data variables.product.prodname_registry %} by a
3. Add your project's specific information to your project's file, which ends in *.csproj*. You must replace:
- `OWNER` with the name of the user or organization account that owns the repository containing your project.
- `REPOSITORY` with the name of the repository containing the package you want to publish.
- - `1.0.0` with the version number of the package.{% if currentVersion != "free-pro-team@latest" %}
+ - `1.0.0` with the version number of the package.{% if enterpriseServerVersions contains currentVersion %}
- `HOSTNAME` with the host name for your {% data variables.product.prodname_ghe_server %} instance.{% endif %}
``` xml
@@ -159,7 +159,7 @@ For example, the *OctodogApp* and *OctocatApp* projects will publish to the same
### Installing a package
-Using packages from {% data variables.product.prodname_dotcom %} in your project is similar to using packages from *nuget.org*. Add your package dependencies to your *.csproj* file, specifying the package name and version. For more information on using a *.csproj* file in your project, see "[Working with NuGet packages](https://docs.microsoft.com/en-us/nuget/consume-packages/overview-and-workflow)" in the Microsoft documentation.
+Using packages from {% data variables.product.prodname_dotcom %} in your project is similar to using packages from *nuget.org*. Add your package dependencies to your *.csproj* file, specifying the package name and version. For more information on using a *.csproj* file in your project, see "[Working with NuGet packages](https://docs.microsoft.com/nuget/consume-packages/overview-and-workflow)" in the Microsoft documentation.
{% data reusables.package_registry.authenticate-step %}
diff --git a/content/packages/using-github-packages-with-your-projects-ecosystem/configuring-gradle-for-use-with-github-packages.md b/content/packages/using-github-packages-with-your-projects-ecosystem/configuring-gradle-for-use-with-github-packages.md
index 238875ff8ba1..7e84a715f372 100644
--- a/content/packages/using-github-packages-with-your-projects-ecosystem/configuring-gradle-for-use-with-github-packages.md
+++ b/content/packages/using-github-packages-with-your-projects-ecosystem/configuring-gradle-for-use-with-github-packages.md
@@ -25,7 +25,7 @@ versions:
You can authenticate to {% data variables.product.prodname_registry %} with Gradle using either Gradle Groovy or Kotlin DSL by editing your *build.gradle* file (Gradle Groovy) or *build.gradle.kts* file (Kotlin DSL) file to include your personal access token. You can also configure Gradle Groovy and Kotlin DSL to recognize a single package or multiple packages in a repository.
-{% if currentVersion != "free-pro-team@latest" %}
+{% if enterpriseServerVersions contains currentVersion %}
Replace *REGISTRY-URL* with the URL for your instance's Maven registry. If your instance has subdomain isolation enabled, use `maven.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/maven`. In either case, replace *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance.
{% endif %}
diff --git a/content/packages/using-github-packages-with-your-projects-ecosystem/configuring-npm-for-use-with-github-packages.md b/content/packages/using-github-packages-with-your-projects-ecosystem/configuring-npm-for-use-with-github-packages.md
index efc0e2d45072..c20f4464fadb 100644
--- a/content/packages/using-github-packages-with-your-projects-ecosystem/configuring-npm-for-use-with-github-packages.md
+++ b/content/packages/using-github-packages-with-your-projects-ecosystem/configuring-npm-for-use-with-github-packages.md
@@ -25,9 +25,9 @@ versions:
You can authenticate to {% data variables.product.prodname_registry %} with npm by either editing your per-user *~/.npmrc* file to include your personal access token or by logging in to npm on the command line using your username and personal access token.
-To authenticate by adding your personal access token to your *~/.npmrc* file, edit the *~/.npmrc* file for your project to include the following line, replacing {% if currentVersion != "free-pro-team@latest" %}*HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance and {% endif %}*TOKEN* with your personal access token. Create a new *~/.npmrc* file if one doesn't exist.
+To authenticate by adding your personal access token to your *~/.npmrc* file, edit the *~/.npmrc* file for your project to include the following line, replacing {% if enterpriseServerVersions contains currentVersion %}*HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance and {% endif %}*TOKEN* with your personal access token. Create a new *~/.npmrc* file if one doesn't exist.
-{% if currentVersion != "free-pro-team@latest" %}
+{% if enterpriseServerVersions contains currentVersion %}
If your instance has subdomain isolation enabled:
{% endif %}
@@ -35,7 +35,7 @@ If your instance has subdomain isolation enabled:
//{% if currentVersion == "free-pro-team@latest" %}npm.pkg.github.com{% else %}npm.HOSTNAME/{% endif %}/:_authToken=TOKEN
```
-{% if currentVersion != "free-pro-team@latest" %}
+{% if enterpriseServerVersions contains currentVersion %}
If your instance has subdomain isolation disabled:
```shell
@@ -45,7 +45,7 @@ If your instance has subdomain isolation disabled:
To authenticate by logging in to npm, use the `npm login` command, replacing *USERNAME* with your {% data variables.product.prodname_dotcom %} username, *TOKEN* with your personal access token, and *PUBLIC-EMAIL-ADDRESS* with your email address.
-{% if currentVersion != "free-pro-team@latest" %}
+{% if enterpriseServerVersions contains currentVersion %}
If your instance has subdomain isolation enabled:
{% endif %}
@@ -56,7 +56,7 @@ $ npm login --registry=https://{% if currentVersion == "free-pro-team@latest" %}
> Email: PUBLIC-EMAIL-ADDRESS
```
-{% if currentVersion != "free-pro-team@latest" %}
+{% if enterpriseServerVersions contains currentVersion %}
If your instance has subdomain isolation disabled:
```shell
@@ -97,7 +97,7 @@ You can use an *.npmrc* file to configure the scope mapping for your project. In
You can use `publishConfig` element in the *package.json* file to specify the registry where you want the package published. For more information, see "[publishConfig](https://docs.npmjs.com/files/package.json#publishconfig)" in the npm documentation.
1. Edit the *package.json* file for your package and include a `publishConfig` entry.
- {% if currentVersion != "free-pro-team@latest" %}
+ {% if enterpriseServerVersions contains currentVersion %}
If your instance has subdomain isolation enabled:
{% endif %}
```shell
@@ -105,7 +105,7 @@ You can use `publishConfig` element in the *package.json* file to specify the re
"registry":"https://{% if currentVersion == "free-pro-team@latest" %}npm.pkg.github.com{% else %}npm.HOSTNAME/{% endif %}"
},
```
- {% if currentVersion != "free-pro-team@latest" %}
+ {% if enterpriseServerVersions contains currentVersion %}
If your instance has subdomain isolation disabled:
```shell
"publishConfig": {
@@ -166,25 +166,25 @@ You also need to add the *.npmrc* file to your project so all requests to instal
#### Installing packages from other organizations
-By default, you can only use {% data variables.product.prodname_registry %} packages from one organization. If you'd like to route package requests to multiple organizations and users, you can add additional lines to your *.npmrc* file, replacing {% if currentVersion != "free-pro-team@latest" %}*HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance and {% endif %}*OWNER* with the name of the user or organization account that owns the repository containing your project. {% data reusables.package_registry.lowercase-name-field %}
+By default, you can only use {% data variables.product.prodname_registry %} packages from one organization. If you'd like to route package requests to multiple organizations and users, you can add additional lines to your *.npmrc* file, replacing {% if enterpriseServerVersions contains currentVersion %}*HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance and {% endif %}*OWNER* with the name of the user or organization account that owns the repository containing your project. {% data reusables.package_registry.lowercase-name-field %}
-{% if currentVersion != "free-pro-team@latest" %}
+{% if enterpriseServerVersions contains currentVersion %}
If your instance has subdomain isolation enabled:
{% endif %}
```shell
registry=https://{% if currentVersion == "free-pro-team@latest" %}npm.pkg.github.com{% else %}npm.HOSTNAME{% endif %}/OWNER
-@OWNER:registry={% if currentVersion == "free-pro-team@latest" %}npm.pkg.github.com{% else %}npm.HOSTNAME/{% endif %}
-@OWNER:registry={% if currentVersion == "free-pro-team@latest" %}npm.pkg.github.com{% else %}npm.HOSTNAME/{% endif %}
+@OWNER:registry=https://{% if currentVersion == "free-pro-team@latest" %}npm.pkg.github.com{% else %}npm.HOSTNAME/{% endif %}
+@OWNER:registry=https://{% if currentVersion == "free-pro-team@latest" %}npm.pkg.github.com{% else %}npm.HOSTNAME/{% endif %}
```
-{% if currentVersion != "free-pro-team@latest" %}
+{% if enterpriseServerVersions contains currentVersion %}
If your instance has subdomain isolation disabled:
```shell
registry=https://HOSTNAME/_registry/npm/OWNER
-@OWNER:registry=HOSTNAME/_registry/npm/
-@OWNER:registry=HOSTNAME/_registry/npm/
+@OWNER:registry=https://HOSTNAME/_registry/npm/
+@OWNER:registry=https://HOSTNAME/_registry/npm/
```
{% endif %}
diff --git a/content/packages/using-github-packages-with-your-projects-ecosystem/configuring-rubygems-for-use-with-github-packages.md b/content/packages/using-github-packages-with-your-projects-ecosystem/configuring-rubygems-for-use-with-github-packages.md
index 35f32a1ae337..da2523152173 100644
--- a/content/packages/using-github-packages-with-your-projects-ecosystem/configuring-rubygems-for-use-with-github-packages.md
+++ b/content/packages/using-github-packages-with-your-projects-ecosystem/configuring-rubygems-for-use-with-github-packages.md
@@ -56,7 +56,7 @@ For example, you would create or edit a *~/.gem/credentials* to include the foll
To install gems, you need to authenticate to {% data variables.product.prodname_registry %} by editing the *~/.gemrc* file for your project to include `https://USERNAME:TOKEN@{% if currentVersion == "free-pro-team@latest" %}rubygems.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER/`. You must replace:
- `USERNAME` with your {% data variables.product.prodname_dotcom %} username.
- `TOKEN` with your personal access token.
- - `OWNER` with the name of the user or organization account that owns the repository containing your project.{% if currentVersion != "free-pro-team@latest" %}
+ - `OWNER` with the name of the user or organization account that owns the repository containing your project.{% if enterpriseServerVersions contains currentVersion %}
- `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the hostname of your {% data variables.product.prodname_ghe_server %} instance.
{% endif %}
@@ -74,7 +74,7 @@ If you don't have a *~/.gemrc* file, create a new *~/.gemrc* file using this exa
```
-To authenticate with Bundler, configure Bundler to use your personal access token, replacing *USERNAME* with your {% data variables.product.prodname_dotcom %} username, *TOKEN* with your personal access token, and *OWNER* with the name of the user or organization account that owns the repository containing your project.{% if currentVersion != "free-pro-team@latest" %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the hostname of your {% data variables.product.prodname_ghe_server %} instance.{% endif %}
+To authenticate with Bundler, configure Bundler to use your personal access token, replacing *USERNAME* with your {% data variables.product.prodname_dotcom %} username, *TOKEN* with your personal access token, and *OWNER* with the name of the user or organization account that owns the repository containing your project.{% if enterpriseServerVersions contains currentVersion %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the hostname of your {% data variables.product.prodname_ghe_server %} instance.{% endif %}
{% data reusables.package_registry.lowercase-name-field %}
@@ -97,7 +97,7 @@ $ bundle config https://{% if currentVersion == "free-pro-team@latest" %}rubygem
```shell
gem build OCTO-GEM.gemspec
```
-3. Publish a package to {% data variables.product.prodname_registry %}, replacing `OWNER` with the name of the user or organization account that owns the repository containing your project and `OCTO-GEM` with the name of your gem package.{% if currentVersion != "free-pro-team@latest" %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance.{% endif %}
+3. Publish a package to {% data variables.product.prodname_registry %}, replacing `OWNER` with the name of the user or organization account that owns the repository containing your project and `OCTO-GEM` with the name of your gem package.{% if enterpriseServerVersions contains currentVersion %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance.{% endif %}
```shell
$ gem push --key github \
@@ -107,7 +107,7 @@ $ bundle config https://{% if currentVersion == "free-pro-team@latest" %}rubygem
### Publishing multiple packages to the same repository
-To publish multiple gems to the same repository, you can include the URL to the {% data variables.product.prodname_dotcom %} repository in the `github_repo` field in `gem.metadata`. If you include this field, {% data variables.product.prodname_dotcom %} matches the repository based on this value, instead of using the gem name.{% if currentVersion != "free-pro-team@latest" %} Replace *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance.{% endif %}
+To publish multiple gems to the same repository, you can include the URL to the {% data variables.product.prodname_dotcom %} repository in the `github_repo` field in `gem.metadata`. If you include this field, {% data variables.product.prodname_dotcom %} matches the repository based on this value, instead of using the gem name.{% if enterpriseServerVersions contains currentVersion %} Replace *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance.{% endif %}
```
gem.metadata = { "github_repo" => "ssh://{% if currentVersion == "free-pro-team@latest" %}github.com{% else %}HOSTNAME{% endif %}/OWNER/REPOSITORY" }
@@ -118,7 +118,7 @@ gem.metadata = { "github_repo" => "ssh://{% if currentVersion == "free-pro-team@
You can use gems from {% data variables.product.prodname_registry %} much like you use gems from *rubygems.org*. You need to authenticate to {% data variables.product.prodname_registry %} by adding your {% data variables.product.prodname_dotcom %} user or organization as a source in the *~/.gemrc* file or by using Bundler and editing you *Gemfile*.
{% data reusables.package_registry.authenticate-step %}
-2. For Bundler, add your {% data variables.product.prodname_dotcom %} user or organization as a source in your *Gemfile* to fetch gems from this new source. For example, you can add a new `source` block to your *Gemfile* that uses {% data variables.product.prodname_registry %} only for the packages you specify, replacing *GEM NAME* with the package you want to install from {% data variables.product.prodname_registry %} and *OWNER* with the user or organization that owns the repository containing the gem you want to install.{% if currentVersion != "free-pro-team@latest" %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance.{% endif %}
+2. For Bundler, add your {% data variables.product.prodname_dotcom %} user or organization as a source in your *Gemfile* to fetch gems from this new source. For example, you can add a new `source` block to your *Gemfile* that uses {% data variables.product.prodname_registry %} only for the packages you specify, replacing *GEM NAME* with the package you want to install from {% data variables.product.prodname_registry %} and *OWNER* with the user or organization that owns the repository containing the gem you want to install.{% if enterpriseServerVersions contains currentVersion %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance.{% endif %}
```
source "https://rubygems.org"
diff --git a/content/rest/guides/basics-of-authentication.md b/content/rest/guides/basics-of-authentication.md
index 20bb8620ee88..6637a367e58d 100644
--- a/content/rest/guides/basics-of-authentication.md
+++ b/content/rest/guides/basics-of-authentication.md
@@ -8,6 +8,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
@@ -56,8 +57,8 @@ end
```
Your client ID and client secret keys come from [your application's configuration
-page][app settings]. You should **never, _ever_** store these values in
-{% data variables.product.product_name %}--or any other public place, for that matter. We recommend storing them as
+page][app settings].{% if currentVersion == "free-pro-team@latest" %} You should **never, _ever_** store these values in
+{% data variables.product.product_name %}--or any other public place, for that matter.{% endif %} We recommend storing them as
[environment variables][about env vars]--which is exactly what we've done here.
Next, in _views/index.erb_, paste this content:
@@ -164,7 +165,7 @@ To help you gracefully handle these situations, all API responses for requests
made with valid tokens also contain an [`X-OAuth-Scopes` header][oauth scopes].
This header contains the list of scopes of the token that was used to make the
request. In addition to that, the OAuth Applications API provides an endpoint to {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
-[check a token for validity][/v3/apps/oauth_applications/#check-a-token]{% else %}[check a token for validity][/v3/apps/oauth_applications/#check-an-authorization]{% endif %}.
+[check a token for validity][/rest/reference/apps#check-a-token]{% else %}[check a token for validity][/v3/apps/oauth_applications/#check-an-authorization]{% endif %}.
Use this information to detect changes in token scopes, and inform your users of
changes in available application functionality.
diff --git a/content/rest/guides/best-practices-for-integrators.md b/content/rest/guides/best-practices-for-integrators.md
index 19f5cc9c5137..48aad9d0b0c4 100644
--- a/content/rest/guides/best-practices-for-integrators.md
+++ b/content/rest/guides/best-practices-for-integrators.md
@@ -7,10 +7,11 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
-Interested in integrating with the GitHub platform? [You're in good company](https://github.com/integrations). This guide will help you build an app that provides the best experience for your users *and* ensure that it's reliably interacting with the API.
+Interested in integrating with the GitHub platform? [You're in good company](https://github.com/integrations). This guide will help you build an app that provides the best experience for your users *and* ensure that it's reliably interacting with the API.
### Secure payloads delivered from GitHub
diff --git a/content/rest/guides/building-a-ci-server.md b/content/rest/guides/building-a-ci-server.md
index 9a6e10167732..f30f0cfb8320 100644
--- a/content/rest/guides/building-a-ci-server.md
+++ b/content/rest/guides/building-a-ci-server.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
@@ -149,7 +150,7 @@ def process_pull_request(pull_request)
@client.create_status(pull_request['base']['repo']['full_name'], pull_request['head']['sha'], 'success')
puts "Pull request processed!"
end
-```
+```
### Conclusion
diff --git a/content/rest/guides/delivering-deployments.md b/content/rest/guides/delivering-deployments.md
index c4187ee640ec..e6d72e1d51e1 100644
--- a/content/rest/guides/delivering-deployments.md
+++ b/content/rest/guides/delivering-deployments.md
@@ -8,9 +8,10 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
-
-
+
+
The [Deployments API][deploy API] provides your projects hosted on {% data variables.product.product_name %} with
the capability to launch them on a server that you own. Combined with
diff --git a/content/rest/guides/discovering-resources-for-a-user.md b/content/rest/guides/discovering-resources-for-a-user.md
index 7615a18b4cd0..bc7b0faf7740 100644
--- a/content/rest/guides/discovering-resources-for-a-user.md
+++ b/content/rest/guides/discovering-resources-for-a-user.md
@@ -7,9 +7,10 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
-
+
When making authenticated requests to the {% data variables.product.product_name %} API, applications often need to fetch the current user's repositories and organizations. In this guide, we'll explain how to reliably discover those resources.
diff --git a/content/rest/guides/getting-started-with-the-checks-api.md b/content/rest/guides/getting-started-with-the-checks-api.md
index bd4c1a2e595a..e83f7ecde716 100644
--- a/content/rest/guides/getting-started-with-the-checks-api.md
+++ b/content/rest/guides/getting-started-with-the-checks-api.md
@@ -4,6 +4,7 @@ intro: 'The Check Runs API enables you to build GitHub Apps that run powerful ch
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Overview
@@ -36,12 +37,12 @@ A check run is an individual test that is part of a check suite. Each run includ
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %}
If a check run is in a incomplete state for more than 14 days, then the check run's `conclusion` becomes `stale` and appears on {% data variables.product.prodname_dotcom %} as stale with {% octicon "issue-reopened" aria-label="The issue-reopened icon" %}. Only {% data variables.product.prodname_dotcom %} can mark check runs as `stale`. For more information about possible conclusions of a check run, see the [`conclusion` parameter](/rest/reference/checks#create-a-check-run--parameters).
{% endif %}
As soon as you receive the [`check_suite`](/webhooks/event-payloads/#check_suite) webhook, you can create the check run, even if the check is not complete. You can update the `status` of the check run as it completes with the values `queued`, `in_progress`, or `completed`, and you can update the `output` as more details become available. A check run can contain timestamps, a link to more details on your external site, detailed annotations for specific lines of code, and information about the analysis performed.
-
+
A check can also be manually re-run in the GitHub UI. See "[About status checks](/articles/about-status-checks#checks)" for more details. When this occurs, the GitHub App that created the check run will receive the [`check_run`](/webhooks/event-payloads/#check_run) webhook requesting a new check run. If you create a check run without creating a check suite, GitHub creates the check suite for you automatically.
diff --git a/content/rest/guides/getting-started-with-the-git-database-api.md b/content/rest/guides/getting-started-with-the-git-database-api.md
index 778759991a30..baa0b4003d6a 100644
--- a/content/rest/guides/getting-started-with-the-git-database-api.md
+++ b/content/rest/guides/getting-started-with-the-git-database-api.md
@@ -4,9 +4,10 @@ intro: 'The Git Database API gives you access to read and write raw Git objects
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
-### Overview
+### Overview
This basically allows you to reimplement a lot of Git functionality over our API - by creating raw objects directly into the database and updating branch references you could technically do just about anything that Git can do without having Git installed.
diff --git a/content/rest/guides/getting-started-with-the-rest-api.md b/content/rest/guides/getting-started-with-the-rest-api.md
index 9edebf89f2a2..12947fd92dd0 100644
--- a/content/rest/guides/getting-started-with-the-rest-api.md
+++ b/content/rest/guides/getting-started-with-the-rest-api.md
@@ -7,10 +7,11 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
-Let's walk through core API concepts as we tackle some everyday use cases.
+Let's walk through core API concepts as we tackle some everyday use cases.
### Overview
@@ -28,7 +29,7 @@ Let's start by testing our setup. Open up a command prompt and enter the
following command:
```shell
-$ curl {% data variables.product.api_url_pre %}/zen
+$ curl https://api.github.com/zen
> Keep it logically awesome.
```
@@ -39,7 +40,7 @@ Next, let's `GET` [Chris Wanstrath's][defunkt github] [GitHub profile][users api
```shell
# GET /users/defunkt
-$ curl {% data variables.product.api_url_pre %}/users/defunkt
+$ curl https://api.github.com/users/defunkt
> {
> "login": "defunkt",
@@ -53,7 +54,7 @@ $ curl {% data variables.product.api_url_pre %}/users/defunkt
Mmmmm, tastes like [JSON][json]. Let's add the `-i` flag to include headers:
```shell
-$ curl -i {% data variables.product.api_url_pre %}/users/defunkt
+$ curl -i https://api.github.com/users/defunkt
> HTTP/1.1 200 OK
> Server: GitHub.com
@@ -124,7 +125,13 @@ When authenticating, you should see your rate limit bumped to 5,000 requests an
You can easily [create a **personal access token**][personal token] using your [Personal access tokens settings page][tokens settings]:
+{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
+{% endif %}
+
+{% if currentVersion == "github-ae@latest" %}
+
+{% endif %}
#### Get your own user profile
diff --git a/content/rest/guides/index.md b/content/rest/guides/index.md
index c1cebd3f8862..bbdd90cbccd5 100644
--- a/content/rest/guides/index.md
+++ b/content/rest/guides/index.md
@@ -7,10 +7,9 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
-
-
This section of the documentation is intended to get you up-and-running with
real-world {% data variables.product.product_name %} API applications. We'll cover everything you need to know, from
authentication, to manipulating results, to combining results with other apps.
diff --git a/content/rest/guides/rendering-data-as-graphs.md b/content/rest/guides/rendering-data-as-graphs.md
index 5684e5ba380a..4be2cf0a4831 100644
--- a/content/rest/guides/rendering-data-as-graphs.md
+++ b/content/rest/guides/rendering-data-as-graphs.md
@@ -7,8 +7,9 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
-
+
In this guide, we're going to use the API to fetch information about repositories
diff --git a/content/rest/guides/traversing-with-pagination.md b/content/rest/guides/traversing-with-pagination.md
index 60e74421d5a0..d03a3cd6b68f 100644
--- a/content/rest/guides/traversing-with-pagination.md
+++ b/content/rest/guides/traversing-with-pagination.md
@@ -7,9 +7,10 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
-
+
The {% data variables.product.product_name %} API provides a vast wealth of information for developers to consume.
Most of the time, you might even find that you're asking for _too much_ information,
@@ -44,8 +45,8 @@ The `-I` parameter indicates that we only care about the headers, not the actual
content. In examining the result, you'll notice some information in the Link header
that looks like this:
- Link: <{% data variables.product.api_url_code %}/search/code?q=addClass+user%3Amozilla&page=2>; rel="next",
- <{% data variables.product.api_url_code %}/search/code?q=addClass+user%3Amozilla&page=34>; rel="last"
+ Link: ; rel="next",
+ ; rel="last"
Let's break that down. `rel="next"` says that the next page is `page=2`. This makes
sense, since by default, all paginated queries start at page `1.` `rel="last"`
@@ -68,10 +69,10 @@ $ curl -I "{% data variables.product.api_url_pre %}/search/code?q=addClass+user:
Here's the link header once more:
- Link: <{% data variables.product.api_url_code %}/search/code?q=addClass+user%3Amozilla&page=15>; rel="next",
- <{% data variables.product.api_url_code %}/search/code?q=addClass+user%3Amozilla&page=34>; rel="last",
- <{% data variables.product.api_url_code %}/search/code?q=addClass+user%3Amozilla&page=1>; rel="first",
- <{% data variables.product.api_url_code %}/search/code?q=addClass+user%3Amozilla&page=13>; rel="prev"
+ Link: ; rel="next",
+ ; rel="last",
+ ; rel="first",
+ ; rel="prev"
As expected, `rel="next"` is at 15, and `rel="last"` is still 34. But now we've
got some more information: `rel="first"` indicates the URL for the _first_ page,
@@ -90,8 +91,8 @@ $ curl -I "{% data variables.product.api_url_pre %}/search/code?q=addClass+user:
Notice what it does to the header response:
- Link: <{% data variables.product.api_url_code %}/search/code?q=addClass+user%3Amozilla&per_page=50&page=2>; rel="next",
- <{% data variables.product.api_url_code %}/search/code?q=addClass+user%3Amozilla&per_page=50&page=20>; rel="last"
+ Link: ; rel="next",
+ ; rel="last"
As you might have guessed, the `rel="last"` information says that the last page
is now 20. This is because we are asking for more information per page about
diff --git a/content/rest/guides/working-with-comments.md b/content/rest/guides/working-with-comments.md
index 81b0465ca43d..dc314fc8bcbf 100644
--- a/content/rest/guides/working-with-comments.md
+++ b/content/rest/guides/working-with-comments.md
@@ -7,13 +7,14 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
For any Pull Request, {% data variables.product.product_name %} provides three kinds of comment views:
[comments on the Pull Request][PR comment] as a whole, [comments on a specific line][PR line comment] within the Pull Request,
-and [comments on a specific commit][commit comment] within the Pull Request.
+and [comments on a specific commit][commit comment] within the Pull Request.
Each of these types of comments goes through a different portion of the {% data variables.product.product_name %} API.
In this guide, we'll explore how you can access and manipulate each one. For every
diff --git a/content/rest/index.md b/content/rest/index.md
index bca0a3e92453..cfdd709ba55b 100644
--- a/content/rest/index.md
+++ b/content/rest/index.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% link_with_intro /overview %}
diff --git a/content/rest/overview/api-previews.md b/content/rest/overview/api-previews.md
index 0e1f657a8b2a..9a4df5a0be31 100644
--- a/content/rest/overview/api-previews.md
+++ b/content/rest/overview/api-previews.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
@@ -47,7 +48,7 @@ Get a [list of events](/v3/issues/timeline/) for an issue or pull request.
**Custom media type:** `mockingbird-preview`
**Announced:** [2016-05-23](https://developer.github.com/changes/2016-05-23-timeline-preview-api/)
-{% if currentVersion != "free-pro-team@latest" %}
+{% if enterpriseServerVersions contains currentVersion %}
### Pre-receive environments
Create, list, update, and delete environments for pre-receive hooks.
@@ -56,7 +57,7 @@ Create, list, update, and delete environments for pre-receive hooks.
**Announced:** [2015-07-29](/rest/reference/enterprise-admin#pre-receive-environments)
{% endif %}
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
### Integrations
Manage [integrations](/early-access/integrations/) through the API.
@@ -80,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
@@ -113,7 +105,7 @@ View all [codes of conduct](/v3/codes_of_conduct) or get which code of conduct a
**Custom media type:** `scarlet-witch-preview`
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.20" %}
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.20" %}
### Nested teams
Include nested team content in [team](/v3/teams/) payloads.
@@ -123,7 +115,7 @@ Include nested team content in [team](/v3/teams/) payloads.
{% endif %}
-{% if currentVersion != "free-pro-team@latest" %}
+{% if currentVersion == "github-ae@latest" or enterpriseServerVersions contains currentVersion %}
### Global webhooks
@@ -134,7 +126,7 @@ Enables [global webhooks](/rest/reference/enterprise-admin#global-webhooks/) for
{% endif %}
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.20" %}
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.20" %}
### Repository transfer
Transfer a [repository](/v3/repos/) to an organization or user.
@@ -143,7 +135,7 @@ Transfer a [repository](/v3/repos/) to an organization or user.
**Announced:** [2017-11-09](https://developer.github.com/changes/2017-11-09-repository-transfer-api-preview)
{% endif %}
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
### Add lock reason
You can now add a reason when you [lock an issue](/v3/issues/#lock-an-issue).
@@ -166,7 +158,7 @@ You can now [require multiple approving reviews](/v3/repos/branches) for a pull
**Custom media type:** `luke-cage-preview`
**Announced:** [2018-03-16](https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews)
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.19" %}
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.19" %}
### Retrieve hovercard information
Retrieve information from [someone's hovercard](/v3/users/#get-contextual-information-for-a-user).
@@ -176,7 +168,7 @@ Retrieve information from [someone's hovercard](/v3/users/#get-contextual-inform
{% endif %}
-{% if currentVersion ver_lt "enterprise-server@2.23" %}
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.23" %}
### Check runs and check suites API
Allows a GitHub App to run external checks on a repository's code. See the [Check runs](/v3/checks/runs/) and [Check suites](/v3/checks/suites/) APIs for more details.
@@ -185,7 +177,7 @@ Allows a GitHub App to run external checks on a repository's code. See the [Chec
**Announced:** [2018-05-07](https://developer.github.com/changes/2018-05-07-new-checks-api-public-beta/)
{% endif %}
-{% if currentVersion != "free-pro-team@latest" %}
+{% if currentVersion == "github-ae@latest" or enterpriseServerVersions contains currentVersion %}
### Anonymous Git access to repositories
@@ -234,18 +226,7 @@ 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 currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.21" %}
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.21" %}
### Draft pull requests
You can use the Draft Pull Requests API and its [pull request](/v3/pulls/) endpoints to see whether a pull request is in draft state. To learn more about draft pull requests, see "[About pull requests](/articles/about-pull-requests/)".
@@ -269,7 +250,7 @@ You can use two new endpoints in the [Commits API](/v3/repos/commits/) to list b
**Custom media types:** `groot-preview`
**Announced:** [2019-04-11](https://developer.github.com/changes/2019-04-11-pulls-branches-for-commit/)
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.21" %}
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.21" %}
### Uninstall a GitHub App
Owners of GitHub Apps can now uninstall an app using the [Apps API](/v3/apps/#delete-an-installation-for-the-authenticated-app).
@@ -316,7 +297,7 @@ You can more securely manage tokens for OAuth Apps by using OAuth tokens as inpu
**Announced:** [2019-11-05](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api/)
{% endif %}
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %}
### New visibility parameter for the Repositories API
You can set and retrieve the visibility of a repository in the [Repositories API](/v3/repos/).
diff --git a/content/rest/overview/endpoints-available-for-github-apps.md b/content/rest/overview/endpoints-available-for-github-apps.md
index 9ae64ab8c3d2..bae1b28804bd 100644
--- a/content/rest/overview/endpoints-available-for-github-apps.md
+++ b/content/rest/overview/endpoints-available-for-github-apps.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
You must use an installation access token to access endpoints using your {% data variables.product.prodname_github_app %}. For more information, see "[Authenticating with {% data variables.product.prodname_github_apps %}](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation)."
diff --git a/content/rest/overview/index.md b/content/rest/overview/index.md
index b66e745f49a8..7e4de671cb08 100644
--- a/content/rest/overview/index.md
+++ b/content/rest/overview/index.md
@@ -5,6 +5,7 @@ intro: 'Learn about resources, libraries, previews and troubleshooting for {% da
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Table of Contents
@@ -15,4 +16,5 @@ versions:
{% link_in_list /troubleshooting %}
{% link_in_list /api-previews %}
{% link_in_list /libraries %}
+{% link_in_list /openapi-description %}
{% link_in_list /endpoints-available-for-github-apps %}
diff --git a/content/rest/overview/libraries.md b/content/rest/overview/libraries.md
index 293c3a163214..a1f11fa03b9a 100644
--- a/content/rest/overview/libraries.md
+++ b/content/rest/overview/libraries.md
@@ -11,13 +11,12 @@ versions:
- Octokit comes in
- many flavors
+ Octokit comes in many flavors
Use the official Octokit library, or choose between any of the available third party libraries.
-
@@ -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)
diff --git a/content/rest/overview/media-types.md b/content/rest/overview/media-types.md
index f8d2387b5844..38e671943916 100644
--- a/content/rest/overview/media-types.md
+++ b/content/rest/overview/media-types.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/rest/overview/openapi-description.md b/content/rest/overview/openapi-description.md
new file mode 100644
index 000000000000..cdd2e1188e98
--- /dev/null
+++ b/content/rest/overview/openapi-description.md
@@ -0,0 +1,27 @@
+---
+title: OpenAPI description
+intro: The {% data variables.product.product_name %} REST API is fully described in an OpenAPI 3.0 compliant document.
+versions:
+ free-pro-team: '*'
+ enterprise-server: '*'
+---
+
+### About OpenAPI descriptions
+
+[OpenAPI](https://swagger.io/docs/specification/about/) is a standard specification for describing REST APIs. OpenAPI descriptions allow both humans and machines to discover the capabilities of an API without needing to first read documentation or understand the implementation. {% data variables.product.company_short %} has made its REST API publicly available as an OpenAPI 3.0 compliant document.
+
+### Getting the {% data variables.product.company_short %} OpenAPI description
+
+You can find the description in the open source [REST API OpenAPI Description](https://github.com/github/rest-api-description) repository.
+
+We provide the description in two formats. The bundled version works for most cases, as it includes OpenAPI components for reuse and readability. If your tooling does not support inline references to components, we also provide a fully dereferenced version.
+
+### Using the {% data variables.product.company_short %} OpenAPI description
+
+There are many uses for an OpenAPI description. For example, you could:
+
+* Generate your own API client.
+* Validate and test a {% data variables.product.company_short %} REST API integration.
+* Explore and interact with the {% data variables.product.product_name %} REST API using third-party tools, such as Insomnia or Postman.
+
+For example, {% data variables.product.company_short %} uses the REST OpenAPI description to generate the {% data variables.product.product_name %} [REST API reference documentation](/rest/reference).
diff --git a/content/rest/overview/other-authentication-methods.md b/content/rest/overview/other-authentication-methods.md
index 6b38bf4caf53..5b70f6fd83a9 100644
--- a/content/rest/overview/other-authentication-methods.md
+++ b/content/rest/overview/other-authentication-methods.md
@@ -6,9 +6,11 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
+{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
While the API provides multiple methods for authentication, we strongly
recommend using [OAuth](/apps/building-integrations/setting-up-and-registering-oauth-apps/) for production applications. The other
methods provided are intended to be used for scripts or testing (i.e., cases
@@ -16,6 +18,14 @@ where full OAuth would be overkill). Third party applications that rely on
{% data variables.product.product_name %} for authentication should not ask for or collect {% data variables.product.product_name %} credentials.
Instead, they should use the [OAuth web flow](/apps/building-oauth-apps/authorizing-oauth-apps/).
+{% endif %}
+
+{% if currentVersion == "github-ae@latest" %}
+
+To authenticate we recommend using [OAuth](/apps/building-integrations/setting-up-and-registering-oauth-apps/) tokens, such a personal access token through the [OAuth web flow](/apps/building-oauth-apps/authorizing-oauth-apps/).
+
+{% endif %}
+
### Basic Authentication
The API supports Basic Authentication as defined in
@@ -36,6 +46,7 @@ $ curl -u username:token {% data variables.product.api_url_pre
This approach is useful if your tools only support Basic Authentication but you want to take advantage of OAuth access token security features.
+{% if enterpriseServerVersions contains currentVersion %}
#### Via username and password
{% data reusables.apps.deprecating_password_auth %}
@@ -52,6 +63,8 @@ $ curl -u username {% data variables.product.api_url_pre %}/user
```
If you have two-factor authentication enabled, make sure you understand how to [work with two-factor authentication](/v3/auth/#working-with-two-factor-authentication).
+{% endif %}
+
{% if currentVersion == "free-pro-team@latest" %}
#### Authenticating for SAML SSO
@@ -84,6 +97,7 @@ $ curl -v -H "Authorization: token TOKEN" {% data variables.product.api
The value `organizations` is a comma-separated list of organization IDs for organizations require authorization of your personal access token.
{% endif %}
+{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
### Working with two-factor authentication
{% data reusables.apps.deprecating_password_auth %}
@@ -92,6 +106,8 @@ When you have two-factor authentication enabled, [Basic Authentication](#basic-a
You can generate a new personal access token {% if currentVersion == "free-pro-team@latest" %}with [{% data variables.product.product_name %} developer settings](https://github.com/settings/tokens/new){% endif %} or use the "[Create a new authorization][create-access]" endpoint in the OAuth Authorizations API to generate a new OAuth token. For more information, see "[Creating a personal access token for the command line](/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line)". Then you would use these tokens to [authenticate using OAuth token][oauth-auth] with the GitHub API. The only time you need to authenticate with your username and password is when you create your OAuth token or use the OAuth Authorizations API.
+
+
#### Using the OAuth Authorizations API with two-factor authentication
When you make calls to the OAuth Authorizations API, Basic Authentication requires that you use a one-time password (OTP) and your username and password instead of tokens. When you attempt to authenticate with the OAuth Authorizations API, the server will respond with a `401 Unauthorized` and one of these headers to let you know that you need a two-factor authentication code:
@@ -108,6 +124,7 @@ $ curl --request POST \
--header 'x-github-otp: OTP' \
--data '{"scopes": ["public_repo"], "note": "test"}'
```
+{% endif %}
[create-access]: /v3/oauth_authorizations/#create-a-new-authorization
[curl]: http://curl.haxx.se/
diff --git a/content/rest/overview/resources-in-the-rest-api.md b/content/rest/overview/resources-in-the-rest-api.md
index ea2573b1ea6c..c275ff4b3a9a 100644
--- a/content/rest/overview/resources-in-the-rest-api.md
+++ b/content/rest/overview/resources-in-the-rest-api.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
@@ -41,7 +42,7 @@ $ curl -i {% data variables.product.api_url_pre %}/users/octocat/orgs
> X-GitHub-Media-Type: github.v3
> X-RateLimit-Limit: 5000
> X-RateLimit-Remaining: 4987
-> X-RateLimit-Reset: 1350085394{% if currentVersion != "free-pro-team@latest" %}
+> X-RateLimit-Reset: 1350085394{% if currentVersion == "github-ae@latest" or enterpriseServerVersions contains currentVersion %}
> X-GitHub-Enterprise-Version: {{ currentVersion }}.0{% endif %}
> Content-Length: 5
> Cache-Control: max-age=0, private, must-revalidate
@@ -88,10 +89,7 @@ response illustrates all attributes that are returned by that method.
### Authentication
-There are two ways to authenticate through {% data variables.product.product_name %} API v3. Requests that
-require authentication will return `404 Not Found`, instead of
-`403 Forbidden`, in some places. This is to prevent the accidental leakage
-of private repositories to unauthorized users.
+{% if currentVersion == "github-ae@latest" %} We recommend authenticating to the {% data variables.product.product_name %} REST API by creating an OAuth2 token through the [web application flow](/developers/apps/authorizing-oauth-apps#web-application-flow). {% else %} There are two ways to authenticate through {% data variables.product.product_name %} REST API.{% endif %} Requests that require authentication will return `404 Not Found`, instead of `403 Forbidden`, in some places. This is to prevent the accidental leakage of private repositories to unauthorized users.
#### Basic authentication
@@ -111,8 +109,9 @@ Note: GitHub recommends sending OAuth tokens using the Authorization header.
{% endnote %}
-Read [more about OAuth2](/apps/building-oauth-apps/). Note that OAuth2 tokens can be acquired using the [web application flow](/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) for production applications.
+Read [more about OAuth2](/apps/building-oauth-apps/). Note that OAuth2 tokens can be acquired using the [web application flow](/developers/apps/authorizing-oauth-apps#web-application-flow) for production applications.
+{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
#### OAuth2 key/secret
{% data reusables.apps.deprecating_auth_with_query_parameters %}
@@ -123,9 +122,9 @@ curl -u my_client_id:my_client_secret '{% data variables.product.api_url_pre %}/
Using your `client_id` and `client_secret` does _not_ authenticate as a user, it will only identify your OAuth application to increase your rate limit. Permissions are only granted to users, not applications, and you will only get back data that an unauthenticated user would see. For this reason, you should only use the OAuth2 key/secret in server-to-server scenarios. Don't leak your OAuth application's client secret to your users.
-{% if currentVersion != "free-pro-team@latest" %}
You will be unable to authenticate using your OAuth2 key and secret while in private mode, and trying to authenticate will return `401 Unauthorized`. For more information, see "[Enabling private mode](/enterprise/admin/installation/enabling-private-mode)".
{% endif %}
+
{% if currentVersion == "free-pro-team@latest" %}
Read [more about unauthenticated rate limiting](#increasing-the-unauthenticated-rate-limit-for-oauth-applications).
@@ -186,10 +185,10 @@ $ curl -i -u username -d '{"scopes":["public_repo"]}' {% data variables.product.
You can issue a `GET` request to the root endpoint to get all the endpoint categories that the REST API supports:
```shell
-$ curl {% if currentVersion != "free-pro-team@latest" %}-u username:password {% endif %}{% data variables.product.api_url_pre %}
+$ curl {% if currentVersion == "github-ae@latest" %}-u username:token {% endif %}{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}-u username:password {% endif %}{% data variables.product.api_url_pre %}
```
-{% if currentVersion != "free-pro-team@latest" %}
+{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
{% note %}
diff --git a/content/rest/overview/troubleshooting.md b/content/rest/overview/troubleshooting.md
index 90755d1de5bb..24c83cfc3703 100644
--- a/content/rest/overview/troubleshooting.md
+++ b/content/rest/overview/troubleshooting.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
diff --git a/content/rest/reference/actions.md b/content/rest/reference/actions.md
index a162cda6f3ad..cf127e928256 100644
--- a/content/rest/reference/actions.md
+++ b/content/rest/reference/actions.md
@@ -24,6 +24,7 @@ The Artifacts API allows you to download, delete, and retrieve information about
{% if operation.subcategory == 'artifacts' %}{% include rest_operation %}{% endif %}
{% endfor %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
## Permissions
The Permissions API allows you to set permissions for what organizations and repositories are allowed to run {% data variables.product.prodname_actions %}, and what actions are allowed to run. For more information, see "[Usage limits, billing, and administration](/actions/reference/usage-limits-billing-and-administration#disabling-or-limiting-github-actions-for-your-repository-or-organization)."
@@ -33,6 +34,7 @@ You can also set permissions for an enterprise. For more information, see the "[
{% for operation in currentRestOperations %}
{% if operation.subcategory == 'permissions' %}{% include rest_operation %}{% endif %}
{% endfor %}
+{% endif %}
## Secrets
diff --git a/content/rest/reference/activity.md b/content/rest/reference/activity.md
index 40e6118fd922..d80553b6c335 100644
--- a/content/rest/reference/activity.md
+++ b/content/rest/reference/activity.md
@@ -5,6 +5,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% for operation in currentRestOperations %}
diff --git a/content/rest/reference/apps.md b/content/rest/reference/apps.md
index ffbdc5fa03cd..c078396322c2 100644
--- a/content/rest/reference/apps.md
+++ b/content/rest/reference/apps.md
@@ -5,6 +5,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
The GitHub Apps API enables you to get high-level information about a GitHub App as well as specific information about installations of the app. To learn more about GitHub Apps, see "[Authenticating as a GitHub App](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app)."
@@ -61,3 +62,12 @@ Be sure to replace stubbed endpoints with production endpoints before deploying
{% endfor %}
{% endif %}
+
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}
+## Webhooks
+
+{% for operation in currentRestOperations %}
+ {% if operation.subcategory == 'webhooks' %}{% include rest_operation %}{% endif %}
+{% endfor %}
+
+{% endif %}
\ No newline at end of file
diff --git a/content/rest/reference/checks.md b/content/rest/reference/checks.md
index 3719d4cefb4d..67ba813b87e5 100644
--- a/content/rest/reference/checks.md
+++ b/content/rest/reference/checks.md
@@ -5,6 +5,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
The Checks API enables you to build GitHub Apps that run powerful checks against code changes in a repository. You can create apps that perform continuous integration, code linting, or code scanning services and provide detailed feedback on commits. For more information, see "[Getting started with the checks API](/rest/guides/getting-started-with-the-checks-api)" and "[Creating CI tests with the Checks API](/apps/quickstart-guides/creating-ci-tests-with-the-checks-api/)."
diff --git a/content/rest/reference/codes-of-conduct.md b/content/rest/reference/codes-of-conduct.md
index 5a2174b00e95..16d7e8bda31b 100644
--- a/content/rest/reference/codes-of-conduct.md
+++ b/content/rest/reference/codes-of-conduct.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
You can use the Codes of Conduct API to retrieve information about a repository's code of conduct. To get a repository's code of conduct, use the "[Get a repository](/v3/repos/#get-a-repository)" endpoint.
diff --git a/content/rest/reference/emojis.md b/content/rest/reference/emojis.md
index cff842b3ac25..ea2ca0751dba 100644
--- a/content/rest/reference/emojis.md
+++ b/content/rest/reference/emojis.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% include rest_operations_at_current_path %}
diff --git a/content/rest/reference/enterprise-admin.md b/content/rest/reference/enterprise-admin.md
index 484f8eaf5de5..cf834d34463b 100644
--- a/content/rest/reference/enterprise-admin.md
+++ b/content/rest/reference/enterprise-admin.md
@@ -7,6 +7,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
You can use these endpoints to administer your enterprise.
@@ -21,32 +22,35 @@ You can use these endpoints to administer your enterprise.
{% endif %}
-{% if currentVersion != "free-pro-team@latest" %}
-
### Endpoint URLs
-REST API endpoints—except [Management Console](#management-console) API endpoints—are prefixed with the following URL:
+REST API endpoints{% if enterpriseServerVersions contains currentVersion %}—except [Management Console](#management-console) API endpoints—{% endif %} are prefixed with the following URL:
```shell
http(s)://hostname/api/v3/
```
+{% if enterpriseServerVersions contains currentVersion %}
[Management Console](#management-console) API endpoints are only prefixed with a hostname:
```shell
http(s)://hostname/
```
-
+{% endif %}
+{% if currentVersion == "github-ae@latest" or enterpriseServerVersions contains currentVersion %}
### Authentication
-Your {% data variables.product.product_name %} installation's API endpoints accept [the same authentication methods](/rest/overview/resources-in-the-rest-api#authentication) as the GitHub.com API. You can authenticate yourself with **[OAuth tokens](/apps/building-integrations/setting-up-and-registering-oauth-apps/)** (which can be created using the [Authorizations API](/rest/reference/oauth-authorizations#create-a-new-authorization)) or **[basic authentication](/rest/overview/resources-in-the-rest-api#basic-authentication)**. {% if currentVersion != "free-pro-team@latest" %}
+Your {% data variables.product.product_name %} installation's API endpoints accept [the same authentication methods](/rest/overview/resources-in-the-rest-api#authentication) as the GitHub.com API. You can authenticate yourself with **[OAuth tokens](/apps/building-integrations/setting-up-and-registering-oauth-apps/)** (which can be created using the [Authorizations API](/rest/reference/oauth-authorizations#create-a-new-authorization)) or **[basic authentication](/rest/overview/resources-in-the-rest-api#basic-authentication)**. {% if enterpriseServerVersions contains currentVersion %}
OAuth tokens must have the `site_admin` [OAuth scope](/developers/apps/scopes-for-oauth-apps#available-scopes) when used with Enterprise-specific endpoints.{% endif %}
-Enterprise administration API endpoints are only accessible to authenticated {% data variables.product.product_name %} site administrators, except for the [Management Console](#management-console) API, which requires the [Management Console password](/enterprise/admin/articles/accessing-the-management-console/).
+Enterprise administration API endpoints are only accessible to authenticated {% data variables.product.product_name %} site administrators{% if enterpriseServerVersions contains currentVersion %}, except for the [Management Console](#management-console) API, which requires the [Management Console password](/enterprise/admin/articles/accessing-the-management-console/){% endif %}.
+{% endif %}
+
+{% if currentVersion == "github-ae@latest" or enterpriseServerVersions contains currentVersion %}
### Version information
-The current version of a {% data variables.product.product_name %} instance is returned in the response header of every API:
+The current version of your enterprise is returned in the response header of every API:
`X-GitHub-Enterprise-Version: {{currentVersion}}.0`
You can also read the current version by calling the [meta endpoint](/rest/reference/meta/).
@@ -57,7 +61,6 @@ You can also read the current version by calling the [meta endpoint](/rest/refer
{% endif %}
{% if currentVersion == "free-pro-team@latest" %}
-
## Billing
{% for operation in currentRestOperations %}
@@ -138,8 +141,20 @@ Name | Type | Description
{% endif %}
-{% if currentVersion != "free-pro-team@latest" %}
+{% if currentVersion == "github-ae@latest" %}
+
+## Encryption at rest
+
+You can use the encryption at rest API to manage the key that encrypts your data on {% data variables.product.product_name %}.
+For more information, see "[Configuring data encryption for your enterprise](/admin/configuration/configuring-data-encryption-for-your-enterprise)."
+
+{% for operation in currentRestOperations %}
+ {% if operation.subcategory == 'encryption-at-rest' %}{% include rest_operation %}{% endif %}
+{% endfor %}
+
+{% endif %}
+{% if currentVersion == "github-ae@latest" or enterpriseServerVersions contains currentVersion %}
## Admin stats
The Admin Stats API provides a variety of metrics about your installation. *It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it.
@@ -148,9 +163,25 @@ The Admin Stats API provides a variety of metrics about your installation. *It i
{% if operation.subcategory == 'admin-stats' %}{% include rest_operation %}{% endif %}
{% endfor %}
+{% endif %}
+
+{% if currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
+
+## Announcements
+
+The Announcements API allows you to manage the global announcement banner in your enterprise. For more information, see "[Customizing user messages for your enterprise](/admin/user-management/customizing-user-messages-for-your-enterprise#creating-a-global-announcement-banner)."
+
+{% for operation in currentRestOperations %}
+ {% if operation.subcategory == 'announcement' %}{% include rest_operation %}{% endif %}
+{% endfor %}
+
+{% endif %}
+
+{% if currentVersion == "github-ae@latest" or enterpriseServerVersions contains currentVersion %}
+
## Global webhooks
-Global webhooks are installed on a {% data variables.product.prodname_enterprise %} instance. You can use global webhooks to automatically monitor, respond to, or enforce rules for users, organizations, teams, and repositories on your instance. Global webhooks can subscribe to the [organization](/developers/webhooks-and-events/webhook-events-and-payloads#organization), [user](/developers/webhooks-and-events/webhook-events-and-payloads#user), [repository](/developers/webhooks-and-events/webhook-events-and-payloads#repository), [team](/developers/webhooks-and-events/webhook-events-and-payloads#team), [member](/developers/webhooks-and-events/webhook-events-and-payloads#member), [membership](/developers/webhooks-and-events/webhook-events-and-payloads#membership), [fork](/developers/webhooks-and-events/webhook-events-and-payloads#fork), and [ping](/developers/webhooks-and-events/about-webhooks#ping-event) event types.
+Global webhooks are installed on your enterprise. You can use global webhooks to automatically monitor, respond to, or enforce rules for users, organizations, teams, and repositories on your enterprise. Global webhooks can subscribe to the [organization](/developers/webhooks-and-events/webhook-events-and-payloads#organization), [user](/developers/webhooks-and-events/webhook-events-and-payloads#user), [repository](/developers/webhooks-and-events/webhook-events-and-payloads#repository), [team](/developers/webhooks-and-events/webhook-events-and-payloads#team), [member](/developers/webhooks-and-events/webhook-events-and-payloads#member), [membership](/developers/webhooks-and-events/webhook-events-and-payloads#membership), [fork](/developers/webhooks-and-events/webhook-events-and-payloads#fork), and [ping](/developers/webhooks-and-events/about-webhooks#ping-event) event types.
*This API is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. To learn how to configure global webhooks, see [About global webhooks](/enterprise/admin/user-management/about-global-webhooks).
@@ -158,16 +189,24 @@ Global webhooks are installed on a {% data variables.product.prodname_enterprise
{% if operation.subcategory == 'global-webhooks' %}{% include rest_operation %}{% endif %}
{% endfor %}
+{% endif %}
+
+{% if enterpriseServerVersions contains currentVersion %}
+
## LDAP
-You can use the LDAP API to update account relationships between a {% data variables.product.prodname_ghe_server %} user or team and its linked LDAP entry or queue a new synchronization.
+You can use the LDAP API to update account relationships between a {% data variables.product.product_name %} user or team and its linked LDAP entry or queue a new synchronization.
-With the LDAP mapping endpoints, you're able to update the Distinguished Name (DN) that a user or team maps to. Note that the LDAP endpoints are generally only effective if your {% data variables.product.prodname_ghe_server %} appliance has [LDAP Sync enabled](/enterprise/admin/authentication/using-ldap). The [Update LDAP mapping for a user](#update-ldap-mapping-for-a-user) endpoint can be used when LDAP is enabled, even if LDAP Sync is disabled.
+With the LDAP mapping endpoints, you're able to update the Distinguished Name (DN) that a user or team maps to. Note that the LDAP endpoints are generally only effective if your {% data variables.product.product_name %} appliance has [LDAP Sync enabled](/enterprise/admin/authentication/using-ldap). The [Update LDAP mapping for a user](#update-ldap-mapping-for-a-user) endpoint can be used when LDAP is enabled, even if LDAP Sync is disabled.
{% for operation in currentRestOperations %}
{% if operation.subcategory == 'ldap' %}{% include rest_operation %}{% endif %}
{% endfor %}
+{% endif %}
+
+
+{% if currentVersion == "github-ae@latest" or enterpriseServerVersions contains currentVersion %}
## License
The License API provides information on your Enterprise license. *It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it.
@@ -176,17 +215,21 @@ The License API provides information on your Enterprise license. *It is only ava
{% if operation.subcategory == 'license' %}{% include rest_operation %}{% endif %}
{% endfor %}
+{% endif %}
+
+{% if enterpriseServerVersions contains currentVersion %}
+
## Management console
-The Management Console API helps you manage your {% data variables.product.prodname_ghe_server %} installation.
+The Management Console API helps you manage your {% data variables.product.product_name %} installation.
{% tip %}
-You must explicitly set the port number when making API calls to the Management Console. If TLS is enabled on your Enterprise instance, the port number is `8443`; otherwise, the port number is `8080`.
+You must explicitly set the port number when making API calls to the Management Console. If TLS is enabled on your enterprise, the port number is `8443`; otherwise, the port number is `8080`.
If you don't want to provide a port number, you'll need to configure your tool to automatically follow redirects.
-You may also need to add the [`-k` flag](http://curl.haxx.se/docs/manpage.html#-k) when using `curl`, since {% data variables.product.prodname_ghe_server %} uses a self-signed certificate before you [add your own TLS certificate](/enterprise/admin/guides/installation/configuring-tls/).
+You may also need to add the [`-k` flag](http://curl.haxx.se/docs/manpage.html#-k) when using `curl`, since {% data variables.product.product_name %} uses a self-signed certificate before you [add your own TLS certificate](/enterprise/admin/guides/installation/configuring-tls/).
{% endtip %}
@@ -210,14 +253,21 @@ $ curl -L 'https://api_key:your-amazing-password@hostname:
{% if operation.subcategory == 'management-console' %}{% include rest_operation %}{% endif %}
{% endfor %}
+{% endif %}
+
+{% if currentVersion == "github-ae@latest" or enterpriseServerVersions contains currentVersion %}
## Organizations
-The Organization Administration API allows you to create organizations on a {% data variables.product.prodname_ghe_server %} appliance. *It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it.
+The Organization Administration API allows you to create organizations on your enterprise. *It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it.
{% for operation in currentRestOperations %}
{% if operation.subcategory == 'orgs' %}{% include rest_operation %}{% endif %}
{% endfor %}
+{% endif %}
+
+
+{% if enterpriseServerVersions contains currentVersion %}
## Organization pre-receive hooks
The Organization Pre-receive Hooks API allows you to view and modify
@@ -242,6 +292,10 @@ configuration. Only site admins are able to access the global configuration.
{% if operation.subcategory == 'org-pre-receive-hooks' %}{% include rest_operation %}{% endif %}
{% endfor %}
+{% endif %}
+
+{% if enterpriseServerVersions contains currentVersion %}
+
## Pre-receive environments
The Pre-receive Environments API allows you to create, list, update and delete environments for pre-receive hooks. *It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it.
@@ -254,7 +308,7 @@ The Pre-receive Environments API allows you to create, list, update and delete e
|-----------------------|-----------|----------------------------------------------------------------------------|
| `name` | `string` | The name of the environment as displayed in the UI. |
| `image_url` | `string` | URL to the tarball that will be downloaded and extracted. |
-| `default_environment` | `boolean` | Whether this is the default environment that ships with {% data variables.product.prodname_ghe_server %}. |
+| `default_environment` | `boolean` | Whether this is the default environment that ships with {% data variables.product.product_name %}. |
| `download` | `object` | This environment's download status. |
| `hooks_count` | `integer` | The number of pre-receive hooks that use this environment. |
@@ -272,6 +326,9 @@ Possible values for `state` are `not_started`, `in_progress`, `success`, `failed
{% if operation.subcategory == 'pre-receive-environments' %}{% include rest_operation %}{% endif %}
{% endfor %}
+{% endif %}
+
+{% if enterpriseServerVersions contains currentVersion %}
## Pre-receive hooks
The Pre-receive Hooks API allows you to create, list, update and delete pre-receive hooks. *It is only available to
@@ -297,6 +354,10 @@ any pushes that result in a non-zero status. `testing` means the script will run
{% if operation.subcategory == 'pre-receive-hooks' %}{% include rest_operation %}{% endif %}
{% endfor %}
+{% endif %}
+
+{% if enterpriseServerVersions contains currentVersion %}
+
## Repository pre-receive hooks
The Repository Pre-receive Hooks API allows you to view and modify
@@ -318,17 +379,12 @@ Possible values for *enforcement* are `enabled`, `disabled` and`testing`. `disab
{% if operation.subcategory == 'repo-pre-receive-hooks' %}{% include rest_operation %}{% endif %}
{% endfor %}
-## Search indexing
-
-The Search Indexing API allows you to queue up a variety of search indexing tasks. *It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it.
-
-{% for operation in currentRestOperations %}
- {% if operation.subcategory == 'search-indexing' %}{% include rest_operation %}{% endif %}
-{% endfor %}
+{% endif %}
+{% if currentVersion == "github-ae@latest" or enterpriseServerVersions contains currentVersion %}
## Users
-The User Administration API allows you to promote, demote, suspend, and unsuspend users on a {% data variables.product.prodname_ghe_server %} appliance. *It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `403` response if they try to access it.
+The User Administration API allows you to suspend{% if enterpriseServerVersions contains currentVersion %}, unsuspend, promote, and demote{% endif %}{% if currentVersion == "github-ae@latest" %} and unsuspend{% endif %} users on your enterprise. *It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `403` response if they try to access it.
{% for operation in currentRestOperations %}
{% if operation.subcategory == 'users' %}{% include rest_operation %}{% endif %}
diff --git a/content/rest/reference/gists.md b/content/rest/reference/gists.md
index fff45f6fc69d..1ff371cc244f 100644
--- a/content/rest/reference/gists.md
+++ b/content/rest/reference/gists.md
@@ -5,11 +5,12 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Authentication
-You can read public gists {% if currentVersion != "free-pro-team@latest" and currentVersion ver_gt "2.9" %}and create them for anonymous users without a token.{% else %} anonymously, but you must be signed into GitHub to create gists.{% endif %} To read or write gists on a user's behalf, you need the gist OAuth scope and a token. For more information, see "[Scopes for OAuth Apps](/developers/apps/scopes-for-oauth-apps)."
+You can read public gists {% if currentVersion == "github-ae@latest" or enterpriseServerVersions contains currentVersion %}and create them for anonymous users without a token.{% else %} anonymously, but you must be signed into GitHub to create gists.{% endif %} To read or write gists on a user's behalf, you need the gist OAuth scope and a token. For more information, see "[Scopes for OAuth Apps](/developers/apps/scopes-for-oauth-apps)."
diff --git a/content/rest/reference/git.md b/content/rest/reference/git.md
index 01f01396f4df..4acb89600877 100644
--- a/content/rest/reference/git.md
+++ b/content/rest/reference/git.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
The Git Database API gives you access to read and write raw Git objects to your Git database on {% data variables.product.product_name %} and to list and update your references (branch heads and tags). For more information about using the Git Database API, see "[Getting started with the Git data API](/rest/guides/getting-started-with-the-git-database-api)."
diff --git a/content/rest/reference/gitignore.md b/content/rest/reference/gitignore.md
index 137bdaf63852..21728e0dd33c 100644
--- a/content/rest/reference/gitignore.md
+++ b/content/rest/reference/gitignore.md
@@ -5,6 +5,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
When you create a new {% data variables.product.product_name %} repository via the API, you can specify a [.gitignore template](/github/using-git/ignoring-files) to apply to the repository upon creation. The .gitignore templates API lists and fetches templates from the {% data variables.product.product_name %} [.gitignore repository](https://github.com/github/gitignore).
diff --git a/content/rest/reference/index.md b/content/rest/reference/index.md
index ef6617ac53b2..dfeb1f064811 100644
--- a/content/rest/reference/index.md
+++ b/content/rest/reference/index.md
@@ -5,6 +5,7 @@ intro: View reference documentation to learn about the resources available in th
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Table of Contents
diff --git a/content/rest/reference/issues.md b/content/rest/reference/issues.md
index 73d71532e670..43181f212a14 100644
--- a/content/rest/reference/issues.md
+++ b/content/rest/reference/issues.md
@@ -5,6 +5,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Custom media types for issues
diff --git a/content/rest/reference/licenses.md b/content/rest/reference/licenses.md
index fb755e75f8eb..0ccf586a3551 100644
--- a/content/rest/reference/licenses.md
+++ b/content/rest/reference/licenses.md
@@ -5,6 +5,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
The Licenses API returns metadata about popular open source licenses and information about a particular project's license file.
diff --git a/content/rest/reference/markdown.md b/content/rest/reference/markdown.md
index aff267306b37..5a71bd7804af 100644
--- a/content/rest/reference/markdown.md
+++ b/content/rest/reference/markdown.md
@@ -5,6 +5,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% include rest_operations_at_current_path %}
diff --git a/content/rest/reference/meta.md b/content/rest/reference/meta.md
index cb3db05d3f7b..b261f929a206 100644
--- a/content/rest/reference/meta.md
+++ b/content/rest/reference/meta.md
@@ -5,6 +5,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% include rest_operations_at_current_path %}
diff --git a/content/rest/reference/orgs.md b/content/rest/reference/orgs.md
index 3725e1f913c0..919098c4516d 100644
--- a/content/rest/reference/orgs.md
+++ b/content/rest/reference/orgs.md
@@ -6,12 +6,14 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% for operation in currentRestOperations %}
{% unless operation.subcategory %}{% include rest_operation %}{% endunless %}
{% endfor %}
+{% if currentVersion == "free-pro-team@latest" %}
## Blocking users
The token used to authenticate the call must have the `admin:org` scope in order to make any blocking calls for an organization. Otherwise, the response returns `HTTP 404`.
@@ -20,6 +22,8 @@ The token used to authenticate the call must have the `admin:org` scope in order
{% if operation.subcategory == 'blocking' %}{% include rest_operation %}{% endif %}
{% endfor %}
+{% endif %}
+
## Members
{% for operation in currentRestOperations %}
@@ -34,7 +38,7 @@ The token used to authenticate the call must have the `admin:org` scope in order
## Webhooks
-Organization webhooks allow you to receive HTTP `POST` payloads whenever certain events happen within the organization. Subscribing to these events makes it possible to build integrations that react to actions on {% data variables.product.prodname_dotcom %}.com. For more information on actions you can subscribe to, see "[{% data variables.product.prodname_dotcom %} event types](/developers/webhooks-and-events/github-event-types)."
+Organization webhooks allow you to receive HTTP `POST` payloads whenever certain events happen within the organization. Subscribing to these events makes it possible to build integrations that react to events on {% data variables.product.product_name %}. For more information on actions you can subscribe to, see "[{% data variables.product.prodname_dotcom %} event types](/developers/webhooks-and-events/github-event-types)."
### Scopes & Restrictions
@@ -56,5 +60,5 @@ For more best practices, [see our guide](/guides/best-practices-for-integrators/
{% data variables.product.product_name %} will send along several HTTP headers to differentiate between event types and payload identifiers. See [webhook headers](/webhooks/event-payloads/#delivery-headers) for details.
{% for operation in currentRestOperations %}
- {% if operation.subcategory == 'hooks' %}{% include rest_operation %}{% endif %}
+ {% if operation.subcategory == 'webhooks' %}{% include rest_operation %}{% endif %}
{% endfor %}
diff --git a/content/rest/reference/permissions-required-for-github-apps.md b/content/rest/reference/permissions-required-for-github-apps.md
index 1bd667279812..6e0757027300 100644
--- a/content/rest/reference/permissions-required-for-github-apps.md
+++ b/content/rest/reference/permissions-required-for-github-apps.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### About {% data variables.product.prodname_github_app %} permissions
@@ -185,7 +186,7 @@ _Branches_
- [`POST /repos/:owner/:repo/branches/:branch/protection/required_signatures`](/v3/repos/branches/#create-commit-signature-protection) (:write)
- [`DELETE /repos/:owner/:repo/branches/:branch/protection/required_signatures`](/v3/repos/branches/#delete-commit-signature-protection) (:write)
- [`GET /repos/:owner/:repo/branches/:branch/protection/required_status_checks`](/v3/repos/branches/#get-status-checks-protection) (:read)
-- [`PATCH /repos/:owner/:repo/branches/:branch/protection/required_status_checks`](/v3/repos/branches/#update-status-check-potection) (:write)
+- [`PATCH /repos/:owner/:repo/branches/:branch/protection/required_status_checks`](/v3/repos/branches/#update-status-check-protection) (:write)
- [`DELETE /repos/:owner/:repo/branches/:branch/protection/required_status_checks`](/v3/repos/branches/#remove-status-check-protection) (:write)
- [`GET /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts`](/v3/repos/branches/#get-all-status-check-contexts) (:read)
- [`POST /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts`](/v3/repos/branches/#add-status-check-contexts) (:write)
@@ -331,7 +332,7 @@ _Traffic_
- [`GET /repos/:owner/:repo/community/code_of_conduct`](/v3/codes_of_conduct/#get-the-code-of-conduct-for-a-repository) (:read)
- [`GET /repos/:owner/:repo/compare/:base...:head`](/v3/repos/commits/#compare-two-commits) (:read)
- [`GET /repos/:owner/:repo/contents/:path`](/v3/repos/contents/#get-repository-content) (:read)
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}
- [`POST /repos/:owner/:repo/dispatches`](/v3/repos/#create-a-repository-dispatch-event) (:write)
{% endif %}
- [`POST /repos/:owner/:repo/forks`](/v3/repos/forks/#create-a-fork) (:read)
@@ -382,8 +383,8 @@ _Import_
_Reactions_
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
-- [`DELETE /reactions/:reaction_id`](/v3/reactions/#delete-a-reaction-legacy) (:write){% else %}- [`DELETE /reactions/:reaction_id`](/v3/reactions/#delete-a-reaction) (:write){% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}
+- [`DELETE /reactions/:reaction_id`](/v3/reactions/#delete-a-reaction-legacy) (:write){% else %}- [`DELETE /reactions/:reaction_id`](/v3/reactions/#delete-a-reaction) (:write){% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}
- [`DELETE /repos/:owner/:repo/comments/:comment_id/reactions/:reaction_id`](/v3/reactions/#delete-a-commit-comment-reaction) (:write)
- [`DELETE /repos/:owner/:repo/issues/:issue_number/reactions/:reaction_id`](/v3/reactions/#delete-an-issue-reaction) (:write)
- [`DELETE /repos/:owner/:repo/issues/comments/:comment_id/reactions/:reaction_id`](/v3/reactions/#delete-an-issue-comment-reaction) (:write)
@@ -408,12 +409,13 @@ _Releases_
- [`GET /repos/:owner/:repo/deployments`](/rest/reference/repos#list-deployments) (:read)
- [`POST /repos/:owner/:repo/deployments`](/rest/reference/repos#create-a-deployment) (:write)
-- [`GET /repos/:owner/:repo/deployments/:deployment_id`](/rest/reference/repos#get-a-deployment) (:read){% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
+- [`GET /repos/:owner/:repo/deployments/:deployment_id`](/rest/reference/repos#get-a-deployment) (:read){% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}
- [`DELETE /repos/:owner/:repo/deployments/:deployment_id`](/rest/reference/repos#delete-a-deployment) (:write){% endif %}
- [`GET /repos/:owner/:repo/deployments/:deployment_id/statuses`](/rest/reference/repos#list-deployment-statuses) (:read)
- [`POST /repos/:owner/:repo/deployments/:deployment_id/statuses`](/rest/reference/repos#create-a-deployment-status) (:write)
- [`GET /repos/:owner/:repo/deployments/:deployment_id/statuses/:status_id`](/rest/reference/repos#get-a-deployment-status) (:read)
+{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
### Permission on "emails"
{% if currentVersion == "free-pro-team@latest" %}
@@ -423,6 +425,7 @@ _Releases_
- [`POST /user/emails`](/v3/users/emails/#add-an-email-address-for-the-authenticated-user) (:write)
- [`DELETE /user/emails`](/v3/users/emails/#delete-an-email-address-for-the-authenticated-user) (:write)
- [`GET /user/public_emails`](/v3/users/emails/#list-public-email-addresses-for-the-authenticated-user) (:read)
+{% endif %}
### Permission on "followers"
@@ -496,7 +499,7 @@ _Reactions_
- [`POST /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/v3/reactions/#create-reaction-for-an-issue-comment) (:write)
- [`GET /repos/:owner/:repo/issues/:issue_number/reactions`](/v3/reactions/#list-reactions-for-an-issue) (:read)
- [`POST /repos/:owner/:repo/issues/:issue_number/reactions`](/v3/reactions/#create-reaction-for-an-issue) (:write)
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}
- [`DELETE /reactions/:reaction_id`](/v3/reactions/#delete-a-reaction-legacy) (:write)
- [`DELETE /repos/:owner/:repo/comments/:comment_id/reactions/:reaction_id`](/v3/reactions/#delete-a-commit-comment-reaction) (:write)
- [`DELETE /repos/:owner/:repo/issues/:issue_number/reactions/:reaction_id`](/v3/reactions/#delete-an-issue-reaction) (:write)
@@ -577,12 +580,12 @@ _Teams_
- [`GET /orgs/:org/teams`](/v3/teams/#list-teams) (:read)
- [`POST /orgs/:org/teams`](/v3/teams/#create-a-team) (:write)
- [`GET /orgs/:org/teams/:team_slug`](/v3/teams/#get-a-team-by-name) (:read)
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.21" %}
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.21" %}
- [`GET /teams/:team_id`](/v3/teams/#get-a-team) (:read)
{% endif %}
- [`PATCH /teams/:team_id`](/v3/teams/#update-a-team) (:write)
- [`DELETE /teams/:team_id`](/v3/teams/#delete-a-team) (:write)
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}
- [`GET /teams/:team_id/projects`](/v3/teams/#list-team-projects) (:read)
- [`GET /teams/:team_id/projects/:project_id`](/v3/teams/#check-team-permissions-for-a-project) (:read)
- [`PUT /teams/:team_id/projects/:project_id`](/v3/teams/#add-or-update-team-project-permissions) (:read)
@@ -619,7 +622,7 @@ _Teams_
_Teams_
- [`DELETE /teams/:team_id/projects/:project_id`](/v3/teams/#remove-a-project-from-a-team) (:read)
-{% if currentVersion != "free-pro-team@latest" %}
+{% if enterpriseServerVersions contains currentVersion %}
### Permission on "organization pre receive hooks"
- [`GET /orgs/:org/pre-receive-hooks`](/enterprise/user/rest/reference/enterprise-admin#list-pre-receive-hooks-for-an-organization) (:read)
@@ -733,7 +736,7 @@ _Reactions_
- [`POST /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/v3/reactions/#create-reaction-for-an-issue-comment) (:write)
- [`GET /repos/:owner/:repo/pulls/comments/:comment_id/reactions`](/v3/reactions/#list-reactions-for-a-pull-request-review-comment) (:read)
- [`POST /repos/:owner/:repo/pulls/comments/:comment_id/reactions`](/v3/reactions/#create-reaction-for-a-pull-request-review-comment) (:write)
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}
- [`DELETE /reactions/:reaction_id`](/v3/reactions/#delete-a-reaction-legacy) (:write)
- [`DELETE /repos/:owner/:repo/comments/:comment_id/reactions/:reaction_id`](/v3/reactions/#delete-a-commit-comment-reaction) (:write)
- [`DELETE /repos/:owner/:repo/issues/:issue_number/reactions/:reaction_id`](/v3/reactions/#delete-an-issue-reaction) (:write)
@@ -766,7 +769,7 @@ _Reviews_
- [`POST /repos/:owner/:repo/hooks/:hook_id/pings`](/v3/repos/hooks/#ping-a-repository-webhook) (:read)
- [`POST /repos/:owner/:repo/hooks/:hook_id/tests`](/v3/repos/hooks/#test-the-push-repository-webhook) (:read)
-{% if currentVersion != "free-pro-team@latest" %}
+{% if enterpriseServerVersions contains currentVersion %}
### Permission on "repository pre receive hooks"
- [`GET /repos/:owner/:repo/pre-receive-hooks`](/enterprise/user/rest/reference/enterprise-admin#list-pre-receive-hooks-for-a-repository) (:read)
diff --git a/content/rest/reference/projects.md b/content/rest/reference/projects.md
index 652d9096ead9..9ff76062b501 100644
--- a/content/rest/reference/projects.md
+++ b/content/rest/reference/projects.md
@@ -5,6 +5,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% for operation in currentRestOperations %}
diff --git a/content/rest/reference/pulls.md b/content/rest/reference/pulls.md
index 8bd9167b0cd4..10d572041ec7 100644
--- a/content/rest/reference/pulls.md
+++ b/content/rest/reference/pulls.md
@@ -5,6 +5,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
The Pull Request API allows you to list, view, edit, create, and even merge pull requests. Comments on pull requests can be managed via the [Issue Comments API](/rest/reference/issues#comments).
diff --git a/content/rest/reference/rate-limit.md b/content/rest/reference/rate-limit.md
index 37ac798d29b7..0ca642052d3d 100644
--- a/content/rest/reference/rate-limit.md
+++ b/content/rest/reference/rate-limit.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
The REST API overview documentation describes the [rate limit rules](/rest/overview/resources-in-the-rest-api#rate-limiting). You can check your current rate limit status at any time using the Rate Limit API described below.
diff --git a/content/rest/reference/reactions.md b/content/rest/reference/reactions.md
index e7c92ebf207b..8992d9904953 100644
--- a/content/rest/reference/reactions.md
+++ b/content/rest/reference/reactions.md
@@ -5,6 +5,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
### Reaction types
diff --git a/content/rest/reference/repos.md b/content/rest/reference/repos.md
index fce27847a049..03aa0d51f3ce 100644
--- a/content/rest/reference/repos.md
+++ b/content/rest/reference/repos.md
@@ -6,6 +6,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
{% for operation in currentRestOperations %}
@@ -50,12 +51,15 @@ The Repo Commits API supports listing, viewing, and comparing commits in a repos
{% if operation.subcategory == 'commits' %}{% include rest_operation %}{% endif %}
{% endfor %}
+{% if currentVersion == "free-pro-team@latest" %}
## Community
{% for operation in currentRestOperations %}
{% if operation.subcategory == 'community' %}{% include rest_operation %}{% endif %}
{% endfor %}
+{% endif %}
+
## Contents
These API endpoints let you create, modify, and delete Base64 encoded content in a repository. To request the raw format or rendered HTML (when supported), use custom media types for repository contents.
@@ -272,6 +276,7 @@ If you are developing a GitHub App and want to provide more detailed information
{% if operation.subcategory == 'statuses' %}{% include rest_operation %}{% endif %}
{% endfor %}
+{% if currentVersion == "free-pro-team@latest" %}
## Traffic
For repositories that you have push access to, the traffic API provides access
@@ -280,6 +285,7 @@ to the information provided in your repository graph. For more information, see
{% for operation in currentRestOperations %}
{% if operation.subcategory == 'traffic' %}{% include rest_operation %}{% endif %}
{% endfor %}
+{% endif %}
## Webhooks
@@ -288,7 +294,7 @@ The Repository Webhooks API allows repository admins to manage the post-receive
If you would like to set up a single webhook to receive events from all of your organization's repositories, see our API documentation for [Organization Webhooks](/rest/reference/orgs#webhooks).
{% for operation in currentRestOperations %}
- {% if operation.subcategory == 'hooks' %}{% include rest_operation %}{% endif %}
+ {% if operation.subcategory == 'webhooks' %}{% include rest_operation %}{% endif %}
{% endfor %}
### Receiving Webhooks
@@ -317,14 +323,14 @@ The default format is what [existing post-receive hooks should expect](/post-rec
#### Callback URLs
-Callback URLs can use the `http://` protocol. {% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.20" %}You can also `github://` callbacks to specify a GitHub service.
+Callback URLs can use the `http://` protocol. {% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.20" %}You can also `github://` callbacks to specify a GitHub service.
{% data reusables.apps.deprecating_github_services_ghe %}
{% endif %}
# Send updates to postbin.org
http://postbin.org/123
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.20" %}
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.20" %}
# Send updates to Campfire
github://campfire?subdomain=github&room=Commits&token=abc123
{% endif %}
diff --git a/content/rest/reference/search.md b/content/rest/reference/search.md
index b3037447cad5..79f4b76b8765 100644
--- a/content/rest/reference/search.md
+++ b/content/rest/reference/search.md
@@ -5,6 +5,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
The Search API helps you search for the specific item you want to find. For example, you can find a user or a specific file in a repository. Think of it the way you think of performing a search on Google. It's designed to help you find the one result you're looking for (or maybe the few results you're looking for). Just like searching on Google, you sometimes want to see a few pages of search results so that you can find the item that best meets your needs. To satisfy that need, the {% data variables.product.product_name %} Search API provides **up to 1,000 results for each search**.
@@ -32,7 +33,7 @@ determining your current rate limit status.
Each endpoint in the Search API uses [query parameters](https://en.wikipedia.org/wiki/Query_string) to perform searches on {% data variables.product.product_name %}. See the individual endpoint in the Search API for an example that includes the endpoint and query parameters.
-A query can contain any combination of search qualifiers supported on GitHub.com. The format of the search query is:
+A query can contain any combination of search qualifiers supported on {% data variables.product.product_name %}. The format of the search query is:
```
q=SEARCH_KEYWORD_1+SEARCH_KEYWORD_N+QUALIFIER_1+QUALIFIER_N
diff --git a/content/rest/reference/teams.md b/content/rest/reference/teams.md
index 4c197548fd2b..a39f3abce4ba 100644
--- a/content/rest/reference/teams.md
+++ b/content/rest/reference/teams.md
@@ -5,6 +5,7 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
This API is only available to authenticated members of the team's [organization](/v3/orgs). OAuth access tokens require the `read:org` [scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). {% data variables.product.prodname_dotcom %} generates the team's `slug` from the team `name`.
@@ -33,16 +34,20 @@ The team discussion comments API allows you to get, create, edit, and delete dis
This API is only available to authenticated members of the team's organization. OAuth access tokens require the `read:org` [scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
{% note %}
**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "Synchronizing teams between your identity provider and GitHub."
{% endnote %}
+{% endif %}
+
{% for operation in currentRestOperations %}
{% if operation.subcategory == 'members' %}{% include rest_operation %}{% endif %}
{% endfor %}
+{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
## Team synchronization
The Team Synchronization API allows you to manage connections between {% data variables.product.product_name %} teams and external identity provider (IdP) groups. To use this API, the authenticated user must be a team maintainer or an owner of the organization associated with the team. The token you use to authenticate will also need to be authorized for use with your IdP (SSO) provider. For more information, see "Authorizing a personal access token for use with a SAML single sign-on organization."
@@ -52,3 +57,5 @@ You can manage GitHub team members through your IdP with team synchronization. T
{% for operation in currentRestOperations %}
{% if operation.subcategory == 'team-sync' %}{% include rest_operation %}{% endif %}
{% endfor %}
+
+{% endif %}
\ No newline at end of file
diff --git a/content/rest/reference/users.md b/content/rest/reference/users.md
index c2dcc1173b62..5371d5569c74 100644
--- a/content/rest/reference/users.md
+++ b/content/rest/reference/users.md
@@ -5,20 +5,25 @@ redirect_from:
versions:
free-pro-team: '*'
enterprise-server: '*'
+ github-ae: '*'
---
-Many of the resources on the users API provide a shortcut for getting information about the currently authenticated user. If a request URL does not include a `{username}` parameter then the response will be for the logged in user (and you must pass [authentication information](/rest/overview/resources-in-the-rest-api#authentication) with your request). Additional private information, such as whether a user has two-factor authentication enabled, is included when authenticated through basic auth or OAuth with the `user` scope.
+Many of the resources on the users API provide a shortcut for getting information about the currently authenticated user. If a request URL does not include a `{username}` parameter then the response will be for the logged in user (and you must pass [authentication information](/rest/overview/resources-in-the-rest-api#authentication) with your request).{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %} Additional private information, such as whether a user has two-factor authentication enabled, is included when authenticated through basic auth or OAuth with the `user` scope.{% endif %}
{% for operation in currentRestOperations %}
{% unless operation.subcategory %}{% include rest_operation %}{% endunless %}
{% endfor %}
+{% if currentVersion == "free-pro-team@latest" %}
## Blocking users
{% for operation in currentRestOperations %}
{% if operation.subcategory == 'blocking' %}{% include rest_operation %}{% endif %}
{% endfor %}
+{% endif %}
+
+{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}
## Emails
Management of email addresses via the API requires that you authenticate through basic auth, or through OAuth with a correct scope for the endpoint.
@@ -27,6 +32,8 @@ Management of email addresses via the API requires that you authenticate through
{% if operation.subcategory == 'emails' %}{% include rest_operation %}{% endif %}
{% endfor %}
+{% endif %}
+
## Followers
{% for operation in currentRestOperations %}
diff --git a/contributing/README.md b/contributing/README.md
index 3c955c424497..6dff199b00e9 100644
--- a/contributing/README.md
+++ b/contributing/README.md
@@ -6,7 +6,7 @@ Here, you'll find additional information that might be helpful as you work on a
- [development](./development.md) - steps for getting this app running on your local machine
- [content markup reference](./content-markup-reference.md) - how to use markup and features specific to the GitHub Docs site
-- [content style guide](./content-style-guide) - style guidance specific to GitHub Docs content and additional resources for writing clear, helpful content
+- [content style guide](./content-style-guide.md) - style guidance specific to GitHub Docs content and additional resources for writing clear, helpful content
- [deployments](./deployments.md) - how our staging and production environments work
- [liquid helpers](./liquid-helpers.md) - using liquid helpers for versioning in our docs
- [localization checklist](./localization-checklist.md) - making sure your content is ready to be translated
diff --git a/contributing/content-markup-reference.md b/contributing/content-markup-reference.md
index 9a0636a84058..0298123710ff 100644
--- a/contributing/content-markup-reference.md
+++ b/contributing/content-markup-reference.md
@@ -64,7 +64,7 @@ Octicons are icons used across GitHub’s interface. We reference Octicons when
`{% octicon "" %}`
`{% octicon "plus" %}`
-`{% octicon "plus" aria-label="The plus icon"}`
+`{% octicon "plus" aria-label="The plus icon" %}`
## Operating system tags
diff --git a/contributing/content-style-guide.md b/contributing/content-style-guide.md
index 470cb468d520..f103bf3dcbc0 100644
--- a/contributing/content-style-guide.md
+++ b/contributing/content-style-guide.md
@@ -2,7 +2,7 @@
Welcome to the content style guide for [GitHub Docs](https://docs.github.com/).
-These guidelines are specific to GitHub’s documentation. For general style questions or guidance on topics not covered here, see the [GitHub Brand Guide](https://brand.github.com/content/) first, then the [Microsoft Style Guide](https://docs.microsoft.com/en-us/style-guide/welcome/). For markup specific to source content on docs.github.com, see our [markup reference guide](content-markup-reference.md).
+These guidelines are specific to GitHub’s documentation. For general style questions or guidance on topics not covered here, see the [GitHub Brand Guide](https://brand.github.com/content/) first, then the [Microsoft Style Guide](https://docs.microsoft.com/style-guide/welcome/). For markup specific to source content on docs.github.com, see our [markup reference guide](content-markup-reference.md).
## Table of contents
- [The GitHub Docs approach to style](#the-github-docs-approach-to-style)
@@ -132,7 +132,7 @@ schedule:
## Headers
Use H3 for headers, and H4 for subheaders. When referring to headers, surround the header name with quotation marks.
-- **Use:** Under “User licences”, view your total licenses.
+- **Use:** Under “User licenses”, view your total licenses.
To orient readers and help them understand if the section is relevant to them, include introductory content after a header - don’t locate a subheader directly following a header.
@@ -140,7 +140,7 @@ To orient readers and help them understand if the section is relevant to them, i
### Alt text
-Every image must include an alt attribute that provides a complete description of the image for the user. For more information, see “[Images, image maps, and multimedia](https://docs.microsoft.com/en-us/style-guide/accessibility/graphics-design-media#images-image-maps-and-multimedia)” in Microsoft’s Style Guide.
+Every image must include an alt attribute that provides a complete description of the image for the user. For more information, see “[Images, image maps, and multimedia](https://docs.microsoft.com/style-guide/accessibility/graphics-design-media#images-image-maps-and-multimedia)” in Microsoft’s Style Guide.
### Filenames
@@ -170,9 +170,9 @@ GitHub Brand Guide:
- [People and communities](https://brand.github.com/content/grammar#people-and-communities)
The Microsoft Style Guide offers resources on bias-free communication, accessibility terms, and writing for all abilities:
-- [Bias-free communication](https://docs.microsoft.com/en-us/style-guide/bias-free-communication)
-- [Writing for all abilities](https://docs.microsoft.com/en-us/style-guide/accessibility/writing-all-abilities)
-- [Accessibility terms](https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/accessibility-terms)
+- [Bias-free communication](https://docs.microsoft.com/style-guide/bias-free-communication)
+- [Writing for all abilities](https://docs.microsoft.com/style-guide/accessibility/writing-all-abilities)
+- [Accessibility terms](https://docs.microsoft.com/style-guide/a-z-word-list-term-collections/term-collections/accessibility-terms)
More resources for learning about inclusive and accessible language and style:
- [18F Content Guide on Inclusive Language](https://content-guide.18f.gov/inclusive-language/)
@@ -257,7 +257,7 @@ Take care to distinguish between product names and product elements. For more in
## Punctuation
-Follow standard American English punctuation rules. For more guidance, see “[Punctuation](https://brand.github.com/content/grammar#punctuation)” in GitHub’s Brand Guide and “[Punctuation](https://docs.microsoft.com/en-us/style-guide/punctuation)” in the Microsoft Style Guide.
+Follow standard American English punctuation rules. For more guidance, see “[Punctuation](https://brand.github.com/content/grammar#punctuation)” in GitHub’s Brand Guide and “[Punctuation](https://docs.microsoft.com/style-guide/punctuation)” in the Microsoft Style Guide.
## Reusables and variables
Use reusable strings for individual nouns (e.g. product names) or for complete sentences or paragraphs. Sentence fragments and phrases should not be contained in reusable strings as they can cause problems when content is localized. For more information, see the data directory in the github/docs repository and the “Product names” section of this document.
@@ -272,7 +272,7 @@ A table’s contents should be clear from the preceding content - avoid unneeded
Use quotation marks around article titles, whether the article is hosted on GitHub Docs or elsewhere. Do not include quotation marks around the names of external sites.
-For further guidance, see “[Formatting titles](https://docs.microsoft.com/en-us/style-guide/text-formatting/formatting-titles)” in Microsoft’s Style Guide.
+For further guidance, see “[Formatting titles](https://docs.microsoft.com/style-guide/text-formatting/formatting-titles)” in Microsoft’s Style Guide.
## User interface elements
@@ -338,15 +338,15 @@ GitHub Brand Guide:
- [Referring to GitHub features and product elements](https://brand.github.com/content/terminology/#referring-to-github-features-and-product-elements)
- [Page names and UI references](https://brand.github.com/content/grammar#page-names-and-ui-references)
Microsoft Style Guide:
-- [Formatting text in instructions](https://docs.microsoft.com/en-us/style-guide/procedures-instructions/formatting-text-in-instructions)
+- [Formatting text in instructions](https://docs.microsoft.com/style-guide/procedures-instructions/formatting-text-in-instructions)
## Voice and tone
-Use clear, simple language that’s approachable and accessible for a wide range of readers. For more information, see “[Voice](https://brand.github.com/content/voice/)” in GitHub’s Brand Guide. To learn more about writing approachable content, see “[Microsoft's brand voice: Above all, simple and human](https://docs.microsoft.com/en-us/style-guide/brand-voice-above-all-simple-human) and “[Top 10 tips for Microsoft style and voice](https://docs.microsoft.com/en-us/style-guide/top-10-tips-style-voice).”
+Use clear, simple language that’s approachable and accessible for a wide range of readers. For more information, see “[Voice](https://brand.github.com/content/voice)” in GitHub’s Brand Guide. To learn more about writing approachable content, see “[Microsoft's brand voice: Above all, simple and human](https://docs.microsoft.com/style-guide/brand-voice-above-all-simple-human) and “[Top 10 tips for Microsoft style and voice](https://docs.microsoft.com/style-guide/top-10-tips-style-voice).”
## Word choice and terminology
-For general guidance and GitHub-specific terms, see “[Terminology](https://brand.github.com/content/terminology)” and “[Words that can be tricky](https://brand.github.com/content/grammar#words-that-can-be-tricky)” in GitHub’s Brand Guide. For more detailed guidance, see the “[A-Z word list](https://docs.microsoft.com/en-us/style-guide)” in Microsoft’s style guide.
+For general guidance and GitHub-specific terms, see “[Terminology](https://brand.github.com/content/terminology)” and “[Words that can be tricky](https://brand.github.com/content/grammar#words-that-can-be-tricky)” in GitHub’s Brand Guide. For more detailed guidance, see the “[A-Z word list](https://docs.microsoft.com/style-guide)” in Microsoft’s style guide.
### Abbreviations
diff --git a/contributing/development.md b/contributing/development.md
index f2c49e9d0c07..7c6f3b297b1f 100644
--- a/contributing/development.md
+++ b/contributing/development.md
@@ -8,7 +8,7 @@ This site is powered by Node.js! :sparkles: :turtle: :rocket: :sparkles:
It runs on macOS, Windows, and Linux environments.
-You'll need Node.js version 12 or 14 to run the site. To install Node.js, [download the "LTS" installer from nodejs.org](https://nodejs.org). If you're using [`nodenv`](https://github.com/nodenv/nodenv), read the [`nodenv` docs](#nodenv) for instructions on switching Node.js versions.
+You'll need Node.js version 12 or 14 to run the site. To install Node.js, [download the "LTS" installer from nodejs.org](https://nodejs.org). If you're using [`nodenv`](https://github.com/nodenv/nodenv), read the [`nodenv` docs](#nodenv) for instructions on switching Node.js versions.
Once you've installed Node.js (which includes the popular `npm` package manager), open Terminal and run the following:
@@ -16,6 +16,7 @@ Once you've installed Node.js (which includes the popular `npm` package manager)
git clone https://github.com/github/docs
cd docs
npm install
+npm run build
npm start
```
@@ -23,6 +24,8 @@ You should now have a running server! Visit [localhost:4000](http://localhost:40
When you're ready to stop your local server, type CTRLc in your terminal window.
+Note that `npm run build` is a one-time step that create static assets.
+
### Using GitHub Codespaces
As an alternative, you can simply use [GitHub Codespaces](https://github.com/features/codespaces).
diff --git a/contributing/localization-checklist.md b/contributing/localization-checklist.md
index 432384699eda..2a617dde53e8 100644
--- a/contributing/localization-checklist.md
+++ b/contributing/localization-checklist.md
@@ -26,7 +26,7 @@ Use the following checklist to help make your files more translation-friendly. F
| Guideline | Avoid | Use instead |
| --------- | ----- | ----------- |
| Avoid country specific information. | 800 numbers, addresses, etc. | If necessary, mention what countries the information applies to. |
-| Avoid the excessive use of stacked modifiers (Noun strings). This can lead to incorrect translations because it is not easy to tell what modifies what. | “public repository default source settings” or “Oauth app access restrictions” | "Default source settings for the public repository" or "restrictions for Oath app access." If using a stacked modifier is essential, make sure the background information and context are clear so the linguist understands what is the noun that is being modified. |
+| Avoid the excessive use of stacked modifiers (Noun strings). This can lead to incorrect translations because it is not easy to tell what modifies what. | “public repository default source settings” or “OAuth app access restrictions” | "Default source settings for the public repository" or "restrictions for OAuth app access." If using a stacked modifier is essential, make sure the background information and context are clear so the linguist understands what is the noun that is being modified. |
| Avoid invisible plurals. | "Program update" or "File retrieval". Is this an update of one program or a general procedure for multiple programs? For "File retrieval", Are you retrieving one file or all of them? | Write the sentence more clearly or provide additional context to eliminate ambiguity that can result in an incorrect translation. |
| Avoid nominalization. | "To reach a conclusion" | Use "Conclude." |
| Avoid using ambiguous modal auxiliary verbs. | May, might, ought, could, used to, etc. | Be more clear when writing to avoid ambiguity. |
diff --git a/contributing/node-versions.md b/contributing/node-versions.md
index 9ab9c9a66a1c..934f75157737 100644
--- a/contributing/node-versions.md
+++ b/contributing/node-versions.md
@@ -1,6 +1,6 @@
# Node Versions
-In [development](contributing/development.md) enviroments this site will run on Node.js versions `12 - 14`.
+In [development](contributing/development.md) environments this site will run on Node.js versions `12 - 14`.
In [staging and production](contributing/deployments.md) environments this site runs on Node.js 14, the [Active LTS version](https://nodejs.org/en/about/releases/) from 2020-10-27 to 2021-10-26).
diff --git a/contributing/permalinks.md b/contributing/permalinks.md
index 07615c493847..f4c1a8532d7b 100644
--- a/contributing/permalinks.md
+++ b/contributing/permalinks.md
@@ -13,3 +13,9 @@ For example, an article that is available in currently supported versions will h
An article that is not available in Enterprise will have just one permalink:
* `/en/free-pro-team@latest/github/getting-started-with-github/set-up-git`
+
+**If you are a content contributor:** You don't need to worry about supported versions when adding a link to a document. Following the examples above, if you want to reference an article you can just use its relative location:
+
+* `/github/getting-started-with-github/set-up-git`
+
+*(Please note that using a hard-coded link or supported version will result in an error when your submitted PR is automatically tested)*
diff --git a/contributing/troubleshooting.md b/contributing/troubleshooting.md
index ffd3c30bb8d2..41ffd6e5c0b7 100644
--- a/contributing/troubleshooting.md
+++ b/contributing/troubleshooting.md
@@ -1,5 +1,6 @@
-# Troubleshooting status checks
+# Troubleshooting
+- [Troubleshooting server tests that fail locally but pass in CI](#troublshooting-server-tests-that-fail-locally-but-pass-in-ci)
- [Troubleshooting stalled deployments and CI](#troubleshooting-stalled-deployments-and-ci)
- [Staging deployment stalled](#staging-deployment-stalled)
- [CI stalled or stuck](#ci-stalled-or-stuck)
@@ -11,7 +12,13 @@
- [Check external links](#check-external-links)
- [Debugging locally](#debugging-locally)
-## Troubleshooting stalled deployments and CI
+## Troubleshooting
+
+### Troubleshooting server tests that fail locally but pass in CI
+
+If you run the tests locally and get failures in `tests/rendering/server.js` around static assets, stylesheets, and/or the client-side JavaScript bundle, but **the same tests pass in CI** on a PR, you likely need to run `npm run build`. This is a one-time command that creates static assets locally.
+
+See [`development.md`](./development.md) for more info.
### Staging deployment stalled
If a staging deployment is pending for more than 5-10min, try the following:
@@ -83,7 +90,7 @@ Again, you should see more information about the error either in your browser or
The `check internal links` test reports any broken links on the site, including images. The test reports the URL of the broken link, _not_ the file that includes that link, so you'll need to search the `docs` repository to find the file.
-Broken images include `assets/images/` in the URL and are often caused by images being versioned for previous versions of GHES but not uploaded to the appropriate folder in S3. Search the `docs` repository for the file name (e.g., `assets/images/help/repository/security-tab.png`), then make sure the image is versioned correctly in each result. If the image is in a reusable, you'll also need to search for each occurence of that reusable. If the image is versioned correctly, upload the image to the appropriate folder(s) in S3.
+Broken images include `assets/images/` in the URL and are often caused by images being versioned for previous versions of GHES but not uploaded to the appropriate folder in S3. Search the `docs` repository for the file name (e.g., `assets/images/help/repository/security-tab.png`), then make sure the image is versioned correctly in each result. If the image is in a reusable, you'll also need to search for each occurrence of that reusable. If the image is versioned correctly, upload the image to the appropriate folder(s) in S3.
For broken links to articles on our site, find the file that contains the link by searching the `docs` repository for the file name (e.g., `incorporating-feedback-in-your-pull-request`). Try the following fixes:
@@ -107,4 +114,4 @@ During development, you can visit any page on `http://localhost:4000` and add `?
| `permalinks` | Shows all [permalinks](contributing/permalinks.md) that the site is generating for the page.
| `redirect_from` | Shows the hardcoded redirects in the [`redirect_from` frontmatter](content#redirect_from).
| `redirects` | Shows all redirects that the site is generating for the page.
-| `includesPlatformSpecificContent` | Shows whether the site detects any [platform-specific content](#operating-system-tags) on the page.
\ No newline at end of file
+| `includesPlatformSpecificContent` | Shows whether the site detects any [platform-specific content](#operating-system-tags) on the page.
diff --git a/data/glossaries/external.yml b/data/glossaries/external.yml
index eb494a7c241a..ab095361f6b2 100644
--- a/data/glossaries/external.yml
+++ b/data/glossaries/external.yml
@@ -60,9 +60,9 @@
- term: branch
description: >-
A branch is a parallel version of a repository. It is contained within the
- repository, but does not affect the primary or master branch allowing you to
+ repository, but does not affect the primary or main branch allowing you to
work freely without disrupting the "live" version. When you've made the
- changes you want to make, you can merge your branch back into the master
+ changes you want to make, you can merge your branch back into the main
branch to publish your changes.
- term: branch restriction
description: >-
@@ -141,8 +141,9 @@
Short, descriptive text that accompanys a commit and communicates the change
the commit is introducing.
- term: compare branch
- description: The branch you use to create a pull request.
- This branch is compared to the base branch you choose for the pull request, and the changes are identified.
+ description: >-
+ The branch you use to create a pull request.
+ This branch is compared to the base branch you choose for the pull request, and the changes are identified.
When the pull request is merged, the base branch is updated with the changes from the compare branch.
Also known as the "head branch" of the pull request.
- term: continuous integration
@@ -395,12 +396,18 @@
Markdown and uses a particular form of Markdown called GitHub Flavored Markdown. See [GitHub Flavored Markdown Spec](https://github.github.com/gfm/) or [Getting started with writing and formatting on GitHub](/articles/getting-started-with-writing-and-formatting-on-github).
- term: Markup
description: A system for annotating and formatting a document.
-- term: master
+- term: main
description: >-
The default development branch. Whenever you create a Git repository, a
- branch named "master" is created, and becomes the active branch. In most
+ branch named "main" is created, and becomes the active branch. In most
cases, this contains the local development, though that is purely by
convention and is not required.
+- term: master
+ description: >-
+ The default branch in many Git repositories. By default, when you create
+ a new Git repository on the command line a branch called `master` is created.
+ Many tools now use an alternative name for the default branch. For example,
+ when you create a new repository on GitHub the default branch is called `main`.
- term: Members graph
description: A repository graph that shows all the forks of a repository.
- term: mention
diff --git a/data/graphql/2.17/graphql_upcoming_changes.public-enterprise.yml b/data/graphql/2.17/graphql_upcoming_changes.public-enterprise.yml
deleted file mode 100644
index f399296f14d1..000000000000
--- a/data/graphql/2.17/graphql_upcoming_changes.public-enterprise.yml
+++ /dev/null
@@ -1,78 +0,0 @@
----
-upcoming_changes:
-- location: Migration.uploadUrlTemplate
- description: "`uploadUrlTemplate` will be removed. Use `uploadUrl` instead."
- reason: "`uploadUrlTemplate` is being removed because it is not a standard URL and
- adds an extra user step."
- date: '2019-04-01T00:00:00+00:00'
- criticality: breaking
- owner: tambling
-- location: Organization.members
- description: "`members` will be removed. Use `Organization.membersWithRole` instead."
- reason: The `members` field is deprecated and will be removed soon.
- date: '2019-04-01T00:00:00+00:00'
- criticality: breaking
- owner: xuorig
-- location: ContributionsCollection.firstIssueContribution.ignoreTimeRange
- description: "`ignoreTimeRange` will be removed. Use a `ContributionsCollection`
- starting sufficiently far back"
- reason: ignore_time_range will be removed
- date: '2019-07-01T00:00:00+00:00'
- criticality: breaking
- owner: seejohnrun
-- location: ContributionsCollection.firstPullRequestContribution.ignoreTimeRange
- description: "`ignoreTimeRange` will be removed. Use a `ContributionsCollection`
- starting sufficiently far back"
- reason: ignore_time_range will be removed
- date: '2019-07-01T00:00:00+00:00'
- criticality: breaking
- owner: seejohnrun
-- location: ContributionsCollection.firstRepositoryContribution.ignoreTimeRange
- description: "`ignoreTimeRange` will be removed. Use a `ContributionsCollection`
- starting sufficiently far back"
- reason: ignore_time_range will be removed
- date: '2019-07-01T00:00:00+00:00'
- criticality: breaking
- owner: seejohnrun
-- location: ContributionsCollection.joinedGitHubContribution.ignoreTimeRange
- description: "`ignoreTimeRange` will be removed. Use a `ContributionsCollection`
- starting sufficiently far back"
- reason: ignore_time_range will be removed
- date: '2019-07-01T00:00:00+00:00'
- criticality: breaking
- owner: seejohnrun
-- location: Organization.pinnedRepositories
- description: "`pinnedRepositories` will be removed. Use ProfileOwner.pinnedItems
- instead."
- reason: pinnedRepositories will be removed
- date: '2019-07-01T00:00:00+00:00'
- criticality: breaking
- owner: cheshire137
-- location: RepositoryOwner.pinnedRepositories
- description: "`pinnedRepositories` will be removed. Use ProfileOwner.pinnedItems
- instead."
- reason: pinnedRepositories will be removed
- date: '2019-07-01T00:00:00+00:00'
- criticality: breaking
- owner: cheshire137
-- location: ReviewDismissedEvent.message
- description: "`message` will be removed. Use `dismissalMessage` instead."
- reason: "`message` is being removed because it not nullable, whereas the underlying
- field is optional."
- date: '2019-07-01T00:00:00+00:00'
- criticality: breaking
- owner: nickvanw
-- location: ReviewDismissedEvent.messageHtml
- description: "`messageHtml` will be removed. Use `dismissalMessageHTML` instead."
- reason: "`messageHtml` is being removed because it not nullable, whereas the underlying
- field is optional."
- date: '2019-07-01T00:00:00+00:00'
- criticality: breaking
- owner: nickvanw
-- location: User.pinnedRepositories
- description: "`pinnedRepositories` will be removed. Use ProfileOwner.pinnedItems
- instead."
- reason: pinnedRepositories will be removed
- date: '2019-07-01T00:00:00+00:00'
- criticality: breaking
- owner: cheshire137
diff --git a/data/graphql/2.17/schema.docs-enterprise.graphql b/data/graphql/2.17/schema.docs-enterprise.graphql
deleted file mode 100644
index d4b328207144..000000000000
--- a/data/graphql/2.17/schema.docs-enterprise.graphql
+++ /dev/null
@@ -1,22267 +0,0 @@
-"""
-Defines what type of global IDs are accepted for a mutation argument of type ID.
-"""
-directive @possibleTypes(
- """
- Abstract type of accepted global ID
- """
- abstractType: String
-
- """
- Accepted types of global IDs.
- """
- concreteTypes: [String!]!
-) on INPUT_FIELD_DEFINITION
-
-"""
-Marks an element of a GraphQL schema as only available via a preview header
-"""
-directive @preview(
- """
- The identifier of the API preview that toggles this field.
- """
- toggledBy: String
-) on SCALAR | OBJECT | FIELD_DEFINITION | ARGUMENT_DEFINITION | INTERFACE | UNION | ENUM | ENUM_VALUE | INPUT_OBJECT | INPUT_FIELD_DEFINITION
-
-"""
-Represents an object which can take actions on GitHub. Typically a User or Bot.
-"""
-interface Actor {
- """
- A URL pointing to the actor's public avatar.
- """
- avatarUrl(
- """
- The size of the resulting square image.
- """
- size: Int
- ): URI!
-
- """
- The username of the actor.
- """
- login: String!
-
- """
- The HTTP path for this actor.
- """
- resourcePath: URI!
-
- """
- The HTTP URL for this actor.
- """
- url: URI!
-}
-
-"""
-Autogenerated input type of AddAssigneesToAssignable
-"""
-input AddAssigneesToAssignableInput {
- """
- The id of the assignable object to add assignees to.
- """
- assignableId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "Assignable")
-
- """
- The id of users to add as assignees.
- """
- assigneeIds: [ID!]! @possibleTypes(concreteTypes: ["User"])
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-}
-
-"""
-Autogenerated return type of AddAssigneesToAssignable
-"""
-type AddAssigneesToAssignablePayload {
- """
- The item that was assigned.
- """
- assignable: Assignable
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-}
-
-"""
-Autogenerated input type of AddComment
-"""
-input AddCommentInput {
- """
- The contents of the comment.
- """
- body: String!
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The Node ID of the subject to modify.
- """
- subjectId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "IssueOrPullRequest")
-}
-
-"""
-Autogenerated return type of AddComment
-"""
-type AddCommentPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The edge from the subject's comment connection.
- """
- commentEdge: IssueCommentEdge
-
- """
- The subject
- """
- subject: Node
-
- """
- The edge from the subject's timeline connection.
- """
- timelineEdge: IssueTimelineItemEdge
-}
-
-"""
-Autogenerated input type of AddLabelsToLabelable
-"""
-input AddLabelsToLabelableInput {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The ids of the labels to add.
- """
- labelIds: [ID!]! @possibleTypes(concreteTypes: ["Label"])
-
- """
- The id of the labelable object to add labels to.
- """
- labelableId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "Labelable")
-}
-
-"""
-Autogenerated return type of AddLabelsToLabelable
-"""
-type AddLabelsToLabelablePayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The item that was labeled.
- """
- labelable: Labelable
-}
-
-"""
-Autogenerated input type of AddProjectCard
-"""
-input AddProjectCardInput {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The content of the card. Must be a member of the ProjectCardItem union
- """
- contentId: ID @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "ProjectCardItem")
-
- """
- The note on the card.
- """
- note: String
-
- """
- The Node ID of the ProjectColumn.
- """
- projectColumnId: ID! @possibleTypes(concreteTypes: ["ProjectColumn"])
-}
-
-"""
-Autogenerated return type of AddProjectCard
-"""
-type AddProjectCardPayload {
- """
- The edge from the ProjectColumn's card connection.
- """
- cardEdge: ProjectCardEdge
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The ProjectColumn
- """
- projectColumn: ProjectColumn
-}
-
-"""
-Autogenerated input type of AddProjectColumn
-"""
-input AddProjectColumnInput {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The name of the column.
- """
- name: String!
-
- """
- The Node ID of the project.
- """
- projectId: ID! @possibleTypes(concreteTypes: ["Project"])
-}
-
-"""
-Autogenerated return type of AddProjectColumn
-"""
-type AddProjectColumnPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The edge from the project's column connection.
- """
- columnEdge: ProjectColumnEdge
-
- """
- The project
- """
- project: Project
-}
-
-"""
-Autogenerated input type of AddPullRequestReviewComment
-"""
-input AddPullRequestReviewCommentInput {
- """
- The text of the comment.
- """
- body: String!
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The SHA of the commit to comment on.
- """
- commitOID: GitObjectID
-
- """
- The comment id to reply to.
- """
- inReplyTo: ID @possibleTypes(concreteTypes: ["PullRequestReviewComment"])
-
- """
- The relative path of the file to comment on.
- """
- path: String
-
- """
- The line index in the diff to comment on.
- """
- position: Int
-
- """
- The Node ID of the review to modify.
- """
- pullRequestReviewId: ID! @possibleTypes(concreteTypes: ["PullRequestReview"])
-}
-
-"""
-Autogenerated return type of AddPullRequestReviewComment
-"""
-type AddPullRequestReviewCommentPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The newly created comment.
- """
- comment: PullRequestReviewComment
-
- """
- The edge from the review's comment connection.
- """
- commentEdge: PullRequestReviewCommentEdge
-}
-
-"""
-Autogenerated input type of AddPullRequestReview
-"""
-input AddPullRequestReviewInput {
- """
- The contents of the review body comment.
- """
- body: String
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The review line comments.
- """
- comments: [DraftPullRequestReviewComment]
-
- """
- The commit OID the review pertains to.
- """
- commitOID: GitObjectID
-
- """
- The event to perform on the pull request review.
- """
- event: PullRequestReviewEvent
-
- """
- The Node ID of the pull request to modify.
- """
- pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"])
-}
-
-"""
-Autogenerated return type of AddPullRequestReview
-"""
-type AddPullRequestReviewPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The newly created pull request review.
- """
- pullRequestReview: PullRequestReview
-
- """
- The edge from the pull request's review connection.
- """
- reviewEdge: PullRequestReviewEdge
-}
-
-"""
-Autogenerated input type of AddReaction
-"""
-input AddReactionInput {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The name of the emoji to react with.
- """
- content: ReactionContent!
-
- """
- The Node ID of the subject to modify.
- """
- subjectId: ID! @possibleTypes(concreteTypes: ["CommitComment", "Issue", "IssueComment", "PullRequest", "PullRequestReview", "PullRequestReviewComment", "TeamDiscussion", "TeamDiscussionComment"], abstractType: "Reactable")
-}
-
-"""
-Autogenerated return type of AddReaction
-"""
-type AddReactionPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The reaction object.
- """
- reaction: Reaction
-
- """
- The reactable subject.
- """
- subject: Reactable
-}
-
-"""
-Autogenerated input type of AddStar
-"""
-input AddStarInput {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The Starrable ID to star.
- """
- starrableId: ID! @possibleTypes(concreteTypes: ["Gist", "Repository", "Topic"], abstractType: "Starrable")
-}
-
-"""
-Autogenerated return type of AddStar
-"""
-type AddStarPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The starrable.
- """
- starrable: Starrable
-}
-
-"""
-Represents a 'added_to_project' event on a given issue or pull request.
-"""
-type AddedToProjectEvent implements Node {
- """
- Identifies the actor who performed the event.
- """
- actor: Actor
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- Identifies the primary key from the database.
- """
- databaseId: Int
- id: ID!
-
- """
- Project referenced by event.
- """
- project: Project @preview(toggledBy: "starfox-preview")
-
- """
- Project card referenced by this project event.
- """
- projectCard: ProjectCard @preview(toggledBy: "starfox-preview")
-
- """
- Column name referenced by this project event.
- """
- projectColumnName: String! @preview(toggledBy: "starfox-preview")
-}
-
-"""
-A GitHub App.
-"""
-type App implements Node {
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- Identifies the primary key from the database.
- """
- databaseId: Int
-
- """
- The description of the app.
- """
- description: String
- id: ID!
-
- """
- The hex color code, without the leading '#', for the logo background.
- """
- logoBackgroundColor: String!
-
- """
- A URL pointing to the app's logo.
- """
- logoUrl(
- """
- The size of the resulting image.
- """
- size: Int
- ): URI!
-
- """
- The name of the app.
- """
- name: String!
-
- """
- A slug based on the name of the app for use in URLs.
- """
- slug: String!
-
- """
- Identifies the date and time when the object was last updated.
- """
- updatedAt: DateTime!
-
- """
- The URL to the app's homepage.
- """
- url: URI!
-}
-
-"""
-An object that can have users assigned to it.
-"""
-interface Assignable {
- """
- A list of Users assigned to this object.
- """
- assignees(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): UserConnection!
-}
-
-"""
-Represents an 'assigned' event on any assignable object.
-"""
-type AssignedEvent implements Node {
- """
- Identifies the actor who performed the event.
- """
- actor: Actor
-
- """
- Identifies the assignable associated with the event.
- """
- assignable: Assignable!
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
- id: ID!
-
- """
- Identifies the user who was assigned.
- """
- user: User
-}
-
-"""
-Represents a 'base_ref_changed' event on a given issue or pull request.
-"""
-type BaseRefChangedEvent implements Node {
- """
- Identifies the actor who performed the event.
- """
- actor: Actor
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- Identifies the primary key from the database.
- """
- databaseId: Int
- id: ID!
-}
-
-"""
-Represents a 'base_ref_force_pushed' event on a given pull request.
-"""
-type BaseRefForcePushedEvent implements Node {
- """
- Identifies the actor who performed the event.
- """
- actor: Actor
-
- """
- Identifies the after commit SHA for the 'base_ref_force_pushed' event.
- """
- afterCommit: Commit
-
- """
- Identifies the before commit SHA for the 'base_ref_force_pushed' event.
- """
- beforeCommit: Commit
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
- id: ID!
-
- """
- PullRequest referenced by event.
- """
- pullRequest: PullRequest!
-
- """
- Identifies the fully qualified ref name for the 'base_ref_force_pushed' event.
- """
- ref: Ref
-}
-
-"""
-Represents a Git blame.
-"""
-type Blame {
- """
- The list of ranges from a Git blame.
- """
- ranges: [BlameRange!]!
-}
-
-"""
-Represents a range of information from a Git blame.
-"""
-type BlameRange {
- """
- Identifies the recency of the change, from 1 (new) to 10 (old). This is
- calculated as a 2-quantile and determines the length of distance between the
- median age of all the changes in the file and the recency of the current
- range's change.
- """
- age: Int!
-
- """
- Identifies the line author
- """
- commit: Commit!
-
- """
- The ending line for the range
- """
- endingLine: Int!
-
- """
- The starting line for the range
- """
- startingLine: Int!
-}
-
-"""
-Represents a Git blob.
-"""
-type Blob implements GitObject & Node {
- """
- An abbreviated version of the Git object ID
- """
- abbreviatedOid: String!
-
- """
- Byte size of Blob object
- """
- byteSize: Int!
-
- """
- The HTTP path for this Git object
- """
- commitResourcePath: URI!
-
- """
- The HTTP URL for this Git object
- """
- commitUrl: URI!
- id: ID!
-
- """
- Indicates whether the Blob is binary or text
- """
- isBinary: Boolean!
-
- """
- Indicates whether the contents is truncated
- """
- isTruncated: Boolean!
-
- """
- The Git object ID
- """
- oid: GitObjectID!
-
- """
- The Repository the Git object belongs to
- """
- repository: Repository!
-
- """
- UTF8 text data or null if the Blob is binary
- """
- text: String
-}
-
-"""
-A special type of user which takes actions on behalf of GitHub Apps.
-"""
-type Bot implements Actor & Node & UniformResourceLocatable {
- """
- A URL pointing to the GitHub App's public avatar.
- """
- avatarUrl(
- """
- The size of the resulting square image.
- """
- size: Int
- ): URI!
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- Identifies the primary key from the database.
- """
- databaseId: Int
- id: ID!
-
- """
- The username of the actor.
- """
- login: String!
-
- """
- The HTTP path for this bot
- """
- resourcePath: URI!
-
- """
- Identifies the date and time when the object was last updated.
- """
- updatedAt: DateTime!
-
- """
- The HTTP URL for this bot
- """
- url: URI!
-}
-
-"""
-A branch protection rule.
-"""
-type BranchProtectionRule implements Node {
- """
- A list of conflicts matching branches protection rule and other branch protection rules
- """
- branchProtectionRuleConflicts(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): BranchProtectionRuleConflictConnection!
-
- """
- The actor who created this branch protection rule.
- """
- creator: Actor
-
- """
- Identifies the primary key from the database.
- """
- databaseId: Int
-
- """
- Will new commits pushed to matching branches dismiss pull request review approvals.
- """
- dismissesStaleReviews: Boolean!
- id: ID!
-
- """
- Can admins overwrite branch protection.
- """
- isAdminEnforced: Boolean!
-
- """
- Repository refs that are protected by this rule
- """
- matchingRefs(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): RefConnection!
-
- """
- Identifies the protection rule pattern.
- """
- pattern: String!
-
- """
- A list push allowances for this branch protection rule.
- """
- pushAllowances(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): PushAllowanceConnection!
-
- """
- The repository associated with this branch protection rule.
- """
- repository: Repository
-
- """
- Number of approving reviews required to update matching branches.
- """
- requiredApprovingReviewCount: Int
-
- """
- List of required status check contexts that must pass for commits to be accepted to matching branches.
- """
- requiredStatusCheckContexts: [String]
-
- """
- Are approving reviews required to update matching branches.
- """
- requiresApprovingReviews: Boolean!
-
- """
- Are commits required to be signed.
- """
- requiresCommitSignatures: Boolean!
-
- """
- Are status checks required to update matching branches.
- """
- requiresStatusChecks: Boolean!
-
- """
- Are branches required to be up to date before merging.
- """
- requiresStrictStatusChecks: Boolean!
-
- """
- Is pushing to matching branches restricted.
- """
- restrictsPushes: Boolean!
-
- """
- Is dismissal of pull request reviews restricted.
- """
- restrictsReviewDismissals: Boolean!
-
- """
- A list review dismissal allowances for this branch protection rule.
- """
- reviewDismissalAllowances(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): ReviewDismissalAllowanceConnection!
-}
-
-"""
-A conflict between two branch protection rules.
-"""
-type BranchProtectionRuleConflict {
- """
- Identifies the branch protection rule.
- """
- branchProtectionRule: BranchProtectionRule
-
- """
- Identifies the conflicting branch protection rule.
- """
- conflictingBranchProtectionRule: BranchProtectionRule
-
- """
- Identifies the branch ref that has conflicting rules
- """
- ref: Ref
-}
-
-"""
-The connection type for BranchProtectionRuleConflict.
-"""
-type BranchProtectionRuleConflictConnection {
- """
- A list of edges.
- """
- edges: [BranchProtectionRuleConflictEdge]
-
- """
- A list of nodes.
- """
- nodes: [BranchProtectionRuleConflict]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type BranchProtectionRuleConflictEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: BranchProtectionRuleConflict
-}
-
-"""
-The connection type for BranchProtectionRule.
-"""
-type BranchProtectionRuleConnection {
- """
- A list of edges.
- """
- edges: [BranchProtectionRuleEdge]
-
- """
- A list of nodes.
- """
- nodes: [BranchProtectionRule]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type BranchProtectionRuleEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: BranchProtectionRule
-}
-
-"""
-Autogenerated input type of ChangeUserStatus
-"""
-input ChangeUserStatusInput {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The emoji to represent your status. Can either be a native Unicode emoji or an emoji name with colons, e.g., :grinning:.
- """
- emoji: String
-
- """
- Whether this status should indicate you are not fully available on GitHub, e.g., you are away.
- """
- limitedAvailability: Boolean = false
-
- """
- A short description of your current status.
- """
- message: String
-
- """
- The ID of the organization whose members will be allowed to see the status. If
- omitted, the status will be publicly visible.
- """
- organizationId: ID @possibleTypes(concreteTypes: ["Organization"])
-}
-
-"""
-Autogenerated return type of ChangeUserStatus
-"""
-type ChangeUserStatusPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- Your updated status.
- """
- status: UserStatus
-}
-
-"""
-A single check annotation.
-"""
-type CheckAnnotation @preview(toggledBy: "antiope-preview") {
- """
- The annotation's severity level.
- """
- annotationLevel: CheckAnnotationLevel
-
- """
- The path to the file that this annotation was made on.
- """
- blobUrl: URI!
-
- """
- Identifies the primary key from the database.
- """
- databaseId: Int
-
- """
- The position of this annotation.
- """
- location: CheckAnnotationSpan!
-
- """
- The annotation's message.
- """
- message: String!
-
- """
- The path that this annotation was made on.
- """
- path: String!
-
- """
- Additional information about the annotation.
- """
- rawDetails: String
-
- """
- The annotation's title
- """
- title: String
-}
-
-"""
-The connection type for CheckAnnotation.
-"""
-type CheckAnnotationConnection {
- """
- A list of edges.
- """
- edges: [CheckAnnotationEdge]
-
- """
- A list of nodes.
- """
- nodes: [CheckAnnotation] @preview(toggledBy: "antiope-preview")
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-Information from a check run analysis to specific lines of code.
-"""
-input CheckAnnotationData @preview(toggledBy: "antiope-preview") {
- """
- Represents an annotation's information level
- """
- annotationLevel: CheckAnnotationLevel!
-
- """
- The location of the annotation
- """
- location: CheckAnnotationRange!
-
- """
- A short description of the feedback for these lines of code.
- """
- message: String!
-
- """
- The path of the file to add an annotation to.
- """
- path: String!
-
- """
- Details about this annotation.
- """
- rawDetails: String
-
- """
- The title that represents the annotation.
- """
- title: String
-}
-
-"""
-An edge in a connection.
-"""
-type CheckAnnotationEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: CheckAnnotation @preview(toggledBy: "antiope-preview")
-}
-
-"""
-Represents an annotation's information level.
-"""
-enum CheckAnnotationLevel @preview(toggledBy: "antiope-preview") {
- """
- An annotation indicating an inescapable error.
- """
- FAILURE
-
- """
- An annotation indicating some information.
- """
- NOTICE
-
- """
- An annotation indicating an ignorable error.
- """
- WARNING
-}
-
-"""
-A character position in a check annotation.
-"""
-type CheckAnnotationPosition @preview(toggledBy: "antiope-preview") {
- """
- Column number (1 indexed).
- """
- column: Int
-
- """
- Line number (1 indexed).
- """
- line: Int!
-}
-
-"""
-Information from a check run analysis to specific lines of code.
-"""
-input CheckAnnotationRange @preview(toggledBy: "antiope-preview") {
- """
- The ending column of the range.
- """
- endColumn: Int
-
- """
- The ending line of the range.
- """
- endLine: Int!
-
- """
- The starting column of the range.
- """
- startColumn: Int
-
- """
- The starting line of the range.
- """
- startLine: Int!
-}
-
-"""
-An inclusive pair of positions for a check annotation.
-"""
-type CheckAnnotationSpan @preview(toggledBy: "antiope-preview") {
- """
- End position (inclusive).
- """
- end: CheckAnnotationPosition!
-
- """
- Start position (inclusive).
- """
- start: CheckAnnotationPosition!
-}
-
-"""
-The possible states for a check suite or run conclusion.
-"""
-enum CheckConclusionState @preview(toggledBy: "antiope-preview") {
- """
- The check suite or run requires action.
- """
- ACTION_REQUIRED
-
- """
- The check suite or run has been cancelled.
- """
- CANCELLED
-
- """
- The check suite or run has failed.
- """
- FAILURE
-
- """
- The check suite or run was neutral.
- """
- NEUTRAL
-
- """
- The check suite or run has succeeded.
- """
- SUCCESS
-
- """
- The check suite or run has timed out.
- """
- TIMED_OUT
-}
-
-"""
-A check run.
-"""
-type CheckRun implements Node & UniformResourceLocatable @preview(toggledBy: "antiope-preview") {
- """
- The check run's annotations
- """
- annotations(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): CheckAnnotationConnection
-
- """
- The check suite that this run is a part of.
- """
- checkSuite: CheckSuite!
-
- """
- Identifies the date and time when the check run was completed.
- """
- completedAt: DateTime
-
- """
- The conclusion of the check run.
- """
- conclusion: CheckConclusionState
-
- """
- Identifies the primary key from the database.
- """
- databaseId: Int
-
- """
- The URL from which to find full details of the check run on the integrator's site.
- """
- detailsUrl: URI
-
- """
- A reference for the check run on the integrator's system.
- """
- externalId: String
- id: ID!
-
- """
- The name of the check for this check run.
- """
- name: String!
-
- """
- The permalink to the check run summary.
- """
- permalink: URI!
-
- """
- The repository associated with this check run.
- """
- repository: Repository!
-
- """
- The HTTP path for this check run.
- """
- resourcePath: URI!
-
- """
- Identifies the date and time when the check run was started.
- """
- startedAt: DateTime
-
- """
- The current status of the check run.
- """
- status: CheckStatusState!
-
- """
- A string representing the check run's summary
- """
- summary: String
-
- """
- A string representing the check run's text
- """
- text: String
-
- """
- A string representing the check run
- """
- title: String
-
- """
- The HTTP URL for this check run.
- """
- url: URI!
-}
-
-"""
-Possible further actions the integrator can perform.
-"""
-input CheckRunAction @preview(toggledBy: "antiope-preview") {
- """
- A short explanation of what this action would do.
- """
- description: String!
-
- """
- A reference for the action on the integrator's system.
- """
- identifier: String!
-
- """
- The text to be displayed on a button in the web UI.
- """
- label: String!
-}
-
-"""
-The connection type for CheckRun.
-"""
-type CheckRunConnection {
- """
- A list of edges.
- """
- edges: [CheckRunEdge]
-
- """
- A list of nodes.
- """
- nodes: [CheckRun] @preview(toggledBy: "antiope-preview")
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type CheckRunEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: CheckRun @preview(toggledBy: "antiope-preview")
-}
-
-"""
-The filters that are available when fetching check runs.
-"""
-input CheckRunFilter @preview(toggledBy: "antiope-preview") {
- """
- Filters the check runs created by this application ID.
- """
- appId: Int
-
- """
- Filters the check runs by this name.
- """
- checkName: String
-
- """
- Filters the check runs by this type.
- """
- checkType: CheckRunType
-
- """
- Filters the check runs by this status.
- """
- status: CheckStatusState
-}
-
-"""
-Descriptive details about the check run.
-"""
-input CheckRunOutput @preview(toggledBy: "antiope-preview") {
- """
- The annotations that are made as part of the check run.
- """
- annotations: [CheckAnnotationData!]
-
- """
- Images attached to the check run output displayed in the GitHub pull request UI.
- """
- images: [CheckRunOutputImage!]
-
- """
- The summary of the check run (supports Commonmark).
- """
- summary: String!
-
- """
- The details of the check run (supports Commonmark).
- """
- text: String
-
- """
- A title to provide for this check run.
- """
- title: String!
-}
-
-"""
-Images attached to the check run output displayed in the GitHub pull request UI.
-"""
-input CheckRunOutputImage @preview(toggledBy: "antiope-preview") {
- """
- The alternative text for the image.
- """
- alt: String!
-
- """
- A short image description.
- """
- caption: String
-
- """
- The full URL of the image.
- """
- imageUrl: URI!
-}
-
-"""
-The possible types of check runs.
-"""
-enum CheckRunType @preview(toggledBy: "antiope-preview") {
- """
- Every check run available.
- """
- ALL
-
- """
- The latest check run.
- """
- LATEST
-}
-
-"""
-The possible states for a check suite or run status.
-"""
-enum CheckStatusState @preview(toggledBy: "antiope-preview") {
- """
- The check suite or run has been completed.
- """
- COMPLETED
-
- """
- The check suite or run is in progress.
- """
- IN_PROGRESS
-
- """
- The check suite or run has been queued.
- """
- QUEUED
-
- """
- The check suite or run has been requested.
- """
- REQUESTED
-}
-
-"""
-A check suite.
-"""
-type CheckSuite implements Node @preview(toggledBy: "antiope-preview") {
- """
- The GitHub App which created this check suite.
- """
- app: App
-
- """
- The name of the branch for this check suite.
- """
- branch: Ref
-
- """
- The check runs associated with a check suite.
- """
- checkRuns(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Filters the check runs by this type.
- """
- filterBy: CheckRunFilter
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): CheckRunConnection
-
- """
- The commit for this check suite
- """
- commit: Commit!
-
- """
- The conclusion of this check suite.
- """
- conclusion: CheckConclusionState
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- Identifies the primary key from the database.
- """
- databaseId: Int
- id: ID!
-
- """
- A list of open pull requests matching the check suite.
- """
- matchingPullRequests(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- The base ref name to filter the pull requests by.
- """
- baseRefName: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- The head ref name to filter the pull requests by.
- """
- headRefName: String
-
- """
- A list of label names to filter the pull requests by.
- """
- labels: [String!]
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for pull requests returned from the connection.
- """
- orderBy: IssueOrder
-
- """
- A list of states to filter the pull requests by.
- """
- states: [PullRequestState!]
- ): PullRequestConnection
-
- """
- The push that triggered this check suite.
- """
- push: Push
-
- """
- The repository associated with this check suite.
- """
- repository: Repository!
-
- """
- The status of this check suite.
- """
- status: CheckStatusState!
-
- """
- Identifies the date and time when the object was last updated.
- """
- updatedAt: DateTime!
-}
-
-"""
-The auto-trigger preferences that are available for check suites.
-"""
-input CheckSuiteAutoTriggerPreference @preview(toggledBy: "antiope-preview") {
- """
- The node ID of the application that owns the check suite.
- """
- appId: ID!
-
- """
- Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository.
- """
- setting: Boolean!
-}
-
-"""
-The connection type for CheckSuite.
-"""
-type CheckSuiteConnection {
- """
- A list of edges.
- """
- edges: [CheckSuiteEdge]
-
- """
- A list of nodes.
- """
- nodes: [CheckSuite] @preview(toggledBy: "antiope-preview")
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type CheckSuiteEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: CheckSuite @preview(toggledBy: "antiope-preview")
-}
-
-"""
-The filters that are available when fetching check suites.
-"""
-input CheckSuiteFilter @preview(toggledBy: "antiope-preview") {
- """
- Filters the check suites created by this application ID.
- """
- appId: Int
-
- """
- Filters the check suites by this name.
- """
- checkName: String
-}
-
-"""
-Autogenerated input type of ClearLabelsFromLabelable
-"""
-input ClearLabelsFromLabelableInput {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The id of the labelable object to clear the labels from.
- """
- labelableId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "Labelable")
-}
-
-"""
-Autogenerated return type of ClearLabelsFromLabelable
-"""
-type ClearLabelsFromLabelablePayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The item that was unlabeled.
- """
- labelable: Labelable
-}
-
-"""
-Autogenerated input type of CloneProject
-"""
-input CloneProjectInput {
- """
- The description of the project.
- """
- body: String
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- Whether or not to clone the source project's workflows.
- """
- includeWorkflows: Boolean!
-
- """
- The name of the project.
- """
- name: String!
-
- """
- The visibility of the project, defaults to false (private).
- """
- public: Boolean
-
- """
- The source project to clone.
- """
- sourceId: ID! @possibleTypes(concreteTypes: ["Project"])
-
- """
- The owner ID to create the project under.
- """
- targetOwnerId: ID! @possibleTypes(concreteTypes: ["Organization", "Repository", "User"], abstractType: "ProjectOwner")
-}
-
-"""
-Autogenerated return type of CloneProject
-"""
-type CloneProjectPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The id of the JobStatus for populating cloned fields.
- """
- jobStatusId: String
-
- """
- The new cloned project.
- """
- project: Project
-}
-
-"""
-An object that can be closed
-"""
-interface Closable {
- """
- `true` if the object is closed (definition of closed may depend on type)
- """
- closed: Boolean!
-
- """
- Identifies the date and time when the object was closed.
- """
- closedAt: DateTime
-}
-
-"""
-Autogenerated input type of CloseIssue
-"""
-input CloseIssueInput {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- ID of the issue to be closed.
- """
- issueId: ID! @possibleTypes(concreteTypes: ["Issue"])
-}
-
-"""
-Autogenerated return type of CloseIssue
-"""
-type CloseIssuePayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The issue that was closed.
- """
- issue: Issue
-}
-
-"""
-Autogenerated input type of ClosePullRequest
-"""
-input ClosePullRequestInput {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- ID of the pull request to be closed.
- """
- pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"])
-}
-
-"""
-Autogenerated return type of ClosePullRequest
-"""
-type ClosePullRequestPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The pull request that was closed.
- """
- pullRequest: PullRequest
-}
-
-"""
-Represents a 'closed' event on any `Closable`.
-"""
-type ClosedEvent implements Node & UniformResourceLocatable {
- """
- Identifies the actor who performed the event.
- """
- actor: Actor
-
- """
- Object that was closed.
- """
- closable: Closable!
-
- """
- Object which triggered the creation of this event.
- """
- closer: Closer
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
- id: ID!
-
- """
- The HTTP path for this closed event.
- """
- resourcePath: URI!
-
- """
- The HTTP URL for this closed event.
- """
- url: URI!
-}
-
-"""
-The object which triggered a `ClosedEvent`.
-"""
-union Closer = Commit | PullRequest
-
-"""
-The Code of Conduct for a repository
-"""
-type CodeOfConduct implements Node {
- """
- The body of the Code of Conduct
- """
- body: String
- id: ID!
-
- """
- The key for the Code of Conduct
- """
- key: String!
-
- """
- The formal name of the Code of Conduct
- """
- name: String!
-
- """
- The HTTP path for this Code of Conduct
- """
- resourcePath: URI
-
- """
- The HTTP URL for this Code of Conduct
- """
- url: URI
-}
-
-"""
-Collaborators affiliation level with a subject.
-"""
-enum CollaboratorAffiliation {
- """
- All collaborators the authenticated user can see.
- """
- ALL
-
- """
- All collaborators with permissions to an organization-owned subject, regardless of organization membership status.
- """
- DIRECT
-
- """
- All outside collaborators of an organization-owned subject.
- """
- OUTSIDE
-}
-
-"""
-Represents a comment.
-"""
-interface Comment {
- """
- The actor who authored the comment.
- """
- author: Actor
-
- """
- Author's association with the subject of the comment.
- """
- authorAssociation: CommentAuthorAssociation!
-
- """
- The body as Markdown.
- """
- body: String!
-
- """
- The body rendered to HTML.
- """
- bodyHTML: HTML!
-
- """
- The body rendered to text.
- """
- bodyText: String!
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- Check if this comment was created via an email reply.
- """
- createdViaEmail: Boolean!
-
- """
- The actor who edited the comment.
- """
- editor: Actor
- id: ID!
-
- """
- Check if this comment was edited and includes an edit with the creation data
- """
- includesCreatedEdit: Boolean!
-
- """
- The moment the editor made the last edit
- """
- lastEditedAt: DateTime
-
- """
- Identifies when the comment was published at.
- """
- publishedAt: DateTime
-
- """
- Identifies the date and time when the object was last updated.
- """
- updatedAt: DateTime!
-
- """
- A list of edits to this content.
- """
- userContentEdits(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): UserContentEditConnection
-
- """
- Did the viewer author this comment.
- """
- viewerDidAuthor: Boolean!
-}
-
-"""
-A comment author association with repository.
-"""
-enum CommentAuthorAssociation {
- """
- Author has been invited to collaborate on the repository.
- """
- COLLABORATOR
-
- """
- Author has previously committed to the repository.
- """
- CONTRIBUTOR
-
- """
- Author has not previously committed to GitHub.
- """
- FIRST_TIMER
-
- """
- Author has not previously committed to the repository.
- """
- FIRST_TIME_CONTRIBUTOR
-
- """
- Author is a member of the organization that owns the repository.
- """
- MEMBER
-
- """
- Author has no association with the repository.
- """
- NONE
-
- """
- Author is the owner of the repository.
- """
- OWNER
-}
-
-"""
-The possible errors that will prevent a user from updating a comment.
-"""
-enum CommentCannotUpdateReason {
- """
- You cannot update this comment
- """
- DENIED
-
- """
- You must be the author or have write access to this repository to update this comment.
- """
- INSUFFICIENT_ACCESS
-
- """
- Unable to create comment because issue is locked.
- """
- LOCKED
-
- """
- You must be logged in to update this comment.
- """
- LOGIN_REQUIRED
-
- """
- Repository is under maintenance.
- """
- MAINTENANCE
-
- """
- At least one email address must be verified to update this comment.
- """
- VERIFIED_EMAIL_REQUIRED
-}
-
-"""
-Represents a 'comment_deleted' event on a given issue or pull request.
-"""
-type CommentDeletedEvent implements Node {
- """
- Identifies the actor who performed the event.
- """
- actor: Actor
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- Identifies the primary key from the database.
- """
- databaseId: Int
- id: ID!
-}
-
-"""
-Represents a Git commit.
-"""
-type Commit implements GitObject & Node & Subscribable & UniformResourceLocatable {
- """
- An abbreviated version of the Git object ID
- """
- abbreviatedOid: String!
-
- """
- The number of additions in this commit.
- """
- additions: Int!
-
- """
- The pull requests associated with a commit
- """
- associatedPullRequests(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for pull requests.
- """
- orderBy: PullRequestOrder = {field: CREATED_AT, direction: ASC}
- ): PullRequestConnection
-
- """
- Authorship details of the commit.
- """
- author: GitActor
-
- """
- Check if the committer and the author match.
- """
- authoredByCommitter: Boolean!
-
- """
- The datetime when this commit was authored.
- """
- authoredDate: DateTime!
-
- """
- Fetches `git blame` information.
- """
- blame(
- """
- The file whose Git blame information you want.
- """
- path: String!
- ): Blame!
-
- """
- The number of changed files in this commit.
- """
- changedFiles: Int!
-
- """
- The check suites associated with a commit.
- """
- checkSuites(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Filters the check suites by this type.
- """
- filterBy: CheckSuiteFilter
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): CheckSuiteConnection @preview(toggledBy: "antiope-preview")
-
- """
- Comments made on the commit.
- """
- comments(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): CommitCommentConnection!
-
- """
- The HTTP path for this Git object
- """
- commitResourcePath: URI!
-
- """
- The HTTP URL for this Git object
- """
- commitUrl: URI!
-
- """
- The datetime when this commit was committed.
- """
- committedDate: DateTime!
-
- """
- Check if commited via GitHub web UI.
- """
- committedViaWeb: Boolean!
-
- """
- Committership details of the commit.
- """
- committer: GitActor
-
- """
- The number of deletions in this commit.
- """
- deletions: Int!
-
- """
- The deployments associated with a commit.
- """
- deployments(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Environments to list deployments for
- """
- environments: [String!]
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for deployments returned from the connection.
- """
- orderBy: DeploymentOrder = {field: CREATED_AT, direction: ASC}
- ): DeploymentConnection
-
- """
- The linear commit history starting from (and including) this commit, in the same order as `git log`.
- """
- history(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- If non-null, filters history to only show commits with matching authorship.
- """
- author: CommitAuthor
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- If non-null, filters history to only show commits touching files under this path.
- """
- path: String
-
- """
- Allows specifying a beginning time or date for fetching commits.
- """
- since: GitTimestamp
-
- """
- Allows specifying an ending time or date for fetching commits.
- """
- until: GitTimestamp
- ): CommitHistoryConnection!
- id: ID!
-
- """
- The Git commit message
- """
- message: String!
-
- """
- The Git commit message body
- """
- messageBody: String!
-
- """
- The commit message body rendered to HTML.
- """
- messageBodyHTML: HTML!
-
- """
- The Git commit message headline
- """
- messageHeadline: String!
-
- """
- The commit message headline rendered to HTML.
- """
- messageHeadlineHTML: HTML!
-
- """
- The Git object ID
- """
- oid: GitObjectID!
-
- """
- The parents of a commit.
- """
- parents(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): CommitConnection!
-
- """
- The datetime when this commit was pushed.
- """
- pushedDate: DateTime
-
- """
- The Repository this commit belongs to
- """
- repository: Repository!
-
- """
- The HTTP path for this commit
- """
- resourcePath: URI!
-
- """
- Commit signing information, if present.
- """
- signature: GitSignature
-
- """
- Status information for this commit
- """
- status: Status
-
- """
- Returns a URL to download a tarball archive for a repository.
- Note: For private repositories, these links are temporary and expire after five minutes.
- """
- tarballUrl: URI!
-
- """
- Commit's root Tree
- """
- tree: Tree!
-
- """
- The HTTP path for the tree of this commit
- """
- treeResourcePath: URI!
-
- """
- The HTTP URL for the tree of this commit
- """
- treeUrl: URI!
-
- """
- The HTTP URL for this commit
- """
- url: URI!
-
- """
- Check if the viewer is able to change their subscription status for the repository.
- """
- viewerCanSubscribe: Boolean!
-
- """
- Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
- """
- viewerSubscription: SubscriptionState
-
- """
- Returns a URL to download a zipball archive for a repository.
- Note: For private repositories, these links are temporary and expire after five minutes.
- """
- zipballUrl: URI!
-}
-
-"""
-Specifies an author for filtering Git commits.
-"""
-input CommitAuthor {
- """
- Email addresses to filter by. Commits authored by any of the specified email addresses will be returned.
- """
- emails: [String!]
-
- """
- ID of a User to filter by. If non-null, only commits authored by this user
- will be returned. This field takes precedence over emails.
- """
- id: ID
-}
-
-"""
-Represents a comment on a given Commit.
-"""
-type CommitComment implements Comment & Deletable & Minimizable & Node & Reactable & RepositoryNode & Updatable & UpdatableComment {
- """
- The actor who authored the comment.
- """
- author: Actor
-
- """
- Author's association with the subject of the comment.
- """
- authorAssociation: CommentAuthorAssociation!
-
- """
- Identifies the comment body.
- """
- body: String!
-
- """
- Identifies the comment body rendered to HTML.
- """
- bodyHTML: HTML!
-
- """
- The body rendered to text.
- """
- bodyText: String!
-
- """
- Identifies the commit associated with the comment, if the commit exists.
- """
- commit: Commit
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- Check if this comment was created via an email reply.
- """
- createdViaEmail: Boolean!
-
- """
- Identifies the primary key from the database.
- """
- databaseId: Int
-
- """
- The actor who edited the comment.
- """
- editor: Actor
- id: ID!
-
- """
- Check if this comment was edited and includes an edit with the creation data
- """
- includesCreatedEdit: Boolean!
-
- """
- Returns whether or not a comment has been minimized.
- """
- isMinimized: Boolean!
-
- """
- The moment the editor made the last edit
- """
- lastEditedAt: DateTime
-
- """
- Returns why the comment was minimized.
- """
- minimizedReason: String
-
- """
- Identifies the file path associated with the comment.
- """
- path: String
-
- """
- Identifies the line position associated with the comment.
- """
- position: Int
-
- """
- Identifies when the comment was published at.
- """
- publishedAt: DateTime
-
- """
- A list of reactions grouped by content left on the subject.
- """
- reactionGroups: [ReactionGroup!]
-
- """
- A list of Reactions left on the Issue.
- """
- reactions(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Allows filtering Reactions by emoji.
- """
- content: ReactionContent
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Allows specifying the order in which reactions are returned.
- """
- orderBy: ReactionOrder
- ): ReactionConnection!
-
- """
- The repository associated with this node.
- """
- repository: Repository!
-
- """
- The HTTP path permalink for this commit comment.
- """
- resourcePath: URI!
-
- """
- Identifies the date and time when the object was last updated.
- """
- updatedAt: DateTime!
-
- """
- The HTTP URL permalink for this commit comment.
- """
- url: URI!
-
- """
- A list of edits to this content.
- """
- userContentEdits(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): UserContentEditConnection
-
- """
- Check if the current viewer can delete this object.
- """
- viewerCanDelete: Boolean!
-
- """
- Check if the current viewer can minimize this object.
- """
- viewerCanMinimize: Boolean!
-
- """
- Can user react to this subject
- """
- viewerCanReact: Boolean!
-
- """
- Check if the current viewer can update this object.
- """
- viewerCanUpdate: Boolean!
-
- """
- Reasons why the current viewer can not update this comment.
- """
- viewerCannotUpdateReasons: [CommentCannotUpdateReason!]!
-
- """
- Did the viewer author this comment.
- """
- viewerDidAuthor: Boolean!
-}
-
-"""
-The connection type for CommitComment.
-"""
-type CommitCommentConnection {
- """
- A list of edges.
- """
- edges: [CommitCommentEdge]
-
- """
- A list of nodes.
- """
- nodes: [CommitComment]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type CommitCommentEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: CommitComment
-}
-
-"""
-A thread of comments on a commit.
-"""
-type CommitCommentThread implements Node & RepositoryNode {
- """
- The comments that exist in this thread.
- """
- comments(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): CommitCommentConnection!
-
- """
- The commit the comments were made on.
- """
- commit: Commit!
- id: ID!
-
- """
- The file the comments were made on.
- """
- path: String
-
- """
- The position in the diff for the commit that the comment was made on.
- """
- position: Int
-
- """
- The repository associated with this node.
- """
- repository: Repository!
-}
-
-"""
-The connection type for Commit.
-"""
-type CommitConnection {
- """
- A list of edges.
- """
- edges: [CommitEdge]
-
- """
- A list of nodes.
- """
- nodes: [Commit]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-Ordering options for commit contribution connections.
-"""
-input CommitContributionOrder {
- """
- The ordering direction.
- """
- direction: OrderDirection!
-
- """
- The field by which to order commit contributions.
- """
- field: CommitContributionOrderField!
-}
-
-"""
-Properties by which commit contribution connections can be ordered.
-"""
-enum CommitContributionOrderField {
- """
- Order commit contributions by how many commits they represent.
- """
- COMMIT_COUNT
-
- """
- Order commit contributions by when they were made.
- """
- OCCURRED_AT
-}
-
-"""
-This aggregates commits made by a user within one repository.
-"""
-type CommitContributionsByRepository {
- """
- The commit contributions, each representing a day.
- """
- contributions(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for commit contributions returned from the connection.
- """
- orderBy: CommitContributionOrder = {field: OCCURRED_AT, direction: DESC}
- ): CreatedCommitContributionConnection!
-
- """
- The repository in which the commits were made.
- """
- repository: Repository!
-
- """
- The HTTP path for the user's commits to the repository in this time range.
- """
- resourcePath: URI!
-
- """
- The HTTP URL for the user's commits to the repository in this time range.
- """
- url: URI!
-}
-
-"""
-An edge in a connection.
-"""
-type CommitEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: Commit
-}
-
-"""
-The connection type for Commit.
-"""
-type CommitHistoryConnection {
- """
- A list of edges.
- """
- edges: [CommitEdge]
-
- """
- A list of nodes.
- """
- nodes: [Commit]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-A content attachment
-"""
-type ContentAttachment {
- """
- The body text of the content attachment. This parameter supports markdown.
- """
- body: String!
-
- """
- The content reference that the content attachment is attached to.
- """
- contentReference: ContentReference!
-
- """
- Identifies the primary key from the database.
- """
- databaseId: Int!
- id: ID!
-
- """
- The title of the content attachment.
- """
- title: String!
-}
-
-"""
-A content reference
-"""
-type ContentReference {
- """
- Identifies the primary key from the database.
- """
- databaseId: Int!
- id: ID!
-
- """
- The reference of the content reference.
- """
- reference: String!
-}
-
-"""
-Represents a contribution a user made on GitHub, such as opening an issue.
-"""
-interface Contribution {
- """
- Whether this contribution is associated with a record you do not have access to. For
- example, your own 'first issue' contribution may have been made on a repository you can no
- longer access.
- """
- isRestricted: Boolean!
-
- """
- When this contribution was made.
- """
- occurredAt: DateTime!
-
- """
- The HTTP path for this contribution.
- """
- resourcePath: URI!
-
- """
- The HTTP URL for this contribution.
- """
- url: URI!
-
- """
- The user who made this contribution.
- """
- user: User!
-}
-
-"""
-A calendar of contributions made on GitHub by a user.
-"""
-type ContributionCalendar {
- """
- A list of hex color codes used in this calendar. The darker the color, the more contributions it represents.
- """
- colors: [String!]!
-
- """
- Determine if the color set was chosen because it's currently Halloween.
- """
- isHalloween: Boolean!
-
- """
- A list of the months of contributions in this calendar.
- """
- months: [ContributionCalendarMonth!]!
-
- """
- The count of total contributions in the calendar.
- """
- totalContributions: Int!
-
- """
- A list of the weeks of contributions in this calendar.
- """
- weeks: [ContributionCalendarWeek!]!
-}
-
-"""
-Represents a single day of contributions on GitHub by a user.
-"""
-type ContributionCalendarDay {
- """
- The hex color code that represents how many contributions were made on this day compared to others in the calendar.
- """
- color: String!
-
- """
- How many contributions were made by the user on this day.
- """
- contributionCount: Int!
-
- """
- The day this square represents.
- """
- date: Date!
-
- """
- A number representing which day of the week this square represents, e.g., 1 is Monday.
- """
- weekday: Int!
-}
-
-"""
-A month of contributions in a user's contribution graph.
-"""
-type ContributionCalendarMonth {
- """
- The date of the first day of this month.
- """
- firstDay: Date!
-
- """
- The name of the month.
- """
- name: String!
-
- """
- How many weeks started in this month.
- """
- totalWeeks: Int!
-
- """
- The year the month occurred in.
- """
- year: Int!
-}
-
-"""
-A week of contributions in a user's contribution graph.
-"""
-type ContributionCalendarWeek {
- """
- The days of contributions in this week.
- """
- contributionDays: [ContributionCalendarDay!]!
-
- """
- The date of the earliest square in this week.
- """
- firstDay: Date!
-}
-
-"""
-Ordering options for contribution connections.
-"""
-input ContributionOrder {
- """
- The ordering direction.
- """
- direction: OrderDirection!
-
- """
- The field by which to order contributions.
- """
- field: ContributionOrderField!
-}
-
-"""
-Properties by which contribution connections can be ordered.
-"""
-enum ContributionOrderField {
- """
- Order contributions by when they were made.
- """
- OCCURRED_AT
-}
-
-"""
-A contributions collection aggregates contributions such as opened issues and commits created by a user.
-"""
-type ContributionsCollection {
- """
- Commit contributions made by the user, grouped by repository.
- """
- commitContributionsByRepository(
- """
- How many repositories should be included.
- """
- maxRepositories: Int = 25
- ): [CommitContributionsByRepository!]!
-
- """
- A calendar of this user's contributions on GitHub.
- """
- contributionCalendar: ContributionCalendar!
-
- """
- The years the user has been making contributions with the most recent year first.
- """
- contributionYears: [Int!]!
-
- """
- Determine if this collection's time span ends in the current month.
- """
- doesEndInCurrentMonth: Boolean!
-
- """
- The date of the first restricted contribution the user made in this time
- period. Can only be non-null when the user has enabled private contribution counts.
- """
- earliestRestrictedContributionDate: Date
-
- """
- The ending date and time of this collection.
- """
- endedAt: DateTime!
-
- """
- The first issue the user opened on GitHub. This will be null if that issue was
- opened outside the collection's time range and ignoreTimeRange is false. If
- the issue is not visible but the user has opted to show private contributions,
- a RestrictedContribution will be returned.
- """
- firstIssueContribution(
- """
- If true, the first issue will be returned even if it was opened outside of the collection's time range.
-
- **Upcoming Change on 2019-07-01 UTC**
- **Description:** `ignoreTimeRange` will be removed. Use a `ContributionsCollection` starting sufficiently far back
- **Reason:** ignore_time_range will be removed
- """
- ignoreTimeRange: Boolean = false
- ): CreatedIssueOrRestrictedContribution
-
- """
- The first pull request the user opened on GitHub. This will be null if that
- pull request was opened outside the collection's time range and
- ignoreTimeRange is not true. If the pull request is not visible but the user
- has opted to show private contributions, a RestrictedContribution will be returned.
- """
- firstPullRequestContribution(
- """
- If true, the first pull request will be returned even if it was opened outside of the collection's time range.
-
- **Upcoming Change on 2019-07-01 UTC**
- **Description:** `ignoreTimeRange` will be removed. Use a `ContributionsCollection` starting sufficiently far back
- **Reason:** ignore_time_range will be removed
- """
- ignoreTimeRange: Boolean = false
- ): CreatedPullRequestOrRestrictedContribution
-
- """
- The first repository the user created on GitHub. This will be null if that
- first repository was created outside the collection's time range and
- ignoreTimeRange is false. If the repository is not visible, then a
- RestrictedContribution is returned.
- """
- firstRepositoryContribution(
- """
- If true, the first repository will be returned even if it was opened outside of the collection's time range.
-
- **Upcoming Change on 2019-07-01 UTC**
- **Description:** `ignoreTimeRange` will be removed. Use a `ContributionsCollection` starting sufficiently far back
- **Reason:** ignore_time_range will be removed
- """
- ignoreTimeRange: Boolean = false
- ): CreatedRepositoryOrRestrictedContribution
-
- """
- Does the user have any more activity in the timeline that occurred prior to the collection's time range?
- """
- hasActivityInThePast: Boolean!
-
- """
- Determine if there are any contributions in this collection.
- """
- hasAnyContributions: Boolean!
-
- """
- Determine if the user made any contributions in this time frame whose details
- are not visible because they were made in a private repository. Can only be
- true if the user enabled private contribution counts.
- """
- hasAnyRestrictedContributions: Boolean!
-
- """
- Whether or not the collector's time span is all within the same day.
- """
- isSingleDay: Boolean!
-
- """
- A list of issues the user opened.
- """
- issueContributions(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Should the user's first issue ever be excluded from the result.
- """
- excludeFirst: Boolean = false
-
- """
- Should the user's most commented issue be excluded from the result.
- """
- excludePopular: Boolean = false
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for contributions returned from the connection.
- """
- orderBy: ContributionOrder = {field: OCCURRED_AT, direction: DESC}
- ): CreatedIssueContributionConnection!
-
- """
- Issue contributions made by the user, grouped by repository.
- """
- issueContributionsByRepository(
- """
- Should the user's first issue ever be excluded from the result.
- """
- excludeFirst: Boolean = false
-
- """
- Should the user's most commented issue be excluded from the result.
- """
- excludePopular: Boolean = false
-
- """
- How many repositories should be included.
- """
- maxRepositories: Int = 25
- ): [IssueContributionsByRepository!]!
-
- """
- When the user signed up for GitHub. This will be null if that sign up date
- falls outside the collection's time range and ignoreTimeRange is false.
- """
- joinedGitHubContribution(
- """
- If true, the contribution will be returned even if the user signed up outside of the collection's time range.
-
- **Upcoming Change on 2019-07-01 UTC**
- **Description:** `ignoreTimeRange` will be removed. Use a `ContributionsCollection` starting sufficiently far back
- **Reason:** ignore_time_range will be removed
- """
- ignoreTimeRange: Boolean = false
- ): JoinedGitHubContribution
-
- """
- The date of the most recent restricted contribution the user made in this time
- period. Can only be non-null when the user has enabled private contribution counts.
- """
- latestRestrictedContributionDate: Date
-
- """
- When this collection's time range does not include any activity from the user, use this
- to get a different collection from an earlier time range that does have activity.
- """
- mostRecentCollectionWithActivity: ContributionsCollection
-
- """
- Returns a different contributions collection from an earlier time range than this one
- that does not have any contributions.
- """
- mostRecentCollectionWithoutActivity: ContributionsCollection
-
- """
- The issue the user opened on GitHub that received the most comments in the specified
- time frame.
- """
- popularIssueContribution: CreatedIssueContribution
-
- """
- The pull request the user opened on GitHub that received the most comments in the
- specified time frame.
- """
- popularPullRequestContribution: CreatedPullRequestContribution
-
- """
- Pull request contributions made by the user.
- """
- pullRequestContributions(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Should the user's first pull request ever be excluded from the result.
- """
- excludeFirst: Boolean = false
-
- """
- Should the user's most commented pull request be excluded from the result.
- """
- excludePopular: Boolean = false
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for contributions returned from the connection.
- """
- orderBy: ContributionOrder = {field: OCCURRED_AT, direction: DESC}
- ): CreatedPullRequestContributionConnection!
-
- """
- Pull request contributions made by the user, grouped by repository.
- """
- pullRequestContributionsByRepository(
- """
- Should the user's first pull request ever be excluded from the result.
- """
- excludeFirst: Boolean = false
-
- """
- Should the user's most commented pull request be excluded from the result.
- """
- excludePopular: Boolean = false
-
- """
- How many repositories should be included.
- """
- maxRepositories: Int = 25
- ): [PullRequestContributionsByRepository!]!
-
- """
- Pull request review contributions made by the user.
- """
- pullRequestReviewContributions(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for contributions returned from the connection.
- """
- orderBy: ContributionOrder = {field: OCCURRED_AT, direction: DESC}
- ): CreatedPullRequestReviewContributionConnection!
-
- """
- Pull request review contributions made by the user, grouped by repository.
- """
- pullRequestReviewContributionsByRepository(
- """
- How many repositories should be included.
- """
- maxRepositories: Int = 25
- ): [PullRequestReviewContributionsByRepository!]!
-
- """
- A list of repositories owned by the user that the user created in this time range.
- """
- repositoryContributions(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Should the user's first repository ever be excluded from the result.
- """
- excludeFirst: Boolean = false
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for contributions returned from the connection.
- """
- orderBy: ContributionOrder = {field: OCCURRED_AT, direction: DESC}
- ): CreatedRepositoryContributionConnection!
-
- """
- A count of contributions made by the user that the viewer cannot access. Only
- non-zero when the user has chosen to share their private contribution counts.
- """
- restrictedContributionsCount: Int!
-
- """
- The beginning date and time of this collection.
- """
- startedAt: DateTime!
-
- """
- How many commits were made by the user in this time span.
- """
- totalCommitContributions: Int!
-
- """
- How many issues the user opened.
- """
- totalIssueContributions(
- """
- Should the user's first issue ever be excluded from this count.
- """
- excludeFirst: Boolean = false
-
- """
- Should the user's most commented issue be excluded from this count.
- """
- excludePopular: Boolean = false
- ): Int!
-
- """
- How many pull requests the user opened.
- """
- totalPullRequestContributions(
- """
- Should the user's first pull request ever be excluded from this count.
- """
- excludeFirst: Boolean = false
-
- """
- Should the user's most commented pull request be excluded from this count.
- """
- excludePopular: Boolean = false
- ): Int!
-
- """
- How many pull request reviews the user left.
- """
- totalPullRequestReviewContributions: Int!
-
- """
- How many different repositories the user committed to.
- """
- totalRepositoriesWithContributedCommits: Int!
-
- """
- How many different repositories the user opened issues in.
- """
- totalRepositoriesWithContributedIssues(
- """
- Should the user's first issue ever be excluded from this count.
- """
- excludeFirst: Boolean = false
-
- """
- Should the user's most commented issue be excluded from this count.
- """
- excludePopular: Boolean = false
- ): Int!
-
- """
- How many different repositories the user left pull request reviews in.
- """
- totalRepositoriesWithContributedPullRequestReviews: Int!
-
- """
- How many different repositories the user opened pull requests in.
- """
- totalRepositoriesWithContributedPullRequests(
- """
- Should the user's first pull request ever be excluded from this count.
- """
- excludeFirst: Boolean = false
-
- """
- Should the user's most commented pull request be excluded from this count.
- """
- excludePopular: Boolean = false
- ): Int!
-
- """
- How many repositories the user created.
- """
- totalRepositoryContributions(
- """
- Should the user's first repository ever be excluded from this count.
- """
- excludeFirst: Boolean = false
- ): Int!
-
- """
- The user who made the contributions in this collection.
- """
- user: User!
-}
-
-"""
-Autogenerated input type of ConvertProjectCardNoteToIssue
-"""
-input ConvertProjectCardNoteToIssueInput {
- """
- The body of the newly created issue.
- """
- body: String
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The ProjectCard ID to convert.
- """
- projectCardId: ID! @possibleTypes(concreteTypes: ["ProjectCard"])
-
- """
- The ID of the repository to create the issue in.
- """
- repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
-
- """
- The title of the newly created issue. Defaults to the card's note text.
- """
- title: String
-}
-
-"""
-Autogenerated return type of ConvertProjectCardNoteToIssue
-"""
-type ConvertProjectCardNoteToIssuePayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The updated ProjectCard.
- """
- projectCard: ProjectCard
-}
-
-"""
-Represents a 'converted_note_to_issue' event on a given issue or pull request.
-"""
-type ConvertedNoteToIssueEvent implements Node {
- """
- Identifies the actor who performed the event.
- """
- actor: Actor
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- Identifies the primary key from the database.
- """
- databaseId: Int
- id: ID!
-
- """
- Project referenced by event.
- """
- project: Project @preview(toggledBy: "starfox-preview")
-
- """
- Project card referenced by this project event.
- """
- projectCard: ProjectCard @preview(toggledBy: "starfox-preview")
-
- """
- Column name referenced by this project event.
- """
- projectColumnName: String! @preview(toggledBy: "starfox-preview")
-}
-
-"""
-Autogenerated input type of CreateBranchProtectionRule
-"""
-input CreateBranchProtectionRuleInput {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- Will new commits pushed to matching branches dismiss pull request review approvals.
- """
- dismissesStaleReviews: Boolean
-
- """
- Can admins overwrite branch protection.
- """
- isAdminEnforced: Boolean
-
- """
- The glob-like pattern used to determine matching branches.
- """
- pattern: String!
-
- """
- A list of User or Team IDs allowed to push to matching branches.
- """
- pushActorIds: [ID!]
-
- """
- The global relay id of the repository in which a new branch protection rule should be created in.
- """
- repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
-
- """
- Number of approving reviews required to update matching branches.
- """
- requiredApprovingReviewCount: Int
-
- """
- List of required status check contexts that must pass for commits to be accepted to matching branches.
- """
- requiredStatusCheckContexts: [String!]
-
- """
- Are approving reviews required to update matching branches.
- """
- requiresApprovingReviews: Boolean
-
- """
- Are reviews from code owners required to update matching branches.
- """
- requiresCodeOwnerReviews: Boolean
-
- """
- Are commits required to be signed.
- """
- requiresCommitSignatures: Boolean
-
- """
- Are status checks required to update matching branches.
- """
- requiresStatusChecks: Boolean
-
- """
- Are branches required to be up to date before merging.
- """
- requiresStrictStatusChecks: Boolean
-
- """
- Is pushing to matching branches restricted.
- """
- restrictsPushes: Boolean
-
- """
- Is dismissal of pull request reviews restricted.
- """
- restrictsReviewDismissals: Boolean
-
- """
- A list of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.
- """
- reviewDismissalActorIds: [ID!]
-}
-
-"""
-Autogenerated return type of CreateBranchProtectionRule
-"""
-type CreateBranchProtectionRulePayload {
- """
- The newly created BranchProtectionRule.
- """
- branchProtectionRule: BranchProtectionRule
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-}
-
-"""
-Autogenerated input type of CreateCheckRun
-"""
-input CreateCheckRunInput @preview(toggledBy: "antiope-preview") {
- """
- Possible further actions the integrator can perform, which a user may trigger.
- """
- actions: [CheckRunAction!]
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The time that the check run finished.
- """
- completedAt: DateTime
-
- """
- The final conclusion of the check.
- """
- conclusion: CheckConclusionState
-
- """
- The URL of the integrator's site that has the full details of the check.
- """
- detailsUrl: URI
-
- """
- A reference for the run on the integrator's system.
- """
- externalId: String
-
- """
- The SHA of the head commit.
- """
- headSha: GitObjectID!
-
- """
- The name of the check.
- """
- name: String!
-
- """
- Descriptive details about the run.
- """
- output: CheckRunOutput
-
- """
- The node ID of the repository.
- """
- repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
-
- """
- The time that the check run began.
- """
- startedAt: DateTime
-
- """
- The current status.
- """
- status: RequestableCheckStatusState
-}
-
-"""
-Autogenerated return type of CreateCheckRun
-"""
-type CreateCheckRunPayload @preview(toggledBy: "antiope-preview") {
- """
- The newly created check run.
- """
- checkRun: CheckRun
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-}
-
-"""
-Autogenerated input type of CreateCheckSuite
-"""
-input CreateCheckSuiteInput @preview(toggledBy: "antiope-preview") {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The SHA of the head commit.
- """
- headSha: GitObjectID!
-
- """
- The Node ID of the repository.
- """
- repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
-}
-
-"""
-Autogenerated return type of CreateCheckSuite
-"""
-type CreateCheckSuitePayload @preview(toggledBy: "antiope-preview") {
- """
- The newly created check suite.
- """
- checkSuite: CheckSuite
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-}
-
-"""
-Autogenerated input type of CreateContentAttachment
-"""
-input CreateContentAttachmentInput {
- """
- The body of the content attachment, which may contain markdown.
- """
- body: String!
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The node ID of the content_reference.
- """
- contentReferenceId: ID! @possibleTypes(concreteTypes: ["ContentReference"])
-
- """
- The title of the content attachment.
- """
- title: String!
-}
-
-"""
-Autogenerated return type of CreateContentAttachment
-"""
-type CreateContentAttachmentPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The newly created content attachment.
- """
- contentAttachment: ContentAttachment
-}
-
-"""
-Autogenerated input type of CreateDeployment
-"""
-input CreateDeploymentInput @preview(toggledBy: "flash-preview") {
- """
- Attempt to automatically merge the default branch into the requested ref, defaults to true.
- """
- autoMerge: Boolean = true
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- Short description of the deployment.
- """
- description: String = ""
-
- """
- Name for the target deployment environment.
- """
- environment: String = "production"
-
- """
- JSON payload with extra information about the deployment.
- """
- payload: String = "{}"
-
- """
- The node ID of the ref to be deployed.
- """
- refId: ID! @possibleTypes(concreteTypes: ["Ref"])
-
- """
- The node ID of the repository.
- """
- repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
-
- """
- The status contexts to verify against commit status checks. To bypass required
- contexts, pass an empty array. Defaults to all unique contexts.
- """
- requiredContexts: [String!]
-
- """
- Specifies a task to execute.
- """
- task: String = "deploy"
-}
-
-"""
-Autogenerated return type of CreateDeployment
-"""
-type CreateDeploymentPayload @preview(toggledBy: "flash-preview") {
- """
- True if the default branch has been auto-merged into the deployment ref.
- """
- autoMerged: Boolean
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The new deployment.
- """
- deployment: Deployment
-}
-
-"""
-Autogenerated input type of CreateDeploymentStatus
-"""
-input CreateDeploymentStatusInput @preview(toggledBy: "flash-preview") {
- """
- Adds a new inactive status to all non-transient, non-production environment
- deployments with the same repository and environment name as the created
- status's deployment.
- """
- autoInactive: Boolean = true
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The node ID of the deployment.
- """
- deploymentId: ID! @possibleTypes(concreteTypes: ["Deployment"])
-
- """
- A short description of the status. Maximum length of 140 characters.
- """
- description: String = ""
-
- """
- If provided, updates the environment of the deploy. Otherwise, does not modify the environment.
- """
- environment: String
-
- """
- Sets the URL for accessing your environment.
- """
- environmentUrl: String = ""
-
- """
- The log URL to associate with this status. This URL should contain
- output to keep the user updated while the task is running or serve as
- historical information for what happened in the deployment.
- """
- logUrl: String = ""
-
- """
- The state of the deployment.
- """
- state: DeploymentStatusState!
-}
-
-"""
-Autogenerated return type of CreateDeploymentStatus
-"""
-type CreateDeploymentStatusPayload @preview(toggledBy: "flash-preview") {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The new deployment status.
- """
- deploymentStatus: DeploymentStatus
-}
-
-"""
-Autogenerated input type of CreateIssue
-"""
-input CreateIssueInput {
- """
- The Node ID for the user assignee for this issue.
- """
- assigneeIds: [ID!] @possibleTypes(concreteTypes: ["User"])
-
- """
- The body for the issue description.
- """
- body: String
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- An array of Node IDs of labels for this issue.
- """
- labelIds: [ID!] @possibleTypes(concreteTypes: ["Label"])
-
- """
- The Node ID of the milestone for this issue.
- """
- milestoneId: ID @possibleTypes(concreteTypes: ["Milestone"])
-
- """
- An array of Node IDs for projects associated with this issue.
- """
- projectIds: [ID!] @possibleTypes(concreteTypes: ["Project"])
-
- """
- The Node ID of the repository.
- """
- repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
-
- """
- The title for the issue.
- """
- title: String!
-}
-
-"""
-Autogenerated return type of CreateIssue
-"""
-type CreateIssuePayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The new issue.
- """
- issue: Issue
-}
-
-"""
-Autogenerated input type of CreateLabel
-"""
-input CreateLabelInput @preview(toggledBy: "bane-preview") {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- A 6 character hex code, without the leading #, identifying the color of the label.
- """
- color: String!
-
- """
- The name of the label.
- """
- name: String!
-
- """
- The Node ID of the repository.
- """
- repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
-}
-
-"""
-Autogenerated return type of CreateLabel
-"""
-type CreateLabelPayload @preview(toggledBy: "bane-preview") {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The new label.
- """
- label: Label
-}
-
-"""
-Autogenerated input type of CreateProject
-"""
-input CreateProjectInput {
- """
- The description of project.
- """
- body: String
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The name of project.
- """
- name: String!
-
- """
- The owner ID to create the project under.
- """
- ownerId: ID! @possibleTypes(concreteTypes: ["Organization", "Repository", "User"], abstractType: "ProjectOwner")
-}
-
-"""
-Autogenerated return type of CreateProject
-"""
-type CreateProjectPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The new project.
- """
- project: Project
-}
-
-"""
-Autogenerated input type of CreatePullRequest
-"""
-input CreatePullRequestInput {
- """
- The name of the branch you want your changes pulled into. This should be an existing branch
- on the current repository. You cannot update the base branch on a pull request to point
- to another repository.
- """
- baseRefName: String!
-
- """
- The contents of the pull request.
- """
- body: String
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- Indicates whether this pull request should be a draft.
- """
- draft: Boolean = false @preview(toggledBy: "shadow-cat-preview")
-
- """
- The name of the branch where your changes are implemented. For cross-repository pull requests
- in the same network, namespace `head_ref_name` with a user like this: `username:branch`.
- """
- headRefName: String!
-
- """
- Indicates whether maintainers can modify the pull request.
- """
- maintainerCanModify: Boolean = true
-
- """
- The Node ID of the repository.
- """
- repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
-
- """
- The title of the pull request.
- """
- title: String!
-}
-
-"""
-Autogenerated return type of CreatePullRequest
-"""
-type CreatePullRequestPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The new pull request.
- """
- pullRequest: PullRequest
-}
-
-"""
-Autogenerated input type of CreateTeamDiscussionComment
-"""
-input CreateTeamDiscussionCommentInput @preview(toggledBy: "echo-preview") {
- """
- The content of the comment.
- """
- body: String!
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The ID of the discussion to which the comment belongs.
- """
- discussionId: ID! @possibleTypes(concreteTypes: ["TeamDiscussion"])
-}
-
-"""
-Autogenerated return type of CreateTeamDiscussionComment
-"""
-type CreateTeamDiscussionCommentPayload @preview(toggledBy: "echo-preview") {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The new comment.
- """
- teamDiscussionComment: TeamDiscussionComment
-}
-
-"""
-Autogenerated input type of CreateTeamDiscussion
-"""
-input CreateTeamDiscussionInput @preview(toggledBy: "echo-preview") {
- """
- The content of the discussion.
- """
- body: String!
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- If true, restricts the visiblity of this discussion to team members and
- organization admins. If false or not specified, allows any organization member
- to view this discussion.
- """
- private: Boolean
-
- """
- The ID of the team to which the discussion belongs.
- """
- teamId: ID! @possibleTypes(concreteTypes: ["Team"])
-
- """
- The title of the discussion.
- """
- title: String!
-}
-
-"""
-Autogenerated return type of CreateTeamDiscussion
-"""
-type CreateTeamDiscussionPayload @preview(toggledBy: "echo-preview") {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The new discussion.
- """
- teamDiscussion: TeamDiscussion
-}
-
-"""
-Represents the contribution a user made by committing to a repository.
-"""
-type CreatedCommitContribution implements Contribution {
- """
- How many commits were made on this day to this repository by the user.
- """
- commitCount: Int!
-
- """
- Whether this contribution is associated with a record you do not have access to. For
- example, your own 'first issue' contribution may have been made on a repository you can no
- longer access.
- """
- isRestricted: Boolean!
-
- """
- When this contribution was made.
- """
- occurredAt: DateTime!
-
- """
- The repository the user made a commit in.
- """
- repository: Repository!
-
- """
- The HTTP path for this contribution.
- """
- resourcePath: URI!
-
- """
- The HTTP URL for this contribution.
- """
- url: URI!
-
- """
- The user who made this contribution.
- """
- user: User!
-}
-
-"""
-The connection type for CreatedCommitContribution.
-"""
-type CreatedCommitContributionConnection {
- """
- A list of edges.
- """
- edges: [CreatedCommitContributionEdge]
-
- """
- A list of nodes.
- """
- nodes: [CreatedCommitContribution]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of commits across days and repositories in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type CreatedCommitContributionEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: CreatedCommitContribution
-}
-
-"""
-Represents the contribution a user made on GitHub by opening an issue.
-"""
-type CreatedIssueContribution implements Contribution {
- """
- Whether this contribution is associated with a record you do not have access to. For
- example, your own 'first issue' contribution may have been made on a repository you can no
- longer access.
- """
- isRestricted: Boolean!
-
- """
- The issue that was opened.
- """
- issue: Issue!
-
- """
- When this contribution was made.
- """
- occurredAt: DateTime!
-
- """
- The HTTP path for this contribution.
- """
- resourcePath: URI!
-
- """
- The HTTP URL for this contribution.
- """
- url: URI!
-
- """
- The user who made this contribution.
- """
- user: User!
-}
-
-"""
-The connection type for CreatedIssueContribution.
-"""
-type CreatedIssueContributionConnection {
- """
- A list of edges.
- """
- edges: [CreatedIssueContributionEdge]
-
- """
- A list of nodes.
- """
- nodes: [CreatedIssueContribution]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type CreatedIssueContributionEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: CreatedIssueContribution
-}
-
-"""
-Represents either a issue the viewer can access or a restricted contribution.
-"""
-union CreatedIssueOrRestrictedContribution = CreatedIssueContribution | RestrictedContribution
-
-"""
-Represents the contribution a user made on GitHub by opening a pull request.
-"""
-type CreatedPullRequestContribution implements Contribution {
- """
- Whether this contribution is associated with a record you do not have access to. For
- example, your own 'first issue' contribution may have been made on a repository you can no
- longer access.
- """
- isRestricted: Boolean!
-
- """
- When this contribution was made.
- """
- occurredAt: DateTime!
-
- """
- The pull request that was opened.
- """
- pullRequest: PullRequest!
-
- """
- The HTTP path for this contribution.
- """
- resourcePath: URI!
-
- """
- The HTTP URL for this contribution.
- """
- url: URI!
-
- """
- The user who made this contribution.
- """
- user: User!
-}
-
-"""
-The connection type for CreatedPullRequestContribution.
-"""
-type CreatedPullRequestContributionConnection {
- """
- A list of edges.
- """
- edges: [CreatedPullRequestContributionEdge]
-
- """
- A list of nodes.
- """
- nodes: [CreatedPullRequestContribution]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type CreatedPullRequestContributionEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: CreatedPullRequestContribution
-}
-
-"""
-Represents either a pull request the viewer can access or a restricted contribution.
-"""
-union CreatedPullRequestOrRestrictedContribution = CreatedPullRequestContribution | RestrictedContribution
-
-"""
-Represents the contribution a user made by leaving a review on a pull request.
-"""
-type CreatedPullRequestReviewContribution implements Contribution {
- """
- Whether this contribution is associated with a record you do not have access to. For
- example, your own 'first issue' contribution may have been made on a repository you can no
- longer access.
- """
- isRestricted: Boolean!
-
- """
- When this contribution was made.
- """
- occurredAt: DateTime!
-
- """
- The pull request the user reviewed.
- """
- pullRequest: PullRequest!
-
- """
- The review the user left on the pull request.
- """
- pullRequestReview: PullRequestReview!
-
- """
- The repository containing the pull request that the user reviewed.
- """
- repository: Repository!
-
- """
- The HTTP path for this contribution.
- """
- resourcePath: URI!
-
- """
- The HTTP URL for this contribution.
- """
- url: URI!
-
- """
- The user who made this contribution.
- """
- user: User!
-}
-
-"""
-The connection type for CreatedPullRequestReviewContribution.
-"""
-type CreatedPullRequestReviewContributionConnection {
- """
- A list of edges.
- """
- edges: [CreatedPullRequestReviewContributionEdge]
-
- """
- A list of nodes.
- """
- nodes: [CreatedPullRequestReviewContribution]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type CreatedPullRequestReviewContributionEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: CreatedPullRequestReviewContribution
-}
-
-"""
-Represents the contribution a user made on GitHub by creating a repository.
-"""
-type CreatedRepositoryContribution implements Contribution {
- """
- Whether this contribution is associated with a record you do not have access to. For
- example, your own 'first issue' contribution may have been made on a repository you can no
- longer access.
- """
- isRestricted: Boolean!
-
- """
- When this contribution was made.
- """
- occurredAt: DateTime!
-
- """
- The repository that was created.
- """
- repository: Repository!
-
- """
- The HTTP path for this contribution.
- """
- resourcePath: URI!
-
- """
- The HTTP URL for this contribution.
- """
- url: URI!
-
- """
- The user who made this contribution.
- """
- user: User!
-}
-
-"""
-The connection type for CreatedRepositoryContribution.
-"""
-type CreatedRepositoryContributionConnection {
- """
- A list of edges.
- """
- edges: [CreatedRepositoryContributionEdge]
-
- """
- A list of nodes.
- """
- nodes: [CreatedRepositoryContribution]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type CreatedRepositoryContributionEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: CreatedRepositoryContribution
-}
-
-"""
-Represents either a repository the viewer can access or a restricted contribution.
-"""
-union CreatedRepositoryOrRestrictedContribution = CreatedRepositoryContribution | RestrictedContribution
-
-"""
-Represents a mention made by one issue or pull request to another.
-"""
-type CrossReferencedEvent implements Node & UniformResourceLocatable {
- """
- Identifies the actor who performed the event.
- """
- actor: Actor
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
- id: ID!
-
- """
- Reference originated in a different repository.
- """
- isCrossRepository: Boolean!
-
- """
- Identifies when the reference was made.
- """
- referencedAt: DateTime!
-
- """
- The HTTP path for this pull request.
- """
- resourcePath: URI!
-
- """
- Issue or pull request that made the reference.
- """
- source: ReferencedSubject!
-
- """
- Issue or pull request to which the reference was made.
- """
- target: ReferencedSubject!
-
- """
- The HTTP URL for this pull request.
- """
- url: URI!
-
- """
- Checks if the target will be closed when the source is merged.
- """
- willCloseTarget: Boolean!
-}
-
-"""
-An ISO-8601 encoded date string.
-"""
-scalar Date
-
-"""
-An ISO-8601 encoded UTC date string.
-"""
-scalar DateTime
-
-"""
-The possible default permissions for repositories.
-"""
-enum DefaultRepositoryPermissionField {
- """
- Can read, write, and administrate repos by default
- """
- ADMIN
-
- """
- No access
- """
- NONE
-
- """
- Can read repos by default
- """
- READ
-
- """
- Can read and write repos by default
- """
- WRITE
-}
-
-"""
-Entities that can be deleted.
-"""
-interface Deletable {
- """
- Check if the current viewer can delete this object.
- """
- viewerCanDelete: Boolean!
-}
-
-"""
-Autogenerated input type of DeleteBranchProtectionRule
-"""
-input DeleteBranchProtectionRuleInput {
- """
- The global relay id of the branch protection rule to be deleted.
- """
- branchProtectionRuleId: ID! @possibleTypes(concreteTypes: ["BranchProtectionRule"])
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-}
-
-"""
-Autogenerated return type of DeleteBranchProtectionRule
-"""
-type DeleteBranchProtectionRulePayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-}
-
-"""
-Autogenerated input type of DeleteIssueComment
-"""
-input DeleteIssueCommentInput {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The ID of the comment to delete.
- """
- id: ID! @possibleTypes(concreteTypes: ["IssueComment"])
-}
-
-"""
-Autogenerated return type of DeleteIssueComment
-"""
-type DeleteIssueCommentPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-}
-
-"""
-Autogenerated input type of DeleteIssue
-"""
-input DeleteIssueInput {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The ID of the issue to delete.
- """
- issueId: ID! @possibleTypes(concreteTypes: ["Issue"])
-}
-
-"""
-Autogenerated return type of DeleteIssue
-"""
-type DeleteIssuePayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The repository the issue belonged to
- """
- repository: Repository
-}
-
-"""
-Autogenerated input type of DeleteLabel
-"""
-input DeleteLabelInput @preview(toggledBy: "bane-preview") {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The Node ID of the label to be deleted.
- """
- id: ID! @possibleTypes(concreteTypes: ["Label"])
-}
-
-"""
-Autogenerated return type of DeleteLabel
-"""
-type DeleteLabelPayload @preview(toggledBy: "bane-preview") {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-}
-
-"""
-Autogenerated input type of DeleteProjectCard
-"""
-input DeleteProjectCardInput {
- """
- The id of the card to delete.
- """
- cardId: ID! @possibleTypes(concreteTypes: ["ProjectCard"])
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-}
-
-"""
-Autogenerated return type of DeleteProjectCard
-"""
-type DeleteProjectCardPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The column the deleted card was in.
- """
- column: ProjectColumn
-
- """
- The deleted card ID.
- """
- deletedCardId: ID
-}
-
-"""
-Autogenerated input type of DeleteProjectColumn
-"""
-input DeleteProjectColumnInput {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The id of the column to delete.
- """
- columnId: ID! @possibleTypes(concreteTypes: ["ProjectColumn"])
-}
-
-"""
-Autogenerated return type of DeleteProjectColumn
-"""
-type DeleteProjectColumnPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The deleted column ID.
- """
- deletedColumnId: ID
-
- """
- The project the deleted column was in.
- """
- project: Project
-}
-
-"""
-Autogenerated input type of DeleteProject
-"""
-input DeleteProjectInput {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The Project ID to update.
- """
- projectId: ID! @possibleTypes(concreteTypes: ["Project"])
-}
-
-"""
-Autogenerated return type of DeleteProject
-"""
-type DeleteProjectPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The repository or organization the project was removed from.
- """
- owner: ProjectOwner
-}
-
-"""
-Autogenerated input type of DeletePullRequestReviewComment
-"""
-input DeletePullRequestReviewCommentInput {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The ID of the comment to delete.
- """
- id: ID! @possibleTypes(concreteTypes: ["PullRequestReviewComment"])
-}
-
-"""
-Autogenerated return type of DeletePullRequestReviewComment
-"""
-type DeletePullRequestReviewCommentPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The pull request review the deleted comment belonged to.
- """
- pullRequestReview: PullRequestReview
-}
-
-"""
-Autogenerated input type of DeletePullRequestReview
-"""
-input DeletePullRequestReviewInput {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The Node ID of the pull request review to delete.
- """
- pullRequestReviewId: ID! @possibleTypes(concreteTypes: ["PullRequestReview"])
-}
-
-"""
-Autogenerated return type of DeletePullRequestReview
-"""
-type DeletePullRequestReviewPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The deleted pull request review.
- """
- pullRequestReview: PullRequestReview
-}
-
-"""
-Autogenerated input type of DeleteTeamDiscussionComment
-"""
-input DeleteTeamDiscussionCommentInput @preview(toggledBy: "echo-preview") {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The ID of the comment to delete.
- """
- id: ID! @possibleTypes(concreteTypes: ["TeamDiscussionComment"])
-}
-
-"""
-Autogenerated return type of DeleteTeamDiscussionComment
-"""
-type DeleteTeamDiscussionCommentPayload @preview(toggledBy: "echo-preview") {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-}
-
-"""
-Autogenerated input type of DeleteTeamDiscussion
-"""
-input DeleteTeamDiscussionInput @preview(toggledBy: "echo-preview") {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The discussion ID to delete.
- """
- id: ID! @possibleTypes(concreteTypes: ["TeamDiscussion"])
-}
-
-"""
-Autogenerated return type of DeleteTeamDiscussion
-"""
-type DeleteTeamDiscussionPayload @preview(toggledBy: "echo-preview") {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-}
-
-"""
-Represents a 'demilestoned' event on a given issue or pull request.
-"""
-type DemilestonedEvent implements Node {
- """
- Identifies the actor who performed the event.
- """
- actor: Actor
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
- id: ID!
-
- """
- Identifies the milestone title associated with the 'demilestoned' event.
- """
- milestoneTitle: String!
-
- """
- Object referenced by event.
- """
- subject: MilestoneItem!
-}
-
-"""
-A repository deploy key.
-"""
-type DeployKey implements Node {
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
- id: ID!
-
- """
- The deploy key.
- """
- key: String!
-
- """
- Whether or not the deploy key is read only.
- """
- readOnly: Boolean!
-
- """
- The deploy key title.
- """
- title: String!
-
- """
- Whether or not the deploy key has been verified.
- """
- verified: Boolean!
-}
-
-"""
-The connection type for DeployKey.
-"""
-type DeployKeyConnection {
- """
- A list of edges.
- """
- edges: [DeployKeyEdge]
-
- """
- A list of nodes.
- """
- nodes: [DeployKey]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type DeployKeyEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: DeployKey
-}
-
-"""
-Represents a 'deployed' event on a given pull request.
-"""
-type DeployedEvent implements Node {
- """
- Identifies the actor who performed the event.
- """
- actor: Actor
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- Identifies the primary key from the database.
- """
- databaseId: Int
-
- """
- The deployment associated with the 'deployed' event.
- """
- deployment: Deployment!
- id: ID!
-
- """
- PullRequest referenced by event.
- """
- pullRequest: PullRequest!
-
- """
- The ref associated with the 'deployed' event.
- """
- ref: Ref
-}
-
-"""
-Represents triggered deployment instance.
-"""
-type Deployment implements Node {
- """
- Identifies the commit sha of the deployment.
- """
- commit: Commit
-
- """
- Identifies the oid of the deployment commit, even if the commit has been deleted.
- """
- commitOid: String!
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- Identifies the actor who triggered the deployment.
- """
- creator: Actor
-
- """
- Identifies the primary key from the database.
- """
- databaseId: Int
-
- """
- The deployment description.
- """
- description: String
-
- """
- The environment to which this deployment was made.
- """
- environment: String
- id: ID!
-
- """
- The latest status of this deployment.
- """
- latestStatus: DeploymentStatus
-
- """
- Extra information that a deployment system might need.
- """
- payload: String
-
- """
- Identifies the Ref of the deployment, if the deployment was created by ref.
- """
- ref: Ref
-
- """
- Identifies the repository associated with the deployment.
- """
- repository: Repository!
-
- """
- The current state of the deployment.
- """
- state: DeploymentState
-
- """
- A list of statuses associated with the deployment.
- """
- statuses(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): DeploymentStatusConnection
-
- """
- The deployment task.
- """
- task: String
-
- """
- Identifies the date and time when the object was last updated.
- """
- updatedAt: DateTime!
-}
-
-"""
-The connection type for Deployment.
-"""
-type DeploymentConnection {
- """
- A list of edges.
- """
- edges: [DeploymentEdge]
-
- """
- A list of nodes.
- """
- nodes: [Deployment]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type DeploymentEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: Deployment
-}
-
-"""
-Represents a 'deployment_environment_changed' event on a given pull request.
-"""
-type DeploymentEnvironmentChangedEvent implements Node {
- """
- Identifies the actor who performed the event.
- """
- actor: Actor
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- The deployment status that updated the deployment environment.
- """
- deploymentStatus: DeploymentStatus!
- id: ID!
-
- """
- PullRequest referenced by event.
- """
- pullRequest: PullRequest!
-}
-
-"""
-Ordering options for deployment connections
-"""
-input DeploymentOrder {
- """
- The ordering direction.
- """
- direction: OrderDirection!
-
- """
- The field to order deployments by.
- """
- field: DeploymentOrderField!
-}
-
-"""
-Properties by which deployment connections can be ordered.
-"""
-enum DeploymentOrderField {
- """
- Order collection by creation time
- """
- CREATED_AT
-}
-
-"""
-The possible states in which a deployment can be.
-"""
-enum DeploymentState {
- """
- The pending deployment was not updated after 30 minutes.
- """
- ABANDONED
-
- """
- The deployment is currently active.
- """
- ACTIVE
-
- """
- An inactive transient deployment.
- """
- DESTROYED
-
- """
- The deployment experienced an error.
- """
- ERROR
-
- """
- The deployment has failed.
- """
- FAILURE
-
- """
- The deployment is inactive.
- """
- INACTIVE
-
- """
- The deployment is in progress.
- """
- IN_PROGRESS
-
- """
- The deployment is pending.
- """
- PENDING
-
- """
- The deployment has queued
- """
- QUEUED
-}
-
-"""
-Describes the status of a given deployment attempt.
-"""
-type DeploymentStatus implements Node {
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- Identifies the actor who triggered the deployment.
- """
- creator: Actor
-
- """
- Identifies the deployment associated with status.
- """
- deployment: Deployment!
-
- """
- Identifies the description of the deployment.
- """
- description: String
-
- """
- Identifies the environment of the deployment at the time of this deployment status
- """
- environment: String @preview(toggledBy: "flash-preview")
-
- """
- Identifies the environment URL of the deployment.
- """
- environmentUrl: URI
- id: ID!
-
- """
- Identifies the log URL of the deployment.
- """
- logUrl: URI
-
- """
- Identifies the current state of the deployment.
- """
- state: DeploymentStatusState!
-
- """
- Identifies the date and time when the object was last updated.
- """
- updatedAt: DateTime!
-}
-
-"""
-The connection type for DeploymentStatus.
-"""
-type DeploymentStatusConnection {
- """
- A list of edges.
- """
- edges: [DeploymentStatusEdge]
-
- """
- A list of nodes.
- """
- nodes: [DeploymentStatus]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type DeploymentStatusEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: DeploymentStatus
-}
-
-"""
-The possible states for a deployment status.
-"""
-enum DeploymentStatusState {
- """
- The deployment experienced an error.
- """
- ERROR
-
- """
- The deployment has failed.
- """
- FAILURE
-
- """
- The deployment is inactive.
- """
- INACTIVE
-
- """
- The deployment is in progress.
- """
- IN_PROGRESS
-
- """
- The deployment is pending.
- """
- PENDING
-
- """
- The deployment is queued
- """
- QUEUED
-
- """
- The deployment was successful.
- """
- SUCCESS
-}
-
-"""
-Autogenerated input type of DismissPullRequestReview
-"""
-input DismissPullRequestReviewInput {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The contents of the pull request review dismissal message.
- """
- message: String!
-
- """
- The Node ID of the pull request review to modify.
- """
- pullRequestReviewId: ID! @possibleTypes(concreteTypes: ["PullRequestReview"])
-}
-
-"""
-Autogenerated return type of DismissPullRequestReview
-"""
-type DismissPullRequestReviewPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The dismissed pull request review.
- """
- pullRequestReview: PullRequestReview
-}
-
-"""
-Specifies a review comment to be left with a Pull Request Review.
-"""
-input DraftPullRequestReviewComment {
- """
- Body of the comment to leave.
- """
- body: String!
-
- """
- Path to the file being commented on.
- """
- path: String!
-
- """
- Position in the file to leave a comment on.
- """
- position: Int!
-}
-
-"""
-An external identity provisioned by SAML SSO or SCIM.
-"""
-type ExternalIdentity implements Node {
- """
- The GUID for this identity
- """
- guid: String!
- id: ID!
-
- """
- Organization invitation for this SCIM-provisioned external identity
- """
- organizationInvitation: OrganizationInvitation
-
- """
- SAML Identity attributes
- """
- samlIdentity: ExternalIdentitySamlAttributes
-
- """
- SCIM Identity attributes
- """
- scimIdentity: ExternalIdentityScimAttributes
-
- """
- User linked to this external identity. Will be NULL if this identity has not been claimed by an organization member.
- """
- user: User
-}
-
-"""
-The connection type for ExternalIdentity.
-"""
-type ExternalIdentityConnection {
- """
- A list of edges.
- """
- edges: [ExternalIdentityEdge]
-
- """
- A list of nodes.
- """
- nodes: [ExternalIdentity]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type ExternalIdentityEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: ExternalIdentity
-}
-
-"""
-SAML attributes for the External Identity
-"""
-type ExternalIdentitySamlAttributes {
- """
- The NameID of the SAML identity
- """
- nameId: String
-}
-
-"""
-SCIM attributes for the External Identity
-"""
-type ExternalIdentityScimAttributes {
- """
- The userName of the SCIM identity
- """
- username: String
-}
-
-"""
-The connection type for User.
-"""
-type FollowerConnection {
- """
- A list of edges.
- """
- edges: [UserEdge]
-
- """
- A list of nodes.
- """
- nodes: [User]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-The connection type for User.
-"""
-type FollowingConnection {
- """
- A list of edges.
- """
- edges: [UserEdge]
-
- """
- A list of nodes.
- """
- nodes: [User]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-A generic hovercard context with a message and icon
-"""
-type GenericHovercardContext implements HovercardContext @preview(toggledBy: "hagar-preview") {
- """
- A string describing this context
- """
- message: String!
-
- """
- An octicon to accompany this context
- """
- octicon: String!
-}
-
-"""
-A Gist.
-"""
-type Gist implements Node & Starrable {
- """
- A list of comments associated with the gist
- """
- comments(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): GistCommentConnection!
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- The gist description.
- """
- description: String
-
- """
- The files in this gist.
- """
- files(
- """
- The maximum number of files to return.
- """
- limit: Int = 10
- ): [GistFile]
- id: ID!
-
- """
- Identifies if the gist is a fork.
- """
- isFork: Boolean!
-
- """
- Whether the gist is public or not.
- """
- isPublic: Boolean!
-
- """
- The gist name.
- """
- name: String!
-
- """
- The gist owner.
- """
- owner: RepositoryOwner
-
- """
- Identifies when the gist was last pushed to.
- """
- pushedAt: DateTime
-
- """
- A list of users who have starred this starrable.
- """
- stargazers(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Order for connection
- """
- orderBy: StarOrder
- ): StargazerConnection!
-
- """
- Identifies the date and time when the object was last updated.
- """
- updatedAt: DateTime!
-
- """
- Returns a boolean indicating whether the viewing user has starred this starrable.
- """
- viewerHasStarred: Boolean!
-}
-
-"""
-Represents a comment on an Gist.
-"""
-type GistComment implements Comment & Deletable & Minimizable & Node & Updatable & UpdatableComment {
- """
- The actor who authored the comment.
- """
- author: Actor
-
- """
- Author's association with the gist.
- """
- authorAssociation: CommentAuthorAssociation!
-
- """
- Identifies the comment body.
- """
- body: String!
-
- """
- The comment body rendered to HTML.
- """
- bodyHTML: HTML!
-
- """
- The body rendered to text.
- """
- bodyText: String!
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- Check if this comment was created via an email reply.
- """
- createdViaEmail: Boolean!
-
- """
- Identifies the primary key from the database.
- """
- databaseId: Int
-
- """
- The actor who edited the comment.
- """
- editor: Actor
-
- """
- The associated gist.
- """
- gist: Gist!
- id: ID!
-
- """
- Check if this comment was edited and includes an edit with the creation data
- """
- includesCreatedEdit: Boolean!
-
- """
- Returns whether or not a comment has been minimized.
- """
- isMinimized: Boolean!
-
- """
- The moment the editor made the last edit
- """
- lastEditedAt: DateTime
-
- """
- Returns why the comment was minimized.
- """
- minimizedReason: String
-
- """
- Identifies when the comment was published at.
- """
- publishedAt: DateTime
-
- """
- Identifies the date and time when the object was last updated.
- """
- updatedAt: DateTime!
-
- """
- A list of edits to this content.
- """
- userContentEdits(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): UserContentEditConnection
-
- """
- Check if the current viewer can delete this object.
- """
- viewerCanDelete: Boolean!
-
- """
- Check if the current viewer can minimize this object.
- """
- viewerCanMinimize: Boolean!
-
- """
- Check if the current viewer can update this object.
- """
- viewerCanUpdate: Boolean!
-
- """
- Reasons why the current viewer can not update this comment.
- """
- viewerCannotUpdateReasons: [CommentCannotUpdateReason!]!
-
- """
- Did the viewer author this comment.
- """
- viewerDidAuthor: Boolean!
-}
-
-"""
-The connection type for GistComment.
-"""
-type GistCommentConnection {
- """
- A list of edges.
- """
- edges: [GistCommentEdge]
-
- """
- A list of nodes.
- """
- nodes: [GistComment]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type GistCommentEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: GistComment
-}
-
-"""
-The connection type for Gist.
-"""
-type GistConnection {
- """
- A list of edges.
- """
- edges: [GistEdge]
-
- """
- A list of nodes.
- """
- nodes: [Gist]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type GistEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: Gist
-}
-
-"""
-A file in a gist.
-"""
-type GistFile {
- """
- The file name encoded to remove characters that are invalid in URL paths.
- """
- encodedName: String
-
- """
- The gist file encoding.
- """
- encoding: String
-
- """
- The file extension from the file name.
- """
- extension: String
-
- """
- Indicates if this file is an image.
- """
- isImage: Boolean!
-
- """
- Whether the file's contents were truncated.
- """
- isTruncated: Boolean!
-
- """
- The programming language this file is written in.
- """
- language: Language
-
- """
- The gist file name.
- """
- name: String
-
- """
- The gist file size in bytes.
- """
- size: Int
-
- """
- UTF8 text data or null if the file is binary
- """
- text(
- """
- Optionally truncate the returned file to this length.
- """
- truncate: Int
- ): String
-}
-
-"""
-Ordering options for gist connections
-"""
-input GistOrder {
- """
- The ordering direction.
- """
- direction: OrderDirection!
-
- """
- The field to order repositories by.
- """
- field: GistOrderField!
-}
-
-"""
-Properties by which gist connections can be ordered.
-"""
-enum GistOrderField {
- """
- Order gists by creation time
- """
- CREATED_AT
-
- """
- Order gists by push time
- """
- PUSHED_AT
-
- """
- Order gists by update time
- """
- UPDATED_AT
-}
-
-"""
-The privacy of a Gist
-"""
-enum GistPrivacy {
- """
- Gists that are public and secret
- """
- ALL
-
- """
- Public
- """
- PUBLIC
-
- """
- Secret
- """
- SECRET
-}
-
-"""
-Represents an actor in a Git commit (ie. an author or committer).
-"""
-type GitActor {
- """
- A URL pointing to the author's public avatar.
- """
- avatarUrl(
- """
- The size of the resulting square image.
- """
- size: Int
- ): URI!
-
- """
- The timestamp of the Git action (authoring or committing).
- """
- date: GitTimestamp
-
- """
- The email in the Git commit.
- """
- email: String
-
- """
- The name in the Git commit.
- """
- name: String
-
- """
- The GitHub user corresponding to the email field. Null if no such user exists.
- """
- user: User
-}
-
-"""
-Represents information about the GitHub instance.
-"""
-type GitHubMetadata {
- """
- Returns a String that's a SHA of `github-services`
- """
- gitHubServicesSha: GitObjectID!
-
- """
- Whether or not users are verified
- """
- isPasswordAuthenticationVerifiable: Boolean!
-}
-
-"""
-Represents a Git object.
-"""
-interface GitObject {
- """
- An abbreviated version of the Git object ID
- """
- abbreviatedOid: String!
-
- """
- The HTTP path for this Git object
- """
- commitResourcePath: URI!
-
- """
- The HTTP URL for this Git object
- """
- commitUrl: URI!
- id: ID!
-
- """
- The Git object ID
- """
- oid: GitObjectID!
-
- """
- The Repository the Git object belongs to
- """
- repository: Repository!
-}
-
-"""
-A Git object ID.
-"""
-scalar GitObjectID
-
-"""
-Git SSH string
-"""
-scalar GitSSHRemote
-
-"""
-Information about a signature (GPG or S/MIME) on a Commit or Tag.
-"""
-interface GitSignature {
- """
- Email used to sign this object.
- """
- email: String!
-
- """
- True if the signature is valid and verified by GitHub.
- """
- isValid: Boolean!
-
- """
- Payload for GPG signing object. Raw ODB object without the signature header.
- """
- payload: String!
-
- """
- ASCII-armored signature header from object.
- """
- signature: String!
-
- """
- GitHub user corresponding to the email signing this commit.
- """
- signer: User
-
- """
- The state of this signature. `VALID` if signature is valid and verified by
- GitHub, otherwise represents reason why signature is considered invalid.
- """
- state: GitSignatureState!
-
- """
- True if the signature was made with GitHub's signing key.
- """
- wasSignedByGitHub: Boolean!
-}
-
-"""
-The state of a Git signature.
-"""
-enum GitSignatureState {
- """
- The signing certificate or its chain could not be verified
- """
- BAD_CERT
-
- """
- Invalid email used for signing
- """
- BAD_EMAIL
-
- """
- Signing key expired
- """
- EXPIRED_KEY
-
- """
- Internal error - the GPG verification service misbehaved
- """
- GPGVERIFY_ERROR
-
- """
- Internal error - the GPG verification service is unavailable at the moment
- """
- GPGVERIFY_UNAVAILABLE
-
- """
- Invalid signature
- """
- INVALID
-
- """
- Malformed signature
- """
- MALFORMED_SIG
-
- """
- The usage flags for the key that signed this don't allow signing
- """
- NOT_SIGNING_KEY
-
- """
- Email used for signing not known to GitHub
- """
- NO_USER
-
- """
- Valid siganture, though certificate revocation check failed
- """
- OCSP_ERROR
-
- """
- Valid signature, pending certificate revocation checking
- """
- OCSP_PENDING
-
- """
- One or more certificates in chain has been revoked
- """
- OCSP_REVOKED
-
- """
- Key used for signing not known to GitHub
- """
- UNKNOWN_KEY
-
- """
- Unknown signature type
- """
- UNKNOWN_SIG_TYPE
-
- """
- Unsigned
- """
- UNSIGNED
-
- """
- Email used for signing unverified on GitHub
- """
- UNVERIFIED_EMAIL
-
- """
- Valid signature and verified by GitHub
- """
- VALID
-}
-
-"""
-An ISO-8601 encoded date string. Unlike the DateTime type, GitTimestamp is not converted in UTC.
-"""
-scalar GitTimestamp
-
-"""
-Represents a GPG signature on a Commit or Tag.
-"""
-type GpgSignature implements GitSignature {
- """
- Email used to sign this object.
- """
- email: String!
-
- """
- True if the signature is valid and verified by GitHub.
- """
- isValid: Boolean!
-
- """
- Hex-encoded ID of the key that signed this object.
- """
- keyId: String
-
- """
- Payload for GPG signing object. Raw ODB object without the signature header.
- """
- payload: String!
-
- """
- ASCII-armored signature header from object.
- """
- signature: String!
-
- """
- GitHub user corresponding to the email signing this commit.
- """
- signer: User
-
- """
- The state of this signature. `VALID` if signature is valid and verified by
- GitHub, otherwise represents reason why signature is considered invalid.
- """
- state: GitSignatureState!
-
- """
- True if the signature was made with GitHub's signing key.
- """
- wasSignedByGitHub: Boolean!
-}
-
-"""
-A string containing HTML code.
-"""
-scalar HTML
-
-"""
-Represents a 'head_ref_deleted' event on a given pull request.
-"""
-type HeadRefDeletedEvent implements Node {
- """
- Identifies the actor who performed the event.
- """
- actor: Actor
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- Identifies the Ref associated with the `head_ref_deleted` event.
- """
- headRef: Ref
-
- """
- Identifies the name of the Ref associated with the `head_ref_deleted` event.
- """
- headRefName: String!
- id: ID!
-
- """
- PullRequest referenced by event.
- """
- pullRequest: PullRequest!
-}
-
-"""
-Represents a 'head_ref_force_pushed' event on a given pull request.
-"""
-type HeadRefForcePushedEvent implements Node {
- """
- Identifies the actor who performed the event.
- """
- actor: Actor
-
- """
- Identifies the after commit SHA for the 'head_ref_force_pushed' event.
- """
- afterCommit: Commit
-
- """
- Identifies the before commit SHA for the 'head_ref_force_pushed' event.
- """
- beforeCommit: Commit
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
- id: ID!
-
- """
- PullRequest referenced by event.
- """
- pullRequest: PullRequest!
-
- """
- Identifies the fully qualified ref name for the 'head_ref_force_pushed' event.
- """
- ref: Ref
-}
-
-"""
-Represents a 'head_ref_restored' event on a given pull request.
-"""
-type HeadRefRestoredEvent implements Node {
- """
- Identifies the actor who performed the event.
- """
- actor: Actor
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
- id: ID!
-
- """
- PullRequest referenced by event.
- """
- pullRequest: PullRequest!
-}
-
-"""
-Detail needed to display a hovercard for a user
-"""
-type Hovercard @preview(toggledBy: "hagar-preview") {
- """
- Each of the contexts for this hovercard
- """
- contexts: [HovercardContext!]!
-}
-
-"""
-An individual line of a hovercard
-"""
-interface HovercardContext @preview(toggledBy: "hagar-preview") {
- """
- A string describing this context
- """
- message: String!
-
- """
- An octicon to accompany this context
- """
- octicon: String!
-}
-
-"""
-Autogenerated input type of ImportProject
-"""
-input ImportProjectInput {
- """
- The description of Project.
- """
- body: String
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- A list of columns containing issues and pull requests.
- """
- columnImports: [ProjectColumnImport!]!
-
- """
- The name of Project.
- """
- name: String!
-
- """
- The name of the Organization or User to create the Project under.
- """
- ownerName: String!
-
- """
- Whether the Project is public or not.
- """
- public: Boolean = false
-}
-
-"""
-Autogenerated return type of ImportProject
-"""
-type ImportProjectPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The new Project!
- """
- project: Project
-}
-
-"""
-An Issue is a place to discuss ideas, enhancements, tasks, and bugs for a project.
-"""
-type Issue implements Assignable & Closable & Comment & Labelable & Lockable & Node & Reactable & RepositoryNode & Subscribable & UniformResourceLocatable & Updatable & UpdatableComment {
- """
- Reason that the conversation was locked.
- """
- activeLockReason: LockReason
-
- """
- A list of Users assigned to this object.
- """
- assignees(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): UserConnection!
-
- """
- The actor who authored the comment.
- """
- author: Actor
-
- """
- Author's association with the subject of the comment.
- """
- authorAssociation: CommentAuthorAssociation!
-
- """
- Identifies the body of the issue.
- """
- body: String!
-
- """
- Identifies the body of the issue rendered to HTML.
- """
- bodyHTML: HTML!
-
- """
- Identifies the body of the issue rendered to text.
- """
- bodyText: String!
-
- """
- `true` if the object is closed (definition of closed may depend on type)
- """
- closed: Boolean!
-
- """
- Identifies the date and time when the object was closed.
- """
- closedAt: DateTime
-
- """
- A list of comments associated with the Issue.
- """
- comments(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): IssueCommentConnection!
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- Check if this comment was created via an email reply.
- """
- createdViaEmail: Boolean!
-
- """
- Identifies the primary key from the database.
- """
- databaseId: Int
-
- """
- The actor who edited the comment.
- """
- editor: Actor
-
- """
- The hovercard information for this issue
- """
- hovercard(
- """
- Whether or not to include notification contexts
- """
- includeNotificationContexts: Boolean = true
- ): Hovercard! @preview(toggledBy: "hagar-preview")
- id: ID!
-
- """
- Check if this comment was edited and includes an edit with the creation data
- """
- includesCreatedEdit: Boolean!
-
- """
- A list of labels associated with the object.
- """
- labels(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): LabelConnection
-
- """
- The moment the editor made the last edit
- """
- lastEditedAt: DateTime
-
- """
- `true` if the object is locked
- """
- locked: Boolean!
-
- """
- Identifies the milestone associated with the issue.
- """
- milestone: Milestone
-
- """
- Identifies the issue number.
- """
- number: Int!
-
- """
- A list of Users that are participating in the Issue conversation.
- """
- participants(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): UserConnection!
-
- """
- List of project cards associated with this issue.
- """
- projectCards(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- A list of archived states to filter the cards by
- """
- archivedStates: [ProjectCardArchivedState] = [ARCHIVED, NOT_ARCHIVED]
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): ProjectCardConnection!
-
- """
- Identifies when the comment was published at.
- """
- publishedAt: DateTime
-
- """
- A list of reactions grouped by content left on the subject.
- """
- reactionGroups: [ReactionGroup!]
-
- """
- A list of Reactions left on the Issue.
- """
- reactions(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Allows filtering Reactions by emoji.
- """
- content: ReactionContent
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Allows specifying the order in which reactions are returned.
- """
- orderBy: ReactionOrder
- ): ReactionConnection!
-
- """
- The repository associated with this node.
- """
- repository: Repository!
-
- """
- The HTTP path for this issue
- """
- resourcePath: URI!
-
- """
- Identifies the state of the issue.
- """
- state: IssueState!
-
- """
- A list of events, comments, commits, etc. associated with the issue.
- """
- timeline(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Allows filtering timeline events by a `since` timestamp.
- """
- since: DateTime
- ): IssueTimelineConnection!
-
- """
- A list of events, comments, commits, etc. associated with the issue.
- """
- timelineItems(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Filter timeline items by type.
- """
- itemTypes: [IssueTimelineItemsItemType!]
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Filter timeline items by a `since` timestamp.
- """
- since: DateTime
-
- """
- Skips the first _n_ elements in the list.
- """
- skip: Int
- ): IssueTimelineItemsConnection!
-
- """
- Identifies the issue title.
- """
- title: String!
-
- """
- Identifies the date and time when the object was last updated.
- """
- updatedAt: DateTime!
-
- """
- The HTTP URL for this issue
- """
- url: URI!
-
- """
- A list of edits to this content.
- """
- userContentEdits(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): UserContentEditConnection
-
- """
- Can user react to this subject
- """
- viewerCanReact: Boolean!
-
- """
- Check if the viewer is able to change their subscription status for the repository.
- """
- viewerCanSubscribe: Boolean!
-
- """
- Check if the current viewer can update this object.
- """
- viewerCanUpdate: Boolean!
-
- """
- Reasons why the current viewer can not update this comment.
- """
- viewerCannotUpdateReasons: [CommentCannotUpdateReason!]!
-
- """
- Did the viewer author this comment.
- """
- viewerDidAuthor: Boolean!
-
- """
- Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
- """
- viewerSubscription: SubscriptionState
-}
-
-"""
-Represents a comment on an Issue.
-"""
-type IssueComment implements Comment & Deletable & Minimizable & Node & Reactable & RepositoryNode & Updatable & UpdatableComment {
- """
- The actor who authored the comment.
- """
- author: Actor
-
- """
- Author's association with the subject of the comment.
- """
- authorAssociation: CommentAuthorAssociation!
-
- """
- The body as Markdown.
- """
- body: String!
-
- """
- The body rendered to HTML.
- """
- bodyHTML: HTML!
-
- """
- The body rendered to text.
- """
- bodyText: String!
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- Check if this comment was created via an email reply.
- """
- createdViaEmail: Boolean!
-
- """
- Identifies the primary key from the database.
- """
- databaseId: Int
-
- """
- The actor who edited the comment.
- """
- editor: Actor
- id: ID!
-
- """
- Check if this comment was edited and includes an edit with the creation data
- """
- includesCreatedEdit: Boolean!
-
- """
- Returns whether or not a comment has been minimized.
- """
- isMinimized: Boolean!
-
- """
- Identifies the issue associated with the comment.
- """
- issue: Issue!
-
- """
- The moment the editor made the last edit
- """
- lastEditedAt: DateTime
-
- """
- Returns why the comment was minimized.
- """
- minimizedReason: String
-
- """
- Identifies when the comment was published at.
- """
- publishedAt: DateTime
-
- """
- Returns the pull request associated with the comment, if this comment was made on a
- pull request.
- """
- pullRequest: PullRequest
-
- """
- A list of reactions grouped by content left on the subject.
- """
- reactionGroups: [ReactionGroup!]
-
- """
- A list of Reactions left on the Issue.
- """
- reactions(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Allows filtering Reactions by emoji.
- """
- content: ReactionContent
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Allows specifying the order in which reactions are returned.
- """
- orderBy: ReactionOrder
- ): ReactionConnection!
-
- """
- The repository associated with this node.
- """
- repository: Repository!
-
- """
- The HTTP path for this issue comment
- """
- resourcePath: URI!
-
- """
- Identifies the date and time when the object was last updated.
- """
- updatedAt: DateTime!
-
- """
- The HTTP URL for this issue comment
- """
- url: URI!
-
- """
- A list of edits to this content.
- """
- userContentEdits(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): UserContentEditConnection
-
- """
- Check if the current viewer can delete this object.
- """
- viewerCanDelete: Boolean!
-
- """
- Check if the current viewer can minimize this object.
- """
- viewerCanMinimize: Boolean!
-
- """
- Can user react to this subject
- """
- viewerCanReact: Boolean!
-
- """
- Check if the current viewer can update this object.
- """
- viewerCanUpdate: Boolean!
-
- """
- Reasons why the current viewer can not update this comment.
- """
- viewerCannotUpdateReasons: [CommentCannotUpdateReason!]!
-
- """
- Did the viewer author this comment.
- """
- viewerDidAuthor: Boolean!
-}
-
-"""
-The connection type for IssueComment.
-"""
-type IssueCommentConnection {
- """
- A list of edges.
- """
- edges: [IssueCommentEdge]
-
- """
- A list of nodes.
- """
- nodes: [IssueComment]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type IssueCommentEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: IssueComment
-}
-
-"""
-The connection type for Issue.
-"""
-type IssueConnection {
- """
- A list of edges.
- """
- edges: [IssueEdge]
-
- """
- A list of nodes.
- """
- nodes: [Issue]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-This aggregates issues opened by a user within one repository.
-"""
-type IssueContributionsByRepository {
- """
- The issue contributions.
- """
- contributions(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for contributions returned from the connection.
- """
- orderBy: ContributionOrder = {field: OCCURRED_AT, direction: DESC}
- ): CreatedIssueContributionConnection!
-
- """
- The repository in which the issues were opened.
- """
- repository: Repository!
-}
-
-"""
-An edge in a connection.
-"""
-type IssueEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: Issue
-}
-
-"""
-Ways in which to filter lists of issues.
-"""
-input IssueFilters {
- """
- List issues assigned to given name. Pass in `null` for issues with no assigned
- user, and `*` for issues assigned to any user.
- """
- assignee: String
-
- """
- List issues created by given name.
- """
- createdBy: String
-
- """
- List issues where the list of label names exist on the issue.
- """
- labels: [String!]
-
- """
- List issues where the given name is mentioned in the issue.
- """
- mentioned: String
-
- """
- List issues by given milestone argument. If an string representation of an
- integer is passed, it should refer to a milestone by its number field. Pass in
- `null` for issues with no milestone, and `*` for issues that are assigned to any milestone.
- """
- milestone: String
-
- """
- List issues that have been updated at or after the given date.
- """
- since: DateTime
-
- """
- List issues filtered by the list of states given.
- """
- states: [IssueState!]
-
- """
- List issues subscribed to by viewer.
- """
- viewerSubscribed: Boolean = false
-}
-
-"""
-Used for return value of Repository.issueOrPullRequest.
-"""
-union IssueOrPullRequest = Issue | PullRequest
-
-"""
-Ways in which lists of issues can be ordered upon return.
-"""
-input IssueOrder {
- """
- The direction in which to order issues by the specified field.
- """
- direction: OrderDirection!
-
- """
- The field in which to order issues by.
- """
- field: IssueOrderField!
-}
-
-"""
-Properties by which issue connections can be ordered.
-"""
-enum IssueOrderField {
- """
- Order issues by comment count
- """
- COMMENTS
-
- """
- Order issues by creation time
- """
- CREATED_AT
-
- """
- Order issues by update time
- """
- UPDATED_AT
-}
-
-"""
-The possible states of an issue.
-"""
-enum IssueState {
- """
- An issue that has been closed
- """
- CLOSED
-
- """
- An issue that is still open
- """
- OPEN
-}
-
-"""
-The connection type for IssueTimelineItem.
-"""
-type IssueTimelineConnection {
- """
- A list of edges.
- """
- edges: [IssueTimelineItemEdge]
-
- """
- A list of nodes.
- """
- nodes: [IssueTimelineItem]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An item in an issue timeline
-"""
-union IssueTimelineItem = AssignedEvent | ClosedEvent | Commit | CrossReferencedEvent | DemilestonedEvent | IssueComment | LabeledEvent | LockedEvent | MilestonedEvent | ReferencedEvent | RenamedTitleEvent | ReopenedEvent | SubscribedEvent | TransferredEvent | UnassignedEvent | UnlabeledEvent | UnlockedEvent | UnsubscribedEvent | UserBlockedEvent
-
-"""
-An edge in a connection.
-"""
-type IssueTimelineItemEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: IssueTimelineItem
-}
-
-"""
-An item in an issue timeline
-"""
-union IssueTimelineItems = AddedToProjectEvent | AssignedEvent | ClosedEvent | CommentDeletedEvent | ConvertedNoteToIssueEvent | CrossReferencedEvent | DemilestonedEvent | IssueComment | LabeledEvent | LockedEvent | MentionedEvent | MilestonedEvent | MovedColumnsInProjectEvent | PinnedEvent | ReferencedEvent | RemovedFromProjectEvent | RenamedTitleEvent | ReopenedEvent | SubscribedEvent | TransferredEvent | UnassignedEvent | UnlabeledEvent | UnlockedEvent | UnpinnedEvent | UnsubscribedEvent | UserBlockedEvent
-
-"""
-The connection type for IssueTimelineItems.
-"""
-type IssueTimelineItemsConnection {
- """
- A list of edges.
- """
- edges: [IssueTimelineItemsEdge]
-
- """
- Identifies the count of items after applying `before` and `after` filters.
- """
- filteredCount: Int!
-
- """
- A list of nodes.
- """
- nodes: [IssueTimelineItems]
-
- """
- Identifies the count of items after applying `before`/`after` filters and `first`/`last`/`skip` slicing.
- """
- pageCount: Int!
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-
- """
- Identifies the date and time when the timeline was last updated.
- """
- updatedAt: DateTime!
-}
-
-"""
-An edge in a connection.
-"""
-type IssueTimelineItemsEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: IssueTimelineItems
-}
-
-"""
-The possible item types found in a timeline.
-"""
-enum IssueTimelineItemsItemType {
- """
- Represents a 'added_to_project' event on a given issue or pull request.
- """
- ADDED_TO_PROJECT_EVENT
-
- """
- Represents an 'assigned' event on any assignable object.
- """
- ASSIGNED_EVENT
-
- """
- Represents a 'closed' event on any `Closable`.
- """
- CLOSED_EVENT
-
- """
- Represents a 'comment_deleted' event on a given issue or pull request.
- """
- COMMENT_DELETED_EVENT
-
- """
- Represents a 'converted_note_to_issue' event on a given issue or pull request.
- """
- CONVERTED_NOTE_TO_ISSUE_EVENT
-
- """
- Represents a mention made by one issue or pull request to another.
- """
- CROSS_REFERENCED_EVENT
-
- """
- Represents a 'demilestoned' event on a given issue or pull request.
- """
- DEMILESTONED_EVENT
-
- """
- Represents a comment on an Issue.
- """
- ISSUE_COMMENT
-
- """
- Represents a 'labeled' event on a given issue or pull request.
- """
- LABELED_EVENT
-
- """
- Represents a 'locked' event on a given issue or pull request.
- """
- LOCKED_EVENT
-
- """
- Represents a 'mentioned' event on a given issue or pull request.
- """
- MENTIONED_EVENT
-
- """
- Represents a 'milestoned' event on a given issue or pull request.
- """
- MILESTONED_EVENT
-
- """
- Represents a 'moved_columns_in_project' event on a given issue or pull request.
- """
- MOVED_COLUMNS_IN_PROJECT_EVENT
-
- """
- Represents a 'pinned' event on a given issue or pull request.
- """
- PINNED_EVENT
-
- """
- Represents a 'referenced' event on a given `ReferencedSubject`.
- """
- REFERENCED_EVENT
-
- """
- Represents a 'removed_from_project' event on a given issue or pull request.
- """
- REMOVED_FROM_PROJECT_EVENT
-
- """
- Represents a 'renamed' event on a given issue or pull request
- """
- RENAMED_TITLE_EVENT
-
- """
- Represents a 'reopened' event on any `Closable`.
- """
- REOPENED_EVENT
-
- """
- Represents a 'subscribed' event on a given `Subscribable`.
- """
- SUBSCRIBED_EVENT
-
- """
- Represents a 'transferred' event on a given issue or pull request.
- """
- TRANSFERRED_EVENT
-
- """
- Represents an 'unassigned' event on any assignable object.
- """
- UNASSIGNED_EVENT
-
- """
- Represents an 'unlabeled' event on a given issue or pull request.
- """
- UNLABELED_EVENT
-
- """
- Represents an 'unlocked' event on a given issue or pull request.
- """
- UNLOCKED_EVENT
-
- """
- Represents an 'unpinned' event on a given issue or pull request.
- """
- UNPINNED_EVENT
-
- """
- Represents an 'unsubscribed' event on a given `Subscribable`.
- """
- UNSUBSCRIBED_EVENT
-
- """
- Represents a 'user_blocked' event on a given user.
- """
- USER_BLOCKED_EVENT
-}
-
-"""
-Represents a user signing up for a GitHub account.
-"""
-type JoinedGitHubContribution implements Contribution {
- """
- Whether this contribution is associated with a record you do not have access to. For
- example, your own 'first issue' contribution may have been made on a repository you can no
- longer access.
- """
- isRestricted: Boolean!
-
- """
- When this contribution was made.
- """
- occurredAt: DateTime!
-
- """
- The HTTP path for this contribution.
- """
- resourcePath: URI!
-
- """
- The HTTP URL for this contribution.
- """
- url: URI!
-
- """
- The user who made this contribution.
- """
- user: User!
-}
-
-"""
-A label for categorizing Issues or Milestones with a given Repository.
-"""
-type Label implements Node {
- """
- Identifies the label color.
- """
- color: String!
-
- """
- Identifies the date and time when the label was created.
- """
- createdAt: DateTime
-
- """
- A brief description of this label.
- """
- description: String
- id: ID!
-
- """
- Indicates whether or not this is a default label.
- """
- isDefault: Boolean!
-
- """
- A list of issues associated with this label.
- """
- issues(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Filtering options for issues returned from the connection.
- """
- filterBy: IssueFilters
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- A list of label names to filter the pull requests by.
- """
- labels: [String!]
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for issues returned from the connection.
- """
- orderBy: IssueOrder
-
- """
- A list of states to filter the issues by.
- """
- states: [IssueState!]
- ): IssueConnection!
-
- """
- Identifies the label name.
- """
- name: String!
-
- """
- A list of pull requests associated with this label.
- """
- pullRequests(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- The base ref name to filter the pull requests by.
- """
- baseRefName: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- The head ref name to filter the pull requests by.
- """
- headRefName: String
-
- """
- A list of label names to filter the pull requests by.
- """
- labels: [String!]
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for pull requests returned from the connection.
- """
- orderBy: IssueOrder
-
- """
- A list of states to filter the pull requests by.
- """
- states: [PullRequestState!]
- ): PullRequestConnection!
-
- """
- The repository associated with this label.
- """
- repository: Repository!
-
- """
- The HTTP path for this label.
- """
- resourcePath: URI!
-
- """
- Identifies the date and time when the label was last updated.
- """
- updatedAt: DateTime
-
- """
- The HTTP URL for this label.
- """
- url: URI!
-}
-
-"""
-The connection type for Label.
-"""
-type LabelConnection {
- """
- A list of edges.
- """
- edges: [LabelEdge]
-
- """
- A list of nodes.
- """
- nodes: [Label]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type LabelEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: Label
-}
-
-"""
-An object that can have labels assigned to it.
-"""
-interface Labelable {
- """
- A list of labels associated with the object.
- """
- labels(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): LabelConnection
-}
-
-"""
-Represents a 'labeled' event on a given issue or pull request.
-"""
-type LabeledEvent implements Node {
- """
- Identifies the actor who performed the event.
- """
- actor: Actor
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
- id: ID!
-
- """
- Identifies the label associated with the 'labeled' event.
- """
- label: Label!
-
- """
- Identifies the `Labelable` associated with the event.
- """
- labelable: Labelable!
-}
-
-"""
-Represents a given language found in repositories.
-"""
-type Language implements Node {
- """
- The color defined for the current language.
- """
- color: String
- id: ID!
-
- """
- The name of the current language.
- """
- name: String!
-}
-
-"""
-A list of languages associated with the parent.
-"""
-type LanguageConnection {
- """
- A list of edges.
- """
- edges: [LanguageEdge]
-
- """
- A list of nodes.
- """
- nodes: [Language]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-
- """
- The total size in bytes of files written in that language.
- """
- totalSize: Int!
-}
-
-"""
-Represents the language of a repository.
-"""
-type LanguageEdge {
- cursor: String!
- node: Language!
-
- """
- The number of bytes of code written in the language.
- """
- size: Int!
-}
-
-"""
-Ordering options for language connections.
-"""
-input LanguageOrder {
- """
- The ordering direction.
- """
- direction: OrderDirection!
-
- """
- The field to order languages by.
- """
- field: LanguageOrderField!
-}
-
-"""
-Properties by which language connections can be ordered.
-"""
-enum LanguageOrderField {
- """
- Order languages by the size of all files containing the language
- """
- SIZE
-}
-
-"""
-A repository's open source license
-"""
-type License implements Node {
- """
- The full text of the license
- """
- body: String!
-
- """
- The conditions set by the license
- """
- conditions: [LicenseRule]!
-
- """
- A human-readable description of the license
- """
- description: String
-
- """
- Whether the license should be featured
- """
- featured: Boolean!
-
- """
- Whether the license should be displayed in license pickers
- """
- hidden: Boolean!
- id: ID!
-
- """
- Instructions on how to implement the license
- """
- implementation: String
-
- """
- The lowercased SPDX ID of the license
- """
- key: String!
-
- """
- The limitations set by the license
- """
- limitations: [LicenseRule]!
-
- """
- The license full name specified by
- """
- name: String!
-
- """
- Customary short name if applicable (e.g, GPLv3)
- """
- nickname: String
-
- """
- The permissions set by the license
- """
- permissions: [LicenseRule]!
-
- """
- Whether the license is a pseudo-license placeholder (e.g., other, no-license)
- """
- pseudoLicense: Boolean!
-
- """
- Short identifier specified by
- """
- spdxId: String
-
- """
- URL to the license on
- """
- url: URI
-}
-
-"""
-Describes a License's conditions, permissions, and limitations
-"""
-type LicenseRule {
- """
- A description of the rule
- """
- description: String!
-
- """
- The machine-readable rule key
- """
- key: String!
-
- """
- The human-readable rule label
- """
- label: String!
-}
-
-"""
-Autogenerated input type of LockLockable
-"""
-input LockLockableInput {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- A reason for why the issue or pull request will be locked.
- """
- lockReason: LockReason
-
- """
- ID of the issue or pull request to be locked.
- """
- lockableId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "Lockable")
-}
-
-"""
-Autogenerated return type of LockLockable
-"""
-type LockLockablePayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The item that was locked.
- """
- lockedRecord: Lockable
-}
-
-"""
-The possible reasons that an issue or pull request was locked.
-"""
-enum LockReason {
- """
- The issue or pull request was locked because the conversation was off-topic.
- """
- OFF_TOPIC
-
- """
- The issue or pull request was locked because the conversation was resolved.
- """
- RESOLVED
-
- """
- The issue or pull request was locked because the conversation was spam.
- """
- SPAM
-
- """
- The issue or pull request was locked because the conversation was too heated.
- """
- TOO_HEATED
-}
-
-"""
-An object that can be locked.
-"""
-interface Lockable {
- """
- Reason that the conversation was locked.
- """
- activeLockReason: LockReason
-
- """
- `true` if the object is locked
- """
- locked: Boolean!
-}
-
-"""
-Represents a 'locked' event on a given issue or pull request.
-"""
-type LockedEvent implements Node {
- """
- Identifies the actor who performed the event.
- """
- actor: Actor
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
- id: ID!
-
- """
- Reason that the conversation was locked (optional).
- """
- lockReason: LockReason
-
- """
- Object that was locked.
- """
- lockable: Lockable!
-}
-
-"""
-Autogenerated input type of MarkPullRequestReadyForReview
-"""
-input MarkPullRequestReadyForReviewInput @preview(toggledBy: "shadow-cat-preview") {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- ID of the pull request to be marked as ready for review.
- """
- pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"])
-}
-
-"""
-Autogenerated return type of MarkPullRequestReadyForReview
-"""
-type MarkPullRequestReadyForReviewPayload @preview(toggledBy: "shadow-cat-preview") {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The pull request that is ready for review.
- """
- pullRequest: PullRequest
-}
-
-"""
-Entities that have members who can set status messages.
-"""
-interface MemberStatusable {
- """
- Get the status messages members of this entity have set that are either public or visible only to the organization.
- """
- memberStatuses(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for user statuses returned from the connection.
- """
- orderBy: UserStatusOrder = {field: UPDATED_AT, direction: DESC}
- ): UserStatusConnection!
-}
-
-"""
-Represents a 'mentioned' event on a given issue or pull request.
-"""
-type MentionedEvent implements Node {
- """
- Identifies the actor who performed the event.
- """
- actor: Actor
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- Identifies the primary key from the database.
- """
- databaseId: Int
- id: ID!
-}
-
-"""
-Autogenerated input type of MergePullRequest
-"""
-input MergePullRequestInput {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- Commit body to use for the merge commit; if omitted, a default message will be used
- """
- commitBody: String
-
- """
- Commit headline to use for the merge commit; if omitted, a default message will be used.
- """
- commitHeadline: String
-
- """
- OID that the pull request head ref must match to allow merge; if omitted, no check is performed.
- """
- expectedHeadOid: GitObjectID
-
- """
- ID of the pull request to be merged.
- """
- pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"])
-}
-
-"""
-Autogenerated return type of MergePullRequest
-"""
-type MergePullRequestPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The pull request that was merged.
- """
- pullRequest: PullRequest
-}
-
-"""
-Detailed status information about a pull request merge.
-"""
-enum MergeStateStatus {
- """
- The head ref is out of date.
- """
- BEHIND
-
- """
- The merge is blocked.
- """
- BLOCKED
-
- """
- Mergeable and passing commit status.
- """
- CLEAN
-
- """
- The merge commit cannot be cleanly created.
- """
- DIRTY
-
- """
- The merge is blocked due to the pull request being a draft.
- """
- DRAFT
-
- """
- Mergeable with passing commit status and pre-recieve hooks.
- """
- HAS_HOOKS
-
- """
- The state cannot currently be determined.
- """
- UNKNOWN
-
- """
- Mergeable with non-passing commit status.
- """
- UNSTABLE
-}
-
-"""
-Whether or not a PullRequest can be merged.
-"""
-enum MergeableState {
- """
- The pull request cannot be merged due to merge conflicts.
- """
- CONFLICTING
-
- """
- The pull request can be merged.
- """
- MERGEABLE
-
- """
- The mergeability of the pull request is still being calculated.
- """
- UNKNOWN
-}
-
-"""
-Represents a 'merged' event on a given pull request.
-"""
-type MergedEvent implements Node & UniformResourceLocatable {
- """
- Identifies the actor who performed the event.
- """
- actor: Actor
-
- """
- Identifies the commit associated with the `merge` event.
- """
- commit: Commit
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
- id: ID!
-
- """
- Identifies the Ref associated with the `merge` event.
- """
- mergeRef: Ref
-
- """
- Identifies the name of the Ref associated with the `merge` event.
- """
- mergeRefName: String!
-
- """
- PullRequest referenced by event.
- """
- pullRequest: PullRequest!
-
- """
- The HTTP path for this merged event.
- """
- resourcePath: URI!
-
- """
- The HTTP URL for this merged event.
- """
- url: URI!
-}
-
-"""
-Represents a Milestone object on a given repository.
-"""
-type Milestone implements Closable & Node & UniformResourceLocatable {
- """
- `true` if the object is closed (definition of closed may depend on type)
- """
- closed: Boolean!
-
- """
- Identifies the date and time when the object was closed.
- """
- closedAt: DateTime
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- Identifies the actor who created the milestone.
- """
- creator: Actor
-
- """
- Identifies the description of the milestone.
- """
- description: String
-
- """
- Identifies the due date of the milestone.
- """
- dueOn: DateTime
- id: ID!
-
- """
- A list of issues associated with the milestone.
- """
- issues(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Filtering options for issues returned from the connection.
- """
- filterBy: IssueFilters
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- A list of label names to filter the pull requests by.
- """
- labels: [String!]
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for issues returned from the connection.
- """
- orderBy: IssueOrder
-
- """
- A list of states to filter the issues by.
- """
- states: [IssueState!]
- ): IssueConnection!
-
- """
- Identifies the number of the milestone.
- """
- number: Int!
-
- """
- A list of pull requests associated with the milestone.
- """
- pullRequests(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- The base ref name to filter the pull requests by.
- """
- baseRefName: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- The head ref name to filter the pull requests by.
- """
- headRefName: String
-
- """
- A list of label names to filter the pull requests by.
- """
- labels: [String!]
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for pull requests returned from the connection.
- """
- orderBy: IssueOrder
-
- """
- A list of states to filter the pull requests by.
- """
- states: [PullRequestState!]
- ): PullRequestConnection!
-
- """
- The repository associated with this milestone.
- """
- repository: Repository!
-
- """
- The HTTP path for this milestone
- """
- resourcePath: URI!
-
- """
- Identifies the state of the milestone.
- """
- state: MilestoneState!
-
- """
- Identifies the title of the milestone.
- """
- title: String!
-
- """
- Identifies the date and time when the object was last updated.
- """
- updatedAt: DateTime!
-
- """
- The HTTP URL for this milestone
- """
- url: URI!
-}
-
-"""
-The connection type for Milestone.
-"""
-type MilestoneConnection {
- """
- A list of edges.
- """
- edges: [MilestoneEdge]
-
- """
- A list of nodes.
- """
- nodes: [Milestone]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type MilestoneEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: Milestone
-}
-
-"""
-Types that can be inside a Milestone.
-"""
-union MilestoneItem = Issue | PullRequest
-
-"""
-Ordering options for milestone connections.
-"""
-input MilestoneOrder {
- """
- The ordering direction.
- """
- direction: OrderDirection!
-
- """
- The field to order milestones by.
- """
- field: MilestoneOrderField!
-}
-
-"""
-Properties by which milestone connections can be ordered.
-"""
-enum MilestoneOrderField {
- """
- Order milestones by when they were created.
- """
- CREATED_AT
-
- """
- Order milestones by when they are due.
- """
- DUE_DATE
-
- """
- Order milestones by their number.
- """
- NUMBER
-
- """
- Order milestones by when they were last updated.
- """
- UPDATED_AT
-}
-
-"""
-The possible states of a milestone.
-"""
-enum MilestoneState {
- """
- A milestone that has been closed.
- """
- CLOSED
-
- """
- A milestone that is still open.
- """
- OPEN
-}
-
-"""
-Represents a 'milestoned' event on a given issue or pull request.
-"""
-type MilestonedEvent implements Node {
- """
- Identifies the actor who performed the event.
- """
- actor: Actor
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
- id: ID!
-
- """
- Identifies the milestone title associated with the 'milestoned' event.
- """
- milestoneTitle: String!
-
- """
- Object referenced by event.
- """
- subject: MilestoneItem!
-}
-
-"""
-Entities that can be minimized.
-"""
-interface Minimizable @preview(toggledBy: "queen-beryl-preview") {
- """
- Returns whether or not a comment has been minimized.
- """
- isMinimized: Boolean!
-
- """
- Returns why the comment was minimized.
- """
- minimizedReason: String
-
- """
- Check if the current viewer can minimize this object.
- """
- viewerCanMinimize: Boolean!
-}
-
-"""
-Autogenerated input type of MinimizeComment
-"""
-input MinimizeCommentInput {
- """
- The classification of comment
- """
- classifier: ReportedContentClassifiers!
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The Node ID of the subject to modify.
- """
- subjectId: ID! @possibleTypes(concreteTypes: ["CommitComment", "GistComment", "IssueComment", "PullRequestReviewComment"], abstractType: "Minimizable")
-}
-
-"""
-Autogenerated return type of MinimizeComment
-"""
-type MinimizeCommentPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The comment that was minimized.
- """
- minimizedComment: Minimizable
-}
-
-"""
-Autogenerated input type of MoveProjectCard
-"""
-input MoveProjectCardInput {
- """
- Place the new card after the card with this id. Pass null to place it at the top.
- """
- afterCardId: ID @possibleTypes(concreteTypes: ["ProjectCard"])
-
- """
- The id of the card to move.
- """
- cardId: ID! @possibleTypes(concreteTypes: ["ProjectCard"])
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The id of the column to move it into.
- """
- columnId: ID! @possibleTypes(concreteTypes: ["ProjectColumn"])
-}
-
-"""
-Autogenerated return type of MoveProjectCard
-"""
-type MoveProjectCardPayload {
- """
- The new edge of the moved card.
- """
- cardEdge: ProjectCardEdge
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-}
-
-"""
-Autogenerated input type of MoveProjectColumn
-"""
-input MoveProjectColumnInput {
- """
- Place the new column after the column with this id. Pass null to place it at the front.
- """
- afterColumnId: ID @possibleTypes(concreteTypes: ["ProjectColumn"])
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The id of the column to move.
- """
- columnId: ID! @possibleTypes(concreteTypes: ["ProjectColumn"])
-}
-
-"""
-Autogenerated return type of MoveProjectColumn
-"""
-type MoveProjectColumnPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The new edge of the moved column.
- """
- columnEdge: ProjectColumnEdge
-}
-
-"""
-Represents a 'moved_columns_in_project' event on a given issue or pull request.
-"""
-type MovedColumnsInProjectEvent implements Node {
- """
- Identifies the actor who performed the event.
- """
- actor: Actor
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- Identifies the primary key from the database.
- """
- databaseId: Int
- id: ID!
-
- """
- Column name the issue or pull request was moved from.
- """
- previousProjectColumnName: String! @preview(toggledBy: "starfox-preview")
-
- """
- Project referenced by event.
- """
- project: Project @preview(toggledBy: "starfox-preview")
-
- """
- Project card referenced by this project event.
- """
- projectCard: ProjectCard @preview(toggledBy: "starfox-preview")
-
- """
- Column name the issue or pull request was moved to.
- """
- projectColumnName: String! @preview(toggledBy: "starfox-preview")
-}
-
-"""
-The root query for implementing GraphQL mutations.
-"""
-type Mutation {
- """
- Adds assignees to an assignable object.
- """
- addAssigneesToAssignable(input: AddAssigneesToAssignableInput!): AddAssigneesToAssignablePayload
-
- """
- Adds a comment to an Issue or Pull Request.
- """
- addComment(input: AddCommentInput!): AddCommentPayload
-
- """
- Adds labels to a labelable object.
- """
- addLabelsToLabelable(input: AddLabelsToLabelableInput!): AddLabelsToLabelablePayload
-
- """
- Adds a card to a ProjectColumn. Either `contentId` or `note` must be provided but **not** both.
- """
- addProjectCard(input: AddProjectCardInput!): AddProjectCardPayload
-
- """
- Adds a column to a Project.
- """
- addProjectColumn(input: AddProjectColumnInput!): AddProjectColumnPayload
-
- """
- Adds a review to a Pull Request.
- """
- addPullRequestReview(input: AddPullRequestReviewInput!): AddPullRequestReviewPayload
-
- """
- Adds a comment to a review.
- """
- addPullRequestReviewComment(input: AddPullRequestReviewCommentInput!): AddPullRequestReviewCommentPayload
-
- """
- Adds a reaction to a subject.
- """
- addReaction(input: AddReactionInput!): AddReactionPayload
-
- """
- Adds a star to a Starrable.
- """
- addStar(input: AddStarInput!): AddStarPayload
-
- """
- Update your status on GitHub.
- """
- changeUserStatus(input: ChangeUserStatusInput!): ChangeUserStatusPayload
-
- """
- Clears all labels from a labelable object.
- """
- clearLabelsFromLabelable(input: ClearLabelsFromLabelableInput!): ClearLabelsFromLabelablePayload
-
- """
- Creates a new project by cloning configuration from an existing project.
- """
- cloneProject(input: CloneProjectInput!): CloneProjectPayload
-
- """
- Close an issue.
- """
- closeIssue(input: CloseIssueInput!): CloseIssuePayload
-
- """
- Close a pull request.
- """
- closePullRequest(input: ClosePullRequestInput!): ClosePullRequestPayload
-
- """
- Convert a project note card to one associated with a newly created issue.
- """
- convertProjectCardNoteToIssue(input: ConvertProjectCardNoteToIssueInput!): ConvertProjectCardNoteToIssuePayload
-
- """
- Create a new branch protection rule
- """
- createBranchProtectionRule(input: CreateBranchProtectionRuleInput!): CreateBranchProtectionRulePayload
-
- """
- Create a check run.
- """
- createCheckRun(input: CreateCheckRunInput!): CreateCheckRunPayload @preview(toggledBy: "antiope-preview")
-
- """
- Create a check suite
- """
- createCheckSuite(input: CreateCheckSuiteInput!): CreateCheckSuitePayload @preview(toggledBy: "antiope-preview")
-
- """
- Create a content attachment.
- """
- createContentAttachment(input: CreateContentAttachmentInput!): CreateContentAttachmentPayload @preview(toggledBy: "corsair-preview")
-
- """
- Creates a new deployment event.
- """
- createDeployment(input: CreateDeploymentInput!): CreateDeploymentPayload @preview(toggledBy: "flash-preview")
-
- """
- Create a deployment status.
- """
- createDeploymentStatus(input: CreateDeploymentStatusInput!): CreateDeploymentStatusPayload @preview(toggledBy: "flash-preview")
-
- """
- Creates a new issue.
- """
- createIssue(input: CreateIssueInput!): CreateIssuePayload
-
- """
- Creates a new label.
- """
- createLabel(input: CreateLabelInput!): CreateLabelPayload @preview(toggledBy: "bane-preview")
-
- """
- Creates a new project.
- """
- createProject(input: CreateProjectInput!): CreateProjectPayload
-
- """
- Create a new pull request
- """
- createPullRequest(input: CreatePullRequestInput!): CreatePullRequestPayload
-
- """
- Creates a new team discussion.
- """
- createTeamDiscussion(input: CreateTeamDiscussionInput!): CreateTeamDiscussionPayload @preview(toggledBy: "echo-preview")
-
- """
- Creates a new team discussion comment.
- """
- createTeamDiscussionComment(input: CreateTeamDiscussionCommentInput!): CreateTeamDiscussionCommentPayload @preview(toggledBy: "echo-preview")
-
- """
- Delete a branch protection rule
- """
- deleteBranchProtectionRule(input: DeleteBranchProtectionRuleInput!): DeleteBranchProtectionRulePayload
-
- """
- Deletes an Issue object.
- """
- deleteIssue(input: DeleteIssueInput!): DeleteIssuePayload
-
- """
- Deletes an IssueComment object.
- """
- deleteIssueComment(input: DeleteIssueCommentInput!): DeleteIssueCommentPayload
-
- """
- Deletes a label.
- """
- deleteLabel(input: DeleteLabelInput!): DeleteLabelPayload @preview(toggledBy: "bane-preview")
-
- """
- Deletes a project.
- """
- deleteProject(input: DeleteProjectInput!): DeleteProjectPayload
-
- """
- Deletes a project card.
- """
- deleteProjectCard(input: DeleteProjectCardInput!): DeleteProjectCardPayload
-
- """
- Deletes a project column.
- """
- deleteProjectColumn(input: DeleteProjectColumnInput!): DeleteProjectColumnPayload
-
- """
- Deletes a pull request review.
- """
- deletePullRequestReview(input: DeletePullRequestReviewInput!): DeletePullRequestReviewPayload
-
- """
- Deletes a pull request review comment.
- """
- deletePullRequestReviewComment(input: DeletePullRequestReviewCommentInput!): DeletePullRequestReviewCommentPayload
-
- """
- Deletes a team discussion.
- """
- deleteTeamDiscussion(input: DeleteTeamDiscussionInput!): DeleteTeamDiscussionPayload @preview(toggledBy: "echo-preview")
-
- """
- Deletes a team discussion comment.
- """
- deleteTeamDiscussionComment(input: DeleteTeamDiscussionCommentInput!): DeleteTeamDiscussionCommentPayload @preview(toggledBy: "echo-preview")
-
- """
- Dismisses an approved or rejected pull request review.
- """
- dismissPullRequestReview(input: DismissPullRequestReviewInput!): DismissPullRequestReviewPayload
-
- """
- Creates a new project by importing columns and a list of issues/PRs.
- """
- importProject(input: ImportProjectInput!): ImportProjectPayload @preview(toggledBy: "slothette-preview")
-
- """
- Lock a lockable object
- """
- lockLockable(input: LockLockableInput!): LockLockablePayload
-
- """
- Marks a pull request ready for review.
- """
- markPullRequestReadyForReview(input: MarkPullRequestReadyForReviewInput!): MarkPullRequestReadyForReviewPayload @preview(toggledBy: "shadow-cat-preview")
-
- """
- Merge a pull request.
- """
- mergePullRequest(input: MergePullRequestInput!): MergePullRequestPayload
-
- """
- Minimizes a comment on an Issue, Commit, Pull Request, or Gist
- """
- minimizeComment(input: MinimizeCommentInput!): MinimizeCommentPayload @preview(toggledBy: "queen-beryl-preview")
-
- """
- Moves a project card to another place.
- """
- moveProjectCard(input: MoveProjectCardInput!): MoveProjectCardPayload
-
- """
- Moves a project column to another place.
- """
- moveProjectColumn(input: MoveProjectColumnInput!): MoveProjectColumnPayload
-
- """
- Pin an issue to a repository
- """
- pinIssue(input: PinIssueInput!): PinIssuePayload @preview(toggledBy: "elektra-preview")
-
- """
- Removes assignees from an assignable object.
- """
- removeAssigneesFromAssignable(input: RemoveAssigneesFromAssignableInput!): RemoveAssigneesFromAssignablePayload
-
- """
- Removes labels from a Labelable object.
- """
- removeLabelsFromLabelable(input: RemoveLabelsFromLabelableInput!): RemoveLabelsFromLabelablePayload
-
- """
- Removes outside collaborator from all repositories in an organization.
- """
- removeOutsideCollaborator(input: RemoveOutsideCollaboratorInput!): RemoveOutsideCollaboratorPayload
-
- """
- Removes a reaction from a subject.
- """
- removeReaction(input: RemoveReactionInput!): RemoveReactionPayload
-
- """
- Removes a star from a Starrable.
- """
- removeStar(input: RemoveStarInput!): RemoveStarPayload
-
- """
- Reopen a issue.
- """
- reopenIssue(input: ReopenIssueInput!): ReopenIssuePayload
-
- """
- Reopen a pull request.
- """
- reopenPullRequest(input: ReopenPullRequestInput!): ReopenPullRequestPayload
-
- """
- Set review requests on a pull request.
- """
- requestReviews(input: RequestReviewsInput!): RequestReviewsPayload
-
- """
- Rerequests an existing check suite.
- """
- rerequestCheckSuite(input: RerequestCheckSuiteInput!): RerequestCheckSuitePayload @preview(toggledBy: "antiope-preview")
-
- """
- Marks a review thread as resolved.
- """
- resolveReviewThread(input: ResolveReviewThreadInput!): ResolveReviewThreadPayload
-
- """
- Submits a pending pull request review.
- """
- submitPullRequestReview(input: SubmitPullRequestReviewInput!): SubmitPullRequestReviewPayload
-
- """
- Unlock a lockable object
- """
- unlockLockable(input: UnlockLockableInput!): UnlockLockablePayload
-
- """
- Unmark an issue as a duplicate of another issue.
- """
- unmarkIssueAsDuplicate(input: UnmarkIssueAsDuplicateInput!): UnmarkIssueAsDuplicatePayload
-
- """
- Unminimizes a comment on an Issue, Commit, Pull Request, or Gist
- """
- unminimizeComment(input: UnminimizeCommentInput!): UnminimizeCommentPayload @preview(toggledBy: "queen-beryl-preview")
-
- """
- Unpin a pinned issue from a repository
- """
- unpinIssue(input: UnpinIssueInput!): UnpinIssuePayload @preview(toggledBy: "elektra-preview")
-
- """
- Marks a review thread as unresolved.
- """
- unresolveReviewThread(input: UnresolveReviewThreadInput!): UnresolveReviewThreadPayload
-
- """
- Create a new branch protection rule
- """
- updateBranchProtectionRule(input: UpdateBranchProtectionRuleInput!): UpdateBranchProtectionRulePayload
-
- """
- Update a check run
- """
- updateCheckRun(input: UpdateCheckRunInput!): UpdateCheckRunPayload @preview(toggledBy: "antiope-preview")
-
- """
- Modifies the settings of an existing check suite
- """
- updateCheckSuitePreferences(input: UpdateCheckSuitePreferencesInput!): UpdateCheckSuitePreferencesPayload @preview(toggledBy: "antiope-preview")
-
- """
- Updates an Issue.
- """
- updateIssue(input: UpdateIssueInput!): UpdateIssuePayload
-
- """
- Updates an IssueComment object.
- """
- updateIssueComment(input: UpdateIssueCommentInput!): UpdateIssueCommentPayload
-
- """
- Updates an existing label.
- """
- updateLabel(input: UpdateLabelInput!): UpdateLabelPayload @preview(toggledBy: "bane-preview")
-
- """
- Updates an existing project.
- """
- updateProject(input: UpdateProjectInput!): UpdateProjectPayload
-
- """
- Updates an existing project card.
- """
- updateProjectCard(input: UpdateProjectCardInput!): UpdateProjectCardPayload
-
- """
- Updates an existing project column.
- """
- updateProjectColumn(input: UpdateProjectColumnInput!): UpdateProjectColumnPayload
-
- """
- Update a pull request
- """
- updatePullRequest(input: UpdatePullRequestInput!): UpdatePullRequestPayload
-
- """
- Updates the body of a pull request review.
- """
- updatePullRequestReview(input: UpdatePullRequestReviewInput!): UpdatePullRequestReviewPayload
-
- """
- Updates a pull request review comment.
- """
- updatePullRequestReviewComment(input: UpdatePullRequestReviewCommentInput!): UpdatePullRequestReviewCommentPayload
-
- """
- Updates the state for subscribable subjects.
- """
- updateSubscription(input: UpdateSubscriptionInput!): UpdateSubscriptionPayload
-
- """
- Updates a team discussion.
- """
- updateTeamDiscussion(input: UpdateTeamDiscussionInput!): UpdateTeamDiscussionPayload @preview(toggledBy: "echo-preview")
-
- """
- Updates a discussion comment.
- """
- updateTeamDiscussionComment(input: UpdateTeamDiscussionCommentInput!): UpdateTeamDiscussionCommentPayload @preview(toggledBy: "echo-preview")
-
- """
- Replaces the repository's topics with the given topics.
- """
- updateTopics(input: UpdateTopicsInput!): UpdateTopicsPayload
-}
-
-"""
-An object with an ID.
-"""
-interface Node {
- """
- ID of the object.
- """
- id: ID!
-}
-
-"""
-Possible directions in which to order a list of items when provided an `orderBy` argument.
-"""
-enum OrderDirection {
- """
- Specifies an ascending order for a given `orderBy` argument.
- """
- ASC
-
- """
- Specifies a descending order for a given `orderBy` argument.
- """
- DESC
-}
-
-"""
-An account on GitHub, with one or more owners, that has repositories, members and teams.
-"""
-type Organization implements Actor & MemberStatusable & Node & ProfileOwner & ProjectOwner & RegistryPackageOwner & RegistryPackageSearch & RepositoryOwner & UniformResourceLocatable {
- """
- Determine if this repository owner has any items that can be pinned to their profile.
- """
- anyPinnableItems(
- """
- Filter to only a particular kind of pinnable item.
- """
- type: PinnableItemType
- ): Boolean!
-
- """
- A URL pointing to the organization's public avatar.
- """
- avatarUrl(
- """
- The size of the resulting square image.
- """
- size: Int
- ): URI!
-
- """
- Identifies the primary key from the database.
- """
- databaseId: Int
-
- """
- The organization's public profile description.
- """
- description: String
-
- """
- The organization's public email.
- """
- email: String
- id: ID!
-
- """
- Showcases a selection of repositories and gists that the profile owner has
- either curated or that have been selected automatically based on popularity.
- """
- itemShowcase: ProfileItemShowcase!
-
- """
- The organization's public profile location.
- """
- location: String
-
- """
- The organization's login name.
- """
- login: String!
-
- """
- Get the status messages members of this entity have set that are either public or visible only to the organization.
- """
- memberStatuses(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for user statuses returned from the connection.
- """
- orderBy: UserStatusOrder = {field: UPDATED_AT, direction: DESC}
- ): UserStatusConnection!
-
- """
- A list of users who are members of this organization.
- """
- members(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): UserConnection! @deprecated(reason: "The `members` field is deprecated and will be removed soon. Use `Organization.membersWithRole` instead. Removal on 2019-04-01 UTC.")
-
- """
- A list of users who are members of this organization.
- """
- membersWithRole(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): OrganizationMemberConnection!
-
- """
- The organization's public profile name.
- """
- name: String
-
- """
- The HTTP path creating a new team
- """
- newTeamResourcePath: URI!
-
- """
- The HTTP URL creating a new team
- """
- newTeamUrl: URI!
-
- """
- The billing email for the organization.
- """
- organizationBillingEmail: String
-
- """
- A list of users who have been invited to join this organization.
- """
- pendingMembers(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): UserConnection!
-
- """
- A list of repositories and gists this profile owner can pin to their profile.
- """
- pinnableItems(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Filter the types of pinnable items that are returned.
- """
- types: [PinnableItemType!]
- ): PinnableItemConnection!
-
- """
- A list of repositories and gists this profile owner has pinned to their profile
- """
- pinnedItems(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Filter the types of pinned items that are returned.
- """
- types: [PinnableItemType!]
- ): PinnableItemConnection!
-
- """
- Returns how many more items this profile owner can pin to their profile.
- """
- pinnedItemsRemaining: Int!
-
- """
- A list of repositories this user has pinned to their profile
- """
- pinnedRepositories(
- """
- Array of viewer's affiliation options for repositories returned from the
- connection. For example, OWNER will include only repositories that the
- current viewer owns.
- """
- affiliations: [RepositoryAffiliation] = [OWNER, COLLABORATOR]
-
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- If non-null, filters repositories according to whether they have been locked
- """
- isLocked: Boolean
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for repositories returned from the connection
- """
- orderBy: RepositoryOrder
-
- """
- Array of owner's affiliation options for repositories returned from the
- connection. For example, OWNER will include only repositories that the
- organization or user being viewed owns.
- """
- ownerAffiliations: [RepositoryAffiliation] = [OWNER, COLLABORATOR]
-
- """
- If non-null, filters repositories according to privacy
- """
- privacy: RepositoryPrivacy
- ): RepositoryConnection! @deprecated(reason: "pinnedRepositories will be removed Use ProfileOwner.pinnedItems instead. Removal on 2019-07-01 UTC.")
-
- """
- Find project by number.
- """
- project(
- """
- The project number to find.
- """
- number: Int!
- ): Project
-
- """
- A list of projects under the owner.
- """
- projects(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for projects returned from the connection
- """
- orderBy: ProjectOrder
-
- """
- Query to search projects by, currently only searching by name.
- """
- search: String
-
- """
- A list of states to filter the projects by.
- """
- states: [ProjectState!]
- ): ProjectConnection!
-
- """
- The HTTP path listing organization's projects
- """
- projectsResourcePath: URI!
-
- """
- The HTTP URL listing organization's projects
- """
- projectsUrl: URI!
-
- """
- A list of repositories that the user owns.
- """
- repositories(
- """
- Array of viewer's affiliation options for repositories returned from the
- connection. For example, OWNER will include only repositories that the
- current viewer owns.
- """
- affiliations: [RepositoryAffiliation] = [OWNER, COLLABORATOR]
-
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- If non-null, filters repositories according to whether they are forks of another repository
- """
- isFork: Boolean
-
- """
- If non-null, filters repositories according to whether they have been locked
- """
- isLocked: Boolean
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for repositories returned from the connection
- """
- orderBy: RepositoryOrder
-
- """
- Array of owner's affiliation options for repositories returned from the
- connection. For example, OWNER will include only repositories that the
- organization or user being viewed owns.
- """
- ownerAffiliations: [RepositoryAffiliation] = [OWNER, COLLABORATOR]
-
- """
- If non-null, filters repositories according to privacy
- """
- privacy: RepositoryPrivacy
- ): RepositoryConnection!
-
- """
- Find Repository.
- """
- repository(
- """
- Name of Repository to find.
- """
- name: String!
- ): Repository
-
- """
- When true the organization requires all members, billing managers, and outside
- collaborators to enable two-factor authentication.
- """
- requiresTwoFactorAuthentication: Boolean
-
- """
- The HTTP path for this organization.
- """
- resourcePath: URI!
-
- """
- The Organization's SAML identity providers
- """
- samlIdentityProvider: OrganizationIdentityProvider
-
- """
- Find an organization's team by its slug.
- """
- team(
- """
- The name or slug of the team to find.
- """
- slug: String!
- ): Team
-
- """
- A list of teams in this organization.
- """
- teams(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- If true, filters teams that are mapped to an LDAP Group (Enterprise only)
- """
- ldapMapped: Boolean
-
- """
- Ordering options for teams returned from the connection
- """
- orderBy: TeamOrder
-
- """
- If non-null, filters teams according to privacy
- """
- privacy: TeamPrivacy
-
- """
- If non-null, filters teams with query on team name and team slug
- """
- query: String
-
- """
- If non-null, filters teams according to whether the viewer is an admin or member on team
- """
- role: TeamRole
-
- """
- If true, restrict to only root teams
- """
- rootTeamsOnly: Boolean = false
-
- """
- User logins to filter by
- """
- userLogins: [String!]
- ): TeamConnection!
-
- """
- The HTTP path listing organization's teams
- """
- teamsResourcePath: URI!
-
- """
- The HTTP URL listing organization's teams
- """
- teamsUrl: URI!
-
- """
- The HTTP URL for this organization.
- """
- url: URI!
-
- """
- Organization is adminable by the viewer.
- """
- viewerCanAdminister: Boolean!
-
- """
- Can the viewer pin repositories and gists to the profile?
- """
- viewerCanChangePinnedItems: Boolean!
-
- """
- Can the current viewer create new projects on this owner.
- """
- viewerCanCreateProjects: Boolean!
-
- """
- Viewer can create repositories on this organization
- """
- viewerCanCreateRepositories: Boolean!
-
- """
- Viewer can create teams on this organization.
- """
- viewerCanCreateTeams: Boolean!
-
- """
- Viewer is an active member of this organization.
- """
- viewerIsAMember: Boolean!
-
- """
- The organization's public profile URL.
- """
- websiteUrl: URI
-}
-
-"""
-The connection type for Organization.
-"""
-type OrganizationConnection {
- """
- A list of edges.
- """
- edges: [OrganizationEdge]
-
- """
- A list of nodes.
- """
- nodes: [Organization]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type OrganizationEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: Organization
-}
-
-"""
-An Identity Provider configured to provision SAML and SCIM identities for Organizations
-"""
-type OrganizationIdentityProvider implements Node {
- """
- The digest algorithm used to sign SAML requests for the Identity Provider.
- """
- digestMethod: URI
-
- """
- External Identities provisioned by this Identity Provider
- """
- externalIdentities(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): ExternalIdentityConnection!
- id: ID!
-
- """
- The x509 certificate used by the Identity Provder to sign assertions and responses.
- """
- idpCertificate: X509Certificate
-
- """
- The Issuer Entity ID for the SAML Identity Provider
- """
- issuer: String
-
- """
- Organization this Identity Provider belongs to
- """
- organization: Organization
-
- """
- The signature algorithm used to sign SAML requests for the Identity Provider.
- """
- signatureMethod: URI
-
- """
- The URL endpoint for the Identity Provider's SAML SSO.
- """
- ssoUrl: URI
-}
-
-"""
-An Invitation for a user to an organization.
-"""
-type OrganizationInvitation implements Node {
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- The email address of the user invited to the organization.
- """
- email: String
- id: ID!
-
- """
- The type of invitation that was sent (e.g. email, user).
- """
- invitationType: OrganizationInvitationType!
-
- """
- The user who was invited to the organization.
- """
- invitee: User
-
- """
- The user who created the invitation.
- """
- inviter: User!
-
- """
- The organization the invite is for
- """
- organization: Organization!
-
- """
- The user's pending role in the organization (e.g. member, owner).
- """
- role: OrganizationInvitationRole!
-}
-
-"""
-The connection type for OrganizationInvitation.
-"""
-type OrganizationInvitationConnection {
- """
- A list of edges.
- """
- edges: [OrganizationInvitationEdge]
-
- """
- A list of nodes.
- """
- nodes: [OrganizationInvitation]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type OrganizationInvitationEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: OrganizationInvitation
-}
-
-"""
-The possible organization invitation roles.
-"""
-enum OrganizationInvitationRole {
- """
- The user is invited to be an admin of the organization.
- """
- ADMIN
-
- """
- The user is invited to be a billing manager of the organization.
- """
- BILLING_MANAGER
-
- """
- The user is invited to be a direct member of the organization.
- """
- DIRECT_MEMBER
-
- """
- The user's previous role will be reinstated.
- """
- REINSTATE
-}
-
-"""
-The possible organization invitation types.
-"""
-enum OrganizationInvitationType {
- """
- The invitation was to an email address.
- """
- EMAIL
-
- """
- The invitation was to an existing user.
- """
- USER
-}
-
-"""
-The connection type for User.
-"""
-type OrganizationMemberConnection {
- """
- A list of edges.
- """
- edges: [OrganizationMemberEdge]
-
- """
- A list of nodes.
- """
- nodes: [User]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-Represents a user within an organization.
-"""
-type OrganizationMemberEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- Whether the organization member has two factor enabled or not. Returns null if information is not available to viewer.
- """
- hasTwoFactorEnabled: Boolean
-
- """
- The item at the end of the edge.
- """
- node: User
-
- """
- The role this user has in the organization.
- """
- role: OrganizationMemberRole
-}
-
-"""
-The possible roles within an organization for its members.
-"""
-enum OrganizationMemberRole {
- """
- The user is an administrator of the organization.
- """
- ADMIN
-
- """
- The user is a member of the organization.
- """
- MEMBER
-}
-
-"""
-An organization teams hovercard context
-"""
-type OrganizationTeamsHovercardContext implements HovercardContext @preview(toggledBy: "hagar-preview") {
- """
- A string describing this context
- """
- message: String!
-
- """
- An octicon to accompany this context
- """
- octicon: String!
-
- """
- Teams in this organization the user is a member of that are relevant
- """
- relevantTeams(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): TeamConnection!
-
- """
- The path for the full team list for this user
- """
- teamsResourcePath: URI!
-
- """
- The URL for the full team list for this user
- """
- teamsUrl: URI!
-
- """
- The total number of teams the user is on in the organization
- """
- totalTeamCount: Int!
-}
-
-"""
-An organization list hovercard context
-"""
-type OrganizationsHovercardContext implements HovercardContext @preview(toggledBy: "hagar-preview") {
- """
- A string describing this context
- """
- message: String!
-
- """
- An octicon to accompany this context
- """
- octicon: String!
-
- """
- Organizations this user is a member of that are relevant
- """
- relevantOrganizations(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): OrganizationConnection!
-
- """
- The total number of organizations this user is in
- """
- totalOrganizationCount: Int!
-}
-
-"""
-Information about pagination in a connection.
-"""
-type PageInfo {
- """
- When paginating forwards, the cursor to continue.
- """
- endCursor: String
-
- """
- When paginating forwards, are there more items?
- """
- hasNextPage: Boolean!
-
- """
- When paginating backwards, are there more items?
- """
- hasPreviousPage: Boolean!
-
- """
- When paginating backwards, the cursor to continue.
- """
- startCursor: String
-}
-
-"""
-Types that can grant permissions on a repository to a user
-"""
-union PermissionGranter = Organization | Repository | Team
-
-"""
-A level of permission and source for a user's access to a repository.
-"""
-type PermissionSource {
- """
- The organization the repository belongs to.
- """
- organization: Organization!
-
- """
- The level of access this source has granted to the user.
- """
- permission: DefaultRepositoryPermissionField!
-
- """
- The source of this permission.
- """
- source: PermissionGranter!
-}
-
-"""
-Autogenerated input type of PinIssue
-"""
-input PinIssueInput {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The ID of the issue to be pinned
- """
- issueId: ID! @possibleTypes(concreteTypes: ["Issue"])
-}
-
-"""
-Autogenerated return type of PinIssue
-"""
-type PinIssuePayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The issue that was pinned
- """
- issue: Issue
-}
-
-"""
-Types that can be pinned to a profile page.
-"""
-union PinnableItem = Gist | Repository
-
-"""
-The connection type for PinnableItem.
-"""
-type PinnableItemConnection {
- """
- A list of edges.
- """
- edges: [PinnableItemEdge]
-
- """
- A list of nodes.
- """
- nodes: [PinnableItem]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type PinnableItemEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: PinnableItem
-}
-
-"""
-Represents items that can be pinned to a profile page.
-"""
-enum PinnableItemType {
- """
- A gist.
- """
- GIST
-
- """
- A repository.
- """
- REPOSITORY
-}
-
-"""
-Represents a 'pinned' event on a given issue or pull request.
-"""
-type PinnedEvent implements Node {
- """
- Identifies the actor who performed the event.
- """
- actor: Actor
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
- id: ID!
-
- """
- Identifies the issue associated with the event.
- """
- issue: Issue!
-}
-
-"""
-A Pinned Issue is a issue pinned to a repository's index page.
-"""
-type PinnedIssue implements Node @preview(toggledBy: "elektra-preview") {
- """
- Identifies the primary key from the database.
- """
- databaseId: Int
- id: ID!
-
- """
- The issue that was pinned.
- """
- issue: Issue!
-
- """
- The actor that pinned this issue.
- """
- pinnedBy: Actor!
-
- """
- The repository that this issue was pinned to.
- """
- repository: Repository!
-}
-
-"""
-The connection type for PinnedIssue.
-"""
-type PinnedIssueConnection @preview(toggledBy: "elektra-preview") {
- """
- A list of edges.
- """
- edges: [PinnedIssueEdge]
-
- """
- A list of nodes.
- """
- nodes: [PinnedIssue]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type PinnedIssueEdge @preview(toggledBy: "elektra-preview") {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: PinnedIssue
-}
-
-"""
-A curatable list of repositories relating to a repository owner, which defaults
-to showing the most popular repositories they own.
-"""
-type ProfileItemShowcase {
- """
- Whether or not the owner has pinned any repositories or gists.
- """
- hasPinnedItems: Boolean!
-
- """
- The repositories and gists in the showcase. If the profile owner has any
- pinned items, those will be returned. Otherwise, the profile owner's popular
- repositories will be returned.
- """
- items(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): PinnableItemConnection!
-}
-
-"""
-Represents any entity on GitHub that has a profile page.
-"""
-interface ProfileOwner {
- """
- Determine if this repository owner has any items that can be pinned to their profile.
- """
- anyPinnableItems(
- """
- Filter to only a particular kind of pinnable item.
- """
- type: PinnableItemType
- ): Boolean!
-
- """
- The public profile email.
- """
- email: String
- id: ID!
-
- """
- Showcases a selection of repositories and gists that the profile owner has
- either curated or that have been selected automatically based on popularity.
- """
- itemShowcase: ProfileItemShowcase!
-
- """
- The public profile location.
- """
- location: String
-
- """
- The username used to login.
- """
- login: String!
-
- """
- The public profile name.
- """
- name: String
-
- """
- A list of repositories and gists this profile owner can pin to their profile.
- """
- pinnableItems(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Filter the types of pinnable items that are returned.
- """
- types: [PinnableItemType!]
- ): PinnableItemConnection!
-
- """
- A list of repositories and gists this profile owner has pinned to their profile
- """
- pinnedItems(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Filter the types of pinned items that are returned.
- """
- types: [PinnableItemType!]
- ): PinnableItemConnection!
-
- """
- Returns how many more items this profile owner can pin to their profile.
- """
- pinnedItemsRemaining: Int!
-
- """
- Can the viewer pin repositories and gists to the profile?
- """
- viewerCanChangePinnedItems: Boolean!
-
- """
- The public profile website URL.
- """
- websiteUrl: URI
-}
-
-"""
-Projects manage issues, pull requests and notes within a project owner.
-"""
-type Project implements Closable & Node & Updatable {
- """
- The project's description body.
- """
- body: String
-
- """
- The projects description body rendered to HTML.
- """
- bodyHTML: HTML!
-
- """
- `true` if the object is closed (definition of closed may depend on type)
- """
- closed: Boolean!
-
- """
- Identifies the date and time when the object was closed.
- """
- closedAt: DateTime
-
- """
- List of columns in the project
- """
- columns(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): ProjectColumnConnection!
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- The actor who originally created the project.
- """
- creator: Actor
-
- """
- Identifies the primary key from the database.
- """
- databaseId: Int
- id: ID!
-
- """
- The project's name.
- """
- name: String!
-
- """
- The project's number.
- """
- number: Int!
-
- """
- The project's owner. Currently limited to repositories, organizations, and users.
- """
- owner: ProjectOwner!
-
- """
- List of pending cards in this project
- """
- pendingCards(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- A list of archived states to filter the cards by
- """
- archivedStates: [ProjectCardArchivedState] = [ARCHIVED, NOT_ARCHIVED]
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): ProjectCardConnection!
-
- """
- The HTTP path for this project
- """
- resourcePath: URI!
-
- """
- Whether the project is open or closed.
- """
- state: ProjectState!
-
- """
- Identifies the date and time when the object was last updated.
- """
- updatedAt: DateTime!
-
- """
- The HTTP URL for this project
- """
- url: URI!
-
- """
- Check if the current viewer can update this object.
- """
- viewerCanUpdate: Boolean!
-}
-
-"""
-A card in a project.
-"""
-type ProjectCard implements Node {
- """
- The project column this card is associated under. A card may only belong to one
- project column at a time. The column field will be null if the card is created
- in a pending state and has yet to be associated with a column. Once cards are
- associated with a column, they will not become pending in the future.
- """
- column: ProjectColumn
-
- """
- The card content item
- """
- content: ProjectCardItem
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- The actor who created this card
- """
- creator: Actor
-
- """
- Identifies the primary key from the database.
- """
- databaseId: Int
- id: ID!
-
- """
- Whether the card is archived
- """
- isArchived: Boolean!
-
- """
- The card note
- """
- note: String
-
- """
- The project that contains this card.
- """
- project: Project!
-
- """
- The HTTP path for this card
- """
- resourcePath: URI!
-
- """
- The state of ProjectCard
- """
- state: ProjectCardState
-
- """
- Identifies the date and time when the object was last updated.
- """
- updatedAt: DateTime!
-
- """
- The HTTP URL for this card
- """
- url: URI!
-}
-
-"""
-The possible archived states of a project card.
-"""
-enum ProjectCardArchivedState {
- """
- A project card that is archived
- """
- ARCHIVED
-
- """
- A project card that is not archived
- """
- NOT_ARCHIVED
-}
-
-"""
-The connection type for ProjectCard.
-"""
-type ProjectCardConnection {
- """
- A list of edges.
- """
- edges: [ProjectCardEdge]
-
- """
- A list of nodes.
- """
- nodes: [ProjectCard]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type ProjectCardEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: ProjectCard
-}
-
-"""
-An issue or PR and its owning repository to be used in a project card.
-"""
-input ProjectCardImport {
- """
- The issue or pull request number.
- """
- number: Int!
-
- """
- Repository name with owner (owner/repository).
- """
- repository: String!
-}
-
-"""
-Types that can be inside Project Cards.
-"""
-union ProjectCardItem = Issue | PullRequest
-
-"""
-Various content states of a ProjectCard
-"""
-enum ProjectCardState {
- """
- The card has content only.
- """
- CONTENT_ONLY
-
- """
- The card has a note only.
- """
- NOTE_ONLY
-
- """
- The card is redacted.
- """
- REDACTED
-}
-
-"""
-A column inside a project.
-"""
-type ProjectColumn implements Node {
- """
- List of cards in the column
- """
- cards(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- A list of archived states to filter the cards by
- """
- archivedStates: [ProjectCardArchivedState] = [ARCHIVED, NOT_ARCHIVED]
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): ProjectCardConnection!
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- Identifies the primary key from the database.
- """
- databaseId: Int
- id: ID!
-
- """
- The project column's name.
- """
- name: String!
-
- """
- The project that contains this column.
- """
- project: Project!
-
- """
- The semantic purpose of the column
- """
- purpose: ProjectColumnPurpose
-
- """
- The HTTP path for this project column
- """
- resourcePath: URI!
-
- """
- Identifies the date and time when the object was last updated.
- """
- updatedAt: DateTime!
-
- """
- The HTTP URL for this project column
- """
- url: URI!
-}
-
-"""
-The connection type for ProjectColumn.
-"""
-type ProjectColumnConnection {
- """
- A list of edges.
- """
- edges: [ProjectColumnEdge]
-
- """
- A list of nodes.
- """
- nodes: [ProjectColumn]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type ProjectColumnEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: ProjectColumn
-}
-
-"""
-A project column and a list of its issues and PRs.
-"""
-input ProjectColumnImport {
- """
- The name of the column.
- """
- columnName: String!
-
- """
- A list of issues and pull requests in the column.
- """
- issues: [ProjectCardImport!]
-
- """
- The position of the column, starting from 0.
- """
- position: Int!
-}
-
-"""
-The semantic purpose of the column - todo, in progress, or done.
-"""
-enum ProjectColumnPurpose {
- """
- The column contains cards which are complete
- """
- DONE
-
- """
- The column contains cards which are currently being worked on
- """
- IN_PROGRESS
-
- """
- The column contains cards still to be worked on
- """
- TODO
-}
-
-"""
-A list of projects associated with the owner.
-"""
-type ProjectConnection {
- """
- A list of edges.
- """
- edges: [ProjectEdge]
-
- """
- A list of nodes.
- """
- nodes: [Project]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type ProjectEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: Project
-}
-
-"""
-Ways in which lists of projects can be ordered upon return.
-"""
-input ProjectOrder {
- """
- The direction in which to order projects by the specified field.
- """
- direction: OrderDirection!
-
- """
- The field in which to order projects by.
- """
- field: ProjectOrderField!
-}
-
-"""
-Properties by which project connections can be ordered.
-"""
-enum ProjectOrderField {
- """
- Order projects by creation time
- """
- CREATED_AT
-
- """
- Order projects by name
- """
- NAME
-
- """
- Order projects by update time
- """
- UPDATED_AT
-}
-
-"""
-Represents an owner of a Project.
-"""
-interface ProjectOwner {
- id: ID!
-
- """
- Find project by number.
- """
- project(
- """
- The project number to find.
- """
- number: Int!
- ): Project
-
- """
- A list of projects under the owner.
- """
- projects(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for projects returned from the connection
- """
- orderBy: ProjectOrder
-
- """
- Query to search projects by, currently only searching by name.
- """
- search: String
-
- """
- A list of states to filter the projects by.
- """
- states: [ProjectState!]
- ): ProjectConnection!
-
- """
- The HTTP path listing owners projects
- """
- projectsResourcePath: URI!
-
- """
- The HTTP URL listing owners projects
- """
- projectsUrl: URI!
-
- """
- Can the current viewer create new projects on this owner.
- """
- viewerCanCreateProjects: Boolean!
-}
-
-"""
-State of the project; either 'open' or 'closed'
-"""
-enum ProjectState {
- """
- The project is closed.
- """
- CLOSED
-
- """
- The project is open.
- """
- OPEN
-}
-
-"""
-A user's public key.
-"""
-type PublicKey implements Node {
- """
- The last time this authorization was used to perform an action
- """
- accessedAt: DateTime
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- The fingerprint for this PublicKey
- """
- fingerprint: String
- id: ID!
-
- """
- Whether this PublicKey is read-only or not
- """
- isReadOnly: Boolean!
-
- """
- The public key string
- """
- key: String!
-
- """
- Identifies the date and time when the object was last updated.
- """
- updatedAt: DateTime!
-}
-
-"""
-The connection type for PublicKey.
-"""
-type PublicKeyConnection {
- """
- A list of edges.
- """
- edges: [PublicKeyEdge]
-
- """
- A list of nodes.
- """
- nodes: [PublicKey]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type PublicKeyEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: PublicKey
-}
-
-"""
-A repository pull request.
-"""
-type PullRequest implements Assignable & Closable & Comment & Labelable & Lockable & Node & Reactable & RepositoryNode & Subscribable & UniformResourceLocatable & Updatable & UpdatableComment {
- """
- Reason that the conversation was locked.
- """
- activeLockReason: LockReason
-
- """
- The number of additions in this pull request.
- """
- additions: Int!
-
- """
- A list of Users assigned to this object.
- """
- assignees(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): UserConnection!
-
- """
- The actor who authored the comment.
- """
- author: Actor
-
- """
- Author's association with the subject of the comment.
- """
- authorAssociation: CommentAuthorAssociation!
-
- """
- Identifies the base Ref associated with the pull request.
- """
- baseRef: Ref
-
- """
- Identifies the name of the base Ref associated with the pull request, even if the ref has been deleted.
- """
- baseRefName: String!
-
- """
- Identifies the oid of the base ref associated with the pull request, even if the ref has been deleted.
- """
- baseRefOid: GitObjectID!
-
- """
- The repository associated with this pull request's base Ref.
- """
- baseRepository: Repository
-
- """
- The body as Markdown.
- """
- body: String!
-
- """
- The body rendered to HTML.
- """
- bodyHTML: HTML!
-
- """
- The body rendered to text.
- """
- bodyText: String!
-
- """
- Whether or not the pull request is rebaseable.
- """
- canBeRebased: Boolean! @preview(toggledBy: "merge-info-preview")
-
- """
- The number of changed files in this pull request.
- """
- changedFiles: Int!
-
- """
- `true` if the pull request is closed
- """
- closed: Boolean!
-
- """
- Identifies the date and time when the object was closed.
- """
- closedAt: DateTime
-
- """
- A list of comments associated with the pull request.
- """
- comments(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): IssueCommentConnection!
-
- """
- A list of commits present in this pull request's head branch not present in the base branch.
- """
- commits(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): PullRequestCommitConnection!
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- Check if this comment was created via an email reply.
- """
- createdViaEmail: Boolean!
-
- """
- Identifies the primary key from the database.
- """
- databaseId: Int
-
- """
- The number of deletions in this pull request.
- """
- deletions: Int!
-
- """
- The actor who edited this pull request's body.
- """
- editor: Actor
-
- """
- Lists the files changed within this pull request.
- """
- files(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): PullRequestChangedFileConnection
-
- """
- Identifies the head Ref associated with the pull request.
- """
- headRef: Ref
-
- """
- Identifies the name of the head Ref associated with the pull request, even if the ref has been deleted.
- """
- headRefName: String!
-
- """
- Identifies the oid of the head ref associated with the pull request, even if the ref has been deleted.
- """
- headRefOid: GitObjectID!
-
- """
- The repository associated with this pull request's head Ref.
- """
- headRepository: Repository
-
- """
- The owner of the repository associated with this pull request's head Ref.
- """
- headRepositoryOwner: RepositoryOwner
-
- """
- The hovercard information for this issue
- """
- hovercard(
- """
- Whether or not to include notification contexts
- """
- includeNotificationContexts: Boolean = true
- ): Hovercard! @preview(toggledBy: "hagar-preview")
- id: ID!
-
- """
- Check if this comment was edited and includes an edit with the creation data
- """
- includesCreatedEdit: Boolean!
-
- """
- The head and base repositories are different.
- """
- isCrossRepository: Boolean!
-
- """
- Identifies if the pull request is a draft.
- """
- isDraft: Boolean! @preview(toggledBy: "shadow-cat-preview")
-
- """
- A list of labels associated with the object.
- """
- labels(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): LabelConnection
-
- """
- The moment the editor made the last edit
- """
- lastEditedAt: DateTime
-
- """
- `true` if the pull request is locked
- """
- locked: Boolean!
-
- """
- Indicates whether maintainers can modify the pull request.
- """
- maintainerCanModify: Boolean!
-
- """
- The commit that was created when this pull request was merged.
- """
- mergeCommit: Commit
-
- """
- Detailed information about the current pull request merge state status.
- """
- mergeStateStatus: MergeStateStatus! @preview(toggledBy: "merge-info-preview")
-
- """
- Whether or not the pull request can be merged based on the existence of merge conflicts.
- """
- mergeable: MergeableState!
-
- """
- Whether or not the pull request was merged.
- """
- merged: Boolean!
-
- """
- The date and time that the pull request was merged.
- """
- mergedAt: DateTime
-
- """
- The actor who merged the pull request.
- """
- mergedBy: Actor
-
- """
- Identifies the milestone associated with the pull request.
- """
- milestone: Milestone
-
- """
- Identifies the pull request number.
- """
- number: Int!
-
- """
- A list of Users that are participating in the Pull Request conversation.
- """
- participants(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): UserConnection!
-
- """
- The permalink to the pull request.
- """
- permalink: URI!
-
- """
- The commit that GitHub automatically generated to test if this pull request
- could be merged. This field will not return a value if the pull request is
- merged, or if the test merge commit is still being generated. See the
- `mergeable` field for more details on the mergeability of the pull request.
- """
- potentialMergeCommit: Commit
-
- """
- List of project cards associated with this pull request.
- """
- projectCards(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- A list of archived states to filter the cards by
- """
- archivedStates: [ProjectCardArchivedState] = [ARCHIVED, NOT_ARCHIVED]
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): ProjectCardConnection!
-
- """
- Identifies when the comment was published at.
- """
- publishedAt: DateTime
-
- """
- A list of reactions grouped by content left on the subject.
- """
- reactionGroups: [ReactionGroup!]
-
- """
- A list of Reactions left on the Issue.
- """
- reactions(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Allows filtering Reactions by emoji.
- """
- content: ReactionContent
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Allows specifying the order in which reactions are returned.
- """
- orderBy: ReactionOrder
- ): ReactionConnection!
-
- """
- The repository associated with this node.
- """
- repository: Repository!
-
- """
- The HTTP path for this pull request.
- """
- resourcePath: URI!
-
- """
- The HTTP path for reverting this pull request.
- """
- revertResourcePath: URI!
-
- """
- The HTTP URL for reverting this pull request.
- """
- revertUrl: URI!
-
- """
- A list of review requests associated with the pull request.
- """
- reviewRequests(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): ReviewRequestConnection
-
- """
- The list of all review threads for this pull request.
- """
- reviewThreads(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): PullRequestReviewThreadConnection!
-
- """
- A list of reviews associated with the pull request.
- """
- reviews(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Filter by author of the review.
- """
- author: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- A list of states to filter the reviews.
- """
- states: [PullRequestReviewState!]
- ): PullRequestReviewConnection
-
- """
- Identifies the state of the pull request.
- """
- state: PullRequestState!
-
- """
- A list of reviewer suggestions based on commit history and past review comments.
- """
- suggestedReviewers: [SuggestedReviewer]!
-
- """
- A list of events, comments, commits, etc. associated with the pull request.
- """
- timeline(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Allows filtering timeline events by a `since` timestamp.
- """
- since: DateTime
- ): PullRequestTimelineConnection!
-
- """
- A list of events, comments, commits, etc. associated with the pull request.
- """
- timelineItems(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Filter timeline items by type.
- """
- itemTypes: [PullRequestTimelineItemsItemType!]
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Filter timeline items by a `since` timestamp.
- """
- since: DateTime
-
- """
- Skips the first _n_ elements in the list.
- """
- skip: Int
- ): PullRequestTimelineItemsConnection!
-
- """
- Identifies the pull request title.
- """
- title: String!
-
- """
- Identifies the date and time when the object was last updated.
- """
- updatedAt: DateTime!
-
- """
- The HTTP URL for this pull request.
- """
- url: URI!
-
- """
- A list of edits to this content.
- """
- userContentEdits(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): UserContentEditConnection
-
- """
- Whether or not the viewer can apply suggestion.
- """
- viewerCanApplySuggestion: Boolean!
-
- """
- Can user react to this subject
- """
- viewerCanReact: Boolean!
-
- """
- Check if the viewer is able to change their subscription status for the repository.
- """
- viewerCanSubscribe: Boolean!
-
- """
- Check if the current viewer can update this object.
- """
- viewerCanUpdate: Boolean!
-
- """
- Reasons why the current viewer can not update this comment.
- """
- viewerCannotUpdateReasons: [CommentCannotUpdateReason!]!
-
- """
- Did the viewer author this comment.
- """
- viewerDidAuthor: Boolean!
-
- """
- Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
- """
- viewerSubscription: SubscriptionState
-}
-
-"""
-A file changed in a pull request.
-"""
-type PullRequestChangedFile {
- """
- The number of additions to the file.
- """
- additions: Int!
-
- """
- The number of deletions to the file.
- """
- deletions: Int!
-
- """
- The path of the file.
- """
- path: String!
-}
-
-"""
-The connection type for PullRequestChangedFile.
-"""
-type PullRequestChangedFileConnection {
- """
- A list of edges.
- """
- edges: [PullRequestChangedFileEdge]
-
- """
- A list of nodes.
- """
- nodes: [PullRequestChangedFile]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type PullRequestChangedFileEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: PullRequestChangedFile
-}
-
-"""
-Represents a Git commit part of a pull request.
-"""
-type PullRequestCommit implements Node & UniformResourceLocatable {
- """
- The Git commit object
- """
- commit: Commit!
- id: ID!
-
- """
- The pull request this commit belongs to
- """
- pullRequest: PullRequest!
-
- """
- The HTTP path for this pull request commit
- """
- resourcePath: URI!
-
- """
- The HTTP URL for this pull request commit
- """
- url: URI!
-}
-
-"""
-Represents a commit comment thread part of a pull request.
-"""
-type PullRequestCommitCommentThread implements Node & RepositoryNode {
- """
- The comments that exist in this thread.
- """
- comments(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): CommitCommentConnection!
-
- """
- The commit the comments were made on.
- """
- commit: Commit!
- id: ID!
-
- """
- The file the comments were made on.
- """
- path: String
-
- """
- The position in the diff for the commit that the comment was made on.
- """
- position: Int
-
- """
- The pull request this commit comment thread belongs to
- """
- pullRequest: PullRequest!
-
- """
- The repository associated with this node.
- """
- repository: Repository!
-}
-
-"""
-The connection type for PullRequestCommit.
-"""
-type PullRequestCommitConnection {
- """
- A list of edges.
- """
- edges: [PullRequestCommitEdge]
-
- """
- A list of nodes.
- """
- nodes: [PullRequestCommit]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type PullRequestCommitEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: PullRequestCommit
-}
-
-"""
-The connection type for PullRequest.
-"""
-type PullRequestConnection {
- """
- A list of edges.
- """
- edges: [PullRequestEdge]
-
- """
- A list of nodes.
- """
- nodes: [PullRequest]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-This aggregates pull requests opened by a user within one repository.
-"""
-type PullRequestContributionsByRepository {
- """
- The pull request contributions.
- """
- contributions(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for contributions returned from the connection.
- """
- orderBy: ContributionOrder = {field: OCCURRED_AT, direction: DESC}
- ): CreatedPullRequestContributionConnection!
-
- """
- The repository in which the pull requests were opened.
- """
- repository: Repository!
-}
-
-"""
-An edge in a connection.
-"""
-type PullRequestEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: PullRequest
-}
-
-"""
-Ways in which lists of issues can be ordered upon return.
-"""
-input PullRequestOrder {
- """
- The direction in which to order pull requests by the specified field.
- """
- direction: OrderDirection!
-
- """
- The field in which to order pull requests by.
- """
- field: PullRequestOrderField!
-}
-
-"""
-Properties by which pull_requests connections can be ordered.
-"""
-enum PullRequestOrderField {
- """
- Order pull_requests by creation time
- """
- CREATED_AT
-
- """
- Order pull_requests by update time
- """
- UPDATED_AT
-}
-
-"""
-A review object for a given pull request.
-"""
-type PullRequestReview implements Comment & Deletable & Node & Reactable & RepositoryNode & Updatable & UpdatableComment {
- """
- The actor who authored the comment.
- """
- author: Actor
-
- """
- Author's association with the subject of the comment.
- """
- authorAssociation: CommentAuthorAssociation!
-
- """
- Identifies the pull request review body.
- """
- body: String!
-
- """
- The body of this review rendered to HTML.
- """
- bodyHTML: HTML!
-
- """
- The body of this review rendered as plain text.
- """
- bodyText: String!
-
- """
- A list of review comments for the current pull request review.
- """
- comments(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): PullRequestReviewCommentConnection!
-
- """
- Identifies the commit associated with this pull request review.
- """
- commit: Commit
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- Check if this comment was created via an email reply.
- """
- createdViaEmail: Boolean!
-
- """
- Identifies the primary key from the database.
- """
- databaseId: Int
-
- """
- The actor who edited the comment.
- """
- editor: Actor
- id: ID!
-
- """
- Check if this comment was edited and includes an edit with the creation data
- """
- includesCreatedEdit: Boolean!
-
- """
- The moment the editor made the last edit
- """
- lastEditedAt: DateTime
-
- """
- A list of teams that this review was made on behalf of.
- """
- onBehalfOf(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): TeamConnection!
-
- """
- Identifies when the comment was published at.
- """
- publishedAt: DateTime
-
- """
- Identifies the pull request associated with this pull request review.
- """
- pullRequest: PullRequest!
-
- """
- A list of reactions grouped by content left on the subject.
- """
- reactionGroups: [ReactionGroup!]
-
- """
- A list of Reactions left on the Issue.
- """
- reactions(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Allows filtering Reactions by emoji.
- """
- content: ReactionContent
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Allows specifying the order in which reactions are returned.
- """
- orderBy: ReactionOrder
- ): ReactionConnection!
-
- """
- The repository associated with this node.
- """
- repository: Repository!
-
- """
- The HTTP path permalink for this PullRequestReview.
- """
- resourcePath: URI!
-
- """
- Identifies the current state of the pull request review.
- """
- state: PullRequestReviewState!
-
- """
- Identifies when the Pull Request Review was submitted
- """
- submittedAt: DateTime
-
- """
- Identifies the date and time when the object was last updated.
- """
- updatedAt: DateTime!
-
- """
- The HTTP URL permalink for this PullRequestReview.
- """
- url: URI!
-
- """
- A list of edits to this content.
- """
- userContentEdits(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): UserContentEditConnection
-
- """
- Check if the current viewer can delete this object.
- """
- viewerCanDelete: Boolean!
-
- """
- Can user react to this subject
- """
- viewerCanReact: Boolean!
-
- """
- Check if the current viewer can update this object.
- """
- viewerCanUpdate: Boolean!
-
- """
- Reasons why the current viewer can not update this comment.
- """
- viewerCannotUpdateReasons: [CommentCannotUpdateReason!]!
-
- """
- Did the viewer author this comment.
- """
- viewerDidAuthor: Boolean!
-}
-
-"""
-A review comment associated with a given repository pull request.
-"""
-type PullRequestReviewComment implements Comment & Deletable & Minimizable & Node & Reactable & RepositoryNode & Updatable & UpdatableComment {
- """
- The actor who authored the comment.
- """
- author: Actor
-
- """
- Author's association with the subject of the comment.
- """
- authorAssociation: CommentAuthorAssociation!
-
- """
- The comment body of this review comment.
- """
- body: String!
-
- """
- The comment body of this review comment rendered to HTML.
- """
- bodyHTML: HTML!
-
- """
- The comment body of this review comment rendered as plain text.
- """
- bodyText: String!
-
- """
- Identifies the commit associated with the comment.
- """
- commit: Commit!
-
- """
- Identifies when the comment was created.
- """
- createdAt: DateTime!
-
- """
- Check if this comment was created via an email reply.
- """
- createdViaEmail: Boolean!
-
- """
- Identifies the primary key from the database.
- """
- databaseId: Int
-
- """
- The diff hunk to which the comment applies.
- """
- diffHunk: String!
-
- """
- Identifies when the comment was created in a draft state.
- """
- draftedAt: DateTime!
-
- """
- The actor who edited the comment.
- """
- editor: Actor
- id: ID!
-
- """
- Check if this comment was edited and includes an edit with the creation data
- """
- includesCreatedEdit: Boolean!
-
- """
- Returns whether or not a comment has been minimized.
- """
- isMinimized: Boolean!
-
- """
- The moment the editor made the last edit
- """
- lastEditedAt: DateTime
-
- """
- Returns why the comment was minimized.
- """
- minimizedReason: String
-
- """
- Identifies the original commit associated with the comment.
- """
- originalCommit: Commit
-
- """
- The original line index in the diff to which the comment applies.
- """
- originalPosition: Int!
-
- """
- Identifies when the comment body is outdated
- """
- outdated: Boolean!
-
- """
- The path to which the comment applies.
- """
- path: String!
-
- """
- The line index in the diff to which the comment applies.
- """
- position: Int
-
- """
- Identifies when the comment was published at.
- """
- publishedAt: DateTime
-
- """
- The pull request associated with this review comment.
- """
- pullRequest: PullRequest!
-
- """
- The pull request review associated with this review comment.
- """
- pullRequestReview: PullRequestReview
-
- """
- A list of reactions grouped by content left on the subject.
- """
- reactionGroups: [ReactionGroup!]
-
- """
- A list of Reactions left on the Issue.
- """
- reactions(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Allows filtering Reactions by emoji.
- """
- content: ReactionContent
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Allows specifying the order in which reactions are returned.
- """
- orderBy: ReactionOrder
- ): ReactionConnection!
-
- """
- The comment this is a reply to.
- """
- replyTo: PullRequestReviewComment
-
- """
- The repository associated with this node.
- """
- repository: Repository!
-
- """
- The HTTP path permalink for this review comment.
- """
- resourcePath: URI!
-
- """
- Identifies the state of the comment.
- """
- state: PullRequestReviewCommentState!
-
- """
- Identifies when the comment was last updated.
- """
- updatedAt: DateTime!
-
- """
- The HTTP URL permalink for this review comment.
- """
- url: URI!
-
- """
- A list of edits to this content.
- """
- userContentEdits(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): UserContentEditConnection
-
- """
- Check if the current viewer can delete this object.
- """
- viewerCanDelete: Boolean!
-
- """
- Check if the current viewer can minimize this object.
- """
- viewerCanMinimize: Boolean!
-
- """
- Can user react to this subject
- """
- viewerCanReact: Boolean!
-
- """
- Check if the current viewer can update this object.
- """
- viewerCanUpdate: Boolean!
-
- """
- Reasons why the current viewer can not update this comment.
- """
- viewerCannotUpdateReasons: [CommentCannotUpdateReason!]!
-
- """
- Did the viewer author this comment.
- """
- viewerDidAuthor: Boolean!
-}
-
-"""
-The connection type for PullRequestReviewComment.
-"""
-type PullRequestReviewCommentConnection {
- """
- A list of edges.
- """
- edges: [PullRequestReviewCommentEdge]
-
- """
- A list of nodes.
- """
- nodes: [PullRequestReviewComment]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type PullRequestReviewCommentEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: PullRequestReviewComment
-}
-
-"""
-The possible states of a pull request review comment.
-"""
-enum PullRequestReviewCommentState {
- """
- A comment that is part of a pending review
- """
- PENDING
-
- """
- A comment that is part of a submitted review
- """
- SUBMITTED
-}
-
-"""
-The connection type for PullRequestReview.
-"""
-type PullRequestReviewConnection {
- """
- A list of edges.
- """
- edges: [PullRequestReviewEdge]
-
- """
- A list of nodes.
- """
- nodes: [PullRequestReview]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-This aggregates pull request reviews made by a user within one repository.
-"""
-type PullRequestReviewContributionsByRepository {
- """
- The pull request review contributions.
- """
- contributions(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for contributions returned from the connection.
- """
- orderBy: ContributionOrder = {field: OCCURRED_AT, direction: DESC}
- ): CreatedPullRequestReviewContributionConnection!
-
- """
- The repository in which the pull request reviews were made.
- """
- repository: Repository!
-}
-
-"""
-An edge in a connection.
-"""
-type PullRequestReviewEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: PullRequestReview
-}
-
-"""
-The possible events to perform on a pull request review.
-"""
-enum PullRequestReviewEvent {
- """
- Submit feedback and approve merging these changes.
- """
- APPROVE
-
- """
- Submit general feedback without explicit approval.
- """
- COMMENT
-
- """
- Dismiss review so it now longer effects merging.
- """
- DISMISS
-
- """
- Submit feedback that must be addressed before merging.
- """
- REQUEST_CHANGES
-}
-
-"""
-The possible states of a pull request review.
-"""
-enum PullRequestReviewState {
- """
- A review allowing the pull request to merge.
- """
- APPROVED
-
- """
- A review blocking the pull request from merging.
- """
- CHANGES_REQUESTED
-
- """
- An informational review.
- """
- COMMENTED
-
- """
- A review that has been dismissed.
- """
- DISMISSED
-
- """
- A review that has not yet been submitted.
- """
- PENDING
-}
-
-"""
-A threaded list of comments for a given pull request.
-"""
-type PullRequestReviewThread implements Node {
- """
- A list of pull request comments associated with the thread.
- """
- comments(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): PullRequestReviewCommentConnection!
- id: ID!
-
- """
- Whether this thread has been resolved
- """
- isResolved: Boolean!
-
- """
- Identifies the pull request associated with this thread.
- """
- pullRequest: PullRequest!
-
- """
- Identifies the repository associated with this thread.
- """
- repository: Repository!
-
- """
- The user who resolved this thread
- """
- resolvedBy: User
-
- """
- Whether or not the viewer can resolve this thread
- """
- viewerCanResolve: Boolean!
-
- """
- Whether or not the viewer can unresolve this thread
- """
- viewerCanUnresolve: Boolean!
-}
-
-"""
-Review comment threads for a pull request review.
-"""
-type PullRequestReviewThreadConnection {
- """
- A list of edges.
- """
- edges: [PullRequestReviewThreadEdge]
-
- """
- A list of nodes.
- """
- nodes: [PullRequestReviewThread]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type PullRequestReviewThreadEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: PullRequestReviewThread
-}
-
-"""
-Represents the latest point in the pull request timeline for which the viewer has seen the pull request's commits.
-"""
-type PullRequestRevisionMarker {
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- The last commit the viewer has seen.
- """
- lastSeenCommit: Commit!
-
- """
- The pull request to which the marker belongs.
- """
- pullRequest: PullRequest!
-}
-
-"""
-The possible states of a pull request.
-"""
-enum PullRequestState {
- """
- A pull request that has been closed without being merged.
- """
- CLOSED
-
- """
- A pull request that has been closed by being merged.
- """
- MERGED
-
- """
- A pull request that is still open.
- """
- OPEN
-}
-
-"""
-The connection type for PullRequestTimelineItem.
-"""
-type PullRequestTimelineConnection {
- """
- A list of edges.
- """
- edges: [PullRequestTimelineItemEdge]
-
- """
- A list of nodes.
- """
- nodes: [PullRequestTimelineItem]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An item in an pull request timeline
-"""
-union PullRequestTimelineItem = AssignedEvent | BaseRefForcePushedEvent | ClosedEvent | Commit | CommitCommentThread | CrossReferencedEvent | DemilestonedEvent | DeployedEvent | DeploymentEnvironmentChangedEvent | HeadRefDeletedEvent | HeadRefForcePushedEvent | HeadRefRestoredEvent | IssueComment | LabeledEvent | LockedEvent | MergedEvent | MilestonedEvent | PullRequestReview | PullRequestReviewComment | PullRequestReviewThread | ReferencedEvent | RenamedTitleEvent | ReopenedEvent | ReviewDismissedEvent | ReviewRequestRemovedEvent | ReviewRequestedEvent | SubscribedEvent | UnassignedEvent | UnlabeledEvent | UnlockedEvent | UnsubscribedEvent | UserBlockedEvent
-
-"""
-An edge in a connection.
-"""
-type PullRequestTimelineItemEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: PullRequestTimelineItem
-}
-
-"""
-An item in a pull request timeline
-"""
-union PullRequestTimelineItems = AddedToProjectEvent | AssignedEvent | BaseRefChangedEvent | BaseRefForcePushedEvent | ClosedEvent | CommentDeletedEvent | ConvertedNoteToIssueEvent | CrossReferencedEvent | DemilestonedEvent | DeployedEvent | DeploymentEnvironmentChangedEvent | HeadRefDeletedEvent | HeadRefForcePushedEvent | HeadRefRestoredEvent | IssueComment | LabeledEvent | LockedEvent | MentionedEvent | MergedEvent | MilestonedEvent | MovedColumnsInProjectEvent | PinnedEvent | PullRequestCommit | PullRequestCommitCommentThread | PullRequestReview | PullRequestReviewThread | PullRequestRevisionMarker | ReferencedEvent | RemovedFromProjectEvent | RenamedTitleEvent | ReopenedEvent | ReviewDismissedEvent | ReviewRequestRemovedEvent | ReviewRequestedEvent | SubscribedEvent | TransferredEvent | UnassignedEvent | UnlabeledEvent | UnlockedEvent | UnpinnedEvent | UnsubscribedEvent | UserBlockedEvent
-
-"""
-The connection type for PullRequestTimelineItems.
-"""
-type PullRequestTimelineItemsConnection {
- """
- A list of edges.
- """
- edges: [PullRequestTimelineItemsEdge]
-
- """
- Identifies the count of items after applying `before` and `after` filters.
- """
- filteredCount: Int!
-
- """
- A list of nodes.
- """
- nodes: [PullRequestTimelineItems]
-
- """
- Identifies the count of items after applying `before`/`after` filters and `first`/`last`/`skip` slicing.
- """
- pageCount: Int!
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-
- """
- Identifies the date and time when the timeline was last updated.
- """
- updatedAt: DateTime!
-}
-
-"""
-An edge in a connection.
-"""
-type PullRequestTimelineItemsEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: PullRequestTimelineItems
-}
-
-"""
-The possible item types found in a timeline.
-"""
-enum PullRequestTimelineItemsItemType {
- """
- Represents a 'added_to_project' event on a given issue or pull request.
- """
- ADDED_TO_PROJECT_EVENT
-
- """
- Represents an 'assigned' event on any assignable object.
- """
- ASSIGNED_EVENT
-
- """
- Represents a 'base_ref_changed' event on a given issue or pull request.
- """
- BASE_REF_CHANGED_EVENT
-
- """
- Represents a 'base_ref_force_pushed' event on a given pull request.
- """
- BASE_REF_FORCE_PUSHED_EVENT
-
- """
- Represents a 'closed' event on any `Closable`.
- """
- CLOSED_EVENT
-
- """
- Represents a 'comment_deleted' event on a given issue or pull request.
- """
- COMMENT_DELETED_EVENT
-
- """
- Represents a 'converted_note_to_issue' event on a given issue or pull request.
- """
- CONVERTED_NOTE_TO_ISSUE_EVENT
-
- """
- Represents a mention made by one issue or pull request to another.
- """
- CROSS_REFERENCED_EVENT
-
- """
- Represents a 'demilestoned' event on a given issue or pull request.
- """
- DEMILESTONED_EVENT
-
- """
- Represents a 'deployed' event on a given pull request.
- """
- DEPLOYED_EVENT
-
- """
- Represents a 'deployment_environment_changed' event on a given pull request.
- """
- DEPLOYMENT_ENVIRONMENT_CHANGED_EVENT
-
- """
- Represents a 'head_ref_deleted' event on a given pull request.
- """
- HEAD_REF_DELETED_EVENT
-
- """
- Represents a 'head_ref_force_pushed' event on a given pull request.
- """
- HEAD_REF_FORCE_PUSHED_EVENT
-
- """
- Represents a 'head_ref_restored' event on a given pull request.
- """
- HEAD_REF_RESTORED_EVENT
-
- """
- Represents a comment on an Issue.
- """
- ISSUE_COMMENT
-
- """
- Represents a 'labeled' event on a given issue or pull request.
- """
- LABELED_EVENT
-
- """
- Represents a 'locked' event on a given issue or pull request.
- """
- LOCKED_EVENT
-
- """
- Represents a 'mentioned' event on a given issue or pull request.
- """
- MENTIONED_EVENT
-
- """
- Represents a 'merged' event on a given pull request.
- """
- MERGED_EVENT
-
- """
- Represents a 'milestoned' event on a given issue or pull request.
- """
- MILESTONED_EVENT
-
- """
- Represents a 'moved_columns_in_project' event on a given issue or pull request.
- """
- MOVED_COLUMNS_IN_PROJECT_EVENT
-
- """
- Represents a 'pinned' event on a given issue or pull request.
- """
- PINNED_EVENT
-
- """
- Represents a Git commit part of a pull request.
- """
- PULL_REQUEST_COMMIT
-
- """
- Represents a commit comment thread part of a pull request.
- """
- PULL_REQUEST_COMMIT_COMMENT_THREAD
-
- """
- A review object for a given pull request.
- """
- PULL_REQUEST_REVIEW
-
- """
- A threaded list of comments for a given pull request.
- """
- PULL_REQUEST_REVIEW_THREAD
-
- """
- Represents the latest point in the pull request timeline for which the viewer has seen the pull request's commits.
- """
- PULL_REQUEST_REVISION_MARKER
-
- """
- Represents a 'referenced' event on a given `ReferencedSubject`.
- """
- REFERENCED_EVENT
-
- """
- Represents a 'removed_from_project' event on a given issue or pull request.
- """
- REMOVED_FROM_PROJECT_EVENT
-
- """
- Represents a 'renamed' event on a given issue or pull request
- """
- RENAMED_TITLE_EVENT
-
- """
- Represents a 'reopened' event on any `Closable`.
- """
- REOPENED_EVENT
-
- """
- Represents a 'review_dismissed' event on a given issue or pull request.
- """
- REVIEW_DISMISSED_EVENT
-
- """
- Represents an 'review_requested' event on a given pull request.
- """
- REVIEW_REQUESTED_EVENT
-
- """
- Represents an 'review_request_removed' event on a given pull request.
- """
- REVIEW_REQUEST_REMOVED_EVENT
-
- """
- Represents a 'subscribed' event on a given `Subscribable`.
- """
- SUBSCRIBED_EVENT
-
- """
- Represents a 'transferred' event on a given issue or pull request.
- """
- TRANSFERRED_EVENT
-
- """
- Represents an 'unassigned' event on any assignable object.
- """
- UNASSIGNED_EVENT
-
- """
- Represents an 'unlabeled' event on a given issue or pull request.
- """
- UNLABELED_EVENT
-
- """
- Represents an 'unlocked' event on a given issue or pull request.
- """
- UNLOCKED_EVENT
-
- """
- Represents an 'unpinned' event on a given issue or pull request.
- """
- UNPINNED_EVENT
-
- """
- Represents an 'unsubscribed' event on a given `Subscribable`.
- """
- UNSUBSCRIBED_EVENT
-
- """
- Represents a 'user_blocked' event on a given user.
- """
- USER_BLOCKED_EVENT
-}
-
-"""
-A Git push.
-"""
-type Push implements Node @preview(toggledBy: "antiope-preview") {
- id: ID!
-
- """
- The SHA after the push
- """
- nextSha: GitObjectID
-
- """
- The permalink for this push.
- """
- permalink: URI!
-
- """
- The SHA before the push
- """
- previousSha: GitObjectID
-
- """
- The user who pushed
- """
- pusher: User!
-
- """
- The repository that was pushed to
- """
- repository: Repository!
-}
-
-"""
-A team or user who has the ability to push to a protected branch.
-"""
-type PushAllowance implements Node {
- """
- The actor that can push.
- """
- actor: PushAllowanceActor
-
- """
- Identifies the branch protection rule associated with the allowed user or team.
- """
- branchProtectionRule: BranchProtectionRule
- id: ID!
-}
-
-"""
-Types that can be an actor.
-"""
-union PushAllowanceActor = Team | User
-
-"""
-The connection type for PushAllowance.
-"""
-type PushAllowanceConnection {
- """
- A list of edges.
- """
- edges: [PushAllowanceEdge]
-
- """
- A list of nodes.
- """
- nodes: [PushAllowance]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type PushAllowanceEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: PushAllowance
-}
-
-"""
-The query root of GitHub's GraphQL interface.
-"""
-type Query {
- """
- Look up a code of conduct by its key
- """
- codeOfConduct(
- """
- The code of conduct's key
- """
- key: String!
- ): CodeOfConduct
-
- """
- Look up a code of conduct by its key
- """
- codesOfConduct: [CodeOfConduct]
-
- """
- Look up an open source license by its key
- """
- license(
- """
- The license's downcased SPDX ID
- """
- key: String!
- ): License
-
- """
- Return a list of known open source licenses
- """
- licenses: [License]!
-
- """
- Return information about the GitHub instance
- """
- meta: GitHubMetadata!
-
- """
- Fetches an object given its ID.
- """
- node(
- """
- ID of the object.
- """
- id: ID!
- ): Node
-
- """
- Lookup nodes by a list of IDs.
- """
- nodes(
- """
- The list of node IDs.
- """
- ids: [ID!]!
- ): [Node]!
-
- """
- Lookup a organization by login.
- """
- organization(
- """
- The organization's login.
- """
- login: String!
- ): Organization
-
- """
- A list of organizations.
- """
- organizations(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): OrganizationConnection!
-
- """
- The client's rate limit information.
- """
- rateLimit(
- """
- If true, calculate the cost for the query without evaluating it
- """
- dryRun: Boolean = false
- ): RateLimit
-
- """
- Hack to workaround https://github.com/facebook/relay/issues/112 re-exposing the root query object
- """
- relay: Query!
-
- """
- Lookup a given repository by the owner and repository name.
- """
- repository(
- """
- The name of the repository
- """
- name: String!
-
- """
- The login field of a user or organization
- """
- owner: String!
- ): Repository
-
- """
- Lookup a repository owner (ie. either a User or an Organization) by login.
- """
- repositoryOwner(
- """
- The username to lookup the owner by.
- """
- login: String!
- ): RepositoryOwner
-
- """
- Lookup resource by a URL.
- """
- resource(
- """
- The URL.
- """
- url: URI!
- ): UniformResourceLocatable
-
- """
- Perform a search across resources.
- """
- search(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- The search string to look for.
- """
- query: String!
-
- """
- The types of search items to search within.
- """
- type: SearchType!
- ): SearchResultItemConnection!
-
- """
- GitHub Security Advisories
- """
- securityAdvisories(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Filter advisories to those published since a time in the past.
- """
- publishedSince: DateTime
-
- """
- Filter advisories to those updated since a time in the past.
- """
- updatedSince: DateTime
- ): SecurityAdvisoryConnection!
-
- """
- Fetch a Security Advisory by its GHSA ID
- """
- securityAdvisory(
- """
- GitHub Security Advisory ID.
- """
- ghsaId: String!
- ): SecurityAdvisory
-
- """
- Software Vulnerabilities documented by GitHub Security Advisories
- """
- securityVulnerabilities(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- An ecosystem to filter vulnerabilities by.
- """
- ecosystem: SecurityAdvisoryEcosystem
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- A package name to filter vulnerabilities by.
- """
- package: String
-
- """
- A list of severities to filter vulnerabilities by.
- """
- severities: [SecurityAdvisorySeverity!]
- ): SecurityVulnerabilityConnection!
-
- """
- Look up a topic by name.
- """
- topic(
- """
- The topic's name.
- """
- name: String!
- ): Topic
-
- """
- Lookup a user by login.
- """
- user(
- """
- The user's login.
- """
- login: String!
- ): User
-
- """
- A list of users.
- """
- users(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): UserConnection!
-
- """
- The currently authenticated user.
- """
- viewer: User!
-}
-
-"""
-Represents the client's rate limit.
-"""
-type RateLimit {
- """
- The point cost for the current query counting against the rate limit.
- """
- cost: Int!
-
- """
- The maximum number of points the client is permitted to consume in a 60 minute window.
- """
- limit: Int!
-
- """
- The maximum number of nodes this query may return
- """
- nodeCount: Int!
-
- """
- The number of points remaining in the current rate limit window.
- """
- remaining: Int!
-
- """
- The time at which the current rate limit window resets in UTC epoch seconds.
- """
- resetAt: DateTime!
-}
-
-"""
-Represents a subject that can be reacted on.
-"""
-interface Reactable {
- """
- Identifies the primary key from the database.
- """
- databaseId: Int
- id: ID!
-
- """
- A list of reactions grouped by content left on the subject.
- """
- reactionGroups: [ReactionGroup!]
-
- """
- A list of Reactions left on the Issue.
- """
- reactions(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Allows filtering Reactions by emoji.
- """
- content: ReactionContent
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Allows specifying the order in which reactions are returned.
- """
- orderBy: ReactionOrder
- ): ReactionConnection!
-
- """
- Can user react to this subject
- """
- viewerCanReact: Boolean!
-}
-
-"""
-The connection type for User.
-"""
-type ReactingUserConnection {
- """
- A list of edges.
- """
- edges: [ReactingUserEdge]
-
- """
- A list of nodes.
- """
- nodes: [User]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-Represents a user that's made a reaction.
-"""
-type ReactingUserEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
- node: User!
-
- """
- The moment when the user made the reaction.
- """
- reactedAt: DateTime!
-}
-
-"""
-An emoji reaction to a particular piece of content.
-"""
-type Reaction implements Node {
- """
- Identifies the emoji reaction.
- """
- content: ReactionContent!
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- Identifies the primary key from the database.
- """
- databaseId: Int
- id: ID!
-
- """
- The reactable piece of content
- """
- reactable: Reactable!
-
- """
- Identifies the user who created this reaction.
- """
- user: User
-}
-
-"""
-A list of reactions that have been left on the subject.
-"""
-type ReactionConnection {
- """
- A list of edges.
- """
- edges: [ReactionEdge]
-
- """
- A list of nodes.
- """
- nodes: [Reaction]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-
- """
- Whether or not the authenticated user has left a reaction on the subject.
- """
- viewerHasReacted: Boolean!
-}
-
-"""
-Emojis that can be attached to Issues, Pull Requests and Comments.
-"""
-enum ReactionContent {
- """
- Represents the 😕 emoji.
- """
- CONFUSED
-
- """
- Represents the 👀 emoji.
- """
- EYES
-
- """
- Represents the ❤️ emoji.
- """
- HEART
-
- """
- Represents the 🎉 emoji.
- """
- HOORAY
-
- """
- Represents the 😄 emoji.
- """
- LAUGH
-
- """
- Represents the 🚀 emoji.
- """
- ROCKET
-
- """
- Represents the 👎 emoji.
- """
- THUMBS_DOWN
-
- """
- Represents the 👍 emoji.
- """
- THUMBS_UP
-}
-
-"""
-An edge in a connection.
-"""
-type ReactionEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: Reaction
-}
-
-"""
-A group of emoji reactions to a particular piece of content.
-"""
-type ReactionGroup {
- """
- Identifies the emoji reaction.
- """
- content: ReactionContent!
-
- """
- Identifies when the reaction was created.
- """
- createdAt: DateTime
-
- """
- The subject that was reacted to.
- """
- subject: Reactable!
-
- """
- Users who have reacted to the reaction subject with the emotion represented by this reaction group
- """
- users(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): ReactingUserConnection!
-
- """
- Whether or not the authenticated user has left a reaction on the subject.
- """
- viewerHasReacted: Boolean!
-}
-
-"""
-Ways in which lists of reactions can be ordered upon return.
-"""
-input ReactionOrder {
- """
- The direction in which to order reactions by the specified field.
- """
- direction: OrderDirection!
-
- """
- The field in which to order reactions by.
- """
- field: ReactionOrderField!
-}
-
-"""
-A list of fields that reactions can be ordered by.
-"""
-enum ReactionOrderField {
- """
- Allows ordering a list of reactions by when they were created.
- """
- CREATED_AT
-}
-
-"""
-Represents a Git reference.
-"""
-type Ref implements Node {
- """
- A list of pull requests with this ref as the head ref.
- """
- associatedPullRequests(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- The base ref name to filter the pull requests by.
- """
- baseRefName: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- The head ref name to filter the pull requests by.
- """
- headRefName: String
-
- """
- A list of label names to filter the pull requests by.
- """
- labels: [String!]
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for pull requests returned from the connection.
- """
- orderBy: IssueOrder
-
- """
- A list of states to filter the pull requests by.
- """
- states: [PullRequestState!]
- ): PullRequestConnection!
- id: ID!
-
- """
- The ref name.
- """
- name: String!
-
- """
- The ref's prefix, such as `refs/heads/` or `refs/tags/`.
- """
- prefix: String!
-
- """
- The repository the ref belongs to.
- """
- repository: Repository!
-
- """
- The object the ref points to.
- """
- target: GitObject!
-}
-
-"""
-The connection type for Ref.
-"""
-type RefConnection {
- """
- A list of edges.
- """
- edges: [RefEdge]
-
- """
- A list of nodes.
- """
- nodes: [Ref]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type RefEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: Ref
-}
-
-"""
-Ways in which lists of git refs can be ordered upon return.
-"""
-input RefOrder {
- """
- The direction in which to order refs by the specified field.
- """
- direction: OrderDirection!
-
- """
- The field in which to order refs by.
- """
- field: RefOrderField!
-}
-
-"""
-Properties by which ref connections can be ordered.
-"""
-enum RefOrderField {
- """
- Order refs by their alphanumeric name
- """
- ALPHABETICAL
-
- """
- Order refs by underlying commit date if the ref prefix is refs/tags/
- """
- TAG_COMMIT_DATE
-}
-
-"""
-Represents a 'referenced' event on a given `ReferencedSubject`.
-"""
-type ReferencedEvent implements Node {
- """
- Identifies the actor who performed the event.
- """
- actor: Actor
-
- """
- Identifies the commit associated with the 'referenced' event.
- """
- commit: Commit
-
- """
- Identifies the repository associated with the 'referenced' event.
- """
- commitRepository: Repository!
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
- id: ID!
-
- """
- Reference originated in a different repository.
- """
- isCrossRepository: Boolean!
-
- """
- Checks if the commit message itself references the subject. Can be false in the case of a commit comment reference.
- """
- isDirectReference: Boolean!
-
- """
- Object referenced by event.
- """
- subject: ReferencedSubject!
-}
-
-"""
-Any referencable object
-"""
-union ReferencedSubject = Issue | PullRequest
-
-"""
-Represents an owner of a registry package.
-"""
-interface RegistryPackageOwner {
- id: ID!
-}
-
-"""
-Represents an interface to search packages on an object.
-"""
-interface RegistryPackageSearch {
- id: ID!
-}
-
-"""
-A release contains the content for a release.
-"""
-type Release implements Node & UniformResourceLocatable {
- """
- The author of the release
- """
- author: User
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- Identifies the description of the release.
- """
- description: String
- id: ID!
-
- """
- Whether or not the release is a draft
- """
- isDraft: Boolean!
-
- """
- Whether or not the release is a prerelease
- """
- isPrerelease: Boolean!
-
- """
- Identifies the title of the release.
- """
- name: String
-
- """
- Identifies the date and time when the release was created.
- """
- publishedAt: DateTime
-
- """
- List of releases assets which are dependent on this release.
- """
- releaseAssets(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- A list of names to filter the assets by.
- """
- name: String
- ): ReleaseAssetConnection!
-
- """
- The HTTP path for this issue
- """
- resourcePath: URI!
-
- """
- The Git tag the release points to
- """
- tag: Ref
-
- """
- The name of the release's Git tag
- """
- tagName: String!
-
- """
- Identifies the date and time when the object was last updated.
- """
- updatedAt: DateTime!
-
- """
- The HTTP URL for this issue
- """
- url: URI!
-}
-
-"""
-A release asset contains the content for a release asset.
-"""
-type ReleaseAsset implements Node {
- """
- The asset's content-type
- """
- contentType: String!
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- The number of times this asset was downloaded
- """
- downloadCount: Int!
-
- """
- Identifies the URL where you can download the release asset via the browser.
- """
- downloadUrl: URI!
- id: ID!
-
- """
- Identifies the title of the release asset.
- """
- name: String!
-
- """
- Release that the asset is associated with
- """
- release: Release
-
- """
- The size (in bytes) of the asset
- """
- size: Int!
-
- """
- Identifies the date and time when the object was last updated.
- """
- updatedAt: DateTime!
-
- """
- The user that performed the upload
- """
- uploadedBy: User!
-
- """
- Identifies the URL of the release asset.
- """
- url: URI!
-}
-
-"""
-The connection type for ReleaseAsset.
-"""
-type ReleaseAssetConnection {
- """
- A list of edges.
- """
- edges: [ReleaseAssetEdge]
-
- """
- A list of nodes.
- """
- nodes: [ReleaseAsset]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type ReleaseAssetEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: ReleaseAsset
-}
-
-"""
-The connection type for Release.
-"""
-type ReleaseConnection {
- """
- A list of edges.
- """
- edges: [ReleaseEdge]
-
- """
- A list of nodes.
- """
- nodes: [Release]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type ReleaseEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: Release
-}
-
-"""
-Ways in which lists of releases can be ordered upon return.
-"""
-input ReleaseOrder {
- """
- The direction in which to order releases by the specified field.
- """
- direction: OrderDirection!
-
- """
- The field in which to order releases by.
- """
- field: ReleaseOrderField!
-}
-
-"""
-Properties by which release connections can be ordered.
-"""
-enum ReleaseOrderField {
- """
- Order releases by creation time
- """
- CREATED_AT
-
- """
- Order releases alphabetically by name
- """
- NAME
-}
-
-"""
-Autogenerated input type of RemoveAssigneesFromAssignable
-"""
-input RemoveAssigneesFromAssignableInput {
- """
- The id of the assignable object to remove assignees from.
- """
- assignableId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "Assignable")
-
- """
- The id of users to remove as assignees.
- """
- assigneeIds: [ID!]! @possibleTypes(concreteTypes: ["User"])
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-}
-
-"""
-Autogenerated return type of RemoveAssigneesFromAssignable
-"""
-type RemoveAssigneesFromAssignablePayload {
- """
- The item that was unassigned.
- """
- assignable: Assignable
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-}
-
-"""
-Autogenerated input type of RemoveLabelsFromLabelable
-"""
-input RemoveLabelsFromLabelableInput {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The ids of labels to remove.
- """
- labelIds: [ID!]! @possibleTypes(concreteTypes: ["Label"])
-
- """
- The id of the Labelable to remove labels from.
- """
- labelableId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "Labelable")
-}
-
-"""
-Autogenerated return type of RemoveLabelsFromLabelable
-"""
-type RemoveLabelsFromLabelablePayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The Labelable the labels were removed from.
- """
- labelable: Labelable
-}
-
-"""
-Autogenerated input type of RemoveOutsideCollaborator
-"""
-input RemoveOutsideCollaboratorInput {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The ID of the organization to remove the outside collaborator from.
- """
- organizationId: ID! @possibleTypes(concreteTypes: ["Organization"])
-
- """
- The ID of the outside collaborator to remove.
- """
- userId: ID! @possibleTypes(concreteTypes: ["User"])
-}
-
-"""
-Autogenerated return type of RemoveOutsideCollaborator
-"""
-type RemoveOutsideCollaboratorPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The user that was removed as an outside collaborator.
- """
- removedUser: User
-}
-
-"""
-Autogenerated input type of RemoveReaction
-"""
-input RemoveReactionInput {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The name of the emoji reaction to remove.
- """
- content: ReactionContent!
-
- """
- The Node ID of the subject to modify.
- """
- subjectId: ID! @possibleTypes(concreteTypes: ["CommitComment", "Issue", "IssueComment", "PullRequest", "PullRequestReview", "PullRequestReviewComment", "TeamDiscussion", "TeamDiscussionComment"], abstractType: "Reactable")
-}
-
-"""
-Autogenerated return type of RemoveReaction
-"""
-type RemoveReactionPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The reaction object.
- """
- reaction: Reaction
-
- """
- The reactable subject.
- """
- subject: Reactable
-}
-
-"""
-Autogenerated input type of RemoveStar
-"""
-input RemoveStarInput {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The Starrable ID to unstar.
- """
- starrableId: ID! @possibleTypes(concreteTypes: ["Gist", "Repository", "Topic"], abstractType: "Starrable")
-}
-
-"""
-Autogenerated return type of RemoveStar
-"""
-type RemoveStarPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The starrable.
- """
- starrable: Starrable
-}
-
-"""
-Represents a 'removed_from_project' event on a given issue or pull request.
-"""
-type RemovedFromProjectEvent implements Node {
- """
- Identifies the actor who performed the event.
- """
- actor: Actor
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- Identifies the primary key from the database.
- """
- databaseId: Int
- id: ID!
-
- """
- Project referenced by event.
- """
- project: Project @preview(toggledBy: "starfox-preview")
-
- """
- Column name referenced by this project event.
- """
- projectColumnName: String! @preview(toggledBy: "starfox-preview")
-}
-
-"""
-Represents a 'renamed' event on a given issue or pull request
-"""
-type RenamedTitleEvent implements Node {
- """
- Identifies the actor who performed the event.
- """
- actor: Actor
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- Identifies the current title of the issue or pull request.
- """
- currentTitle: String!
- id: ID!
-
- """
- Identifies the previous title of the issue or pull request.
- """
- previousTitle: String!
-
- """
- Subject that was renamed.
- """
- subject: RenamedTitleSubject!
-}
-
-"""
-An object which has a renamable title
-"""
-union RenamedTitleSubject = Issue | PullRequest
-
-"""
-Autogenerated input type of ReopenIssue
-"""
-input ReopenIssueInput {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- ID of the issue to be opened.
- """
- issueId: ID! @possibleTypes(concreteTypes: ["Issue"])
-}
-
-"""
-Autogenerated return type of ReopenIssue
-"""
-type ReopenIssuePayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The issue that was opened.
- """
- issue: Issue
-}
-
-"""
-Autogenerated input type of ReopenPullRequest
-"""
-input ReopenPullRequestInput {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- ID of the pull request to be reopened.
- """
- pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"])
-}
-
-"""
-Autogenerated return type of ReopenPullRequest
-"""
-type ReopenPullRequestPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The pull request that was reopened.
- """
- pullRequest: PullRequest
-}
-
-"""
-Represents a 'reopened' event on any `Closable`.
-"""
-type ReopenedEvent implements Node {
- """
- Identifies the actor who performed the event.
- """
- actor: Actor
-
- """
- Object that was reopened.
- """
- closable: Closable!
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
- id: ID!
-}
-
-"""
-The reasons a piece of content can be reported or minimized.
-"""
-enum ReportedContentClassifiers {
- """
- An irrelevant piece of content
- """
- OFF_TOPIC
-
- """
- An outdated piece of content
- """
- OUTDATED
-
- """
- The content has been resolved
- """
- RESOLVED
-}
-
-"""
-A repository contains the content for a project.
-"""
-type Repository implements Node & ProjectOwner & RegistryPackageOwner & RepositoryInfo & Starrable & Subscribable & UniformResourceLocatable {
- """
- A list of users that can be assigned to issues in this repository.
- """
- assignableUsers(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): UserConnection!
-
- """
- A list of branch protection rules for this repository.
- """
- branchProtectionRules(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): BranchProtectionRuleConnection!
-
- """
- Returns the code of conduct for this repository
- """
- codeOfConduct: CodeOfConduct
-
- """
- A list of collaborators associated with the repository.
- """
- collaborators(
- """
- Collaborators affiliation level with a repository.
- """
- affiliation: CollaboratorAffiliation
-
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): RepositoryCollaboratorConnection
-
- """
- A list of commit comments associated with the repository.
- """
- commitComments(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): CommitCommentConnection!
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- Identifies the primary key from the database.
- """
- databaseId: Int
-
- """
- The Ref associated with the repository's default branch.
- """
- defaultBranchRef: Ref
-
- """
- A list of deploy keys that are on this repository.
- """
- deployKeys(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): DeployKeyConnection!
-
- """
- Deployments associated with the repository
- """
- deployments(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Environments to list deployments for
- """
- environments: [String!]
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for deployments returned from the connection.
- """
- orderBy: DeploymentOrder = {field: CREATED_AT, direction: ASC}
- ): DeploymentConnection!
-
- """
- The description of the repository.
- """
- description: String
-
- """
- The description of the repository rendered to HTML.
- """
- descriptionHTML: HTML!
-
- """
- The number of kilobytes this repository occupies on disk.
- """
- diskUsage: Int
-
- """
- Returns how many forks there are of this repository in the whole network.
- """
- forkCount: Int!
-
- """
- A list of direct forked repositories.
- """
- forks(
- """
- Array of viewer's affiliation options for repositories returned from the
- connection. For example, OWNER will include only repositories that the
- current viewer owns.
- """
- affiliations: [RepositoryAffiliation] = [OWNER, COLLABORATOR]
-
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- If non-null, filters repositories according to whether they have been locked
- """
- isLocked: Boolean
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for repositories returned from the connection
- """
- orderBy: RepositoryOrder
-
- """
- Array of owner's affiliation options for repositories returned from the
- connection. For example, OWNER will include only repositories that the
- organization or user being viewed owns.
- """
- ownerAffiliations: [RepositoryAffiliation] = [OWNER, COLLABORATOR]
-
- """
- If non-null, filters repositories according to privacy
- """
- privacy: RepositoryPrivacy
- ): RepositoryConnection!
-
- """
- Indicates if the repository has anonymous Git read access feature enabled.
- """
- hasAnonymousAccessEnabled: Boolean!
-
- """
- Indicates if the repository has issues feature enabled.
- """
- hasIssuesEnabled: Boolean!
-
- """
- Indicates if the repository has wiki feature enabled.
- """
- hasWikiEnabled: Boolean!
-
- """
- The repository's URL.
- """
- homepageUrl: URI
- id: ID!
-
- """
- Indicates if the repository is unmaintained.
- """
- isArchived: Boolean!
-
- """
- Returns whether or not this repository disabled.
- """
- isDisabled: Boolean!
-
- """
- Identifies if the repository is a fork.
- """
- isFork: Boolean!
-
- """
- Indicates if the repository has been locked or not.
- """
- isLocked: Boolean!
-
- """
- Identifies if the repository is a mirror.
- """
- isMirror: Boolean!
-
- """
- Identifies if the repository is private.
- """
- isPrivate: Boolean!
-
- """
- Returns a single issue from the current repository by number.
- """
- issue(
- """
- The number for the issue to be returned.
- """
- number: Int!
- ): Issue
-
- """
- Returns a single issue-like object from the current repository by number.
- """
- issueOrPullRequest(
- """
- The number for the issue to be returned.
- """
- number: Int!
- ): IssueOrPullRequest
-
- """
- A list of issues that have been opened in the repository.
- """
- issues(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Filtering options for issues returned from the connection.
- """
- filterBy: IssueFilters
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- A list of label names to filter the pull requests by.
- """
- labels: [String!]
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for issues returned from the connection.
- """
- orderBy: IssueOrder
-
- """
- A list of states to filter the issues by.
- """
- states: [IssueState!]
- ): IssueConnection!
-
- """
- Returns a single label by name
- """
- label(
- """
- Label name
- """
- name: String!
- ): Label
-
- """
- A list of labels associated with the repository.
- """
- labels(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- If provided, searches labels by name and description.
- """
- query: String
- ): LabelConnection
-
- """
- A list containing a breakdown of the language composition of the repository.
- """
- languages(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Order for connection
- """
- orderBy: LanguageOrder
- ): LanguageConnection
-
- """
- The license associated with the repository
- """
- licenseInfo: License
-
- """
- The reason the repository has been locked.
- """
- lockReason: RepositoryLockReason
-
- """
- A list of Users that can be mentioned in the context of the repository.
- """
- mentionableUsers(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): UserConnection!
-
- """
- Whether or not PRs are merged with a merge commit on this repository.
- """
- mergeCommitAllowed: Boolean!
-
- """
- Returns a single milestone from the current repository by number.
- """
- milestone(
- """
- The number for the milestone to be returned.
- """
- number: Int!
- ): Milestone
-
- """
- A list of milestones associated with the repository.
- """
- milestones(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for milestones.
- """
- orderBy: MilestoneOrder
-
- """
- Filter by the state of the milestones.
- """
- states: [MilestoneState!]
- ): MilestoneConnection
-
- """
- The repository's original mirror URL.
- """
- mirrorUrl: URI
-
- """
- The name of the repository.
- """
- name: String!
-
- """
- The repository's name with owner.
- """
- nameWithOwner: String!
-
- """
- A Git object in the repository
- """
- object(
- """
- A Git revision expression suitable for rev-parse
- """
- expression: String
-
- """
- The Git object ID
- """
- oid: GitObjectID
- ): GitObject
-
- """
- The User owner of the repository.
- """
- owner: RepositoryOwner!
-
- """
- The repository parent, if this is a fork.
- """
- parent: Repository
-
- """
- A list of pinned issues for this repository.
- """
- pinnedIssues(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): PinnedIssueConnection @preview(toggledBy: "elektra-preview")
-
- """
- The primary language of the repository's code.
- """
- primaryLanguage: Language
-
- """
- Find project by number.
- """
- project(
- """
- The project number to find.
- """
- number: Int!
- ): Project
-
- """
- A list of projects under the owner.
- """
- projects(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for projects returned from the connection
- """
- orderBy: ProjectOrder
-
- """
- Query to search projects by, currently only searching by name.
- """
- search: String
-
- """
- A list of states to filter the projects by.
- """
- states: [ProjectState!]
- ): ProjectConnection!
-
- """
- The HTTP path listing the repository's projects
- """
- projectsResourcePath: URI!
-
- """
- The HTTP URL listing the repository's projects
- """
- projectsUrl: URI!
-
- """
- Returns a single pull request from the current repository by number.
- """
- pullRequest(
- """
- The number for the pull request to be returned.
- """
- number: Int!
- ): PullRequest
-
- """
- A list of pull requests that have been opened in the repository.
- """
- pullRequests(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- The base ref name to filter the pull requests by.
- """
- baseRefName: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- The head ref name to filter the pull requests by.
- """
- headRefName: String
-
- """
- A list of label names to filter the pull requests by.
- """
- labels: [String!]
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for pull requests returned from the connection.
- """
- orderBy: IssueOrder
-
- """
- A list of states to filter the pull requests by.
- """
- states: [PullRequestState!]
- ): PullRequestConnection!
-
- """
- Identifies when the repository was last pushed to.
- """
- pushedAt: DateTime
-
- """
- Whether or not rebase-merging is enabled on this repository.
- """
- rebaseMergeAllowed: Boolean!
-
- """
- Fetch a given ref from the repository
- """
- ref(
- """
- The ref to retrieve. Fully qualified matches are checked in order
- (`refs/heads/master`) before falling back onto checks for short name matches (`master`).
- """
- qualifiedName: String!
- ): Ref
-
- """
- Fetch a list of refs from the repository
- """
- refs(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- DEPRECATED: use orderBy. The ordering direction.
- """
- direction: OrderDirection
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for refs returned from the connection.
- """
- orderBy: RefOrder
-
- """
- A ref name prefix like `refs/heads/`, `refs/tags/`, etc.
- """
- refPrefix: String!
- ): RefConnection
-
- """
- Lookup a single release given various criteria.
- """
- release(
- """
- The name of the Tag the Release was created from
- """
- tagName: String!
- ): Release
-
- """
- List of releases which are dependent on this repository.
- """
- releases(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Order for connection
- """
- orderBy: ReleaseOrder
- ): ReleaseConnection!
-
- """
- A list of applied repository-topic associations for this repository.
- """
- repositoryTopics(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): RepositoryTopicConnection!
-
- """
- The HTTP path for this repository
- """
- resourcePath: URI!
-
- """
- A description of the repository, rendered to HTML without any links in it.
- """
- shortDescriptionHTML(
- """
- How many characters to return.
- """
- limit: Int = 200
- ): HTML!
-
- """
- Whether or not squash-merging is enabled on this repository.
- """
- squashMergeAllowed: Boolean!
-
- """
- The SSH URL to clone this repository
- """
- sshUrl: GitSSHRemote!
-
- """
- A list of users who have starred this starrable.
- """
- stargazers(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Order for connection
- """
- orderBy: StarOrder
- ): StargazerConnection!
-
- """
- Temporary authentication token for cloning this repository.
- """
- tempCloneToken: String @preview(toggledBy: "daredevil-preview")
-
- """
- Identifies the date and time when the object was last updated.
- """
- updatedAt: DateTime!
-
- """
- The HTTP URL for this repository
- """
- url: URI!
-
- """
- Indicates whether the viewer has admin permissions on this repository.
- """
- viewerCanAdminister: Boolean!
-
- """
- Can the current viewer create new projects on this owner.
- """
- viewerCanCreateProjects: Boolean!
-
- """
- Check if the viewer is able to change their subscription status for the repository.
- """
- viewerCanSubscribe: Boolean!
-
- """
- Indicates whether the viewer can update the topics of this repository.
- """
- viewerCanUpdateTopics: Boolean!
-
- """
- Returns a boolean indicating whether the viewing user has starred this starrable.
- """
- viewerHasStarred: Boolean!
-
- """
- The users permission level on the repository. Will return null if authenticated as an GitHub App.
- """
- viewerPermission: RepositoryPermission
-
- """
- Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
- """
- viewerSubscription: SubscriptionState
-
- """
- A list of vulnerability alerts that are on this repository.
- """
- vulnerabilityAlerts(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): RepositoryVulnerabilityAlertConnection @preview(toggledBy: "vixen-preview")
-
- """
- A list of users watching the repository.
- """
- watchers(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): UserConnection!
-}
-
-"""
-The affiliation of a user to a repository
-"""
-enum RepositoryAffiliation {
- """
- Repositories that the user has been added to as a collaborator.
- """
- COLLABORATOR
-
- """
- Repositories that the user has access to through being a member of an
- organization. This includes every repository on every team that the user is on.
- """
- ORGANIZATION_MEMBER
-
- """
- Repositories that are owned by the authenticated user.
- """
- OWNER
-}
-
-"""
-The connection type for User.
-"""
-type RepositoryCollaboratorConnection {
- """
- A list of edges.
- """
- edges: [RepositoryCollaboratorEdge]
-
- """
- A list of nodes.
- """
- nodes: [User]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-Represents a user who is a collaborator of a repository.
-"""
-type RepositoryCollaboratorEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
- node: User!
-
- """
- The permission the user has on the repository.
- """
- permission: RepositoryPermission!
-
- """
- A list of sources for the user's access to the repository.
- """
- permissionSources: [PermissionSource!]
-}
-
-"""
-A list of repositories owned by the subject.
-"""
-type RepositoryConnection {
- """
- A list of edges.
- """
- edges: [RepositoryEdge]
-
- """
- A list of nodes.
- """
- nodes: [Repository]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-
- """
- The total size in kilobytes of all repositories in the connection.
- """
- totalDiskUsage: Int!
-}
-
-"""
-The reason a repository is listed as 'contributed'.
-"""
-enum RepositoryContributionType {
- """
- Created a commit
- """
- COMMIT
-
- """
- Created an issue
- """
- ISSUE
-
- """
- Created a pull request
- """
- PULL_REQUEST
-
- """
- Reviewed a pull request
- """
- PULL_REQUEST_REVIEW
-
- """
- Created the repository
- """
- REPOSITORY
-}
-
-"""
-An edge in a connection.
-"""
-type RepositoryEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: Repository
-}
-
-"""
-A subset of repository info.
-"""
-interface RepositoryInfo {
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- The description of the repository.
- """
- description: String
-
- """
- The description of the repository rendered to HTML.
- """
- descriptionHTML: HTML!
-
- """
- Returns how many forks there are of this repository in the whole network.
- """
- forkCount: Int!
-
- """
- Indicates if the repository has anonymous Git read access feature enabled.
- """
- hasAnonymousAccessEnabled: Boolean!
-
- """
- Indicates if the repository has issues feature enabled.
- """
- hasIssuesEnabled: Boolean!
-
- """
- Indicates if the repository has wiki feature enabled.
- """
- hasWikiEnabled: Boolean!
-
- """
- The repository's URL.
- """
- homepageUrl: URI
-
- """
- Indicates if the repository is unmaintained.
- """
- isArchived: Boolean!
-
- """
- Identifies if the repository is a fork.
- """
- isFork: Boolean!
-
- """
- Indicates if the repository has been locked or not.
- """
- isLocked: Boolean!
-
- """
- Identifies if the repository is a mirror.
- """
- isMirror: Boolean!
-
- """
- Identifies if the repository is private.
- """
- isPrivate: Boolean!
-
- """
- The license associated with the repository
- """
- licenseInfo: License
-
- """
- The reason the repository has been locked.
- """
- lockReason: RepositoryLockReason
-
- """
- The repository's original mirror URL.
- """
- mirrorUrl: URI
-
- """
- The name of the repository.
- """
- name: String!
-
- """
- The repository's name with owner.
- """
- nameWithOwner: String!
-
- """
- The User owner of the repository.
- """
- owner: RepositoryOwner!
-
- """
- Identifies when the repository was last pushed to.
- """
- pushedAt: DateTime
-
- """
- The HTTP path for this repository
- """
- resourcePath: URI!
-
- """
- A description of the repository, rendered to HTML without any links in it.
- """
- shortDescriptionHTML(
- """
- How many characters to return.
- """
- limit: Int = 200
- ): HTML!
-
- """
- Identifies the date and time when the object was last updated.
- """
- updatedAt: DateTime!
-
- """
- The HTTP URL for this repository
- """
- url: URI!
-}
-
-"""
-An invitation for a user to be added to a repository.
-"""
-type RepositoryInvitation implements Node {
- id: ID!
-
- """
- The user who received the invitation.
- """
- invitee: User!
-
- """
- The user who created the invitation.
- """
- inviter: User!
-
- """
- The permission granted on this repository by this invitation.
- """
- permission: RepositoryPermission!
-
- """
- The Repository the user is invited to.
- """
- repository: RepositoryInfo
-}
-
-"""
-The possible reasons a given repository could be in a locked state.
-"""
-enum RepositoryLockReason {
- """
- The repository is locked due to a billing related reason.
- """
- BILLING
-
- """
- The repository is locked due to a migration.
- """
- MIGRATING
-
- """
- The repository is locked due to a move.
- """
- MOVING
-
- """
- The repository is locked due to a rename.
- """
- RENAME
-}
-
-"""
-Represents a object that belongs to a repository.
-"""
-interface RepositoryNode {
- """
- The repository associated with this node.
- """
- repository: Repository!
-}
-
-"""
-Ordering options for repository connections
-"""
-input RepositoryOrder {
- """
- The ordering direction.
- """
- direction: OrderDirection!
-
- """
- The field to order repositories by.
- """
- field: RepositoryOrderField!
-}
-
-"""
-Properties by which repository connections can be ordered.
-"""
-enum RepositoryOrderField {
- """
- Order repositories by creation time
- """
- CREATED_AT
-
- """
- Order repositories by name
- """
- NAME
-
- """
- Order repositories by push time
- """
- PUSHED_AT
-
- """
- Order repositories by number of stargazers
- """
- STARGAZERS
-
- """
- Order repositories by update time
- """
- UPDATED_AT
-}
-
-"""
-Represents an owner of a Repository.
-"""
-interface RepositoryOwner {
- """
- A URL pointing to the owner's public avatar.
- """
- avatarUrl(
- """
- The size of the resulting square image.
- """
- size: Int
- ): URI!
- id: ID!
-
- """
- The username used to login.
- """
- login: String!
-
- """
- A list of repositories this user has pinned to their profile
- """
- pinnedRepositories(
- """
- Array of viewer's affiliation options for repositories returned from the
- connection. For example, OWNER will include only repositories that the
- current viewer owns.
- """
- affiliations: [RepositoryAffiliation] = [OWNER, COLLABORATOR]
-
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- If non-null, filters repositories according to whether they have been locked
- """
- isLocked: Boolean
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for repositories returned from the connection
- """
- orderBy: RepositoryOrder
-
- """
- Array of owner's affiliation options for repositories returned from the
- connection. For example, OWNER will include only repositories that the
- organization or user being viewed owns.
- """
- ownerAffiliations: [RepositoryAffiliation] = [OWNER, COLLABORATOR]
-
- """
- If non-null, filters repositories according to privacy
- """
- privacy: RepositoryPrivacy
- ): RepositoryConnection! @deprecated(reason: "pinnedRepositories will be removed Use ProfileOwner.pinnedItems instead. Removal on 2019-07-01 UTC.")
-
- """
- A list of repositories that the user owns.
- """
- repositories(
- """
- Array of viewer's affiliation options for repositories returned from the
- connection. For example, OWNER will include only repositories that the
- current viewer owns.
- """
- affiliations: [RepositoryAffiliation] = [OWNER, COLLABORATOR]
-
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- If non-null, filters repositories according to whether they are forks of another repository
- """
- isFork: Boolean
-
- """
- If non-null, filters repositories according to whether they have been locked
- """
- isLocked: Boolean
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for repositories returned from the connection
- """
- orderBy: RepositoryOrder
-
- """
- Array of owner's affiliation options for repositories returned from the
- connection. For example, OWNER will include only repositories that the
- organization or user being viewed owns.
- """
- ownerAffiliations: [RepositoryAffiliation] = [OWNER, COLLABORATOR]
-
- """
- If non-null, filters repositories according to privacy
- """
- privacy: RepositoryPrivacy
- ): RepositoryConnection!
-
- """
- Find Repository.
- """
- repository(
- """
- Name of Repository to find.
- """
- name: String!
- ): Repository
-
- """
- The HTTP URL for the owner.
- """
- resourcePath: URI!
-
- """
- The HTTP URL for the owner.
- """
- url: URI!
-}
-
-"""
-The access level to a repository
-"""
-enum RepositoryPermission {
- """
- Can read, clone, push, and add collaborators
- """
- ADMIN
-
- """
- Can read and clone
- """
- READ
-
- """
- Can read, clone and push
- """
- WRITE
-}
-
-"""
-The privacy of a repository
-"""
-enum RepositoryPrivacy {
- """
- Private
- """
- PRIVATE
-
- """
- Public
- """
- PUBLIC
-}
-
-"""
-A repository-topic connects a repository to a topic.
-"""
-type RepositoryTopic implements Node & UniformResourceLocatable {
- id: ID!
-
- """
- The HTTP path for this repository-topic.
- """
- resourcePath: URI!
-
- """
- The topic.
- """
- topic: Topic!
-
- """
- The HTTP URL for this repository-topic.
- """
- url: URI!
-}
-
-"""
-The connection type for RepositoryTopic.
-"""
-type RepositoryTopicConnection {
- """
- A list of edges.
- """
- edges: [RepositoryTopicEdge]
-
- """
- A list of nodes.
- """
- nodes: [RepositoryTopic]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type RepositoryTopicEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: RepositoryTopic
-}
-
-"""
-A alert for a repository with an affected vulnerability.
-"""
-type RepositoryVulnerabilityAlert implements Node & RepositoryNode @preview(toggledBy: "vixen-preview") {
- """
- The reason the alert was dismissed
- """
- dismissReason: String
-
- """
- When was the alert dimissed?
- """
- dismissedAt: DateTime
-
- """
- The user who dismissed the alert
- """
- dismisser: User
- id: ID!
-
- """
- The associated repository
- """
- repository: Repository!
-
- """
- The associated security advisory
- """
- securityAdvisory: SecurityAdvisory
-
- """
- The associated security vulnerablity
- """
- securityVulnerability: SecurityVulnerability
-
- """
- The vulnerable manifest filename
- """
- vulnerableManifestFilename: String!
-
- """
- The vulnerable manifest path
- """
- vulnerableManifestPath: String!
-
- """
- The vulnerable requirements
- """
- vulnerableRequirements: String
-}
-
-"""
-The connection type for RepositoryVulnerabilityAlert.
-"""
-type RepositoryVulnerabilityAlertConnection @preview(toggledBy: "vixen-preview") {
- """
- A list of edges.
- """
- edges: [RepositoryVulnerabilityAlertEdge]
-
- """
- A list of nodes.
- """
- nodes: [RepositoryVulnerabilityAlert]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type RepositoryVulnerabilityAlertEdge @preview(toggledBy: "vixen-preview") {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: RepositoryVulnerabilityAlert
-}
-
-"""
-Autogenerated input type of RequestReviews
-"""
-input RequestReviewsInput {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The Node ID of the pull request to modify.
- """
- pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"])
-
- """
- The Node IDs of the team to request.
- """
- teamIds: [ID!] @possibleTypes(concreteTypes: ["Team"])
-
- """
- Add users to the set rather than replace.
- """
- union: Boolean
-
- """
- The Node IDs of the user to request.
- """
- userIds: [ID!] @possibleTypes(concreteTypes: ["User"])
-}
-
-"""
-Autogenerated return type of RequestReviews
-"""
-type RequestReviewsPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The pull request that is getting requests.
- """
- pullRequest: PullRequest
-
- """
- The edge from the pull request to the requested reviewers.
- """
- requestedReviewersEdge: UserEdge
-}
-
-"""
-The possible states that can be requested when creating a check run.
-"""
-enum RequestableCheckStatusState @preview(toggledBy: "antiope-preview") {
- """
- The check suite or run has been completed.
- """
- COMPLETED
-
- """
- The check suite or run is in progress.
- """
- IN_PROGRESS
-
- """
- The check suite or run has been queued.
- """
- QUEUED
-}
-
-"""
-Types that can be requested reviewers.
-"""
-union RequestedReviewer = Team | User
-
-"""
-Autogenerated input type of RerequestCheckSuite
-"""
-input RerequestCheckSuiteInput @preview(toggledBy: "antiope-preview") {
- """
- The Node ID of the check suite.
- """
- checkSuiteId: ID! @possibleTypes(concreteTypes: ["CheckSuite"])
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The Node ID of the repository.
- """
- repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
-}
-
-"""
-Autogenerated return type of RerequestCheckSuite
-"""
-type RerequestCheckSuitePayload @preview(toggledBy: "antiope-preview") {
- """
- The requested check suite.
- """
- checkSuite: CheckSuite
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-}
-
-"""
-Autogenerated input type of ResolveReviewThread
-"""
-input ResolveReviewThreadInput {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The ID of the thread to resolve
- """
- threadId: ID! @possibleTypes(concreteTypes: ["PullRequestReviewThread"])
-}
-
-"""
-Autogenerated return type of ResolveReviewThread
-"""
-type ResolveReviewThreadPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The thread to resolve.
- """
- thread: PullRequestReviewThread
-}
-
-"""
-Represents a private contribution a user made on GitHub.
-"""
-type RestrictedContribution implements Contribution {
- """
- Whether this contribution is associated with a record you do not have access to. For
- example, your own 'first issue' contribution may have been made on a repository you can no
- longer access.
- """
- isRestricted: Boolean!
-
- """
- When this contribution was made.
- """
- occurredAt: DateTime!
-
- """
- The HTTP path for this contribution.
- """
- resourcePath: URI!
-
- """
- The HTTP URL for this contribution.
- """
- url: URI!
-
- """
- The user who made this contribution.
- """
- user: User!
-}
-
-"""
-A team or user who has the ability to dismiss a review on a protected branch.
-"""
-type ReviewDismissalAllowance implements Node {
- """
- The actor that can dismiss.
- """
- actor: ReviewDismissalAllowanceActor
-
- """
- Identifies the branch protection rule associated with the allowed user or team.
- """
- branchProtectionRule: BranchProtectionRule
- id: ID!
-}
-
-"""
-Types that can be an actor.
-"""
-union ReviewDismissalAllowanceActor = Team | User
-
-"""
-The connection type for ReviewDismissalAllowance.
-"""
-type ReviewDismissalAllowanceConnection {
- """
- A list of edges.
- """
- edges: [ReviewDismissalAllowanceEdge]
-
- """
- A list of nodes.
- """
- nodes: [ReviewDismissalAllowance]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type ReviewDismissalAllowanceEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: ReviewDismissalAllowance
-}
-
-"""
-Represents a 'review_dismissed' event on a given issue or pull request.
-"""
-type ReviewDismissedEvent implements Node & UniformResourceLocatable {
- """
- Identifies the actor who performed the event.
- """
- actor: Actor
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- Identifies the primary key from the database.
- """
- databaseId: Int
-
- """
- Identifies the optional message associated with the 'review_dismissed' event.
- """
- dismissalMessage: String
-
- """
- Identifies the optional message associated with the event, rendered to HTML.
- """
- dismissalMessageHTML: String
- id: ID!
-
- """
- Identifies the message associated with the 'review_dismissed' event.
- """
- message: String! @deprecated(reason: "`message` is being removed because it not nullable, whereas the underlying field is optional. Use `dismissalMessage` instead. Removal on 2019-07-01 UTC.")
-
- """
- The message associated with the event, rendered to HTML.
- """
- messageHtml: HTML! @deprecated(reason: "`messageHtml` is being removed because it not nullable, whereas the underlying field is optional. Use `dismissalMessageHTML` instead. Removal on 2019-07-01 UTC.")
-
- """
- Identifies the previous state of the review with the 'review_dismissed' event.
- """
- previousReviewState: PullRequestReviewState!
-
- """
- PullRequest referenced by event.
- """
- pullRequest: PullRequest!
-
- """
- Identifies the commit which caused the review to become stale.
- """
- pullRequestCommit: PullRequestCommit
-
- """
- The HTTP path for this review dismissed event.
- """
- resourcePath: URI!
-
- """
- Identifies the review associated with the 'review_dismissed' event.
- """
- review: PullRequestReview
-
- """
- The HTTP URL for this review dismissed event.
- """
- url: URI!
-}
-
-"""
-A request for a user to review a pull request.
-"""
-type ReviewRequest implements Node {
- """
- Identifies the primary key from the database.
- """
- databaseId: Int
- id: ID!
-
- """
- Identifies the pull request associated with this review request.
- """
- pullRequest: PullRequest!
-
- """
- The reviewer that is requested.
- """
- requestedReviewer: RequestedReviewer
-}
-
-"""
-The connection type for ReviewRequest.
-"""
-type ReviewRequestConnection {
- """
- A list of edges.
- """
- edges: [ReviewRequestEdge]
-
- """
- A list of nodes.
- """
- nodes: [ReviewRequest]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type ReviewRequestEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: ReviewRequest
-}
-
-"""
-Represents an 'review_request_removed' event on a given pull request.
-"""
-type ReviewRequestRemovedEvent implements Node {
- """
- Identifies the actor who performed the event.
- """
- actor: Actor
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
- id: ID!
-
- """
- PullRequest referenced by event.
- """
- pullRequest: PullRequest!
-
- """
- Identifies the reviewer whose review request was removed.
- """
- requestedReviewer: RequestedReviewer
-}
-
-"""
-Represents an 'review_requested' event on a given pull request.
-"""
-type ReviewRequestedEvent implements Node {
- """
- Identifies the actor who performed the event.
- """
- actor: Actor
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
- id: ID!
-
- """
- PullRequest referenced by event.
- """
- pullRequest: PullRequest!
-
- """
- Identifies the reviewer whose review was requested.
- """
- requestedReviewer: RequestedReviewer
-}
-
-"""
-A hovercard context with a message describing the current code review state of the pull
-request.
-"""
-type ReviewStatusHovercardContext implements HovercardContext @preview(toggledBy: "hagar-preview") {
- """
- A string describing this context
- """
- message: String!
-
- """
- An octicon to accompany this context
- """
- octicon: String!
-}
-
-"""
-The results of a search.
-"""
-union SearchResultItem = Issue | Organization | PullRequest | Repository | User
-
-"""
-A list of results that matched against a search query.
-"""
-type SearchResultItemConnection {
- """
- The number of pieces of code that matched the search query.
- """
- codeCount: Int!
-
- """
- A list of edges.
- """
- edges: [SearchResultItemEdge]
-
- """
- The number of issues that matched the search query.
- """
- issueCount: Int!
-
- """
- A list of nodes.
- """
- nodes: [SearchResultItem]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- The number of repositories that matched the search query.
- """
- repositoryCount: Int!
-
- """
- The number of users that matched the search query.
- """
- userCount: Int!
-
- """
- The number of wiki pages that matched the search query.
- """
- wikiCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type SearchResultItemEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: SearchResultItem
-
- """
- Text matches on the result found.
- """
- textMatches: [TextMatch]
-}
-
-"""
-Represents the individual results of a search.
-"""
-enum SearchType {
- """
- Returns results matching issues in repositories.
- """
- ISSUE
-
- """
- Returns results matching repositories.
- """
- REPOSITORY
-
- """
- Returns results matching users and organizations on GitHub.
- """
- USER
-}
-
-"""
-A GitHub Security Advisory
-"""
-type SecurityAdvisory implements Node {
- """
- Identifies the primary key from the database.
- """
- databaseId: Int
-
- """
- This is a long plaintext description of the advisory
- """
- description: String!
-
- """
- The GitHub Security Advisory ID
- """
- ghsaId: String!
- id: ID!
-
- """
- A list of identifiers for this advisory
- """
- identifiers: [SecurityAdvisoryIdentifier!]!
-
- """
- When the advisory was published
- """
- publishedAt: DateTime!
-
- """
- A list of references for this advisory
- """
- references: [SecurityAdvisoryReference!]!
-
- """
- The severity of the advisory
- """
- severity: SecurityAdvisorySeverity!
-
- """
- A short plaintext summary of the advisory
- """
- summary: String!
-
- """
- When the advisory was last updated
- """
- updatedAt: DateTime!
-
- """
- Vulnerabilities associated with this Advisory
- """
- vulnerabilities(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- An ecosystem to filter vulnerabilities by.
- """
- ecosystem: SecurityAdvisoryEcosystem
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- A package name to filter vulnerabilities by.
- """
- package: String
-
- """
- A list of severities to filter vulnerabilities by.
- """
- severities: [SecurityAdvisorySeverity!]
- ): SecurityVulnerabilityConnection!
-
- """
- When the advisory was withdrawn, if it has been withdrawn
- """
- withdrawnAt: DateTime
-}
-
-"""
-The connection type for SecurityAdvisory.
-"""
-type SecurityAdvisoryConnection {
- """
- A list of edges.
- """
- edges: [SecurityAdvisoryEdge]
-
- """
- A list of nodes.
- """
- nodes: [SecurityAdvisory]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-The possible ecosystems of a security vulnerability's package.
-"""
-enum SecurityAdvisoryEcosystem {
- """
- Java artifacts hosted at the Maven central repository
- """
- MAVEN
-
- """
- JavaScript packages hosted at npmjs.com
- """
- NPM
-
- """
- .NET packages hosted at the NuGet Gallery
- """
- NUGET
-
- """
- Python packages hosted at PyPI.org
- """
- PIP
-
- """
- Ruby gems hosted at RubyGems.org
- """
- RUBYGEMS
-}
-
-"""
-An edge in a connection.
-"""
-type SecurityAdvisoryEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: SecurityAdvisory
-}
-
-"""
-A GitHub Security Advisory Identifier
-"""
-type SecurityAdvisoryIdentifier {
- """
- The identifier type, e.g. GHSA, CVE
- """
- type: String!
-
- """
- The identifier
- """
- value: String!
-}
-
-"""
-An individual package
-"""
-type SecurityAdvisoryPackage {
- """
- The ecosystem the package belongs to, e.g. RUBYGEMS, NPM
- """
- ecosystem: SecurityAdvisoryEcosystem!
-
- """
- The package name
- """
- name: String!
-}
-
-"""
-An individual package version
-"""
-type SecurityAdvisoryPackageVersion {
- """
- The package name or version
- """
- identifier: String!
-}
-
-"""
-A GitHub Security Advisory Reference
-"""
-type SecurityAdvisoryReference {
- """
- A publicly accessible reference
- """
- url: URI!
-}
-
-"""
-Severity of the vulnerability.
-"""
-enum SecurityAdvisorySeverity {
- """
- Critical.
- """
- CRITICAL
-
- """
- High.
- """
- HIGH
-
- """
- Low.
- """
- LOW
-
- """
- Moderate.
- """
- MODERATE
-}
-
-"""
-An individual vulnerability within an Advisory
-"""
-type SecurityVulnerability {
- """
- The Advisory associated with this Vulnerability
- """
- advisory: SecurityAdvisory!
-
- """
- The first version containing a fix for the vulnerability
- """
- firstPatchedVersion: SecurityAdvisoryPackageVersion
-
- """
- A description of the vulnerable package
- """
- package: SecurityAdvisoryPackage!
-
- """
- The severity of the vulnerability within this package
- """
- severity: SecurityAdvisorySeverity!
-
- """
- When the vulnerability was last updated
- """
- updatedAt: DateTime!
-
- """
- A string that describes the vulnerable package versions.
- This string follows a basic syntax with a few forms.
- + `= 0.2.0` denotes a single vulnerable version.
- + `<= 1.0.8` denotes a version range up to and including the specified version
- + `< 0.1.11` denotes a version range up to, but excluding, the specified version
- + `>= 4.3.0, < 4.3.5` denotes a version range with a known minimum and maximum version.
- + `>= 0.0.1` denotes a version range with a known minimum, but no known maximum
- """
- vulnerableVersionRange: String!
-}
-
-"""
-The connection type for SecurityVulnerability.
-"""
-type SecurityVulnerabilityConnection {
- """
- A list of edges.
- """
- edges: [SecurityVulnerabilityEdge]
-
- """
- A list of nodes.
- """
- nodes: [SecurityVulnerability]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type SecurityVulnerabilityEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: SecurityVulnerability
-}
-
-"""
-Represents an S/MIME signature on a Commit or Tag.
-"""
-type SmimeSignature implements GitSignature {
- """
- Email used to sign this object.
- """
- email: String!
-
- """
- True if the signature is valid and verified by GitHub.
- """
- isValid: Boolean!
-
- """
- Payload for GPG signing object. Raw ODB object without the signature header.
- """
- payload: String!
-
- """
- ASCII-armored signature header from object.
- """
- signature: String!
-
- """
- GitHub user corresponding to the email signing this commit.
- """
- signer: User
-
- """
- The state of this signature. `VALID` if signature is valid and verified by
- GitHub, otherwise represents reason why signature is considered invalid.
- """
- state: GitSignatureState!
-
- """
- True if the signature was made with GitHub's signing key.
- """
- wasSignedByGitHub: Boolean!
-}
-
-"""
-Ways in which star connections can be ordered.
-"""
-input StarOrder {
- """
- The direction in which to order nodes.
- """
- direction: OrderDirection!
-
- """
- The field in which to order nodes by.
- """
- field: StarOrderField!
-}
-
-"""
-Properties by which star connections can be ordered.
-"""
-enum StarOrderField {
- """
- Allows ordering a list of stars by when they were created.
- """
- STARRED_AT
-}
-
-"""
-The connection type for User.
-"""
-type StargazerConnection {
- """
- A list of edges.
- """
- edges: [StargazerEdge]
-
- """
- A list of nodes.
- """
- nodes: [User]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-Represents a user that's starred a repository.
-"""
-type StargazerEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
- node: User!
-
- """
- Identifies when the item was starred.
- """
- starredAt: DateTime!
-}
-
-"""
-Things that can be starred.
-"""
-interface Starrable {
- id: ID!
-
- """
- A list of users who have starred this starrable.
- """
- stargazers(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Order for connection
- """
- orderBy: StarOrder
- ): StargazerConnection!
-
- """
- Returns a boolean indicating whether the viewing user has starred this starrable.
- """
- viewerHasStarred: Boolean!
-}
-
-"""
-The connection type for Repository.
-"""
-type StarredRepositoryConnection {
- """
- A list of edges.
- """
- edges: [StarredRepositoryEdge]
-
- """
- A list of nodes.
- """
- nodes: [Repository]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-Represents a starred repository.
-"""
-type StarredRepositoryEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
- node: Repository!
-
- """
- Identifies when the item was starred.
- """
- starredAt: DateTime!
-}
-
-"""
-Represents a commit status.
-"""
-type Status implements Node {
- """
- The commit this status is attached to.
- """
- commit: Commit
-
- """
- Looks up an individual status context by context name.
- """
- context(
- """
- The context name.
- """
- name: String!
- ): StatusContext
-
- """
- The individual status contexts for this commit.
- """
- contexts: [StatusContext!]!
- id: ID!
-
- """
- The combined commit status.
- """
- state: StatusState!
-}
-
-"""
-Represents an individual commit status context
-"""
-type StatusContext implements Node {
- """
- This commit this status context is attached to.
- """
- commit: Commit
-
- """
- The name of this status context.
- """
- context: String!
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- The actor who created this status context.
- """
- creator: Actor
-
- """
- The description for this status context.
- """
- description: String
- id: ID!
-
- """
- The state of this status context.
- """
- state: StatusState!
-
- """
- The URL for this status context.
- """
- targetUrl: URI
-}
-
-"""
-The possible commit status states.
-"""
-enum StatusState {
- """
- Status is errored.
- """
- ERROR
-
- """
- Status is expected.
- """
- EXPECTED
-
- """
- Status is failing.
- """
- FAILURE
-
- """
- Status is pending.
- """
- PENDING
-
- """
- Status is successful.
- """
- SUCCESS
-}
-
-"""
-Autogenerated input type of SubmitPullRequestReview
-"""
-input SubmitPullRequestReviewInput {
- """
- The text field to set on the Pull Request Review.
- """
- body: String
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The event to send to the Pull Request Review.
- """
- event: PullRequestReviewEvent!
-
- """
- The Pull Request Review ID to submit.
- """
- pullRequestReviewId: ID! @possibleTypes(concreteTypes: ["PullRequestReview"])
-}
-
-"""
-Autogenerated return type of SubmitPullRequestReview
-"""
-type SubmitPullRequestReviewPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The submitted pull request review.
- """
- pullRequestReview: PullRequestReview
-}
-
-"""
-Entities that can be subscribed to for web and email notifications.
-"""
-interface Subscribable {
- id: ID!
-
- """
- Check if the viewer is able to change their subscription status for the repository.
- """
- viewerCanSubscribe: Boolean!
-
- """
- Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
- """
- viewerSubscription: SubscriptionState
-}
-
-"""
-Represents a 'subscribed' event on a given `Subscribable`.
-"""
-type SubscribedEvent implements Node {
- """
- Identifies the actor who performed the event.
- """
- actor: Actor
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
- id: ID!
-
- """
- Object referenced by event.
- """
- subscribable: Subscribable!
-}
-
-"""
-The possible states of a subscription.
-"""
-enum SubscriptionState {
- """
- The User is never notified.
- """
- IGNORED
-
- """
- The User is notified of all conversations.
- """
- SUBSCRIBED
-
- """
- The User is only notified when participating or @mentioned.
- """
- UNSUBSCRIBED
-}
-
-"""
-A suggestion to review a pull request based on a user's commit history and review comments.
-"""
-type SuggestedReviewer {
- """
- Is this suggestion based on past commits?
- """
- isAuthor: Boolean!
-
- """
- Is this suggestion based on past review comments?
- """
- isCommenter: Boolean!
-
- """
- Identifies the user suggested to review the pull request.
- """
- reviewer: User!
-}
-
-"""
-Represents a Git tag.
-"""
-type Tag implements GitObject & Node {
- """
- An abbreviated version of the Git object ID
- """
- abbreviatedOid: String!
-
- """
- The HTTP path for this Git object
- """
- commitResourcePath: URI!
-
- """
- The HTTP URL for this Git object
- """
- commitUrl: URI!
- id: ID!
-
- """
- The Git tag message.
- """
- message: String
-
- """
- The Git tag name.
- """
- name: String!
-
- """
- The Git object ID
- """
- oid: GitObjectID!
-
- """
- The Repository the Git object belongs to
- """
- repository: Repository!
-
- """
- Details about the tag author.
- """
- tagger: GitActor
-
- """
- The Git object the tag points to.
- """
- target: GitObject!
-}
-
-"""
-A team of users in an organization.
-"""
-type Team implements MemberStatusable & Node & Subscribable {
- """
- A list of teams that are ancestors of this team.
- """
- ancestors(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): TeamConnection!
-
- """
- A URL pointing to the team's avatar.
- """
- avatarUrl(
- """
- The size in pixels of the resulting square image.
- """
- size: Int = 400
- ): URI
-
- """
- List of child teams belonging to this team
- """
- childTeams(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Whether to list immediate child teams or all descendant child teams.
- """
- immediateOnly: Boolean = true
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Order for connection
- """
- orderBy: TeamOrder
-
- """
- User logins to filter by
- """
- userLogins: [String!]
- ): TeamConnection!
-
- """
- The slug corresponding to the organization and team.
- """
- combinedSlug: String!
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- The description of the team.
- """
- description: String
-
- """
- Find a team discussion by its number.
- """
- discussion(
- """
- The sequence number of the discussion to find.
- """
- number: Int!
- ): TeamDiscussion @preview(toggledBy: "echo-preview")
-
- """
- A list of team discussions.
- """
- discussions(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- If provided, filters discussions according to whether or not they are pinned.
- """
- isPinned: Boolean
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Order for connection
- """
- orderBy: TeamDiscussionOrder
- ): TeamDiscussionConnection! @preview(toggledBy: "echo-preview")
-
- """
- The HTTP path for team discussions
- """
- discussionsResourcePath: URI! @preview(toggledBy: "echo-preview")
-
- """
- The HTTP URL for team discussions
- """
- discussionsUrl: URI! @preview(toggledBy: "echo-preview")
-
- """
- The HTTP path for editing this team
- """
- editTeamResourcePath: URI!
-
- """
- The HTTP URL for editing this team
- """
- editTeamUrl: URI!
- id: ID!
-
- """
- A list of pending invitations for users to this team
- """
- invitations(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): OrganizationInvitationConnection
-
- """
- Get the status messages members of this entity have set that are either public or visible only to the organization.
- """
- memberStatuses(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for user statuses returned from the connection.
- """
- orderBy: UserStatusOrder = {field: UPDATED_AT, direction: DESC}
- ): UserStatusConnection!
-
- """
- A list of users who are members of this team.
- """
- members(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Filter by membership type
- """
- membership: TeamMembershipType = ALL
-
- """
- Order for the connection.
- """
- orderBy: TeamMemberOrder
-
- """
- The search string to look for.
- """
- query: String
-
- """
- Filter by team member role
- """
- role: TeamMemberRole
- ): TeamMemberConnection!
-
- """
- The HTTP path for the team' members
- """
- membersResourcePath: URI!
-
- """
- The HTTP URL for the team' members
- """
- membersUrl: URI!
-
- """
- The name of the team.
- """
- name: String!
-
- """
- The HTTP path creating a new team
- """
- newTeamResourcePath: URI!
-
- """
- The HTTP URL creating a new team
- """
- newTeamUrl: URI!
-
- """
- The organization that owns this team.
- """
- organization: Organization!
-
- """
- The parent team of the team.
- """
- parentTeam: Team
-
- """
- The level of privacy the team has.
- """
- privacy: TeamPrivacy!
-
- """
- A list of repositories this team has access to.
- """
- repositories(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Order for the connection.
- """
- orderBy: TeamRepositoryOrder
-
- """
- The search string to look for.
- """
- query: String
- ): TeamRepositoryConnection!
-
- """
- The HTTP path for this team's repositories
- """
- repositoriesResourcePath: URI!
-
- """
- The HTTP URL for this team's repositories
- """
- repositoriesUrl: URI!
-
- """
- The HTTP path for this team
- """
- resourcePath: URI!
-
- """
- The slug corresponding to the team.
- """
- slug: String!
-
- """
- The HTTP path for this team's teams
- """
- teamsResourcePath: URI!
-
- """
- The HTTP URL for this team's teams
- """
- teamsUrl: URI!
-
- """
- Identifies the date and time when the object was last updated.
- """
- updatedAt: DateTime!
-
- """
- The HTTP URL for this team
- """
- url: URI!
-
- """
- Team is adminable by the viewer.
- """
- viewerCanAdminister: Boolean!
-
- """
- Check if the viewer is able to change their subscription status for the repository.
- """
- viewerCanSubscribe: Boolean!
-
- """
- Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
- """
- viewerSubscription: SubscriptionState
-}
-
-"""
-The connection type for Team.
-"""
-type TeamConnection {
- """
- A list of edges.
- """
- edges: [TeamEdge]
-
- """
- A list of nodes.
- """
- nodes: [Team]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-A team discussion.
-"""
-type TeamDiscussion implements Comment & Deletable & Node & Reactable & Subscribable & UniformResourceLocatable & Updatable & UpdatableComment @preview(toggledBy: "echo-preview") {
- """
- The actor who authored the comment.
- """
- author: Actor
-
- """
- Author's association with the discussion's team.
- """
- authorAssociation: CommentAuthorAssociation!
-
- """
- The body as Markdown.
- """
- body: String!
-
- """
- The discussion body rendered to HTML.
- """
- bodyHTML: HTML!
-
- """
- The body rendered to text.
- """
- bodyText: String!
-
- """
- Identifies the discussion body hash.
- """
- bodyVersion: String!
-
- """
- A list of comments on this discussion.
- """
- comments(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- When provided, filters the connection such that results begin with the comment with this number.
- """
- fromComment: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Order for connection
- """
- orderBy: TeamDiscussionCommentOrder
- ): TeamDiscussionCommentConnection!
-
- """
- The HTTP path for discussion comments
- """
- commentsResourcePath: URI!
-
- """
- The HTTP URL for discussion comments
- """
- commentsUrl: URI!
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- Check if this comment was created via an email reply.
- """
- createdViaEmail: Boolean!
-
- """
- Identifies the primary key from the database.
- """
- databaseId: Int
-
- """
- The actor who edited the comment.
- """
- editor: Actor
- id: ID!
-
- """
- Check if this comment was edited and includes an edit with the creation data
- """
- includesCreatedEdit: Boolean!
-
- """
- Whether or not the discussion is pinned.
- """
- isPinned: Boolean!
-
- """
- Whether or not the discussion is only visible to team members and org admins.
- """
- isPrivate: Boolean!
-
- """
- The moment the editor made the last edit
- """
- lastEditedAt: DateTime
-
- """
- Identifies the discussion within its team.
- """
- number: Int!
-
- """
- Identifies when the comment was published at.
- """
- publishedAt: DateTime
-
- """
- A list of reactions grouped by content left on the subject.
- """
- reactionGroups: [ReactionGroup!]
-
- """
- A list of Reactions left on the Issue.
- """
- reactions(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Allows filtering Reactions by emoji.
- """
- content: ReactionContent
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Allows specifying the order in which reactions are returned.
- """
- orderBy: ReactionOrder
- ): ReactionConnection!
-
- """
- The HTTP path for this discussion
- """
- resourcePath: URI!
-
- """
- The team that defines the context of this discussion.
- """
- team: Team!
-
- """
- The title of the discussion
- """
- title: String!
-
- """
- Identifies the date and time when the object was last updated.
- """
- updatedAt: DateTime!
-
- """
- The HTTP URL for this discussion
- """
- url: URI!
-
- """
- A list of edits to this content.
- """
- userContentEdits(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): UserContentEditConnection
-
- """
- Check if the current viewer can delete this object.
- """
- viewerCanDelete: Boolean!
-
- """
- Whether or not the current viewer can pin this discussion.
- """
- viewerCanPin: Boolean!
-
- """
- Can user react to this subject
- """
- viewerCanReact: Boolean!
-
- """
- Check if the viewer is able to change their subscription status for the repository.
- """
- viewerCanSubscribe: Boolean!
-
- """
- Check if the current viewer can update this object.
- """
- viewerCanUpdate: Boolean!
-
- """
- Reasons why the current viewer can not update this comment.
- """
- viewerCannotUpdateReasons: [CommentCannotUpdateReason!]!
-
- """
- Did the viewer author this comment.
- """
- viewerDidAuthor: Boolean!
-
- """
- Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
- """
- viewerSubscription: SubscriptionState
-}
-
-"""
-A comment on a team discussion.
-"""
-type TeamDiscussionComment implements Comment & Deletable & Node & Reactable & UniformResourceLocatable & Updatable & UpdatableComment @preview(toggledBy: "echo-preview") {
- """
- The actor who authored the comment.
- """
- author: Actor
-
- """
- Author's association with the comment's team.
- """
- authorAssociation: CommentAuthorAssociation!
-
- """
- The body as Markdown.
- """
- body: String!
-
- """
- The comment body rendered to HTML.
- """
- bodyHTML: HTML!
-
- """
- The body rendered to text.
- """
- bodyText: String!
-
- """
- The current version of the body content.
- """
- bodyVersion: String!
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- Check if this comment was created via an email reply.
- """
- createdViaEmail: Boolean!
-
- """
- Identifies the primary key from the database.
- """
- databaseId: Int
-
- """
- The discussion this comment is about.
- """
- discussion: TeamDiscussion!
-
- """
- The actor who edited the comment.
- """
- editor: Actor
- id: ID!
-
- """
- Check if this comment was edited and includes an edit with the creation data
- """
- includesCreatedEdit: Boolean!
-
- """
- The moment the editor made the last edit
- """
- lastEditedAt: DateTime
-
- """
- Identifies the comment number.
- """
- number: Int!
-
- """
- Identifies when the comment was published at.
- """
- publishedAt: DateTime
-
- """
- A list of reactions grouped by content left on the subject.
- """
- reactionGroups: [ReactionGroup!]
-
- """
- A list of Reactions left on the Issue.
- """
- reactions(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Allows filtering Reactions by emoji.
- """
- content: ReactionContent
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Allows specifying the order in which reactions are returned.
- """
- orderBy: ReactionOrder
- ): ReactionConnection!
-
- """
- The HTTP path for this comment
- """
- resourcePath: URI!
-
- """
- Identifies the date and time when the object was last updated.
- """
- updatedAt: DateTime!
-
- """
- The HTTP URL for this comment
- """
- url: URI!
-
- """
- A list of edits to this content.
- """
- userContentEdits(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): UserContentEditConnection
-
- """
- Check if the current viewer can delete this object.
- """
- viewerCanDelete: Boolean!
-
- """
- Can user react to this subject
- """
- viewerCanReact: Boolean!
-
- """
- Check if the current viewer can update this object.
- """
- viewerCanUpdate: Boolean!
-
- """
- Reasons why the current viewer can not update this comment.
- """
- viewerCannotUpdateReasons: [CommentCannotUpdateReason!]!
-
- """
- Did the viewer author this comment.
- """
- viewerDidAuthor: Boolean!
-}
-
-"""
-The connection type for TeamDiscussionComment.
-"""
-type TeamDiscussionCommentConnection @preview(toggledBy: "echo-preview") {
- """
- A list of edges.
- """
- edges: [TeamDiscussionCommentEdge]
-
- """
- A list of nodes.
- """
- nodes: [TeamDiscussionComment]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type TeamDiscussionCommentEdge @preview(toggledBy: "echo-preview") {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: TeamDiscussionComment
-}
-
-"""
-Ways in which team discussion comment connections can be ordered.
-"""
-input TeamDiscussionCommentOrder @preview(toggledBy: "echo-preview") {
- """
- The direction in which to order nodes.
- """
- direction: OrderDirection!
-
- """
- The field by which to order nodes.
- """
- field: TeamDiscussionCommentOrderField!
-}
-
-"""
-Properties by which team discussion comment connections can be ordered.
-"""
-enum TeamDiscussionCommentOrderField @preview(toggledBy: "echo-preview") {
- """
- Allows sequential ordering of team discussion comments (which is equivalent to chronological ordering).
- """
- NUMBER
-}
-
-"""
-The connection type for TeamDiscussion.
-"""
-type TeamDiscussionConnection @preview(toggledBy: "echo-preview") {
- """
- A list of edges.
- """
- edges: [TeamDiscussionEdge]
-
- """
- A list of nodes.
- """
- nodes: [TeamDiscussion]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type TeamDiscussionEdge @preview(toggledBy: "echo-preview") {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: TeamDiscussion
-}
-
-"""
-Ways in which team discussion connections can be ordered.
-"""
-input TeamDiscussionOrder @preview(toggledBy: "echo-preview") {
- """
- The direction in which to order nodes.
- """
- direction: OrderDirection!
-
- """
- The field by which to order nodes.
- """
- field: TeamDiscussionOrderField!
-}
-
-"""
-Properties by which team discussion connections can be ordered.
-"""
-enum TeamDiscussionOrderField @preview(toggledBy: "echo-preview") {
- """
- Allows chronological ordering of team discussions.
- """
- CREATED_AT
-}
-
-"""
-An edge in a connection.
-"""
-type TeamEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: Team
-}
-
-"""
-The connection type for User.
-"""
-type TeamMemberConnection {
- """
- A list of edges.
- """
- edges: [TeamMemberEdge]
-
- """
- A list of nodes.
- """
- nodes: [User]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-Represents a user who is a member of a team.
-"""
-type TeamMemberEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The HTTP path to the organization's member access page.
- """
- memberAccessResourcePath: URI!
-
- """
- The HTTP URL to the organization's member access page.
- """
- memberAccessUrl: URI!
- node: User!
-
- """
- The role the member has on the team.
- """
- role: TeamMemberRole!
-}
-
-"""
-Ordering options for team member connections
-"""
-input TeamMemberOrder {
- """
- The ordering direction.
- """
- direction: OrderDirection!
-
- """
- The field to order team members by.
- """
- field: TeamMemberOrderField!
-}
-
-"""
-Properties by which team member connections can be ordered.
-"""
-enum TeamMemberOrderField {
- """
- Order team members by creation time
- """
- CREATED_AT
-
- """
- Order team members by login
- """
- LOGIN
-}
-
-"""
-The possible team member roles; either 'maintainer' or 'member'.
-"""
-enum TeamMemberRole {
- """
- A team maintainer has permission to add and remove team members.
- """
- MAINTAINER
-
- """
- A team member has no administrative permissions on the team.
- """
- MEMBER
-}
-
-"""
-Defines which types of team members are included in the returned list. Can be one of IMMEDIATE, CHILD_TEAM or ALL.
-"""
-enum TeamMembershipType {
- """
- Includes immediate and child team members for the team.
- """
- ALL
-
- """
- Includes only child team members for the team.
- """
- CHILD_TEAM
-
- """
- Includes only immediate members of the team.
- """
- IMMEDIATE
-}
-
-"""
-Ways in which team connections can be ordered.
-"""
-input TeamOrder {
- """
- The direction in which to order nodes.
- """
- direction: OrderDirection!
-
- """
- The field in which to order nodes by.
- """
- field: TeamOrderField!
-}
-
-"""
-Properties by which team connections can be ordered.
-"""
-enum TeamOrderField {
- """
- Allows ordering a list of teams by name.
- """
- NAME
-}
-
-"""
-The possible team privacy values.
-"""
-enum TeamPrivacy {
- """
- A secret team can only be seen by its members.
- """
- SECRET
-
- """
- A visible team can be seen and @mentioned by every member of the organization.
- """
- VISIBLE
-}
-
-"""
-The connection type for Repository.
-"""
-type TeamRepositoryConnection {
- """
- A list of edges.
- """
- edges: [TeamRepositoryEdge]
-
- """
- A list of nodes.
- """
- nodes: [Repository]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-Represents a team repository.
-"""
-type TeamRepositoryEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
- node: Repository!
-
- """
- The permission level the team has on the repository
- """
- permission: RepositoryPermission!
-}
-
-"""
-Ordering options for team repository connections
-"""
-input TeamRepositoryOrder {
- """
- The ordering direction.
- """
- direction: OrderDirection!
-
- """
- The field to order repositories by.
- """
- field: TeamRepositoryOrderField!
-}
-
-"""
-Properties by which team repository connections can be ordered.
-"""
-enum TeamRepositoryOrderField {
- """
- Order repositories by creation time
- """
- CREATED_AT
-
- """
- Order repositories by name
- """
- NAME
-
- """
- Order repositories by permission
- """
- PERMISSION
-
- """
- Order repositories by push time
- """
- PUSHED_AT
-
- """
- Order repositories by number of stargazers
- """
- STARGAZERS
-
- """
- Order repositories by update time
- """
- UPDATED_AT
-}
-
-"""
-The role of a user on a team.
-"""
-enum TeamRole {
- """
- User has admin rights on the team.
- """
- ADMIN
-
- """
- User is a member of the team.
- """
- MEMBER
-}
-
-"""
-A text match within a search result.
-"""
-type TextMatch {
- """
- The specific text fragment within the property matched on.
- """
- fragment: String!
-
- """
- Highlights within the matched fragment.
- """
- highlights: [TextMatchHighlight!]!
-
- """
- The property matched on.
- """
- property: String!
-}
-
-"""
-Represents a single highlight in a search result match.
-"""
-type TextMatchHighlight {
- """
- The indice in the fragment where the matched text begins.
- """
- beginIndice: Int!
-
- """
- The indice in the fragment where the matched text ends.
- """
- endIndice: Int!
-
- """
- The text matched.
- """
- text: String!
-}
-
-"""
-A topic aggregates entities that are related to a subject.
-"""
-type Topic implements Node & Starrable {
- id: ID!
-
- """
- The topic's name.
- """
- name: String!
-
- """
- A list of related topics, including aliases of this topic, sorted with the most relevant
- first. Returns up to 10 Topics.
- """
- relatedTopics(
- """
- How many topics to return.
- """
- first: Int = 3
- ): [Topic!]!
-
- """
- A list of users who have starred this starrable.
- """
- stargazers(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Order for connection
- """
- orderBy: StarOrder
- ): StargazerConnection!
-
- """
- Returns a boolean indicating whether the viewing user has starred this starrable.
- """
- viewerHasStarred: Boolean!
-}
-
-"""
-Represents a 'transferred' event on a given issue or pull request.
-"""
-type TransferredEvent implements Node {
- """
- Identifies the actor who performed the event.
- """
- actor: Actor
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- The repository this came from
- """
- fromRepository: Repository
- id: ID!
-
- """
- Identifies the issue associated with the event.
- """
- issue: Issue!
-}
-
-"""
-Represents a Git tree.
-"""
-type Tree implements GitObject & Node {
- """
- An abbreviated version of the Git object ID
- """
- abbreviatedOid: String!
-
- """
- The HTTP path for this Git object
- """
- commitResourcePath: URI!
-
- """
- The HTTP URL for this Git object
- """
- commitUrl: URI!
-
- """
- A list of tree entries.
- """
- entries: [TreeEntry!]
- id: ID!
-
- """
- The Git object ID
- """
- oid: GitObjectID!
-
- """
- The Repository the Git object belongs to
- """
- repository: Repository!
-}
-
-"""
-Represents a Git tree entry.
-"""
-type TreeEntry {
- """
- Entry file mode.
- """
- mode: Int!
-
- """
- Entry file name.
- """
- name: String!
-
- """
- Entry file object.
- """
- object: GitObject
-
- """
- Entry file Git object ID.
- """
- oid: GitObjectID!
-
- """
- The Repository the tree entry belongs to
- """
- repository: Repository!
-
- """
- Entry file type.
- """
- type: String!
-}
-
-"""
-An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.
-"""
-scalar URI
-
-"""
-Represents an 'unassigned' event on any assignable object.
-"""
-type UnassignedEvent implements Node {
- """
- Identifies the actor who performed the event.
- """
- actor: Actor
-
- """
- Identifies the assignable associated with the event.
- """
- assignable: Assignable!
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
- id: ID!
-
- """
- Identifies the subject (user) who was unassigned.
- """
- user: User
-}
-
-"""
-Represents a type that can be retrieved by a URL.
-"""
-interface UniformResourceLocatable {
- """
- The HTML path to this resource.
- """
- resourcePath: URI!
-
- """
- The URL to this resource.
- """
- url: URI!
-}
-
-"""
-Represents an unknown signature on a Commit or Tag.
-"""
-type UnknownSignature implements GitSignature {
- """
- Email used to sign this object.
- """
- email: String!
-
- """
- True if the signature is valid and verified by GitHub.
- """
- isValid: Boolean!
-
- """
- Payload for GPG signing object. Raw ODB object without the signature header.
- """
- payload: String!
-
- """
- ASCII-armored signature header from object.
- """
- signature: String!
-
- """
- GitHub user corresponding to the email signing this commit.
- """
- signer: User
-
- """
- The state of this signature. `VALID` if signature is valid and verified by
- GitHub, otherwise represents reason why signature is considered invalid.
- """
- state: GitSignatureState!
-
- """
- True if the signature was made with GitHub's signing key.
- """
- wasSignedByGitHub: Boolean!
-}
-
-"""
-Represents an 'unlabeled' event on a given issue or pull request.
-"""
-type UnlabeledEvent implements Node {
- """
- Identifies the actor who performed the event.
- """
- actor: Actor
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
- id: ID!
-
- """
- Identifies the label associated with the 'unlabeled' event.
- """
- label: Label!
-
- """
- Identifies the `Labelable` associated with the event.
- """
- labelable: Labelable!
-}
-
-"""
-Autogenerated input type of UnlockLockable
-"""
-input UnlockLockableInput {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- ID of the issue or pull request to be unlocked.
- """
- lockableId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "Lockable")
-}
-
-"""
-Autogenerated return type of UnlockLockable
-"""
-type UnlockLockablePayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The item that was unlocked.
- """
- unlockedRecord: Lockable
-}
-
-"""
-Represents an 'unlocked' event on a given issue or pull request.
-"""
-type UnlockedEvent implements Node {
- """
- Identifies the actor who performed the event.
- """
- actor: Actor
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
- id: ID!
-
- """
- Object that was unlocked.
- """
- lockable: Lockable!
-}
-
-"""
-Autogenerated input type of UnmarkIssueAsDuplicate
-"""
-input UnmarkIssueAsDuplicateInput {
- """
- ID of the issue or pull request currently considered canonical/authoritative/original.
- """
- canonicalId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "IssueOrPullRequest")
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- ID of the issue or pull request currently marked as a duplicate.
- """
- duplicateId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "IssueOrPullRequest")
-}
-
-"""
-Autogenerated return type of UnmarkIssueAsDuplicate
-"""
-type UnmarkIssueAsDuplicatePayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The issue or pull request that was marked as a duplicate.
- """
- duplicate: IssueOrPullRequest
-}
-
-"""
-Autogenerated input type of UnminimizeComment
-"""
-input UnminimizeCommentInput {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The Node ID of the subject to modify.
- """
- subjectId: ID! @possibleTypes(concreteTypes: ["CommitComment", "GistComment", "IssueComment", "PullRequestReviewComment"], abstractType: "Minimizable")
-}
-
-"""
-Autogenerated return type of UnminimizeComment
-"""
-type UnminimizeCommentPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The comment that was unminimized.
- """
- unminimizedComment: Minimizable
-}
-
-"""
-Autogenerated input type of UnpinIssue
-"""
-input UnpinIssueInput {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The ID of the issue to be unpinned
- """
- issueId: ID! @possibleTypes(concreteTypes: ["Issue"])
-}
-
-"""
-Autogenerated return type of UnpinIssue
-"""
-type UnpinIssuePayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The issue that was unpinned
- """
- issue: Issue
-}
-
-"""
-Represents an 'unpinned' event on a given issue or pull request.
-"""
-type UnpinnedEvent implements Node {
- """
- Identifies the actor who performed the event.
- """
- actor: Actor
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
- id: ID!
-
- """
- Identifies the issue associated with the event.
- """
- issue: Issue!
-}
-
-"""
-Autogenerated input type of UnresolveReviewThread
-"""
-input UnresolveReviewThreadInput {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The ID of the thread to unresolve
- """
- threadId: ID! @possibleTypes(concreteTypes: ["PullRequestReviewThread"])
-}
-
-"""
-Autogenerated return type of UnresolveReviewThread
-"""
-type UnresolveReviewThreadPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The thread to resolve.
- """
- thread: PullRequestReviewThread
-}
-
-"""
-Represents an 'unsubscribed' event on a given `Subscribable`.
-"""
-type UnsubscribedEvent implements Node {
- """
- Identifies the actor who performed the event.
- """
- actor: Actor
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
- id: ID!
-
- """
- Object referenced by event.
- """
- subscribable: Subscribable!
-}
-
-"""
-Entities that can be updated.
-"""
-interface Updatable {
- """
- Check if the current viewer can update this object.
- """
- viewerCanUpdate: Boolean!
-}
-
-"""
-Comments that can be updated.
-"""
-interface UpdatableComment {
- """
- Reasons why the current viewer can not update this comment.
- """
- viewerCannotUpdateReasons: [CommentCannotUpdateReason!]!
-}
-
-"""
-Autogenerated input type of UpdateBranchProtectionRule
-"""
-input UpdateBranchProtectionRuleInput {
- """
- The global relay id of the branch protection rule to be updated.
- """
- branchProtectionRuleId: ID! @possibleTypes(concreteTypes: ["BranchProtectionRule"])
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- Will new commits pushed to matching branches dismiss pull request review approvals.
- """
- dismissesStaleReviews: Boolean
-
- """
- Can admins overwrite branch protection.
- """
- isAdminEnforced: Boolean
-
- """
- The glob-like pattern used to determine matching branches.
- """
- pattern: String
-
- """
- A list of User or Team IDs allowed to push to matching branches.
- """
- pushActorIds: [ID!]
-
- """
- Number of approving reviews required to update matching branches.
- """
- requiredApprovingReviewCount: Int
-
- """
- List of required status check contexts that must pass for commits to be accepted to matching branches.
- """
- requiredStatusCheckContexts: [String!]
-
- """
- Are approving reviews required to update matching branches.
- """
- requiresApprovingReviews: Boolean
-
- """
- Are reviews from code owners required to update matching branches.
- """
- requiresCodeOwnerReviews: Boolean
-
- """
- Are commits required to be signed.
- """
- requiresCommitSignatures: Boolean
-
- """
- Are status checks required to update matching branches.
- """
- requiresStatusChecks: Boolean
-
- """
- Are branches required to be up to date before merging.
- """
- requiresStrictStatusChecks: Boolean
-
- """
- Is pushing to matching branches restricted.
- """
- restrictsPushes: Boolean
-
- """
- Is dismissal of pull request reviews restricted.
- """
- restrictsReviewDismissals: Boolean
-
- """
- A list of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.
- """
- reviewDismissalActorIds: [ID!]
-}
-
-"""
-Autogenerated return type of UpdateBranchProtectionRule
-"""
-type UpdateBranchProtectionRulePayload {
- """
- The newly created BranchProtectionRule.
- """
- branchProtectionRule: BranchProtectionRule
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-}
-
-"""
-Autogenerated input type of UpdateCheckRun
-"""
-input UpdateCheckRunInput @preview(toggledBy: "antiope-preview") {
- """
- Possible further actions the integrator can perform, which a user may trigger.
- """
- actions: [CheckRunAction!]
-
- """
- The node of the check.
- """
- checkRunId: ID! @possibleTypes(concreteTypes: ["CheckRun"])
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The time that the check run finished.
- """
- completedAt: DateTime
-
- """
- The final conclusion of the check.
- """
- conclusion: CheckConclusionState
-
- """
- The URL of the integrator's site that has the full details of the check.
- """
- detailsUrl: URI
-
- """
- A reference for the run on the integrator's system.
- """
- externalId: String
-
- """
- The name of the check.
- """
- name: String
-
- """
- Descriptive details about the run.
- """
- output: CheckRunOutput
-
- """
- The node ID of the repository.
- """
- repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
-
- """
- The time that the check run began.
- """
- startedAt: DateTime
-
- """
- The current status.
- """
- status: RequestableCheckStatusState
-}
-
-"""
-Autogenerated return type of UpdateCheckRun
-"""
-type UpdateCheckRunPayload @preview(toggledBy: "antiope-preview") {
- """
- The updated check run.
- """
- checkRun: CheckRun
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-}
-
-"""
-Autogenerated input type of UpdateCheckSuitePreferences
-"""
-input UpdateCheckSuitePreferencesInput @preview(toggledBy: "antiope-preview") {
- """
- The check suite preferences to modify.
- """
- autoTriggerPreferences: [CheckSuiteAutoTriggerPreference!]!
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The Node ID of the repository.
- """
- repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
-}
-
-"""
-Autogenerated return type of UpdateCheckSuitePreferences
-"""
-type UpdateCheckSuitePreferencesPayload @preview(toggledBy: "antiope-preview") {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The updated repository.
- """
- repository: Repository
-}
-
-"""
-Autogenerated input type of UpdateIssueComment
-"""
-input UpdateIssueCommentInput {
- """
- The updated text of the comment.
- """
- body: String!
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The ID of the IssueComment to modify.
- """
- id: ID! @possibleTypes(concreteTypes: ["IssueComment"])
-}
-
-"""
-Autogenerated return type of UpdateIssueComment
-"""
-type UpdateIssueCommentPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The updated comment.
- """
- issueComment: IssueComment
-}
-
-"""
-Autogenerated input type of UpdateIssue
-"""
-input UpdateIssueInput {
- """
- An array of Node IDs of users for this issue.
- """
- assigneeIds: [ID!] @possibleTypes(concreteTypes: ["User"])
-
- """
- The body for the issue description.
- """
- body: String
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The ID of the Issue to modify.
- """
- id: ID! @possibleTypes(concreteTypes: ["Issue"])
-
- """
- An array of Node IDs of labels for this issue.
- """
- labelIds: [ID!] @possibleTypes(concreteTypes: ["Label"])
-
- """
- The Node ID of the milestone for this issue.
- """
- milestoneId: ID @possibleTypes(concreteTypes: ["Milestone"])
-
- """
- An array of Node IDs for projects associated with this issue.
- """
- projectIds: [ID!]
-
- """
- The desired issue state.
- """
- state: IssueState
-
- """
- The title for the issue.
- """
- title: String
-}
-
-"""
-Autogenerated return type of UpdateIssue
-"""
-type UpdateIssuePayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The issue.
- """
- issue: Issue
-}
-
-"""
-Autogenerated input type of UpdateLabel
-"""
-input UpdateLabelInput @preview(toggledBy: "bane-preview") {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- A 6 character hex code, without the leading #, identifying the updated color of the label.
- """
- color: String
-
- """
- The Node ID of the label to be updated.
- """
- id: ID! @possibleTypes(concreteTypes: ["Label"])
-
- """
- The updated name of the label.
- """
- name: String
-}
-
-"""
-Autogenerated return type of UpdateLabel
-"""
-type UpdateLabelPayload @preview(toggledBy: "bane-preview") {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The updated label.
- """
- label: Label
-}
-
-"""
-Autogenerated input type of UpdateProjectCard
-"""
-input UpdateProjectCardInput {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- Whether or not the ProjectCard should be archived
- """
- isArchived: Boolean
-
- """
- The note of ProjectCard.
- """
- note: String
-
- """
- The ProjectCard ID to update.
- """
- projectCardId: ID! @possibleTypes(concreteTypes: ["ProjectCard"])
-}
-
-"""
-Autogenerated return type of UpdateProjectCard
-"""
-type UpdateProjectCardPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The updated ProjectCard.
- """
- projectCard: ProjectCard
-}
-
-"""
-Autogenerated input type of UpdateProjectColumn
-"""
-input UpdateProjectColumnInput {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The name of project column.
- """
- name: String!
-
- """
- The ProjectColumn ID to update.
- """
- projectColumnId: ID! @possibleTypes(concreteTypes: ["ProjectColumn"])
-}
-
-"""
-Autogenerated return type of UpdateProjectColumn
-"""
-type UpdateProjectColumnPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The updated project column.
- """
- projectColumn: ProjectColumn
-}
-
-"""
-Autogenerated input type of UpdateProject
-"""
-input UpdateProjectInput {
- """
- The description of project.
- """
- body: String
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The name of project.
- """
- name: String
-
- """
- The Project ID to update.
- """
- projectId: ID! @possibleTypes(concreteTypes: ["Project"])
-
- """
- Whether the project is public or not.
- """
- public: Boolean
-
- """
- Whether the project is open or closed.
- """
- state: ProjectState
-}
-
-"""
-Autogenerated return type of UpdateProject
-"""
-type UpdateProjectPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The updated project.
- """
- project: Project
-}
-
-"""
-Autogenerated input type of UpdatePullRequest
-"""
-input UpdatePullRequestInput {
- """
- The name of the branch you want your changes pulled into. This should be an existing branch
- on the current repository.
- """
- baseRefName: String
-
- """
- The contents of the pull request.
- """
- body: String
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- Indicates whether maintainers can modify the pull request.
- """
- maintainerCanModify: Boolean
-
- """
- The Node ID of the pull request.
- """
- pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"])
-
- """
- The title of the pull request.
- """
- title: String
-}
-
-"""
-Autogenerated return type of UpdatePullRequest
-"""
-type UpdatePullRequestPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The updated pull request.
- """
- pullRequest: PullRequest
-}
-
-"""
-Autogenerated input type of UpdatePullRequestReviewComment
-"""
-input UpdatePullRequestReviewCommentInput {
- """
- The text of the comment.
- """
- body: String!
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The Node ID of the comment to modify.
- """
- pullRequestReviewCommentId: ID! @possibleTypes(concreteTypes: ["PullRequestReviewComment"])
-}
-
-"""
-Autogenerated return type of UpdatePullRequestReviewComment
-"""
-type UpdatePullRequestReviewCommentPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The updated comment.
- """
- pullRequestReviewComment: PullRequestReviewComment
-}
-
-"""
-Autogenerated input type of UpdatePullRequestReview
-"""
-input UpdatePullRequestReviewInput {
- """
- The contents of the pull request review body.
- """
- body: String!
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The Node ID of the pull request review to modify.
- """
- pullRequestReviewId: ID! @possibleTypes(concreteTypes: ["PullRequestReview"])
-}
-
-"""
-Autogenerated return type of UpdatePullRequestReview
-"""
-type UpdatePullRequestReviewPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The updated pull request review.
- """
- pullRequestReview: PullRequestReview
-}
-
-"""
-Autogenerated input type of UpdateSubscription
-"""
-input UpdateSubscriptionInput {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The new state of the subscription.
- """
- state: SubscriptionState!
-
- """
- The Node ID of the subscribable object to modify.
- """
- subscribableId: ID! @possibleTypes(concreteTypes: ["Commit", "Issue", "PullRequest", "Repository", "Team", "TeamDiscussion"], abstractType: "Subscribable")
-}
-
-"""
-Autogenerated return type of UpdateSubscription
-"""
-type UpdateSubscriptionPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The input subscribable entity.
- """
- subscribable: Subscribable
-}
-
-"""
-Autogenerated input type of UpdateTeamDiscussionComment
-"""
-input UpdateTeamDiscussionCommentInput @preview(toggledBy: "echo-preview") {
- """
- The updated text of the comment.
- """
- body: String!
-
- """
- The current version of the body content.
- """
- bodyVersion: String
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The ID of the comment to modify.
- """
- id: ID! @possibleTypes(concreteTypes: ["TeamDiscussionComment"])
-}
-
-"""
-Autogenerated return type of UpdateTeamDiscussionComment
-"""
-type UpdateTeamDiscussionCommentPayload @preview(toggledBy: "echo-preview") {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The updated comment.
- """
- teamDiscussionComment: TeamDiscussionComment
-}
-
-"""
-Autogenerated input type of UpdateTeamDiscussion
-"""
-input UpdateTeamDiscussionInput @preview(toggledBy: "echo-preview") {
- """
- The updated text of the discussion.
- """
- body: String
-
- """
- The current version of the body content. If provided, this update operation
- will be rejected if the given version does not match the latest version on the server.
- """
- bodyVersion: String
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The Node ID of the discussion to modify.
- """
- id: ID! @possibleTypes(concreteTypes: ["TeamDiscussion"])
-
- """
- If provided, sets the pinned state of the updated discussion.
- """
- pinned: Boolean
-
- """
- The updated title of the discussion.
- """
- title: String
-}
-
-"""
-Autogenerated return type of UpdateTeamDiscussion
-"""
-type UpdateTeamDiscussionPayload @preview(toggledBy: "echo-preview") {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The updated discussion.
- """
- teamDiscussion: TeamDiscussion
-}
-
-"""
-Autogenerated input type of UpdateTopics
-"""
-input UpdateTopicsInput {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The Node ID of the repository.
- """
- repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
-
- """
- An array of topic names.
- """
- topicNames: [String!]!
-}
-
-"""
-Autogenerated return type of UpdateTopics
-"""
-type UpdateTopicsPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- Names of the provided topics that are not valid.
- """
- invalidTopicNames: [String!]
-
- """
- The updated repository.
- """
- repository: Repository
-}
-
-"""
-A user is an individual's account on GitHub that owns repositories and can make new content.
-"""
-type User implements Actor & Node & ProfileOwner & ProjectOwner & RegistryPackageOwner & RegistryPackageSearch & RepositoryOwner & UniformResourceLocatable {
- """
- Determine if this repository owner has any items that can be pinned to their profile.
- """
- anyPinnableItems(
- """
- Filter to only a particular kind of pinnable item.
- """
- type: PinnableItemType
- ): Boolean!
-
- """
- A URL pointing to the user's public avatar.
- """
- avatarUrl(
- """
- The size of the resulting square image.
- """
- size: Int
- ): URI!
-
- """
- The user's public profile bio.
- """
- bio: String
-
- """
- The user's public profile bio as HTML.
- """
- bioHTML: HTML!
-
- """
- A list of commit comments made by this user.
- """
- commitComments(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): CommitCommentConnection!
-
- """
- The user's public profile company.
- """
- company: String
-
- """
- The user's public profile company as HTML.
- """
- companyHTML: HTML!
-
- """
- The collection of contributions this user has made to different repositories.
- """
- contributionsCollection(
- """
- Only contributions made at this time or later will be counted. If omitted, defaults to a year ago.
- """
- from: DateTime
-
- """
- The ID of the organization used to filter contributions.
- """
- organizationID: ID
-
- """
- Only contributions made before and up to and including this time will be
- counted. If omitted, defaults to the current time.
- """
- to: DateTime
- ): ContributionsCollection!
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- Identifies the primary key from the database.
- """
- databaseId: Int
-
- """
- The user's publicly visible profile email.
- """
- email: String!
-
- """
- A list of users the given user is followed by.
- """
- followers(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): FollowerConnection!
-
- """
- A list of users the given user is following.
- """
- following(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): FollowingConnection!
-
- """
- Find gist by repo name.
- """
- gist(
- """
- The gist name to find.
- """
- name: String!
- ): Gist
-
- """
- A list of gist comments made by this user.
- """
- gistComments(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): GistCommentConnection!
-
- """
- A list of the Gists the user has created.
- """
- gists(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for gists returned from the connection
- """
- orderBy: GistOrder
-
- """
- Filters Gists according to privacy.
- """
- privacy: GistPrivacy
- ): GistConnection!
-
- """
- The hovercard information for this user in a given context
- """
- hovercard(
- """
- The ID of the subject to get the hovercard in the context of
- """
- primarySubjectId: ID
- ): Hovercard! @preview(toggledBy: "hagar-preview")
- id: ID!
-
- """
- Whether or not this user is a participant in the GitHub Security Bug Bounty.
- """
- isBountyHunter: Boolean!
-
- """
- Whether or not this user is a participant in the GitHub Campus Experts Program.
- """
- isCampusExpert: Boolean!
-
- """
- Whether or not this user is a GitHub Developer Program member.
- """
- isDeveloperProgramMember: Boolean!
-
- """
- Whether or not this user is a GitHub employee.
- """
- isEmployee: Boolean!
-
- """
- Whether or not the user has marked themselves as for hire.
- """
- isHireable: Boolean!
-
- """
- Whether or not this user is a site administrator.
- """
- isSiteAdmin: Boolean!
-
- """
- Whether or not this user is the viewing user.
- """
- isViewer: Boolean!
-
- """
- A list of issue comments made by this user.
- """
- issueComments(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): IssueCommentConnection!
-
- """
- A list of issues associated with this user.
- """
- issues(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Filtering options for issues returned from the connection.
- """
- filterBy: IssueFilters
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- A list of label names to filter the pull requests by.
- """
- labels: [String!]
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for issues returned from the connection.
- """
- orderBy: IssueOrder
-
- """
- A list of states to filter the issues by.
- """
- states: [IssueState!]
- ): IssueConnection!
-
- """
- Showcases a selection of repositories and gists that the profile owner has
- either curated or that have been selected automatically based on popularity.
- """
- itemShowcase: ProfileItemShowcase!
-
- """
- The user's public profile location.
- """
- location: String
-
- """
- The username used to login.
- """
- login: String!
-
- """
- The user's public profile name.
- """
- name: String
-
- """
- Find an organization by its login that the user belongs to.
- """
- organization(
- """
- The login of the organization to find.
- """
- login: String!
- ): Organization
-
- """
- A list of organizations the user belongs to.
- """
- organizations(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): OrganizationConnection!
-
- """
- A list of repositories and gists this profile owner can pin to their profile.
- """
- pinnableItems(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Filter the types of pinnable items that are returned.
- """
- types: [PinnableItemType!]
- ): PinnableItemConnection!
-
- """
- A list of repositories and gists this profile owner has pinned to their profile
- """
- pinnedItems(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Filter the types of pinned items that are returned.
- """
- types: [PinnableItemType!]
- ): PinnableItemConnection!
-
- """
- Returns how many more items this profile owner can pin to their profile.
- """
- pinnedItemsRemaining: Int!
-
- """
- A list of repositories this user has pinned to their profile
- """
- pinnedRepositories(
- """
- Array of viewer's affiliation options for repositories returned from the
- connection. For example, OWNER will include only repositories that the
- current viewer owns.
- """
- affiliations: [RepositoryAffiliation] = [OWNER, COLLABORATOR]
-
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- If non-null, filters repositories according to whether they have been locked
- """
- isLocked: Boolean
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for repositories returned from the connection
- """
- orderBy: RepositoryOrder
-
- """
- Array of owner's affiliation options for repositories returned from the
- connection. For example, OWNER will include only repositories that the
- organization or user being viewed owns.
- """
- ownerAffiliations: [RepositoryAffiliation] = [OWNER, COLLABORATOR]
-
- """
- If non-null, filters repositories according to privacy
- """
- privacy: RepositoryPrivacy
- ): RepositoryConnection! @deprecated(reason: "pinnedRepositories will be removed Use ProfileOwner.pinnedItems instead. Removal on 2019-07-01 UTC.")
-
- """
- Find project by number.
- """
- project(
- """
- The project number to find.
- """
- number: Int!
- ): Project
-
- """
- A list of projects under the owner.
- """
- projects(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for projects returned from the connection
- """
- orderBy: ProjectOrder
-
- """
- Query to search projects by, currently only searching by name.
- """
- search: String
-
- """
- A list of states to filter the projects by.
- """
- states: [ProjectState!]
- ): ProjectConnection!
-
- """
- The HTTP path listing user's projects
- """
- projectsResourcePath: URI!
-
- """
- The HTTP URL listing user's projects
- """
- projectsUrl: URI!
-
- """
- A list of public keys associated with this user.
- """
- publicKeys(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): PublicKeyConnection!
-
- """
- A list of pull requests associated with this user.
- """
- pullRequests(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- The base ref name to filter the pull requests by.
- """
- baseRefName: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- The head ref name to filter the pull requests by.
- """
- headRefName: String
-
- """
- A list of label names to filter the pull requests by.
- """
- labels: [String!]
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for pull requests returned from the connection.
- """
- orderBy: IssueOrder
-
- """
- A list of states to filter the pull requests by.
- """
- states: [PullRequestState!]
- ): PullRequestConnection!
-
- """
- A list of repositories that the user owns.
- """
- repositories(
- """
- Array of viewer's affiliation options for repositories returned from the
- connection. For example, OWNER will include only repositories that the
- current viewer owns.
- """
- affiliations: [RepositoryAffiliation] = [OWNER, COLLABORATOR]
-
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- If non-null, filters repositories according to whether they are forks of another repository
- """
- isFork: Boolean
-
- """
- If non-null, filters repositories according to whether they have been locked
- """
- isLocked: Boolean
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for repositories returned from the connection
- """
- orderBy: RepositoryOrder
-
- """
- Array of owner's affiliation options for repositories returned from the
- connection. For example, OWNER will include only repositories that the
- organization or user being viewed owns.
- """
- ownerAffiliations: [RepositoryAffiliation] = [OWNER, COLLABORATOR]
-
- """
- If non-null, filters repositories according to privacy
- """
- privacy: RepositoryPrivacy
- ): RepositoryConnection!
-
- """
- A list of repositories that the user recently contributed to.
- """
- repositoriesContributedTo(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- If non-null, include only the specified types of contributions. The
- GitHub.com UI uses [COMMIT, ISSUE, PULL_REQUEST, REPOSITORY]
- """
- contributionTypes: [RepositoryContributionType]
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- If true, include user repositories
- """
- includeUserRepositories: Boolean
-
- """
- If non-null, filters repositories according to whether they have been locked
- """
- isLocked: Boolean
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for repositories returned from the connection
- """
- orderBy: RepositoryOrder
-
- """
- If non-null, filters repositories according to privacy
- """
- privacy: RepositoryPrivacy
- ): RepositoryConnection!
-
- """
- Find Repository.
- """
- repository(
- """
- Name of Repository to find.
- """
- name: String!
- ): Repository
-
- """
- The HTTP path for this user
- """
- resourcePath: URI!
-
- """
- Repositories the user has starred.
- """
- starredRepositories(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Order for connection
- """
- orderBy: StarOrder
-
- """
- Filters starred repositories to only return repositories owned by the viewer.
- """
- ownedByViewer: Boolean
- ): StarredRepositoryConnection!
-
- """
- The user's description of what they're currently doing.
- """
- status: UserStatus
-
- """
- Identifies the date and time when the user was suspended.
- """
- suspendedAt: DateTime
-
- """
- Identifies the date and time when the object was last updated.
- """
- updatedAt: DateTime!
-
- """
- The HTTP URL for this user
- """
- url: URI!
-
- """
- Can the viewer pin repositories and gists to the profile?
- """
- viewerCanChangePinnedItems: Boolean!
-
- """
- Can the current viewer create new projects on this owner.
- """
- viewerCanCreateProjects: Boolean!
-
- """
- Whether or not the viewer is able to follow the user.
- """
- viewerCanFollow: Boolean!
-
- """
- Whether or not this user is followed by the viewer.
- """
- viewerIsFollowing: Boolean!
-
- """
- A list of repositories the given user is watching.
- """
- watching(
- """
- Affiliation options for repositories returned from the connection
- """
- affiliations: [RepositoryAffiliation] = [OWNER, COLLABORATOR, ORGANIZATION_MEMBER]
-
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- If non-null, filters repositories according to whether they have been locked
- """
- isLocked: Boolean
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for repositories returned from the connection
- """
- orderBy: RepositoryOrder
-
- """
- Array of owner's affiliation options for repositories returned from the
- connection. For example, OWNER will include only repositories that the
- organization or user being viewed owns.
- """
- ownerAffiliations: [RepositoryAffiliation] = [OWNER, COLLABORATOR]
-
- """
- If non-null, filters repositories according to privacy
- """
- privacy: RepositoryPrivacy
- ): RepositoryConnection!
-
- """
- A URL pointing to the user's public website/blog.
- """
- websiteUrl: URI
-}
-
-"""
-The possible durations that a user can be blocked for.
-"""
-enum UserBlockDuration {
- """
- The user was blocked for 1 day
- """
- ONE_DAY
-
- """
- The user was blocked for 30 days
- """
- ONE_MONTH
-
- """
- The user was blocked for 7 days
- """
- ONE_WEEK
-
- """
- The user was blocked permanently
- """
- PERMANENT
-
- """
- The user was blocked for 3 days
- """
- THREE_DAYS
-}
-
-"""
-Represents a 'user_blocked' event on a given user.
-"""
-type UserBlockedEvent implements Node {
- """
- Identifies the actor who performed the event.
- """
- actor: Actor
-
- """
- Number of days that the user was blocked for.
- """
- blockDuration: UserBlockDuration!
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
- id: ID!
-
- """
- The user who was blocked.
- """
- subject: User
-}
-
-"""
-The connection type for User.
-"""
-type UserConnection {
- """
- A list of edges.
- """
- edges: [UserEdge]
-
- """
- A list of nodes.
- """
- nodes: [User]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edit on user content
-"""
-type UserContentEdit implements Node {
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- Identifies the date and time when the object was deleted.
- """
- deletedAt: DateTime
-
- """
- The actor who deleted this content
- """
- deletedBy: Actor
-
- """
- A summary of the changes for this edit
- """
- diff: String
-
- """
- When this content was edited
- """
- editedAt: DateTime!
-
- """
- The actor who edited this content
- """
- editor: Actor
- id: ID!
-
- """
- Identifies the date and time when the object was last updated.
- """
- updatedAt: DateTime!
-}
-
-"""
-A list of edits to content.
-"""
-type UserContentEditConnection {
- """
- A list of edges.
- """
- edges: [UserContentEditEdge]
-
- """
- A list of nodes.
- """
- nodes: [UserContentEdit]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type UserContentEditEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: UserContentEdit
-}
-
-"""
-Represents a user.
-"""
-type UserEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: User
-}
-
-"""
-The user's description of what they're currently doing.
-"""
-type UserStatus implements Node {
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- An emoji summarizing the user's status.
- """
- emoji: String
-
- """
- ID of the object.
- """
- id: ID!
-
- """
- Whether this status indicates the user is not fully available on GitHub.
- """
- indicatesLimitedAvailability: Boolean!
-
- """
- A brief message describing what the user is doing.
- """
- message: String
-
- """
- The organization whose members can see this status. If null, this status is publicly visible.
- """
- organization: Organization
-
- """
- Identifies the date and time when the object was last updated.
- """
- updatedAt: DateTime!
-
- """
- The user who has this status.
- """
- user: User!
-}
-
-"""
-The connection type for UserStatus.
-"""
-type UserStatusConnection {
- """
- A list of edges.
- """
- edges: [UserStatusEdge]
-
- """
- A list of nodes.
- """
- nodes: [UserStatus]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
-
-"""
-An edge in a connection.
-"""
-type UserStatusEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: UserStatus
-}
-
-"""
-Ordering options for user status connections.
-"""
-input UserStatusOrder {
- """
- The ordering direction.
- """
- direction: OrderDirection!
-
- """
- The field to order user statuses by.
- """
- field: UserStatusOrderField!
-}
-
-"""
-Properties by which user status connections can be ordered.
-"""
-enum UserStatusOrderField {
- """
- Order user statuses by when they were updated.
- """
- UPDATED_AT
-}
-
-"""
-A hovercard context with a message describing how the viewer is related.
-"""
-type ViewerHovercardContext implements HovercardContext @preview(toggledBy: "hagar-preview") {
- """
- A string describing this context
- """
- message: String!
-
- """
- An octicon to accompany this context
- """
- octicon: String!
-
- """
- Identifies the user who is related to this context.
- """
- viewer: User!
-}
-
-"""
-A valid x509 certificate string
-"""
-scalar X509Certificate
diff --git a/data/graphql/2.18/graphql_previews.enterprise.yml b/data/graphql/2.18/graphql_previews.enterprise.yml
deleted file mode 100644
index d33c39257e48..000000000000
--- a/data/graphql/2.18/graphql_previews.enterprise.yml
+++ /dev/null
@@ -1,400 +0,0 @@
-- title: Audit Log
- description: This preview adds support for reading Audit Log entries.
- toggled_by: ':audit-log-preview'
- announcement: null
- updates: null
- toggled_on:
- - AccountPlanChangeAuditEntry.actorLocation
- - BusinessAddOrganizationAuditEntry.actorLocation
- - IssueCommentUpdateAuditEntry.actorLocation
- - OauthApplicationDestroyAuditEntry.actorLocation
- - OauthApplicationResetSecretAuditEntry.actorLocation
- - OauthApplicationRevokeTokensAuditEntry.actorLocation
- - OauthApplicationTransferAuditEntry.actorLocation
- - OrgAcceptBusinessInvitationAuditEntry.actorLocation
- - Organization.auditLog
- - OrgAuditLogExportAuditEntry.actorLocation
- - OrgBillingSignupErrorAuditEntry.actorLocation
- - OrgCancelBusinessInvitationAuditEntry.actorLocation
- - OrgCancelInvitationAuditEntry.actorLocation
- - OrgConfigDisableContributorsOnlyAuditEntry.actorLocation
- - OrgConfigDisableSockpuppetDisallowedAuditEntry.actorLocation
- - OrgConfigEnableContributorsOnlyAuditEntry.actorLocation
- - OrgConfigEnableSockpuppetDisallowedAuditEntry.actorLocation
- - OrgCreateAuditEntry.actorLocation
- - OrgRenameAuditEntry.actorLocation
- - PrivateRepositoryForkingClearAuditEntry.actorLocation
- - ProjectCreateAuditEntry.actorLocation
- - RepoAddTopicAuditEntry.actorLocation
- - RepoArchivedAuditEntry.actorLocation
- - RepoChangeMergeSettingAuditEntry.actorLocation
- - RepoCreateAuditEntry.actorLocation
- - RepoDestroyAuditEntry.actorLocation
- - RepoDisableAuditEntry.actorLocation
- - RepoEnableAuditEntry.actorLocation
- - RepoPagesCnameAuditEntry.actorLocation
- - RepoPagesCreateAuditEntry.actorLocation
- - RepoPagesDestroyAuditEntry.actorLocation
- - RepoPagesHttpsRedirectDisabledAuditEntry.actorLocation
- - RepoPagesHttpsRedirectEnabledAuditEntry.actorLocation
- - RepoPagesSourceAuditEntry.actorLocation
- - RepoRemoveTopicAuditEntry.actorLocation
- - RepoRenameAuditEntry.actorLocation
- - RepositoryVisibilityChangeClearAuditEntry.actorLocation
- - RepoTransferAuditEntry.actorLocation
- - RepoTransferStartAuditEntry.actorLocation
- - RepoUnarchivedAuditEntry.actorLocation
- - RepoUpdateMemberAuditEntry.actorLocation
- - TeamChangePrivacyAuditEntry.actorLocation
- - TeamCreateAuditEntry.actorLocation
- - TeamDeleteAuditEntry.actorLocation
- - TeamDestroyAuditEntry.actorLocation
- - TeamRenameAuditEntry.actorLocation
- - TeamUpdatePermissionAuditEntry.actorLocation
- - TeamUpdateRepositoryPermissionAuditEntry.actorLocation
- - UserAddEmailAuditEntry.actorLocation
- - UserStatusUpdateAuditEntry.actorLocation
- - AuditEntryActor
- - OrganizationAuditEntry
- - OrgRestoreMemberAuditEntryMembership
- - AuditLogOrder
- - AuditEntry
- - EnterpriseAuditEntryData
- - OauthApplicationAuditEntryData
- - OrganizationAuditEntryData
- - RepositoryAuditEntryData
- - TeamAuditEntryData
- - ActorLocation
- - MembersCanDeleteReposClearAuditEntry
- - MembersCanDeleteReposDisableAuditEntry
- - MembersCanDeleteReposEnableAuditEntry
- - OauthApplicationCreateAuditEntry
- - OrgAddBillingManagerAuditEntry
- - OrgAddMemberAuditEntry
- - OrgBlockUserAuditEntry
- - OrgConfigDisableCollaboratorsOnlyAuditEntry
- - OrgConfigEnableCollaboratorsOnlyAuditEntry
- - OrgDisableOauthAppRestrictionsAuditEntry
- - OrgDisableSamlAuditEntry
- - OrgDisableTwoFactorRequirementAuditEntry
- - OrgEnableOauthAppRestrictionsAuditEntry
- - OrgEnableSamlAuditEntry
- - OrgEnableTwoFactorRequirementAuditEntry
- - OrgInviteMemberAuditEntry
- - OrgInviteToBusinessAuditEntry
- - OrgOauthAppAccessApprovedAuditEntry
- - OrgOauthAppAccessDeniedAuditEntry
- - OrgOauthAppAccessRequestedAuditEntry
- - OrgRemoveBillingManagerAuditEntry
- - OrgRemoveMemberAuditEntry
- - OrgRemoveOutsideCollaboratorAuditEntry
- - OrgRestoreMemberAuditEntry
- - OrgRestoreMemberMembershipOrganizationAuditEntryData
- - OrgRestoreMemberMembershipRepositoryAuditEntryData
- - OrgRestoreMemberMembershipTeamAuditEntryData
- - OrgUnblockUserAuditEntry
- - OrgUpdateDefaultRepositoryPermissionAuditEntry
- - OrgUpdateMemberAuditEntry
- - OrgUpdateMemberRepositoryCreationPermissionAuditEntry
- - OrgUpdateMemberRepositoryInvitationPermissionAuditEntry
- - PrivateRepositoryForkingDisableAuditEntry
- - PrivateRepositoryForkingEnableAuditEntry
- - RepoAccessAuditEntry
- - RepoAddMemberAuditEntry
- - RepoConfigDisableAnonymousGitAccessAuditEntry
- - RepoConfigDisableCollaboratorsOnlyAuditEntry
- - RepoConfigDisableContributorsOnlyAuditEntry
- - RepoConfigDisableSockpuppetDisallowedAuditEntry
- - RepoConfigEnableAnonymousGitAccessAuditEntry
- - RepoConfigEnableCollaboratorsOnlyAuditEntry
- - RepoConfigEnableContributorsOnlyAuditEntry
- - RepoConfigEnableSockpuppetDisallowedAuditEntry
- - RepoConfigLockAnonymousGitAccessAuditEntry
- - RepoConfigUnlockAnonymousGitAccessAuditEntry
- - RepoRemoveMemberAuditEntry
- - RepositoryVisibilityChangeDisableAuditEntry
- - RepositoryVisibilityChangeEnableAuditEntry
- - TeamAddMemberAuditEntry
- - TeamAddRepositoryAuditEntry
- - TeamChangeParentTeamAuditEntry
- - TeamRemoveMemberAuditEntry
- - TeamRemoveRepositoryAuditEntry
- - AuditLogOrderField
- - OauthApplicationCreateAuditEntryState
- - OauthApplicationRevokeTokensAuditEntryState
- - OrgAddMemberAuditEntryPermission
- - OrgRemoveBillingManagerAuditEntryReason
- - OrgRemoveMemberAuditEntryMembershipType
- - OrgRemoveMemberAuditEntryReason
- - OrgRemoveOutsideCollaboratorAuditEntryMembershipType
- - OrgRemoveOutsideCollaboratorAuditEntryReason
- - OrgUpdateDefaultRepositoryPermissionAuditEntryPermission
- - OrgUpdateMemberAuditEntryPermission
- - OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility
- - RepoAccessAuditEntryVisibility
- - RepoAddMemberAuditEntryVisibility
- - RepoRemoveMemberAuditEntryVisibility
- - PreciseDateTime
- owning_teams:
- - '@github/audit-log'
-- title: Deployments
- description: >-
- This preview adds support for deployments mutations and new deployments
- features.
- toggled_by: ':flash-preview'
- announcement: null
- updates: null
- toggled_on:
- - DeploymentStatus.environment
- - Mutation.createDeploymentStatus
- - CreateDeploymentStatusInput
- - CreateDeploymentStatusPayload
- - Mutation.createDeployment
- - CreateDeploymentInput
- - CreateDeploymentPayload
- owning_teams:
- - '@github/ecosystem-api'
-- title: Draft Pull Requests Preview
- description: This preview adds support for draft pull requests.
- toggled_by: ':shadow-cat-preview'
- announcement: null
- updates: null
- toggled_on:
- - Mutation.markPullRequestReadyForReview
- - CreatePullRequestInput.draft
- - PullRequest.isDraft
- - MarkPullRequestReadyForReviewInput
- - MarkPullRequestReadyForReviewPayload
- owning_teams:
- - '@github/pe-pull-requests'
-- title: Checks
- description: This preview adds support for reading checks created by GitHub Apps.
- toggled_by: ':antiope-preview'
- announcement: null
- updates: null
- toggled_on:
- - CheckAnnotationRange
- - CheckAnnotationPosition
- - CheckAnnotationSpan
- - CheckAnnotation
- - CheckAnnotationConnection.nodes
- - CheckAnnotationData
- - CheckAnnotationEdge.node
- - CheckAnnotationLevel
- - CheckConclusionState
- - CheckStatusState
- - CheckSuiteAutoTriggerPreference
- - CheckRun
- - CheckRunConnection.nodes
- - CheckRunEdge.node
- - CheckRunAction
- - CheckRunFilter
- - CheckRunOutput
- - CheckRunOutputImage
- - CheckRunType
- - CheckSuite
- - CheckSuiteConnection.nodes
- - CheckSuiteEdge.node
- - CheckSuiteFilter
- - CreateCheckRunInput
- - CreateCheckRunPayload
- - CreateCheckSuiteInput
- - CreateCheckSuitePayload
- - Commit.checkSuites
- - Mutation.createCheckRun
- - Mutation.createCheckSuite
- - Mutation.rerequestCheckSuite
- - Mutation.updateCheckRun
- - Mutation.updateCheckSuitePreferences
- - Push
- - RequestableCheckStatusState
- - RerequestCheckSuiteInput
- - RerequestCheckSuitePayload
- - UpdateCheckRunInput
- - UpdateCheckRunPayload
- - UpdateCheckSuitePayload.checkSuite
- - UpdateCheckSuitePreferencesInput
- - UpdateCheckSuitePreferencesPayload
- owning_teams:
- - '@github/ecosystem-primitives'
-- title: Team discussions
- description: Adds support for reading and managing discussions within teams.
- toggled_by: ':echo-preview'
- announcement: null
- updates: null
- toggled_on:
- - CreateTeamDiscussionCommentInput
- - CreateTeamDiscussionCommentPayload
- - CreateTeamDiscussionInput
- - CreateTeamDiscussionPayload
- - DeleteTeamDiscussionCommentInput
- - DeleteTeamDiscussionCommentPayload
- - DeleteTeamDiscussionInput
- - DeleteTeamDiscussionPayload
- - Mutation.createTeamDiscussion
- - Mutation.createTeamDiscussionComment
- - Mutation.deleteTeamDiscussion
- - Mutation.deleteTeamDiscussionComment
- - Mutation.updateTeamDiscussion
- - Mutation.updateTeamDiscussionComment
- - Team.discussion
- - Team.discussions
- - Team.discussionsResourcePath
- - Team.discussionsUrl
- - TeamDiscussion
- - TeamDiscussionComment
- - TeamDiscussionCommentConnection
- - TeamDiscussionCommentEdge
- - TeamDiscussionCommentOrder
- - TeamDiscussionCommentOrderField
- - TeamDiscussionConnection
- - TeamDiscussionEdge
- - TeamDiscussionOrder
- - TeamDiscussionOrderField
- - UpdateTeamDiscussionCommentInput
- - UpdateTeamDiscussionCommentPayload
- - UpdateTeamDiscussionInput
- - UpdateTeamDiscussionPayload
- owning_teams:
- - '@github/identity'
-- title: Hovercards
- description: This preview adds support for reading hovercard contextual data
- toggled_by: ':hagar-preview'
- announcement: null
- updates: null
- toggled_on:
- - Issue.hovercard
- - PullRequest.hovercard
- - User.hovercard
- - HovercardContext
- - GenericHovercardContext
- - Hovercard
- - OrganizationTeamsHovercardContext
- - OrganizationsHovercardContext
- - ReviewStatusHovercardContext
- - ViewerHovercardContext
- owning_teams:
- - '@github/identity'
-- title: >-
- MergeInfoPreview - More detailed information about a pull request's merge
- state.
- description: >-
- This preview adds support for accessing fields that provide more detailed
- information about a pull request's merge state.
- toggled_by: ':merge-info-preview'
- announcement: null
- updates: null
- toggled_on:
- - PullRequest.canBeRebased
- - PullRequest.mergeStateStatus
- owning_teams:
- - '@github/pe-pull-requests'
-- title: Repository Vulnerability Alerts
- description: This preview adds support for viewing vulnerability alerts for a repository.
- toggled_by: ':vixen-preview'
- announcement: null
- updates: null
- toggled_on:
- - RepositoryVulnerabilityAlert
- - Repository.vulnerabilityAlerts
- - RepositoryVulnerabilityAlertConnection
- - RepositoryVulnerabilityAlertEdge
- owning_teams:
- - '@github/ee-security-workflows'
-- title: Temporary Cloning Token for Private Repositories
- description: >-
- This preview adds support for accessing a temporary token field for cloning
- private repositories.
- toggled_by: ':daredevil-preview'
- announcement: null
- updates: null
- toggled_on:
- - Repository.tempCloneToken
- owning_teams:
- - '@github/experience-engineering-work'
-- title: Project Event Details
- description: >-
- This preview adds project, project card, and project column details to
- project-related issue events.
- toggled_by: ':starfox-preview'
- announcement: null
- updates: null
- toggled_on:
- - AddedToProjectEvent.project
- - AddedToProjectEvent.projectCard
- - AddedToProjectEvent.projectColumnName
- - ConvertedNoteToIssueEvent.project
- - ConvertedNoteToIssueEvent.projectCard
- - ConvertedNoteToIssueEvent.projectColumnName
- - MovedColumnsInProjectEvent.project
- - MovedColumnsInProjectEvent.projectCard
- - MovedColumnsInProjectEvent.projectColumnName
- - MovedColumnsInProjectEvent.previousProjectColumnName
- - RemovedFromProjectEvent.project
- - RemovedFromProjectEvent.projectColumnName
- owning_teams:
- - '@github/github-projects'
-- title: Minimize Comments Preview
- description: >-
- This preview adds support for minimizing comments on issues, pull requests,
- commits, and gists.
- toggled_by: ':queen-beryl-preview'
- announcement: null
- updates: null
- toggled_on:
- - Mutation.minimizeComment
- - Mutation.unminimizeComment
- - Minimizable
- owning_teams:
- - '@github/ce-community-and-safety'
-- title: Create content attachments
- description: This preview adds support for creating content attachments.
- toggled_by: ':corsair-preview'
- announcement: null
- updates: null
- toggled_on:
- - Mutation.createContentAttachment
- owning_teams:
- - '@github/ecosystem-primitives'
-- title: Pinned Issues Preview
- description: This preview adds support for pinned issues.
- toggled_by: ':elektra-preview'
- announcement: null
- updates: null
- toggled_on:
- - Repository.pinnedIssues
- - PinnedIssue
- - PinnedIssueEdge
- - PinnedIssueConnection
- - Mutation.pinIssue
- - Mutation.unpinIssue
- owning_teams:
- - '@github/pe-pull-requests'
-- title: Labels Preview
- description: >-
- This preview adds support for adding, updating, creating and deleting
- labels.
- toggled_by: ':bane-preview'
- announcement: null
- updates: null
- toggled_on:
- - Mutation.createLabel
- - CreateLabelPayload
- - CreateLabelInput
- - Mutation.deleteLabel
- - DeleteLabelPayload
- - DeleteLabelInput
- - Mutation.updateLabel
- - UpdateLabelPayload
- - UpdateLabelInput
- owning_teams:
- - '@github/pe-pull-requests'
-- title: Import Project
- description: This preview adds support for importing projects.
- toggled_by: ':slothette-preview'
- announcement: null
- updates: null
- toggled_on:
- - Mutation.importProject
- owning_teams:
- - '@github/pe-issues-projects'
diff --git a/data/graphql/2.18/graphql_upcoming_changes.public-enterprise.yml b/data/graphql/2.18/graphql_upcoming_changes.public-enterprise.yml
deleted file mode 100644
index eb6b6f3ddaf2..000000000000
--- a/data/graphql/2.18/graphql_upcoming_changes.public-enterprise.yml
+++ /dev/null
@@ -1,96 +0,0 @@
----
-upcoming_changes:
-- location: Migration.uploadUrlTemplate
- description: "`uploadUrlTemplate` will be removed. Use `uploadUrl` instead."
- reason: "`uploadUrlTemplate` is being removed because it is not a standard URL and
- adds an extra user step."
- date: '2019-04-01T00:00:00+00:00'
- criticality: breaking
- owner: tambling
-- location: Organization.members
- description: "`members` will be removed. Use `Organization.membersWithRole` instead."
- reason: The `members` field is deprecated and will be removed soon.
- date: '2019-04-01T00:00:00+00:00'
- criticality: breaking
- owner: xuorig
-- location: ContributionsCollection.firstIssueContribution.ignoreTimeRange
- description: "`ignoreTimeRange` will be removed. Use a `ContributionsCollection`
- starting sufficiently far back"
- reason: ignore_time_range will be removed
- date: '2019-07-01T00:00:00+00:00'
- criticality: breaking
- owner: seejohnrun
-- location: ContributionsCollection.firstPullRequestContribution.ignoreTimeRange
- description: "`ignoreTimeRange` will be removed. Use a `ContributionsCollection`
- starting sufficiently far back"
- reason: ignore_time_range will be removed
- date: '2019-07-01T00:00:00+00:00'
- criticality: breaking
- owner: seejohnrun
-- location: ContributionsCollection.firstRepositoryContribution.ignoreTimeRange
- description: "`ignoreTimeRange` will be removed. Use a `ContributionsCollection`
- starting sufficiently far back"
- reason: ignore_time_range will be removed
- date: '2019-07-01T00:00:00+00:00'
- criticality: breaking
- owner: seejohnrun
-- location: ContributionsCollection.joinedGitHubContribution.ignoreTimeRange
- description: "`ignoreTimeRange` will be removed. Use a `ContributionsCollection`
- starting sufficiently far back"
- reason: ignore_time_range will be removed
- date: '2019-07-01T00:00:00+00:00'
- criticality: breaking
- owner: seejohnrun
-- location: ReviewDismissedEvent.message
- description: "`message` will be removed. Use `dismissalMessage` instead."
- reason: "`message` is being removed because it not nullable, whereas the underlying
- field is optional."
- date: '2019-07-01T00:00:00+00:00'
- criticality: breaking
- owner: nickvanw
-- location: ReviewDismissedEvent.messageHtml
- description: "`messageHtml` will be removed. Use `dismissalMessageHTML` instead."
- reason: "`messageHtml` is being removed because it not nullable, whereas the underlying
- field is optional."
- date: '2019-07-01T00:00:00+00:00'
- criticality: breaking
- owner: nickvanw
-- location: ContributionOrder.field
- description: "`field` will be removed. Only one order field is supported."
- reason: "`field` will be removed."
- date: '2019-10-01T00:00:00+00:00'
- criticality: breaking
- owner: dinahshi
-- location: Issue.timeline
- description: "`timeline` will be removed. Use Issue.timelineItems instead."
- reason: "`timeline` will be removed"
- date: '2019-10-01T00:00:00+00:00'
- criticality: breaking
- owner: mikesea
-- location: Organization.pinnedRepositories
- description: "`pinnedRepositories` will be removed. Use ProfileOwner.pinnedItems
- instead."
- reason: pinnedRepositories will be removed
- date: '2019-10-01T00:00:00+00:00'
- criticality: breaking
- owner: cheshire137
-- location: PullRequest.timeline
- description: "`timeline` will be removed. Use PullRequest.timelineItems instead."
- reason: "`timeline` will be removed"
- date: '2019-10-01T00:00:00+00:00'
- criticality: breaking
- owner: mikesea
-- location: RepositoryOwner.pinnedRepositories
- description: "`pinnedRepositories` will be removed. Use ProfileOwner.pinnedItems
- instead."
- reason: pinnedRepositories will be removed
- date: '2019-10-01T00:00:00+00:00'
- criticality: breaking
- owner: cheshire137
-- location: User.pinnedRepositories
- description: "`pinnedRepositories` will be removed. Use ProfileOwner.pinnedItems
- instead."
- reason: pinnedRepositories will be removed
- date: '2019-10-01T00:00:00+00:00'
- criticality: breaking
- owner: cheshire137
diff --git a/data/graphql/ghae/graphql_previews.ghae.yml b/data/graphql/ghae/graphql_previews.ghae.yml
new file mode 100644
index 000000000000..c17115e10c1b
--- /dev/null
+++ b/data/graphql/ghae/graphql_previews.ghae.yml
@@ -0,0 +1,145 @@
+- title: Access to package version deletion
+ description: >-
+ This preview adds support for the DeletePackageVersion mutation which
+ enables deletion of private package versions.
+ toggled_by: ':package-deletes-preview'
+ announcement: null
+ updates: null
+ toggled_on:
+ - Mutation.deletePackageVersion
+ owning_teams:
+ - '@github/pe-package-registry'
+- title: Deployments
+ description: >-
+ This preview adds support for deployments mutations and new deployments
+ features.
+ toggled_by: ':flash-preview'
+ announcement: null
+ updates: null
+ toggled_on:
+ - DeploymentStatus.environment
+ - Mutation.createDeploymentStatus
+ - CreateDeploymentStatusInput
+ - CreateDeploymentStatusPayload
+ - Mutation.createDeployment
+ - CreateDeploymentInput
+ - CreateDeploymentPayload
+ owning_teams:
+ - '@github/ecosystem-api'
+- title: >-
+ MergeInfoPreview - More detailed information about a pull request's merge
+ state.
+ description: >-
+ This preview adds support for accessing fields that provide more detailed
+ information about a pull request's merge state.
+ toggled_by: ':merge-info-preview'
+ announcement: null
+ updates: null
+ toggled_on:
+ - PullRequest.canBeRebased
+ - PullRequest.mergeStateStatus
+ owning_teams:
+ - '@github/pe-pull-requests'
+- title: UpdateRefsPreview - Update multiple refs in a single operation.
+ description: This preview adds support for updating multiple refs in a single operation.
+ toggled_by: ':update-refs-preview'
+ announcement: null
+ updates: null
+ toggled_on:
+ - Mutation.updateRefs
+ - GitRefname
+ - RefUpdate
+ - UpdateRefsInput
+ - UpdateRefsPayload
+ owning_teams:
+ - '@github/reponauts'
+- title: Project Event Details
+ description: >-
+ This preview adds project, project card, and project column details to
+ project-related issue events.
+ toggled_by: ':starfox-preview'
+ announcement: null
+ updates: null
+ toggled_on:
+ - AddedToProjectEvent.project
+ - AddedToProjectEvent.projectCard
+ - AddedToProjectEvent.projectColumnName
+ - ConvertedNoteToIssueEvent.project
+ - ConvertedNoteToIssueEvent.projectCard
+ - ConvertedNoteToIssueEvent.projectColumnName
+ - MovedColumnsInProjectEvent.project
+ - MovedColumnsInProjectEvent.projectCard
+ - MovedColumnsInProjectEvent.projectColumnName
+ - MovedColumnsInProjectEvent.previousProjectColumnName
+ - RemovedFromProjectEvent.project
+ - RemovedFromProjectEvent.projectColumnName
+ owning_teams:
+ - '@github/github-projects'
+- title: Create content attachments
+ description: This preview adds support for creating content attachments.
+ toggled_by: ':corsair-preview'
+ announcement: null
+ updates: null
+ toggled_on:
+ - Mutation.createContentAttachment
+ owning_teams:
+ - '@github/ce-extensibility'
+- title: Pinned Issues Preview
+ description: This preview adds support for pinned issues.
+ toggled_by: ':elektra-preview'
+ announcement: null
+ updates: null
+ toggled_on:
+ - Repository.pinnedIssues
+ - PinnedIssue
+ - PinnedIssueEdge
+ - PinnedIssueConnection
+ - Mutation.pinIssue
+ - Mutation.unpinIssue
+ owning_teams:
+ - '@github/pe-pull-requests'
+- title: Labels Preview
+ description: >-
+ This preview adds support for adding, updating, creating and deleting
+ labels.
+ toggled_by: ':bane-preview'
+ announcement: null
+ updates: null
+ toggled_on:
+ - Mutation.createLabel
+ - CreateLabelPayload
+ - CreateLabelInput
+ - Mutation.deleteLabel
+ - DeleteLabelPayload
+ - DeleteLabelInput
+ - Mutation.updateLabel
+ - UpdateLabelPayload
+ - UpdateLabelInput
+ owning_teams:
+ - '@github/pe-pull-requests'
+- title: Import Project
+ description: This preview adds support for importing projects.
+ toggled_by: ':slothette-preview'
+ announcement: null
+ updates: null
+ toggled_on:
+ - Mutation.importProject
+ owning_teams:
+ - '@github/pe-issues-projects'
+- title: Team Review Assignments Preview
+ description: >-
+ This preview adds support for updating the settings for team review
+ assignment.
+ toggled_by: ':stone-crop-preview'
+ announcement: null
+ updates: null
+ toggled_on:
+ - Mutation.updateTeamReviewAssignment
+ - UpdateTeamReviewAssignmentInput
+ - TeamReviewAssignmentAlgorithm
+ - Team.reviewRequestDelegationEnabled
+ - Team.reviewRequestDelegationAlgorithm
+ - Team.reviewRequestDelegationMemberCount
+ - Team.reviewRequestDelegationNotifyTeam
+ owning_teams:
+ - '@github/pe-pull-requests'
diff --git a/data/graphql/ghae/graphql_upcoming_changes.public-ghae.yml b/data/graphql/ghae/graphql_upcoming_changes.public-ghae.yml
new file mode 100644
index 000000000000..56e1ff90ea8f
--- /dev/null
+++ b/data/graphql/ghae/graphql_upcoming_changes.public-ghae.yml
@@ -0,0 +1,106 @@
+---
+upcoming_changes:
+- location: Migration.uploadUrlTemplate
+ description: "`uploadUrlTemplate` will be removed. Use `uploadUrl` instead."
+ reason: "`uploadUrlTemplate` is being removed because it is not a standard URL and
+ adds an extra user step."
+ date: '2019-04-01T00:00:00+00:00'
+ criticality: breaking
+ owner: tambling
+- location: AssignedEvent.user
+ description: "`user` will be removed. Use the `assignee` field instead."
+ reason: Assignees can now be mannequins.
+ date: '2020-01-01T00:00:00+00:00'
+ criticality: breaking
+ owner: tambling
+- location: EnterpriseBillingInfo.availableSeats
+ description: "`availableSeats` will be removed. Use EnterpriseBillingInfo.totalAvailableLicenses
+ instead."
+ reason: "`availableSeats` will be replaced with `totalAvailableLicenses` to provide
+ more clarity on the value being returned"
+ date: '2020-01-01T00:00:00+00:00'
+ criticality: breaking
+ owner: BlakeWilliams
+- location: EnterpriseBillingInfo.seats
+ description: "`seats` will be removed. Use EnterpriseBillingInfo.totalLicenses instead."
+ reason: "`seats` will be replaced with `totalLicenses` to provide more clarity on
+ the value being returned"
+ date: '2020-01-01T00:00:00+00:00'
+ criticality: breaking
+ owner: BlakeWilliams
+- location: UnassignedEvent.user
+ description: "`user` will be removed. Use the `assignee` field instead."
+ reason: Assignees can now be mannequins.
+ date: '2020-01-01T00:00:00+00:00'
+ criticality: breaking
+ owner: tambling
+- location: Sponsorship.maintainer
+ description: "`maintainer` will be removed. Use `Sponsorship.sponsorable` instead."
+ reason: "`Sponsorship.maintainer` will be removed."
+ date: '2020-04-01T00:00:00+00:00'
+ criticality: breaking
+ owner: antn
+- location: EnterprisePendingMemberInvitationEdge.isUnlicensed
+ description: "`isUnlicensed` will be removed."
+ reason: All pending members consume a license
+ date: '2020-07-01T00:00:00+00:00'
+ criticality: breaking
+ owner: BrentWheeldon
+- location: EnterpriseOwnerInfo.pendingCollaborators
+ description: "`pendingCollaborators` will be removed. Use the `pendingCollaboratorInvitations`
+ field instead."
+ reason: Repository invitations can now be associated with an email, not only an
+ invitee.
+ date: '2020-10-01T00:00:00+00:00'
+ criticality: breaking
+ owner: jdennes
+- location: Issue.timeline
+ description: "`timeline` will be removed. Use Issue.timelineItems instead."
+ reason: "`timeline` will be removed"
+ date: '2020-10-01T00:00:00+00:00'
+ criticality: breaking
+ owner: mikesea
+- location: PullRequest.timeline
+ description: "`timeline` will be removed. Use PullRequest.timelineItems instead."
+ reason: "`timeline` will be removed"
+ date: '2020-10-01T00:00:00+00:00'
+ criticality: breaking
+ owner: mikesea
+- location: RepositoryInvitationOrderField.INVITEE_LOGIN
+ description: "`INVITEE_LOGIN` will be removed."
+ reason: "`INVITEE_LOGIN` is no longer a valid field value. Repository invitations
+ can now be associated with an email, not only an invitee."
+ date: '2020-10-01T00:00:00+00:00'
+ criticality: breaking
+ owner: jdennes
+- location: Sponsorship.sponsor
+ description: "`sponsor` will be removed. Use `Sponsorship.sponsorEntity` instead."
+ reason: "`Sponsorship.sponsor` will be removed."
+ date: '2020-10-01T00:00:00+00:00'
+ criticality: breaking
+ owner: nholden
+- location: EnterpriseMemberEdge.isUnlicensed
+ description: "`isUnlicensed` will be removed."
+ reason: All members consume a license
+ date: '2021-01-01T00:00:00+00:00'
+ criticality: breaking
+ owner: BrentWheeldon
+- location: EnterpriseOutsideCollaboratorEdge.isUnlicensed
+ description: "`isUnlicensed` will be removed."
+ reason: All outside collaborators consume a license
+ date: '2021-01-01T00:00:00+00:00'
+ criticality: breaking
+ owner: BrentWheeldon
+- location: EnterprisePendingCollaboratorEdge.isUnlicensed
+ description: "`isUnlicensed` will be removed."
+ reason: All pending collaborators consume a license
+ date: '2021-01-01T00:00:00+00:00'
+ criticality: breaking
+ owner: BrentWheeldon
+- location: MergeStateStatus.DRAFT
+ description: "`DRAFT` will be removed. Use PullRequest.isDraft instead."
+ reason: DRAFT state will be removed from this enum and `isDraft` should be used
+ instead
+ date: '2021-01-01T00:00:00+00:00'
+ criticality: breaking
+ owner: nplasterer
diff --git a/data/graphql/2.18/schema.docs-enterprise.graphql b/data/graphql/ghae/schema.docs-ghae.graphql
similarity index 74%
rename from data/graphql/2.18/schema.docs-enterprise.graphql
rename to data/graphql/ghae/schema.docs-ghae.graphql
index 9379f72a9a13..7bca3e6574b3 100644
--- a/data/graphql/2.18/schema.docs-enterprise.graphql
+++ b/data/graphql/ghae/schema.docs-ghae.graphql
@@ -20,7 +20,7 @@ directive @preview(
"""
The identifier of the API preview that toggles this field.
"""
- toggledBy: String
+ toggledBy: String!
) on SCALAR | OBJECT | FIELD_DEFINITION | ARGUMENT_DEFINITION | INTERFACE | UNION | ENUM | ENUM_VALUE | INPUT_OBJECT | INPUT_FIELD_DEFINITION
"""
@@ -56,7 +56,7 @@ interface Actor {
"""
Location information for an actor
"""
-type ActorLocation @preview(toggledBy: "audit-log-preview") {
+type ActorLocation {
"""
City
"""
@@ -163,6 +163,56 @@ type AddCommentPayload {
timelineEdge: IssueTimelineItemEdge
}
+"""
+Autogenerated input type of AddEnterpriseAdmin
+"""
+input AddEnterpriseAdminInput {
+ """
+ A unique identifier for the client performing the mutation.
+ """
+ clientMutationId: String
+
+ """
+ The ID of the enterprise account to which the administrator should be added.
+ """
+ enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"])
+
+ """
+ The login of the user to add as an administrator.
+ """
+ login: String!
+}
+
+"""
+Autogenerated return type of AddEnterpriseAdmin
+"""
+type AddEnterpriseAdminPayload {
+ """
+ The user who was added as an administrator.
+ """
+ admin: User
+
+ """
+ A unique identifier for the client performing the mutation.
+ """
+ clientMutationId: String
+
+ """
+ The updated enterprise.
+ """
+ enterprise: Enterprise
+
+ """
+ The role of the administrator.
+ """
+ role: EnterpriseAdministratorRole
+
+ """
+ The viewer performing the mutation.
+ """
+ viewer: User
+}
+
"""
Autogenerated input type of AddLabelsToLabelable
"""
@@ -317,10 +367,15 @@ input AddPullRequestReviewCommentInput {
"""
position: Int
+ """
+ The node ID of the pull request reviewing
+ """
+ pullRequestId: ID @possibleTypes(concreteTypes: ["PullRequest"])
+
"""
The Node ID of the review to modify.
"""
- pullRequestReviewId: ID! @possibleTypes(concreteTypes: ["PullRequestReview"])
+ pullRequestReviewId: ID @possibleTypes(concreteTypes: ["PullRequestReview"])
}
"""
@@ -376,6 +431,11 @@ input AddPullRequestReviewInput {
The Node ID of the pull request to modify.
"""
pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"])
+
+ """
+ The review line comment threads.
+ """
+ threads: [DraftPullRequestReviewThread]
}
"""
@@ -398,6 +458,71 @@ type AddPullRequestReviewPayload {
reviewEdge: PullRequestReviewEdge
}
+"""
+Autogenerated input type of AddPullRequestReviewThread
+"""
+input AddPullRequestReviewThreadInput {
+ """
+ Body of the thread's first comment.
+ """
+ body: String!
+
+ """
+ A unique identifier for the client performing the mutation.
+ """
+ clientMutationId: String
+
+ """
+ The line of the blob to which the thread refers. The end of the line range for multi-line comments.
+ """
+ line: Int!
+
+ """
+ Path to the file being commented on.
+ """
+ path: String!
+
+ """
+ The node ID of the pull request reviewing
+ """
+ pullRequestId: ID @possibleTypes(concreteTypes: ["PullRequest"])
+
+ """
+ The Node ID of the review to modify.
+ """
+ pullRequestReviewId: ID @possibleTypes(concreteTypes: ["PullRequestReview"])
+
+ """
+ The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range.
+ """
+ side: DiffSide = RIGHT
+
+ """
+ The first line of the range to which the comment refers.
+ """
+ startLine: Int
+
+ """
+ The side of the diff on which the start line resides.
+ """
+ startSide: DiffSide = RIGHT
+}
+
+"""
+Autogenerated return type of AddPullRequestReviewThread
+"""
+type AddPullRequestReviewThreadPayload {
+ """
+ A unique identifier for the client performing the mutation.
+ """
+ clientMutationId: String
+
+ """
+ The newly created thread.
+ """
+ thread: PullRequestReviewThread
+}
+
"""
Autogenerated input type of AddReaction
"""
@@ -560,6 +685,36 @@ type App implements Node {
url: URI!
}
+"""
+Autogenerated input type of ArchiveRepository
+"""
+input ArchiveRepositoryInput {
+ """
+ A unique identifier for the client performing the mutation.
+ """
+ clientMutationId: String
+
+ """
+ The ID of the repository to mark as archived.
+ """
+ repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
+}
+
+"""
+Autogenerated return type of ArchiveRepository
+"""
+type ArchiveRepositoryPayload {
+ """
+ A unique identifier for the client performing the mutation.
+ """
+ clientMutationId: String
+
+ """
+ The repository that was marked as archived.
+ """
+ repository: Repository
+}
+
"""
An object that can have users assigned to it.
"""
@@ -604,6 +759,11 @@ type AssignedEvent implements Node {
"""
assignable: Assignable!
+ """
+ Identifies the user or mannequin that was assigned.
+ """
+ assignee: Assignee
+
"""
Identifies the date and time when the object was created.
"""
@@ -613,13 +773,18 @@ type AssignedEvent implements Node {
"""
Identifies the user who was assigned.
"""
- user: User
+ user: User @deprecated(reason: "Assignees can now be mannequins. Use the `assignee` field instead. Removal on 2020-01-01 UTC.")
}
+"""
+Types that can be assigned to issues.
+"""
+union Assignee = Bot | Mannequin | Organization | User
+
"""
An entry in the audit log.
"""
-interface AuditEntry @preview(toggledBy: "audit-log-preview") {
+interface AuditEntry {
"""
The action name
"""
@@ -638,7 +803,7 @@ interface AuditEntry @preview(toggledBy: "audit-log-preview") {
"""
A readable representation of the actor's location
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ actorLocation: ActorLocation
"""
The username of the user who initiated the action
@@ -660,6 +825,11 @@ interface AuditEntry @preview(toggledBy: "audit-log-preview") {
"""
createdAt: PreciseDateTime!
+ """
+ The corresponding operation type for the action
+ """
+ operationType: OperationType
+
"""
The user affected by the action
"""
@@ -684,12 +854,12 @@ interface AuditEntry @preview(toggledBy: "audit-log-preview") {
"""
Types that can initiate an audit log event.
"""
-union AuditEntryActor @preview(toggledBy: "audit-log-preview") = Bot | Organization | User
+union AuditEntryActor = Bot | Organization | User
"""
Ordering options for Audit Log connections.
"""
-input AuditLogOrder @preview(toggledBy: "audit-log-preview") {
+input AuditLogOrder {
"""
The ordering direction.
"""
@@ -704,13 +874,75 @@ input AuditLogOrder @preview(toggledBy: "audit-log-preview") {
"""
Properties by which Audit Log connections can be ordered.
"""
-enum AuditLogOrderField @preview(toggledBy: "audit-log-preview") {
+enum AuditLogOrderField {
"""
Order audit log entries by timestamp
"""
CREATED_AT
}
+"""
+Represents a 'automatic_base_change_failed' event on a given pull request.
+"""
+type AutomaticBaseChangeFailedEvent implements Node {
+ """
+ Identifies the actor who performed the event.
+ """
+ actor: Actor
+
+ """
+ Identifies the date and time when the object was created.
+ """
+ createdAt: DateTime!
+ id: ID!
+
+ """
+ The new base for this PR
+ """
+ newBase: String!
+
+ """
+ The old base for this PR
+ """
+ oldBase: String!
+
+ """
+ PullRequest referenced by event.
+ """
+ pullRequest: PullRequest!
+}
+
+"""
+Represents a 'automatic_base_change_succeeded' event on a given pull request.
+"""
+type AutomaticBaseChangeSucceededEvent implements Node {
+ """
+ Identifies the actor who performed the event.
+ """
+ actor: Actor
+
+ """
+ Identifies the date and time when the object was created.
+ """
+ createdAt: DateTime!
+ id: ID!
+
+ """
+ The new base for this PR
+ """
+ newBase: String!
+
+ """
+ The old base for this PR
+ """
+ oldBase: String!
+
+ """
+ PullRequest referenced by event.
+ """
+ pullRequest: PullRequest!
+}
+
"""
Represents a 'base_ref_changed' event on a given issue or pull request.
"""
@@ -725,11 +957,52 @@ type BaseRefChangedEvent implements Node {
"""
createdAt: DateTime!
+ """
+ Identifies the name of the base ref for the pull request after it was changed.
+ """
+ currentRefName: String!
+
"""
Identifies the primary key from the database.
"""
databaseId: Int
id: ID!
+
+ """
+ Identifies the name of the base ref for the pull request before it was changed.
+ """
+ previousRefName: String!
+
+ """
+ PullRequest referenced by event.
+ """
+ pullRequest: PullRequest!
+}
+
+"""
+Represents a 'base_ref_deleted' event on a given pull request.
+"""
+type BaseRefDeletedEvent implements Node {
+ """
+ Identifies the actor who performed the event.
+ """
+ actor: Actor
+
+ """
+ Identifies the name of the Ref associated with the `base_ref_deleted` event.
+ """
+ baseRefName: String
+
+ """
+ Identifies the date and time when the object was created.
+ """
+ createdAt: DateTime!
+ id: ID!
+
+ """
+ PullRequest referenced by event.
+ """
+ pullRequest: PullRequest
}
"""
@@ -832,9 +1105,9 @@ type Blob implements GitObject & Node {
id: ID!
"""
- Indicates whether the Blob is binary or text
+ Indicates whether the Blob is binary or text. Returns null if unable to determine the encoding.
"""
- isBinary: Boolean!
+ isBinary: Boolean
"""
Indicates whether the contents is truncated
@@ -907,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
"""
@@ -976,6 +1259,11 @@ type BranchProtectionRule implements Node {
Returns the last _n_ elements from the list.
"""
last: Int
+
+ """
+ Filters refs with query on name
+ """
+ query: String
): RefConnection!
"""
@@ -1038,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.
"""
@@ -1238,7 +1531,7 @@ type ChangeUserStatusPayload {
"""
A single check annotation.
"""
-type CheckAnnotation @preview(toggledBy: "antiope-preview") {
+type CheckAnnotation {
"""
The annotation's severity level.
"""
@@ -1292,7 +1585,7 @@ type CheckAnnotationConnection {
"""
A list of nodes.
"""
- nodes: [CheckAnnotation] @preview(toggledBy: "antiope-preview")
+ nodes: [CheckAnnotation]
"""
Information to aid in pagination.
@@ -1308,7 +1601,7 @@ type CheckAnnotationConnection {
"""
Information from a check run analysis to specific lines of code.
"""
-input CheckAnnotationData @preview(toggledBy: "antiope-preview") {
+input CheckAnnotationData {
"""
Represents an annotation's information level
"""
@@ -1352,13 +1645,13 @@ type CheckAnnotationEdge {
"""
The item at the end of the edge.
"""
- node: CheckAnnotation @preview(toggledBy: "antiope-preview")
+ node: CheckAnnotation
}
"""
Represents an annotation's information level.
"""
-enum CheckAnnotationLevel @preview(toggledBy: "antiope-preview") {
+enum CheckAnnotationLevel {
"""
An annotation indicating an inescapable error.
"""
@@ -1378,7 +1671,7 @@ enum CheckAnnotationLevel @preview(toggledBy: "antiope-preview") {
"""
A character position in a check annotation.
"""
-type CheckAnnotationPosition @preview(toggledBy: "antiope-preview") {
+type CheckAnnotationPosition {
"""
Column number (1 indexed).
"""
@@ -1393,7 +1686,7 @@ type CheckAnnotationPosition @preview(toggledBy: "antiope-preview") {
"""
Information from a check run analysis to specific lines of code.
"""
-input CheckAnnotationRange @preview(toggledBy: "antiope-preview") {
+input CheckAnnotationRange {
"""
The ending column of the range.
"""
@@ -1418,7 +1711,7 @@ input CheckAnnotationRange @preview(toggledBy: "antiope-preview") {
"""
An inclusive pair of positions for a check annotation.
"""
-type CheckAnnotationSpan @preview(toggledBy: "antiope-preview") {
+type CheckAnnotationSpan {
"""
End position (inclusive).
"""
@@ -1433,7 +1726,7 @@ type CheckAnnotationSpan @preview(toggledBy: "antiope-preview") {
"""
The possible states for a check suite or run conclusion.
"""
-enum CheckConclusionState @preview(toggledBy: "antiope-preview") {
+enum CheckConclusionState {
"""
The check suite or run requires action.
"""
@@ -1454,6 +1747,16 @@ enum CheckConclusionState @preview(toggledBy: "antiope-preview") {
"""
NEUTRAL
+ """
+ The check suite or run was skipped.
+ """
+ SKIPPED
+
+ """
+ The check suite or run was marked stale by GitHub. Only GitHub can use this conclusion.
+ """
+ STALE
+
"""
The check suite or run has succeeded.
"""
@@ -1468,7 +1771,7 @@ enum CheckConclusionState @preview(toggledBy: "antiope-preview") {
"""
A check run.
"""
-type CheckRun implements Node & UniformResourceLocatable @preview(toggledBy: "antiope-preview") {
+type CheckRun implements Node & UniformResourceLocatable {
"""
The check run's annotations
"""
@@ -1579,7 +1882,7 @@ type CheckRun implements Node & UniformResourceLocatable @preview(toggledBy: "an
"""
Possible further actions the integrator can perform.
"""
-input CheckRunAction @preview(toggledBy: "antiope-preview") {
+input CheckRunAction {
"""
A short explanation of what this action would do.
"""
@@ -1608,7 +1911,7 @@ type CheckRunConnection {
"""
A list of nodes.
"""
- nodes: [CheckRun] @preview(toggledBy: "antiope-preview")
+ nodes: [CheckRun]
"""
Information to aid in pagination.
@@ -1633,13 +1936,13 @@ type CheckRunEdge {
"""
The item at the end of the edge.
"""
- node: CheckRun @preview(toggledBy: "antiope-preview")
+ node: CheckRun
}
"""
The filters that are available when fetching check runs.
"""
-input CheckRunFilter @preview(toggledBy: "antiope-preview") {
+input CheckRunFilter {
"""
Filters the check runs created by this application ID.
"""
@@ -1664,7 +1967,7 @@ input CheckRunFilter @preview(toggledBy: "antiope-preview") {
"""
Descriptive details about the check run.
"""
-input CheckRunOutput @preview(toggledBy: "antiope-preview") {
+input CheckRunOutput {
"""
The annotations that are made as part of the check run.
"""
@@ -1694,7 +1997,7 @@ input CheckRunOutput @preview(toggledBy: "antiope-preview") {
"""
Images attached to the check run output displayed in the GitHub pull request UI.
"""
-input CheckRunOutputImage @preview(toggledBy: "antiope-preview") {
+input CheckRunOutputImage {
"""
The alternative text for the image.
"""
@@ -1714,7 +2017,7 @@ input CheckRunOutputImage @preview(toggledBy: "antiope-preview") {
"""
The possible types of check runs.
"""
-enum CheckRunType @preview(toggledBy: "antiope-preview") {
+enum CheckRunType {
"""
Every check run available.
"""
@@ -1729,7 +2032,7 @@ enum CheckRunType @preview(toggledBy: "antiope-preview") {
"""
The possible states for a check suite or run status.
"""
-enum CheckStatusState @preview(toggledBy: "antiope-preview") {
+enum CheckStatusState {
"""
The check suite or run has been completed.
"""
@@ -1754,7 +2057,7 @@ enum CheckStatusState @preview(toggledBy: "antiope-preview") {
"""
A check suite.
"""
-type CheckSuite implements Node @preview(toggledBy: "antiope-preview") {
+type CheckSuite implements Node {
"""
The GitHub App which created this check suite.
"""
@@ -1876,6 +2179,11 @@ type CheckSuite implements Node @preview(toggledBy: "antiope-preview") {
"""
repository: Repository!
+ """
+ The HTTP path for this check suite
+ """
+ resourcePath: URI!
+
"""
The status of this check suite.
"""
@@ -1885,12 +2193,17 @@ type CheckSuite implements Node @preview(toggledBy: "antiope-preview") {
Identifies the date and time when the object was last updated.
"""
updatedAt: DateTime!
+
+ """
+ The HTTP URL for this check suite
+ """
+ url: URI!
}
"""
The auto-trigger preferences that are available for check suites.
"""
-input CheckSuiteAutoTriggerPreference @preview(toggledBy: "antiope-preview") {
+input CheckSuiteAutoTriggerPreference {
"""
The node ID of the application that owns the check suite.
"""
@@ -1914,7 +2227,7 @@ type CheckSuiteConnection {
"""
A list of nodes.
"""
- nodes: [CheckSuite] @preview(toggledBy: "antiope-preview")
+ nodes: [CheckSuite]
"""
Information to aid in pagination.
@@ -1939,13 +2252,13 @@ type CheckSuiteEdge {
"""
The item at the end of the edge.
"""
- node: CheckSuite @preview(toggledBy: "antiope-preview")
+ node: CheckSuite
}
"""
The filters that are available when fetching check suites.
"""
-input CheckSuiteFilter @preview(toggledBy: "antiope-preview") {
+input CheckSuiteFilter {
"""
Filters the check suites created by this application ID.
"""
@@ -2061,6 +2374,12 @@ input CloneTemplateRepositoryInput {
"""
description: String
+ """
+ Whether to copy all branches from the template to the new repository. Defaults
+ to copying only the default branch of the template.
+ """
+ includeAllBranches: Boolean = false
+
"""
The name of the new repository.
"""
@@ -2384,6 +2703,11 @@ enum CommentAuthorAssociation {
"""
FIRST_TIME_CONTRIBUTOR
+ """
+ Author is a placeholder for an unclaimed user.
+ """
+ MANNEQUIN
+
"""
Author is a member of the organization that owns the repository.
"""
@@ -2404,6 +2728,11 @@ enum CommentAuthorAssociation {
The possible errors that will prevent a user from updating a comment.
"""
enum CommentCannotUpdateReason {
+ """
+ Unable to create comment because repository is archived.
+ """
+ ARCHIVED
+
"""
You cannot update this comment
"""
@@ -2453,6 +2782,11 @@ type CommentDeletedEvent implements Node {
Identifies the primary key from the database.
"""
databaseId: Int
+
+ """
+ The user who authored the deleted comment.
+ """
+ deletedCommentAuthor: Actor
id: ID!
}
@@ -2516,14 +2850,40 @@ type Commit implements GitObject & Node & Subscribable & UniformResourceLocatabl
authoredDate: DateTime!
"""
- Fetches `git blame` information.
+ The list of authors for this commit based on the git author and the Co-authored-by
+ message trailer. The git author will always be first.
"""
- blame(
+ authors(
"""
- The file whose Git blame information you want.
+ Returns the elements in the list that come after the specified cursor.
"""
- path: String!
- ): Blame!
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): GitActorConnection!
+
+ """
+ Fetches `git blame` information.
+ """
+ blame(
+ """
+ The file whose Git blame information you want.
+ """
+ path: String!
+ ): Blame!
"""
The number of changed files in this commit.
@@ -2558,7 +2918,7 @@ type Commit implements GitObject & Node & Subscribable & UniformResourceLocatabl
Returns the last _n_ elements from the list.
"""
last: Int
- ): CheckSuiteConnection @preview(toggledBy: "antiope-preview")
+ ): CheckSuiteConnection
"""
Comments made on the commit.
@@ -2650,6 +3010,16 @@ type Commit implements GitObject & Node & Subscribable & UniformResourceLocatabl
orderBy: DeploymentOrder = {field: CREATED_AT, direction: ASC}
): DeploymentConnection
+ """
+ The tree entry representing the file located at the given path.
+ """
+ file(
+ """
+ The path for the file
+ """
+ path: String!
+ ): TreeEntry
+
"""
The linear commit history starting from (and including) this commit, in the same order as `git log`.
"""
@@ -2726,6 +3096,11 @@ type Commit implements GitObject & Node & Subscribable & UniformResourceLocatabl
"""
oid: GitObjectID!
+ """
+ The organization this commit was made on behalf of.
+ """
+ onBehalfOf: Organization
+
"""
The parents of a commit.
"""
@@ -2776,6 +3151,36 @@ type Commit implements GitObject & Node & Subscribable & UniformResourceLocatabl
"""
status: Status
+ """
+ Check and Status rollup information for this commit.
+ """
+ statusCheckRollup: StatusCheckRollup
+
+ """
+ Returns a list of all submodules in this repository as of this Commit parsed from the .gitmodules file.
+ """
+ submodules(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): SubmoduleConnection!
+
"""
Returns a URL to download a tarball archive for a repository.
Note: For private repositories, these links are temporary and expire after five minutes.
@@ -2855,7 +3260,7 @@ type CommitComment implements Comment & Deletable & Minimizable & Node & Reactab
body: String!
"""
- Identifies the comment body rendered to HTML.
+ The body rendered to HTML.
"""
bodyHTML: HTML!
@@ -3113,7 +3518,7 @@ type CommitCommentThread implements Node & RepositoryNode {
"""
The commit the comments were made on.
"""
- commit: Commit!
+ commit: Commit
id: ID!
"""
@@ -3277,6 +3682,37 @@ type CommitHistoryConnection {
totalCount: Int!
}
+"""
+Represents a 'connected' event on a given issue or pull request.
+"""
+type ConnectedEvent implements Node {
+ """
+ Identifies the actor who performed the event.
+ """
+ actor: Actor
+
+ """
+ Identifies the date and time when the object was created.
+ """
+ createdAt: DateTime!
+ id: ID!
+
+ """
+ Reference originated in a different repository.
+ """
+ isCrossRepository: Boolean!
+
+ """
+ Issue or pull request that made the reference.
+ """
+ source: ReferencedSubject!
+
+ """
+ Issue or pull request which was connected.
+ """
+ subject: ReferencedSubject!
+}
+
"""
A content attachment
"""
@@ -3454,25 +3890,6 @@ input ContributionOrder {
The ordering direction.
"""
direction: OrderDirection!
-
- """
- The field by which to order contributions.
-
- **Upcoming Change on 2019-10-01 UTC**
- **Description:** `field` will be removed. Only one order field is supported.
- **Reason:** `field` will be removed.
- """
- field: ContributionOrderField
-}
-
-"""
-Properties by which contribution connections can be ordered.
-"""
-enum ContributionOrderField {
- """
- Order contributions by when they were made.
- """
- OCCURRED_AT
}
"""
@@ -3521,16 +3938,7 @@ type ContributionsCollection {
the issue is not visible but the user has opted to show private contributions,
a RestrictedContribution will be returned.
"""
- firstIssueContribution(
- """
- If true, the first issue will be returned even if it was opened outside of the collection's time range.
-
- **Upcoming Change on 2019-07-01 UTC**
- **Description:** `ignoreTimeRange` will be removed. Use a `ContributionsCollection` starting sufficiently far back
- **Reason:** ignore_time_range will be removed
- """
- ignoreTimeRange: Boolean = false
- ): CreatedIssueOrRestrictedContribution
+ firstIssueContribution: CreatedIssueOrRestrictedContribution
"""
The first pull request the user opened on GitHub. This will be null if that
@@ -3538,16 +3946,7 @@ type ContributionsCollection {
ignoreTimeRange is not true. If the pull request is not visible but the user
has opted to show private contributions, a RestrictedContribution will be returned.
"""
- firstPullRequestContribution(
- """
- If true, the first pull request will be returned even if it was opened outside of the collection's time range.
-
- **Upcoming Change on 2019-07-01 UTC**
- **Description:** `ignoreTimeRange` will be removed. Use a `ContributionsCollection` starting sufficiently far back
- **Reason:** ignore_time_range will be removed
- """
- ignoreTimeRange: Boolean = false
- ): CreatedPullRequestOrRestrictedContribution
+ firstPullRequestContribution: CreatedPullRequestOrRestrictedContribution
"""
The first repository the user created on GitHub. This will be null if that
@@ -3555,16 +3954,7 @@ type ContributionsCollection {
ignoreTimeRange is false. If the repository is not visible, then a
RestrictedContribution is returned.
"""
- firstRepositoryContribution(
- """
- If true, the first repository will be returned even if it was opened outside of the collection's time range.
-
- **Upcoming Change on 2019-07-01 UTC**
- **Description:** `ignoreTimeRange` will be removed. Use a `ContributionsCollection` starting sufficiently far back
- **Reason:** ignore_time_range will be removed
- """
- ignoreTimeRange: Boolean = false
- ): CreatedRepositoryOrRestrictedContribution
+ firstRepositoryContribution: CreatedRepositoryOrRestrictedContribution
"""
Does the user have any more activity in the timeline that occurred prior to the collection's time range?
@@ -3625,7 +4015,7 @@ type ContributionsCollection {
"""
Ordering options for contributions returned from the connection.
"""
- orderBy: ContributionOrder = {field: OCCURRED_AT, direction: DESC}
+ orderBy: ContributionOrder = {direction: DESC}
): CreatedIssueContributionConnection!
"""
@@ -3652,16 +4042,7 @@ type ContributionsCollection {
When the user signed up for GitHub. This will be null if that sign up date
falls outside the collection's time range and ignoreTimeRange is false.
"""
- joinedGitHubContribution(
- """
- If true, the contribution will be returned even if the user signed up outside of the collection's time range.
-
- **Upcoming Change on 2019-07-01 UTC**
- **Description:** `ignoreTimeRange` will be removed. Use a `ContributionsCollection` starting sufficiently far back
- **Reason:** ignore_time_range will be removed
- """
- ignoreTimeRange: Boolean = false
- ): JoinedGitHubContribution
+ joinedGitHubContribution: JoinedGitHubContribution
"""
The date of the most recent restricted contribution the user made in this time
@@ -3730,7 +4111,7 @@ type ContributionsCollection {
"""
Ordering options for contributions returned from the connection.
"""
- orderBy: ContributionOrder = {field: OCCURRED_AT, direction: DESC}
+ orderBy: ContributionOrder = {direction: DESC}
): CreatedPullRequestContributionConnection!
"""
@@ -3780,7 +4161,7 @@ type ContributionsCollection {
"""
Ordering options for contributions returned from the connection.
"""
- orderBy: ContributionOrder = {field: OCCURRED_AT, direction: DESC}
+ orderBy: ContributionOrder = {direction: DESC}
): CreatedPullRequestReviewContributionConnection!
"""
@@ -3825,7 +4206,7 @@ type ContributionsCollection {
"""
Ordering options for contributions returned from the connection.
"""
- orderBy: ContributionOrder = {field: OCCURRED_AT, direction: DESC}
+ orderBy: ContributionOrder = {direction: DESC}
): CreatedRepositoryContributionConnection!
"""
@@ -3980,6 +4361,37 @@ type ConvertProjectCardNoteToIssuePayload {
projectCard: ProjectCard
}
+"""
+Represents a 'convert_to_draft' event on a given pull request.
+"""
+type ConvertToDraftEvent implements Node & UniformResourceLocatable {
+ """
+ Identifies the actor who performed the event.
+ """
+ actor: Actor
+
+ """
+ Identifies the date and time when the object was created.
+ """
+ createdAt: DateTime!
+ id: ID!
+
+ """
+ PullRequest referenced by event.
+ """
+ pullRequest: PullRequest!
+
+ """
+ The HTTP path for this convert to draft event.
+ """
+ resourcePath: URI!
+
+ """
+ The HTTP URL for this convert to draft event.
+ """
+ url: URI!
+}
+
"""
Represents a 'converted_note_to_issue' event on a given issue or pull request.
"""
@@ -4020,6 +4432,16 @@ type ConvertedNoteToIssueEvent implements Node {
Autogenerated input type of CreateBranchProtectionRule
"""
input CreateBranchProtectionRuleInput {
+ """
+ Can this branch be deleted.
+ """
+ allowsDeletions: Boolean
+
+ """
+ Are force pushes allowed on this branch.
+ """
+ allowsForcePushes: Boolean
+
"""
A unique identifier for the client performing the mutation.
"""
@@ -4041,7 +4463,7 @@ input CreateBranchProtectionRuleInput {
pattern: String!
"""
- A list of User or Team IDs allowed to push to matching branches.
+ A list of User, Team or App IDs allowed to push to matching branches.
"""
pushActorIds: [ID!]
@@ -4075,6 +4497,11 @@ input CreateBranchProtectionRuleInput {
"""
requiresCommitSignatures: Boolean
+ """
+ Are merge commits prohibited from being pushed to this branch.
+ """
+ requiresLinearHistory: Boolean
+
"""
Are status checks required to update matching branches.
"""
@@ -4119,7 +4546,7 @@ type CreateBranchProtectionRulePayload {
"""
Autogenerated input type of CreateCheckRun
"""
-input CreateCheckRunInput @preview(toggledBy: "antiope-preview") {
+input CreateCheckRunInput {
"""
Possible further actions the integrator can perform, which a user may trigger.
"""
@@ -4184,7 +4611,7 @@ input CreateCheckRunInput @preview(toggledBy: "antiope-preview") {
"""
Autogenerated return type of CreateCheckRun
"""
-type CreateCheckRunPayload @preview(toggledBy: "antiope-preview") {
+type CreateCheckRunPayload {
"""
The newly created check run.
"""
@@ -4199,7 +4626,7 @@ type CreateCheckRunPayload @preview(toggledBy: "antiope-preview") {
"""
Autogenerated input type of CreateCheckSuite
"""
-input CreateCheckSuiteInput @preview(toggledBy: "antiope-preview") {
+input CreateCheckSuiteInput {
"""
A unique identifier for the client performing the mutation.
"""
@@ -4219,7 +4646,7 @@ input CreateCheckSuiteInput @preview(toggledBy: "antiope-preview") {
"""
Autogenerated return type of CreateCheckSuite
"""
-type CreateCheckSuitePayload @preview(toggledBy: "antiope-preview") {
+type CreateCheckSuitePayload {
"""
The newly created check suite.
"""
@@ -4406,6 +4833,51 @@ type CreateDeploymentStatusPayload @preview(toggledBy: "flash-preview") {
deploymentStatus: DeploymentStatus
}
+"""
+Autogenerated input type of CreateIpAllowListEntry
+"""
+input CreateIpAllowListEntryInput {
+ """
+ An IP address or range of addresses in CIDR notation.
+ """
+ allowListValue: String!
+
+ """
+ A unique identifier for the client performing the mutation.
+ """
+ clientMutationId: String
+
+ """
+ Whether the IP allow list entry is active when an IP allow list is enabled.
+ """
+ isActive: Boolean!
+
+ """
+ An optional name for the IP allow list entry.
+ """
+ name: String
+
+ """
+ The ID of the owner for which to create the new IP allow list entry.
+ """
+ ownerId: ID! @possibleTypes(concreteTypes: ["Enterprise", "Organization"], abstractType: "IpAllowListOwner")
+}
+
+"""
+Autogenerated return type of CreateIpAllowListEntry
+"""
+type CreateIpAllowListEntryPayload {
+ """
+ A unique identifier for the client performing the mutation.
+ """
+ clientMutationId: String
+
+ """
+ The IP allow list entry that was created.
+ """
+ ipAllowListEntry: IpAllowListEntry
+}
+
"""
Autogenerated input type of CreateIssue
"""
@@ -4425,6 +4897,11 @@ input CreateIssueInput {
"""
clientMutationId: String
+ """
+ The name of an issue template in the repository, assigns labels and assignees from the template to the issue
+ """
+ issueTemplate: String
+
"""
An array of Node IDs of labels for this issue.
"""
@@ -4535,6 +5012,11 @@ input CreateProjectInput {
"""
ownerId: ID! @possibleTypes(concreteTypes: ["Organization", "Repository", "User"], abstractType: "ProjectOwner")
+ """
+ A list of repository IDs to create as linked repositories for the project
+ """
+ repositoryIds: [ID!] @possibleTypes(concreteTypes: ["Repository"])
+
"""
The name of the GitHub-provided template.
"""
@@ -4580,7 +5062,7 @@ input CreatePullRequestInput {
"""
Indicates whether this pull request should be a draft.
"""
- draft: Boolean = false @preview(toggledBy: "shadow-cat-preview")
+ draft: Boolean = false
"""
The name of the branch where your changes are implemented. For cross-repository pull requests
@@ -4734,7 +5216,7 @@ type CreateRepositoryPayload {
"""
Autogenerated input type of CreateTeamDiscussionComment
"""
-input CreateTeamDiscussionCommentInput @preview(toggledBy: "echo-preview") {
+input CreateTeamDiscussionCommentInput {
"""
The content of the comment.
"""
@@ -4754,7 +5236,7 @@ input CreateTeamDiscussionCommentInput @preview(toggledBy: "echo-preview") {
"""
Autogenerated return type of CreateTeamDiscussionComment
"""
-type CreateTeamDiscussionCommentPayload @preview(toggledBy: "echo-preview") {
+type CreateTeamDiscussionCommentPayload {
"""
A unique identifier for the client performing the mutation.
"""
@@ -4769,7 +5251,7 @@ type CreateTeamDiscussionCommentPayload @preview(toggledBy: "echo-preview") {
"""
Autogenerated input type of CreateTeamDiscussion
"""
-input CreateTeamDiscussionInput @preview(toggledBy: "echo-preview") {
+input CreateTeamDiscussionInput {
"""
The content of the discussion.
"""
@@ -4801,7 +5283,7 @@ input CreateTeamDiscussionInput @preview(toggledBy: "echo-preview") {
"""
Autogenerated return type of CreateTeamDiscussion
"""
-type CreateTeamDiscussionPayload @preview(toggledBy: "echo-preview") {
+type CreateTeamDiscussionPayload {
"""
A unique identifier for the client performing the mutation.
"""
@@ -5349,6 +5831,61 @@ type DeleteBranchProtectionRulePayload {
clientMutationId: String
}
+"""
+Autogenerated input type of DeleteDeployment
+"""
+input DeleteDeploymentInput {
+ """
+ A unique identifier for the client performing the mutation.
+ """
+ clientMutationId: String
+
+ """
+ The Node ID of the deployment to be deleted.
+ """
+ id: ID! @possibleTypes(concreteTypes: ["Deployment"])
+}
+
+"""
+Autogenerated return type of DeleteDeployment
+"""
+type DeleteDeploymentPayload {
+ """
+ A unique identifier for the client performing the mutation.
+ """
+ clientMutationId: String
+}
+
+"""
+Autogenerated input type of DeleteIpAllowListEntry
+"""
+input DeleteIpAllowListEntryInput {
+ """
+ A unique identifier for the client performing the mutation.
+ """
+ clientMutationId: String
+
+ """
+ The ID of the IP allow list entry to delete.
+ """
+ ipAllowListEntryId: ID! @possibleTypes(concreteTypes: ["IpAllowListEntry"])
+}
+
+"""
+Autogenerated return type of DeleteIpAllowListEntry
+"""
+type DeleteIpAllowListEntryPayload {
+ """
+ A unique identifier for the client performing the mutation.
+ """
+ clientMutationId: String
+
+ """
+ The IP allow list entry that was deleted.
+ """
+ ipAllowListEntry: IpAllowListEntry
+}
+
"""
Autogenerated input type of DeleteIssueComment
"""
@@ -5617,7 +6154,7 @@ type DeleteRefPayload {
"""
Autogenerated input type of DeleteTeamDiscussionComment
"""
-input DeleteTeamDiscussionCommentInput @preview(toggledBy: "echo-preview") {
+input DeleteTeamDiscussionCommentInput {
"""
A unique identifier for the client performing the mutation.
"""
@@ -5632,7 +6169,7 @@ input DeleteTeamDiscussionCommentInput @preview(toggledBy: "echo-preview") {
"""
Autogenerated return type of DeleteTeamDiscussionComment
"""
-type DeleteTeamDiscussionCommentPayload @preview(toggledBy: "echo-preview") {
+type DeleteTeamDiscussionCommentPayload {
"""
A unique identifier for the client performing the mutation.
"""
@@ -5642,7 +6179,7 @@ type DeleteTeamDiscussionCommentPayload @preview(toggledBy: "echo-preview") {
"""
Autogenerated input type of DeleteTeamDiscussion
"""
-input DeleteTeamDiscussionInput @preview(toggledBy: "echo-preview") {
+input DeleteTeamDiscussionInput {
"""
A unique identifier for the client performing the mutation.
"""
@@ -5657,7 +6194,7 @@ input DeleteTeamDiscussionInput @preview(toggledBy: "echo-preview") {
"""
Autogenerated return type of DeleteTeamDiscussion
"""
-type DeleteTeamDiscussionPayload @preview(toggledBy: "echo-preview") {
+type DeleteTeamDiscussionPayload {
"""
A unique identifier for the client performing the mutation.
"""
@@ -5819,7 +6356,7 @@ type Deployment implements Node {
"""
Identifies the actor who triggered the deployment.
"""
- creator: Actor
+ creator: Actor!
"""
Identifies the primary key from the database.
@@ -5832,16 +6369,26 @@ type Deployment implements Node {
description: String
"""
- The environment to which this deployment was made.
+ The latest environment to which this deployment was made.
"""
environment: String
id: ID!
+ """
+ The latest environment to which this deployment was made.
+ """
+ latestEnvironment: String
+
"""
The latest status of this deployment.
"""
latestStatus: DeploymentStatus
+ """
+ The original environment to which this deployment was made.
+ """
+ originalEnvironment: String
+
"""
Extra information that a deployment system might need.
"""
@@ -6051,7 +6598,7 @@ type DeploymentStatus implements Node {
"""
Identifies the actor who triggered the deployment.
"""
- creator: Actor
+ creator: Actor!
"""
Identifies the deployment associated with status.
@@ -6171,244 +6718,190 @@ enum DeploymentStatusState {
}
"""
-Autogenerated input type of DismissPullRequestReview
+The possible sides of a diff.
"""
-input DismissPullRequestReviewInput {
- """
- A unique identifier for the client performing the mutation.
+enum DiffSide {
"""
- clientMutationId: String
-
- """
- The contents of the pull request review dismissal message.
+ The left side of the diff.
"""
- message: String!
+ LEFT
"""
- The Node ID of the pull request review to modify.
+ The right side of the diff.
"""
- pullRequestReviewId: ID! @possibleTypes(concreteTypes: ["PullRequestReview"])
+ RIGHT
}
"""
-Autogenerated return type of DismissPullRequestReview
+Represents a 'disconnected' event on a given issue or pull request.
"""
-type DismissPullRequestReviewPayload {
+type DisconnectedEvent implements Node {
"""
- A unique identifier for the client performing the mutation.
+ Identifies the actor who performed the event.
"""
- clientMutationId: String
+ actor: Actor
"""
- The dismissed pull request review.
+ Identifies the date and time when the object was created.
"""
- pullRequestReview: PullRequestReview
-}
+ createdAt: DateTime!
+ id: ID!
-"""
-Specifies a review comment to be left with a Pull Request Review.
-"""
-input DraftPullRequestReviewComment {
"""
- Body of the comment to leave.
+ Reference originated in a different repository.
"""
- body: String!
+ isCrossRepository: Boolean!
"""
- Path to the file being commented on.
+ Issue or pull request from which the issue was disconnected.
"""
- path: String!
+ source: ReferencedSubject!
"""
- Position in the file to leave a comment on.
+ Issue or pull request which was disconnected.
"""
- position: Int!
+ subject: ReferencedSubject!
}
"""
-Metadata for an audit entry containing enterprise account information.
+Autogenerated input type of DismissPullRequestReview
"""
-interface EnterpriseAuditEntryData @preview(toggledBy: "audit-log-preview") {
+input DismissPullRequestReviewInput {
"""
- The HTTP path for this enterprise.
+ A unique identifier for the client performing the mutation.
"""
- enterpriseResourcePath: URI
+ clientMutationId: String
"""
- The slug of the enterprise.
+ The contents of the pull request review dismissal message.
"""
- enterpriseSlug: String
+ message: String!
"""
- The HTTP URL for this enterprise.
+ The Node ID of the pull request review to modify.
"""
- enterpriseUrl: URI
+ pullRequestReviewId: ID! @possibleTypes(concreteTypes: ["PullRequestReview"])
}
"""
-An external identity provisioned by SAML SSO or SCIM.
+Autogenerated return type of DismissPullRequestReview
"""
-type ExternalIdentity implements Node {
- """
- The GUID for this identity
- """
- guid: String!
- id: ID!
-
- """
- Organization invitation for this SCIM-provisioned external identity
- """
- organizationInvitation: OrganizationInvitation
-
- """
- SAML Identity attributes
- """
- samlIdentity: ExternalIdentitySamlAttributes
-
+type DismissPullRequestReviewPayload {
"""
- SCIM Identity attributes
+ A unique identifier for the client performing the mutation.
"""
- scimIdentity: ExternalIdentityScimAttributes
+ clientMutationId: String
"""
- User linked to this external identity. Will be NULL if this identity has not been claimed by an organization member.
+ The dismissed pull request review.
"""
- user: User
+ pullRequestReview: PullRequestReview
}
"""
-The connection type for ExternalIdentity.
+Specifies a review comment to be left with a Pull Request Review.
"""
-type ExternalIdentityConnection {
- """
- A list of edges.
- """
- edges: [ExternalIdentityEdge]
-
- """
- A list of nodes.
- """
- nodes: [ExternalIdentity]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
+input DraftPullRequestReviewComment {
"""
- Identifies the total count of items in the connection.
+ Body of the comment to leave.
"""
- totalCount: Int!
-}
+ body: String!
-"""
-An edge in a connection.
-"""
-type ExternalIdentityEdge {
"""
- A cursor for use in pagination.
+ Path to the file being commented on.
"""
- cursor: String!
+ path: String!
"""
- The item at the end of the edge.
+ Position in the file to leave a comment on.
"""
- node: ExternalIdentity
+ position: Int!
}
"""
-SAML attributes for the External Identity
+Specifies a review comment thread to be left with a Pull Request Review.
"""
-type ExternalIdentitySamlAttributes {
+input DraftPullRequestReviewThread {
"""
- The NameID of the SAML identity
+ Body of the comment to leave.
"""
- nameId: String
-}
+ body: String!
-"""
-SCIM attributes for the External Identity
-"""
-type ExternalIdentityScimAttributes {
"""
- The userName of the SCIM identity
+ The line of the blob to which the thread refers. The end of the line range for multi-line comments.
"""
- username: String
-}
+ line: Int!
-"""
-The connection type for User.
-"""
-type FollowerConnection {
"""
- A list of edges.
+ Path to the file being commented on.
"""
- edges: [UserEdge]
+ path: String!
"""
- A list of nodes.
+ The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range.
"""
- nodes: [User]
+ side: DiffSide = RIGHT
"""
- Information to aid in pagination.
+ The first line of the range to which the comment refers.
"""
- pageInfo: PageInfo!
+ startLine: Int
"""
- Identifies the total count of items in the connection.
+ The side of the diff on which the start line resides.
"""
- totalCount: Int!
+ startSide: DiffSide = RIGHT
}
"""
-The connection type for User.
+An account to manage multiple organizations with consolidated policy and billing.
"""
-type FollowingConnection {
+type Enterprise implements Node {
"""
- A list of edges.
+ A URL pointing to the enterprise's public avatar.
"""
- edges: [UserEdge]
+ avatarUrl(
+ """
+ The size of the resulting square image.
+ """
+ size: Int
+ ): URI!
"""
- A list of nodes.
+ Enterprise billing information visible to enterprise billing managers.
"""
- nodes: [User]
+ billingInfo: EnterpriseBillingInfo
"""
- Information to aid in pagination.
+ Identifies the date and time when the object was created.
"""
- pageInfo: PageInfo!
+ createdAt: DateTime!
"""
- Identifies the total count of items in the connection.
+ Identifies the primary key from the database.
"""
- totalCount: Int!
-}
+ databaseId: Int
-"""
-A generic hovercard context with a message and icon
-"""
-type GenericHovercardContext implements HovercardContext @preview(toggledBy: "hagar-preview") {
"""
- A string describing this context
+ The description of the enterprise.
"""
- message: String!
+ description: String
"""
- An octicon to accompany this context
+ The description of the enterprise as HTML.
"""
- octicon: String!
-}
+ descriptionHTML: HTML!
+ id: ID!
-"""
-A Gist.
-"""
-type Gist implements Node & Starrable {
"""
- A list of comments associated with the gist
+ The location of the enterprise.
"""
- comments(
+ location: String
+
+ """
+ A list of users who are members of this enterprise.
+ """
+ members(
"""
Returns the elements in the list that come after the specified cursor.
"""
@@ -6419,6 +6912,11 @@ type Gist implements Node & Starrable {
"""
before: String
+ """
+ Only return members within the selected GitHub Enterprise deployment
+ """
+ deployment: EnterpriseUserDeployment
+
"""
Returns the first _n_ elements from the list.
"""
@@ -6428,37 +6926,37 @@ type Gist implements Node & Starrable {
Returns the last _n_ elements from the list.
"""
last: Int
- ): GistCommentConnection!
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
+ """
+ Ordering options for members returned from the connection.
+ """
+ orderBy: EnterpriseMemberOrder = {field: LOGIN, direction: ASC}
- """
- The gist description.
- """
- description: String
+ """
+ Only return members within the organizations with these logins
+ """
+ organizationLogins: [String!]
- """
- The files in this gist.
- """
- files(
"""
- The maximum number of files to return.
+ The search string to look for.
"""
- limit: Int = 10
+ query: String
"""
- The oid of the files to return
+ The role of the user in the enterprise organization or server.
"""
- oid: GitObjectID
- ): [GistFile]
+ role: EnterpriseUserAccountMembershipRole
+ ): EnterpriseMemberConnection!
"""
- A list of forks associated with the gist
+ The name of the enterprise.
"""
- forks(
+ name: String!
+
+ """
+ A list of organizations that belong to this enterprise.
+ """
+ organizations(
"""
Returns the elements in the list that come after the specified cursor.
"""
@@ -6480,41 +6978,40 @@ type Gist implements Node & Starrable {
last: Int
"""
- Ordering options for gists returned from the connection
+ Ordering options for organizations returned from the connection.
"""
- orderBy: GistOrder
- ): GistConnection!
- id: ID!
+ orderBy: OrganizationOrder = {field: LOGIN, direction: ASC}
- """
- Identifies if the gist is a fork.
- """
- isFork: Boolean!
+ """
+ The search string to look for.
+ """
+ query: String
+ ): OrganizationConnection!
"""
- Whether the gist is public or not.
+ Enterprise information only visible to enterprise owners.
"""
- isPublic: Boolean!
+ ownerInfo: EnterpriseOwnerInfo
"""
- The gist name.
+ The HTTP path for this enterprise.
"""
- name: String!
+ resourcePath: URI!
"""
- The gist owner.
+ The URL-friendly identifier for the enterprise.
"""
- owner: RepositoryOwner
+ slug: String!
"""
- Identifies when the gist was last pushed to.
+ The HTTP URL for this enterprise.
"""
- pushedAt: DateTime
+ url: URI!
"""
- A list of users who have starred this starrable.
+ A list of user accounts on this enterprise.
"""
- stargazers(
+ userAccounts(
"""
Returns the elements in the list that come after the specified cursor.
"""
@@ -6534,173 +7031,113 @@ type Gist implements Node & Starrable {
Returns the last _n_ elements from the list.
"""
last: Int
-
- """
- Order for connection
- """
- orderBy: StarOrder
- ): StargazerConnection!
+ ): EnterpriseUserAccountConnection!
"""
- Identifies the date and time when the object was last updated.
+ Is the current viewer an admin of this enterprise?
"""
- updatedAt: DateTime!
+ viewerIsAdmin: Boolean!
"""
- Returns a boolean indicating whether the viewing user has starred this starrable.
+ The URL of the enterprise website.
"""
- viewerHasStarred: Boolean!
+ websiteUrl: URI
}
"""
-Represents a comment on an Gist.
+The connection type for User.
"""
-type GistComment implements Comment & Deletable & Minimizable & Node & Updatable & UpdatableComment {
+type EnterpriseAdministratorConnection {
"""
- The actor who authored the comment.
+ A list of edges.
"""
- author: Actor
+ edges: [EnterpriseAdministratorEdge]
"""
- Author's association with the gist.
+ A list of nodes.
"""
- authorAssociation: CommentAuthorAssociation!
+ nodes: [User]
"""
- Identifies the comment body.
+ Information to aid in pagination.
"""
- body: String!
+ pageInfo: PageInfo!
"""
- The comment body rendered to HTML.
+ Identifies the total count of items in the connection.
"""
- bodyHTML: HTML!
+ totalCount: Int!
+}
+"""
+A User who is an administrator of an enterprise.
+"""
+type EnterpriseAdministratorEdge {
"""
- The body rendered to text.
+ A cursor for use in pagination.
"""
- bodyText: String!
+ cursor: String!
"""
- Identifies the date and time when the object was created.
+ The item at the end of the edge.
"""
- createdAt: DateTime!
+ node: User
"""
- Check if this comment was created via an email reply.
+ The role of the administrator.
"""
- createdViaEmail: Boolean!
+ role: EnterpriseAdministratorRole!
+}
+"""
+An invitation for a user to become an owner or billing manager of an enterprise.
+"""
+type EnterpriseAdministratorInvitation implements Node {
"""
- Identifies the primary key from the database.
+ Identifies the date and time when the object was created.
"""
- databaseId: Int
+ createdAt: DateTime!
"""
- The actor who edited the comment.
+ The email of the person who was invited to the enterprise.
"""
- editor: Actor
+ email: String
"""
- The associated gist.
+ The enterprise the invitation is for.
"""
- gist: Gist!
+ enterprise: Enterprise!
id: ID!
"""
- Check if this comment was edited and includes an edit with the creation data
- """
- includesCreatedEdit: Boolean!
-
- """
- Returns whether or not a comment has been minimized.
- """
- isMinimized: Boolean!
-
- """
- The moment the editor made the last edit
- """
- lastEditedAt: DateTime
-
- """
- Returns why the comment was minimized.
- """
- minimizedReason: String
-
- """
- Identifies when the comment was published at.
- """
- publishedAt: DateTime
-
- """
- Identifies the date and time when the object was last updated.
- """
- updatedAt: DateTime!
-
- """
- A list of edits to this content.
- """
- userContentEdits(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): UserContentEditConnection
-
- """
- Check if the current viewer can delete this object.
- """
- viewerCanDelete: Boolean!
-
- """
- Check if the current viewer can minimize this object.
- """
- viewerCanMinimize: Boolean!
-
- """
- Check if the current viewer can update this object.
+ The user who was invited to the enterprise.
"""
- viewerCanUpdate: Boolean!
+ invitee: User
"""
- Reasons why the current viewer can not update this comment.
+ The user who created the invitation.
"""
- viewerCannotUpdateReasons: [CommentCannotUpdateReason!]!
+ inviter: User
"""
- Did the viewer author this comment.
+ The invitee's pending role in the enterprise (owner or billing_manager).
"""
- viewerDidAuthor: Boolean!
+ role: EnterpriseAdministratorRole!
}
"""
-The connection type for GistComment.
+The connection type for EnterpriseAdministratorInvitation.
"""
-type GistCommentConnection {
+type EnterpriseAdministratorInvitationConnection {
"""
A list of edges.
"""
- edges: [GistCommentEdge]
+ edges: [EnterpriseAdministratorInvitationEdge]
"""
A list of nodes.
"""
- nodes: [GistComment]
+ nodes: [EnterpriseAdministratorInvitation]
"""
Information to aid in pagination.
@@ -6716,7 +7153,7 @@ type GistCommentConnection {
"""
An edge in a connection.
"""
-type GistCommentEdge {
+type EnterpriseAdministratorInvitationEdge {
"""
A cursor for use in pagination.
"""
@@ -6725,613 +7162,518 @@ type GistCommentEdge {
"""
The item at the end of the edge.
"""
- node: GistComment
+ node: EnterpriseAdministratorInvitation
}
"""
-The connection type for Gist.
+Ordering options for enterprise administrator invitation connections
"""
-type GistConnection {
- """
- A list of edges.
- """
- edges: [GistEdge]
-
+input EnterpriseAdministratorInvitationOrder {
"""
- A list of nodes.
+ The ordering direction.
"""
- nodes: [Gist]
+ direction: OrderDirection!
"""
- Information to aid in pagination.
+ The field to order enterprise administrator invitations by.
"""
- pageInfo: PageInfo!
+ field: EnterpriseAdministratorInvitationOrderField!
+}
+"""
+Properties by which enterprise administrator invitation connections can be ordered.
+"""
+enum EnterpriseAdministratorInvitationOrderField {
"""
- Identifies the total count of items in the connection.
+ Order enterprise administrator member invitations by creation time
"""
- totalCount: Int!
+ CREATED_AT
}
"""
-An edge in a connection.
+The possible administrator roles in an enterprise account.
"""
-type GistEdge {
+enum EnterpriseAdministratorRole {
"""
- A cursor for use in pagination.
+ Represents a billing manager of the enterprise account.
"""
- cursor: String!
+ BILLING_MANAGER
"""
- The item at the end of the edge.
+ Represents an owner of the enterprise account.
"""
- node: Gist
+ OWNER
}
"""
-A file in a gist.
+Metadata for an audit entry containing enterprise account information.
"""
-type GistFile {
+interface EnterpriseAuditEntryData {
"""
- The file name encoded to remove characters that are invalid in URL paths.
+ The HTTP path for this enterprise.
"""
- encodedName: String
+ enterpriseResourcePath: URI
"""
- The gist file encoding.
+ The slug of the enterprise.
"""
- encoding: String
+ enterpriseSlug: String
"""
- The file extension from the file name.
+ The HTTP URL for this enterprise.
"""
- extension: String
+ enterpriseUrl: URI
+}
+"""
+Enterprise billing information visible to enterprise billing managers and owners.
+"""
+type EnterpriseBillingInfo {
"""
- Indicates if this file is an image.
+ The number of licenseable users/emails across the enterprise.
"""
- isImage: Boolean!
+ allLicensableUsersCount: Int!
"""
- Whether the file's contents were truncated.
+ The number of data packs used by all organizations owned by the enterprise.
"""
- isTruncated: Boolean!
+ assetPacks: Int!
"""
- The programming language this file is written in.
+ The number of available seats across all owned organizations based on the unique number of billable users.
"""
- language: Language
+ availableSeats: Int! @deprecated(reason: "`availableSeats` will be replaced with `totalAvailableLicenses` to provide more clarity on the value being returned Use EnterpriseBillingInfo.totalAvailableLicenses instead. Removal on 2020-01-01 UTC.")
"""
- The gist file name.
+ The bandwidth quota in GB for all organizations owned by the enterprise.
"""
- name: String
+ bandwidthQuota: Float!
"""
- The gist file size in bytes.
+ The bandwidth usage in GB for all organizations owned by the enterprise.
"""
- size: Int
+ bandwidthUsage: Float!
"""
- UTF8 text data or null if the file is binary
+ The bandwidth usage as a percentage of the bandwidth quota.
"""
- text(
- """
- Optionally truncate the returned file to this length.
- """
- truncate: Int
- ): String
-}
+ bandwidthUsagePercentage: Int!
-"""
-Ordering options for gist connections
-"""
-input GistOrder {
"""
- The ordering direction.
+ The total seats across all organizations owned by the enterprise.
"""
- direction: OrderDirection!
+ seats: Int! @deprecated(reason: "`seats` will be replaced with `totalLicenses` to provide more clarity on the value being returned Use EnterpriseBillingInfo.totalLicenses instead. Removal on 2020-01-01 UTC.")
"""
- The field to order repositories by.
+ The storage quota in GB for all organizations owned by the enterprise.
"""
- field: GistOrderField!
-}
+ storageQuota: Float!
-"""
-Properties by which gist connections can be ordered.
-"""
-enum GistOrderField {
"""
- Order gists by creation time
+ The storage usage in GB for all organizations owned by the enterprise.
"""
- CREATED_AT
+ storageUsage: Float!
"""
- Order gists by push time
+ The storage usage as a percentage of the storage quota.
"""
- PUSHED_AT
+ storageUsagePercentage: Int!
"""
- Order gists by update time
+ The number of available licenses across all owned organizations based on the unique number of billable users.
"""
- UPDATED_AT
+ totalAvailableLicenses: Int!
+
+ """
+ The total number of licenses allocated.
+ """
+ totalLicenses: Int!
}
"""
-The privacy of a Gist
+The possible values for the enterprise default repository permission setting.
"""
-enum GistPrivacy {
+enum EnterpriseDefaultRepositoryPermissionSettingValue {
"""
- Gists that are public and secret
+ Organization members will be able to clone, pull, push, and add new collaborators to all organization repositories.
"""
- ALL
+ ADMIN
"""
- Public
+ Organization members will only be able to clone and pull public repositories.
"""
- PUBLIC
+ NONE
"""
- Secret
+ Organizations in the enterprise choose default repository permissions for their members.
"""
- SECRET
-}
+ NO_POLICY
-"""
-Represents an actor in a Git commit (ie. an author or committer).
-"""
-type GitActor {
"""
- A URL pointing to the author's public avatar.
+ Organization members will be able to clone and pull all organization repositories.
"""
- avatarUrl(
- """
- The size of the resulting square image.
- """
- size: Int
- ): URI!
+ READ
"""
- The timestamp of the Git action (authoring or committing).
+ Organization members will be able to clone, pull, and push all organization repositories.
"""
- date: GitTimestamp
+ WRITE
+}
+"""
+The possible values for an enabled/disabled enterprise setting.
+"""
+enum EnterpriseEnabledDisabledSettingValue {
"""
- The email in the Git commit.
+ The setting is disabled for organizations in the enterprise.
"""
- email: String
+ DISABLED
"""
- The name in the Git commit.
+ The setting is enabled for organizations in the enterprise.
"""
- name: String
+ ENABLED
"""
- The GitHub user corresponding to the email field. Null if no such user exists.
+ There is no policy set for organizations in the enterprise.
"""
- user: User
+ NO_POLICY
}
"""
-Represents information about the GitHub instance.
+The possible values for an enabled/no policy enterprise setting.
"""
-type GitHubMetadata {
+enum EnterpriseEnabledSettingValue {
"""
- Returns a String that's a SHA of `github-services`
+ The setting is enabled for organizations in the enterprise.
"""
- gitHubServicesSha: GitObjectID!
+ ENABLED
"""
- Whether or not users are verified
+ There is no policy set for organizations in the enterprise.
"""
- isPasswordAuthenticationVerifiable: Boolean!
+ NO_POLICY
}
"""
-Represents a Git object.
+An identity provider configured to provision identities for an enterprise.
"""
-interface GitObject {
+type EnterpriseIdentityProvider implements Node {
"""
- An abbreviated version of the Git object ID
+ The digest algorithm used to sign SAML requests for the identity provider.
"""
- abbreviatedOid: String!
+ digestMethod: SamlDigestAlgorithm
"""
- The HTTP path for this Git object
+ The enterprise this identity provider belongs to.
"""
- commitResourcePath: URI!
+ enterprise: Enterprise
"""
- The HTTP URL for this Git object
+ ExternalIdentities provisioned by this identity provider.
"""
- commitUrl: URI!
- id: ID!
+ externalIdentities(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
- """
- The Git object ID
- """
- oid: GitObjectID!
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
- """
- The Repository the Git object belongs to
- """
- repository: Repository!
-}
-
-"""
-A Git object ID.
-"""
-scalar GitObjectID
-
-"""
-Git SSH string
-"""
-scalar GitSSHRemote
-
-"""
-Information about a signature (GPG or S/MIME) on a Commit or Tag.
-"""
-interface GitSignature {
- """
- Email used to sign this object.
- """
- email: String!
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
- """
- True if the signature is valid and verified by GitHub.
- """
- isValid: Boolean!
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): ExternalIdentityConnection!
+ id: ID!
"""
- Payload for GPG signing object. Raw ODB object without the signature header.
+ The x509 certificate used by the identity provider to sign assertions and responses.
"""
- payload: String!
+ idpCertificate: X509Certificate
"""
- ASCII-armored signature header from object.
+ The Issuer Entity ID for the SAML identity provider.
"""
- signature: String!
+ issuer: String
"""
- GitHub user corresponding to the email signing this commit.
+ Recovery codes that can be used by admins to access the enterprise if the identity provider is unavailable.
"""
- signer: User
+ recoveryCodes: [String!]
"""
- The state of this signature. `VALID` if signature is valid and verified by
- GitHub, otherwise represents reason why signature is considered invalid.
+ The signature algorithm used to sign SAML requests for the identity provider.
"""
- state: GitSignatureState!
+ signatureMethod: SamlSignatureAlgorithm
"""
- True if the signature was made with GitHub's signing key.
+ The URL endpoint for the identity provider's SAML SSO.
"""
- wasSignedByGitHub: Boolean!
+ ssoUrl: URI
}
"""
-The state of a Git signature.
+An object that is a member of an enterprise.
"""
-enum GitSignatureState {
- """
- The signing certificate or its chain could not be verified
- """
- BAD_CERT
+union EnterpriseMember = EnterpriseUserAccount | User
+"""
+The connection type for EnterpriseMember.
+"""
+type EnterpriseMemberConnection {
"""
- Invalid email used for signing
+ A list of edges.
"""
- BAD_EMAIL
+ edges: [EnterpriseMemberEdge]
"""
- Signing key expired
+ A list of nodes.
"""
- EXPIRED_KEY
+ nodes: [EnterpriseMember]
"""
- Internal error - the GPG verification service misbehaved
+ Information to aid in pagination.
"""
- GPGVERIFY_ERROR
+ pageInfo: PageInfo!
"""
- Internal error - the GPG verification service is unavailable at the moment
+ Identifies the total count of items in the connection.
"""
- GPGVERIFY_UNAVAILABLE
+ totalCount: Int!
+}
+"""
+A User who is a member of an enterprise through one or more organizations.
+"""
+type EnterpriseMemberEdge {
"""
- Invalid signature
+ A cursor for use in pagination.
"""
- INVALID
+ cursor: String!
"""
- Malformed signature
+ Whether the user does not have a license for the enterprise.
"""
- MALFORMED_SIG
+ isUnlicensed: Boolean! @deprecated(reason: "All members consume a license Removal on 2021-01-01 UTC.")
"""
- The usage flags for the key that signed this don't allow signing
+ The item at the end of the edge.
"""
- NOT_SIGNING_KEY
+ node: EnterpriseMember
+}
+"""
+Ordering options for enterprise member connections.
+"""
+input EnterpriseMemberOrder {
"""
- Email used for signing not known to GitHub
+ The ordering direction.
"""
- NO_USER
+ direction: OrderDirection!
"""
- Valid siganture, though certificate revocation check failed
+ The field to order enterprise members by.
"""
- OCSP_ERROR
+ field: EnterpriseMemberOrderField!
+}
+"""
+Properties by which enterprise member connections can be ordered.
+"""
+enum EnterpriseMemberOrderField {
"""
- Valid signature, pending certificate revocation checking
+ Order enterprise members by creation time
"""
- OCSP_PENDING
+ CREATED_AT
"""
- One or more certificates in chain has been revoked
+ Order enterprise members by login
"""
- OCSP_REVOKED
+ LOGIN
+}
+"""
+The possible values for the enterprise members can create repositories setting.
+"""
+enum EnterpriseMembersCanCreateRepositoriesSettingValue {
"""
- Key used for signing not known to GitHub
+ Members will be able to create public and private repositories.
"""
- UNKNOWN_KEY
+ ALL
"""
- Unknown signature type
+ Members will not be able to create public or private repositories.
"""
- UNKNOWN_SIG_TYPE
+ DISABLED
"""
- Unsigned
+ Organization administrators choose whether to allow members to create repositories.
"""
- UNSIGNED
+ NO_POLICY
"""
- Email used for signing unverified on GitHub
+ Members will be able to create only private repositories.
"""
- UNVERIFIED_EMAIL
+ PRIVATE
"""
- Valid signature and verified by GitHub
+ Members will be able to create only public repositories.
"""
- VALID
+ PUBLIC
}
"""
-An ISO-8601 encoded date string. Unlike the DateTime type, GitTimestamp is not converted in UTC.
+The possible values for the members can make purchases setting.
"""
-scalar GitTimestamp
+enum EnterpriseMembersCanMakePurchasesSettingValue {
+ """
+ The setting is disabled for organizations in the enterprise.
+ """
+ DISABLED
-"""
-Represents a GPG signature on a Commit or Tag.
-"""
-type GpgSignature implements GitSignature {
"""
- Email used to sign this object.
+ The setting is enabled for organizations in the enterprise.
"""
- email: String!
+ ENABLED
+}
+"""
+The connection type for Organization.
+"""
+type EnterpriseOrganizationMembershipConnection {
"""
- True if the signature is valid and verified by GitHub.
+ A list of edges.
"""
- isValid: Boolean!
+ edges: [EnterpriseOrganizationMembershipEdge]
"""
- Hex-encoded ID of the key that signed this object.
+ A list of nodes.
"""
- keyId: String
+ nodes: [Organization]
"""
- Payload for GPG signing object. Raw ODB object without the signature header.
+ Information to aid in pagination.
"""
- payload: String!
+ pageInfo: PageInfo!
"""
- ASCII-armored signature header from object.
+ Identifies the total count of items in the connection.
"""
- signature: String!
+ totalCount: Int!
+}
+"""
+An enterprise organization that a user is a member of.
+"""
+type EnterpriseOrganizationMembershipEdge {
"""
- GitHub user corresponding to the email signing this commit.
+ A cursor for use in pagination.
"""
- signer: User
+ cursor: String!
"""
- The state of this signature. `VALID` if signature is valid and verified by
- GitHub, otherwise represents reason why signature is considered invalid.
+ The item at the end of the edge.
"""
- state: GitSignatureState!
+ node: Organization
"""
- True if the signature was made with GitHub's signing key.
+ The role of the user in the enterprise membership.
"""
- wasSignedByGitHub: Boolean!
+ role: EnterpriseUserAccountMembershipRole!
}
"""
-A string containing HTML code.
-"""
-scalar HTML
-
-"""
-Represents a 'head_ref_deleted' event on a given pull request.
+The connection type for User.
"""
-type HeadRefDeletedEvent implements Node {
+type EnterpriseOutsideCollaboratorConnection {
"""
- Identifies the actor who performed the event.
- """
- actor: Actor
-
- """
- Identifies the date and time when the object was created.
+ A list of edges.
"""
- createdAt: DateTime!
+ edges: [EnterpriseOutsideCollaboratorEdge]
"""
- Identifies the Ref associated with the `head_ref_deleted` event.
+ A list of nodes.
"""
- headRef: Ref
+ nodes: [User]
"""
- Identifies the name of the Ref associated with the `head_ref_deleted` event.
+ Information to aid in pagination.
"""
- headRefName: String!
- id: ID!
+ pageInfo: PageInfo!
"""
- PullRequest referenced by event.
+ Identifies the total count of items in the connection.
"""
- pullRequest: PullRequest!
+ totalCount: Int!
}
"""
-Represents a 'head_ref_force_pushed' event on a given pull request.
+A User who is an outside collaborator of an enterprise through one or more organizations.
"""
-type HeadRefForcePushedEvent implements Node {
- """
- Identifies the actor who performed the event.
- """
- actor: Actor
-
+type EnterpriseOutsideCollaboratorEdge {
"""
- Identifies the after commit SHA for the 'head_ref_force_pushed' event.
+ A cursor for use in pagination.
"""
- afterCommit: Commit
+ cursor: String!
"""
- Identifies the before commit SHA for the 'head_ref_force_pushed' event.
+ Whether the outside collaborator does not have a license for the enterprise.
"""
- beforeCommit: Commit
+ isUnlicensed: Boolean! @deprecated(reason: "All outside collaborators consume a license Removal on 2021-01-01 UTC.")
"""
- Identifies the date and time when the object was created.
+ The item at the end of the edge.
"""
- createdAt: DateTime!
- id: ID!
+ node: User
"""
- PullRequest referenced by event.
+ The enterprise organization repositories this user is a member of.
"""
- pullRequest: PullRequest!
+ repositories(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
- """
- Identifies the fully qualified ref name for the 'head_ref_force_pushed' event.
- """
- ref: Ref
-}
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
-"""
-Represents a 'head_ref_restored' event on a given pull request.
-"""
-type HeadRefRestoredEvent implements Node {
- """
- Identifies the actor who performed the event.
- """
- actor: Actor
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
- id: ID!
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
- """
- PullRequest referenced by event.
- """
- pullRequest: PullRequest!
+ """
+ Ordering options for repositories.
+ """
+ orderBy: RepositoryOrder = {field: NAME, direction: ASC}
+ ): EnterpriseRepositoryInfoConnection!
}
"""
-Detail needed to display a hovercard for a user
+Enterprise information only visible to enterprise owners.
"""
-type Hovercard @preview(toggledBy: "hagar-preview") {
+type EnterpriseOwnerInfo {
"""
- Each of the contexts for this hovercard
+ A list of all of the administrators for this enterprise.
"""
- contexts: [HovercardContext!]!
-}
-
-"""
-An individual line of a hovercard
-"""
-interface HovercardContext @preview(toggledBy: "hagar-preview") {
- """
- A string describing this context
- """
- message: String!
-
- """
- An octicon to accompany this context
- """
- octicon: String!
-}
-
-"""
-Autogenerated input type of ImportProject
-"""
-input ImportProjectInput {
- """
- The description of Project.
- """
- body: String
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- A list of columns containing issues and pull requests.
- """
- columnImports: [ProjectColumnImport!]!
-
- """
- The name of Project.
- """
- name: String!
-
- """
- The name of the Organization or User to create the Project under.
- """
- ownerName: String!
-
- """
- Whether the Project is public or not.
- """
- public: Boolean = false
-}
-
-"""
-Autogenerated return type of ImportProject
-"""
-type ImportProjectPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The new Project!
- """
- project: Project
-}
-
-"""
-An Issue is a place to discuss ideas, enhancements, tasks, and bugs for a project.
-"""
-type Issue implements Assignable & Closable & Comment & Labelable & Lockable & Node & Reactable & RepositoryNode & Subscribable & UniformResourceLocatable & Updatable & UpdatableComment {
- """
- Reason that the conversation was locked.
- """
- activeLockReason: LockReason
-
- """
- A list of Users assigned to this object.
- """
- assignees(
+ admins(
"""
Returns the elements in the list that come after the specified cursor.
"""
@@ -7351,47 +7693,27 @@ type Issue implements Assignable & Closable & Comment & Labelable & Lockable & N
Returns the last _n_ elements from the list.
"""
last: Int
- ): UserConnection!
-
- """
- The actor who authored the comment.
- """
- author: Actor
-
- """
- Author's association with the subject of the comment.
- """
- authorAssociation: CommentAuthorAssociation!
-
- """
- Identifies the body of the issue.
- """
- body: String!
-
- """
- Identifies the body of the issue rendered to HTML.
- """
- bodyHTML: HTML!
- """
- Identifies the body of the issue rendered to text.
- """
- bodyText: String!
+ """
+ Ordering options for administrators returned from the connection.
+ """
+ orderBy: EnterpriseMemberOrder = {field: LOGIN, direction: ASC}
- """
- `true` if the object is closed (definition of closed may depend on type)
- """
- closed: Boolean!
+ """
+ The search string to look for.
+ """
+ query: String
- """
- Identifies the date and time when the object was closed.
- """
- closedAt: DateTime
+ """
+ The role to filter by.
+ """
+ role: EnterpriseAdministratorRole
+ ): EnterpriseAdministratorConnection!
"""
- A list of comments associated with the Issue.
+ A list of users in the enterprise who currently have two-factor authentication disabled.
"""
- comments(
+ affiliatedUsersWithTwoFactorDisabled(
"""
Returns the elements in the list that come after the specified cursor.
"""
@@ -7411,48 +7733,22 @@ type Issue implements Assignable & Closable & Comment & Labelable & Lockable & N
Returns the last _n_ elements from the list.
"""
last: Int
- ): IssueCommentConnection!
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- Check if this comment was created via an email reply.
- """
- createdViaEmail: Boolean!
-
- """
- Identifies the primary key from the database.
- """
- databaseId: Int
-
- """
- The actor who edited the comment.
- """
- editor: Actor
+ ): UserConnection!
"""
- The hovercard information for this issue
+ Whether or not affiliated users with two-factor authentication disabled exist in the enterprise.
"""
- hovercard(
- """
- Whether or not to include notification contexts
- """
- includeNotificationContexts: Boolean = true
- ): Hovercard! @preview(toggledBy: "hagar-preview")
- id: ID!
+ affiliatedUsersWithTwoFactorDisabledExist: Boolean!
"""
- Check if this comment was edited and includes an edit with the creation data
+ The setting value for whether private repository forking is enabled for repositories in organizations in this enterprise.
"""
- includesCreatedEdit: Boolean!
+ allowPrivateRepositoryForkingSetting: EnterpriseEnabledDisabledSettingValue!
"""
- A list of labels associated with the object.
+ A list of enterprise organizations configured with the provided private repository forking setting value.
"""
- labels(
+ allowPrivateRepositoryForkingSettingOrganizations(
"""
Returns the elements in the list that come after the specified cursor.
"""
@@ -7472,32 +7768,27 @@ type Issue implements Assignable & Closable & Comment & Labelable & Lockable & N
Returns the last _n_ elements from the list.
"""
last: Int
- ): LabelConnection
- """
- The moment the editor made the last edit
- """
- lastEditedAt: DateTime
-
- """
- `true` if the object is locked
- """
- locked: Boolean!
+ """
+ Ordering options for organizations with this setting.
+ """
+ orderBy: OrganizationOrder = {field: LOGIN, direction: ASC}
- """
- Identifies the milestone associated with the issue.
- """
- milestone: Milestone
+ """
+ The setting value to find organizations for.
+ """
+ value: Boolean!
+ ): OrganizationConnection!
"""
- Identifies the issue number.
+ The setting value for base repository permissions for organizations in this enterprise.
"""
- number: Int!
+ defaultRepositoryPermissionSetting: EnterpriseDefaultRepositoryPermissionSettingValue!
"""
- A list of Users that are participating in the Issue conversation.
+ A list of enterprise organizations configured with the provided default repository permission.
"""
- participants(
+ defaultRepositoryPermissionSettingOrganizations(
"""
Returns the elements in the list that come after the specified cursor.
"""
@@ -7517,22 +7808,32 @@ type Issue implements Assignable & Closable & Comment & Labelable & Lockable & N
Returns the last _n_ elements from the list.
"""
last: Int
- ): UserConnection!
+
+ """
+ Ordering options for organizations with this setting.
+ """
+ orderBy: OrganizationOrder = {field: LOGIN, direction: ASC}
+
+ """
+ The permission to find organizations for.
+ """
+ value: DefaultRepositoryPermissionField!
+ ): OrganizationConnection!
"""
- List of project cards associated with this issue.
+ The setting value for whether the enterprise has an IP allow list enabled.
"""
- projectCards(
+ ipAllowListEnabledSetting: IpAllowListEnabledSettingValue!
+
+ """
+ The IP addresses that are allowed to access resources owned by the enterprise.
+ """
+ ipAllowListEntries(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
- """
- A list of archived states to filter the cards by
- """
- archivedStates: [ProjectCardArchivedState] = [ARCHIVED, NOT_ARCHIVED]
-
"""
Returns the elements in the list that come before the specified cursor.
"""
@@ -7547,22 +7848,33 @@ type Issue implements Assignable & Closable & Comment & Labelable & Lockable & N
Returns the last _n_ elements from the list.
"""
last: Int
- ): ProjectCardConnection!
+
+ """
+ Ordering options for IP allow list entries returned.
+ """
+ orderBy: IpAllowListEntryOrder = {field: ALLOW_LIST_VALUE, direction: ASC}
+ ): IpAllowListEntryConnection!
"""
- Identifies when the comment was published at.
+ Whether or not the default repository permission is currently being updated.
"""
- publishedAt: DateTime
+ isUpdatingDefaultRepositoryPermission: Boolean!
"""
- A list of reactions grouped by content left on the subject.
+ Whether the two-factor authentication requirement is currently being enforced.
"""
- reactionGroups: [ReactionGroup!]
+ isUpdatingTwoFactorRequirement: Boolean!
"""
- A list of Reactions left on the Issue.
+ The setting value for whether organization members with admin permissions on a
+ repository can change repository visibility.
"""
- reactions(
+ membersCanChangeRepositoryVisibilitySetting: EnterpriseEnabledDisabledSettingValue!
+
+ """
+ A list of enterprise organizations configured with the provided can change repository visibility setting value.
+ """
+ membersCanChangeRepositoryVisibilitySettingOrganizations(
"""
Returns the elements in the list that come after the specified cursor.
"""
@@ -7573,11 +7885,6 @@ type Issue implements Assignable & Closable & Comment & Labelable & Lockable & N
"""
before: String
- """
- Allows filtering Reactions by emoji.
- """
- content: ReactionContent
-
"""
Returns the first _n_ elements from the list.
"""
@@ -7589,30 +7896,40 @@ type Issue implements Assignable & Closable & Comment & Labelable & Lockable & N
last: Int
"""
- Allows specifying the order in which reactions are returned.
+ Ordering options for organizations with this setting.
"""
- orderBy: ReactionOrder
- ): ReactionConnection!
+ orderBy: OrganizationOrder = {field: LOGIN, direction: ASC}
+
+ """
+ The setting value to find organizations for.
+ """
+ value: Boolean!
+ ): OrganizationConnection!
"""
- The repository associated with this node.
+ The setting value for whether members of organizations in the enterprise can create internal repositories.
"""
- repository: Repository!
+ membersCanCreateInternalRepositoriesSetting: Boolean
"""
- The HTTP path for this issue
+ The setting value for whether members of organizations in the enterprise can create private repositories.
"""
- resourcePath: URI!
+ membersCanCreatePrivateRepositoriesSetting: Boolean
"""
- Identifies the state of the issue.
+ The setting value for whether members of organizations in the enterprise can create public repositories.
"""
- state: IssueState!
+ membersCanCreatePublicRepositoriesSetting: Boolean
"""
- A list of events, comments, commits, etc. associated with the issue.
+ The setting value for whether members of organizations in the enterprise can create repositories.
"""
- timeline(
+ membersCanCreateRepositoriesSetting: EnterpriseMembersCanCreateRepositoriesSettingValue
+
+ """
+ A list of enterprise organizations configured with the provided repository creation setting value.
+ """
+ membersCanCreateRepositoriesSettingOrganizations(
"""
Returns the elements in the list that come after the specified cursor.
"""
@@ -7634,15 +7951,25 @@ type Issue implements Assignable & Closable & Comment & Labelable & Lockable & N
last: Int
"""
- Allows filtering timeline events by a `since` timestamp.
+ Ordering options for organizations with this setting.
"""
- since: DateTime
- ): IssueTimelineConnection! @deprecated(reason: "`timeline` will be removed Use Issue.timelineItems instead. Removal on 2019-10-01 UTC.")
+ orderBy: OrganizationOrder = {field: LOGIN, direction: ASC}
+
+ """
+ The setting to find organizations for.
+ """
+ value: OrganizationMembersCanCreateRepositoriesSettingValue!
+ ): OrganizationConnection!
"""
- A list of events, comments, commits, etc. associated with the issue.
+ The setting value for whether members with admin permissions for repositories can delete issues.
"""
- timelineItems(
+ membersCanDeleteIssuesSetting: EnterpriseEnabledDisabledSettingValue!
+
+ """
+ A list of enterprise organizations configured with the provided members can delete issues setting value.
+ """
+ membersCanDeleteIssuesSettingOrganizations(
"""
Returns the elements in the list that come after the specified cursor.
"""
@@ -7658,46 +7985,31 @@ type Issue implements Assignable & Closable & Comment & Labelable & Lockable & N
"""
first: Int
- """
- Filter timeline items by type.
- """
- itemTypes: [IssueTimelineItemsItemType!]
-
"""
Returns the last _n_ elements from the list.
"""
last: Int
"""
- Filter timeline items by a `since` timestamp.
+ Ordering options for organizations with this setting.
"""
- since: DateTime
+ orderBy: OrganizationOrder = {field: LOGIN, direction: ASC}
"""
- Skips the first _n_ elements in the list.
+ The setting value to find organizations for.
"""
- skip: Int
- ): IssueTimelineItemsConnection!
+ value: Boolean!
+ ): OrganizationConnection!
"""
- Identifies the issue title.
+ The setting value for whether members with admin permissions for repositories can delete or transfer repositories.
"""
- title: String!
+ membersCanDeleteRepositoriesSetting: EnterpriseEnabledDisabledSettingValue!
"""
- Identifies the date and time when the object was last updated.
- """
- updatedAt: DateTime!
-
+ A list of enterprise organizations configured with the provided members can delete repositories setting value.
"""
- The HTTP URL for this issue
- """
- url: URI!
-
- """
- A list of edits to this content.
- """
- userContentEdits(
+ membersCanDeleteRepositoriesSettingOrganizations(
"""
Returns the elements in the list that come after the specified cursor.
"""
@@ -7717,134 +8029,152 @@ type Issue implements Assignable & Closable & Comment & Labelable & Lockable & N
Returns the last _n_ elements from the list.
"""
last: Int
- ): UserContentEditConnection
- """
- Can user react to this subject
- """
- viewerCanReact: Boolean!
+ """
+ Ordering options for organizations with this setting.
+ """
+ orderBy: OrganizationOrder = {field: LOGIN, direction: ASC}
- """
- Check if the viewer is able to change their subscription status for the repository.
- """
- viewerCanSubscribe: Boolean!
+ """
+ The setting value to find organizations for.
+ """
+ value: Boolean!
+ ): OrganizationConnection!
"""
- Check if the current viewer can update this object.
+ The setting value for whether members of organizations in the enterprise can invite outside collaborators.
"""
- viewerCanUpdate: Boolean!
+ membersCanInviteCollaboratorsSetting: EnterpriseEnabledDisabledSettingValue!
"""
- Reasons why the current viewer can not update this comment.
+ A list of enterprise organizations configured with the provided members can invite collaborators setting value.
"""
- viewerCannotUpdateReasons: [CommentCannotUpdateReason!]!
+ membersCanInviteCollaboratorsSettingOrganizations(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
- """
- Did the viewer author this comment.
- """
- viewerDidAuthor: Boolean!
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
- """
- Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
- """
- viewerSubscription: SubscriptionState
-}
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
-"""
-Represents a comment on an Issue.
-"""
-type IssueComment implements Comment & Deletable & Minimizable & Node & Reactable & RepositoryNode & Updatable & UpdatableComment {
- """
- The actor who authored the comment.
- """
- author: Actor
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
- """
- Author's association with the subject of the comment.
- """
- authorAssociation: CommentAuthorAssociation!
+ """
+ Ordering options for organizations with this setting.
+ """
+ orderBy: OrganizationOrder = {field: LOGIN, direction: ASC}
- """
- The body as Markdown.
- """
- body: String!
+ """
+ The setting value to find organizations for.
+ """
+ value: Boolean!
+ ): OrganizationConnection!
"""
- The body rendered to HTML.
+ Indicates whether members of this enterprise's organizations can purchase additional services for those organizations.
"""
- bodyHTML: HTML!
+ membersCanMakePurchasesSetting: EnterpriseMembersCanMakePurchasesSettingValue!
"""
- The body rendered to text.
+ The setting value for whether members with admin permissions for repositories can update protected branches.
"""
- bodyText: String!
+ membersCanUpdateProtectedBranchesSetting: EnterpriseEnabledDisabledSettingValue!
"""
- Identifies the date and time when the object was created.
+ A list of enterprise organizations configured with the provided members can update protected branches setting value.
"""
- createdAt: DateTime!
+ membersCanUpdateProtectedBranchesSettingOrganizations(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
- """
- Check if this comment was created via an email reply.
- """
- createdViaEmail: Boolean!
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
- """
- Identifies the primary key from the database.
- """
- databaseId: Int
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
- """
- The actor who edited the comment.
- """
- editor: Actor
- id: ID!
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
- """
- Check if this comment was edited and includes an edit with the creation data
- """
- includesCreatedEdit: Boolean!
+ """
+ Ordering options for organizations with this setting.
+ """
+ orderBy: OrganizationOrder = {field: LOGIN, direction: ASC}
- """
- Returns whether or not a comment has been minimized.
- """
- isMinimized: Boolean!
+ """
+ The setting value to find organizations for.
+ """
+ value: Boolean!
+ ): OrganizationConnection!
"""
- Identifies the issue associated with the comment.
+ The setting value for whether members can view dependency insights.
"""
- issue: Issue!
+ membersCanViewDependencyInsightsSetting: EnterpriseEnabledDisabledSettingValue!
"""
- The moment the editor made the last edit
+ A list of enterprise organizations configured with the provided members can view dependency insights setting value.
"""
- lastEditedAt: DateTime
+ membersCanViewDependencyInsightsSettingOrganizations(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
- """
- Returns why the comment was minimized.
- """
- minimizedReason: String
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
- """
- Identifies when the comment was published at.
- """
- publishedAt: DateTime
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
- """
- Returns the pull request associated with the comment, if this comment was made on a
- pull request.
- """
- pullRequest: PullRequest
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Ordering options for organizations with this setting.
+ """
+ orderBy: OrganizationOrder = {field: LOGIN, direction: ASC}
+
+ """
+ The setting value to find organizations for.
+ """
+ value: Boolean!
+ ): OrganizationConnection!
"""
- A list of reactions grouped by content left on the subject.
+ The setting value for whether organization projects are enabled for organizations in this enterprise.
"""
- reactionGroups: [ReactionGroup!]
+ organizationProjectsSetting: EnterpriseEnabledDisabledSettingValue!
"""
- A list of Reactions left on the Issue.
+ A list of enterprise organizations configured with the provided organization projects setting value.
"""
- reactions(
+ organizationProjectsSettingOrganizations(
"""
Returns the elements in the list that come after the specified cursor.
"""
@@ -7855,11 +8185,6 @@ type IssueComment implements Comment & Deletable & Minimizable & Node & Reactabl
"""
before: String
- """
- Allows filtering Reactions by emoji.
- """
- content: ReactionContent
-
"""
Returns the first _n_ elements from the list.
"""
@@ -7871,35 +8196,65 @@ type IssueComment implements Comment & Deletable & Minimizable & Node & Reactabl
last: Int
"""
- Allows specifying the order in which reactions are returned.
+ Ordering options for organizations with this setting.
"""
- orderBy: ReactionOrder
- ): ReactionConnection!
+ orderBy: OrganizationOrder = {field: LOGIN, direction: ASC}
- """
- The repository associated with this node.
- """
- repository: Repository!
+ """
+ The setting value to find organizations for.
+ """
+ value: Boolean!
+ ): OrganizationConnection!
"""
- The HTTP path for this issue comment
+ A list of outside collaborators across the repositories in the enterprise.
"""
- resourcePath: URI!
+ outsideCollaborators(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
- """
- Identifies the date and time when the object was last updated.
- """
- updatedAt: DateTime!
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
- """
- The HTTP URL for this issue comment
- """
- url: URI!
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ The login of one specific outside collaborator.
+ """
+ login: String
+
+ """
+ Ordering options for outside collaborators returned from the connection.
+ """
+ orderBy: EnterpriseMemberOrder = {field: LOGIN, direction: ASC}
+
+ """
+ The search string to look for.
+ """
+ query: String
+
+ """
+ Only return outside collaborators on repositories with this visibility.
+ """
+ visibility: RepositoryVisibility
+ ): EnterpriseOutsideCollaboratorConnection!
"""
- A list of edits to this content.
+ A list of pending administrator invitations for the enterprise.
"""
- userContentEdits(
+ pendingAdminInvitations(
"""
Returns the elements in the list that come after the specified cursor.
"""
@@ -7919,112 +8274,212 @@ type IssueComment implements Comment & Deletable & Minimizable & Node & Reactabl
Returns the last _n_ elements from the list.
"""
last: Int
- ): UserContentEditConnection
-
- """
- Check if the current viewer can delete this object.
- """
- viewerCanDelete: Boolean!
- """
- Check if the current viewer can minimize this object.
- """
- viewerCanMinimize: Boolean!
+ """
+ Ordering options for pending enterprise administrator invitations returned from the connection.
+ """
+ orderBy: EnterpriseAdministratorInvitationOrder = {field: CREATED_AT, direction: DESC}
- """
- Can user react to this subject
- """
- viewerCanReact: Boolean!
+ """
+ The search string to look for.
+ """
+ query: String
- """
- Check if the current viewer can update this object.
- """
- viewerCanUpdate: Boolean!
+ """
+ The role to filter by.
+ """
+ role: EnterpriseAdministratorRole
+ ): EnterpriseAdministratorInvitationConnection!
"""
- Reasons why the current viewer can not update this comment.
+ A list of pending collaborator invitations across the repositories in the enterprise.
"""
- viewerCannotUpdateReasons: [CommentCannotUpdateReason!]!
+ pendingCollaboratorInvitations(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
- """
- Did the viewer author this comment.
- """
- viewerDidAuthor: Boolean!
-}
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
-"""
-The connection type for IssueComment.
-"""
-type IssueCommentConnection {
- """
- A list of edges.
- """
- edges: [IssueCommentEdge]
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
- """
- A list of nodes.
- """
- nodes: [IssueComment]
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
+ """
+ Ordering options for pending repository collaborator invitations returned from the connection.
+ """
+ orderBy: RepositoryInvitationOrder = {field: CREATED_AT, direction: DESC}
+
+ """
+ The search string to look for.
+ """
+ query: String
+ ): RepositoryInvitationConnection!
"""
- Identifies the total count of items in the connection.
+ A list of pending collaborators across the repositories in the enterprise.
"""
- totalCount: Int!
-}
+ pendingCollaborators(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Ordering options for pending repository collaborator invitations returned from the connection.
+ """
+ orderBy: RepositoryInvitationOrder = {field: CREATED_AT, direction: DESC}
+
+ """
+ The search string to look for.
+ """
+ query: String
+ ): EnterprisePendingCollaboratorConnection! @deprecated(reason: "Repository invitations can now be associated with an email, not only an invitee. Use the `pendingCollaboratorInvitations` field instead. Removal on 2020-10-01 UTC.")
-"""
-An edge in a connection.
-"""
-type IssueCommentEdge {
"""
- A cursor for use in pagination.
+ A list of pending member invitations for organizations in the enterprise.
"""
- cursor: String!
+ pendingMemberInvitations(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ The search string to look for.
+ """
+ query: String
+ ): EnterprisePendingMemberInvitationConnection!
"""
- The item at the end of the edge.
+ The setting value for whether repository projects are enabled in this enterprise.
"""
- node: IssueComment
-}
+ repositoryProjectsSetting: EnterpriseEnabledDisabledSettingValue!
-"""
-The connection type for Issue.
-"""
-type IssueConnection {
"""
- A list of edges.
+ A list of enterprise organizations configured with the provided repository projects setting value.
"""
- edges: [IssueEdge]
+ repositoryProjectsSettingOrganizations(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Ordering options for organizations with this setting.
+ """
+ orderBy: OrganizationOrder = {field: LOGIN, direction: ASC}
+
+ """
+ The setting value to find organizations for.
+ """
+ value: Boolean!
+ ): OrganizationConnection!
"""
- A list of nodes.
+ The SAML Identity Provider for the enterprise.
"""
- nodes: [Issue]
+ samlIdentityProvider: EnterpriseIdentityProvider
"""
- Information to aid in pagination.
+ A list of enterprise organizations configured with the SAML single sign-on setting value.
"""
- pageInfo: PageInfo!
+ samlIdentityProviderSettingOrganizations(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Ordering options for organizations with this setting.
+ """
+ orderBy: OrganizationOrder = {field: LOGIN, direction: ASC}
+
+ """
+ The setting value to find organizations for.
+ """
+ value: IdentityProviderConfigurationState!
+ ): OrganizationConnection!
"""
- Identifies the total count of items in the connection.
+ The setting value for whether team discussions are enabled for organizations in this enterprise.
"""
- totalCount: Int!
-}
+ teamDiscussionsSetting: EnterpriseEnabledDisabledSettingValue!
-"""
-This aggregates issues opened by a user within one repository.
-"""
-type IssueContributionsByRepository {
"""
- The issue contributions.
+ A list of enterprise organizations configured with the provided team discussions setting value.
"""
- contributions(
+ teamDiscussionsSettingOrganizations(
"""
Returns the elements in the list that come after the specified cursor.
"""
@@ -8046,148 +8501,217 @@ type IssueContributionsByRepository {
last: Int
"""
- Ordering options for contributions returned from the connection.
+ Ordering options for organizations with this setting.
"""
- orderBy: ContributionOrder = {field: OCCURRED_AT, direction: DESC}
- ): CreatedIssueContributionConnection!
+ orderBy: OrganizationOrder = {field: LOGIN, direction: ASC}
- """
- The repository in which the issues were opened.
- """
- repository: Repository!
-}
+ """
+ The setting value to find organizations for.
+ """
+ value: Boolean!
+ ): OrganizationConnection!
-"""
-An edge in a connection.
-"""
-type IssueEdge {
"""
- A cursor for use in pagination.
+ The setting value for whether the enterprise requires two-factor authentication for its organizations and users.
"""
- cursor: String!
+ twoFactorRequiredSetting: EnterpriseEnabledSettingValue!
"""
- The item at the end of the edge.
+ A list of enterprise organizations configured with the two-factor authentication setting value.
"""
- node: Issue
+ twoFactorRequiredSettingOrganizations(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Ordering options for organizations with this setting.
+ """
+ orderBy: OrganizationOrder = {field: LOGIN, direction: ASC}
+
+ """
+ The setting value to find organizations for.
+ """
+ value: Boolean!
+ ): OrganizationConnection!
}
"""
-Ways in which to filter lists of issues.
+The connection type for User.
"""
-input IssueFilters {
+type EnterprisePendingCollaboratorConnection {
"""
- List issues assigned to given name. Pass in `null` for issues with no assigned
- user, and `*` for issues assigned to any user.
+ A list of edges.
"""
- assignee: String
+ edges: [EnterprisePendingCollaboratorEdge]
"""
- List issues created by given name.
+ A list of nodes.
"""
- createdBy: String
+ nodes: [User]
"""
- List issues where the list of label names exist on the issue.
+ Information to aid in pagination.
"""
- labels: [String!]
+ pageInfo: PageInfo!
"""
- List issues where the given name is mentioned in the issue.
+ Identifies the total count of items in the connection.
"""
- mentioned: String
+ totalCount: Int!
+}
+"""
+A user with an invitation to be a collaborator on a repository owned by an organization in an enterprise.
+"""
+type EnterprisePendingCollaboratorEdge {
"""
- List issues by given milestone argument. If an string representation of an
- integer is passed, it should refer to a milestone by its number field. Pass in
- `null` for issues with no milestone, and `*` for issues that are assigned to any milestone.
+ A cursor for use in pagination.
"""
- milestone: String
+ cursor: String!
"""
- List issues that have been updated at or after the given date.
+ Whether the invited collaborator does not have a license for the enterprise.
"""
- since: DateTime
+ isUnlicensed: Boolean! @deprecated(reason: "All pending collaborators consume a license Removal on 2021-01-01 UTC.")
"""
- List issues filtered by the list of states given.
+ The item at the end of the edge.
"""
- states: [IssueState!]
+ node: User
"""
- List issues subscribed to by viewer.
+ The enterprise organization repositories this user is a member of.
"""
- viewerSubscribed: Boolean = false
-}
-
-"""
-Used for return value of Repository.issueOrPullRequest.
-"""
-union IssueOrPullRequest = Issue | PullRequest
+ repositories(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Ordering options for repositories.
+ """
+ orderBy: RepositoryOrder = {field: NAME, direction: ASC}
+ ): EnterpriseRepositoryInfoConnection!
+}
"""
-Ways in which lists of issues can be ordered upon return.
+The connection type for OrganizationInvitation.
"""
-input IssueOrder {
+type EnterprisePendingMemberInvitationConnection {
"""
- The direction in which to order issues by the specified field.
+ A list of edges.
"""
- direction: OrderDirection!
+ edges: [EnterprisePendingMemberInvitationEdge]
"""
- The field in which to order issues by.
+ A list of nodes.
"""
- field: IssueOrderField!
+ nodes: [OrganizationInvitation]
+
+ """
+ Information to aid in pagination.
+ """
+ pageInfo: PageInfo!
+
+ """
+ Identifies the total count of items in the connection.
+ """
+ totalCount: Int!
+
+ """
+ Identifies the total count of unique users in the connection.
+ """
+ totalUniqueUserCount: Int!
}
"""
-Properties by which issue connections can be ordered.
+An invitation to be a member in an enterprise organization.
"""
-enum IssueOrderField {
+type EnterprisePendingMemberInvitationEdge {
"""
- Order issues by comment count
+ A cursor for use in pagination.
"""
- COMMENTS
+ cursor: String!
"""
- Order issues by creation time
+ Whether the invitation has a license for the enterprise.
"""
- CREATED_AT
+ isUnlicensed: Boolean! @deprecated(reason: "All pending members consume a license Removal on 2020-07-01 UTC.")
"""
- Order issues by update time
+ The item at the end of the edge.
"""
- UPDATED_AT
+ node: OrganizationInvitation
}
"""
-The possible states of an issue.
+A subset of repository information queryable from an enterprise.
"""
-enum IssueState {
+type EnterpriseRepositoryInfo implements Node {
+ id: ID!
+
"""
- An issue that has been closed
+ Identifies if the repository is private.
"""
- CLOSED
+ isPrivate: Boolean!
"""
- An issue that is still open
+ The repository's name.
"""
- OPEN
+ name: String!
+
+ """
+ The repository's name with owner.
+ """
+ nameWithOwner: String!
}
"""
-The connection type for IssueTimelineItem.
+The connection type for EnterpriseRepositoryInfo.
"""
-type IssueTimelineConnection {
+type EnterpriseRepositoryInfoConnection {
"""
A list of edges.
"""
- edges: [IssueTimelineItemEdge]
+ edges: [EnterpriseRepositoryInfoEdge]
"""
A list of nodes.
"""
- nodes: [IssueTimelineItem]
+ nodes: [EnterpriseRepositoryInfo]
"""
Information to aid in pagination.
@@ -8200,15 +8724,10 @@ type IssueTimelineConnection {
totalCount: Int!
}
-"""
-An item in an issue timeline
-"""
-union IssueTimelineItem = AssignedEvent | ClosedEvent | Commit | CrossReferencedEvent | DemilestonedEvent | IssueComment | LabeledEvent | LockedEvent | MilestonedEvent | ReferencedEvent | RenamedTitleEvent | ReopenedEvent | SubscribedEvent | TransferredEvent | UnassignedEvent | UnlabeledEvent | UnlockedEvent | UnsubscribedEvent | UserBlockedEvent
-
"""
An edge in a connection.
"""
-type IssueTimelineItemEdge {
+type EnterpriseRepositoryInfoEdge {
"""
A cursor for use in pagination.
"""
@@ -8217,325 +8736,507 @@ type IssueTimelineItemEdge {
"""
The item at the end of the edge.
"""
- node: IssueTimelineItem
+ node: EnterpriseRepositoryInfo
}
"""
-An item in an issue timeline
-"""
-union IssueTimelineItems = AddedToProjectEvent | AssignedEvent | ClosedEvent | CommentDeletedEvent | ConvertedNoteToIssueEvent | CrossReferencedEvent | DemilestonedEvent | IssueComment | LabeledEvent | LockedEvent | MentionedEvent | MilestonedEvent | MovedColumnsInProjectEvent | PinnedEvent | ReferencedEvent | RemovedFromProjectEvent | RenamedTitleEvent | ReopenedEvent | SubscribedEvent | TransferredEvent | UnassignedEvent | UnlabeledEvent | UnlockedEvent | UnpinnedEvent | UnsubscribedEvent | UserBlockedEvent
-
-"""
-The connection type for IssueTimelineItems.
+An Enterprise Server installation.
"""
-type IssueTimelineItemsConnection {
+type EnterpriseServerInstallation implements Node {
"""
- A list of edges.
+ Identifies the date and time when the object was created.
"""
- edges: [IssueTimelineItemsEdge]
+ createdAt: DateTime!
"""
- Identifies the count of items after applying `before` and `after` filters.
+ The customer name to which the Enterprise Server installation belongs.
"""
- filteredCount: Int!
+ customerName: String!
"""
- A list of nodes.
+ The host name of the Enterprise Server installation.
"""
- nodes: [IssueTimelineItems]
+ hostName: String!
+ id: ID!
"""
- Identifies the count of items after applying `before`/`after` filters and `first`/`last`/`skip` slicing.
+ Whether or not the installation is connected to an Enterprise Server installation via GitHub Connect.
"""
- pageCount: Int!
+ isConnected: Boolean!
"""
- Information to aid in pagination.
+ Identifies the date and time when the object was last updated.
"""
- pageInfo: PageInfo!
+ updatedAt: DateTime!
"""
- Identifies the total count of items in the connection.
+ User accounts on this Enterprise Server installation.
"""
- totalCount: Int!
+ userAccounts(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Ordering options for Enterprise Server user accounts returned from the connection.
+ """
+ orderBy: EnterpriseServerUserAccountOrder = {field: LOGIN, direction: ASC}
+ ): EnterpriseServerUserAccountConnection!
"""
- Identifies the date and time when the timeline was last updated.
+ User accounts uploads for the Enterprise Server installation.
"""
- updatedAt: DateTime!
+ userAccountsUploads(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Ordering options for Enterprise Server user accounts uploads returned from the connection.
+ """
+ orderBy: EnterpriseServerUserAccountsUploadOrder = {field: CREATED_AT, direction: DESC}
+ ): EnterpriseServerUserAccountsUploadConnection!
}
"""
-An edge in a connection.
+A user account on an Enterprise Server installation.
"""
-type IssueTimelineItemsEdge {
+type EnterpriseServerUserAccount implements Node {
"""
- A cursor for use in pagination.
+ Identifies the date and time when the object was created.
"""
- cursor: String!
+ createdAt: DateTime!
"""
- The item at the end of the edge.
+ User emails belonging to this user account.
"""
- node: IssueTimelineItems
-}
+ emails(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Ordering options for Enterprise Server user account emails returned from the connection.
+ """
+ orderBy: EnterpriseServerUserAccountEmailOrder = {field: EMAIL, direction: ASC}
+ ): EnterpriseServerUserAccountEmailConnection!
-"""
-The possible item types found in a timeline.
-"""
-enum IssueTimelineItemsItemType {
"""
- Represents a 'added_to_project' event on a given issue or pull request.
+ The Enterprise Server installation on which this user account exists.
"""
- ADDED_TO_PROJECT_EVENT
+ enterpriseServerInstallation: EnterpriseServerInstallation!
+ id: ID!
"""
- Represents an 'assigned' event on any assignable object.
+ Whether the user account is a site administrator on the Enterprise Server installation.
"""
- ASSIGNED_EVENT
+ isSiteAdmin: Boolean!
"""
- Represents a 'closed' event on any `Closable`.
+ The login of the user account on the Enterprise Server installation.
"""
- CLOSED_EVENT
+ login: String!
"""
- Represents a 'comment_deleted' event on a given issue or pull request.
+ The profile name of the user account on the Enterprise Server installation.
"""
- COMMENT_DELETED_EVENT
+ profileName: String
"""
- Represents a 'converted_note_to_issue' event on a given issue or pull request.
+ The date and time when the user account was created on the Enterprise Server installation.
"""
- CONVERTED_NOTE_TO_ISSUE_EVENT
+ remoteCreatedAt: DateTime!
"""
- Represents a mention made by one issue or pull request to another.
+ The ID of the user account on the Enterprise Server installation.
"""
- CROSS_REFERENCED_EVENT
+ remoteUserId: Int!
"""
- Represents a 'demilestoned' event on a given issue or pull request.
+ Identifies the date and time when the object was last updated.
"""
- DEMILESTONED_EVENT
+ updatedAt: DateTime!
+}
+"""
+The connection type for EnterpriseServerUserAccount.
+"""
+type EnterpriseServerUserAccountConnection {
"""
- Represents a comment on an Issue.
+ A list of edges.
"""
- ISSUE_COMMENT
+ edges: [EnterpriseServerUserAccountEdge]
"""
- Represents a 'labeled' event on a given issue or pull request.
+ A list of nodes.
"""
- LABELED_EVENT
+ nodes: [EnterpriseServerUserAccount]
"""
- Represents a 'locked' event on a given issue or pull request.
+ Information to aid in pagination.
"""
- LOCKED_EVENT
+ pageInfo: PageInfo!
"""
- Represents a 'mentioned' event on a given issue or pull request.
+ Identifies the total count of items in the connection.
"""
- MENTIONED_EVENT
+ totalCount: Int!
+}
+"""
+An edge in a connection.
+"""
+type EnterpriseServerUserAccountEdge {
"""
- Represents a 'milestoned' event on a given issue or pull request.
+ A cursor for use in pagination.
"""
- MILESTONED_EVENT
+ cursor: String!
"""
- Represents a 'moved_columns_in_project' event on a given issue or pull request.
+ The item at the end of the edge.
"""
- MOVED_COLUMNS_IN_PROJECT_EVENT
+ node: EnterpriseServerUserAccount
+}
+"""
+An email belonging to a user account on an Enterprise Server installation.
+"""
+type EnterpriseServerUserAccountEmail implements Node {
"""
- Represents a 'pinned' event on a given issue or pull request.
+ Identifies the date and time when the object was created.
"""
- PINNED_EVENT
+ createdAt: DateTime!
"""
- Represents a 'referenced' event on a given `ReferencedSubject`.
+ The email address.
"""
- REFERENCED_EVENT
+ email: String!
+ id: ID!
"""
- Represents a 'removed_from_project' event on a given issue or pull request.
+ Indicates whether this is the primary email of the associated user account.
"""
- REMOVED_FROM_PROJECT_EVENT
+ isPrimary: Boolean!
"""
- Represents a 'renamed' event on a given issue or pull request
+ Identifies the date and time when the object was last updated.
"""
- RENAMED_TITLE_EVENT
+ updatedAt: DateTime!
"""
- Represents a 'reopened' event on any `Closable`.
+ The user account to which the email belongs.
"""
- REOPENED_EVENT
+ userAccount: EnterpriseServerUserAccount!
+}
+"""
+The connection type for EnterpriseServerUserAccountEmail.
+"""
+type EnterpriseServerUserAccountEmailConnection {
"""
- Represents a 'subscribed' event on a given `Subscribable`.
+ A list of edges.
"""
- SUBSCRIBED_EVENT
+ edges: [EnterpriseServerUserAccountEmailEdge]
"""
- Represents a 'transferred' event on a given issue or pull request.
+ A list of nodes.
"""
- TRANSFERRED_EVENT
+ nodes: [EnterpriseServerUserAccountEmail]
"""
- Represents an 'unassigned' event on any assignable object.
+ Information to aid in pagination.
"""
- UNASSIGNED_EVENT
+ pageInfo: PageInfo!
"""
- Represents an 'unlabeled' event on a given issue or pull request.
+ Identifies the total count of items in the connection.
"""
- UNLABELED_EVENT
+ totalCount: Int!
+}
+"""
+An edge in a connection.
+"""
+type EnterpriseServerUserAccountEmailEdge {
"""
- Represents an 'unlocked' event on a given issue or pull request.
+ A cursor for use in pagination.
"""
- UNLOCKED_EVENT
+ cursor: String!
"""
- Represents an 'unpinned' event on a given issue or pull request.
+ The item at the end of the edge.
"""
- UNPINNED_EVENT
+ node: EnterpriseServerUserAccountEmail
+}
+"""
+Ordering options for Enterprise Server user account email connections.
+"""
+input EnterpriseServerUserAccountEmailOrder {
"""
- Represents an 'unsubscribed' event on a given `Subscribable`.
+ The ordering direction.
"""
- UNSUBSCRIBED_EVENT
+ direction: OrderDirection!
"""
- Represents a 'user_blocked' event on a given user.
+ The field to order emails by.
"""
- USER_BLOCKED_EVENT
+ field: EnterpriseServerUserAccountEmailOrderField!
}
"""
-Represents a user signing up for a GitHub account.
+Properties by which Enterprise Server user account email connections can be ordered.
"""
-type JoinedGitHubContribution implements Contribution {
+enum EnterpriseServerUserAccountEmailOrderField {
"""
- Whether this contribution is associated with a record you do not have access to. For
- example, your own 'first issue' contribution may have been made on a repository you can no
- longer access.
+ Order emails by email
"""
- isRestricted: Boolean!
+ EMAIL
+}
+"""
+Ordering options for Enterprise Server user account connections.
+"""
+input EnterpriseServerUserAccountOrder {
"""
- When this contribution was made.
+ The ordering direction.
"""
- occurredAt: DateTime!
+ direction: OrderDirection!
"""
- The HTTP path for this contribution.
+ The field to order user accounts by.
"""
- resourcePath: URI!
+ field: EnterpriseServerUserAccountOrderField!
+}
+"""
+Properties by which Enterprise Server user account connections can be ordered.
+"""
+enum EnterpriseServerUserAccountOrderField {
"""
- The HTTP URL for this contribution.
+ Order user accounts by login
"""
- url: URI!
+ LOGIN
"""
- The user who made this contribution.
+ Order user accounts by creation time on the Enterprise Server installation
"""
- user: User!
+ REMOTE_CREATED_AT
}
"""
-A label for categorizing Issues or Milestones with a given Repository.
+A user accounts upload from an Enterprise Server installation.
"""
-type Label implements Node {
+type EnterpriseServerUserAccountsUpload implements Node {
"""
- Identifies the label color.
+ Identifies the date and time when the object was created.
"""
- color: String!
+ createdAt: DateTime!
"""
- Identifies the date and time when the label was created.
+ The enterprise to which this upload belongs.
"""
- createdAt: DateTime
+ enterprise: Enterprise!
"""
- A brief description of this label.
+ The Enterprise Server installation for which this upload was generated.
"""
- description: String
+ enterpriseServerInstallation: EnterpriseServerInstallation!
id: ID!
"""
- Indicates whether or not this is a default label.
+ The name of the file uploaded.
"""
- isDefault: Boolean!
+ name: String!
"""
- A list of issues associated with this label.
+ The synchronization state of the upload
"""
- issues(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
+ syncState: EnterpriseServerUserAccountsUploadSyncState!
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
+ """
+ Identifies the date and time when the object was last updated.
+ """
+ updatedAt: DateTime!
+}
- """
- Filtering options for issues returned from the connection.
- """
- filterBy: IssueFilters
+"""
+The connection type for EnterpriseServerUserAccountsUpload.
+"""
+type EnterpriseServerUserAccountsUploadConnection {
+ """
+ A list of edges.
+ """
+ edges: [EnterpriseServerUserAccountsUploadEdge]
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
+ """
+ A list of nodes.
+ """
+ nodes: [EnterpriseServerUserAccountsUpload]
- """
- A list of label names to filter the pull requests by.
- """
- labels: [String!]
+ """
+ Information to aid in pagination.
+ """
+ pageInfo: PageInfo!
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
+ """
+ Identifies the total count of items in the connection.
+ """
+ totalCount: Int!
+}
- """
- Ordering options for issues returned from the connection.
- """
- orderBy: IssueOrder
+"""
+An edge in a connection.
+"""
+type EnterpriseServerUserAccountsUploadEdge {
+ """
+ A cursor for use in pagination.
+ """
+ cursor: String!
+
+ """
+ The item at the end of the edge.
+ """
+ node: EnterpriseServerUserAccountsUpload
+}
+
+"""
+Ordering options for Enterprise Server user accounts upload connections.
+"""
+input EnterpriseServerUserAccountsUploadOrder {
+ """
+ The ordering direction.
+ """
+ direction: OrderDirection!
+
+ """
+ The field to order user accounts uploads by.
+ """
+ field: EnterpriseServerUserAccountsUploadOrderField!
+}
+
+"""
+Properties by which Enterprise Server user accounts upload connections can be ordered.
+"""
+enum EnterpriseServerUserAccountsUploadOrderField {
+ """
+ Order user accounts uploads by creation time
+ """
+ CREATED_AT
+}
+
+"""
+Synchronization state of the Enterprise Server user accounts upload
+"""
+enum EnterpriseServerUserAccountsUploadSyncState {
+ """
+ The synchronization of the upload failed.
+ """
+ FAILURE
+
+ """
+ The synchronization of the upload is pending.
+ """
+ PENDING
+ """
+ The synchronization of the upload succeeded.
+ """
+ SUCCESS
+}
+
+"""
+An account for a user who is an admin of an enterprise or a member of an enterprise through one or more organizations.
+"""
+type EnterpriseUserAccount implements Actor & Node {
+ """
+ A URL pointing to the enterprise user account's public avatar.
+ """
+ avatarUrl(
"""
- A list of states to filter the issues by.
+ The size of the resulting square image.
"""
- states: [IssueState!]
- ): IssueConnection!
+ size: Int
+ ): URI!
"""
- Identifies the label name.
+ Identifies the date and time when the object was created.
"""
- name: String!
+ createdAt: DateTime!
"""
- A list of pull requests associated with this label.
+ The enterprise in which this user account exists.
"""
- pullRequests(
+ enterprise: Enterprise!
+ id: ID!
+
+ """
+ An identifier for the enterprise user account, a login or email address
+ """
+ login: String!
+
+ """
+ The name of the enterprise user account
+ """
+ name: String
+
+ """
+ A list of enterprise organizations this user is a member of.
+ """
+ organizations(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
- """
- The base ref name to filter the pull requests by.
- """
- baseRefName: String
-
"""
Returns the elements in the list that come before the specified cursor.
"""
@@ -8547,65 +9248,60 @@ type Label implements Node {
first: Int
"""
- The head ref name to filter the pull requests by.
- """
- headRefName: String
-
- """
- A list of label names to filter the pull requests by.
+ Returns the last _n_ elements from the list.
"""
- labels: [String!]
+ last: Int
"""
- Returns the last _n_ elements from the list.
+ Ordering options for organizations returned from the connection.
"""
- last: Int
+ orderBy: OrganizationOrder = {field: LOGIN, direction: ASC}
"""
- Ordering options for pull requests returned from the connection.
+ The search string to look for.
"""
- orderBy: IssueOrder
+ query: String
"""
- A list of states to filter the pull requests by.
+ The role of the user in the enterprise organization.
"""
- states: [PullRequestState!]
- ): PullRequestConnection!
+ role: EnterpriseUserAccountMembershipRole
+ ): EnterpriseOrganizationMembershipConnection!
"""
- The repository associated with this label.
+ The HTTP path for this user.
"""
- repository: Repository!
+ resourcePath: URI!
"""
- The HTTP path for this label.
+ Identifies the date and time when the object was last updated.
"""
- resourcePath: URI!
+ updatedAt: DateTime!
"""
- Identifies the date and time when the label was last updated.
+ The HTTP URL for this user.
"""
- updatedAt: DateTime
+ url: URI!
"""
- The HTTP URL for this label.
+ The user within the enterprise.
"""
- url: URI!
+ user: User
}
"""
-The connection type for Label.
+The connection type for EnterpriseUserAccount.
"""
-type LabelConnection {
+type EnterpriseUserAccountConnection {
"""
A list of edges.
"""
- edges: [LabelEdge]
+ edges: [EnterpriseUserAccountEdge]
"""
A list of nodes.
"""
- nodes: [Label]
+ nodes: [EnterpriseUserAccount]
"""
Information to aid in pagination.
@@ -8621,7 +9317,7 @@ type LabelConnection {
"""
An edge in a connection.
"""
-type LabelEdge {
+type EnterpriseUserAccountEdge {
"""
A cursor for use in pagination.
"""
@@ -8630,94 +9326,83 @@ type LabelEdge {
"""
The item at the end of the edge.
"""
- node: Label
+ node: EnterpriseUserAccount
}
"""
-An object that can have labels assigned to it.
+The possible roles for enterprise membership.
"""
-interface Labelable {
+enum EnterpriseUserAccountMembershipRole {
"""
- A list of labels associated with the object.
+ The user is a member of the enterprise membership.
"""
- labels(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
+ MEMBER
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): LabelConnection
+ """
+ The user is an owner of the enterprise membership.
+ """
+ OWNER
}
"""
-Represents a 'labeled' event on a given issue or pull request.
+The possible GitHub Enterprise deployments where this user can exist.
"""
-type LabeledEvent implements Node {
+enum EnterpriseUserDeployment {
"""
- Identifies the actor who performed the event.
+ The user is part of a GitHub Enterprise Cloud deployment.
"""
- actor: Actor
+ CLOUD
"""
- Identifies the date and time when the object was created.
+ The user is part of a GitHub Enterprise Server deployment.
"""
- createdAt: DateTime!
+ SERVER
+}
+
+"""
+An external identity provisioned by SAML SSO or SCIM.
+"""
+type ExternalIdentity implements Node {
+ """
+ The GUID for this identity
+ """
+ guid: String!
id: ID!
"""
- Identifies the label associated with the 'labeled' event.
+ Organization invitation for this SCIM-provisioned external identity
"""
- label: Label!
+ organizationInvitation: OrganizationInvitation
"""
- Identifies the `Labelable` associated with the event.
+ SAML Identity attributes
"""
- labelable: Labelable!
-}
+ samlIdentity: ExternalIdentitySamlAttributes
-"""
-Represents a given language found in repositories.
-"""
-type Language implements Node {
"""
- The color defined for the current language.
+ SCIM Identity attributes
"""
- color: String
- id: ID!
+ scimIdentity: ExternalIdentityScimAttributes
"""
- The name of the current language.
+ User linked to this external identity. Will be NULL if this identity has not been claimed by an organization member.
"""
- name: String!
+ user: User
}
"""
-A list of languages associated with the parent.
+The connection type for ExternalIdentity.
"""
-type LanguageConnection {
+type ExternalIdentityConnection {
"""
A list of edges.
"""
- edges: [LanguageEdge]
+ edges: [ExternalIdentityEdge]
"""
A list of nodes.
"""
- nodes: [Language]
+ nodes: [ExternalIdentity]
"""
Information to aid in pagination.
@@ -8728,332 +9413,327 @@ type LanguageConnection {
Identifies the total count of items in the connection.
"""
totalCount: Int!
-
- """
- The total size in bytes of files written in that language.
- """
- totalSize: Int!
-}
-
-"""
-Represents the language of a repository.
-"""
-type LanguageEdge {
- cursor: String!
- node: Language!
-
- """
- The number of bytes of code written in the language.
- """
- size: Int!
}
"""
-Ordering options for language connections.
+An edge in a connection.
"""
-input LanguageOrder {
- """
- The ordering direction.
- """
- direction: OrderDirection!
-
+type ExternalIdentityEdge {
"""
- The field to order languages by.
+ A cursor for use in pagination.
"""
- field: LanguageOrderField!
-}
+ cursor: String!
-"""
-Properties by which language connections can be ordered.
-"""
-enum LanguageOrderField {
"""
- Order languages by the size of all files containing the language
+ The item at the end of the edge.
"""
- SIZE
+ node: ExternalIdentity
}
"""
-A repository's open source license
+SAML attributes for the External Identity
"""
-type License implements Node {
- """
- The full text of the license
- """
- body: String!
-
- """
- The conditions set by the license
- """
- conditions: [LicenseRule]!
-
- """
- A human-readable description of the license
- """
- description: String
-
+type ExternalIdentitySamlAttributes {
"""
- Whether the license should be featured
+ The emails associated with the SAML identity
"""
- featured: Boolean!
+ emails: [UserEmailMetadata!]
"""
- Whether the license should be displayed in license pickers
+ Family name of the SAML identity
"""
- hidden: Boolean!
- id: ID!
+ familyName: String
"""
- Instructions on how to implement the license
+ Given name of the SAML identity
"""
- implementation: String
+ givenName: String
"""
- The lowercased SPDX ID of the license
+ The groups linked to this identity in IDP
"""
- key: String!
+ groups: [String!]
"""
- The limitations set by the license
+ The NameID of the SAML identity
"""
- limitations: [LicenseRule]!
+ nameId: String
"""
- The license full name specified by
+ The userName of the SAML identity
"""
- name: String!
+ username: String
+}
+"""
+SCIM attributes for the External Identity
+"""
+type ExternalIdentityScimAttributes {
"""
- Customary short name if applicable (e.g, GPLv3)
+ The emails associated with the SCIM identity
"""
- nickname: String
+ emails: [UserEmailMetadata!]
"""
- The permissions set by the license
+ Family name of the SCIM identity
"""
- permissions: [LicenseRule]!
+ familyName: String
"""
- Whether the license is a pseudo-license placeholder (e.g., other, no-license)
+ Given name of the SCIM identity
"""
- pseudoLicense: Boolean!
+ givenName: String
"""
- Short identifier specified by
+ The groups linked to this identity in IDP
"""
- spdxId: String
+ groups: [String!]
"""
- URL to the license on
+ The userName of the SCIM identity
"""
- url: URI
+ username: String
}
"""
-Describes a License's conditions, permissions, and limitations
+The possible viewed states of a file .
"""
-type LicenseRule {
+enum FileViewedState {
"""
- A description of the rule
+ The file has new changes since last viewed.
"""
- description: String!
+ DISMISSED
"""
- The machine-readable rule key
+ The file has not been marked as viewed.
"""
- key: String!
+ UNVIEWED
"""
- The human-readable rule label
+ The file has been marked as viewed.
"""
- label: String!
+ VIEWED
}
"""
-Autogenerated input type of LockLockable
+Autogenerated input type of FollowUser
"""
-input LockLockableInput {
+input FollowUserInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
- A reason for why the issue or pull request will be locked.
- """
- lockReason: LockReason
-
- """
- ID of the issue or pull request to be locked.
+ ID of the user to follow.
"""
- lockableId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "Lockable")
+ userId: ID! @possibleTypes(concreteTypes: ["User"])
}
"""
-Autogenerated return type of LockLockable
+Autogenerated return type of FollowUser
"""
-type LockLockablePayload {
+type FollowUserPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
- The item that was locked.
+ The user that was followed.
"""
- lockedRecord: Lockable
+ user: User
}
"""
-The possible reasons that an issue or pull request was locked.
+The connection type for User.
"""
-enum LockReason {
+type FollowerConnection {
"""
- The issue or pull request was locked because the conversation was off-topic.
+ A list of edges.
"""
- OFF_TOPIC
+ edges: [UserEdge]
"""
- The issue or pull request was locked because the conversation was resolved.
+ A list of nodes.
"""
- RESOLVED
+ nodes: [User]
"""
- The issue or pull request was locked because the conversation was spam.
+ Information to aid in pagination.
"""
- SPAM
+ pageInfo: PageInfo!
"""
- The issue or pull request was locked because the conversation was too heated.
+ Identifies the total count of items in the connection.
"""
- TOO_HEATED
+ totalCount: Int!
}
"""
-An object that can be locked.
+The connection type for User.
"""
-interface Lockable {
+type FollowingConnection {
"""
- Reason that the conversation was locked.
+ A list of edges.
"""
- activeLockReason: LockReason
+ edges: [UserEdge]
"""
- `true` if the object is locked
+ A list of nodes.
"""
- locked: Boolean!
-}
+ nodes: [User]
-"""
-Represents a 'locked' event on a given issue or pull request.
-"""
-type LockedEvent implements Node {
"""
- Identifies the actor who performed the event.
+ Information to aid in pagination.
"""
- actor: Actor
+ pageInfo: PageInfo!
"""
- Identifies the date and time when the object was created.
+ Identifies the total count of items in the connection.
"""
- createdAt: DateTime!
- id: ID!
+ totalCount: Int!
+}
+"""
+A generic hovercard context with a message and icon
+"""
+type GenericHovercardContext implements HovercardContext {
"""
- Reason that the conversation was locked (optional).
+ A string describing this context
"""
- lockReason: LockReason
+ message: String!
"""
- Object that was locked.
+ An octicon to accompany this context
"""
- lockable: Lockable!
+ octicon: String!
}
"""
-A placeholder user for attribution of imported data on GitHub.
+A Gist.
"""
-type Mannequin implements Actor & Node & UniformResourceLocatable {
+type Gist implements Node & Starrable & UniformResourceLocatable {
"""
- A URL pointing to the GitHub App's public avatar.
+ A list of comments associated with the gist
"""
- avatarUrl(
+ comments(
"""
- The size of the resulting square image.
+ Returns the elements in the list that come after the specified cursor.
"""
- size: Int
- ): URI!
+ after: String
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): GistCommentConnection!
"""
- Identifies the primary key from the database.
+ Identifies the date and time when the object was created.
"""
- databaseId: Int
- id: ID!
+ createdAt: DateTime!
"""
- The username of the actor.
+ The gist description.
"""
- login: String!
+ description: String
"""
- The HTML path to this resource.
+ The files in this gist.
"""
- resourcePath: URI!
+ files(
+ """
+ The maximum number of files to return.
+ """
+ limit: Int = 10
+
+ """
+ The oid of the files to return
+ """
+ oid: GitObjectID
+ ): [GistFile]
"""
- Identifies the date and time when the object was last updated.
+ A list of forks associated with the gist
"""
- updatedAt: DateTime!
+ forks(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Ordering options for gists returned from the connection
+ """
+ orderBy: GistOrder
+ ): GistConnection!
+ id: ID!
"""
- The URL to this resource.
+ Identifies if the gist is a fork.
"""
- url: URI!
-}
+ isFork: Boolean!
-"""
-Autogenerated input type of MarkPullRequestReadyForReview
-"""
-input MarkPullRequestReadyForReviewInput @preview(toggledBy: "shadow-cat-preview") {
"""
- A unique identifier for the client performing the mutation.
+ Whether the gist is public or not.
"""
- clientMutationId: String
+ isPublic: Boolean!
"""
- ID of the pull request to be marked as ready for review.
+ The gist name.
"""
- pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"])
-}
+ name: String!
-"""
-Autogenerated return type of MarkPullRequestReadyForReview
-"""
-type MarkPullRequestReadyForReviewPayload @preview(toggledBy: "shadow-cat-preview") {
"""
- A unique identifier for the client performing the mutation.
+ The gist owner.
"""
- clientMutationId: String
+ owner: RepositoryOwner
"""
- The pull request that is ready for review.
+ Identifies when the gist was last pushed to.
"""
- pullRequest: PullRequest
-}
+ pushedAt: DateTime
-"""
-Entities that have members who can set status messages.
-"""
-interface MemberStatusable {
"""
- Get the status messages members of this entity have set that are either public or visible only to the organization.
+ The HTML path to this resource.
"""
- memberStatuses(
+ resourcePath: URI!
+
+ """
+ Returns a count of how many stargazers there are on this object
+ """
+ stargazerCount: Int!
+
+ """
+ A list of users who have starred this starrable.
+ """
+ stargazers(
"""
Returns the elements in the list that come after the specified cursor.
"""
@@ -9075,2469 +9755,2967 @@ interface MemberStatusable {
last: Int
"""
- Ordering options for user statuses returned from the connection.
+ Order for connection
"""
- orderBy: UserStatusOrder = {field: UPDATED_AT, direction: DESC}
- ): UserStatusConnection!
-}
+ orderBy: StarOrder
+ ): StargazerConnection!
-"""
-Audit log entry for a members_can_delete_repos.clear event.
-"""
-type MembersCanDeleteReposClearAuditEntry implements AuditEntry & EnterpriseAuditEntryData & Node & OrganizationAuditEntryData @preview(toggledBy: "audit-log-preview") {
"""
- The action name
+ Identifies the date and time when the object was last updated.
"""
- action: String!
+ updatedAt: DateTime!
"""
- The user who initiated the action
+ The HTTP URL for this Gist.
"""
- actor: AuditEntryActor
+ url: URI!
"""
- The IP address of the actor
+ Returns a boolean indicating whether the viewing user has starred this starrable.
"""
- actorIp: String
+ viewerHasStarred: Boolean!
+}
+"""
+Represents a comment on an Gist.
+"""
+type GistComment implements Comment & Deletable & Minimizable & Node & Updatable & UpdatableComment {
"""
- A readable representation of the actor's location
+ The actor who authored the comment.
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ author: Actor
"""
- The username of the user who initiated the action
+ Author's association with the gist.
"""
- actorLogin: String
+ authorAssociation: CommentAuthorAssociation!
"""
- The HTTP path for the actor.
+ Identifies the comment body.
"""
- actorResourcePath: URI
+ body: String!
"""
- The HTTP URL for the actor.
+ The body rendered to HTML.
"""
- actorUrl: URI
+ bodyHTML: HTML!
"""
- The time the action was initiated
+ The body rendered to text.
"""
- createdAt: PreciseDateTime!
+ bodyText: String!
"""
- The HTTP path for this enterprise.
+ Identifies the date and time when the object was created.
"""
- enterpriseResourcePath: URI
+ createdAt: DateTime!
"""
- The slug of the enterprise.
+ Check if this comment was created via an email reply.
"""
- enterpriseSlug: String
+ createdViaEmail: Boolean!
"""
- The HTTP URL for this enterprise.
+ Identifies the primary key from the database.
"""
- enterpriseUrl: URI
- id: ID!
+ databaseId: Int
"""
- The Organization associated with the Audit Entry.
+ The actor who edited the comment.
"""
- organization: Organization
+ editor: Actor
"""
- The name of the Organization.
+ The associated gist.
"""
- organizationName: String
+ gist: Gist!
+ id: ID!
"""
- The HTTP path for the organization
+ Check if this comment was edited and includes an edit with the creation data
"""
- organizationResourcePath: URI
+ includesCreatedEdit: Boolean!
"""
- The HTTP URL for the organization
+ Returns whether or not a comment has been minimized.
"""
- organizationUrl: URI
+ isMinimized: Boolean!
"""
- The user affected by the action
+ The moment the editor made the last edit
"""
- user: User
+ lastEditedAt: DateTime
"""
- For actions involving two users, the actor is the initiator and the user is the affected user.
+ Returns why the comment was minimized.
"""
- userLogin: String
+ minimizedReason: String
"""
- The HTTP path for the user.
+ Identifies when the comment was published at.
"""
- userResourcePath: URI
+ publishedAt: DateTime
"""
- The HTTP URL for the user.
+ Identifies the date and time when the object was last updated.
"""
- userUrl: URI
-}
+ updatedAt: DateTime!
-"""
-Audit log entry for a members_can_delete_repos.disable event.
-"""
-type MembersCanDeleteReposDisableAuditEntry implements AuditEntry & EnterpriseAuditEntryData & Node & OrganizationAuditEntryData @preview(toggledBy: "audit-log-preview") {
"""
- The action name
+ A list of edits to this content.
"""
- action: String!
+ userContentEdits(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): UserContentEditConnection
"""
- The user who initiated the action
+ Check if the current viewer can delete this object.
"""
- actor: AuditEntryActor
+ viewerCanDelete: Boolean!
"""
- The IP address of the actor
+ Check if the current viewer can minimize this object.
"""
- actorIp: String
+ viewerCanMinimize: Boolean!
"""
- A readable representation of the actor's location
+ Check if the current viewer can update this object.
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ viewerCanUpdate: Boolean!
"""
- The username of the user who initiated the action
+ Reasons why the current viewer can not update this comment.
"""
- actorLogin: String
+ viewerCannotUpdateReasons: [CommentCannotUpdateReason!]!
"""
- The HTTP path for the actor.
+ Did the viewer author this comment.
"""
- actorResourcePath: URI
+ viewerDidAuthor: Boolean!
+}
+"""
+The connection type for GistComment.
+"""
+type GistCommentConnection {
"""
- The HTTP URL for the actor.
+ A list of edges.
"""
- actorUrl: URI
+ edges: [GistCommentEdge]
"""
- The time the action was initiated
- """
- createdAt: PreciseDateTime!
-
- """
- The HTTP path for this enterprise.
+ A list of nodes.
"""
- enterpriseResourcePath: URI
+ nodes: [GistComment]
"""
- The slug of the enterprise.
+ Information to aid in pagination.
"""
- enterpriseSlug: String
+ pageInfo: PageInfo!
"""
- The HTTP URL for this enterprise.
+ Identifies the total count of items in the connection.
"""
- enterpriseUrl: URI
- id: ID!
+ totalCount: Int!
+}
+"""
+An edge in a connection.
+"""
+type GistCommentEdge {
"""
- The Organization associated with the Audit Entry.
+ A cursor for use in pagination.
"""
- organization: Organization
+ cursor: String!
"""
- The name of the Organization.
+ The item at the end of the edge.
"""
- organizationName: String
+ node: GistComment
+}
+"""
+The connection type for Gist.
+"""
+type GistConnection {
"""
- The HTTP path for the organization
+ A list of edges.
"""
- organizationResourcePath: URI
+ edges: [GistEdge]
"""
- The HTTP URL for the organization
+ A list of nodes.
"""
- organizationUrl: URI
+ nodes: [Gist]
"""
- The user affected by the action
+ Information to aid in pagination.
"""
- user: User
+ pageInfo: PageInfo!
"""
- For actions involving two users, the actor is the initiator and the user is the affected user.
+ Identifies the total count of items in the connection.
"""
- userLogin: String
+ totalCount: Int!
+}
+"""
+An edge in a connection.
+"""
+type GistEdge {
"""
- The HTTP path for the user.
+ A cursor for use in pagination.
"""
- userResourcePath: URI
+ cursor: String!
"""
- The HTTP URL for the user.
+ The item at the end of the edge.
"""
- userUrl: URI
+ node: Gist
}
"""
-Audit log entry for a members_can_delete_repos.enable event.
+A file in a gist.
"""
-type MembersCanDeleteReposEnableAuditEntry implements AuditEntry & EnterpriseAuditEntryData & Node & OrganizationAuditEntryData @preview(toggledBy: "audit-log-preview") {
+type GistFile {
"""
- The action name
+ The file name encoded to remove characters that are invalid in URL paths.
"""
- action: String!
+ encodedName: String
"""
- The user who initiated the action
+ The gist file encoding.
"""
- actor: AuditEntryActor
+ encoding: String
"""
- The IP address of the actor
+ The file extension from the file name.
"""
- actorIp: String
+ extension: String
"""
- A readable representation of the actor's location
+ Indicates if this file is an image.
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ isImage: Boolean!
"""
- The username of the user who initiated the action
+ Whether the file's contents were truncated.
"""
- actorLogin: String
+ isTruncated: Boolean!
"""
- The HTTP path for the actor.
+ The programming language this file is written in.
"""
- actorResourcePath: URI
+ language: Language
"""
- The HTTP URL for the actor.
+ The gist file name.
"""
- actorUrl: URI
+ name: String
"""
- The time the action was initiated
+ The gist file size in bytes.
"""
- createdAt: PreciseDateTime!
+ size: Int
"""
- The HTTP path for this enterprise.
+ UTF8 text data or null if the file is binary
"""
- enterpriseResourcePath: URI
+ text(
+ """
+ Optionally truncate the returned file to this length.
+ """
+ truncate: Int
+ ): String
+}
+"""
+Ordering options for gist connections
+"""
+input GistOrder {
"""
- The slug of the enterprise.
+ The ordering direction.
"""
- enterpriseSlug: String
+ direction: OrderDirection!
"""
- The HTTP URL for this enterprise.
+ The field to order repositories by.
"""
- enterpriseUrl: URI
- id: ID!
+ field: GistOrderField!
+}
+"""
+Properties by which gist connections can be ordered.
+"""
+enum GistOrderField {
"""
- The Organization associated with the Audit Entry.
+ Order gists by creation time
"""
- organization: Organization
+ CREATED_AT
"""
- The name of the Organization.
+ Order gists by push time
"""
- organizationName: String
+ PUSHED_AT
"""
- The HTTP path for the organization
+ Order gists by update time
"""
- organizationResourcePath: URI
+ UPDATED_AT
+}
+"""
+The privacy of a Gist
+"""
+enum GistPrivacy {
"""
- The HTTP URL for the organization
+ Gists that are public and secret
"""
- organizationUrl: URI
+ ALL
"""
- The user affected by the action
+ Public
"""
- user: User
+ PUBLIC
"""
- For actions involving two users, the actor is the initiator and the user is the affected user.
+ Secret
"""
- userLogin: String
+ SECRET
+}
+"""
+Represents an actor in a Git commit (ie. an author or committer).
+"""
+type GitActor {
"""
- The HTTP path for the user.
+ A URL pointing to the author's public avatar.
"""
- userResourcePath: URI
+ avatarUrl(
+ """
+ The size of the resulting square image.
+ """
+ size: Int
+ ): URI!
"""
- The HTTP URL for the user.
+ The timestamp of the Git action (authoring or committing).
"""
- userUrl: URI
-}
+ date: GitTimestamp
-"""
-Represents a 'mentioned' event on a given issue or pull request.
-"""
-type MentionedEvent implements Node {
"""
- Identifies the actor who performed the event.
+ The email in the Git commit.
"""
- actor: Actor
+ email: String
"""
- Identifies the date and time when the object was created.
+ The name in the Git commit.
"""
- createdAt: DateTime!
+ name: String
"""
- Identifies the primary key from the database.
+ The GitHub user corresponding to the email field. Null if no such user exists.
"""
- databaseId: Int
- id: ID!
+ user: User
}
"""
-Autogenerated input type of MergeBranch
+The connection type for GitActor.
"""
-input MergeBranchInput {
+type GitActorConnection {
"""
- The name of the base branch that the provided head will be merged into.
+ A list of edges.
"""
- base: String!
+ edges: [GitActorEdge]
"""
- A unique identifier for the client performing the mutation.
+ A list of nodes.
"""
- clientMutationId: String
+ nodes: [GitActor]
"""
- Message to use for the merge commit. If omitted, a default will be used.
+ Information to aid in pagination.
"""
- commitMessage: String
+ pageInfo: PageInfo!
"""
- The head to merge into the base branch. This can be a branch name or a commit GitObjectID.
+ Identifies the total count of items in the connection.
"""
- head: String!
+ totalCount: Int!
+}
+"""
+An edge in a connection.
+"""
+type GitActorEdge {
"""
- The Node ID of the Repository containing the base branch that will be modified.
+ A cursor for use in pagination.
"""
- repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
+ cursor: String!
+
+ """
+ The item at the end of the edge.
+ """
+ node: GitActor
}
"""
-Autogenerated return type of MergeBranch
+Represents information about the GitHub instance.
"""
-type MergeBranchPayload {
+type GitHubMetadata {
"""
- A unique identifier for the client performing the mutation.
+ Returns a String that's a SHA of `github-services`
"""
- clientMutationId: String
+ gitHubServicesSha: GitObjectID!
"""
- The resulting merge Commit.
+ Whether or not users are verified
"""
- mergeCommit: Commit
+ isPasswordAuthenticationVerifiable: Boolean!
}
"""
-Autogenerated input type of MergePullRequest
+Represents a Git object.
"""
-input MergePullRequestInput {
+interface GitObject {
"""
- A unique identifier for the client performing the mutation.
+ An abbreviated version of the Git object ID
"""
- clientMutationId: String
+ abbreviatedOid: String!
"""
- Commit body to use for the merge commit; if omitted, a default message will be used
+ The HTTP path for this Git object
"""
- commitBody: String
+ commitResourcePath: URI!
"""
- Commit headline to use for the merge commit; if omitted, a default message will be used.
+ The HTTP URL for this Git object
"""
- commitHeadline: String
+ commitUrl: URI!
+ id: ID!
"""
- OID that the pull request head ref must match to allow merge; if omitted, no check is performed.
+ The Git object ID
"""
- expectedHeadOid: GitObjectID
+ oid: GitObjectID!
"""
- ID of the pull request to be merged.
+ The Repository the Git object belongs to
"""
- pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"])
+ repository: Repository!
}
"""
-Autogenerated return type of MergePullRequest
+A Git object ID.
"""
-type MergePullRequestPayload {
+scalar GitObjectID
+
+"""
+A fully qualified reference name (e.g. `refs/heads/master`).
+"""
+scalar GitRefname @preview(toggledBy: "update-refs-preview")
+
+"""
+Git SSH string
+"""
+scalar GitSSHRemote
+
+"""
+Information about a signature (GPG or S/MIME) on a Commit or Tag.
+"""
+interface GitSignature {
"""
- A unique identifier for the client performing the mutation.
+ Email used to sign this object.
"""
- clientMutationId: String
+ email: String!
"""
- The pull request that was merged.
+ True if the signature is valid and verified by GitHub.
"""
- pullRequest: PullRequest
-}
+ isValid: Boolean!
-"""
-Detailed status information about a pull request merge.
-"""
-enum MergeStateStatus {
"""
- The head ref is out of date.
+ Payload for GPG signing object. Raw ODB object without the signature header.
"""
- BEHIND
+ payload: String!
"""
- The merge is blocked.
+ ASCII-armored signature header from object.
"""
- BLOCKED
+ signature: String!
"""
- Mergeable and passing commit status.
+ GitHub user corresponding to the email signing this commit.
"""
- CLEAN
+ signer: User
"""
- The merge commit cannot be cleanly created.
+ The state of this signature. `VALID` if signature is valid and verified by
+ GitHub, otherwise represents reason why signature is considered invalid.
"""
- DIRTY
+ state: GitSignatureState!
"""
- The merge is blocked due to the pull request being a draft.
+ True if the signature was made with GitHub's signing key.
"""
- DRAFT
+ wasSignedByGitHub: Boolean!
+}
+"""
+The state of a Git signature.
+"""
+enum GitSignatureState {
"""
- Mergeable with passing commit status and pre-recieve hooks.
+ The signing certificate or its chain could not be verified
"""
- HAS_HOOKS
+ BAD_CERT
"""
- The state cannot currently be determined.
+ Invalid email used for signing
"""
- UNKNOWN
+ BAD_EMAIL
"""
- Mergeable with non-passing commit status.
+ Signing key expired
"""
- UNSTABLE
-}
+ EXPIRED_KEY
-"""
-Whether or not a PullRequest can be merged.
-"""
-enum MergeableState {
"""
- The pull request cannot be merged due to merge conflicts.
+ Internal error - the GPG verification service misbehaved
"""
- CONFLICTING
+ GPGVERIFY_ERROR
"""
- The pull request can be merged.
+ Internal error - the GPG verification service is unavailable at the moment
"""
- MERGEABLE
+ GPGVERIFY_UNAVAILABLE
"""
- The mergeability of the pull request is still being calculated.
+ Invalid signature
"""
- UNKNOWN
-}
+ INVALID
-"""
-Represents a 'merged' event on a given pull request.
-"""
-type MergedEvent implements Node & UniformResourceLocatable {
"""
- Identifies the actor who performed the event.
+ Malformed signature
"""
- actor: Actor
+ MALFORMED_SIG
"""
- Identifies the commit associated with the `merge` event.
+ The usage flags for the key that signed this don't allow signing
"""
- commit: Commit
+ NOT_SIGNING_KEY
"""
- Identifies the date and time when the object was created.
+ Email used for signing not known to GitHub
"""
- createdAt: DateTime!
- id: ID!
+ NO_USER
"""
- Identifies the Ref associated with the `merge` event.
+ Valid siganture, though certificate revocation check failed
"""
- mergeRef: Ref
+ OCSP_ERROR
"""
- Identifies the name of the Ref associated with the `merge` event.
+ Valid signature, pending certificate revocation checking
"""
- mergeRefName: String!
+ OCSP_PENDING
"""
- PullRequest referenced by event.
+ One or more certificates in chain has been revoked
"""
- pullRequest: PullRequest!
+ OCSP_REVOKED
"""
- The HTTP path for this merged event.
+ Key used for signing not known to GitHub
"""
- resourcePath: URI!
+ UNKNOWN_KEY
"""
- The HTTP URL for this merged event.
+ Unknown signature type
"""
- url: URI!
+ UNKNOWN_SIG_TYPE
+
+ """
+ Unsigned
+ """
+ UNSIGNED
+
+ """
+ Email used for signing unverified on GitHub
+ """
+ UNVERIFIED_EMAIL
+
+ """
+ Valid signature and verified by GitHub
+ """
+ VALID
}
"""
-Represents a Milestone object on a given repository.
+An ISO-8601 encoded date string. Unlike the DateTime type, GitTimestamp is not converted in UTC.
"""
-type Milestone implements Closable & Node & UniformResourceLocatable {
+scalar GitTimestamp
+
+"""
+Represents a GPG signature on a Commit or Tag.
+"""
+type GpgSignature implements GitSignature {
"""
- `true` if the object is closed (definition of closed may depend on type)
+ Email used to sign this object.
"""
- closed: Boolean!
+ email: String!
"""
- Identifies the date and time when the object was closed.
+ True if the signature is valid and verified by GitHub.
"""
- closedAt: DateTime
+ isValid: Boolean!
"""
- Identifies the date and time when the object was created.
+ Hex-encoded ID of the key that signed this object.
"""
- createdAt: DateTime!
+ keyId: String
"""
- Identifies the actor who created the milestone.
+ Payload for GPG signing object. Raw ODB object without the signature header.
"""
- creator: Actor
+ payload: String!
"""
- Identifies the description of the milestone.
+ ASCII-armored signature header from object.
"""
- description: String
+ signature: String!
"""
- Identifies the due date of the milestone.
+ GitHub user corresponding to the email signing this commit.
"""
- dueOn: DateTime
- id: ID!
+ signer: User
"""
- Just for debugging on review-lab
+ The state of this signature. `VALID` if signature is valid and verified by
+ GitHub, otherwise represents reason why signature is considered invalid.
"""
- issuePrioritiesDebug: String!
+ state: GitSignatureState!
"""
- A list of issues associated with the milestone.
+ True if the signature was made with GitHub's signing key.
"""
- issues(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
+ wasSignedByGitHub: Boolean!
+}
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
+"""
+A string containing HTML code.
+"""
+scalar HTML
- """
- Filtering options for issues returned from the connection.
- """
- filterBy: IssueFilters
+"""
+Represents a 'head_ref_deleted' event on a given pull request.
+"""
+type HeadRefDeletedEvent implements Node {
+ """
+ Identifies the actor who performed the event.
+ """
+ actor: Actor
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
+ """
+ Identifies the date and time when the object was created.
+ """
+ createdAt: DateTime!
- """
- A list of label names to filter the pull requests by.
- """
- labels: [String!]
+ """
+ Identifies the Ref associated with the `head_ref_deleted` event.
+ """
+ headRef: Ref
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
+ """
+ Identifies the name of the Ref associated with the `head_ref_deleted` event.
+ """
+ headRefName: String!
+ id: ID!
- """
- Ordering options for issues returned from the connection.
- """
- orderBy: IssueOrder
+ """
+ PullRequest referenced by event.
+ """
+ pullRequest: PullRequest!
+}
- """
- A list of states to filter the issues by.
- """
- states: [IssueState!]
- ): IssueConnection!
+"""
+Represents a 'head_ref_force_pushed' event on a given pull request.
+"""
+type HeadRefForcePushedEvent implements Node {
+ """
+ Identifies the actor who performed the event.
+ """
+ actor: Actor
"""
- Identifies the number of the milestone.
+ Identifies the after commit SHA for the 'head_ref_force_pushed' event.
"""
- number: Int!
+ afterCommit: Commit
"""
- A list of pull requests associated with the milestone.
+ Identifies the before commit SHA for the 'head_ref_force_pushed' event.
"""
- pullRequests(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- The base ref name to filter the pull requests by.
- """
- baseRefName: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- The head ref name to filter the pull requests by.
- """
- headRefName: String
-
- """
- A list of label names to filter the pull requests by.
- """
- labels: [String!]
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for pull requests returned from the connection.
- """
- orderBy: IssueOrder
-
- """
- A list of states to filter the pull requests by.
- """
- states: [PullRequestState!]
- ): PullRequestConnection!
-
- """
- The repository associated with this milestone.
- """
- repository: Repository!
-
- """
- The HTTP path for this milestone
- """
- resourcePath: URI!
-
- """
- Identifies the state of the milestone.
- """
- state: MilestoneState!
+ beforeCommit: Commit
"""
- Identifies the title of the milestone.
+ Identifies the date and time when the object was created.
"""
- title: String!
+ createdAt: DateTime!
+ id: ID!
"""
- Identifies the date and time when the object was last updated.
+ PullRequest referenced by event.
"""
- updatedAt: DateTime!
+ pullRequest: PullRequest!
"""
- The HTTP URL for this milestone
+ Identifies the fully qualified ref name for the 'head_ref_force_pushed' event.
"""
- url: URI!
+ ref: Ref
}
"""
-The connection type for Milestone.
+Represents a 'head_ref_restored' event on a given pull request.
"""
-type MilestoneConnection {
+type HeadRefRestoredEvent implements Node {
"""
- A list of edges.
+ Identifies the actor who performed the event.
"""
- edges: [MilestoneEdge]
+ actor: Actor
"""
- A list of nodes.
+ Identifies the date and time when the object was created.
"""
- nodes: [Milestone]
+ createdAt: DateTime!
+ id: ID!
"""
- Information to aid in pagination.
+ PullRequest referenced by event.
"""
- pageInfo: PageInfo!
+ pullRequest: PullRequest!
+}
+"""
+Detail needed to display a hovercard for a user
+"""
+type Hovercard {
"""
- Identifies the total count of items in the connection.
+ Each of the contexts for this hovercard
"""
- totalCount: Int!
+ contexts: [HovercardContext!]!
}
"""
-An edge in a connection.
+An individual line of a hovercard
"""
-type MilestoneEdge {
+interface HovercardContext {
"""
- A cursor for use in pagination.
+ A string describing this context
"""
- cursor: String!
+ message: String!
"""
- The item at the end of the edge.
+ An octicon to accompany this context
"""
- node: Milestone
+ octicon: String!
}
"""
-Types that can be inside a Milestone.
+The possible states in which authentication can be configured with an identity provider.
"""
-union MilestoneItem = Issue | PullRequest
+enum IdentityProviderConfigurationState {
+ """
+ Authentication with an identity provider is configured but not enforced.
+ """
+ CONFIGURED
-"""
-Ordering options for milestone connections.
-"""
-input MilestoneOrder {
"""
- The ordering direction.
+ Authentication with an identity provider is configured and enforced.
"""
- direction: OrderDirection!
+ ENFORCED
"""
- The field to order milestones by.
+ Authentication with an identity provider is not configured.
"""
- field: MilestoneOrderField!
+ UNCONFIGURED
}
"""
-Properties by which milestone connections can be ordered.
+Autogenerated input type of ImportProject
"""
-enum MilestoneOrderField {
+input ImportProjectInput {
"""
- Order milestones by when they were created.
+ The description of Project.
"""
- CREATED_AT
+ body: String
"""
- Order milestones by when they are due.
+ A unique identifier for the client performing the mutation.
"""
- DUE_DATE
+ clientMutationId: String
"""
- Order milestones by their number.
+ A list of columns containing issues and pull requests.
"""
- NUMBER
+ columnImports: [ProjectColumnImport!]!
"""
- Order milestones by when they were last updated.
+ The name of Project.
"""
- UPDATED_AT
-}
+ name: String!
-"""
-The possible states of a milestone.
-"""
-enum MilestoneState {
"""
- A milestone that has been closed.
+ The name of the Organization or User to create the Project under.
"""
- CLOSED
+ ownerName: String!
"""
- A milestone that is still open.
+ Whether the Project is public or not.
"""
- OPEN
+ public: Boolean = false
}
"""
-Represents a 'milestoned' event on a given issue or pull request.
+Autogenerated return type of ImportProject
"""
-type MilestonedEvent implements Node {
+type ImportProjectPayload {
"""
- Identifies the actor who performed the event.
+ A unique identifier for the client performing the mutation.
"""
- actor: Actor
+ clientMutationId: String
"""
- Identifies the date and time when the object was created.
+ The new Project!
"""
- createdAt: DateTime!
- id: ID!
+ project: Project
+}
+"""
+The possible values for the IP allow list enabled setting.
+"""
+enum IpAllowListEnabledSettingValue {
"""
- Identifies the milestone title associated with the 'milestoned' event.
+ The setting is disabled for the owner.
"""
- milestoneTitle: String!
+ DISABLED
"""
- Object referenced by event.
+ The setting is enabled for the owner.
"""
- subject: MilestoneItem!
+ ENABLED
}
"""
-Entities that can be minimized.
+An IP address or range of addresses that is allowed to access an owner's resources.
"""
-interface Minimizable @preview(toggledBy: "queen-beryl-preview") {
+type IpAllowListEntry implements Node {
"""
- Returns whether or not a comment has been minimized.
+ A single IP address or range of IP addresses in CIDR notation.
"""
- isMinimized: Boolean!
+ allowListValue: String!
"""
- Returns why the comment was minimized.
+ Identifies the date and time when the object was created.
"""
- minimizedReason: String
+ createdAt: DateTime!
+ id: ID!
"""
- Check if the current viewer can minimize this object.
+ Whether the entry is currently active.
"""
- viewerCanMinimize: Boolean!
-}
+ isActive: Boolean!
-"""
-Autogenerated input type of MinimizeComment
-"""
-input MinimizeCommentInput {
"""
- The classification of comment
+ The name of the IP allow list entry.
"""
- classifier: ReportedContentClassifiers!
+ name: String
"""
- A unique identifier for the client performing the mutation.
+ The owner of the IP allow list entry.
"""
- clientMutationId: String
+ owner: IpAllowListOwner!
"""
- The Node ID of the subject to modify.
+ Identifies the date and time when the object was last updated.
"""
- subjectId: ID! @possibleTypes(concreteTypes: ["CommitComment", "GistComment", "IssueComment", "PullRequestReviewComment"], abstractType: "Minimizable")
+ updatedAt: DateTime!
}
"""
-Autogenerated return type of MinimizeComment
+The connection type for IpAllowListEntry.
"""
-type MinimizeCommentPayload {
+type IpAllowListEntryConnection {
"""
- A unique identifier for the client performing the mutation.
+ A list of edges.
"""
- clientMutationId: String
+ edges: [IpAllowListEntryEdge]
"""
- The comment that was minimized.
+ A list of nodes.
"""
- minimizedComment: Minimizable
-}
+ nodes: [IpAllowListEntry]
-"""
-Autogenerated input type of MoveProjectCard
-"""
-input MoveProjectCardInput {
"""
- Place the new card after the card with this id. Pass null to place it at the top.
+ Information to aid in pagination.
"""
- afterCardId: ID @possibleTypes(concreteTypes: ["ProjectCard"])
+ pageInfo: PageInfo!
"""
- The id of the card to move.
+ Identifies the total count of items in the connection.
"""
- cardId: ID! @possibleTypes(concreteTypes: ["ProjectCard"])
+ totalCount: Int!
+}
+"""
+An edge in a connection.
+"""
+type IpAllowListEntryEdge {
"""
- A unique identifier for the client performing the mutation.
+ A cursor for use in pagination.
"""
- clientMutationId: String
+ cursor: String!
"""
- The id of the column to move it into.
+ The item at the end of the edge.
"""
- columnId: ID! @possibleTypes(concreteTypes: ["ProjectColumn"])
+ node: IpAllowListEntry
}
"""
-Autogenerated return type of MoveProjectCard
+Ordering options for IP allow list entry connections.
"""
-type MoveProjectCardPayload {
+input IpAllowListEntryOrder {
"""
- The new edge of the moved card.
+ The ordering direction.
"""
- cardEdge: ProjectCardEdge
+ direction: OrderDirection!
"""
- A unique identifier for the client performing the mutation.
+ The field to order IP allow list entries by.
"""
- clientMutationId: String
+ field: IpAllowListEntryOrderField!
}
"""
-Autogenerated input type of MoveProjectColumn
+Properties by which IP allow list entry connections can be ordered.
"""
-input MoveProjectColumnInput {
- """
- Place the new column after the column with this id. Pass null to place it at the front.
+enum IpAllowListEntryOrderField {
"""
- afterColumnId: ID @possibleTypes(concreteTypes: ["ProjectColumn"])
-
- """
- A unique identifier for the client performing the mutation.
+ Order IP allow list entries by the allow list value.
"""
- clientMutationId: String
+ ALLOW_LIST_VALUE
"""
- The id of the column to move.
+ Order IP allow list entries by creation time.
"""
- columnId: ID! @possibleTypes(concreteTypes: ["ProjectColumn"])
+ CREATED_AT
}
"""
-Autogenerated return type of MoveProjectColumn
+Types that can own an IP allow list.
"""
-type MoveProjectColumnPayload {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The new edge of the moved column.
- """
- columnEdge: ProjectColumnEdge
-}
+union IpAllowListOwner = Enterprise | Organization
"""
-Represents a 'moved_columns_in_project' event on a given issue or pull request.
+An Issue is a place to discuss ideas, enhancements, tasks, and bugs for a project.
"""
-type MovedColumnsInProjectEvent implements Node {
- """
- Identifies the actor who performed the event.
- """
- actor: Actor
-
+type Issue implements Assignable & Closable & Comment & Labelable & Lockable & Node & Reactable & RepositoryNode & Subscribable & UniformResourceLocatable & Updatable & UpdatableComment {
"""
- Identifies the date and time when the object was created.
+ Reason that the conversation was locked.
"""
- createdAt: DateTime!
+ activeLockReason: LockReason
"""
- Identifies the primary key from the database.
+ A list of Users assigned to this object.
"""
- databaseId: Int
- id: ID!
+ assignees(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
- """
- Column name the issue or pull request was moved from.
- """
- previousProjectColumnName: String! @preview(toggledBy: "starfox-preview")
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
- """
- Project referenced by event.
- """
- project: Project @preview(toggledBy: "starfox-preview")
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
- """
- Project card referenced by this project event.
- """
- projectCard: ProjectCard @preview(toggledBy: "starfox-preview")
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): UserConnection!
"""
- Column name the issue or pull request was moved to.
+ The actor who authored the comment.
"""
- projectColumnName: String! @preview(toggledBy: "starfox-preview")
-}
+ author: Actor
-"""
-The root query for implementing GraphQL mutations.
-"""
-type Mutation {
"""
- Adds assignees to an assignable object.
+ Author's association with the subject of the comment.
"""
- addAssigneesToAssignable(input: AddAssigneesToAssignableInput!): AddAssigneesToAssignablePayload
+ authorAssociation: CommentAuthorAssociation!
"""
- Adds a comment to an Issue or Pull Request.
+ Identifies the body of the issue.
"""
- addComment(input: AddCommentInput!): AddCommentPayload
+ body: String!
"""
- Adds labels to a labelable object.
+ The body rendered to HTML.
"""
- addLabelsToLabelable(input: AddLabelsToLabelableInput!): AddLabelsToLabelablePayload
+ bodyHTML: HTML!
"""
- Adds a card to a ProjectColumn. Either `contentId` or `note` must be provided but **not** both.
+ The http path for this issue body
"""
- addProjectCard(input: AddProjectCardInput!): AddProjectCardPayload
+ bodyResourcePath: URI!
"""
- Adds a column to a Project.
+ Identifies the body of the issue rendered to text.
"""
- addProjectColumn(input: AddProjectColumnInput!): AddProjectColumnPayload
+ bodyText: String!
"""
- Adds a review to a Pull Request.
+ The http URL for this issue body
"""
- addPullRequestReview(input: AddPullRequestReviewInput!): AddPullRequestReviewPayload
+ bodyUrl: URI!
"""
- Adds a comment to a review.
+ `true` if the object is closed (definition of closed may depend on type)
"""
- addPullRequestReviewComment(input: AddPullRequestReviewCommentInput!): AddPullRequestReviewCommentPayload
+ closed: Boolean!
"""
- Adds a reaction to a subject.
+ Identifies the date and time when the object was closed.
"""
- addReaction(input: AddReactionInput!): AddReactionPayload
+ closedAt: DateTime
"""
- Adds a star to a Starrable.
+ A list of comments associated with the Issue.
"""
- addStar(input: AddStarInput!): AddStarPayload
+ comments(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
- """
- Update your status on GitHub.
- """
- changeUserStatus(input: ChangeUserStatusInput!): ChangeUserStatusPayload
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
- """
- Clears all labels from a labelable object.
- """
- clearLabelsFromLabelable(input: ClearLabelsFromLabelableInput!): ClearLabelsFromLabelablePayload
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
- """
- Creates a new project by cloning configuration from an existing project.
- """
- cloneProject(input: CloneProjectInput!): CloneProjectPayload
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): IssueCommentConnection!
"""
- Create a new repository with the same files and directory structure as a template repository.
+ Identifies the date and time when the object was created.
"""
- cloneTemplateRepository(input: CloneTemplateRepositoryInput!): CloneTemplateRepositoryPayload
+ createdAt: DateTime!
"""
- Close an issue.
+ Check if this comment was created via an email reply.
"""
- closeIssue(input: CloseIssueInput!): CloseIssuePayload
+ createdViaEmail: Boolean!
"""
- Close a pull request.
+ Identifies the primary key from the database.
"""
- closePullRequest(input: ClosePullRequestInput!): ClosePullRequestPayload
+ databaseId: Int
"""
- Convert a project note card to one associated with a newly created issue.
+ The actor who edited the comment.
"""
- convertProjectCardNoteToIssue(input: ConvertProjectCardNoteToIssueInput!): ConvertProjectCardNoteToIssuePayload
+ editor: Actor
"""
- Create a new branch protection rule
+ The hovercard information for this issue
"""
- createBranchProtectionRule(input: CreateBranchProtectionRuleInput!): CreateBranchProtectionRulePayload
+ hovercard(
+ """
+ Whether or not to include notification contexts
+ """
+ includeNotificationContexts: Boolean = true
+ ): Hovercard!
+ id: ID!
"""
- Create a check run.
+ Check if this comment was edited and includes an edit with the creation data
"""
- createCheckRun(input: CreateCheckRunInput!): CreateCheckRunPayload @preview(toggledBy: "antiope-preview")
+ includesCreatedEdit: Boolean!
"""
- Create a check suite
+ Is this issue read by the viewer
"""
- createCheckSuite(input: CreateCheckSuiteInput!): CreateCheckSuitePayload @preview(toggledBy: "antiope-preview")
+ isReadByViewer: Boolean
"""
- Create a content attachment.
+ A list of labels associated with the object.
"""
- createContentAttachment(input: CreateContentAttachmentInput!): CreateContentAttachmentPayload @preview(toggledBy: "corsair-preview")
+ labels(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
- """
- Creates a new deployment event.
- """
- createDeployment(input: CreateDeploymentInput!): CreateDeploymentPayload @preview(toggledBy: "flash-preview")
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
- """
- Create a deployment status.
- """
- createDeploymentStatus(input: CreateDeploymentStatusInput!): CreateDeploymentStatusPayload @preview(toggledBy: "flash-preview")
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
- """
- Creates a new issue.
- """
- createIssue(input: CreateIssueInput!): CreateIssuePayload
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
- """
- Creates a new label.
- """
- createLabel(input: CreateLabelInput!): CreateLabelPayload @preview(toggledBy: "bane-preview")
+ """
+ Ordering options for labels returned from the connection.
+ """
+ orderBy: LabelOrder = {field: CREATED_AT, direction: ASC}
+ ): LabelConnection
"""
- Creates a new project.
+ The moment the editor made the last edit
"""
- createProject(input: CreateProjectInput!): CreateProjectPayload
+ lastEditedAt: DateTime
"""
- Create a new pull request
+ `true` if the object is locked
"""
- createPullRequest(input: CreatePullRequestInput!): CreatePullRequestPayload
+ locked: Boolean!
"""
- Create a new Git Ref.
+ Identifies the milestone associated with the issue.
"""
- createRef(input: CreateRefInput!): CreateRefPayload
+ milestone: Milestone
"""
- Create a new repository.
+ Identifies the issue number.
"""
- createRepository(input: CreateRepositoryInput!): CreateRepositoryPayload
+ number: Int!
"""
- Creates a new team discussion.
+ A list of Users that are participating in the Issue conversation.
"""
- createTeamDiscussion(input: CreateTeamDiscussionInput!): CreateTeamDiscussionPayload @preview(toggledBy: "echo-preview")
+ participants(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
- """
- Creates a new team discussion comment.
- """
- createTeamDiscussionComment(input: CreateTeamDiscussionCommentInput!): CreateTeamDiscussionCommentPayload @preview(toggledBy: "echo-preview")
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
- """
- Delete a branch protection rule
- """
- deleteBranchProtectionRule(input: DeleteBranchProtectionRuleInput!): DeleteBranchProtectionRulePayload
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
- """
- Deletes an Issue object.
- """
- deleteIssue(input: DeleteIssueInput!): DeleteIssuePayload
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): UserConnection!
"""
- Deletes an IssueComment object.
+ List of project cards associated with this issue.
"""
- deleteIssueComment(input: DeleteIssueCommentInput!): DeleteIssueCommentPayload
+ projectCards(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
- """
- Deletes a label.
- """
- deleteLabel(input: DeleteLabelInput!): DeleteLabelPayload @preview(toggledBy: "bane-preview")
+ """
+ A list of archived states to filter the cards by
+ """
+ archivedStates: [ProjectCardArchivedState] = [ARCHIVED, NOT_ARCHIVED]
- """
- Deletes a project.
- """
- deleteProject(input: DeleteProjectInput!): DeleteProjectPayload
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): ProjectCardConnection!
"""
- Deletes a project card.
+ Identifies when the comment was published at.
"""
- deleteProjectCard(input: DeleteProjectCardInput!): DeleteProjectCardPayload
+ publishedAt: DateTime
"""
- Deletes a project column.
+ A list of reactions grouped by content left on the subject.
"""
- deleteProjectColumn(input: DeleteProjectColumnInput!): DeleteProjectColumnPayload
+ reactionGroups: [ReactionGroup!]
"""
- Deletes a pull request review.
+ A list of Reactions left on the Issue.
"""
- deletePullRequestReview(input: DeletePullRequestReviewInput!): DeletePullRequestReviewPayload
+ reactions(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Allows filtering Reactions by emoji.
+ """
+ content: ReactionContent
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Allows specifying the order in which reactions are returned.
+ """
+ orderBy: ReactionOrder
+ ): ReactionConnection!
"""
- Deletes a pull request review comment.
+ The repository associated with this node.
"""
- deletePullRequestReviewComment(input: DeletePullRequestReviewCommentInput!): DeletePullRequestReviewCommentPayload
+ repository: Repository!
"""
- Delete a Git Ref.
+ The HTTP path for this issue
"""
- deleteRef(input: DeleteRefInput!): DeleteRefPayload
+ resourcePath: URI!
"""
- Deletes a team discussion.
+ Identifies the state of the issue.
"""
- deleteTeamDiscussion(input: DeleteTeamDiscussionInput!): DeleteTeamDiscussionPayload @preview(toggledBy: "echo-preview")
+ state: IssueState!
"""
- Deletes a team discussion comment.
+ A list of events, comments, commits, etc. associated with the issue.
"""
- deleteTeamDiscussionComment(input: DeleteTeamDiscussionCommentInput!): DeleteTeamDiscussionCommentPayload @preview(toggledBy: "echo-preview")
+ timeline(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Allows filtering timeline events by a `since` timestamp.
+ """
+ since: DateTime
+ ): IssueTimelineConnection! @deprecated(reason: "`timeline` will be removed Use Issue.timelineItems instead. Removal on 2020-10-01 UTC.")
"""
- Dismisses an approved or rejected pull request review.
+ A list of events, comments, commits, etc. associated with the issue.
"""
- dismissPullRequestReview(input: DismissPullRequestReviewInput!): DismissPullRequestReviewPayload
+ timelineItems(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Filter timeline items by type.
+ """
+ itemTypes: [IssueTimelineItemsItemType!]
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Filter timeline items by a `since` timestamp.
+ """
+ since: DateTime
+
+ """
+ Skips the first _n_ elements in the list.
+ """
+ skip: Int
+ ): IssueTimelineItemsConnection!
"""
- Creates a new project by importing columns and a list of issues/PRs.
+ Identifies the issue title.
"""
- importProject(input: ImportProjectInput!): ImportProjectPayload @preview(toggledBy: "slothette-preview")
+ title: String!
"""
- Lock a lockable object
+ Identifies the date and time when the object was last updated.
"""
- lockLockable(input: LockLockableInput!): LockLockablePayload
+ updatedAt: DateTime!
"""
- Marks a pull request ready for review.
+ The HTTP URL for this issue
"""
- markPullRequestReadyForReview(input: MarkPullRequestReadyForReviewInput!): MarkPullRequestReadyForReviewPayload @preview(toggledBy: "shadow-cat-preview")
+ url: URI!
"""
- Merge a head into a branch.
+ A list of edits to this content.
"""
- mergeBranch(input: MergeBranchInput!): MergeBranchPayload
+ userContentEdits(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): UserContentEditConnection
"""
- Merge a pull request.
+ Can user react to this subject
"""
- mergePullRequest(input: MergePullRequestInput!): MergePullRequestPayload
+ viewerCanReact: Boolean!
"""
- Minimizes a comment on an Issue, Commit, Pull Request, or Gist
+ Check if the viewer is able to change their subscription status for the repository.
"""
- minimizeComment(input: MinimizeCommentInput!): MinimizeCommentPayload @preview(toggledBy: "queen-beryl-preview")
+ viewerCanSubscribe: Boolean!
"""
- Moves a project card to another place.
+ Check if the current viewer can update this object.
"""
- moveProjectCard(input: MoveProjectCardInput!): MoveProjectCardPayload
+ viewerCanUpdate: Boolean!
"""
- Moves a project column to another place.
+ Reasons why the current viewer can not update this comment.
"""
- moveProjectColumn(input: MoveProjectColumnInput!): MoveProjectColumnPayload
+ viewerCannotUpdateReasons: [CommentCannotUpdateReason!]!
"""
- Pin an issue to a repository
+ Did the viewer author this comment.
"""
- pinIssue(input: PinIssueInput!): PinIssuePayload @preview(toggledBy: "elektra-preview")
+ viewerDidAuthor: Boolean!
"""
- Removes assignees from an assignable object.
+ Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
"""
- removeAssigneesFromAssignable(input: RemoveAssigneesFromAssignableInput!): RemoveAssigneesFromAssignablePayload
+ viewerSubscription: SubscriptionState
+}
+"""
+Represents a comment on an Issue.
+"""
+type IssueComment implements Comment & Deletable & Minimizable & Node & Reactable & RepositoryNode & Updatable & UpdatableComment {
"""
- Removes labels from a Labelable object.
+ The actor who authored the comment.
"""
- removeLabelsFromLabelable(input: RemoveLabelsFromLabelableInput!): RemoveLabelsFromLabelablePayload
+ author: Actor
"""
- Removes outside collaborator from all repositories in an organization.
+ Author's association with the subject of the comment.
"""
- removeOutsideCollaborator(input: RemoveOutsideCollaboratorInput!): RemoveOutsideCollaboratorPayload
+ authorAssociation: CommentAuthorAssociation!
"""
- Removes a reaction from a subject.
+ The body as Markdown.
"""
- removeReaction(input: RemoveReactionInput!): RemoveReactionPayload
+ body: String!
"""
- Removes a star from a Starrable.
+ The body rendered to HTML.
"""
- removeStar(input: RemoveStarInput!): RemoveStarPayload
+ bodyHTML: HTML!
"""
- Reopen a issue.
+ The body rendered to text.
"""
- reopenIssue(input: ReopenIssueInput!): ReopenIssuePayload
+ bodyText: String!
"""
- Reopen a pull request.
+ Identifies the date and time when the object was created.
"""
- reopenPullRequest(input: ReopenPullRequestInput!): ReopenPullRequestPayload
+ createdAt: DateTime!
"""
- Set review requests on a pull request.
+ Check if this comment was created via an email reply.
"""
- requestReviews(input: RequestReviewsInput!): RequestReviewsPayload
+ createdViaEmail: Boolean!
"""
- Rerequests an existing check suite.
+ Identifies the primary key from the database.
"""
- rerequestCheckSuite(input: RerequestCheckSuiteInput!): RerequestCheckSuitePayload @preview(toggledBy: "antiope-preview")
+ databaseId: Int
"""
- Marks a review thread as resolved.
+ The actor who edited the comment.
"""
- resolveReviewThread(input: ResolveReviewThreadInput!): ResolveReviewThreadPayload
+ editor: Actor
+ id: ID!
"""
- Submits a pending pull request review.
+ Check if this comment was edited and includes an edit with the creation data
"""
- submitPullRequestReview(input: SubmitPullRequestReviewInput!): SubmitPullRequestReviewPayload
+ includesCreatedEdit: Boolean!
"""
- Unlock a lockable object
+ Returns whether or not a comment has been minimized.
"""
- unlockLockable(input: UnlockLockableInput!): UnlockLockablePayload
+ isMinimized: Boolean!
"""
- Unmark an issue as a duplicate of another issue.
+ Identifies the issue associated with the comment.
"""
- unmarkIssueAsDuplicate(input: UnmarkIssueAsDuplicateInput!): UnmarkIssueAsDuplicatePayload
+ issue: Issue!
"""
- Unminimizes a comment on an Issue, Commit, Pull Request, or Gist
+ The moment the editor made the last edit
"""
- unminimizeComment(input: UnminimizeCommentInput!): UnminimizeCommentPayload @preview(toggledBy: "queen-beryl-preview")
+ lastEditedAt: DateTime
"""
- Unpin a pinned issue from a repository
+ Returns why the comment was minimized.
"""
- unpinIssue(input: UnpinIssueInput!): UnpinIssuePayload @preview(toggledBy: "elektra-preview")
+ minimizedReason: String
"""
- Marks a review thread as unresolved.
+ Identifies when the comment was published at.
"""
- unresolveReviewThread(input: UnresolveReviewThreadInput!): UnresolveReviewThreadPayload
+ publishedAt: DateTime
"""
- Create a new branch protection rule
+ Returns the pull request associated with the comment, if this comment was made on a
+ pull request.
"""
- updateBranchProtectionRule(input: UpdateBranchProtectionRuleInput!): UpdateBranchProtectionRulePayload
+ pullRequest: PullRequest
"""
- Update a check run
+ A list of reactions grouped by content left on the subject.
"""
- updateCheckRun(input: UpdateCheckRunInput!): UpdateCheckRunPayload @preview(toggledBy: "antiope-preview")
+ reactionGroups: [ReactionGroup!]
"""
- Modifies the settings of an existing check suite
+ A list of Reactions left on the Issue.
"""
- updateCheckSuitePreferences(input: UpdateCheckSuitePreferencesInput!): UpdateCheckSuitePreferencesPayload @preview(toggledBy: "antiope-preview")
+ reactions(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Allows filtering Reactions by emoji.
+ """
+ content: ReactionContent
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Allows specifying the order in which reactions are returned.
+ """
+ orderBy: ReactionOrder
+ ): ReactionConnection!
"""
- Updates an Issue.
+ The repository associated with this node.
"""
- updateIssue(input: UpdateIssueInput!): UpdateIssuePayload
+ repository: Repository!
"""
- Updates an IssueComment object.
+ The HTTP path for this issue comment
"""
- updateIssueComment(input: UpdateIssueCommentInput!): UpdateIssueCommentPayload
+ resourcePath: URI!
"""
- Updates an existing label.
+ Identifies the date and time when the object was last updated.
"""
- updateLabel(input: UpdateLabelInput!): UpdateLabelPayload @preview(toggledBy: "bane-preview")
+ updatedAt: DateTime!
"""
- Updates an existing project.
+ The HTTP URL for this issue comment
"""
- updateProject(input: UpdateProjectInput!): UpdateProjectPayload
+ url: URI!
"""
- Updates an existing project card.
+ A list of edits to this content.
"""
- updateProjectCard(input: UpdateProjectCardInput!): UpdateProjectCardPayload
+ userContentEdits(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): UserContentEditConnection
"""
- Updates an existing project column.
+ Check if the current viewer can delete this object.
"""
- updateProjectColumn(input: UpdateProjectColumnInput!): UpdateProjectColumnPayload
+ viewerCanDelete: Boolean!
"""
- Update a pull request
+ Check if the current viewer can minimize this object.
"""
- updatePullRequest(input: UpdatePullRequestInput!): UpdatePullRequestPayload
+ viewerCanMinimize: Boolean!
"""
- Updates the body of a pull request review.
+ Can user react to this subject
"""
- updatePullRequestReview(input: UpdatePullRequestReviewInput!): UpdatePullRequestReviewPayload
+ viewerCanReact: Boolean!
"""
- Updates a pull request review comment.
+ Check if the current viewer can update this object.
"""
- updatePullRequestReviewComment(input: UpdatePullRequestReviewCommentInput!): UpdatePullRequestReviewCommentPayload
+ viewerCanUpdate: Boolean!
"""
- Update a Git Ref.
+ Reasons why the current viewer can not update this comment.
"""
- updateRef(input: UpdateRefInput!): UpdateRefPayload
+ viewerCannotUpdateReasons: [CommentCannotUpdateReason!]!
"""
- Update information about a repository.
+ Did the viewer author this comment.
"""
- updateRepository(input: UpdateRepositoryInput!): UpdateRepositoryPayload
+ viewerDidAuthor: Boolean!
+}
+"""
+The connection type for IssueComment.
+"""
+type IssueCommentConnection {
"""
- Updates the state for subscribable subjects.
+ A list of edges.
"""
- updateSubscription(input: UpdateSubscriptionInput!): UpdateSubscriptionPayload
+ edges: [IssueCommentEdge]
"""
- Updates a team discussion.
+ A list of nodes.
"""
- updateTeamDiscussion(input: UpdateTeamDiscussionInput!): UpdateTeamDiscussionPayload @preview(toggledBy: "echo-preview")
+ nodes: [IssueComment]
"""
- Updates a discussion comment.
+ Information to aid in pagination.
"""
- updateTeamDiscussionComment(input: UpdateTeamDiscussionCommentInput!): UpdateTeamDiscussionCommentPayload @preview(toggledBy: "echo-preview")
+ pageInfo: PageInfo!
"""
- Replaces the repository's topics with the given topics.
+ Identifies the total count of items in the connection.
"""
- updateTopics(input: UpdateTopicsInput!): UpdateTopicsPayload
+ totalCount: Int!
}
"""
-An object with an ID.
+An edge in a connection.
"""
-interface Node {
+type IssueCommentEdge {
"""
- ID of the object.
+ A cursor for use in pagination.
"""
- id: ID!
+ cursor: String!
+
+ """
+ The item at the end of the edge.
+ """
+ node: IssueComment
}
"""
-Metadata for an audit entry with action oauth_application.*
+The connection type for Issue.
"""
-interface OauthApplicationAuditEntryData @preview(toggledBy: "audit-log-preview") {
+type IssueConnection {
"""
- The name of the OAuth Application.
+ A list of edges.
"""
- oauthApplicationName: String
+ edges: [IssueEdge]
"""
- The HTTP path for the OAuth Application
+ A list of nodes.
"""
- oauthApplicationResourcePath: URI
+ nodes: [Issue]
"""
- The HTTP URL for the OAuth Application
+ Information to aid in pagination.
"""
- oauthApplicationUrl: URI
+ pageInfo: PageInfo!
+
+ """
+ Identifies the total count of items in the connection.
+ """
+ totalCount: Int!
}
"""
-Audit log entry for a oauth_application.create event.
+This aggregates issues opened by a user within one repository.
"""
-type OauthApplicationCreateAuditEntry implements AuditEntry & Node & OauthApplicationAuditEntryData & OrganizationAuditEntryData @preview(toggledBy: "audit-log-preview") {
+type IssueContributionsByRepository {
"""
- The action name
+ The issue contributions.
"""
- action: String!
+ contributions(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
- """
- The user who initiated the action
- """
- actor: AuditEntryActor
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
- """
- The IP address of the actor
- """
- actorIp: String
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
- """
- A readable representation of the actor's location
- """
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Ordering options for contributions returned from the connection.
+ """
+ orderBy: ContributionOrder = {direction: DESC}
+ ): CreatedIssueContributionConnection!
"""
- The username of the user who initiated the action
+ The repository in which the issues were opened.
"""
- actorLogin: String
+ repository: Repository!
+}
+"""
+An edge in a connection.
+"""
+type IssueEdge {
"""
- The HTTP path for the actor.
+ A cursor for use in pagination.
"""
- actorResourcePath: URI
+ cursor: String!
"""
- The HTTP URL for the actor.
+ The item at the end of the edge.
"""
- actorUrl: URI
+ node: Issue
+}
+"""
+Ways in which to filter lists of issues.
+"""
+input IssueFilters {
"""
- The application URL of the OAuth Application.
+ List issues assigned to given name. Pass in `null` for issues with no assigned
+ user, and `*` for issues assigned to any user.
"""
- applicationUrl: URI
+ assignee: String
"""
- The callback URL of the OAuth Application.
+ List issues created by given name.
"""
- callbackUrl: URI
+ createdBy: String
"""
- The time the action was initiated
+ List issues where the list of label names exist on the issue.
"""
- createdAt: PreciseDateTime!
- id: ID!
+ labels: [String!]
"""
- The name of the OAuth Application.
+ List issues where the given name is mentioned in the issue.
"""
- oauthApplicationName: String
+ mentioned: String
"""
- The HTTP path for the OAuth Application
+ List issues by given milestone argument. If an string representation of an
+ integer is passed, it should refer to a milestone by its number field. Pass in
+ `null` for issues with no milestone, and `*` for issues that are assigned to any milestone.
"""
- oauthApplicationResourcePath: URI
+ milestone: String
"""
- The HTTP URL for the OAuth Application
+ List issues that have been updated at or after the given date.
"""
- oauthApplicationUrl: URI
+ since: DateTime
"""
- The Organization associated with the Audit Entry.
+ List issues filtered by the list of states given.
"""
- organization: Organization
+ states: [IssueState!]
"""
- The name of the Organization.
+ List issues subscribed to by viewer.
"""
- organizationName: String
+ viewerSubscribed: Boolean = false
+}
- """
- The HTTP path for the organization
- """
- organizationResourcePath: URI
+"""
+Used for return value of Repository.issueOrPullRequest.
+"""
+union IssueOrPullRequest = Issue | PullRequest
+"""
+Ways in which lists of issues can be ordered upon return.
+"""
+input IssueOrder {
"""
- The HTTP URL for the organization
+ The direction in which to order issues by the specified field.
"""
- organizationUrl: URI
+ direction: OrderDirection!
"""
- The rate limit of the OAuth Application.
+ The field in which to order issues by.
"""
- rateLimit: Int
+ field: IssueOrderField!
+}
+"""
+Properties by which issue connections can be ordered.
+"""
+enum IssueOrderField {
"""
- The state of the OAuth Application.
+ Order issues by comment count
"""
- state: OauthApplicationCreateAuditEntryState
+ COMMENTS
"""
- The user affected by the action
+ Order issues by creation time
"""
- user: User
+ CREATED_AT
"""
- For actions involving two users, the actor is the initiator and the user is the affected user.
+ Order issues by update time
"""
- userLogin: String
+ UPDATED_AT
+}
+"""
+The possible states of an issue.
+"""
+enum IssueState {
"""
- The HTTP path for the user.
+ An issue that has been closed
"""
- userResourcePath: URI
+ CLOSED
"""
- The HTTP URL for the user.
+ An issue that is still open
"""
- userUrl: URI
+ OPEN
}
"""
-The state of an OAuth Application when it was created.
+A repository issue template.
"""
-enum OauthApplicationCreateAuditEntryState @preview(toggledBy: "audit-log-preview") {
- """
- The OAuth Application was active and allowed to have OAuth Accesses.
+type IssueTemplate {
"""
- ACTIVE
-
- """
- The OAuth Application was in the process of being deleted.
+ The template purpose.
"""
- PENDING_DELETION
+ about: String
"""
- The OAuth Application was suspended from generating OAuth Accesses due to abuse or security concerns.
+ The suggested issue body.
"""
- SUSPENDED
-}
+ body: String
-"""
-Possible directions in which to order a list of items when provided an `orderBy` argument.
-"""
-enum OrderDirection {
"""
- Specifies an ascending order for a given `orderBy` argument.
+ The template name.
"""
- ASC
+ name: String!
"""
- Specifies a descending order for a given `orderBy` argument.
+ The suggested issue title.
"""
- DESC
+ title: String
}
"""
-Audit log entry for a org.add_billing_manager
+The connection type for IssueTimelineItem.
"""
-type OrgAddBillingManagerAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData @preview(toggledBy: "audit-log-preview") {
+type IssueTimelineConnection {
"""
- The action name
+ A list of edges.
"""
- action: String!
+ edges: [IssueTimelineItemEdge]
"""
- The user who initiated the action
+ A list of nodes.
"""
- actor: AuditEntryActor
+ nodes: [IssueTimelineItem]
"""
- The IP address of the actor
+ Information to aid in pagination.
"""
- actorIp: String
+ pageInfo: PageInfo!
"""
- A readable representation of the actor's location
+ Identifies the total count of items in the connection.
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ totalCount: Int!
+}
- """
- The username of the user who initiated the action
- """
- actorLogin: String
+"""
+An item in an issue timeline
+"""
+union IssueTimelineItem = AssignedEvent | ClosedEvent | Commit | CrossReferencedEvent | DemilestonedEvent | IssueComment | LabeledEvent | LockedEvent | MilestonedEvent | ReferencedEvent | RenamedTitleEvent | ReopenedEvent | SubscribedEvent | TransferredEvent | UnassignedEvent | UnlabeledEvent | UnlockedEvent | UnsubscribedEvent | UserBlockedEvent
+"""
+An edge in a connection.
+"""
+type IssueTimelineItemEdge {
"""
- The HTTP path for the actor.
+ A cursor for use in pagination.
"""
- actorResourcePath: URI
+ cursor: String!
"""
- The HTTP URL for the actor.
+ The item at the end of the edge.
"""
- actorUrl: URI
+ node: IssueTimelineItem
+}
- """
- The time the action was initiated
- """
- createdAt: PreciseDateTime!
- id: ID!
+"""
+An item in an issue timeline
+"""
+union IssueTimelineItems = AddedToProjectEvent | AssignedEvent | ClosedEvent | CommentDeletedEvent | ConnectedEvent | ConvertedNoteToIssueEvent | CrossReferencedEvent | DemilestonedEvent | DisconnectedEvent | IssueComment | LabeledEvent | LockedEvent | MarkedAsDuplicateEvent | MentionedEvent | MilestonedEvent | MovedColumnsInProjectEvent | PinnedEvent | ReferencedEvent | RemovedFromProjectEvent | RenamedTitleEvent | ReopenedEvent | SubscribedEvent | TransferredEvent | UnassignedEvent | UnlabeledEvent | UnlockedEvent | UnmarkedAsDuplicateEvent | UnpinnedEvent | UnsubscribedEvent | UserBlockedEvent
+"""
+The connection type for IssueTimelineItems.
+"""
+type IssueTimelineItemsConnection {
"""
- The email address used to invite a billing manager for the organization.
+ A list of edges.
"""
- invitationEmail: String
+ edges: [IssueTimelineItemsEdge]
"""
- The Organization associated with the Audit Entry.
+ Identifies the count of items after applying `before` and `after` filters.
"""
- organization: Organization
+ filteredCount: Int!
"""
- The name of the Organization.
+ A list of nodes.
"""
- organizationName: String
+ nodes: [IssueTimelineItems]
"""
- The HTTP path for the organization
+ Identifies the count of items after applying `before`/`after` filters and `first`/`last`/`skip` slicing.
"""
- organizationResourcePath: URI
+ pageCount: Int!
"""
- The HTTP URL for the organization
+ Information to aid in pagination.
"""
- organizationUrl: URI
+ pageInfo: PageInfo!
"""
- The user affected by the action
+ Identifies the total count of items in the connection.
"""
- user: User
+ totalCount: Int!
"""
- For actions involving two users, the actor is the initiator and the user is the affected user.
+ Identifies the date and time when the timeline was last updated.
"""
- userLogin: String
+ updatedAt: DateTime!
+}
+"""
+An edge in a connection.
+"""
+type IssueTimelineItemsEdge {
"""
- The HTTP path for the user.
+ A cursor for use in pagination.
"""
- userResourcePath: URI
+ cursor: String!
"""
- The HTTP URL for the user.
+ The item at the end of the edge.
"""
- userUrl: URI
+ node: IssueTimelineItems
}
"""
-Audit log entry for a org.add_member
+The possible item types found in a timeline.
"""
-type OrgAddMemberAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData @preview(toggledBy: "audit-log-preview") {
+enum IssueTimelineItemsItemType {
"""
- The action name
+ Represents a 'added_to_project' event on a given issue or pull request.
"""
- action: String!
+ ADDED_TO_PROJECT_EVENT
"""
- The user who initiated the action
+ Represents an 'assigned' event on any assignable object.
"""
- actor: AuditEntryActor
+ ASSIGNED_EVENT
"""
- The IP address of the actor
+ Represents a 'closed' event on any `Closable`.
"""
- actorIp: String
+ CLOSED_EVENT
"""
- A readable representation of the actor's location
+ Represents a 'comment_deleted' event on a given issue or pull request.
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ COMMENT_DELETED_EVENT
"""
- The username of the user who initiated the action
+ Represents a 'connected' event on a given issue or pull request.
"""
- actorLogin: String
+ CONNECTED_EVENT
"""
- The HTTP path for the actor.
+ Represents a 'converted_note_to_issue' event on a given issue or pull request.
"""
- actorResourcePath: URI
+ CONVERTED_NOTE_TO_ISSUE_EVENT
"""
- The HTTP URL for the actor.
+ Represents a mention made by one issue or pull request to another.
"""
- actorUrl: URI
+ CROSS_REFERENCED_EVENT
"""
- The time the action was initiated
+ Represents a 'demilestoned' event on a given issue or pull request.
"""
- createdAt: PreciseDateTime!
- id: ID!
+ DEMILESTONED_EVENT
"""
- The Organization associated with the Audit Entry.
+ Represents a 'disconnected' event on a given issue or pull request.
"""
- organization: Organization
+ DISCONNECTED_EVENT
"""
- The name of the Organization.
+ Represents a comment on an Issue.
"""
- organizationName: String
+ ISSUE_COMMENT
"""
- The HTTP path for the organization
+ Represents a 'labeled' event on a given issue or pull request.
"""
- organizationResourcePath: URI
+ LABELED_EVENT
"""
- The HTTP URL for the organization
+ Represents a 'locked' event on a given issue or pull request.
"""
- organizationUrl: URI
+ LOCKED_EVENT
"""
- The permission level of the member added to the organization.
+ Represents a 'marked_as_duplicate' event on a given issue or pull request.
"""
- permission: OrgAddMemberAuditEntryPermission
+ MARKED_AS_DUPLICATE_EVENT
"""
- The user affected by the action
+ Represents a 'mentioned' event on a given issue or pull request.
"""
- user: User
+ MENTIONED_EVENT
"""
- For actions involving two users, the actor is the initiator and the user is the affected user.
+ Represents a 'milestoned' event on a given issue or pull request.
"""
- userLogin: String
+ MILESTONED_EVENT
"""
- The HTTP path for the user.
+ Represents a 'moved_columns_in_project' event on a given issue or pull request.
"""
- userResourcePath: URI
+ MOVED_COLUMNS_IN_PROJECT_EVENT
"""
- The HTTP URL for the user.
+ Represents a 'pinned' event on a given issue or pull request.
"""
- userUrl: URI
-}
+ PINNED_EVENT
-"""
-The permissions available to members on an Organization.
-"""
-enum OrgAddMemberAuditEntryPermission @preview(toggledBy: "audit-log-preview") {
"""
- Can read, clone, push, and add collaborators to repositories.
+ Represents a 'referenced' event on a given `ReferencedSubject`.
"""
- ADMIN
+ REFERENCED_EVENT
"""
- Can read and clone repositories.
+ Represents a 'removed_from_project' event on a given issue or pull request.
"""
- READ
-}
+ REMOVED_FROM_PROJECT_EVENT
-"""
-Audit log entry for a org.block_user
-"""
-type OrgBlockUserAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData @preview(toggledBy: "audit-log-preview") {
"""
- The action name
+ Represents a 'renamed' event on a given issue or pull request
"""
- action: String!
+ RENAMED_TITLE_EVENT
"""
- The user who initiated the action
+ Represents a 'reopened' event on any `Closable`.
"""
- actor: AuditEntryActor
+ REOPENED_EVENT
"""
- The IP address of the actor
+ Represents a 'subscribed' event on a given `Subscribable`.
"""
- actorIp: String
+ SUBSCRIBED_EVENT
"""
- A readable representation of the actor's location
+ Represents a 'transferred' event on a given issue or pull request.
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ TRANSFERRED_EVENT
"""
- The username of the user who initiated the action
+ Represents an 'unassigned' event on any assignable object.
"""
- actorLogin: String
+ UNASSIGNED_EVENT
"""
- The HTTP path for the actor.
+ Represents an 'unlabeled' event on a given issue or pull request.
"""
- actorResourcePath: URI
+ UNLABELED_EVENT
"""
- The HTTP URL for the actor.
+ Represents an 'unlocked' event on a given issue or pull request.
"""
- actorUrl: URI
+ UNLOCKED_EVENT
"""
- The blocked user.
+ Represents an 'unmarked_as_duplicate' event on a given issue or pull request.
"""
- blockedUser: User
+ UNMARKED_AS_DUPLICATE_EVENT
"""
- The username of the blocked user.
+ Represents an 'unpinned' event on a given issue or pull request.
"""
- blockedUserName: String
+ UNPINNED_EVENT
"""
- The HTTP path for the blocked user.
+ Represents an 'unsubscribed' event on a given `Subscribable`.
"""
- blockedUserResourcePath: URI
+ UNSUBSCRIBED_EVENT
"""
- The HTTP URL for the blocked user.
+ Represents a 'user_blocked' event on a given user.
"""
- blockedUserUrl: URI
+ USER_BLOCKED_EVENT
+}
+"""
+Represents a user signing up for a GitHub account.
+"""
+type JoinedGitHubContribution implements Contribution {
"""
- The time the action was initiated
+ Whether this contribution is associated with a record you do not have access to. For
+ example, your own 'first issue' contribution may have been made on a repository you can no
+ longer access.
"""
- createdAt: PreciseDateTime!
- id: ID!
+ isRestricted: Boolean!
"""
- The Organization associated with the Audit Entry.
+ When this contribution was made.
"""
- organization: Organization
+ occurredAt: DateTime!
"""
- The name of the Organization.
+ The HTTP path for this contribution.
"""
- organizationName: String
+ resourcePath: URI!
"""
- The HTTP path for the organization
+ The HTTP URL for this contribution.
"""
- organizationResourcePath: URI
+ url: URI!
"""
- The HTTP URL for the organization
+ The user who made this contribution.
"""
- organizationUrl: URI
+ user: User!
+}
+"""
+A label for categorizing Issues or Milestones with a given Repository.
+"""
+type Label implements Node {
"""
- The user affected by the action
+ Identifies the label color.
"""
- user: User
+ color: String!
"""
- For actions involving two users, the actor is the initiator and the user is the affected user.
+ Identifies the date and time when the label was created.
"""
- userLogin: String
+ createdAt: DateTime
"""
- The HTTP path for the user.
+ A brief description of this label.
"""
- userResourcePath: URI
+ description: String
+ id: ID!
"""
- The HTTP URL for the user.
+ Indicates whether or not this is a default label.
"""
- userUrl: URI
-}
+ isDefault: Boolean!
-"""
-Audit log entry for a org.config.disable_collaborators_only event.
-"""
-type OrgConfigDisableCollaboratorsOnlyAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData @preview(toggledBy: "audit-log-preview") {
"""
- The action name
+ A list of issues associated with this label.
"""
- action: String!
+ issues(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
- """
- The user who initiated the action
- """
- actor: AuditEntryActor
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
- """
- The IP address of the actor
- """
- actorIp: String
+ """
+ Filtering options for issues returned from the connection.
+ """
+ filterBy: IssueFilters
- """
- A readable representation of the actor's location
- """
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ A list of label names to filter the pull requests by.
+ """
+ labels: [String!]
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Ordering options for issues returned from the connection.
+ """
+ orderBy: IssueOrder
+
+ """
+ A list of states to filter the issues by.
+ """
+ states: [IssueState!]
+ ): IssueConnection!
"""
- The username of the user who initiated the action
+ Identifies the label name.
"""
- actorLogin: String
+ name: String!
"""
- The HTTP path for the actor.
+ A list of pull requests associated with this label.
"""
- actorResourcePath: URI
+ pullRequests(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ The base ref name to filter the pull requests by.
+ """
+ baseRefName: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ The head ref name to filter the pull requests by.
+ """
+ headRefName: String
+
+ """
+ A list of label names to filter the pull requests by.
+ """
+ labels: [String!]
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Ordering options for pull requests returned from the connection.
+ """
+ orderBy: IssueOrder
+
+ """
+ A list of states to filter the pull requests by.
+ """
+ states: [PullRequestState!]
+ ): PullRequestConnection!
"""
- The HTTP URL for the actor.
+ The repository associated with this label.
"""
- actorUrl: URI
+ repository: Repository!
"""
- The time the action was initiated
+ The HTTP path for this label.
"""
- createdAt: PreciseDateTime!
- id: ID!
+ resourcePath: URI!
"""
- The Organization associated with the Audit Entry.
+ Identifies the date and time when the label was last updated.
"""
- organization: Organization
+ updatedAt: DateTime
"""
- The name of the Organization.
+ The HTTP URL for this label.
"""
- organizationName: String
+ url: URI!
+}
+"""
+The connection type for Label.
+"""
+type LabelConnection {
"""
- The HTTP path for the organization
+ A list of edges.
"""
- organizationResourcePath: URI
+ edges: [LabelEdge]
"""
- The HTTP URL for the organization
+ A list of nodes.
"""
- organizationUrl: URI
+ nodes: [Label]
"""
- The user affected by the action
+ Information to aid in pagination.
"""
- user: User
+ pageInfo: PageInfo!
"""
- For actions involving two users, the actor is the initiator and the user is the affected user.
+ Identifies the total count of items in the connection.
"""
- userLogin: String
+ totalCount: Int!
+}
+"""
+An edge in a connection.
+"""
+type LabelEdge {
"""
- The HTTP path for the user.
+ A cursor for use in pagination.
"""
- userResourcePath: URI
+ cursor: String!
"""
- The HTTP URL for the user.
+ The item at the end of the edge.
"""
- userUrl: URI
+ node: Label
}
"""
-Audit log entry for a org.config.enable_collaborators_only event.
+Ways in which lists of labels can be ordered upon return.
"""
-type OrgConfigEnableCollaboratorsOnlyAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData @preview(toggledBy: "audit-log-preview") {
+input LabelOrder {
"""
- The action name
+ The direction in which to order labels by the specified field.
"""
- action: String!
+ direction: OrderDirection!
"""
- The user who initiated the action
+ The field in which to order labels by.
"""
- actor: AuditEntryActor
+ field: LabelOrderField!
+}
+"""
+Properties by which label connections can be ordered.
+"""
+enum LabelOrderField {
"""
- The IP address of the actor
+ Order labels by creation time
"""
- actorIp: String
+ CREATED_AT
"""
- A readable representation of the actor's location
+ Order labels by name
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ NAME
+}
+"""
+An object that can have labels assigned to it.
+"""
+interface Labelable {
"""
- The username of the user who initiated the action
+ A list of labels associated with the object.
"""
- actorLogin: String
+ labels(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Ordering options for labels returned from the connection.
+ """
+ orderBy: LabelOrder = {field: CREATED_AT, direction: ASC}
+ ): LabelConnection
+}
+"""
+Represents a 'labeled' event on a given issue or pull request.
+"""
+type LabeledEvent implements Node {
"""
- The HTTP path for the actor.
+ Identifies the actor who performed the event.
"""
- actorResourcePath: URI
+ actor: Actor
"""
- The HTTP URL for the actor.
+ Identifies the date and time when the object was created.
"""
- actorUrl: URI
+ createdAt: DateTime!
+ id: ID!
"""
- The time the action was initiated
+ Identifies the label associated with the 'labeled' event.
"""
- createdAt: PreciseDateTime!
- id: ID!
+ label: Label!
"""
- The Organization associated with the Audit Entry.
+ Identifies the `Labelable` associated with the event.
"""
- organization: Organization
+ labelable: Labelable!
+}
+"""
+Represents a given language found in repositories.
+"""
+type Language implements Node {
"""
- The name of the Organization.
+ The color defined for the current language.
"""
- organizationName: String
+ color: String
+ id: ID!
"""
- The HTTP path for the organization
+ The name of the current language.
"""
- organizationResourcePath: URI
+ name: String!
+}
+"""
+A list of languages associated with the parent.
+"""
+type LanguageConnection {
"""
- The HTTP URL for the organization
+ A list of edges.
"""
- organizationUrl: URI
+ edges: [LanguageEdge]
"""
- The user affected by the action
+ A list of nodes.
"""
- user: User
+ nodes: [Language]
"""
- For actions involving two users, the actor is the initiator and the user is the affected user.
+ Information to aid in pagination.
"""
- userLogin: String
+ pageInfo: PageInfo!
"""
- The HTTP path for the user.
+ Identifies the total count of items in the connection.
"""
- userResourcePath: URI
+ totalCount: Int!
"""
- The HTTP URL for the user.
+ The total size in bytes of files written in that language.
"""
- userUrl: URI
+ totalSize: Int!
}
"""
-Audit log entry for a org.disable_oauth_app_restrictions event.
+Represents the language of a repository.
"""
-type OrgDisableOauthAppRestrictionsAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData @preview(toggledBy: "audit-log-preview") {
- """
- The action name
- """
- action: String!
+type LanguageEdge {
+ cursor: String!
+ node: Language!
"""
- The user who initiated the action
+ The number of bytes of code written in the language.
"""
- actor: AuditEntryActor
+ size: Int!
+}
+"""
+Ordering options for language connections.
+"""
+input LanguageOrder {
"""
- The IP address of the actor
+ The ordering direction.
"""
- actorIp: String
+ direction: OrderDirection!
"""
- A readable representation of the actor's location
+ The field to order languages by.
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ field: LanguageOrderField!
+}
+"""
+Properties by which language connections can be ordered.
+"""
+enum LanguageOrderField {
"""
- The username of the user who initiated the action
+ Order languages by the size of all files containing the language
"""
- actorLogin: String
+ SIZE
+}
+"""
+A repository's open source license
+"""
+type License implements Node {
"""
- The HTTP path for the actor.
+ The full text of the license
"""
- actorResourcePath: URI
+ body: String!
"""
- The HTTP URL for the actor.
+ The conditions set by the license
"""
- actorUrl: URI
+ conditions: [LicenseRule]!
"""
- The time the action was initiated
+ A human-readable description of the license
"""
- createdAt: PreciseDateTime!
- id: ID!
+ description: String
"""
- The Organization associated with the Audit Entry.
+ Whether the license should be featured
"""
- organization: Organization
+ featured: Boolean!
"""
- The name of the Organization.
+ Whether the license should be displayed in license pickers
"""
- organizationName: String
+ hidden: Boolean!
+ id: ID!
"""
- The HTTP path for the organization
+ Instructions on how to implement the license
"""
- organizationResourcePath: URI
+ implementation: String
"""
- The HTTP URL for the organization
+ The lowercased SPDX ID of the license
"""
- organizationUrl: URI
+ key: String!
"""
- The user affected by the action
+ The limitations set by the license
"""
- user: User
+ limitations: [LicenseRule]!
"""
- For actions involving two users, the actor is the initiator and the user is the affected user.
+ The license full name specified by
"""
- userLogin: String
+ name: String!
"""
- The HTTP path for the user.
+ Customary short name if applicable (e.g, GPLv3)
"""
- userResourcePath: URI
+ nickname: String
"""
- The HTTP URL for the user.
+ The permissions set by the license
"""
- userUrl: URI
-}
+ permissions: [LicenseRule]!
-"""
-Audit log entry for a org.disable_saml event.
-"""
-type OrgDisableSamlAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData @preview(toggledBy: "audit-log-preview") {
"""
- The action name
+ Whether the license is a pseudo-license placeholder (e.g., other, no-license)
"""
- action: String!
+ pseudoLicense: Boolean!
"""
- The user who initiated the action
+ Short identifier specified by
"""
- actor: AuditEntryActor
+ spdxId: String
"""
- The IP address of the actor
+ URL to the license on
"""
- actorIp: String
+ url: URI
+}
+"""
+Describes a License's conditions, permissions, and limitations
+"""
+type LicenseRule {
"""
- A readable representation of the actor's location
+ A description of the rule
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ description: String!
"""
- The username of the user who initiated the action
+ The machine-readable rule key
"""
- actorLogin: String
+ key: String!
"""
- The HTTP path for the actor.
+ The human-readable rule label
"""
- actorResourcePath: URI
+ label: String!
+}
+"""
+Autogenerated input type of LinkRepositoryToProject
+"""
+input LinkRepositoryToProjectInput {
"""
- The HTTP URL for the actor.
+ A unique identifier for the client performing the mutation.
"""
- actorUrl: URI
+ clientMutationId: String
"""
- The time the action was initiated
+ The ID of the Project to link to a Repository
"""
- createdAt: PreciseDateTime!
+ projectId: ID! @possibleTypes(concreteTypes: ["Project"])
"""
- The SAML provider's digest algorithm URL.
+ The ID of the Repository to link to a Project.
"""
- digestMethodUrl: URI
- id: ID!
+ repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
+}
+"""
+Autogenerated return type of LinkRepositoryToProject
+"""
+type LinkRepositoryToProjectPayload {
"""
- The SAML provider's issuer URL.
+ A unique identifier for the client performing the mutation.
"""
- issuerUrl: URI
+ clientMutationId: String
"""
- The Organization associated with the Audit Entry.
+ The linked Project.
"""
- organization: Organization
+ project: Project
"""
- The name of the Organization.
+ The linked Repository.
"""
- organizationName: String
+ repository: Repository
+}
+"""
+Autogenerated input type of LockLockable
+"""
+input LockLockableInput {
"""
- The HTTP path for the organization
+ A unique identifier for the client performing the mutation.
"""
- organizationResourcePath: URI
+ clientMutationId: String
"""
- The HTTP URL for the organization
+ A reason for why the issue or pull request will be locked.
"""
- organizationUrl: URI
+ lockReason: LockReason
"""
- The SAML provider's signature algorithm URL.
+ ID of the issue or pull request to be locked.
"""
- signatureMethodUrl: URI
+ lockableId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "Lockable")
+}
+"""
+Autogenerated return type of LockLockable
+"""
+type LockLockablePayload {
"""
- The SAML provider's single sign-on URL.
+ Identifies the actor who performed the event.
"""
- singleSignOnUrl: URI
+ actor: Actor
"""
- The user affected by the action
+ A unique identifier for the client performing the mutation.
"""
- user: User
+ clientMutationId: String
"""
- For actions involving two users, the actor is the initiator and the user is the affected user.
+ The item that was locked.
"""
- userLogin: String
+ lockedRecord: Lockable
+}
+"""
+The possible reasons that an issue or pull request was locked.
+"""
+enum LockReason {
"""
- The HTTP path for the user.
+ The issue or pull request was locked because the conversation was off-topic.
"""
- userResourcePath: URI
+ OFF_TOPIC
"""
- The HTTP URL for the user.
+ The issue or pull request was locked because the conversation was resolved.
"""
- userUrl: URI
-}
+ RESOLVED
-"""
-Audit log entry for a org.disable_two_factor_requirement event.
-"""
-type OrgDisableTwoFactorRequirementAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData @preview(toggledBy: "audit-log-preview") {
"""
- The action name
+ The issue or pull request was locked because the conversation was spam.
"""
- action: String!
+ SPAM
"""
- The user who initiated the action
+ The issue or pull request was locked because the conversation was too heated.
"""
- actor: AuditEntryActor
+ TOO_HEATED
+}
+"""
+An object that can be locked.
+"""
+interface Lockable {
"""
- The IP address of the actor
+ Reason that the conversation was locked.
"""
- actorIp: String
+ activeLockReason: LockReason
"""
- A readable representation of the actor's location
+ `true` if the object is locked
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ locked: Boolean!
+}
+"""
+Represents a 'locked' event on a given issue or pull request.
+"""
+type LockedEvent implements Node {
"""
- The username of the user who initiated the action
+ Identifies the actor who performed the event.
"""
- actorLogin: String
+ actor: Actor
"""
- The HTTP path for the actor.
+ Identifies the date and time when the object was created.
"""
- actorResourcePath: URI
+ createdAt: DateTime!
+ id: ID!
"""
- The HTTP URL for the actor.
+ Reason that the conversation was locked (optional).
"""
- actorUrl: URI
+ lockReason: LockReason
"""
- The time the action was initiated
+ Object that was locked.
"""
- createdAt: PreciseDateTime!
- id: ID!
+ lockable: Lockable!
+}
+"""
+A placeholder user for attribution of imported data on GitHub.
+"""
+type Mannequin implements Actor & Node & UniformResourceLocatable {
"""
- The Organization associated with the Audit Entry.
+ A URL pointing to the GitHub App's public avatar.
"""
- organization: Organization
+ avatarUrl(
+ """
+ The size of the resulting square image.
+ """
+ size: Int
+ ): URI!
"""
- The name of the Organization.
+ Identifies the date and time when the object was created.
"""
- organizationName: String
+ createdAt: DateTime!
"""
- The HTTP path for the organization
+ Identifies the primary key from the database.
"""
- organizationResourcePath: URI
+ databaseId: Int
"""
- The HTTP URL for the organization
+ The mannequin's email on the source instance.
"""
- organizationUrl: URI
+ email: String
+ id: ID!
"""
- The user affected by the action
+ The username of the actor.
"""
- user: User
+ login: String!
"""
- For actions involving two users, the actor is the initiator and the user is the affected user.
+ The HTML path to this resource.
"""
- userLogin: String
+ resourcePath: URI!
"""
- The HTTP path for the user.
+ Identifies the date and time when the object was last updated.
"""
- userResourcePath: URI
+ updatedAt: DateTime!
"""
- The HTTP URL for the user.
+ The URL to this resource.
"""
- userUrl: URI
+ url: URI!
}
"""
-Audit log entry for a org.enable_oauth_app_restrictions event.
+Autogenerated input type of MarkFileAsViewed
"""
-type OrgEnableOauthAppRestrictionsAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData @preview(toggledBy: "audit-log-preview") {
+input MarkFileAsViewedInput {
"""
- The action name
+ A unique identifier for the client performing the mutation.
"""
- action: String!
+ clientMutationId: String
"""
- The user who initiated the action
+ The path of the file to mark as viewed
"""
- actor: AuditEntryActor
+ path: String!
"""
- The IP address of the actor
+ The Node ID of the pull request.
"""
- actorIp: String
+ pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"])
+}
+"""
+Autogenerated return type of MarkFileAsViewed
+"""
+type MarkFileAsViewedPayload {
"""
- A readable representation of the actor's location
+ A unique identifier for the client performing the mutation.
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ clientMutationId: String
"""
- The username of the user who initiated the action
+ The updated pull request.
"""
- actorLogin: String
+ pullRequest: PullRequest
+}
+"""
+Autogenerated input type of MarkPullRequestReadyForReview
+"""
+input MarkPullRequestReadyForReviewInput {
"""
- The HTTP path for the actor.
+ A unique identifier for the client performing the mutation.
"""
- actorResourcePath: URI
+ clientMutationId: String
"""
- The HTTP URL for the actor.
+ ID of the pull request to be marked as ready for review.
"""
- actorUrl: URI
+ pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"])
+}
+"""
+Autogenerated return type of MarkPullRequestReadyForReview
+"""
+type MarkPullRequestReadyForReviewPayload {
"""
- The time the action was initiated
+ A unique identifier for the client performing the mutation.
"""
- createdAt: PreciseDateTime!
- id: ID!
+ clientMutationId: String
"""
- The Organization associated with the Audit Entry.
+ The pull request that is ready for review.
"""
- organization: Organization
+ pullRequest: PullRequest
+}
+"""
+Represents a 'marked_as_duplicate' event on a given issue or pull request.
+"""
+type MarkedAsDuplicateEvent implements Node {
"""
- The name of the Organization.
+ Identifies the actor who performed the event.
"""
- organizationName: String
+ actor: Actor
"""
- The HTTP path for the organization
+ The authoritative issue or pull request which has been duplicated by another.
"""
- organizationResourcePath: URI
+ canonical: IssueOrPullRequest
"""
- The HTTP URL for the organization
+ Identifies the date and time when the object was created.
"""
- organizationUrl: URI
+ createdAt: DateTime!
"""
- The user affected by the action
+ The issue or pull request which has been marked as a duplicate of another.
"""
- user: User
+ duplicate: IssueOrPullRequest
+ id: ID!
"""
- For actions involving two users, the actor is the initiator and the user is the affected user.
+ Canonical and duplicate belong to different repositories.
"""
- userLogin: String
+ isCrossRepository: Boolean!
+}
+"""
+Entities that have members who can set status messages.
+"""
+interface MemberStatusable {
"""
- The HTTP path for the user.
+ Get the status messages members of this entity have set that are either public or visible only to the organization.
"""
- userResourcePath: URI
+ memberStatuses(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
- """
- The HTTP URL for the user.
- """
- userUrl: URI
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Ordering options for user statuses returned from the connection.
+ """
+ orderBy: UserStatusOrder = {field: UPDATED_AT, direction: DESC}
+ ): UserStatusConnection!
}
"""
-Audit log entry for a org.enable_saml event.
+Audit log entry for a members_can_delete_repos.clear event.
"""
-type OrgEnableSamlAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData @preview(toggledBy: "audit-log-preview") {
+type MembersCanDeleteReposClearAuditEntry implements AuditEntry & EnterpriseAuditEntryData & Node & OrganizationAuditEntryData {
"""
The action name
"""
@@ -11556,7 +12734,7 @@ type OrgEnableSamlAuditEntry implements AuditEntry & Node & OrganizationAuditEnt
"""
A readable representation of the actor's location
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ actorLocation: ActorLocation
"""
The username of the user who initiated the action
@@ -11579,15 +12757,25 @@ type OrgEnableSamlAuditEntry implements AuditEntry & Node & OrganizationAuditEnt
createdAt: PreciseDateTime!
"""
- The SAML provider's digest algorithm URL.
+ The HTTP path for this enterprise.
"""
- digestMethodUrl: URI
+ enterpriseResourcePath: URI
+
+ """
+ The slug of the enterprise.
+ """
+ enterpriseSlug: String
+
+ """
+ The HTTP URL for this enterprise.
+ """
+ enterpriseUrl: URI
id: ID!
"""
- The SAML provider's issuer URL.
+ The corresponding operation type for the action
"""
- issuerUrl: URI
+ operationType: OperationType
"""
The Organization associated with the Audit Entry.
@@ -11609,16 +12797,6 @@ type OrgEnableSamlAuditEntry implements AuditEntry & Node & OrganizationAuditEnt
"""
organizationUrl: URI
- """
- The SAML provider's signature algorithm URL.
- """
- signatureMethodUrl: URI
-
- """
- The SAML provider's single sign-on URL.
- """
- singleSignOnUrl: URI
-
"""
The user affected by the action
"""
@@ -11641,9 +12819,9 @@ type OrgEnableSamlAuditEntry implements AuditEntry & Node & OrganizationAuditEnt
}
"""
-Audit log entry for a org.enable_two_factor_requirement event.
+Audit log entry for a members_can_delete_repos.disable event.
"""
-type OrgEnableTwoFactorRequirementAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData @preview(toggledBy: "audit-log-preview") {
+type MembersCanDeleteReposDisableAuditEntry implements AuditEntry & EnterpriseAuditEntryData & Node & OrganizationAuditEntryData {
"""
The action name
"""
@@ -11662,7 +12840,7 @@ type OrgEnableTwoFactorRequirementAuditEntry implements AuditEntry & Node & Orga
"""
A readable representation of the actor's location
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ actorLocation: ActorLocation
"""
The username of the user who initiated the action
@@ -11683,10 +12861,30 @@ type OrgEnableTwoFactorRequirementAuditEntry implements AuditEntry & Node & Orga
The time the action was initiated
"""
createdAt: PreciseDateTime!
- id: ID!
"""
- The Organization associated with the Audit Entry.
+ The HTTP path for this enterprise.
+ """
+ enterpriseResourcePath: URI
+
+ """
+ The slug of the enterprise.
+ """
+ enterpriseSlug: String
+
+ """
+ The HTTP URL for this enterprise.
+ """
+ enterpriseUrl: URI
+ id: ID!
+
+ """
+ The corresponding operation type for the action
+ """
+ operationType: OperationType
+
+ """
+ The Organization associated with the Audit Entry.
"""
organization: Organization
@@ -11727,9 +12925,9 @@ type OrgEnableTwoFactorRequirementAuditEntry implements AuditEntry & Node & Orga
}
"""
-Audit log entry for a org.invite_member event.
+Audit log entry for a members_can_delete_repos.enable event.
"""
-type OrgInviteMemberAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData @preview(toggledBy: "audit-log-preview") {
+type MembersCanDeleteReposEnableAuditEntry implements AuditEntry & EnterpriseAuditEntryData & Node & OrganizationAuditEntryData {
"""
The action name
"""
@@ -11748,7 +12946,7 @@ type OrgInviteMemberAuditEntry implements AuditEntry & Node & OrganizationAuditE
"""
A readable representation of the actor's location
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ actorLocation: ActorLocation
"""
The username of the user who initiated the action
@@ -11771,20 +12969,30 @@ type OrgInviteMemberAuditEntry implements AuditEntry & Node & OrganizationAuditE
createdAt: PreciseDateTime!
"""
- The email address of the organization invitation.
+ The HTTP path for this enterprise.
"""
- email: String
+ enterpriseResourcePath: URI
+
+ """
+ The slug of the enterprise.
+ """
+ enterpriseSlug: String
+
+ """
+ The HTTP URL for this enterprise.
+ """
+ enterpriseUrl: URI
id: ID!
"""
- The Organization associated with the Audit Entry.
+ The corresponding operation type for the action
"""
- organization: Organization
+ operationType: OperationType
"""
- The organization invitation.
+ The Organization associated with the Audit Entry.
"""
- organizationInvitation: OrganizationInvitation
+ organization: Organization
"""
The name of the Organization.
@@ -11823,1238 +13031,1366 @@ type OrgInviteMemberAuditEntry implements AuditEntry & Node & OrganizationAuditE
}
"""
-Audit log entry for a org.invite_to_business event.
+Represents a 'mentioned' event on a given issue or pull request.
"""
-type OrgInviteToBusinessAuditEntry implements AuditEntry & EnterpriseAuditEntryData & Node & OrganizationAuditEntryData @preview(toggledBy: "audit-log-preview") {
+type MentionedEvent implements Node {
"""
- The action name
+ Identifies the actor who performed the event.
"""
- action: String!
+ actor: Actor
"""
- The user who initiated the action
+ Identifies the date and time when the object was created.
"""
- actor: AuditEntryActor
+ createdAt: DateTime!
"""
- The IP address of the actor
+ Identifies the primary key from the database.
"""
- actorIp: String
+ databaseId: Int
+ id: ID!
+}
+"""
+Autogenerated input type of MergeBranch
+"""
+input MergeBranchInput {
"""
- A readable representation of the actor's location
+ The name of the base branch that the provided head will be merged into.
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ base: String!
"""
- The username of the user who initiated the action
+ A unique identifier for the client performing the mutation.
"""
- actorLogin: String
+ clientMutationId: String
"""
- The HTTP path for the actor.
+ Message to use for the merge commit. If omitted, a default will be used.
"""
- actorResourcePath: URI
+ commitMessage: String
"""
- The HTTP URL for the actor.
+ The head to merge into the base branch. This can be a branch name or a commit GitObjectID.
"""
- actorUrl: URI
+ head: String!
"""
- The time the action was initiated
+ The Node ID of the Repository containing the base branch that will be modified.
"""
- createdAt: PreciseDateTime!
+ repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
+}
+"""
+Autogenerated return type of MergeBranch
+"""
+type MergeBranchPayload {
"""
- The HTTP path for this enterprise.
+ A unique identifier for the client performing the mutation.
"""
- enterpriseResourcePath: URI
+ clientMutationId: String
"""
- The slug of the enterprise.
+ The resulting merge Commit.
"""
- enterpriseSlug: String
+ mergeCommit: Commit
+}
+"""
+Autogenerated input type of MergePullRequest
+"""
+input MergePullRequestInput {
"""
- The HTTP URL for this enterprise.
+ The email address to associate with this merge.
"""
- enterpriseUrl: URI
- id: ID!
+ authorEmail: String
"""
- The Organization associated with the Audit Entry.
+ A unique identifier for the client performing the mutation.
"""
- organization: Organization
+ clientMutationId: String
"""
- The name of the Organization.
+ Commit body to use for the merge commit; if omitted, a default message will be used
"""
- organizationName: String
+ commitBody: String
"""
- The HTTP path for the organization
+ Commit headline to use for the merge commit; if omitted, a default message will be used.
"""
- organizationResourcePath: URI
+ commitHeadline: String
"""
- The HTTP URL for the organization
+ OID that the pull request head ref must match to allow merge; if omitted, no check is performed.
"""
- organizationUrl: URI
+ expectedHeadOid: GitObjectID
"""
- The user affected by the action
+ The merge method to use. If omitted, defaults to 'MERGE'
"""
- user: User
+ mergeMethod: PullRequestMergeMethod = MERGE
"""
- For actions involving two users, the actor is the initiator and the user is the affected user.
+ ID of the pull request to be merged.
"""
- userLogin: String
+ pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"])
+}
+
+"""
+Autogenerated return type of MergePullRequest
+"""
+type MergePullRequestPayload {
+ """
+ Identifies the actor who performed the event.
+ """
+ actor: Actor
"""
- The HTTP path for the user.
+ A unique identifier for the client performing the mutation.
"""
- userResourcePath: URI
+ clientMutationId: String
"""
- The HTTP URL for the user.
+ The pull request that was merged.
"""
- userUrl: URI
+ pullRequest: PullRequest
}
"""
-Audit log entry for a org.oauth_app_access_approved event.
+Detailed status information about a pull request merge.
"""
-type OrgOauthAppAccessApprovedAuditEntry implements AuditEntry & Node & OauthApplicationAuditEntryData & OrganizationAuditEntryData @preview(toggledBy: "audit-log-preview") {
+enum MergeStateStatus {
"""
- The action name
+ The head ref is out of date.
"""
- action: String!
+ BEHIND
"""
- The user who initiated the action
+ The merge is blocked.
"""
- actor: AuditEntryActor
+ BLOCKED
"""
- The IP address of the actor
+ Mergeable and passing commit status.
"""
- actorIp: String
+ CLEAN
"""
- A readable representation of the actor's location
+ The merge commit cannot be cleanly created.
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ DIRTY
"""
- The username of the user who initiated the action
+ The merge is blocked due to the pull request being a draft.
"""
- actorLogin: String
+ DRAFT @deprecated(reason: "DRAFT state will be removed from this enum and `isDraft` should be used instead Use PullRequest.isDraft instead. Removal on 2021-01-01 UTC.")
"""
- The HTTP path for the actor.
+ Mergeable with passing commit status and pre-receive hooks.
"""
- actorResourcePath: URI
+ HAS_HOOKS
"""
- The HTTP URL for the actor.
+ The state cannot currently be determined.
"""
- actorUrl: URI
+ UNKNOWN
"""
- The time the action was initiated
+ Mergeable with non-passing commit status.
"""
- createdAt: PreciseDateTime!
- id: ID!
+ UNSTABLE
+}
+"""
+Whether or not a PullRequest can be merged.
+"""
+enum MergeableState {
"""
- The name of the OAuth Application.
+ The pull request cannot be merged due to merge conflicts.
"""
- oauthApplicationName: String
+ CONFLICTING
"""
- The HTTP path for the OAuth Application
+ The pull request can be merged.
"""
- oauthApplicationResourcePath: URI
+ MERGEABLE
"""
- The HTTP URL for the OAuth Application
+ The mergeability of the pull request is still being calculated.
"""
- oauthApplicationUrl: URI
+ UNKNOWN
+}
+"""
+Represents a 'merged' event on a given pull request.
+"""
+type MergedEvent implements Node & UniformResourceLocatable {
"""
- The Organization associated with the Audit Entry.
+ Identifies the actor who performed the event.
"""
- organization: Organization
+ actor: Actor
"""
- The name of the Organization.
+ Identifies the commit associated with the `merge` event.
"""
- organizationName: String
+ commit: Commit
"""
- The HTTP path for the organization
+ Identifies the date and time when the object was created.
"""
- organizationResourcePath: URI
+ createdAt: DateTime!
+ id: ID!
"""
- The HTTP URL for the organization
+ Identifies the Ref associated with the `merge` event.
"""
- organizationUrl: URI
+ mergeRef: Ref
"""
- The user affected by the action
+ Identifies the name of the Ref associated with the `merge` event.
"""
- user: User
+ mergeRefName: String!
"""
- For actions involving two users, the actor is the initiator and the user is the affected user.
+ PullRequest referenced by event.
"""
- userLogin: String
+ pullRequest: PullRequest!
"""
- The HTTP path for the user.
+ The HTTP path for this merged event.
"""
- userResourcePath: URI
+ resourcePath: URI!
"""
- The HTTP URL for the user.
+ The HTTP URL for this merged event.
"""
- userUrl: URI
+ url: URI!
}
"""
-Audit log entry for a org.oauth_app_access_denied event.
+Represents a Milestone object on a given repository.
"""
-type OrgOauthAppAccessDeniedAuditEntry implements AuditEntry & Node & OauthApplicationAuditEntryData & OrganizationAuditEntryData @preview(toggledBy: "audit-log-preview") {
+type Milestone implements Closable & Node & UniformResourceLocatable {
"""
- The action name
+ `true` if the object is closed (definition of closed may depend on type)
"""
- action: String!
+ closed: Boolean!
"""
- The user who initiated the action
+ Identifies the date and time when the object was closed.
"""
- actor: AuditEntryActor
+ closedAt: DateTime
"""
- The IP address of the actor
+ Identifies the date and time when the object was created.
"""
- actorIp: String
+ createdAt: DateTime!
"""
- A readable representation of the actor's location
+ Identifies the actor who created the milestone.
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ creator: Actor
"""
- The username of the user who initiated the action
+ Identifies the description of the milestone.
"""
- actorLogin: String
+ description: String
"""
- The HTTP path for the actor.
+ Identifies the due date of the milestone.
"""
- actorResourcePath: URI
+ dueOn: DateTime
+ id: ID!
"""
- The HTTP URL for the actor.
+ A list of issues associated with the milestone.
"""
- actorUrl: URI
+ issues(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
- """
- The time the action was initiated
- """
- createdAt: PreciseDateTime!
- id: ID!
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
- """
- The name of the OAuth Application.
- """
- oauthApplicationName: String
+ """
+ Filtering options for issues returned from the connection.
+ """
+ filterBy: IssueFilters
- """
- The HTTP path for the OAuth Application
- """
- oauthApplicationResourcePath: URI
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ A list of label names to filter the pull requests by.
+ """
+ labels: [String!]
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Ordering options for issues returned from the connection.
+ """
+ orderBy: IssueOrder
+
+ """
+ A list of states to filter the issues by.
+ """
+ states: [IssueState!]
+ ): IssueConnection!
"""
- The HTTP URL for the OAuth Application
+ Identifies the number of the milestone.
"""
- oauthApplicationUrl: URI
+ number: Int!
"""
- The Organization associated with the Audit Entry.
+ Indentifies the percentage complete for the milestone
"""
- organization: Organization
+ progressPercentage: Float!
"""
- The name of the Organization.
+ A list of pull requests associated with the milestone.
"""
- organizationName: String
+ pullRequests(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ The base ref name to filter the pull requests by.
+ """
+ baseRefName: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ The head ref name to filter the pull requests by.
+ """
+ headRefName: String
+
+ """
+ A list of label names to filter the pull requests by.
+ """
+ labels: [String!]
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Ordering options for pull requests returned from the connection.
+ """
+ orderBy: IssueOrder
+
+ """
+ A list of states to filter the pull requests by.
+ """
+ states: [PullRequestState!]
+ ): PullRequestConnection!
"""
- The HTTP path for the organization
+ The repository associated with this milestone.
"""
- organizationResourcePath: URI
+ repository: Repository!
"""
- The HTTP URL for the organization
+ The HTTP path for this milestone
"""
- organizationUrl: URI
+ resourcePath: URI!
"""
- The user affected by the action
+ Identifies the state of the milestone.
"""
- user: User
+ state: MilestoneState!
"""
- For actions involving two users, the actor is the initiator and the user is the affected user.
+ Identifies the title of the milestone.
"""
- userLogin: String
+ title: String!
"""
- The HTTP path for the user.
+ Identifies the date and time when the object was last updated.
"""
- userResourcePath: URI
+ updatedAt: DateTime!
"""
- The HTTP URL for the user.
+ The HTTP URL for this milestone
"""
- userUrl: URI
+ url: URI!
}
"""
-Audit log entry for a org.oauth_app_access_requested event.
+The connection type for Milestone.
"""
-type OrgOauthAppAccessRequestedAuditEntry implements AuditEntry & Node & OauthApplicationAuditEntryData & OrganizationAuditEntryData @preview(toggledBy: "audit-log-preview") {
+type MilestoneConnection {
"""
- The action name
+ A list of edges.
"""
- action: String!
+ edges: [MilestoneEdge]
"""
- The user who initiated the action
+ A list of nodes.
"""
- actor: AuditEntryActor
+ nodes: [Milestone]
"""
- The IP address of the actor
+ Information to aid in pagination.
"""
- actorIp: String
+ pageInfo: PageInfo!
"""
- A readable representation of the actor's location
+ Identifies the total count of items in the connection.
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ totalCount: Int!
+}
+"""
+An edge in a connection.
+"""
+type MilestoneEdge {
"""
- The username of the user who initiated the action
+ A cursor for use in pagination.
"""
- actorLogin: String
+ cursor: String!
"""
- The HTTP path for the actor.
+ The item at the end of the edge.
"""
- actorResourcePath: URI
+ node: Milestone
+}
- """
- The HTTP URL for the actor.
- """
- actorUrl: URI
+"""
+Types that can be inside a Milestone.
+"""
+union MilestoneItem = Issue | PullRequest
+"""
+Ordering options for milestone connections.
+"""
+input MilestoneOrder {
"""
- The time the action was initiated
+ The ordering direction.
"""
- createdAt: PreciseDateTime!
- id: ID!
+ direction: OrderDirection!
"""
- The name of the OAuth Application.
+ The field to order milestones by.
"""
- oauthApplicationName: String
+ field: MilestoneOrderField!
+}
+"""
+Properties by which milestone connections can be ordered.
+"""
+enum MilestoneOrderField {
"""
- The HTTP path for the OAuth Application
+ Order milestones by when they were created.
"""
- oauthApplicationResourcePath: URI
+ CREATED_AT
"""
- The HTTP URL for the OAuth Application
+ Order milestones by when they are due.
"""
- oauthApplicationUrl: URI
+ DUE_DATE
"""
- The Organization associated with the Audit Entry.
+ Order milestones by their number.
"""
- organization: Organization
+ NUMBER
"""
- The name of the Organization.
+ Order milestones by when they were last updated.
"""
- organizationName: String
+ UPDATED_AT
+}
+"""
+The possible states of a milestone.
+"""
+enum MilestoneState {
"""
- The HTTP path for the organization
+ A milestone that has been closed.
"""
- organizationResourcePath: URI
+ CLOSED
"""
- The HTTP URL for the organization
+ A milestone that is still open.
"""
- organizationUrl: URI
+ OPEN
+}
+"""
+Represents a 'milestoned' event on a given issue or pull request.
+"""
+type MilestonedEvent implements Node {
"""
- The user affected by the action
+ Identifies the actor who performed the event.
"""
- user: User
+ actor: Actor
"""
- For actions involving two users, the actor is the initiator and the user is the affected user.
+ Identifies the date and time when the object was created.
"""
- userLogin: String
+ createdAt: DateTime!
+ id: ID!
"""
- The HTTP path for the user.
+ Identifies the milestone title associated with the 'milestoned' event.
"""
- userResourcePath: URI
+ milestoneTitle: String!
"""
- The HTTP URL for the user.
+ Object referenced by event.
"""
- userUrl: URI
+ subject: MilestoneItem!
}
"""
-Audit log entry for a org.remove_billing_manager event.
+Entities that can be minimized.
"""
-type OrgRemoveBillingManagerAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData @preview(toggledBy: "audit-log-preview") {
+interface Minimizable {
"""
- The action name
+ Returns whether or not a comment has been minimized.
"""
- action: String!
+ isMinimized: Boolean!
"""
- The user who initiated the action
+ Returns why the comment was minimized.
"""
- actor: AuditEntryActor
+ minimizedReason: String
"""
- The IP address of the actor
+ Check if the current viewer can minimize this object.
"""
- actorIp: String
+ viewerCanMinimize: Boolean!
+}
+"""
+Autogenerated input type of MinimizeComment
+"""
+input MinimizeCommentInput {
"""
- A readable representation of the actor's location
+ The classification of comment
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ classifier: ReportedContentClassifiers!
"""
- The username of the user who initiated the action
+ A unique identifier for the client performing the mutation.
"""
- actorLogin: String
+ clientMutationId: String
"""
- The HTTP path for the actor.
+ The Node ID of the subject to modify.
"""
- actorResourcePath: URI
+ subjectId: ID! @possibleTypes(concreteTypes: ["CommitComment", "GistComment", "IssueComment", "PullRequestReviewComment"], abstractType: "Minimizable")
+}
+"""
+Autogenerated return type of MinimizeComment
+"""
+type MinimizeCommentPayload {
"""
- The HTTP URL for the actor.
+ A unique identifier for the client performing the mutation.
"""
- actorUrl: URI
+ clientMutationId: String
"""
- The time the action was initiated
+ The comment that was minimized.
"""
- createdAt: PreciseDateTime!
- id: ID!
+ minimizedComment: Minimizable
+}
+"""
+Autogenerated input type of MoveProjectCard
+"""
+input MoveProjectCardInput {
"""
- The Organization associated with the Audit Entry.
+ Place the new card after the card with this id. Pass null to place it at the top.
"""
- organization: Organization
+ afterCardId: ID @possibleTypes(concreteTypes: ["ProjectCard"])
"""
- The name of the Organization.
+ The id of the card to move.
"""
- organizationName: String
+ cardId: ID! @possibleTypes(concreteTypes: ["ProjectCard"])
"""
- The HTTP path for the organization
+ A unique identifier for the client performing the mutation.
"""
- organizationResourcePath: URI
+ clientMutationId: String
"""
- The HTTP URL for the organization
+ The id of the column to move it into.
"""
- organizationUrl: URI
+ columnId: ID! @possibleTypes(concreteTypes: ["ProjectColumn"])
+}
+"""
+Autogenerated return type of MoveProjectCard
+"""
+type MoveProjectCardPayload {
"""
- The reason for the billing manager being removed.
+ The new edge of the moved card.
"""
- reason: OrgRemoveBillingManagerAuditEntryReason
+ cardEdge: ProjectCardEdge
"""
- The user affected by the action
+ A unique identifier for the client performing the mutation.
"""
- user: User
+ clientMutationId: String
+}
+"""
+Autogenerated input type of MoveProjectColumn
+"""
+input MoveProjectColumnInput {
"""
- For actions involving two users, the actor is the initiator and the user is the affected user.
+ Place the new column after the column with this id. Pass null to place it at the front.
"""
- userLogin: String
+ afterColumnId: ID @possibleTypes(concreteTypes: ["ProjectColumn"])
"""
- The HTTP path for the user.
+ A unique identifier for the client performing the mutation.
"""
- userResourcePath: URI
+ clientMutationId: String
"""
- The HTTP URL for the user.
+ The id of the column to move.
"""
- userUrl: URI
+ columnId: ID! @possibleTypes(concreteTypes: ["ProjectColumn"])
}
"""
-The reason a billing manager was removed from an Organization.
+Autogenerated return type of MoveProjectColumn
"""
-enum OrgRemoveBillingManagerAuditEntryReason @preview(toggledBy: "audit-log-preview") {
- """
- SAML external identity missing
- """
- SAML_EXTERNAL_IDENTITY_MISSING
-
+type MoveProjectColumnPayload {
"""
- SAML SSO enforcement requires an external identity
+ A unique identifier for the client performing the mutation.
"""
- SAML_SSO_ENFORCEMENT_REQUIRES_EXTERNAL_IDENTITY
+ clientMutationId: String
"""
- The organization required 2FA of its billing managers and this user did not have 2FA enabled.
+ The new edge of the moved column.
"""
- TWO_FACTOR_REQUIREMENT_NON_COMPLIANCE
+ columnEdge: ProjectColumnEdge
}
"""
-Audit log entry for a org.remove_member event.
+Represents a 'moved_columns_in_project' event on a given issue or pull request.
"""
-type OrgRemoveMemberAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData @preview(toggledBy: "audit-log-preview") {
+type MovedColumnsInProjectEvent implements Node {
"""
- The action name
+ Identifies the actor who performed the event.
"""
- action: String!
+ actor: Actor
"""
- The user who initiated the action
+ Identifies the date and time when the object was created.
"""
- actor: AuditEntryActor
+ createdAt: DateTime!
"""
- The IP address of the actor
+ Identifies the primary key from the database.
"""
- actorIp: String
+ databaseId: Int
+ id: ID!
"""
- A readable representation of the actor's location
+ Column name the issue or pull request was moved from.
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ previousProjectColumnName: String! @preview(toggledBy: "starfox-preview")
"""
- The username of the user who initiated the action
+ Project referenced by event.
"""
- actorLogin: String
+ project: Project @preview(toggledBy: "starfox-preview")
"""
- The HTTP path for the actor.
+ Project card referenced by this project event.
"""
- actorResourcePath: URI
+ projectCard: ProjectCard @preview(toggledBy: "starfox-preview")
"""
- The HTTP URL for the actor.
+ Column name the issue or pull request was moved to.
"""
- actorUrl: URI
+ projectColumnName: String! @preview(toggledBy: "starfox-preview")
+}
+"""
+The root query for implementing GraphQL mutations.
+"""
+type Mutation {
"""
- The time the action was initiated
+ Adds assignees to an assignable object.
"""
- createdAt: PreciseDateTime!
- id: ID!
+ addAssigneesToAssignable(input: AddAssigneesToAssignableInput!): AddAssigneesToAssignablePayload
"""
- The types of membership the member has with the organization.
+ Adds a comment to an Issue or Pull Request.
"""
- membershipTypes: [OrgRemoveMemberAuditEntryMembershipType!]
+ addComment(input: AddCommentInput!): AddCommentPayload
"""
- The Organization associated with the Audit Entry.
+ Adds an administrator to the global enterprise account.
"""
- organization: Organization
+ addEnterpriseAdmin(input: AddEnterpriseAdminInput!): AddEnterpriseAdminPayload
"""
- The name of the Organization.
+ Adds labels to a labelable object.
"""
- organizationName: String
+ addLabelsToLabelable(input: AddLabelsToLabelableInput!): AddLabelsToLabelablePayload
"""
- The HTTP path for the organization
+ Adds a card to a ProjectColumn. Either `contentId` or `note` must be provided but **not** both.
"""
- organizationResourcePath: URI
+ addProjectCard(input: AddProjectCardInput!): AddProjectCardPayload
"""
- The HTTP URL for the organization
+ Adds a column to a Project.
"""
- organizationUrl: URI
+ addProjectColumn(input: AddProjectColumnInput!): AddProjectColumnPayload
"""
- The reason for the member being removed.
+ Adds a review to a Pull Request.
"""
- reason: OrgRemoveMemberAuditEntryReason
+ addPullRequestReview(input: AddPullRequestReviewInput!): AddPullRequestReviewPayload
"""
- The user affected by the action
+ Adds a comment to a review.
"""
- user: User
+ addPullRequestReviewComment(input: AddPullRequestReviewCommentInput!): AddPullRequestReviewCommentPayload
"""
- For actions involving two users, the actor is the initiator and the user is the affected user.
+ Adds a new thread to a pending Pull Request Review.
"""
- userLogin: String
+ addPullRequestReviewThread(input: AddPullRequestReviewThreadInput!): AddPullRequestReviewThreadPayload
"""
- The HTTP path for the user.
+ Adds a reaction to a subject.
"""
- userResourcePath: URI
+ addReaction(input: AddReactionInput!): AddReactionPayload
"""
- The HTTP URL for the user.
+ Adds a star to a Starrable.
"""
- userUrl: URI
-}
+ addStar(input: AddStarInput!): AddStarPayload
-"""
-The type of membership a user has with an Organization.
-"""
-enum OrgRemoveMemberAuditEntryMembershipType @preview(toggledBy: "audit-log-preview") {
"""
- Organization administrators have full access and can change several settings,
- including the names of repositories that belong to the Organization and Owners
- team membership. In addition, organization admins can delete the organization
- and all of its repositories.
+ Marks a repository as archived.
"""
- ADMIN
+ archiveRepository(input: ArchiveRepositoryInput!): ArchiveRepositoryPayload
"""
- A billing manager is a user who manages the billing settings for the Organization, such as updating payment information.
+ Update your status on GitHub.
"""
- BILLING_MANAGER
+ changeUserStatus(input: ChangeUserStatusInput!): ChangeUserStatusPayload
"""
- A direct member is a user that is a member of the Organization.
+ Clears all labels from a labelable object.
"""
- DIRECT_MEMBER
+ clearLabelsFromLabelable(input: ClearLabelsFromLabelableInput!): ClearLabelsFromLabelablePayload
"""
- An outside collaborator is a person who isn't explicitly a member of the
- Organization, but who has Read, Write, or Admin permissions to one or more
- repositories in the organization.
+ Creates a new project by cloning configuration from an existing project.
"""
- OUTSIDE_COLLABORATOR
+ cloneProject(input: CloneProjectInput!): CloneProjectPayload
"""
- An unaffiliated collaborator is a person who is not a member of the
- Organization and does not have access to any repositories in the Organization.
+ Create a new repository with the same files and directory structure as a template repository.
"""
- UNAFFILIATED
-}
+ cloneTemplateRepository(input: CloneTemplateRepositoryInput!): CloneTemplateRepositoryPayload
-"""
-The reason a member was removed from an Organization.
-"""
-enum OrgRemoveMemberAuditEntryReason @preview(toggledBy: "audit-log-preview") {
"""
- SAML external identity missing
+ Close an issue.
"""
- SAML_EXTERNAL_IDENTITY_MISSING
+ closeIssue(input: CloseIssueInput!): CloseIssuePayload
"""
- SAML SSO enforcement requires an external identity
+ Close a pull request.
"""
- SAML_SSO_ENFORCEMENT_REQUIRES_EXTERNAL_IDENTITY
+ closePullRequest(input: ClosePullRequestInput!): ClosePullRequestPayload
"""
- The organization required 2FA of its billing managers and this user did not have 2FA enabled.
+ Convert a project note card to one associated with a newly created issue.
"""
- TWO_FACTOR_REQUIREMENT_NON_COMPLIANCE
-}
+ convertProjectCardNoteToIssue(input: ConvertProjectCardNoteToIssueInput!): ConvertProjectCardNoteToIssuePayload
-"""
-Audit log entry for a org.remove_outside_collaborator event.
-"""
-type OrgRemoveOutsideCollaboratorAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData @preview(toggledBy: "audit-log-preview") {
"""
- The action name
+ Create a new branch protection rule
"""
- action: String!
+ createBranchProtectionRule(input: CreateBranchProtectionRuleInput!): CreateBranchProtectionRulePayload
"""
- The user who initiated the action
+ Create a check run.
"""
- actor: AuditEntryActor
+ createCheckRun(input: CreateCheckRunInput!): CreateCheckRunPayload
"""
- The IP address of the actor
+ Create a check suite
"""
- actorIp: String
+ createCheckSuite(input: CreateCheckSuiteInput!): CreateCheckSuitePayload
"""
- A readable representation of the actor's location
+ Create a content attachment.
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ createContentAttachment(input: CreateContentAttachmentInput!): CreateContentAttachmentPayload @preview(toggledBy: "corsair-preview")
"""
- The username of the user who initiated the action
+ Creates a new deployment event.
"""
- actorLogin: String
+ createDeployment(input: CreateDeploymentInput!): CreateDeploymentPayload @preview(toggledBy: "flash-preview")
"""
- The HTTP path for the actor.
+ Create a deployment status.
"""
- actorResourcePath: URI
+ createDeploymentStatus(input: CreateDeploymentStatusInput!): CreateDeploymentStatusPayload @preview(toggledBy: "flash-preview")
"""
- The HTTP URL for the actor.
+ Creates a new IP allow list entry.
"""
- actorUrl: URI
+ createIpAllowListEntry(input: CreateIpAllowListEntryInput!): CreateIpAllowListEntryPayload
"""
- The time the action was initiated
+ Creates a new issue.
"""
- createdAt: PreciseDateTime!
- id: ID!
+ createIssue(input: CreateIssueInput!): CreateIssuePayload
"""
- The types of membership the outside collaborator has with the organization.
+ Creates a new label.
"""
- membershipTypes: [OrgRemoveOutsideCollaboratorAuditEntryMembershipType!]
+ createLabel(input: CreateLabelInput!): CreateLabelPayload @preview(toggledBy: "bane-preview")
"""
- The Organization associated with the Audit Entry.
+ Creates a new project.
"""
- organization: Organization
+ createProject(input: CreateProjectInput!): CreateProjectPayload
"""
- The name of the Organization.
+ Create a new pull request
"""
- organizationName: String
+ createPullRequest(input: CreatePullRequestInput!): CreatePullRequestPayload
"""
- The HTTP path for the organization
+ Create a new Git Ref.
"""
- organizationResourcePath: URI
+ createRef(input: CreateRefInput!): CreateRefPayload
"""
- The HTTP URL for the organization
+ Create a new repository.
"""
- organizationUrl: URI
+ createRepository(input: CreateRepositoryInput!): CreateRepositoryPayload
"""
- The reason for the outside collaborator being removed from the Organization.
+ Creates a new team discussion.
"""
- reason: OrgRemoveOutsideCollaboratorAuditEntryReason
+ createTeamDiscussion(input: CreateTeamDiscussionInput!): CreateTeamDiscussionPayload
"""
- The user affected by the action
+ Creates a new team discussion comment.
"""
- user: User
+ createTeamDiscussionComment(input: CreateTeamDiscussionCommentInput!): CreateTeamDiscussionCommentPayload
"""
- For actions involving two users, the actor is the initiator and the user is the affected user.
+ Delete a branch protection rule
"""
- userLogin: String
+ deleteBranchProtectionRule(input: DeleteBranchProtectionRuleInput!): DeleteBranchProtectionRulePayload
"""
- The HTTP path for the user.
+ Deletes a deployment.
"""
- userResourcePath: URI
+ deleteDeployment(input: DeleteDeploymentInput!): DeleteDeploymentPayload
"""
- The HTTP URL for the user.
+ Deletes an IP allow list entry.
"""
- userUrl: URI
-}
+ deleteIpAllowListEntry(input: DeleteIpAllowListEntryInput!): DeleteIpAllowListEntryPayload
-"""
-The type of membership a user has with an Organization.
-"""
-enum OrgRemoveOutsideCollaboratorAuditEntryMembershipType @preview(toggledBy: "audit-log-preview") {
"""
- A billing manager is a user who manages the billing settings for the Organization, such as updating payment information.
+ Deletes an Issue object.
"""
- BILLING_MANAGER
+ deleteIssue(input: DeleteIssueInput!): DeleteIssuePayload
"""
- An outside collaborator is a person who isn't explicitly a member of the
- Organization, but who has Read, Write, or Admin permissions to one or more
- repositories in the organization.
+ Deletes an IssueComment object.
"""
- OUTSIDE_COLLABORATOR
+ deleteIssueComment(input: DeleteIssueCommentInput!): DeleteIssueCommentPayload
"""
- An unaffiliated collaborator is a person who is not a member of the
- Organization and does not have access to any repositories in the organization.
+ Deletes a label.
"""
- UNAFFILIATED
-}
+ deleteLabel(input: DeleteLabelInput!): DeleteLabelPayload @preview(toggledBy: "bane-preview")
-"""
-The reason an outside collaborator was removed from an Organization.
-"""
-enum OrgRemoveOutsideCollaboratorAuditEntryReason @preview(toggledBy: "audit-log-preview") {
"""
- SAML external identity missing
+ Deletes a project.
"""
- SAML_EXTERNAL_IDENTITY_MISSING
+ deleteProject(input: DeleteProjectInput!): DeleteProjectPayload
"""
- The organization required 2FA of its billing managers and this user did not have 2FA enabled.
+ Deletes a project card.
"""
- TWO_FACTOR_REQUIREMENT_NON_COMPLIANCE
-}
+ deleteProjectCard(input: DeleteProjectCardInput!): DeleteProjectCardPayload
-"""
-Audit log entry for a org.restore_member event.
-"""
-type OrgRestoreMemberAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData @preview(toggledBy: "audit-log-preview") {
"""
- The action name
+ Deletes a project column.
"""
- action: String!
+ deleteProjectColumn(input: DeleteProjectColumnInput!): DeleteProjectColumnPayload
"""
- The user who initiated the action
+ Deletes a pull request review.
"""
- actor: AuditEntryActor
+ deletePullRequestReview(input: DeletePullRequestReviewInput!): DeletePullRequestReviewPayload
"""
- The IP address of the actor
+ Deletes a pull request review comment.
"""
- actorIp: String
+ deletePullRequestReviewComment(input: DeletePullRequestReviewCommentInput!): DeletePullRequestReviewCommentPayload
"""
- A readable representation of the actor's location
+ Delete a Git Ref.
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ deleteRef(input: DeleteRefInput!): DeleteRefPayload
"""
- The username of the user who initiated the action
+ Deletes a team discussion.
"""
- actorLogin: String
+ deleteTeamDiscussion(input: DeleteTeamDiscussionInput!): DeleteTeamDiscussionPayload
"""
- The HTTP path for the actor.
+ Deletes a team discussion comment.
"""
- actorResourcePath: URI
+ deleteTeamDiscussionComment(input: DeleteTeamDiscussionCommentInput!): DeleteTeamDiscussionCommentPayload
"""
- The HTTP URL for the actor.
+ Dismisses an approved or rejected pull request review.
"""
- actorUrl: URI
+ dismissPullRequestReview(input: DismissPullRequestReviewInput!): DismissPullRequestReviewPayload
"""
- The time the action was initiated
+ Follow a user.
"""
- createdAt: PreciseDateTime!
- id: ID!
+ followUser(input: FollowUserInput!): FollowUserPayload
"""
- The Organization associated with the Audit Entry.
+ Creates a new project by importing columns and a list of issues/PRs.
"""
- organization: Organization
+ importProject(input: ImportProjectInput!): ImportProjectPayload @preview(toggledBy: "slothette-preview")
"""
- The name of the Organization.
+ Creates a repository link for a project.
"""
- organizationName: String
+ linkRepositoryToProject(input: LinkRepositoryToProjectInput!): LinkRepositoryToProjectPayload
"""
- The HTTP path for the organization
+ Lock a lockable object
"""
- organizationResourcePath: URI
+ lockLockable(input: LockLockableInput!): LockLockablePayload
"""
- The HTTP URL for the organization
+ Mark a pull request file as viewed
"""
- organizationUrl: URI
+ markFileAsViewed(input: MarkFileAsViewedInput!): MarkFileAsViewedPayload
"""
- The number of custom email routings for the restored member.
+ Marks a pull request ready for review.
"""
- restoredCustomEmailRoutingsCount: Int
+ markPullRequestReadyForReview(input: MarkPullRequestReadyForReviewInput!): MarkPullRequestReadyForReviewPayload
"""
- The number of issue assignemnts for the restored member.
+ Merge a head into a branch.
"""
- restoredIssueAssignmentsCount: Int
+ mergeBranch(input: MergeBranchInput!): MergeBranchPayload
"""
- Restored organization membership objects.
+ Merge a pull request.
"""
- restoredMemberships: [OrgRestoreMemberAuditEntryMembership!]
+ mergePullRequest(input: MergePullRequestInput!): MergePullRequestPayload
"""
- The number of restored memberships.
+ Minimizes a comment on an Issue, Commit, Pull Request, or Gist
"""
- restoredMembershipsCount: Int
+ minimizeComment(input: MinimizeCommentInput!): MinimizeCommentPayload
"""
- The number of repositories of the restored member.
+ Moves a project card to another place.
"""
- restoredRepositoriesCount: Int
+ moveProjectCard(input: MoveProjectCardInput!): MoveProjectCardPayload
"""
- The number of starred repositories for the restored member.
+ Moves a project column to another place.
"""
- restoredRepositoryStarsCount: Int
+ moveProjectColumn(input: MoveProjectColumnInput!): MoveProjectColumnPayload
"""
- The number of watched repositories for the restored member.
+ Pin an issue to a repository
"""
- restoredRepositoryWatchesCount: Int
+ pinIssue(input: PinIssueInput!): PinIssuePayload @preview(toggledBy: "elektra-preview")
"""
- The user affected by the action
+ Removes assignees from an assignable object.
"""
- user: User
+ removeAssigneesFromAssignable(input: RemoveAssigneesFromAssignableInput!): RemoveAssigneesFromAssignablePayload
"""
- For actions involving two users, the actor is the initiator and the user is the affected user.
+ Removes an administrator from the enterprise.
"""
- userLogin: String
+ removeEnterpriseAdmin(input: RemoveEnterpriseAdminInput!): RemoveEnterpriseAdminPayload
"""
- The HTTP path for the user.
+ Removes labels from a Labelable object.
"""
- userResourcePath: URI
+ removeLabelsFromLabelable(input: RemoveLabelsFromLabelableInput!): RemoveLabelsFromLabelablePayload
"""
- The HTTP URL for the user.
+ Removes outside collaborator from all repositories in an organization.
"""
- userUrl: URI
-}
-
-"""
-Types of memberships that can be restored for an Organization member.
-"""
-union OrgRestoreMemberAuditEntryMembership @preview(toggledBy: "audit-log-preview") = OrgRestoreMemberMembershipOrganizationAuditEntryData | OrgRestoreMemberMembershipRepositoryAuditEntryData | OrgRestoreMemberMembershipTeamAuditEntryData
+ removeOutsideCollaborator(input: RemoveOutsideCollaboratorInput!): RemoveOutsideCollaboratorPayload
-"""
-Metadata for an organization membership for org.restore_member actions
-"""
-type OrgRestoreMemberMembershipOrganizationAuditEntryData implements OrganizationAuditEntryData @preview(toggledBy: "audit-log-preview") {
"""
- The Organization associated with the Audit Entry.
+ Removes a reaction from a subject.
"""
- organization: Organization
+ removeReaction(input: RemoveReactionInput!): RemoveReactionPayload
"""
- The name of the Organization.
+ Removes a star from a Starrable.
"""
- organizationName: String
+ removeStar(input: RemoveStarInput!): RemoveStarPayload
"""
- The HTTP path for the organization
+ Reopen a issue.
"""
- organizationResourcePath: URI
+ reopenIssue(input: ReopenIssueInput!): ReopenIssuePayload
"""
- The HTTP URL for the organization
+ Reopen a pull request.
"""
- organizationUrl: URI
-}
+ reopenPullRequest(input: ReopenPullRequestInput!): ReopenPullRequestPayload
-"""
-Metadata for a repository membership for org.restore_member actions
-"""
-type OrgRestoreMemberMembershipRepositoryAuditEntryData implements RepositoryAuditEntryData @preview(toggledBy: "audit-log-preview") {
"""
- The repository associated with the action
+ Set review requests on a pull request.
"""
- repository: Repository
+ requestReviews(input: RequestReviewsInput!): RequestReviewsPayload
"""
- The name of the repository
+ Rerequests an existing check suite.
"""
- repositoryName: String
+ rerequestCheckSuite(input: RerequestCheckSuiteInput!): RerequestCheckSuitePayload
"""
- The HTTP path for the repository
+ Marks a review thread as resolved.
"""
- repositoryResourcePath: URI
+ resolveReviewThread(input: ResolveReviewThreadInput!): ResolveReviewThreadPayload
"""
- The HTTP URL for the repository
+ Submits a pending pull request review.
"""
- repositoryUrl: URI
-}
+ submitPullRequestReview(input: SubmitPullRequestReviewInput!): SubmitPullRequestReviewPayload
-"""
-Metadata for a team membership for org.restore_member actions
-"""
-type OrgRestoreMemberMembershipTeamAuditEntryData implements TeamAuditEntryData @preview(toggledBy: "audit-log-preview") {
"""
- The team associated with the action
+ Transfer an issue to a different repository
"""
- team: Team
+ transferIssue(input: TransferIssueInput!): TransferIssuePayload
"""
- The name of the team
+ Unarchives a repository.
"""
- teamName: String
+ unarchiveRepository(input: UnarchiveRepositoryInput!): UnarchiveRepositoryPayload
"""
- The HTTP path for this team
+ Unfollow a user.
"""
- teamResourcePath: URI
+ unfollowUser(input: UnfollowUserInput!): UnfollowUserPayload
"""
- The HTTP URL for this team
+ Deletes a repository link from a project.
"""
- teamUrl: URI
-}
+ unlinkRepositoryFromProject(input: UnlinkRepositoryFromProjectInput!): UnlinkRepositoryFromProjectPayload
-"""
-Audit log entry for a org.unblock_user
-"""
-type OrgUnblockUserAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData @preview(toggledBy: "audit-log-preview") {
"""
- The action name
+ Unlock a lockable object
"""
- action: String!
+ unlockLockable(input: UnlockLockableInput!): UnlockLockablePayload
"""
- The user who initiated the action
+ Unmark a pull request file as viewed
"""
- actor: AuditEntryActor
+ unmarkFileAsViewed(input: UnmarkFileAsViewedInput!): UnmarkFileAsViewedPayload
"""
- The IP address of the actor
+ Unmark an issue as a duplicate of another issue.
"""
- actorIp: String
+ unmarkIssueAsDuplicate(input: UnmarkIssueAsDuplicateInput!): UnmarkIssueAsDuplicatePayload
"""
- A readable representation of the actor's location
+ Unminimizes a comment on an Issue, Commit, Pull Request, or Gist
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ unminimizeComment(input: UnminimizeCommentInput!): UnminimizeCommentPayload
"""
- The username of the user who initiated the action
+ Unpin a pinned issue from a repository
"""
- actorLogin: String
+ unpinIssue(input: UnpinIssueInput!): UnpinIssuePayload @preview(toggledBy: "elektra-preview")
"""
- The HTTP path for the actor.
+ Marks a review thread as unresolved.
"""
- actorResourcePath: URI
+ unresolveReviewThread(input: UnresolveReviewThreadInput!): UnresolveReviewThreadPayload
"""
- The HTTP URL for the actor.
+ Create a new branch protection rule
"""
- actorUrl: URI
+ updateBranchProtectionRule(input: UpdateBranchProtectionRuleInput!): UpdateBranchProtectionRulePayload
"""
- The user being unblocked by the organization.
+ Update a check run
"""
- blockedUser: User
+ updateCheckRun(input: UpdateCheckRunInput!): UpdateCheckRunPayload
"""
- The username of the blocked user.
+ Modifies the settings of an existing check suite
"""
- blockedUserName: String
+ updateCheckSuitePreferences(input: UpdateCheckSuitePreferencesInput!): UpdateCheckSuitePreferencesPayload
"""
- The HTTP path for the blocked user.
+ Sets whether private repository forks are enabled for an enterprise.
"""
- blockedUserResourcePath: URI
+ updateEnterpriseAllowPrivateRepositoryForkingSetting(input: UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput!): UpdateEnterpriseAllowPrivateRepositoryForkingSettingPayload
"""
- The HTTP URL for the blocked user.
+ Sets the default repository permission for organizations in an enterprise.
"""
- blockedUserUrl: URI
+ updateEnterpriseDefaultRepositoryPermissionSetting(input: UpdateEnterpriseDefaultRepositoryPermissionSettingInput!): UpdateEnterpriseDefaultRepositoryPermissionSettingPayload
"""
- The time the action was initiated
+ Sets whether organization members with admin permissions on a repository can change repository visibility.
"""
- createdAt: PreciseDateTime!
- id: ID!
+ updateEnterpriseMembersCanChangeRepositoryVisibilitySetting(input: UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput!): UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingPayload
"""
- The Organization associated with the Audit Entry.
+ Sets the members can create repositories setting for an enterprise.
"""
- organization: Organization
+ updateEnterpriseMembersCanCreateRepositoriesSetting(input: UpdateEnterpriseMembersCanCreateRepositoriesSettingInput!): UpdateEnterpriseMembersCanCreateRepositoriesSettingPayload
"""
- The name of the Organization.
+ Sets the members can delete issues setting for an enterprise.
"""
- organizationName: String
+ updateEnterpriseMembersCanDeleteIssuesSetting(input: UpdateEnterpriseMembersCanDeleteIssuesSettingInput!): UpdateEnterpriseMembersCanDeleteIssuesSettingPayload
"""
- The HTTP path for the organization
+ Sets the members can delete repositories setting for an enterprise.
"""
- organizationResourcePath: URI
+ updateEnterpriseMembersCanDeleteRepositoriesSetting(input: UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput!): UpdateEnterpriseMembersCanDeleteRepositoriesSettingPayload
"""
- The HTTP URL for the organization
+ Sets whether members can invite collaborators are enabled for an enterprise.
"""
- organizationUrl: URI
+ updateEnterpriseMembersCanInviteCollaboratorsSetting(input: UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput!): UpdateEnterpriseMembersCanInviteCollaboratorsSettingPayload
"""
- The user affected by the action
+ Sets whether or not an organization admin can make purchases.
"""
- user: User
+ updateEnterpriseMembersCanMakePurchasesSetting(input: UpdateEnterpriseMembersCanMakePurchasesSettingInput!): UpdateEnterpriseMembersCanMakePurchasesSettingPayload
"""
- For actions involving two users, the actor is the initiator and the user is the affected user.
+ Sets the members can update protected branches setting for an enterprise.
"""
- userLogin: String
+ updateEnterpriseMembersCanUpdateProtectedBranchesSetting(input: UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput!): UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingPayload
"""
- The HTTP path for the user.
+ Sets the members can view dependency insights for an enterprise.
"""
- userResourcePath: URI
+ updateEnterpriseMembersCanViewDependencyInsightsSetting(input: UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput!): UpdateEnterpriseMembersCanViewDependencyInsightsSettingPayload
"""
- The HTTP URL for the user.
+ Sets whether organization projects are enabled for an enterprise.
"""
- userUrl: URI
-}
+ updateEnterpriseOrganizationProjectsSetting(input: UpdateEnterpriseOrganizationProjectsSettingInput!): UpdateEnterpriseOrganizationProjectsSettingPayload
-"""
-Audit log entry for a org.update_default_repository_permission
-"""
-type OrgUpdateDefaultRepositoryPermissionAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData @preview(toggledBy: "audit-log-preview") {
"""
- The action name
+ Updates an enterprise's profile.
"""
- action: String!
+ updateEnterpriseProfile(input: UpdateEnterpriseProfileInput!): UpdateEnterpriseProfilePayload
"""
- The user who initiated the action
+ Sets whether repository projects are enabled for a enterprise.
"""
- actor: AuditEntryActor
+ updateEnterpriseRepositoryProjectsSetting(input: UpdateEnterpriseRepositoryProjectsSettingInput!): UpdateEnterpriseRepositoryProjectsSettingPayload
"""
- The IP address of the actor
+ Sets whether team discussions are enabled for an enterprise.
"""
- actorIp: String
+ updateEnterpriseTeamDiscussionsSetting(input: UpdateEnterpriseTeamDiscussionsSettingInput!): UpdateEnterpriseTeamDiscussionsSettingPayload
"""
- A readable representation of the actor's location
+ Sets whether two factor authentication is required for all users in an enterprise.
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ updateEnterpriseTwoFactorAuthenticationRequiredSetting(input: UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput!): UpdateEnterpriseTwoFactorAuthenticationRequiredSettingPayload
"""
- The username of the user who initiated the action
+ Sets whether an IP allow list is enabled on an owner.
"""
- actorLogin: String
+ updateIpAllowListEnabledSetting(input: UpdateIpAllowListEnabledSettingInput!): UpdateIpAllowListEnabledSettingPayload
"""
- The HTTP path for the actor.
+ Updates an IP allow list entry.
"""
- actorResourcePath: URI
+ updateIpAllowListEntry(input: UpdateIpAllowListEntryInput!): UpdateIpAllowListEntryPayload
"""
- The HTTP URL for the actor.
+ Updates an Issue.
"""
- actorUrl: URI
+ updateIssue(input: UpdateIssueInput!): UpdateIssuePayload
"""
- The time the action was initiated
+ Updates an IssueComment object.
"""
- createdAt: PreciseDateTime!
- id: ID!
+ updateIssueComment(input: UpdateIssueCommentInput!): UpdateIssueCommentPayload
"""
- The Organization associated with the Audit Entry.
+ Updates an existing label.
"""
- organization: Organization
+ updateLabel(input: UpdateLabelInput!): UpdateLabelPayload @preview(toggledBy: "bane-preview")
"""
- The name of the Organization.
+ Updates an existing project.
"""
- organizationName: String
+ updateProject(input: UpdateProjectInput!): UpdateProjectPayload
"""
- The HTTP path for the organization
+ Updates an existing project card.
"""
- organizationResourcePath: URI
+ updateProjectCard(input: UpdateProjectCardInput!): UpdateProjectCardPayload
"""
- The HTTP URL for the organization
+ Updates an existing project column.
"""
- organizationUrl: URI
+ updateProjectColumn(input: UpdateProjectColumnInput!): UpdateProjectColumnPayload
"""
- The new default repository permission level for the organization.
+ Update a pull request
"""
- permission: OrgUpdateDefaultRepositoryPermissionAuditEntryPermission
+ updatePullRequest(input: UpdatePullRequestInput!): UpdatePullRequestPayload
"""
- The former default repository permission level for the organization.
+ Updates the body of a pull request review.
"""
- permissionWas: OrgUpdateDefaultRepositoryPermissionAuditEntryPermission
+ updatePullRequestReview(input: UpdatePullRequestReviewInput!): UpdatePullRequestReviewPayload
"""
- The user affected by the action
+ Updates a pull request review comment.
"""
- user: User
+ updatePullRequestReviewComment(input: UpdatePullRequestReviewCommentInput!): UpdatePullRequestReviewCommentPayload
"""
- For actions involving two users, the actor is the initiator and the user is the affected user.
+ Update a Git Ref.
"""
- userLogin: String
+ updateRef(input: UpdateRefInput!): UpdateRefPayload
"""
- The HTTP path for the user.
+ Creates, updates and/or deletes multiple refs in a repository.
+
+ This mutation takes a list of `RefUpdate`s and performs these updates
+ on the repository. All updates are performed atomically, meaning that
+ if one of them is rejected, no other ref will be modified.
+
+ `RefUpdate.beforeOid` specifies that the given reference needs to point
+ to the given value before performing any updates. A value of
+ `0000000000000000000000000000000000000000` can be used to verify that
+ the references should not exist.
+
+ `RefUpdate.afterOid` specifies the value that the given reference
+ will point to after performing all updates. A value of
+ `0000000000000000000000000000000000000000` can be used to delete a
+ reference.
+
+ If `RefUpdate.force` is set to `true`, a non-fast-forward updates
+ for the given reference will be allowed.
"""
- userResourcePath: URI
+ updateRefs(input: UpdateRefsInput!): UpdateRefsPayload @preview(toggledBy: "update-refs-preview")
"""
- The HTTP URL for the user.
+ Update information about a repository.
"""
- userUrl: URI
+ updateRepository(input: UpdateRepositoryInput!): UpdateRepositoryPayload
+
+ """
+ Updates the state for subscribable subjects.
+ """
+ updateSubscription(input: UpdateSubscriptionInput!): UpdateSubscriptionPayload
+
+ """
+ Updates a team discussion.
+ """
+ updateTeamDiscussion(input: UpdateTeamDiscussionInput!): UpdateTeamDiscussionPayload
+
+ """
+ Updates a discussion comment.
+ """
+ updateTeamDiscussionComment(input: UpdateTeamDiscussionCommentInput!): UpdateTeamDiscussionCommentPayload
+
+ """
+ Updates team review assignment.
+ """
+ updateTeamReviewAssignment(input: UpdateTeamReviewAssignmentInput!): UpdateTeamReviewAssignmentPayload @preview(toggledBy: "stone-crop-preview")
+
+ """
+ Replaces the repository's topics with the given topics.
+ """
+ updateTopics(input: UpdateTopicsInput!): UpdateTopicsPayload
}
"""
-The default permission a repository can have in an Organization.
+An object with an ID.
"""
-enum OrgUpdateDefaultRepositoryPermissionAuditEntryPermission @preview(toggledBy: "audit-log-preview") {
+interface Node {
"""
- Can read, clone, push, and add collaborators to repositories.
+ ID of the object.
"""
- ADMIN
+ id: ID!
+}
+"""
+Metadata for an audit entry with action oauth_application.*
+"""
+interface OauthApplicationAuditEntryData {
"""
- No default permission value.
+ The name of the OAuth Application.
"""
- NONE
+ oauthApplicationName: String
"""
- Can read and clone repositories.
+ The HTTP path for the OAuth Application
"""
- READ
+ oauthApplicationResourcePath: URI
"""
- Can read, clone and push to repositories.
+ The HTTP URL for the OAuth Application
"""
- WRITE
+ oauthApplicationUrl: URI
}
"""
-Audit log entry for a org.update_member event.
+Audit log entry for a oauth_application.create event.
"""
-type OrgUpdateMemberAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData @preview(toggledBy: "audit-log-preview") {
+type OauthApplicationCreateAuditEntry implements AuditEntry & Node & OauthApplicationAuditEntryData & OrganizationAuditEntryData {
"""
The action name
"""
@@ -13073,7 +14409,7 @@ type OrgUpdateMemberAuditEntry implements AuditEntry & Node & OrganizationAuditE
"""
A readable representation of the actor's location
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ actorLocation: ActorLocation
"""
The username of the user who initiated the action
@@ -13090,12 +14426,42 @@ type OrgUpdateMemberAuditEntry implements AuditEntry & Node & OrganizationAuditE
"""
actorUrl: URI
+ """
+ The application URL of the OAuth Application.
+ """
+ applicationUrl: URI
+
+ """
+ The callback URL of the OAuth Application.
+ """
+ callbackUrl: URI
+
"""
The time the action was initiated
"""
createdAt: PreciseDateTime!
id: ID!
+ """
+ The name of the OAuth Application.
+ """
+ oauthApplicationName: String
+
+ """
+ The HTTP path for the OAuth Application
+ """
+ oauthApplicationResourcePath: URI
+
+ """
+ The HTTP URL for the OAuth Application
+ """
+ oauthApplicationUrl: URI
+
+ """
+ The corresponding operation type for the action
+ """
+ operationType: OperationType
+
"""
The Organization associated with the Audit Entry.
"""
@@ -13117,14 +14483,14 @@ type OrgUpdateMemberAuditEntry implements AuditEntry & Node & OrganizationAuditE
organizationUrl: URI
"""
- The new member permission level for the organization.
+ The rate limit of the OAuth Application.
"""
- permission: OrgUpdateMemberAuditEntryPermission
+ rateLimit: Int
"""
- The former member permission level for the organization.
+ The state of the OAuth Application.
"""
- permissionWas: OrgUpdateMemberAuditEntryPermission
+ state: OauthApplicationCreateAuditEntryState
"""
The user affected by the action
@@ -13148,24 +14514,84 @@ type OrgUpdateMemberAuditEntry implements AuditEntry & Node & OrganizationAuditE
}
"""
-The permissions available to members on an Organization.
+The state of an OAuth Application when it was created.
"""
-enum OrgUpdateMemberAuditEntryPermission @preview(toggledBy: "audit-log-preview") {
+enum OauthApplicationCreateAuditEntryState {
"""
- Can read, clone, push, and add collaborators to repositories.
+ The OAuth Application was active and allowed to have OAuth Accesses.
"""
- ADMIN
+ ACTIVE
"""
- Can read and clone repositories.
+ The OAuth Application was in the process of being deleted.
"""
- READ
+ PENDING_DELETION
+
+ """
+ The OAuth Application was suspended from generating OAuth Accesses due to abuse or security concerns.
+ """
+ SUSPENDED
}
"""
-Audit log entry for a org.update_member_repository_creation_permission event.
+The corresponding operation type for the action
+"""
+enum OperationType {
+ """
+ An existing resource was accessed
+ """
+ ACCESS
+
+ """
+ A resource performed an authentication event
+ """
+ AUTHENTICATION
+
+ """
+ A new resource was created
+ """
+ CREATE
+
+ """
+ An existing resource was modified
+ """
+ MODIFY
+
+ """
+ An existing resource was removed
+ """
+ REMOVE
+
+ """
+ An existing resource was restored
+ """
+ RESTORE
+
+ """
+ An existing resource was transferred between multiple resources
+ """
+ TRANSFER
+}
+
+"""
+Possible directions in which to order a list of items when provided an `orderBy` argument.
+"""
+enum OrderDirection {
+ """
+ Specifies an ascending order for a given `orderBy` argument.
+ """
+ ASC
+
+ """
+ Specifies a descending order for a given `orderBy` argument.
+ """
+ DESC
+}
+
+"""
+Audit log entry for a org.add_billing_manager
"""
-type OrgUpdateMemberRepositoryCreationPermissionAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData @preview(toggledBy: "audit-log-preview") {
+type OrgAddBillingManagerAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData {
"""
The action name
"""
@@ -13184,7 +14610,7 @@ type OrgUpdateMemberRepositoryCreationPermissionAuditEntry implements AuditEntry
"""
A readable representation of the actor's location
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ actorLocation: ActorLocation
"""
The username of the user who initiated the action
@@ -13201,17 +14627,22 @@ type OrgUpdateMemberRepositoryCreationPermissionAuditEntry implements AuditEntry
"""
actorUrl: URI
- """
- Can members create repositories in the organization.
- """
- canCreateRepositories: Boolean
-
"""
The time the action was initiated
"""
createdAt: PreciseDateTime!
id: ID!
+ """
+ The email address used to invite a billing manager for the organization.
+ """
+ invitationEmail: String
+
+ """
+ The corresponding operation type for the action
+ """
+ operationType: OperationType
+
"""
The Organization associated with the Audit Entry.
"""
@@ -13251,32 +14682,12 @@ type OrgUpdateMemberRepositoryCreationPermissionAuditEntry implements AuditEntry
The HTTP URL for the user.
"""
userUrl: URI
-
- """
- The permission for visibility level of repositories for this organization.
- """
- visibility: OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility
-}
-
-"""
-The permissions available for repository creation on an Organization.
-"""
-enum OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility @preview(toggledBy: "audit-log-preview") {
- """
- All organization members are restricted from creating any repositories.
- """
- ALL
-
- """
- All organization members are restricted from creating public repositories.
- """
- PUBLIC
}
"""
-Audit log entry for a org.update_member_repository_invitation_permission event.
+Audit log entry for a org.add_member
"""
-type OrgUpdateMemberRepositoryInvitationPermissionAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData @preview(toggledBy: "audit-log-preview") {
+type OrgAddMemberAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData {
"""
The action name
"""
@@ -13295,7 +14706,7 @@ type OrgUpdateMemberRepositoryInvitationPermissionAuditEntry implements AuditEnt
"""
A readable representation of the actor's location
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ actorLocation: ActorLocation
"""
The username of the user who initiated the action
@@ -13312,17 +14723,17 @@ type OrgUpdateMemberRepositoryInvitationPermissionAuditEntry implements AuditEnt
"""
actorUrl: URI
- """
- Can outside collaborators be invited to repositories in the organization.
- """
- canInviteOutsideCollaboratorsToRepositories: Boolean
-
"""
The time the action was initiated
"""
createdAt: PreciseDateTime!
id: ID!
+ """
+ The corresponding operation type for the action
+ """
+ operationType: OperationType
+
"""
The Organization associated with the Audit Entry.
"""
@@ -13343,6 +14754,11 @@ type OrgUpdateMemberRepositoryInvitationPermissionAuditEntry implements AuditEnt
"""
organizationUrl: URI
+ """
+ The permission level of the member added to the organization.
+ """
+ permission: OrgAddMemberAuditEntryPermission
+
"""
The user affected by the action
"""
@@ -13365,233 +14781,6407 @@ type OrgUpdateMemberRepositoryInvitationPermissionAuditEntry implements AuditEnt
}
"""
-An account on GitHub, with one or more owners, that has repositories, members and teams.
+The permissions available to members on an Organization.
"""
-type Organization implements Actor & MemberStatusable & Node & ProfileOwner & ProjectOwner & RegistryPackageOwner & RegistryPackageSearch & RepositoryOwner & UniformResourceLocatable {
+enum OrgAddMemberAuditEntryPermission {
"""
- Determine if this repository owner has any items that can be pinned to their profile.
+ Can read, clone, push, and add collaborators to repositories.
"""
- anyPinnableItems(
- """
- Filter to only a particular kind of pinnable item.
- """
- type: PinnableItemType
- ): Boolean!
+ ADMIN
"""
- Audit log entries of the organization
+ Can read and clone repositories.
"""
- auditLog(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
+ READ
+}
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
+"""
+Audit log entry for a org.block_user
+"""
+type OrgBlockUserAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData {
+ """
+ The action name
+ """
+ action: String!
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
+ """
+ The user who initiated the action
+ """
+ actor: AuditEntryActor
- """
- Ordering options for the returned audit log entries.
- """
- orderBy: AuditLogOrder = {field: CREATED_AT, direction: DESC}
+ """
+ The IP address of the actor
+ """
+ actorIp: String
- """
- The query string to filter audit entries
- """
- query: String
- ): OrganizationAuditEntryConnection! @preview(toggledBy: "audit-log-preview")
+ """
+ A readable representation of the actor's location
+ """
+ actorLocation: ActorLocation
"""
- A URL pointing to the organization's public avatar.
+ The username of the user who initiated the action
"""
- avatarUrl(
- """
- The size of the resulting square image.
- """
- size: Int
- ): URI!
+ actorLogin: String
"""
- Identifies the primary key from the database.
+ The HTTP path for the actor.
"""
- databaseId: Int
+ actorResourcePath: URI
"""
- The organization's public profile description.
+ The HTTP URL for the actor.
"""
- description: String
+ actorUrl: URI
"""
- The organization's public email.
+ The blocked user.
"""
- email: String
- id: ID!
+ blockedUser: User
"""
- Showcases a selection of repositories and gists that the profile owner has
- either curated or that have been selected automatically based on popularity.
+ The username of the blocked user.
"""
- itemShowcase: ProfileItemShowcase!
+ blockedUserName: String
"""
- The organization's public profile location.
+ The HTTP path for the blocked user.
"""
- location: String
+ blockedUserResourcePath: URI
"""
- The organization's login name.
+ The HTTP URL for the blocked user.
"""
- login: String!
+ blockedUserUrl: URI
"""
- Get the status messages members of this entity have set that are either public or visible only to the organization.
+ The time the action was initiated
"""
- memberStatuses(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
+ createdAt: PreciseDateTime!
+ id: ID!
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
+ """
+ The corresponding operation type for the action
+ """
+ operationType: OperationType
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
+ """
+ The Organization associated with the Audit Entry.
+ """
+ organization: Organization
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
+ """
+ The name of the Organization.
+ """
+ organizationName: String
- """
- Ordering options for user statuses returned from the connection.
- """
- orderBy: UserStatusOrder = {field: UPDATED_AT, direction: DESC}
- ): UserStatusConnection!
+ """
+ The HTTP path for the organization
+ """
+ organizationResourcePath: URI
"""
- A list of users who are members of this organization.
+ The HTTP URL for the organization
"""
- members(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
+ organizationUrl: URI
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
+ """
+ The user affected by the action
+ """
+ user: User
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
+ """
+ For actions involving two users, the actor is the initiator and the user is the affected user.
+ """
+ userLogin: String
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): UserConnection! @deprecated(reason: "The `members` field is deprecated and will be removed soon. Use `Organization.membersWithRole` instead. Removal on 2019-04-01 UTC.")
+ """
+ The HTTP path for the user.
+ """
+ userResourcePath: URI
"""
- A list of users who are members of this organization.
+ The HTTP URL for the user.
"""
- membersWithRole(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
+ userUrl: URI
+}
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
+"""
+Audit log entry for a org.config.disable_collaborators_only event.
+"""
+type OrgConfigDisableCollaboratorsOnlyAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData {
+ """
+ The action name
+ """
+ action: String!
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
+ """
+ The user who initiated the action
+ """
+ actor: AuditEntryActor
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): OrganizationMemberConnection!
+ """
+ The IP address of the actor
+ """
+ actorIp: String
"""
- The organization's public profile name.
+ A readable representation of the actor's location
"""
- name: String
+ actorLocation: ActorLocation
"""
- The HTTP path creating a new team
+ The username of the user who initiated the action
"""
- newTeamResourcePath: URI!
+ actorLogin: String
"""
- The HTTP URL creating a new team
+ The HTTP path for the actor.
"""
- newTeamUrl: URI!
+ actorResourcePath: URI
"""
- The billing email for the organization.
+ The HTTP URL for the actor.
"""
- organizationBillingEmail: String
+ actorUrl: URI
"""
- A list of users who have been invited to join this organization.
+ The time the action was initiated
"""
- pendingMembers(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
+ createdAt: PreciseDateTime!
+ id: ID!
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
+ """
+ The corresponding operation type for the action
+ """
+ operationType: OperationType
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
+ """
+ The Organization associated with the Audit Entry.
+ """
+ organization: Organization
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): UserConnection!
+ """
+ The name of the Organization.
+ """
+ organizationName: String
"""
- A list of repositories and gists this profile owner can pin to their profile.
+ The HTTP path for the organization
"""
- pinnableItems(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
+ organizationResourcePath: URI
+ """
+ The HTTP URL for the organization
+ """
+ organizationUrl: URI
+
+ """
+ The user affected by the action
+ """
+ user: User
+
+ """
+ For actions involving two users, the actor is the initiator and the user is the affected user.
+ """
+ userLogin: String
+
+ """
+ The HTTP path for the user.
+ """
+ userResourcePath: URI
+
+ """
+ The HTTP URL for the user.
+ """
+ userUrl: URI
+}
+
+"""
+Audit log entry for a org.config.enable_collaborators_only event.
+"""
+type OrgConfigEnableCollaboratorsOnlyAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData {
+ """
+ The action name
+ """
+ action: String!
+
+ """
+ The user who initiated the action
+ """
+ actor: AuditEntryActor
+
+ """
+ The IP address of the actor
+ """
+ actorIp: String
+
+ """
+ A readable representation of the actor's location
+ """
+ actorLocation: ActorLocation
+
+ """
+ The username of the user who initiated the action
+ """
+ actorLogin: String
+
+ """
+ The HTTP path for the actor.
+ """
+ actorResourcePath: URI
+
+ """
+ The HTTP URL for the actor.
+ """
+ actorUrl: URI
+
+ """
+ The time the action was initiated
+ """
+ createdAt: PreciseDateTime!
+ id: ID!
+
+ """
+ The corresponding operation type for the action
+ """
+ operationType: OperationType
+
+ """
+ The Organization associated with the Audit Entry.
+ """
+ organization: Organization
+
+ """
+ The name of the Organization.
+ """
+ organizationName: String
+
+ """
+ The HTTP path for the organization
+ """
+ organizationResourcePath: URI
+
+ """
+ The HTTP URL for the organization
+ """
+ organizationUrl: URI
+
+ """
+ The user affected by the action
+ """
+ user: User
+
+ """
+ For actions involving two users, the actor is the initiator and the user is the affected user.
+ """
+ userLogin: String
+
+ """
+ The HTTP path for the user.
+ """
+ userResourcePath: URI
+
+ """
+ The HTTP URL for the user.
+ """
+ userUrl: URI
+}
+
+"""
+Audit log entry for a org.create event.
+"""
+type OrgCreateAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData {
+ """
+ The action name
+ """
+ action: String!
+
+ """
+ The user who initiated the action
+ """
+ actor: AuditEntryActor
+
+ """
+ The IP address of the actor
+ """
+ actorIp: String
+
+ """
+ A readable representation of the actor's location
+ """
+ actorLocation: ActorLocation
+
+ """
+ The username of the user who initiated the action
+ """
+ actorLogin: String
+
+ """
+ The HTTP path for the actor.
+ """
+ actorResourcePath: URI
+
+ """
+ The HTTP URL for the actor.
+ """
+ actorUrl: URI
+
+ """
+ The billing plan for the Organization.
+ """
+ billingPlan: OrgCreateAuditEntryBillingPlan
+
+ """
+ The time the action was initiated
+ """
+ createdAt: PreciseDateTime!
+ id: ID!
+
+ """
+ The corresponding operation type for the action
+ """
+ operationType: OperationType
+
+ """
+ The Organization associated with the Audit Entry.
+ """
+ organization: Organization
+
+ """
+ The name of the Organization.
+ """
+ organizationName: String
+
+ """
+ The HTTP path for the organization
+ """
+ organizationResourcePath: URI
+
+ """
+ The HTTP URL for the organization
+ """
+ organizationUrl: URI
+
+ """
+ The user affected by the action
+ """
+ user: User
+
+ """
+ For actions involving two users, the actor is the initiator and the user is the affected user.
+ """
+ userLogin: String
+
+ """
+ The HTTP path for the user.
+ """
+ userResourcePath: URI
+
+ """
+ The HTTP URL for the user.
+ """
+ userUrl: URI
+}
+
+"""
+The billing plans available for organizations.
+"""
+enum OrgCreateAuditEntryBillingPlan {
+ """
+ Team Plan
+ """
+ BUSINESS
+
+ """
+ Enterprise Cloud Plan
+ """
+ BUSINESS_PLUS
+
+ """
+ Free Plan
+ """
+ FREE
+
+ """
+ Tiered Per Seat Plan
+ """
+ TIERED_PER_SEAT
+
+ """
+ Legacy Unlimited Plan
+ """
+ UNLIMITED
+}
+
+"""
+Audit log entry for a org.disable_oauth_app_restrictions event.
+"""
+type OrgDisableOauthAppRestrictionsAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData {
+ """
+ The action name
+ """
+ action: String!
+
+ """
+ The user who initiated the action
+ """
+ actor: AuditEntryActor
+
+ """
+ The IP address of the actor
+ """
+ actorIp: String
+
+ """
+ A readable representation of the actor's location
+ """
+ actorLocation: ActorLocation
+
+ """
+ The username of the user who initiated the action
+ """
+ actorLogin: String
+
+ """
+ The HTTP path for the actor.
+ """
+ actorResourcePath: URI
+
+ """
+ The HTTP URL for the actor.
+ """
+ actorUrl: URI
+
+ """
+ The time the action was initiated
+ """
+ createdAt: PreciseDateTime!
+ id: ID!
+
+ """
+ The corresponding operation type for the action
+ """
+ operationType: OperationType
+
+ """
+ The Organization associated with the Audit Entry.
+ """
+ organization: Organization
+
+ """
+ The name of the Organization.
+ """
+ organizationName: String
+
+ """
+ The HTTP path for the organization
+ """
+ organizationResourcePath: URI
+
+ """
+ The HTTP URL for the organization
+ """
+ organizationUrl: URI
+
+ """
+ The user affected by the action
+ """
+ user: User
+
+ """
+ For actions involving two users, the actor is the initiator and the user is the affected user.
+ """
+ userLogin: String
+
+ """
+ The HTTP path for the user.
+ """
+ userResourcePath: URI
+
+ """
+ The HTTP URL for the user.
+ """
+ userUrl: URI
+}
+
+"""
+Audit log entry for a org.disable_saml event.
+"""
+type OrgDisableSamlAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData {
+ """
+ The action name
+ """
+ action: String!
+
+ """
+ The user who initiated the action
+ """
+ actor: AuditEntryActor
+
+ """
+ The IP address of the actor
+ """
+ actorIp: String
+
+ """
+ A readable representation of the actor's location
+ """
+ actorLocation: ActorLocation
+
+ """
+ The username of the user who initiated the action
+ """
+ actorLogin: String
+
+ """
+ The HTTP path for the actor.
+ """
+ actorResourcePath: URI
+
+ """
+ The HTTP URL for the actor.
+ """
+ actorUrl: URI
+
+ """
+ The time the action was initiated
+ """
+ createdAt: PreciseDateTime!
+
+ """
+ The SAML provider's digest algorithm URL.
+ """
+ digestMethodUrl: URI
+ id: ID!
+
+ """
+ The SAML provider's issuer URL.
+ """
+ issuerUrl: URI
+
+ """
+ The corresponding operation type for the action
+ """
+ operationType: OperationType
+
+ """
+ The Organization associated with the Audit Entry.
+ """
+ organization: Organization
+
+ """
+ The name of the Organization.
+ """
+ organizationName: String
+
+ """
+ The HTTP path for the organization
+ """
+ organizationResourcePath: URI
+
+ """
+ The HTTP URL for the organization
+ """
+ organizationUrl: URI
+
+ """
+ The SAML provider's signature algorithm URL.
+ """
+ signatureMethodUrl: URI
+
+ """
+ The SAML provider's single sign-on URL.
+ """
+ singleSignOnUrl: URI
+
+ """
+ The user affected by the action
+ """
+ user: User
+
+ """
+ For actions involving two users, the actor is the initiator and the user is the affected user.
+ """
+ userLogin: String
+
+ """
+ The HTTP path for the user.
+ """
+ userResourcePath: URI
+
+ """
+ The HTTP URL for the user.
+ """
+ userUrl: URI
+}
+
+"""
+Audit log entry for a org.disable_two_factor_requirement event.
+"""
+type OrgDisableTwoFactorRequirementAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData {
+ """
+ The action name
+ """
+ action: String!
+
+ """
+ The user who initiated the action
+ """
+ actor: AuditEntryActor
+
+ """
+ The IP address of the actor
+ """
+ actorIp: String
+
+ """
+ A readable representation of the actor's location
+ """
+ actorLocation: ActorLocation
+
+ """
+ The username of the user who initiated the action
+ """
+ actorLogin: String
+
+ """
+ The HTTP path for the actor.
+ """
+ actorResourcePath: URI
+
+ """
+ The HTTP URL for the actor.
+ """
+ actorUrl: URI
+
+ """
+ The time the action was initiated
+ """
+ createdAt: PreciseDateTime!
+ id: ID!
+
+ """
+ The corresponding operation type for the action
+ """
+ operationType: OperationType
+
+ """
+ The Organization associated with the Audit Entry.
+ """
+ organization: Organization
+
+ """
+ The name of the Organization.
+ """
+ organizationName: String
+
+ """
+ The HTTP path for the organization
+ """
+ organizationResourcePath: URI
+
+ """
+ The HTTP URL for the organization
+ """
+ organizationUrl: URI
+
+ """
+ The user affected by the action
+ """
+ user: User
+
+ """
+ For actions involving two users, the actor is the initiator and the user is the affected user.
+ """
+ userLogin: String
+
+ """
+ The HTTP path for the user.
+ """
+ userResourcePath: URI
+
+ """
+ The HTTP URL for the user.
+ """
+ userUrl: URI
+}
+
+"""
+Audit log entry for a org.enable_oauth_app_restrictions event.
+"""
+type OrgEnableOauthAppRestrictionsAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData {
+ """
+ The action name
+ """
+ action: String!
+
+ """
+ The user who initiated the action
+ """
+ actor: AuditEntryActor
+
+ """
+ The IP address of the actor
+ """
+ actorIp: String
+
+ """
+ A readable representation of the actor's location
+ """
+ actorLocation: ActorLocation
+
+ """
+ The username of the user who initiated the action
+ """
+ actorLogin: String
+
+ """
+ The HTTP path for the actor.
+ """
+ actorResourcePath: URI
+
+ """
+ The HTTP URL for the actor.
+ """
+ actorUrl: URI
+
+ """
+ The time the action was initiated
+ """
+ createdAt: PreciseDateTime!
+ id: ID!
+
+ """
+ The corresponding operation type for the action
+ """
+ operationType: OperationType
+
+ """
+ The Organization associated with the Audit Entry.
+ """
+ organization: Organization
+
+ """
+ The name of the Organization.
+ """
+ organizationName: String
+
+ """
+ The HTTP path for the organization
+ """
+ organizationResourcePath: URI
+
+ """
+ The HTTP URL for the organization
+ """
+ organizationUrl: URI
+
+ """
+ The user affected by the action
+ """
+ user: User
+
+ """
+ For actions involving two users, the actor is the initiator and the user is the affected user.
+ """
+ userLogin: String
+
+ """
+ The HTTP path for the user.
+ """
+ userResourcePath: URI
+
+ """
+ The HTTP URL for the user.
+ """
+ userUrl: URI
+}
+
+"""
+Audit log entry for a org.enable_saml event.
+"""
+type OrgEnableSamlAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData {
+ """
+ The action name
+ """
+ action: String!
+
+ """
+ The user who initiated the action
+ """
+ actor: AuditEntryActor
+
+ """
+ The IP address of the actor
+ """
+ actorIp: String
+
+ """
+ A readable representation of the actor's location
+ """
+ actorLocation: ActorLocation
+
+ """
+ The username of the user who initiated the action
+ """
+ actorLogin: String
+
+ """
+ The HTTP path for the actor.
+ """
+ actorResourcePath: URI
+
+ """
+ The HTTP URL for the actor.
+ """
+ actorUrl: URI
+
+ """
+ The time the action was initiated
+ """
+ createdAt: PreciseDateTime!
+
+ """
+ The SAML provider's digest algorithm URL.
+ """
+ digestMethodUrl: URI
+ id: ID!
+
+ """
+ The SAML provider's issuer URL.
+ """
+ issuerUrl: URI
+
+ """
+ The corresponding operation type for the action
+ """
+ operationType: OperationType
+
+ """
+ The Organization associated with the Audit Entry.
+ """
+ organization: Organization
+
+ """
+ The name of the Organization.
+ """
+ organizationName: String
+
+ """
+ The HTTP path for the organization
+ """
+ organizationResourcePath: URI
+
+ """
+ The HTTP URL for the organization
+ """
+ organizationUrl: URI
+
+ """
+ The SAML provider's signature algorithm URL.
+ """
+ signatureMethodUrl: URI
+
+ """
+ The SAML provider's single sign-on URL.
+ """
+ singleSignOnUrl: URI
+
+ """
+ The user affected by the action
+ """
+ user: User
+
+ """
+ For actions involving two users, the actor is the initiator and the user is the affected user.
+ """
+ userLogin: String
+
+ """
+ The HTTP path for the user.
+ """
+ userResourcePath: URI
+
+ """
+ The HTTP URL for the user.
+ """
+ userUrl: URI
+}
+
+"""
+Audit log entry for a org.enable_two_factor_requirement event.
+"""
+type OrgEnableTwoFactorRequirementAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData {
+ """
+ The action name
+ """
+ action: String!
+
+ """
+ The user who initiated the action
+ """
+ actor: AuditEntryActor
+
+ """
+ The IP address of the actor
+ """
+ actorIp: String
+
+ """
+ A readable representation of the actor's location
+ """
+ actorLocation: ActorLocation
+
+ """
+ The username of the user who initiated the action
+ """
+ actorLogin: String
+
+ """
+ The HTTP path for the actor.
+ """
+ actorResourcePath: URI
+
+ """
+ The HTTP URL for the actor.
+ """
+ actorUrl: URI
+
+ """
+ The time the action was initiated
+ """
+ createdAt: PreciseDateTime!
+ id: ID!
+
+ """
+ The corresponding operation type for the action
+ """
+ operationType: OperationType
+
+ """
+ The Organization associated with the Audit Entry.
+ """
+ organization: Organization
+
+ """
+ The name of the Organization.
+ """
+ organizationName: String
+
+ """
+ The HTTP path for the organization
+ """
+ organizationResourcePath: URI
+
+ """
+ The HTTP URL for the organization
+ """
+ organizationUrl: URI
+
+ """
+ The user affected by the action
+ """
+ user: User
+
+ """
+ For actions involving two users, the actor is the initiator and the user is the affected user.
+ """
+ userLogin: String
+
+ """
+ The HTTP path for the user.
+ """
+ userResourcePath: URI
+
+ """
+ The HTTP URL for the user.
+ """
+ userUrl: URI
+}
+
+"""
+Audit log entry for a org.invite_member event.
+"""
+type OrgInviteMemberAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData {
+ """
+ The action name
+ """
+ action: String!
+
+ """
+ The user who initiated the action
+ """
+ actor: AuditEntryActor
+
+ """
+ The IP address of the actor
+ """
+ actorIp: String
+
+ """
+ A readable representation of the actor's location
+ """
+ actorLocation: ActorLocation
+
+ """
+ The username of the user who initiated the action
+ """
+ actorLogin: String
+
+ """
+ The HTTP path for the actor.
+ """
+ actorResourcePath: URI
+
+ """
+ The HTTP URL for the actor.
+ """
+ actorUrl: URI
+
+ """
+ The time the action was initiated
+ """
+ createdAt: PreciseDateTime!
+
+ """
+ The email address of the organization invitation.
+ """
+ email: String
+ id: ID!
+
+ """
+ The corresponding operation type for the action
+ """
+ operationType: OperationType
+
+ """
+ The Organization associated with the Audit Entry.
+ """
+ organization: Organization
+
+ """
+ The organization invitation.
+ """
+ organizationInvitation: OrganizationInvitation
+
+ """
+ The name of the Organization.
+ """
+ organizationName: String
+
+ """
+ The HTTP path for the organization
+ """
+ organizationResourcePath: URI
+
+ """
+ The HTTP URL for the organization
+ """
+ organizationUrl: URI
+
+ """
+ The user affected by the action
+ """
+ user: User
+
+ """
+ For actions involving two users, the actor is the initiator and the user is the affected user.
+ """
+ userLogin: String
+
+ """
+ The HTTP path for the user.
+ """
+ userResourcePath: URI
+
+ """
+ The HTTP URL for the user.
+ """
+ userUrl: URI
+}
+
+"""
+Audit log entry for a org.invite_to_business event.
+"""
+type OrgInviteToBusinessAuditEntry implements AuditEntry & EnterpriseAuditEntryData & Node & OrganizationAuditEntryData {
+ """
+ The action name
+ """
+ action: String!
+
+ """
+ The user who initiated the action
+ """
+ actor: AuditEntryActor
+
+ """
+ The IP address of the actor
+ """
+ actorIp: String
+
+ """
+ A readable representation of the actor's location
+ """
+ actorLocation: ActorLocation
+
+ """
+ The username of the user who initiated the action
+ """
+ actorLogin: String
+
+ """
+ The HTTP path for the actor.
+ """
+ actorResourcePath: URI
+
+ """
+ The HTTP URL for the actor.
+ """
+ actorUrl: URI
+
+ """
+ The time the action was initiated
+ """
+ createdAt: PreciseDateTime!
+
+ """
+ The HTTP path for this enterprise.
+ """
+ enterpriseResourcePath: URI
+
+ """
+ The slug of the enterprise.
+ """
+ enterpriseSlug: String
+
+ """
+ The HTTP URL for this enterprise.
+ """
+ enterpriseUrl: URI
+ id: ID!
+
+ """
+ The corresponding operation type for the action
+ """
+ operationType: OperationType
+
+ """
+ The Organization associated with the Audit Entry.
+ """
+ organization: Organization
+
+ """
+ The name of the Organization.
+ """
+ organizationName: String
+
+ """
+ The HTTP path for the organization
+ """
+ organizationResourcePath: URI
+
+ """
+ The HTTP URL for the organization
+ """
+ organizationUrl: URI
+
+ """
+ The user affected by the action
+ """
+ user: User
+
+ """
+ For actions involving two users, the actor is the initiator and the user is the affected user.
+ """
+ userLogin: String
+
+ """
+ The HTTP path for the user.
+ """
+ userResourcePath: URI
+
+ """
+ The HTTP URL for the user.
+ """
+ userUrl: URI
+}
+
+"""
+Audit log entry for a org.oauth_app_access_approved event.
+"""
+type OrgOauthAppAccessApprovedAuditEntry implements AuditEntry & Node & OauthApplicationAuditEntryData & OrganizationAuditEntryData {
+ """
+ The action name
+ """
+ action: String!
+
+ """
+ The user who initiated the action
+ """
+ actor: AuditEntryActor
+
+ """
+ The IP address of the actor
+ """
+ actorIp: String
+
+ """
+ A readable representation of the actor's location
+ """
+ actorLocation: ActorLocation
+
+ """
+ The username of the user who initiated the action
+ """
+ actorLogin: String
+
+ """
+ The HTTP path for the actor.
+ """
+ actorResourcePath: URI
+
+ """
+ The HTTP URL for the actor.
+ """
+ actorUrl: URI
+
+ """
+ The time the action was initiated
+ """
+ createdAt: PreciseDateTime!
+ id: ID!
+
+ """
+ The name of the OAuth Application.
+ """
+ oauthApplicationName: String
+
+ """
+ The HTTP path for the OAuth Application
+ """
+ oauthApplicationResourcePath: URI
+
+ """
+ The HTTP URL for the OAuth Application
+ """
+ oauthApplicationUrl: URI
+
+ """
+ The corresponding operation type for the action
+ """
+ operationType: OperationType
+
+ """
+ The Organization associated with the Audit Entry.
+ """
+ organization: Organization
+
+ """
+ The name of the Organization.
+ """
+ organizationName: String
+
+ """
+ The HTTP path for the organization
+ """
+ organizationResourcePath: URI
+
+ """
+ The HTTP URL for the organization
+ """
+ organizationUrl: URI
+
+ """
+ The user affected by the action
+ """
+ user: User
+
+ """
+ For actions involving two users, the actor is the initiator and the user is the affected user.
+ """
+ userLogin: String
+
+ """
+ The HTTP path for the user.
+ """
+ userResourcePath: URI
+
+ """
+ The HTTP URL for the user.
+ """
+ userUrl: URI
+}
+
+"""
+Audit log entry for a org.oauth_app_access_denied event.
+"""
+type OrgOauthAppAccessDeniedAuditEntry implements AuditEntry & Node & OauthApplicationAuditEntryData & OrganizationAuditEntryData {
+ """
+ The action name
+ """
+ action: String!
+
+ """
+ The user who initiated the action
+ """
+ actor: AuditEntryActor
+
+ """
+ The IP address of the actor
+ """
+ actorIp: String
+
+ """
+ A readable representation of the actor's location
+ """
+ actorLocation: ActorLocation
+
+ """
+ The username of the user who initiated the action
+ """
+ actorLogin: String
+
+ """
+ The HTTP path for the actor.
+ """
+ actorResourcePath: URI
+
+ """
+ The HTTP URL for the actor.
+ """
+ actorUrl: URI
+
+ """
+ The time the action was initiated
+ """
+ createdAt: PreciseDateTime!
+ id: ID!
+
+ """
+ The name of the OAuth Application.
+ """
+ oauthApplicationName: String
+
+ """
+ The HTTP path for the OAuth Application
+ """
+ oauthApplicationResourcePath: URI
+
+ """
+ The HTTP URL for the OAuth Application
+ """
+ oauthApplicationUrl: URI
+
+ """
+ The corresponding operation type for the action
+ """
+ operationType: OperationType
+
+ """
+ The Organization associated with the Audit Entry.
+ """
+ organization: Organization
+
+ """
+ The name of the Organization.
+ """
+ organizationName: String
+
+ """
+ The HTTP path for the organization
+ """
+ organizationResourcePath: URI
+
+ """
+ The HTTP URL for the organization
+ """
+ organizationUrl: URI
+
+ """
+ The user affected by the action
+ """
+ user: User
+
+ """
+ For actions involving two users, the actor is the initiator and the user is the affected user.
+ """
+ userLogin: String
+
+ """
+ The HTTP path for the user.
+ """
+ userResourcePath: URI
+
+ """
+ The HTTP URL for the user.
+ """
+ userUrl: URI
+}
+
+"""
+Audit log entry for a org.oauth_app_access_requested event.
+"""
+type OrgOauthAppAccessRequestedAuditEntry implements AuditEntry & Node & OauthApplicationAuditEntryData & OrganizationAuditEntryData {
+ """
+ The action name
+ """
+ action: String!
+
+ """
+ The user who initiated the action
+ """
+ actor: AuditEntryActor
+
+ """
+ The IP address of the actor
+ """
+ actorIp: String
+
+ """
+ A readable representation of the actor's location
+ """
+ actorLocation: ActorLocation
+
+ """
+ The username of the user who initiated the action
+ """
+ actorLogin: String
+
+ """
+ The HTTP path for the actor.
+ """
+ actorResourcePath: URI
+
+ """
+ The HTTP URL for the actor.
+ """
+ actorUrl: URI
+
+ """
+ The time the action was initiated
+ """
+ createdAt: PreciseDateTime!
+ id: ID!
+
+ """
+ The name of the OAuth Application.
+ """
+ oauthApplicationName: String
+
+ """
+ The HTTP path for the OAuth Application
+ """
+ oauthApplicationResourcePath: URI
+
+ """
+ The HTTP URL for the OAuth Application
+ """
+ oauthApplicationUrl: URI
+
+ """
+ The corresponding operation type for the action
+ """
+ operationType: OperationType
+
+ """
+ The Organization associated with the Audit Entry.
+ """
+ organization: Organization
+
+ """
+ The name of the Organization.
+ """
+ organizationName: String
+
+ """
+ The HTTP path for the organization
+ """
+ organizationResourcePath: URI
+
+ """
+ The HTTP URL for the organization
+ """
+ organizationUrl: URI
+
+ """
+ The user affected by the action
+ """
+ user: User
+
+ """
+ For actions involving two users, the actor is the initiator and the user is the affected user.
+ """
+ userLogin: String
+
+ """
+ The HTTP path for the user.
+ """
+ userResourcePath: URI
+
+ """
+ The HTTP URL for the user.
+ """
+ userUrl: URI
+}
+
+"""
+Audit log entry for a org.remove_billing_manager event.
+"""
+type OrgRemoveBillingManagerAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData {
+ """
+ The action name
+ """
+ action: String!
+
+ """
+ The user who initiated the action
+ """
+ actor: AuditEntryActor
+
+ """
+ The IP address of the actor
+ """
+ actorIp: String
+
+ """
+ A readable representation of the actor's location
+ """
+ actorLocation: ActorLocation
+
+ """
+ The username of the user who initiated the action
+ """
+ actorLogin: String
+
+ """
+ The HTTP path for the actor.
+ """
+ actorResourcePath: URI
+
+ """
+ The HTTP URL for the actor.
+ """
+ actorUrl: URI
+
+ """
+ The time the action was initiated
+ """
+ createdAt: PreciseDateTime!
+ id: ID!
+
+ """
+ The corresponding operation type for the action
+ """
+ operationType: OperationType
+
+ """
+ The Organization associated with the Audit Entry.
+ """
+ organization: Organization
+
+ """
+ The name of the Organization.
+ """
+ organizationName: String
+
+ """
+ The HTTP path for the organization
+ """
+ organizationResourcePath: URI
+
+ """
+ The HTTP URL for the organization
+ """
+ organizationUrl: URI
+
+ """
+ The reason for the billing manager being removed.
+ """
+ reason: OrgRemoveBillingManagerAuditEntryReason
+
+ """
+ The user affected by the action
+ """
+ user: User
+
+ """
+ For actions involving two users, the actor is the initiator and the user is the affected user.
+ """
+ userLogin: String
+
+ """
+ The HTTP path for the user.
+ """
+ userResourcePath: URI
+
+ """
+ The HTTP URL for the user.
+ """
+ userUrl: URI
+}
+
+"""
+The reason a billing manager was removed from an Organization.
+"""
+enum OrgRemoveBillingManagerAuditEntryReason {
+ """
+ SAML external identity missing
+ """
+ SAML_EXTERNAL_IDENTITY_MISSING
+
+ """
+ SAML SSO enforcement requires an external identity
+ """
+ SAML_SSO_ENFORCEMENT_REQUIRES_EXTERNAL_IDENTITY
+
+ """
+ The organization required 2FA of its billing managers and this user did not have 2FA enabled.
+ """
+ TWO_FACTOR_REQUIREMENT_NON_COMPLIANCE
+}
+
+"""
+Audit log entry for a org.remove_member event.
+"""
+type OrgRemoveMemberAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData {
+ """
+ The action name
+ """
+ action: String!
+
+ """
+ The user who initiated the action
+ """
+ actor: AuditEntryActor
+
+ """
+ The IP address of the actor
+ """
+ actorIp: String
+
+ """
+ A readable representation of the actor's location
+ """
+ actorLocation: ActorLocation
+
+ """
+ The username of the user who initiated the action
+ """
+ actorLogin: String
+
+ """
+ The HTTP path for the actor.
+ """
+ actorResourcePath: URI
+
+ """
+ The HTTP URL for the actor.
+ """
+ actorUrl: URI
+
+ """
+ The time the action was initiated
+ """
+ createdAt: PreciseDateTime!
+ id: ID!
+
+ """
+ The types of membership the member has with the organization.
+ """
+ membershipTypes: [OrgRemoveMemberAuditEntryMembershipType!]
+
+ """
+ The corresponding operation type for the action
+ """
+ operationType: OperationType
+
+ """
+ The Organization associated with the Audit Entry.
+ """
+ organization: Organization
+
+ """
+ The name of the Organization.
+ """
+ organizationName: String
+
+ """
+ The HTTP path for the organization
+ """
+ organizationResourcePath: URI
+
+ """
+ The HTTP URL for the organization
+ """
+ organizationUrl: URI
+
+ """
+ The reason for the member being removed.
+ """
+ reason: OrgRemoveMemberAuditEntryReason
+
+ """
+ The user affected by the action
+ """
+ user: User
+
+ """
+ For actions involving two users, the actor is the initiator and the user is the affected user.
+ """
+ userLogin: String
+
+ """
+ The HTTP path for the user.
+ """
+ userResourcePath: URI
+
+ """
+ The HTTP URL for the user.
+ """
+ userUrl: URI
+}
+
+"""
+The type of membership a user has with an Organization.
+"""
+enum OrgRemoveMemberAuditEntryMembershipType {
+ """
+ Organization administrators have full access and can change several settings,
+ including the names of repositories that belong to the Organization and Owners
+ team membership. In addition, organization admins can delete the organization
+ and all of its repositories.
+ """
+ ADMIN
+
+ """
+ A billing manager is a user who manages the billing settings for the Organization, such as updating payment information.
+ """
+ BILLING_MANAGER
+
+ """
+ A direct member is a user that is a member of the Organization.
+ """
+ DIRECT_MEMBER
+
+ """
+ An outside collaborator is a person who isn't explicitly a member of the
+ Organization, but who has Read, Write, or Admin permissions to one or more
+ repositories in the organization.
+ """
+ OUTSIDE_COLLABORATOR
+
+ """
+ An unaffiliated collaborator is a person who is not a member of the
+ Organization and does not have access to any repositories in the Organization.
+ """
+ UNAFFILIATED
+}
+
+"""
+The reason a member was removed from an Organization.
+"""
+enum OrgRemoveMemberAuditEntryReason {
+ """
+ SAML external identity missing
+ """
+ SAML_EXTERNAL_IDENTITY_MISSING
+
+ """
+ SAML SSO enforcement requires an external identity
+ """
+ SAML_SSO_ENFORCEMENT_REQUIRES_EXTERNAL_IDENTITY
+
+ """
+ User was removed from organization during account recovery
+ """
+ TWO_FACTOR_ACCOUNT_RECOVERY
+
+ """
+ The organization required 2FA of its billing managers and this user did not have 2FA enabled.
+ """
+ TWO_FACTOR_REQUIREMENT_NON_COMPLIANCE
+
+ """
+ User account has been deleted
+ """
+ USER_ACCOUNT_DELETED
+}
+
+"""
+Audit log entry for a org.remove_outside_collaborator event.
+"""
+type OrgRemoveOutsideCollaboratorAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData {
+ """
+ The action name
+ """
+ action: String!
+
+ """
+ The user who initiated the action
+ """
+ actor: AuditEntryActor
+
+ """
+ The IP address of the actor
+ """
+ actorIp: String
+
+ """
+ A readable representation of the actor's location
+ """
+ actorLocation: ActorLocation
+
+ """
+ The username of the user who initiated the action
+ """
+ actorLogin: String
+
+ """
+ The HTTP path for the actor.
+ """
+ actorResourcePath: URI
+
+ """
+ The HTTP URL for the actor.
+ """
+ actorUrl: URI
+
+ """
+ The time the action was initiated
+ """
+ createdAt: PreciseDateTime!
+ id: ID!
+
+ """
+ The types of membership the outside collaborator has with the organization.
+ """
+ membershipTypes: [OrgRemoveOutsideCollaboratorAuditEntryMembershipType!]
+
+ """
+ The corresponding operation type for the action
+ """
+ operationType: OperationType
+
+ """
+ The Organization associated with the Audit Entry.
+ """
+ organization: Organization
+
+ """
+ The name of the Organization.
+ """
+ organizationName: String
+
+ """
+ The HTTP path for the organization
+ """
+ organizationResourcePath: URI
+
+ """
+ The HTTP URL for the organization
+ """
+ organizationUrl: URI
+
+ """
+ The reason for the outside collaborator being removed from the Organization.
+ """
+ reason: OrgRemoveOutsideCollaboratorAuditEntryReason
+
+ """
+ The user affected by the action
+ """
+ user: User
+
+ """
+ For actions involving two users, the actor is the initiator and the user is the affected user.
+ """
+ userLogin: String
+
+ """
+ The HTTP path for the user.
+ """
+ userResourcePath: URI
+
+ """
+ The HTTP URL for the user.
+ """
+ userUrl: URI
+}
+
+"""
+The type of membership a user has with an Organization.
+"""
+enum OrgRemoveOutsideCollaboratorAuditEntryMembershipType {
+ """
+ A billing manager is a user who manages the billing settings for the Organization, such as updating payment information.
+ """
+ BILLING_MANAGER
+
+ """
+ An outside collaborator is a person who isn't explicitly a member of the
+ Organization, but who has Read, Write, or Admin permissions to one or more
+ repositories in the organization.
+ """
+ OUTSIDE_COLLABORATOR
+
+ """
+ An unaffiliated collaborator is a person who is not a member of the
+ Organization and does not have access to any repositories in the organization.
+ """
+ UNAFFILIATED
+}
+
+"""
+The reason an outside collaborator was removed from an Organization.
+"""
+enum OrgRemoveOutsideCollaboratorAuditEntryReason {
+ """
+ SAML external identity missing
+ """
+ SAML_EXTERNAL_IDENTITY_MISSING
+
+ """
+ The organization required 2FA of its billing managers and this user did not have 2FA enabled.
+ """
+ TWO_FACTOR_REQUIREMENT_NON_COMPLIANCE
+}
+
+"""
+Audit log entry for a org.restore_member event.
+"""
+type OrgRestoreMemberAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData {
+ """
+ The action name
+ """
+ action: String!
+
+ """
+ The user who initiated the action
+ """
+ actor: AuditEntryActor
+
+ """
+ The IP address of the actor
+ """
+ actorIp: String
+
+ """
+ A readable representation of the actor's location
+ """
+ actorLocation: ActorLocation
+
+ """
+ The username of the user who initiated the action
+ """
+ actorLogin: String
+
+ """
+ The HTTP path for the actor.
+ """
+ actorResourcePath: URI
+
+ """
+ The HTTP URL for the actor.
+ """
+ actorUrl: URI
+
+ """
+ The time the action was initiated
+ """
+ createdAt: PreciseDateTime!
+ id: ID!
+
+ """
+ The corresponding operation type for the action
+ """
+ operationType: OperationType
+
+ """
+ The Organization associated with the Audit Entry.
+ """
+ organization: Organization
+
+ """
+ The name of the Organization.
+ """
+ organizationName: String
+
+ """
+ The HTTP path for the organization
+ """
+ organizationResourcePath: URI
+
+ """
+ The HTTP URL for the organization
+ """
+ organizationUrl: URI
+
+ """
+ The number of custom email routings for the restored member.
+ """
+ restoredCustomEmailRoutingsCount: Int
+
+ """
+ The number of issue assignemnts for the restored member.
+ """
+ restoredIssueAssignmentsCount: Int
+
+ """
+ Restored organization membership objects.
+ """
+ restoredMemberships: [OrgRestoreMemberAuditEntryMembership!]
+
+ """
+ The number of restored memberships.
+ """
+ restoredMembershipsCount: Int
+
+ """
+ The number of repositories of the restored member.
+ """
+ restoredRepositoriesCount: Int
+
+ """
+ The number of starred repositories for the restored member.
+ """
+ restoredRepositoryStarsCount: Int
+
+ """
+ The number of watched repositories for the restored member.
+ """
+ restoredRepositoryWatchesCount: Int
+
+ """
+ The user affected by the action
+ """
+ user: User
+
+ """
+ For actions involving two users, the actor is the initiator and the user is the affected user.
+ """
+ userLogin: String
+
+ """
+ The HTTP path for the user.
+ """
+ userResourcePath: URI
+
+ """
+ The HTTP URL for the user.
+ """
+ userUrl: URI
+}
+
+"""
+Types of memberships that can be restored for an Organization member.
+"""
+union OrgRestoreMemberAuditEntryMembership = OrgRestoreMemberMembershipOrganizationAuditEntryData | OrgRestoreMemberMembershipRepositoryAuditEntryData | OrgRestoreMemberMembershipTeamAuditEntryData
+
+"""
+Metadata for an organization membership for org.restore_member actions
+"""
+type OrgRestoreMemberMembershipOrganizationAuditEntryData implements OrganizationAuditEntryData {
+ """
+ The Organization associated with the Audit Entry.
+ """
+ organization: Organization
+
+ """
+ The name of the Organization.
+ """
+ organizationName: String
+
+ """
+ The HTTP path for the organization
+ """
+ organizationResourcePath: URI
+
+ """
+ The HTTP URL for the organization
+ """
+ organizationUrl: URI
+}
+
+"""
+Metadata for a repository membership for org.restore_member actions
+"""
+type OrgRestoreMemberMembershipRepositoryAuditEntryData implements RepositoryAuditEntryData {
+ """
+ The repository associated with the action
+ """
+ repository: Repository
+
+ """
+ The name of the repository
+ """
+ repositoryName: String
+
+ """
+ The HTTP path for the repository
+ """
+ repositoryResourcePath: URI
+
+ """
+ The HTTP URL for the repository
+ """
+ repositoryUrl: URI
+}
+
+"""
+Metadata for a team membership for org.restore_member actions
+"""
+type OrgRestoreMemberMembershipTeamAuditEntryData implements TeamAuditEntryData {
+ """
+ The team associated with the action
+ """
+ team: Team
+
+ """
+ The name of the team
+ """
+ teamName: String
+
+ """
+ The HTTP path for this team
+ """
+ teamResourcePath: URI
+
+ """
+ The HTTP URL for this team
+ """
+ teamUrl: URI
+}
+
+"""
+Audit log entry for a org.unblock_user
+"""
+type OrgUnblockUserAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData {
+ """
+ The action name
+ """
+ action: String!
+
+ """
+ The user who initiated the action
+ """
+ actor: AuditEntryActor
+
+ """
+ The IP address of the actor
+ """
+ actorIp: String
+
+ """
+ A readable representation of the actor's location
+ """
+ actorLocation: ActorLocation
+
+ """
+ The username of the user who initiated the action
+ """
+ actorLogin: String
+
+ """
+ The HTTP path for the actor.
+ """
+ actorResourcePath: URI
+
+ """
+ The HTTP URL for the actor.
+ """
+ actorUrl: URI
+
+ """
+ The user being unblocked by the organization.
+ """
+ blockedUser: User
+
+ """
+ The username of the blocked user.
+ """
+ blockedUserName: String
+
+ """
+ The HTTP path for the blocked user.
+ """
+ blockedUserResourcePath: URI
+
+ """
+ The HTTP URL for the blocked user.
+ """
+ blockedUserUrl: URI
+
+ """
+ The time the action was initiated
+ """
+ createdAt: PreciseDateTime!
+ id: ID!
+
+ """
+ The corresponding operation type for the action
+ """
+ operationType: OperationType
+
+ """
+ The Organization associated with the Audit Entry.
+ """
+ organization: Organization
+
+ """
+ The name of the Organization.
+ """
+ organizationName: String
+
+ """
+ The HTTP path for the organization
+ """
+ organizationResourcePath: URI
+
+ """
+ The HTTP URL for the organization
+ """
+ organizationUrl: URI
+
+ """
+ The user affected by the action
+ """
+ user: User
+
+ """
+ For actions involving two users, the actor is the initiator and the user is the affected user.
+ """
+ userLogin: String
+
+ """
+ The HTTP path for the user.
+ """
+ userResourcePath: URI
+
+ """
+ The HTTP URL for the user.
+ """
+ userUrl: URI
+}
+
+"""
+Audit log entry for a org.update_default_repository_permission
+"""
+type OrgUpdateDefaultRepositoryPermissionAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData {
+ """
+ The action name
+ """
+ action: String!
+
+ """
+ The user who initiated the action
+ """
+ actor: AuditEntryActor
+
+ """
+ The IP address of the actor
+ """
+ actorIp: String
+
+ """
+ A readable representation of the actor's location
+ """
+ actorLocation: ActorLocation
+
+ """
+ The username of the user who initiated the action
+ """
+ actorLogin: String
+
+ """
+ The HTTP path for the actor.
+ """
+ actorResourcePath: URI
+
+ """
+ The HTTP URL for the actor.
+ """
+ actorUrl: URI
+
+ """
+ The time the action was initiated
+ """
+ createdAt: PreciseDateTime!
+ id: ID!
+
+ """
+ The corresponding operation type for the action
+ """
+ operationType: OperationType
+
+ """
+ The Organization associated with the Audit Entry.
+ """
+ organization: Organization
+
+ """
+ The name of the Organization.
+ """
+ organizationName: String
+
+ """
+ The HTTP path for the organization
+ """
+ organizationResourcePath: URI
+
+ """
+ The HTTP URL for the organization
+ """
+ organizationUrl: URI
+
+ """
+ The new default repository permission level for the organization.
+ """
+ permission: OrgUpdateDefaultRepositoryPermissionAuditEntryPermission
+
+ """
+ The former default repository permission level for the organization.
+ """
+ permissionWas: OrgUpdateDefaultRepositoryPermissionAuditEntryPermission
+
+ """
+ The user affected by the action
+ """
+ user: User
+
+ """
+ For actions involving two users, the actor is the initiator and the user is the affected user.
+ """
+ userLogin: String
+
+ """
+ The HTTP path for the user.
+ """
+ userResourcePath: URI
+
+ """
+ The HTTP URL for the user.
+ """
+ userUrl: URI
+}
+
+"""
+The default permission a repository can have in an Organization.
+"""
+enum OrgUpdateDefaultRepositoryPermissionAuditEntryPermission {
+ """
+ Can read, clone, push, and add collaborators to repositories.
+ """
+ ADMIN
+
+ """
+ No default permission value.
+ """
+ NONE
+
+ """
+ Can read and clone repositories.
+ """
+ READ
+
+ """
+ Can read, clone and push to repositories.
+ """
+ WRITE
+}
+
+"""
+Audit log entry for a org.update_member event.
+"""
+type OrgUpdateMemberAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData {
+ """
+ The action name
+ """
+ action: String!
+
+ """
+ The user who initiated the action
+ """
+ actor: AuditEntryActor
+
+ """
+ The IP address of the actor
+ """
+ actorIp: String
+
+ """
+ A readable representation of the actor's location
+ """
+ actorLocation: ActorLocation
+
+ """
+ The username of the user who initiated the action
+ """
+ actorLogin: String
+
+ """
+ The HTTP path for the actor.
+ """
+ actorResourcePath: URI
+
+ """
+ The HTTP URL for the actor.
+ """
+ actorUrl: URI
+
+ """
+ The time the action was initiated
+ """
+ createdAt: PreciseDateTime!
+ id: ID!
+
+ """
+ The corresponding operation type for the action
+ """
+ operationType: OperationType
+
+ """
+ The Organization associated with the Audit Entry.
+ """
+ organization: Organization
+
+ """
+ The name of the Organization.
+ """
+ organizationName: String
+
+ """
+ The HTTP path for the organization
+ """
+ organizationResourcePath: URI
+
+ """
+ The HTTP URL for the organization
+ """
+ organizationUrl: URI
+
+ """
+ The new member permission level for the organization.
+ """
+ permission: OrgUpdateMemberAuditEntryPermission
+
+ """
+ The former member permission level for the organization.
+ """
+ permissionWas: OrgUpdateMemberAuditEntryPermission
+
+ """
+ The user affected by the action
+ """
+ user: User
+
+ """
+ For actions involving two users, the actor is the initiator and the user is the affected user.
+ """
+ userLogin: String
+
+ """
+ The HTTP path for the user.
+ """
+ userResourcePath: URI
+
+ """
+ The HTTP URL for the user.
+ """
+ userUrl: URI
+}
+
+"""
+The permissions available to members on an Organization.
+"""
+enum OrgUpdateMemberAuditEntryPermission {
+ """
+ Can read, clone, push, and add collaborators to repositories.
+ """
+ ADMIN
+
+ """
+ Can read and clone repositories.
+ """
+ READ
+}
+
+"""
+Audit log entry for a org.update_member_repository_creation_permission event.
+"""
+type OrgUpdateMemberRepositoryCreationPermissionAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData {
+ """
+ The action name
+ """
+ action: String!
+
+ """
+ The user who initiated the action
+ """
+ actor: AuditEntryActor
+
+ """
+ The IP address of the actor
+ """
+ actorIp: String
+
+ """
+ A readable representation of the actor's location
+ """
+ actorLocation: ActorLocation
+
+ """
+ The username of the user who initiated the action
+ """
+ actorLogin: String
+
+ """
+ The HTTP path for the actor.
+ """
+ actorResourcePath: URI
+
+ """
+ The HTTP URL for the actor.
+ """
+ actorUrl: URI
+
+ """
+ Can members create repositories in the organization.
+ """
+ canCreateRepositories: Boolean
+
+ """
+ The time the action was initiated
+ """
+ createdAt: PreciseDateTime!
+ id: ID!
+
+ """
+ The corresponding operation type for the action
+ """
+ operationType: OperationType
+
+ """
+ The Organization associated with the Audit Entry.
+ """
+ organization: Organization
+
+ """
+ The name of the Organization.
+ """
+ organizationName: String
+
+ """
+ The HTTP path for the organization
+ """
+ organizationResourcePath: URI
+
+ """
+ The HTTP URL for the organization
+ """
+ organizationUrl: URI
+
+ """
+ The user affected by the action
+ """
+ user: User
+
+ """
+ For actions involving two users, the actor is the initiator and the user is the affected user.
+ """
+ userLogin: String
+
+ """
+ The HTTP path for the user.
+ """
+ userResourcePath: URI
+
+ """
+ The HTTP URL for the user.
+ """
+ userUrl: URI
+
+ """
+ The permission for visibility level of repositories for this organization.
+ """
+ visibility: OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility
+}
+
+"""
+The permissions available for repository creation on an Organization.
+"""
+enum OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility {
+ """
+ All organization members are restricted from creating any repositories.
+ """
+ ALL
+
+ """
+ All organization members are restricted from creating internal repositories.
+ """
+ INTERNAL
+
+ """
+ All organization members are allowed to create any repositories.
+ """
+ NONE
+
+ """
+ All organization members are restricted from creating private repositories.
+ """
+ PRIVATE
+
+ """
+ All organization members are restricted from creating private or internal repositories.
+ """
+ PRIVATE_INTERNAL
+
+ """
+ All organization members are restricted from creating public repositories.
+ """
+ PUBLIC
+
+ """
+ All organization members are restricted from creating public or internal repositories.
+ """
+ PUBLIC_INTERNAL
+
+ """
+ All organization members are restricted from creating public or private repositories.
+ """
+ PUBLIC_PRIVATE
+}
+
+"""
+Audit log entry for a org.update_member_repository_invitation_permission event.
+"""
+type OrgUpdateMemberRepositoryInvitationPermissionAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData {
+ """
+ The action name
+ """
+ action: String!
+
+ """
+ The user who initiated the action
+ """
+ actor: AuditEntryActor
+
+ """
+ The IP address of the actor
+ """
+ actorIp: String
+
+ """
+ A readable representation of the actor's location
+ """
+ actorLocation: ActorLocation
+
+ """
+ The username of the user who initiated the action
+ """
+ actorLogin: String
+
+ """
+ The HTTP path for the actor.
+ """
+ actorResourcePath: URI
+
+ """
+ The HTTP URL for the actor.
+ """
+ actorUrl: URI
+
+ """
+ Can outside collaborators be invited to repositories in the organization.
+ """
+ canInviteOutsideCollaboratorsToRepositories: Boolean
+
+ """
+ The time the action was initiated
+ """
+ createdAt: PreciseDateTime!
+ id: ID!
+
+ """
+ The corresponding operation type for the action
+ """
+ operationType: OperationType
+
+ """
+ The Organization associated with the Audit Entry.
+ """
+ organization: Organization
+
+ """
+ The name of the Organization.
+ """
+ organizationName: String
+
+ """
+ The HTTP path for the organization
+ """
+ organizationResourcePath: URI
+
+ """
+ The HTTP URL for the organization
+ """
+ organizationUrl: URI
+
+ """
+ The user affected by the action
+ """
+ user: User
+
+ """
+ For actions involving two users, the actor is the initiator and the user is the affected user.
+ """
+ userLogin: String
+
+ """
+ The HTTP path for the user.
+ """
+ userResourcePath: URI
+
+ """
+ The HTTP URL for the user.
+ """
+ userUrl: URI
+}
+
+"""
+An account on GitHub, with one or more owners, that has repositories, members and teams.
+"""
+type Organization implements Actor & MemberStatusable & Node & ProfileOwner & ProjectOwner & RepositoryOwner & Sponsorable & UniformResourceLocatable {
+ """
+ Determine if this repository owner has any items that can be pinned to their profile.
+ """
+ anyPinnableItems(
+ """
+ Filter to only a particular kind of pinnable item.
+ """
+ type: PinnableItemType
+ ): Boolean!
+
+ """
+ Audit log entries of the organization
+ """
+ auditLog(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Ordering options for the returned audit log entries.
+ """
+ orderBy: AuditLogOrder = {field: CREATED_AT, direction: DESC}
+
+ """
+ The query string to filter audit entries
+ """
+ query: String
+ ): OrganizationAuditEntryConnection!
+
+ """
+ A URL pointing to the organization's public avatar.
+ """
+ avatarUrl(
+ """
+ The size of the resulting square image.
+ """
+ size: Int
+ ): URI!
+
+ """
+ Identifies the date and time when the object was created.
+ """
+ createdAt: DateTime!
+
+ """
+ Identifies the primary key from the database.
+ """
+ databaseId: Int
+
+ """
+ The organization's public profile description.
+ """
+ description: String
+
+ """
+ The organization's public profile description rendered to HTML.
+ """
+ descriptionHTML: String
+
+ """
+ The organization's public email.
+ """
+ email: String
+ id: ID!
+
+ """
+ The setting value for whether the organization has an IP allow list enabled.
+ """
+ ipAllowListEnabledSetting: IpAllowListEnabledSettingValue!
+
+ """
+ The IP addresses that are allowed to access resources owned by the organization.
+ """
+ ipAllowListEntries(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Ordering options for IP allow list entries returned.
+ """
+ orderBy: IpAllowListEntryOrder = {field: ALLOW_LIST_VALUE, direction: ASC}
+ ): IpAllowListEntryConnection!
+
+ """
+ Whether the organization has verified its profile email and website, always false on Enterprise.
+ """
+ isVerified: Boolean!
+
+ """
+ Showcases a selection of repositories and gists that the profile owner has
+ either curated or that have been selected automatically based on popularity.
+ """
+ itemShowcase: ProfileItemShowcase!
+
+ """
+ The organization's public profile location.
+ """
+ location: String
+
+ """
+ The organization's login name.
+ """
+ login: String!
+
+ """
+ Get the status messages members of this entity have set that are either public or visible only to the organization.
+ """
+ memberStatuses(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Ordering options for user statuses returned from the connection.
+ """
+ orderBy: UserStatusOrder = {field: UPDATED_AT, direction: DESC}
+ ): UserStatusConnection!
+
+ """
+ A list of users who are members of this organization.
+ """
+ membersWithRole(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): OrganizationMemberConnection!
+
+ """
+ The organization's public profile name.
+ """
+ name: String
+
+ """
+ The HTTP path creating a new team
+ """
+ newTeamResourcePath: URI!
+
+ """
+ The HTTP URL creating a new team
+ """
+ newTeamUrl: URI!
+
+ """
+ The billing email for the organization.
+ """
+ organizationBillingEmail: String
+
+ """
+ A list of users who have been invited to join this organization.
+ """
+ pendingMembers(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): UserConnection!
+
+ """
+ A list of repositories and gists this profile owner can pin to their profile.
+ """
+ pinnableItems(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Filter the types of pinnable items that are returned.
+ """
+ types: [PinnableItemType!]
+ ): PinnableItemConnection!
+
+ """
+ A list of repositories and gists this profile owner has pinned to their profile
+ """
+ pinnedItems(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Filter the types of pinned items that are returned.
+ """
+ types: [PinnableItemType!]
+ ): PinnableItemConnection!
+
+ """
+ Returns how many more items this profile owner can pin to their profile.
+ """
+ pinnedItemsRemaining: Int!
+
+ """
+ Find project by number.
+ """
+ project(
+ """
+ The project number to find.
+ """
+ number: Int!
+ ): Project
+
+ """
+ A list of projects under the owner.
+ """
+ projects(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Ordering options for projects returned from the connection
+ """
+ orderBy: ProjectOrder
+
+ """
+ Query to search projects by, currently only searching by name.
+ """
+ search: String
+
+ """
+ A list of states to filter the projects by.
+ """
+ states: [ProjectState!]
+ ): ProjectConnection!
+
+ """
+ The HTTP path listing organization's projects
+ """
+ projectsResourcePath: URI!
+
+ """
+ The HTTP URL listing organization's projects
+ """
+ projectsUrl: URI!
+
+ """
+ A list of repositories that the user owns.
+ """
+ repositories(
+ """
+ Array of viewer's affiliation options for repositories returned from the
+ connection. For example, OWNER will include only repositories that the
+ current viewer owns.
+ """
+ affiliations: [RepositoryAffiliation]
+
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ If non-null, filters repositories according to whether they are forks of another repository
+ """
+ isFork: Boolean
+
+ """
+ If non-null, filters repositories according to whether they have been locked
+ """
+ isLocked: Boolean
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Ordering options for repositories returned from the connection
+ """
+ orderBy: RepositoryOrder
+
+ """
+ Array of owner's affiliation options for repositories returned from the
+ connection. For example, OWNER will include only repositories that the
+ organization or user being viewed owns.
+ """
+ ownerAffiliations: [RepositoryAffiliation] = [OWNER, COLLABORATOR]
+
+ """
+ If non-null, filters repositories according to privacy
+ """
+ privacy: RepositoryPrivacy
+ ): RepositoryConnection!
+
+ """
+ Find Repository.
+ """
+ repository(
+ """
+ Name of Repository to find.
+ """
+ name: String!
+ ): Repository
+
+ """
+ When true the organization requires all members, billing managers, and outside
+ collaborators to enable two-factor authentication.
+ """
+ requiresTwoFactorAuthentication: Boolean
+
+ """
+ The HTTP path for this organization.
+ """
+ resourcePath: URI!
+
+ """
+ The Organization's SAML identity providers
+ """
+ samlIdentityProvider: OrganizationIdentityProvider
+
+ """
+ This object's sponsorships as the maintainer.
+ """
+ sponsorshipsAsMaintainer(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Whether or not to include private sponsorships in the result set
+ """
+ includePrivate: Boolean = false
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Ordering options for sponsorships returned from this connection. If left
+ blank, the sponsorships will be ordered based on relevancy to the viewer.
+ """
+ orderBy: SponsorshipOrder
+ ): SponsorshipConnection!
+
+ """
+ This object's sponsorships as the sponsor.
+ """
+ sponsorshipsAsSponsor(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Ordering options for sponsorships returned from this connection. If left
+ blank, the sponsorships will be ordered based on relevancy to the viewer.
+ """
+ orderBy: SponsorshipOrder
+ ): SponsorshipConnection!
+
+ """
+ Find an organization's team by its slug.
+ """
+ team(
+ """
+ The name or slug of the team to find.
+ """
+ slug: String!
+ ): Team
+
+ """
+ A list of teams in this organization.
+ """
+ teams(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ If true, filters teams that are mapped to an LDAP Group (Enterprise only)
+ """
+ ldapMapped: Boolean
+
+ """
+ Ordering options for teams returned from the connection
+ """
+ orderBy: TeamOrder
+
+ """
+ If non-null, filters teams according to privacy
+ """
+ privacy: TeamPrivacy
+
+ """
+ If non-null, filters teams with query on team name and team slug
+ """
+ query: String
+
+ """
+ If non-null, filters teams according to whether the viewer is an admin or member on team
+ """
+ role: TeamRole
+
+ """
+ If true, restrict to only root teams
+ """
+ rootTeamsOnly: Boolean = false
+
+ """
+ User logins to filter by
+ """
+ userLogins: [String!]
+ ): TeamConnection!
+
+ """
+ The HTTP path listing organization's teams
+ """
+ teamsResourcePath: URI!
+
+ """
+ The HTTP URL listing organization's teams
+ """
+ teamsUrl: URI!
+
+ """
+ The organization's Twitter username.
+ """
+ twitterUsername: String
+
+ """
+ Identifies the date and time when the object was last updated.
+ """
+ updatedAt: DateTime!
+
+ """
+ The HTTP URL for this organization.
+ """
+ url: URI!
+
+ """
+ Organization is adminable by the viewer.
+ """
+ viewerCanAdminister: Boolean!
+
+ """
+ Can the viewer pin repositories and gists to the profile?
+ """
+ viewerCanChangePinnedItems: Boolean!
+
+ """
+ Can the current viewer create new projects on this owner.
+ """
+ viewerCanCreateProjects: Boolean!
+
+ """
+ Viewer can create repositories on this organization
+ """
+ viewerCanCreateRepositories: Boolean!
+
+ """
+ Viewer can create teams on this organization.
+ """
+ viewerCanCreateTeams: Boolean!
+
+ """
+ Viewer is an active member of this organization.
+ """
+ viewerIsAMember: Boolean!
+
+ """
+ The organization's public profile URL.
+ """
+ websiteUrl: URI
+}
+
+"""
+An audit entry in an organization audit log.
+"""
+union OrganizationAuditEntry = MembersCanDeleteReposClearAuditEntry | MembersCanDeleteReposDisableAuditEntry | MembersCanDeleteReposEnableAuditEntry | OauthApplicationCreateAuditEntry | OrgAddBillingManagerAuditEntry | OrgAddMemberAuditEntry | OrgBlockUserAuditEntry | OrgConfigDisableCollaboratorsOnlyAuditEntry | OrgConfigEnableCollaboratorsOnlyAuditEntry | OrgCreateAuditEntry | OrgDisableOauthAppRestrictionsAuditEntry | OrgDisableSamlAuditEntry | OrgDisableTwoFactorRequirementAuditEntry | OrgEnableOauthAppRestrictionsAuditEntry | OrgEnableSamlAuditEntry | OrgEnableTwoFactorRequirementAuditEntry | OrgInviteMemberAuditEntry | OrgInviteToBusinessAuditEntry | OrgOauthAppAccessApprovedAuditEntry | OrgOauthAppAccessDeniedAuditEntry | OrgOauthAppAccessRequestedAuditEntry | OrgRemoveBillingManagerAuditEntry | OrgRemoveMemberAuditEntry | OrgRemoveOutsideCollaboratorAuditEntry | OrgRestoreMemberAuditEntry | OrgUnblockUserAuditEntry | OrgUpdateDefaultRepositoryPermissionAuditEntry | OrgUpdateMemberAuditEntry | OrgUpdateMemberRepositoryCreationPermissionAuditEntry | OrgUpdateMemberRepositoryInvitationPermissionAuditEntry | PrivateRepositoryForkingDisableAuditEntry | PrivateRepositoryForkingEnableAuditEntry | RepoAccessAuditEntry | RepoAddMemberAuditEntry | RepoAddTopicAuditEntry | RepoArchivedAuditEntry | RepoChangeMergeSettingAuditEntry | RepoConfigDisableAnonymousGitAccessAuditEntry | RepoConfigDisableCollaboratorsOnlyAuditEntry | RepoConfigDisableContributorsOnlyAuditEntry | RepoConfigDisableSockpuppetDisallowedAuditEntry | RepoConfigEnableAnonymousGitAccessAuditEntry | RepoConfigEnableCollaboratorsOnlyAuditEntry | RepoConfigEnableContributorsOnlyAuditEntry | RepoConfigEnableSockpuppetDisallowedAuditEntry | RepoConfigLockAnonymousGitAccessAuditEntry | RepoConfigUnlockAnonymousGitAccessAuditEntry | RepoCreateAuditEntry | RepoDestroyAuditEntry | RepoRemoveMemberAuditEntry | RepoRemoveTopicAuditEntry | RepositoryVisibilityChangeDisableAuditEntry | RepositoryVisibilityChangeEnableAuditEntry | TeamAddMemberAuditEntry | TeamAddRepositoryAuditEntry | TeamChangeParentTeamAuditEntry | TeamRemoveMemberAuditEntry | TeamRemoveRepositoryAuditEntry
+
+"""
+The connection type for OrganizationAuditEntry.
+"""
+type OrganizationAuditEntryConnection {
+ """
+ A list of edges.
+ """
+ edges: [OrganizationAuditEntryEdge]
+
+ """
+ A list of nodes.
+ """
+ nodes: [OrganizationAuditEntry]
+
+ """
+ Information to aid in pagination.
+ """
+ pageInfo: PageInfo!
+
+ """
+ Identifies the total count of items in the connection.
+ """
+ totalCount: Int!
+}
+
+"""
+Metadata for an audit entry with action org.*
+"""
+interface OrganizationAuditEntryData {
+ """
+ The Organization associated with the Audit Entry.
+ """
+ organization: Organization
+
+ """
+ The name of the Organization.
+ """
+ organizationName: String
+
+ """
+ The HTTP path for the organization
+ """
+ organizationResourcePath: URI
+
+ """
+ The HTTP URL for the organization
+ """
+ organizationUrl: URI
+}
+
+"""
+An edge in a connection.
+"""
+type OrganizationAuditEntryEdge {
+ """
+ A cursor for use in pagination.
+ """
+ cursor: String!
+
+ """
+ The item at the end of the edge.
+ """
+ node: OrganizationAuditEntry
+}
+
+"""
+The connection type for Organization.
+"""
+type OrganizationConnection {
+ """
+ A list of edges.
+ """
+ edges: [OrganizationEdge]
+
+ """
+ A list of nodes.
+ """
+ nodes: [Organization]
+
+ """
+ Information to aid in pagination.
+ """
+ pageInfo: PageInfo!
+
+ """
+ Identifies the total count of items in the connection.
+ """
+ totalCount: Int!
+}
+
+"""
+An edge in a connection.
+"""
+type OrganizationEdge {
+ """
+ A cursor for use in pagination.
+ """
+ cursor: String!
+
+ """
+ The item at the end of the edge.
+ """
+ node: Organization
+}
+
+"""
+An Identity Provider configured to provision SAML and SCIM identities for Organizations
+"""
+type OrganizationIdentityProvider implements Node {
+ """
+ The digest algorithm used to sign SAML requests for the Identity Provider.
+ """
+ digestMethod: URI
+
+ """
+ External Identities provisioned by this Identity Provider
+ """
+ externalIdentities(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): ExternalIdentityConnection!
+ id: ID!
+
+ """
+ The x509 certificate used by the Identity Provder to sign assertions and responses.
+ """
+ idpCertificate: X509Certificate
+
+ """
+ The Issuer Entity ID for the SAML Identity Provider
+ """
+ issuer: String
+
+ """
+ Organization this Identity Provider belongs to
+ """
+ organization: Organization
+
+ """
+ The signature algorithm used to sign SAML requests for the Identity Provider.
+ """
+ signatureMethod: URI
+
+ """
+ The URL endpoint for the Identity Provider's SAML SSO.
+ """
+ ssoUrl: URI
+}
+
+"""
+An Invitation for a user to an organization.
+"""
+type OrganizationInvitation implements Node {
+ """
+ Identifies the date and time when the object was created.
+ """
+ createdAt: DateTime!
+
+ """
+ The email address of the user invited to the organization.
+ """
+ email: String
+ id: ID!
+
+ """
+ The type of invitation that was sent (e.g. email, user).
+ """
+ invitationType: OrganizationInvitationType!
+
+ """
+ The user who was invited to the organization.
+ """
+ invitee: User
+
+ """
+ The user who created the invitation.
+ """
+ inviter: User!
+
+ """
+ The organization the invite is for
+ """
+ organization: Organization!
+
+ """
+ The user's pending role in the organization (e.g. member, owner).
+ """
+ role: OrganizationInvitationRole!
+}
+
+"""
+The connection type for OrganizationInvitation.
+"""
+type OrganizationInvitationConnection {
+ """
+ A list of edges.
+ """
+ edges: [OrganizationInvitationEdge]
+
+ """
+ A list of nodes.
+ """
+ nodes: [OrganizationInvitation]
+
+ """
+ Information to aid in pagination.
+ """
+ pageInfo: PageInfo!
+
+ """
+ Identifies the total count of items in the connection.
+ """
+ totalCount: Int!
+}
+
+"""
+An edge in a connection.
+"""
+type OrganizationInvitationEdge {
+ """
+ A cursor for use in pagination.
+ """
+ cursor: String!
+
+ """
+ The item at the end of the edge.
+ """
+ node: OrganizationInvitation
+}
+
+"""
+The possible organization invitation roles.
+"""
+enum OrganizationInvitationRole {
+ """
+ The user is invited to be an admin of the organization.
+ """
+ ADMIN
+
+ """
+ The user is invited to be a billing manager of the organization.
+ """
+ BILLING_MANAGER
+
+ """
+ The user is invited to be a direct member of the organization.
+ """
+ DIRECT_MEMBER
+
+ """
+ The user's previous role will be reinstated.
+ """
+ REINSTATE
+}
+
+"""
+The possible organization invitation types.
+"""
+enum OrganizationInvitationType {
+ """
+ The invitation was to an email address.
+ """
+ EMAIL
+
+ """
+ The invitation was to an existing user.
+ """
+ USER
+}
+
+"""
+The connection type for User.
+"""
+type OrganizationMemberConnection {
+ """
+ A list of edges.
+ """
+ edges: [OrganizationMemberEdge]
+
+ """
+ A list of nodes.
+ """
+ nodes: [User]
+
+ """
+ Information to aid in pagination.
+ """
+ pageInfo: PageInfo!
+
+ """
+ Identifies the total count of items in the connection.
+ """
+ totalCount: Int!
+}
+
+"""
+Represents a user within an organization.
+"""
+type OrganizationMemberEdge {
+ """
+ A cursor for use in pagination.
+ """
+ cursor: String!
+
+ """
+ Whether the organization member has two factor enabled or not. Returns null if information is not available to viewer.
+ """
+ hasTwoFactorEnabled: Boolean
+
+ """
+ The item at the end of the edge.
+ """
+ node: User
+
+ """
+ The role this user has in the organization.
+ """
+ role: OrganizationMemberRole
+}
+
+"""
+The possible roles within an organization for its members.
+"""
+enum OrganizationMemberRole {
+ """
+ The user is an administrator of the organization.
+ """
+ ADMIN
+
+ """
+ The user is a member of the organization.
+ """
+ MEMBER
+}
+
+"""
+The possible values for the members can create repositories setting on an organization.
+"""
+enum OrganizationMembersCanCreateRepositoriesSettingValue {
+ """
+ Members will be able to create public and private repositories.
+ """
+ ALL
+
+ """
+ Members will not be able to create public or private repositories.
+ """
+ DISABLED
+
+ """
+ Members will be able to create only private repositories.
+ """
+ PRIVATE
+}
+
+"""
+Ordering options for organization connections.
+"""
+input OrganizationOrder {
+ """
+ The ordering direction.
+ """
+ direction: OrderDirection!
+
+ """
+ The field to order organizations by.
+ """
+ field: OrganizationOrderField!
+}
+
+"""
+Properties by which organization connections can be ordered.
+"""
+enum OrganizationOrderField {
+ """
+ Order organizations by creation time
+ """
+ CREATED_AT
+
+ """
+ Order organizations by login
+ """
+ LOGIN
+}
+
+"""
+An organization teams hovercard context
+"""
+type OrganizationTeamsHovercardContext implements HovercardContext {
+ """
+ A string describing this context
+ """
+ message: String!
+
+ """
+ An octicon to accompany this context
+ """
+ octicon: String!
+
+ """
+ Teams in this organization the user is a member of that are relevant
+ """
+ relevantTeams(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): TeamConnection!
+
+ """
+ The path for the full team list for this user
+ """
+ teamsResourcePath: URI!
+
+ """
+ The URL for the full team list for this user
+ """
+ teamsUrl: URI!
+
+ """
+ The total number of teams the user is on in the organization
+ """
+ totalTeamCount: Int!
+}
+
+"""
+An organization list hovercard context
+"""
+type OrganizationsHovercardContext implements HovercardContext {
+ """
+ A string describing this context
+ """
+ message: String!
+
+ """
+ An octicon to accompany this context
+ """
+ octicon: String!
+
+ """
+ Organizations this user is a member of that are relevant
+ """
+ relevantOrganizations(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): OrganizationConnection!
+
+ """
+ The total number of organizations this user is in
+ """
+ totalOrganizationCount: Int!
+}
+
+"""
+Information about pagination in a connection.
+"""
+type PageInfo {
+ """
+ When paginating forwards, the cursor to continue.
+ """
+ endCursor: String
+
+ """
+ When paginating forwards, are there more items?
+ """
+ hasNextPage: Boolean!
+
+ """
+ When paginating backwards, are there more items?
+ """
+ hasPreviousPage: Boolean!
+
+ """
+ When paginating backwards, the cursor to continue.
+ """
+ startCursor: String
+}
+
+"""
+Types that can grant permissions on a repository to a user
+"""
+union PermissionGranter = Organization | Repository | Team
+
+"""
+A level of permission and source for a user's access to a repository.
+"""
+type PermissionSource {
+ """
+ The organization the repository belongs to.
+ """
+ organization: Organization!
+
+ """
+ The level of access this source has granted to the user.
+ """
+ permission: DefaultRepositoryPermissionField!
+
+ """
+ The source of this permission.
+ """
+ source: PermissionGranter!
+}
+
+"""
+Autogenerated input type of PinIssue
+"""
+input PinIssueInput {
+ """
+ A unique identifier for the client performing the mutation.
+ """
+ clientMutationId: String
+
+ """
+ The ID of the issue to be pinned
+ """
+ issueId: ID! @possibleTypes(concreteTypes: ["Issue"])
+}
+
+"""
+Autogenerated return type of PinIssue
+"""
+type PinIssuePayload {
+ """
+ A unique identifier for the client performing the mutation.
+ """
+ clientMutationId: String
+
+ """
+ The issue that was pinned
+ """
+ issue: Issue
+}
+
+"""
+Types that can be pinned to a profile page.
+"""
+union PinnableItem = Gist | Repository
+
+"""
+The connection type for PinnableItem.
+"""
+type PinnableItemConnection {
+ """
+ A list of edges.
+ """
+ edges: [PinnableItemEdge]
+
+ """
+ A list of nodes.
+ """
+ nodes: [PinnableItem]
+
+ """
+ Information to aid in pagination.
+ """
+ pageInfo: PageInfo!
+
+ """
+ Identifies the total count of items in the connection.
+ """
+ totalCount: Int!
+}
+
+"""
+An edge in a connection.
+"""
+type PinnableItemEdge {
+ """
+ A cursor for use in pagination.
+ """
+ cursor: String!
+
+ """
+ The item at the end of the edge.
+ """
+ node: PinnableItem
+}
+
+"""
+Represents items that can be pinned to a profile page or dashboard.
+"""
+enum PinnableItemType {
+ """
+ A gist.
+ """
+ GIST
+
+ """
+ An issue.
+ """
+ ISSUE
+
+ """
+ An organization.
+ """
+ ORGANIZATION
+
+ """
+ A project.
+ """
+ PROJECT
+
+ """
+ A pull request.
+ """
+ PULL_REQUEST
+
+ """
+ A repository.
+ """
+ REPOSITORY
+
+ """
+ A team.
+ """
+ TEAM
+
+ """
+ A user.
+ """
+ USER
+}
+
+"""
+Represents a 'pinned' event on a given issue or pull request.
+"""
+type PinnedEvent implements Node {
+ """
+ Identifies the actor who performed the event.
+ """
+ actor: Actor
+
+ """
+ Identifies the date and time when the object was created.
+ """
+ createdAt: DateTime!
+ id: ID!
+
+ """
+ Identifies the issue associated with the event.
+ """
+ issue: Issue!
+}
+
+"""
+A Pinned Issue is a issue pinned to a repository's index page.
+"""
+type PinnedIssue implements Node @preview(toggledBy: "elektra-preview") {
+ """
+ Identifies the primary key from the database.
+ """
+ databaseId: Int
+ id: ID!
+
+ """
+ The issue that was pinned.
+ """
+ issue: Issue!
+
+ """
+ The actor that pinned this issue.
+ """
+ pinnedBy: Actor!
+
+ """
+ The repository that this issue was pinned to.
+ """
+ repository: Repository!
+}
+
+"""
+The connection type for PinnedIssue.
+"""
+type PinnedIssueConnection @preview(toggledBy: "elektra-preview") {
+ """
+ A list of edges.
+ """
+ edges: [PinnedIssueEdge]
+
+ """
+ A list of nodes.
+ """
+ nodes: [PinnedIssue]
+
+ """
+ Information to aid in pagination.
+ """
+ pageInfo: PageInfo!
+
+ """
+ Identifies the total count of items in the connection.
+ """
+ totalCount: Int!
+}
+
+"""
+An edge in a connection.
+"""
+type PinnedIssueEdge @preview(toggledBy: "elektra-preview") {
+ """
+ A cursor for use in pagination.
+ """
+ cursor: String!
+
+ """
+ The item at the end of the edge.
+ """
+ node: PinnedIssue
+}
+
+"""
+An ISO-8601 encoded UTC date string with millisecond precison.
+"""
+scalar PreciseDateTime
+
+"""
+Audit log entry for a private_repository_forking.disable event.
+"""
+type PrivateRepositoryForkingDisableAuditEntry implements AuditEntry & EnterpriseAuditEntryData & Node & OrganizationAuditEntryData & RepositoryAuditEntryData {
+ """
+ The action name
+ """
+ action: String!
+
+ """
+ The user who initiated the action
+ """
+ actor: AuditEntryActor
+
+ """
+ The IP address of the actor
+ """
+ actorIp: String
+
+ """
+ A readable representation of the actor's location
+ """
+ actorLocation: ActorLocation
+
+ """
+ The username of the user who initiated the action
+ """
+ actorLogin: String
+
+ """
+ The HTTP path for the actor.
+ """
+ actorResourcePath: URI
+
+ """
+ The HTTP URL for the actor.
+ """
+ actorUrl: URI
+
+ """
+ The time the action was initiated
+ """
+ createdAt: PreciseDateTime!
+
+ """
+ The HTTP path for this enterprise.
+ """
+ enterpriseResourcePath: URI
+
+ """
+ The slug of the enterprise.
+ """
+ enterpriseSlug: String
+
+ """
+ The HTTP URL for this enterprise.
+ """
+ enterpriseUrl: URI
+ id: ID!
+
+ """
+ The corresponding operation type for the action
+ """
+ operationType: OperationType
+
+ """
+ The Organization associated with the Audit Entry.
+ """
+ organization: Organization
+
+ """
+ The name of the Organization.
+ """
+ organizationName: String
+
+ """
+ The HTTP path for the organization
+ """
+ organizationResourcePath: URI
+
+ """
+ The HTTP URL for the organization
+ """
+ organizationUrl: URI
+
+ """
+ The repository associated with the action
+ """
+ repository: Repository
+
+ """
+ The name of the repository
+ """
+ repositoryName: String
+
+ """
+ The HTTP path for the repository
+ """
+ repositoryResourcePath: URI
+
+ """
+ The HTTP URL for the repository
+ """
+ repositoryUrl: URI
+
+ """
+ The user affected by the action
+ """
+ user: User
+
+ """
+ For actions involving two users, the actor is the initiator and the user is the affected user.
+ """
+ userLogin: String
+
+ """
+ The HTTP path for the user.
+ """
+ userResourcePath: URI
+
+ """
+ The HTTP URL for the user.
+ """
+ userUrl: URI
+}
+
+"""
+Audit log entry for a private_repository_forking.enable event.
+"""
+type PrivateRepositoryForkingEnableAuditEntry implements AuditEntry & EnterpriseAuditEntryData & Node & OrganizationAuditEntryData & RepositoryAuditEntryData {
+ """
+ The action name
+ """
+ action: String!
+
+ """
+ The user who initiated the action
+ """
+ actor: AuditEntryActor
+
+ """
+ The IP address of the actor
+ """
+ actorIp: String
+
+ """
+ A readable representation of the actor's location
+ """
+ actorLocation: ActorLocation
+
+ """
+ The username of the user who initiated the action
+ """
+ actorLogin: String
+
+ """
+ The HTTP path for the actor.
+ """
+ actorResourcePath: URI
+
+ """
+ The HTTP URL for the actor.
+ """
+ actorUrl: URI
+
+ """
+ The time the action was initiated
+ """
+ createdAt: PreciseDateTime!
+
+ """
+ The HTTP path for this enterprise.
+ """
+ enterpriseResourcePath: URI
+
+ """
+ The slug of the enterprise.
+ """
+ enterpriseSlug: String
+
+ """
+ The HTTP URL for this enterprise.
+ """
+ enterpriseUrl: URI
+ id: ID!
+
+ """
+ The corresponding operation type for the action
+ """
+ operationType: OperationType
+
+ """
+ The Organization associated with the Audit Entry.
+ """
+ organization: Organization
+
+ """
+ The name of the Organization.
+ """
+ organizationName: String
+
+ """
+ The HTTP path for the organization
+ """
+ organizationResourcePath: URI
+
+ """
+ The HTTP URL for the organization
+ """
+ organizationUrl: URI
+
+ """
+ The repository associated with the action
+ """
+ repository: Repository
+
+ """
+ The name of the repository
+ """
+ repositoryName: String
+
+ """
+ The HTTP path for the repository
+ """
+ repositoryResourcePath: URI
+
+ """
+ The HTTP URL for the repository
+ """
+ repositoryUrl: URI
+
+ """
+ The user affected by the action
+ """
+ user: User
+
+ """
+ For actions involving two users, the actor is the initiator and the user is the affected user.
+ """
+ userLogin: String
+
+ """
+ The HTTP path for the user.
+ """
+ userResourcePath: URI
+
+ """
+ The HTTP URL for the user.
+ """
+ userUrl: URI
+}
+
+"""
+A curatable list of repositories relating to a repository owner, which defaults
+to showing the most popular repositories they own.
+"""
+type ProfileItemShowcase {
+ """
+ Whether or not the owner has pinned any repositories or gists.
+ """
+ hasPinnedItems: Boolean!
+
+ """
+ The repositories and gists in the showcase. If the profile owner has any
+ pinned items, those will be returned. Otherwise, the profile owner's popular
+ repositories will be returned.
+ """
+ items(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): PinnableItemConnection!
+}
+
+"""
+Represents any entity on GitHub that has a profile page.
+"""
+interface ProfileOwner {
+ """
+ Determine if this repository owner has any items that can be pinned to their profile.
+ """
+ anyPinnableItems(
+ """
+ Filter to only a particular kind of pinnable item.
+ """
+ type: PinnableItemType
+ ): Boolean!
+
+ """
+ The public profile email.
+ """
+ email: String
+ id: ID!
+
+ """
+ Showcases a selection of repositories and gists that the profile owner has
+ either curated or that have been selected automatically based on popularity.
+ """
+ itemShowcase: ProfileItemShowcase!
+
+ """
+ The public profile location.
+ """
+ location: String
+
+ """
+ The username used to login.
+ """
+ login: String!
+
+ """
+ The public profile name.
+ """
+ name: String
+
+ """
+ A list of repositories and gists this profile owner can pin to their profile.
+ """
+ pinnableItems(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Filter the types of pinnable items that are returned.
+ """
+ types: [PinnableItemType!]
+ ): PinnableItemConnection!
+
+ """
+ A list of repositories and gists this profile owner has pinned to their profile
+ """
+ pinnedItems(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Filter the types of pinned items that are returned.
+ """
+ types: [PinnableItemType!]
+ ): PinnableItemConnection!
+
+ """
+ Returns how many more items this profile owner can pin to their profile.
+ """
+ pinnedItemsRemaining: Int!
+
+ """
+ Can the viewer pin repositories and gists to the profile?
+ """
+ viewerCanChangePinnedItems: Boolean!
+
+ """
+ The public profile website URL.
+ """
+ websiteUrl: URI
+}
+
+"""
+Projects manage issues, pull requests and notes within a project owner.
+"""
+type Project implements Closable & Node & Updatable {
+ """
+ The project's description body.
+ """
+ body: String
+
+ """
+ The projects description body rendered to HTML.
+ """
+ bodyHTML: HTML!
+
+ """
+ `true` if the object is closed (definition of closed may depend on type)
+ """
+ closed: Boolean!
+
+ """
+ Identifies the date and time when the object was closed.
+ """
+ closedAt: DateTime
+
+ """
+ List of columns in the project
+ """
+ columns(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): ProjectColumnConnection!
+
+ """
+ Identifies the date and time when the object was created.
+ """
+ createdAt: DateTime!
+
+ """
+ The actor who originally created the project.
+ """
+ creator: Actor
+
+ """
+ Identifies the primary key from the database.
+ """
+ databaseId: Int
+ id: ID!
+
+ """
+ The project's name.
+ """
+ name: String!
+
+ """
+ The project's number.
+ """
+ number: Int!
+
+ """
+ The project's owner. Currently limited to repositories, organizations, and users.
+ """
+ owner: ProjectOwner!
+
+ """
+ List of pending cards in this project
+ """
+ pendingCards(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ A list of archived states to filter the cards by
+ """
+ archivedStates: [ProjectCardArchivedState] = [ARCHIVED, NOT_ARCHIVED]
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): ProjectCardConnection!
+
+ """
+ Project progress details.
+ """
+ progress: ProjectProgress!
+
+ """
+ The HTTP path for this project
+ """
+ resourcePath: URI!
+
+ """
+ Whether the project is open or closed.
+ """
+ state: ProjectState!
+
+ """
+ Identifies the date and time when the object was last updated.
+ """
+ updatedAt: DateTime!
+
+ """
+ The HTTP URL for this project
+ """
+ url: URI!
+
+ """
+ Check if the current viewer can update this object.
+ """
+ viewerCanUpdate: Boolean!
+}
+
+"""
+A card in a project.
+"""
+type ProjectCard implements Node {
+ """
+ The project column this card is associated under. A card may only belong to one
+ project column at a time. The column field will be null if the card is created
+ in a pending state and has yet to be associated with a column. Once cards are
+ associated with a column, they will not become pending in the future.
+ """
+ column: ProjectColumn
+
+ """
+ The card content item
+ """
+ content: ProjectCardItem
+
+ """
+ Identifies the date and time when the object was created.
+ """
+ createdAt: DateTime!
+
+ """
+ The actor who created this card
+ """
+ creator: Actor
+
+ """
+ Identifies the primary key from the database.
+ """
+ databaseId: Int
+ id: ID!
+
+ """
+ Whether the card is archived
+ """
+ isArchived: Boolean!
+
+ """
+ The card note
+ """
+ note: String
+
+ """
+ The project that contains this card.
+ """
+ project: Project!
+
+ """
+ The HTTP path for this card
+ """
+ resourcePath: URI!
+
+ """
+ The state of ProjectCard
+ """
+ state: ProjectCardState
+
+ """
+ Identifies the date and time when the object was last updated.
+ """
+ updatedAt: DateTime!
+
+ """
+ The HTTP URL for this card
+ """
+ url: URI!
+}
+
+"""
+The possible archived states of a project card.
+"""
+enum ProjectCardArchivedState {
+ """
+ A project card that is archived
+ """
+ ARCHIVED
+
+ """
+ A project card that is not archived
+ """
+ NOT_ARCHIVED
+}
+
+"""
+The connection type for ProjectCard.
+"""
+type ProjectCardConnection {
+ """
+ A list of edges.
+ """
+ edges: [ProjectCardEdge]
+
+ """
+ A list of nodes.
+ """
+ nodes: [ProjectCard]
+
+ """
+ Information to aid in pagination.
+ """
+ pageInfo: PageInfo!
+
+ """
+ Identifies the total count of items in the connection.
+ """
+ totalCount: Int!
+}
+
+"""
+An edge in a connection.
+"""
+type ProjectCardEdge {
+ """
+ A cursor for use in pagination.
+ """
+ cursor: String!
+
+ """
+ The item at the end of the edge.
+ """
+ node: ProjectCard
+}
+
+"""
+An issue or PR and its owning repository to be used in a project card.
+"""
+input ProjectCardImport {
+ """
+ The issue or pull request number.
+ """
+ number: Int!
+
+ """
+ Repository name with owner (owner/repository).
+ """
+ repository: String!
+}
+
+"""
+Types that can be inside Project Cards.
+"""
+union ProjectCardItem = Issue | PullRequest
+
+"""
+Various content states of a ProjectCard
+"""
+enum ProjectCardState {
+ """
+ The card has content only.
+ """
+ CONTENT_ONLY
+
+ """
+ The card has a note only.
+ """
+ NOTE_ONLY
+
+ """
+ The card is redacted.
+ """
+ REDACTED
+}
+
+"""
+A column inside a project.
+"""
+type ProjectColumn implements Node {
+ """
+ List of cards in the column
+ """
+ cards(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ A list of archived states to filter the cards by
+ """
+ archivedStates: [ProjectCardArchivedState] = [ARCHIVED, NOT_ARCHIVED]
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): ProjectCardConnection!
+
+ """
+ Identifies the date and time when the object was created.
+ """
+ createdAt: DateTime!
+
+ """
+ Identifies the primary key from the database.
+ """
+ databaseId: Int
+ id: ID!
+
+ """
+ The project column's name.
+ """
+ name: String!
+
+ """
+ The project that contains this column.
+ """
+ project: Project!
+
+ """
+ The semantic purpose of the column
+ """
+ purpose: ProjectColumnPurpose
+
+ """
+ The HTTP path for this project column
+ """
+ resourcePath: URI!
+
+ """
+ Identifies the date and time when the object was last updated.
+ """
+ updatedAt: DateTime!
+
+ """
+ The HTTP URL for this project column
+ """
+ url: URI!
+}
+
+"""
+The connection type for ProjectColumn.
+"""
+type ProjectColumnConnection {
+ """
+ A list of edges.
+ """
+ edges: [ProjectColumnEdge]
+
+ """
+ A list of nodes.
+ """
+ nodes: [ProjectColumn]
+
+ """
+ Information to aid in pagination.
+ """
+ pageInfo: PageInfo!
+
+ """
+ Identifies the total count of items in the connection.
+ """
+ totalCount: Int!
+}
+
+"""
+An edge in a connection.
+"""
+type ProjectColumnEdge {
+ """
+ A cursor for use in pagination.
+ """
+ cursor: String!
+
+ """
+ The item at the end of the edge.
+ """
+ node: ProjectColumn
+}
+
+"""
+A project column and a list of its issues and PRs.
+"""
+input ProjectColumnImport {
+ """
+ The name of the column.
+ """
+ columnName: String!
+
+ """
+ A list of issues and pull requests in the column.
+ """
+ issues: [ProjectCardImport!]
+
+ """
+ The position of the column, starting from 0.
+ """
+ position: Int!
+}
+
+"""
+The semantic purpose of the column - todo, in progress, or done.
+"""
+enum ProjectColumnPurpose {
+ """
+ The column contains cards which are complete
+ """
+ DONE
+
+ """
+ The column contains cards which are currently being worked on
+ """
+ IN_PROGRESS
+
+ """
+ The column contains cards still to be worked on
+ """
+ TODO
+}
+
+"""
+A list of projects associated with the owner.
+"""
+type ProjectConnection {
+ """
+ A list of edges.
+ """
+ edges: [ProjectEdge]
+
+ """
+ A list of nodes.
+ """
+ nodes: [Project]
+
+ """
+ Information to aid in pagination.
+ """
+ pageInfo: PageInfo!
+
+ """
+ Identifies the total count of items in the connection.
+ """
+ totalCount: Int!
+}
+
+"""
+An edge in a connection.
+"""
+type ProjectEdge {
+ """
+ A cursor for use in pagination.
+ """
+ cursor: String!
+
+ """
+ The item at the end of the edge.
+ """
+ node: Project
+}
+
+"""
+Ways in which lists of projects can be ordered upon return.
+"""
+input ProjectOrder {
+ """
+ The direction in which to order projects by the specified field.
+ """
+ direction: OrderDirection!
+
+ """
+ The field in which to order projects by.
+ """
+ field: ProjectOrderField!
+}
+
+"""
+Properties by which project connections can be ordered.
+"""
+enum ProjectOrderField {
+ """
+ Order projects by creation time
+ """
+ CREATED_AT
+
+ """
+ Order projects by name
+ """
+ NAME
+
+ """
+ Order projects by update time
+ """
+ UPDATED_AT
+}
+
+"""
+Represents an owner of a Project.
+"""
+interface ProjectOwner {
+ id: ID!
+
+ """
+ Find project by number.
+ """
+ project(
+ """
+ The project number to find.
+ """
+ number: Int!
+ ): Project
+
+ """
+ A list of projects under the owner.
+ """
+ projects(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Ordering options for projects returned from the connection
+ """
+ orderBy: ProjectOrder
+
+ """
+ Query to search projects by, currently only searching by name.
+ """
+ search: String
+
+ """
+ A list of states to filter the projects by.
+ """
+ states: [ProjectState!]
+ ): ProjectConnection!
+
+ """
+ The HTTP path listing owners projects
+ """
+ projectsResourcePath: URI!
+
+ """
+ The HTTP URL listing owners projects
+ """
+ projectsUrl: URI!
+
+ """
+ Can the current viewer create new projects on this owner.
+ """
+ viewerCanCreateProjects: Boolean!
+}
+
+"""
+Project progress stats.
+"""
+type ProjectProgress {
+ """
+ The number of done cards.
+ """
+ doneCount: Int!
+
+ """
+ The percentage of done cards.
+ """
+ donePercentage: Float!
+
+ """
+ Whether progress tracking is enabled and cards with purpose exist for this project
+ """
+ enabled: Boolean!
+
+ """
+ The number of in-progress cards.
+ """
+ inProgressCount: Int!
+
+ """
+ The percentage of in-progress cards.
+ """
+ inProgressPercentage: Float!
+
+ """
+ The number of to do cards.
+ """
+ todoCount: Int!
+
+ """
+ The percentage of to do cards.
+ """
+ todoPercentage: Float!
+}
+
+"""
+State of the project; either 'open' or 'closed'
+"""
+enum ProjectState {
+ """
+ The project is closed.
+ """
+ CLOSED
+
+ """
+ The project is open.
+ """
+ OPEN
+}
+
+"""
+GitHub-provided templates for Projects
+"""
+enum ProjectTemplate {
+ """
+ Create a board with v2 triggers to automatically move cards across To do, In progress and Done columns.
+ """
+ AUTOMATED_KANBAN_V2
+
+ """
+ Create a board with triggers to automatically move cards across columns with review automation.
+ """
+ AUTOMATED_REVIEWS_KANBAN
+
+ """
+ Create a board with columns for To do, In progress and Done.
+ """
+ BASIC_KANBAN
+
+ """
+ Create a board to triage and prioritize bugs with To do, priority, and Done columns.
+ """
+ BUG_TRIAGE
+}
+
+"""
+A user's public key.
+"""
+type PublicKey implements Node {
+ """
+ The last time this authorization was used to perform an action. Values will be null for keys not owned by the user.
+ """
+ accessedAt: DateTime
+
+ """
+ Identifies the date and time when the key was created. Keys created before
+ March 5th, 2014 have inaccurate values. Values will be null for keys not owned by the user.
+ """
+ createdAt: DateTime
+
+ """
+ The fingerprint for this PublicKey.
+ """
+ fingerprint: String!
+ id: ID!
+
+ """
+ Whether this PublicKey is read-only or not. Values will be null for keys not owned by the user.
+ """
+ isReadOnly: Boolean
+
+ """
+ The public key string.
+ """
+ key: String!
+
+ """
+ Identifies the date and time when the key was updated. Keys created before
+ March 5th, 2014 may have inaccurate values. Values will be null for keys not
+ owned by the user.
+ """
+ updatedAt: DateTime
+}
+
+"""
+The connection type for PublicKey.
+"""
+type PublicKeyConnection {
+ """
+ A list of edges.
+ """
+ edges: [PublicKeyEdge]
+
+ """
+ A list of nodes.
+ """
+ nodes: [PublicKey]
+
+ """
+ Information to aid in pagination.
+ """
+ pageInfo: PageInfo!
+
+ """
+ Identifies the total count of items in the connection.
+ """
+ totalCount: Int!
+}
+
+"""
+An edge in a connection.
+"""
+type PublicKeyEdge {
+ """
+ A cursor for use in pagination.
+ """
+ cursor: String!
+
+ """
+ The item at the end of the edge.
+ """
+ node: PublicKey
+}
+
+"""
+A repository pull request.
+"""
+type PullRequest implements Assignable & Closable & Comment & Labelable & Lockable & Node & Reactable & RepositoryNode & Subscribable & UniformResourceLocatable & Updatable & UpdatableComment {
+ """
+ Reason that the conversation was locked.
+ """
+ activeLockReason: LockReason
+
+ """
+ The number of additions in this pull request.
+ """
+ additions: Int!
+
+ """
+ A list of Users assigned to this object.
+ """
+ assignees(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): UserConnection!
+
+ """
+ The actor who authored the comment.
+ """
+ author: Actor
+
+ """
+ Author's association with the subject of the comment.
+ """
+ authorAssociation: CommentAuthorAssociation!
+
+ """
+ Identifies the base Ref associated with the pull request.
+ """
+ baseRef: Ref
+
+ """
+ Identifies the name of the base Ref associated with the pull request, even if the ref has been deleted.
+ """
+ baseRefName: String!
+
+ """
+ Identifies the oid of the base ref associated with the pull request, even if the ref has been deleted.
+ """
+ baseRefOid: GitObjectID!
+
+ """
+ The repository associated with this pull request's base Ref.
+ """
+ baseRepository: Repository
+
+ """
+ The body as Markdown.
+ """
+ body: String!
+
+ """
+ The body rendered to HTML.
+ """
+ bodyHTML: HTML!
+
+ """
+ The body rendered to text.
+ """
+ bodyText: String!
+
+ """
+ Whether or not the pull request is rebaseable.
+ """
+ canBeRebased: Boolean! @preview(toggledBy: "merge-info-preview")
+
+ """
+ The number of changed files in this pull request.
+ """
+ changedFiles: Int!
+
+ """
+ The HTTP path for the checks of this pull request.
+ """
+ checksResourcePath: URI!
+
+ """
+ The HTTP URL for the checks of this pull request.
+ """
+ checksUrl: URI!
+
+ """
+ `true` if the pull request is closed
+ """
+ closed: Boolean!
+
+ """
+ Identifies the date and time when the object was closed.
+ """
+ closedAt: DateTime
+
+ """
+ A list of comments associated with the pull request.
+ """
+ comments(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): IssueCommentConnection!
+
+ """
+ A list of commits present in this pull request's head branch not present in the base branch.
+ """
+ commits(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): PullRequestCommitConnection!
+
+ """
+ Identifies the date and time when the object was created.
+ """
+ createdAt: DateTime!
+
+ """
+ Check if this comment was created via an email reply.
+ """
+ createdViaEmail: Boolean!
+
+ """
+ Identifies the primary key from the database.
+ """
+ databaseId: Int
+
+ """
+ The number of deletions in this pull request.
+ """
+ deletions: Int!
+
+ """
+ The actor who edited this pull request's body.
+ """
+ editor: Actor
+
+ """
+ Lists the files changed within this pull request.
+ """
+ files(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): PullRequestChangedFileConnection
+
+ """
+ Identifies the head Ref associated with the pull request.
+ """
+ headRef: Ref
+
+ """
+ Identifies the name of the head Ref associated with the pull request, even if the ref has been deleted.
+ """
+ headRefName: String!
+
+ """
+ Identifies the oid of the head ref associated with the pull request, even if the ref has been deleted.
+ """
+ headRefOid: GitObjectID!
+
+ """
+ The repository associated with this pull request's head Ref.
+ """
+ headRepository: Repository
+
+ """
+ The owner of the repository associated with this pull request's head Ref.
+ """
+ headRepositoryOwner: RepositoryOwner
+
+ """
+ The hovercard information for this issue
+ """
+ hovercard(
+ """
+ Whether or not to include notification contexts
+ """
+ includeNotificationContexts: Boolean = true
+ ): Hovercard!
+ id: ID!
+
+ """
+ Check if this comment was edited and includes an edit with the creation data
+ """
+ includesCreatedEdit: Boolean!
+
+ """
+ The head and base repositories are different.
+ """
+ isCrossRepository: Boolean!
+
+ """
+ Identifies if the pull request is a draft.
+ """
+ isDraft: Boolean!
+
+ """
+ Is this pull request read by the viewer
+ """
+ isReadByViewer: Boolean
+
+ """
+ A list of labels associated with the object.
+ """
+ labels(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Ordering options for labels returned from the connection.
+ """
+ orderBy: LabelOrder = {field: CREATED_AT, direction: ASC}
+ ): LabelConnection
+
+ """
+ The moment the editor made the last edit
+ """
+ lastEditedAt: DateTime
+
+ """
+ A list of latest reviews per user associated with the pull request.
+ """
+ latestOpinionatedReviews(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Only return reviews from user who have write access to the repository
+ """
+ writersOnly: Boolean = false
+ ): PullRequestReviewConnection
+
+ """
+ A list of latest reviews per user associated with the pull request that are not also pending review.
+ """
+ latestReviews(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): PullRequestReviewConnection
+
+ """
+ `true` if the pull request is locked
+ """
+ locked: Boolean!
+
+ """
+ Indicates whether maintainers can modify the pull request.
+ """
+ maintainerCanModify: Boolean!
+
+ """
+ The commit that was created when this pull request was merged.
+ """
+ mergeCommit: Commit
+
+ """
+ Detailed information about the current pull request merge state status.
+ """
+ mergeStateStatus: MergeStateStatus! @preview(toggledBy: "merge-info-preview")
+
+ """
+ Whether or not the pull request can be merged based on the existence of merge conflicts.
+ """
+ mergeable: MergeableState!
+
+ """
+ Whether or not the pull request was merged.
+ """
+ merged: Boolean!
+
+ """
+ The date and time that the pull request was merged.
+ """
+ mergedAt: DateTime
+
+ """
+ The actor who merged the pull request.
+ """
+ mergedBy: Actor
+
+ """
+ Identifies the milestone associated with the pull request.
+ """
+ milestone: Milestone
+
+ """
+ Identifies the pull request number.
+ """
+ number: Int!
+
+ """
+ A list of Users that are participating in the Pull Request conversation.
+ """
+ participants(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): UserConnection!
+
+ """
+ The permalink to the pull request.
+ """
+ permalink: URI!
+
+ """
+ The commit that GitHub automatically generated to test if this pull request
+ could be merged. This field will not return a value if the pull request is
+ merged, or if the test merge commit is still being generated. See the
+ `mergeable` field for more details on the mergeability of the pull request.
+ """
+ potentialMergeCommit: Commit
+
+ """
+ List of project cards associated with this pull request.
+ """
+ projectCards(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ A list of archived states to filter the cards by
+ """
+ archivedStates: [ProjectCardArchivedState] = [ARCHIVED, NOT_ARCHIVED]
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): ProjectCardConnection!
+
+ """
+ Identifies when the comment was published at.
+ """
+ publishedAt: DateTime
+
+ """
+ A list of reactions grouped by content left on the subject.
+ """
+ reactionGroups: [ReactionGroup!]
+
+ """
+ A list of Reactions left on the Issue.
+ """
+ reactions(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Allows filtering Reactions by emoji.
+ """
+ content: ReactionContent
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Allows specifying the order in which reactions are returned.
+ """
+ orderBy: ReactionOrder
+ ): ReactionConnection!
+
+ """
+ The repository associated with this node.
+ """
+ repository: Repository!
+
+ """
+ The HTTP path for this pull request.
+ """
+ resourcePath: URI!
+
+ """
+ The HTTP path for reverting this pull request.
+ """
+ revertResourcePath: URI!
+
+ """
+ The HTTP URL for reverting this pull request.
+ """
+ revertUrl: URI!
+
+ """
+ The current status of this pull request with respect to code review.
+ """
+ reviewDecision: PullRequestReviewDecision
+
+ """
+ A list of review requests associated with the pull request.
+ """
+ reviewRequests(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): ReviewRequestConnection
+
+ """
+ The list of all review threads for this pull request.
+ """
+ reviewThreads(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): PullRequestReviewThreadConnection!
+
+ """
+ A list of reviews associated with the pull request.
+ """
+ reviews(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Filter by author of the review.
+ """
+ author: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ A list of states to filter the reviews.
+ """
+ states: [PullRequestReviewState!]
+ ): PullRequestReviewConnection
+
+ """
+ Identifies the state of the pull request.
+ """
+ state: PullRequestState!
+
+ """
+ A list of reviewer suggestions based on commit history and past review comments.
+ """
+ suggestedReviewers: [SuggestedReviewer]!
+
+ """
+ A list of events, comments, commits, etc. associated with the pull request.
+ """
+ timeline(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Allows filtering timeline events by a `since` timestamp.
+ """
+ since: DateTime
+ ): PullRequestTimelineConnection! @deprecated(reason: "`timeline` will be removed Use PullRequest.timelineItems instead. Removal on 2020-10-01 UTC.")
+
+ """
+ A list of events, comments, commits, etc. associated with the pull request.
+ """
+ timelineItems(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Filter timeline items by type.
+ """
+ itemTypes: [PullRequestTimelineItemsItemType!]
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Filter timeline items by a `since` timestamp.
+ """
+ since: DateTime
+
+ """
+ Skips the first _n_ elements in the list.
+ """
+ skip: Int
+ ): PullRequestTimelineItemsConnection!
+
+ """
+ Identifies the pull request title.
+ """
+ title: String!
+
+ """
+ Identifies the date and time when the object was last updated.
+ """
+ updatedAt: DateTime!
+
+ """
+ The HTTP URL for this pull request.
+ """
+ url: URI!
+
+ """
+ A list of edits to this content.
+ """
+ userContentEdits(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): UserContentEditConnection
+
+ """
+ Whether or not the viewer can apply suggestion.
+ """
+ viewerCanApplySuggestion: Boolean!
+
+ """
+ Check if the viewer can restore the deleted head ref.
+ """
+ viewerCanDeleteHeadRef: Boolean!
+
+ """
+ Can user react to this subject
+ """
+ viewerCanReact: Boolean!
+
+ """
+ Check if the viewer is able to change their subscription status for the repository.
+ """
+ viewerCanSubscribe: Boolean!
+
+ """
+ Check if the current viewer can update this object.
+ """
+ viewerCanUpdate: Boolean!
+
+ """
+ Reasons why the current viewer can not update this comment.
+ """
+ viewerCannotUpdateReasons: [CommentCannotUpdateReason!]!
+
+ """
+ Did the viewer author this comment.
+ """
+ viewerDidAuthor: Boolean!
+
+ """
+ The merge body text for the viewer and method.
+ """
+ viewerMergeBodyText(
+ """
+ The merge method for the message.
+ """
+ mergeType: PullRequestMergeMethod
+ ): String!
+
+ """
+ The merge headline text for the viewer and method.
+ """
+ viewerMergeHeadlineText(
+ """
+ The merge method for the message.
+ """
+ mergeType: PullRequestMergeMethod
+ ): String!
+
+ """
+ Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
+ """
+ viewerSubscription: SubscriptionState
+}
+
+"""
+A file changed in a pull request.
+"""
+type PullRequestChangedFile {
+ """
+ The number of additions to the file.
+ """
+ additions: Int!
+
+ """
+ The number of deletions to the file.
+ """
+ deletions: Int!
+
+ """
+ The path of the file.
+ """
+ path: String!
+
+ """
+ The state of the file for the viewer.
+ """
+ viewerViewedState: FileViewedState!
+}
+
+"""
+The connection type for PullRequestChangedFile.
+"""
+type PullRequestChangedFileConnection {
+ """
+ A list of edges.
+ """
+ edges: [PullRequestChangedFileEdge]
+
+ """
+ A list of nodes.
+ """
+ nodes: [PullRequestChangedFile]
+
+ """
+ Information to aid in pagination.
+ """
+ pageInfo: PageInfo!
+
+ """
+ Identifies the total count of items in the connection.
+ """
+ totalCount: Int!
+}
+
+"""
+An edge in a connection.
+"""
+type PullRequestChangedFileEdge {
+ """
+ A cursor for use in pagination.
+ """
+ cursor: String!
+
+ """
+ The item at the end of the edge.
+ """
+ node: PullRequestChangedFile
+}
+
+"""
+Represents a Git commit part of a pull request.
+"""
+type PullRequestCommit implements Node & UniformResourceLocatable {
+ """
+ The Git commit object
+ """
+ commit: Commit!
+ id: ID!
+
+ """
+ The pull request this commit belongs to
+ """
+ pullRequest: PullRequest!
+
+ """
+ The HTTP path for this pull request commit
+ """
+ resourcePath: URI!
+
+ """
+ The HTTP URL for this pull request commit
+ """
+ url: URI!
+}
+
+"""
+Represents a commit comment thread part of a pull request.
+"""
+type PullRequestCommitCommentThread implements Node & RepositoryNode {
+ """
+ The comments that exist in this thread.
+ """
+ comments(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): CommitCommentConnection!
+
+ """
+ The commit the comments were made on.
+ """
+ commit: Commit!
+ id: ID!
+
+ """
+ The file the comments were made on.
+ """
+ path: String
+
+ """
+ The position in the diff for the commit that the comment was made on.
+ """
+ position: Int
+
+ """
+ The pull request this commit comment thread belongs to
+ """
+ pullRequest: PullRequest!
+
+ """
+ The repository associated with this node.
+ """
+ repository: Repository!
+}
+
+"""
+The connection type for PullRequestCommit.
+"""
+type PullRequestCommitConnection {
+ """
+ A list of edges.
+ """
+ edges: [PullRequestCommitEdge]
+
+ """
+ A list of nodes.
+ """
+ nodes: [PullRequestCommit]
+
+ """
+ Information to aid in pagination.
+ """
+ pageInfo: PageInfo!
+
+ """
+ Identifies the total count of items in the connection.
+ """
+ totalCount: Int!
+}
+
+"""
+An edge in a connection.
+"""
+type PullRequestCommitEdge {
+ """
+ A cursor for use in pagination.
+ """
+ cursor: String!
+
+ """
+ The item at the end of the edge.
+ """
+ node: PullRequestCommit
+}
+
+"""
+The connection type for PullRequest.
+"""
+type PullRequestConnection {
+ """
+ A list of edges.
+ """
+ edges: [PullRequestEdge]
+
+ """
+ A list of nodes.
+ """
+ nodes: [PullRequest]
+
+ """
+ Information to aid in pagination.
+ """
+ pageInfo: PageInfo!
+
+ """
+ Identifies the total count of items in the connection.
+ """
+ totalCount: Int!
+}
+
+"""
+This aggregates pull requests opened by a user within one repository.
+"""
+type PullRequestContributionsByRepository {
+ """
+ The pull request contributions.
+ """
+ contributions(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
"""
- Returns the elements in the list that come before the specified cursor.
- """
before: String
"""
@@ -13605,15 +21195,120 @@ type Organization implements Actor & MemberStatusable & Node & ProfileOwner & Pr
last: Int
"""
- Filter the types of pinnable items that are returned.
+ Ordering options for contributions returned from the connection.
"""
- types: [PinnableItemType!]
- ): PinnableItemConnection!
+ orderBy: ContributionOrder = {direction: DESC}
+ ): CreatedPullRequestContributionConnection!
"""
- A list of repositories and gists this profile owner has pinned to their profile
+ The repository in which the pull requests were opened.
"""
- pinnedItems(
+ repository: Repository!
+}
+
+"""
+An edge in a connection.
+"""
+type PullRequestEdge {
+ """
+ A cursor for use in pagination.
+ """
+ cursor: String!
+
+ """
+ The item at the end of the edge.
+ """
+ node: PullRequest
+}
+
+"""
+Represents available types of methods to use when merging a pull request.
+"""
+enum PullRequestMergeMethod {
+ """
+ Add all commits from the head branch to the base branch with a merge commit.
+ """
+ MERGE
+
+ """
+ Add all commits from the head branch onto the base branch individually.
+ """
+ REBASE
+
+ """
+ Combine all commits from the head branch into a single commit in the base branch.
+ """
+ SQUASH
+}
+
+"""
+Ways in which lists of issues can be ordered upon return.
+"""
+input PullRequestOrder {
+ """
+ The direction in which to order pull requests by the specified field.
+ """
+ direction: OrderDirection!
+
+ """
+ The field in which to order pull requests by.
+ """
+ field: PullRequestOrderField!
+}
+
+"""
+Properties by which pull_requests connections can be ordered.
+"""
+enum PullRequestOrderField {
+ """
+ Order pull_requests by creation time
+ """
+ CREATED_AT
+
+ """
+ Order pull_requests by update time
+ """
+ UPDATED_AT
+}
+
+"""
+A review object for a given pull request.
+"""
+type PullRequestReview implements Comment & Deletable & Node & Reactable & RepositoryNode & Updatable & UpdatableComment {
+ """
+ The actor who authored the comment.
+ """
+ author: Actor
+
+ """
+ Author's association with the subject of the comment.
+ """
+ authorAssociation: CommentAuthorAssociation!
+
+ """
+ Indicates whether the author of this review has push access to the repository.
+ """
+ authorCanPushToRepository: Boolean!
+
+ """
+ Identifies the pull request review body.
+ """
+ body: String!
+
+ """
+ The body rendered to HTML.
+ """
+ bodyHTML: HTML!
+
+ """
+ The body of this review rendered as plain text.
+ """
+ bodyText: String!
+
+ """
+ A list of review comments for the current pull request review.
+ """
+ comments(
"""
Returns the elements in the list that come after the specified cursor.
"""
@@ -13633,29 +21328,48 @@ type Organization implements Actor & MemberStatusable & Node & ProfileOwner & Pr
Returns the last _n_ elements from the list.
"""
last: Int
+ ): PullRequestReviewCommentConnection!
- """
- Filter the types of pinned items that are returned.
- """
- types: [PinnableItemType!]
- ): PinnableItemConnection!
+ """
+ Identifies the commit associated with this pull request review.
+ """
+ commit: Commit
"""
- Returns how many more items this profile owner can pin to their profile.
+ Identifies the date and time when the object was created.
"""
- pinnedItemsRemaining: Int!
+ createdAt: DateTime!
"""
- A list of repositories this user has pinned to their profile
+ Check if this comment was created via an email reply.
"""
- pinnedRepositories(
- """
- Array of viewer's affiliation options for repositories returned from the
- connection. For example, OWNER will include only repositories that the
- current viewer owns.
- """
- affiliations: [RepositoryAffiliation]
+ createdViaEmail: Boolean!
+
+ """
+ Identifies the primary key from the database.
+ """
+ databaseId: Int
+
+ """
+ The actor who edited the comment.
+ """
+ editor: Actor
+ id: ID!
+
+ """
+ Check if this comment was edited and includes an edit with the creation data
+ """
+ includesCreatedEdit: Boolean!
+
+ """
+ The moment the editor made the last edit
+ """
+ lastEditedAt: DateTime
+ """
+ A list of teams that this review was made on behalf of.
+ """
+ onBehalfOf(
"""
Returns the elements in the list that come after the specified cursor.
"""
@@ -13671,48 +21385,31 @@ type Organization implements Actor & MemberStatusable & Node & ProfileOwner & Pr
"""
first: Int
- """
- If non-null, filters repositories according to whether they have been locked
- """
- isLocked: Boolean
-
"""
Returns the last _n_ elements from the list.
"""
last: Int
+ ): TeamConnection!
- """
- Ordering options for repositories returned from the connection
- """
- orderBy: RepositoryOrder
-
- """
- Array of owner's affiliation options for repositories returned from the
- connection. For example, OWNER will include only repositories that the
- organization or user being viewed owns.
- """
- ownerAffiliations: [RepositoryAffiliation] = [OWNER, COLLABORATOR]
+ """
+ Identifies when the comment was published at.
+ """
+ publishedAt: DateTime
- """
- If non-null, filters repositories according to privacy
- """
- privacy: RepositoryPrivacy
- ): RepositoryConnection! @deprecated(reason: "pinnedRepositories will be removed Use ProfileOwner.pinnedItems instead. Removal on 2019-10-01 UTC.")
+ """
+ Identifies the pull request associated with this pull request review.
+ """
+ pullRequest: PullRequest!
"""
- Find project by number.
+ A list of reactions grouped by content left on the subject.
"""
- project(
- """
- The project number to find.
- """
- number: Int!
- ): Project
+ reactionGroups: [ReactionGroup!]
"""
- A list of projects under the owner.
+ A list of Reactions left on the Issue.
"""
- projects(
+ reactions(
"""
Returns the elements in the list that come after the specified cursor.
"""
@@ -13723,6 +21420,11 @@ type Organization implements Actor & MemberStatusable & Node & ProfileOwner & Pr
"""
before: String
+ """
+ Allows filtering Reactions by emoji.
+ """
+ content: ReactionContent
+
"""
Returns the first _n_ elements from the list.
"""
@@ -13734,42 +21436,45 @@ type Organization implements Actor & MemberStatusable & Node & ProfileOwner & Pr
last: Int
"""
- Ordering options for projects returned from the connection
+ Allows specifying the order in which reactions are returned.
"""
- orderBy: ProjectOrder
+ orderBy: ReactionOrder
+ ): ReactionConnection!
- """
- Query to search projects by, currently only searching by name.
- """
- search: String
+ """
+ The repository associated with this node.
+ """
+ repository: Repository!
- """
- A list of states to filter the projects by.
- """
- states: [ProjectState!]
- ): ProjectConnection!
+ """
+ The HTTP path permalink for this PullRequestReview.
+ """
+ resourcePath: URI!
"""
- The HTTP path listing organization's projects
+ Identifies the current state of the pull request review.
"""
- projectsResourcePath: URI!
+ state: PullRequestReviewState!
"""
- The HTTP URL listing organization's projects
+ Identifies when the Pull Request Review was submitted
"""
- projectsUrl: URI!
+ submittedAt: DateTime
"""
- A list of repositories that the user owns.
+ Identifies the date and time when the object was last updated.
"""
- repositories(
- """
- Array of viewer's affiliation options for repositories returned from the
- connection. For example, OWNER will include only repositories that the
- current viewer owns.
- """
- affiliations: [RepositoryAffiliation]
+ updatedAt: DateTime!
+
+ """
+ The HTTP URL permalink for this PullRequestReview.
+ """
+ url: URI!
+ """
+ A list of edits to this content.
+ """
+ userContentEdits(
"""
Returns the elements in the list that come after the specified cursor.
"""
@@ -13785,79 +21490,172 @@ type Organization implements Actor & MemberStatusable & Node & ProfileOwner & Pr
"""
first: Int
- """
- If non-null, filters repositories according to whether they are forks of another repository
- """
- isFork: Boolean
-
- """
- If non-null, filters repositories according to whether they have been locked
- """
- isLocked: Boolean
-
"""
Returns the last _n_ elements from the list.
"""
last: Int
+ ): UserContentEditConnection
- """
- Ordering options for repositories returned from the connection
- """
- orderBy: RepositoryOrder
+ """
+ Check if the current viewer can delete this object.
+ """
+ viewerCanDelete: Boolean!
- """
- Array of owner's affiliation options for repositories returned from the
- connection. For example, OWNER will include only repositories that the
- organization or user being viewed owns.
- """
- ownerAffiliations: [RepositoryAffiliation] = [OWNER, COLLABORATOR]
+ """
+ Can user react to this subject
+ """
+ viewerCanReact: Boolean!
- """
- If non-null, filters repositories according to privacy
- """
- privacy: RepositoryPrivacy
- ): RepositoryConnection!
+ """
+ Check if the current viewer can update this object.
+ """
+ viewerCanUpdate: Boolean!
"""
- Find Repository.
+ Reasons why the current viewer can not update this comment.
"""
- repository(
- """
- Name of Repository to find.
- """
- name: String!
- ): Repository
+ viewerCannotUpdateReasons: [CommentCannotUpdateReason!]!
"""
- When true the organization requires all members, billing managers, and outside
- collaborators to enable two-factor authentication.
+ Did the viewer author this comment.
"""
- requiresTwoFactorAuthentication: Boolean
+ viewerDidAuthor: Boolean!
+}
+"""
+A review comment associated with a given repository pull request.
+"""
+type PullRequestReviewComment implements Comment & Deletable & Minimizable & Node & Reactable & RepositoryNode & Updatable & UpdatableComment {
"""
- The HTTP path for this organization.
+ The actor who authored the comment.
"""
- resourcePath: URI!
+ author: Actor
"""
- The Organization's SAML identity providers
+ Author's association with the subject of the comment.
"""
- samlIdentityProvider: OrganizationIdentityProvider
+ authorAssociation: CommentAuthorAssociation!
"""
- Find an organization's team by its slug.
+ The comment body of this review comment.
"""
- team(
- """
- The name or slug of the team to find.
- """
- slug: String!
- ): Team
+ body: String!
"""
- A list of teams in this organization.
+ The body rendered to HTML.
"""
- teams(
+ bodyHTML: HTML!
+
+ """
+ The comment body of this review comment rendered as plain text.
+ """
+ bodyText: String!
+
+ """
+ Identifies the commit associated with the comment.
+ """
+ commit: Commit
+
+ """
+ Identifies when the comment was created.
+ """
+ createdAt: DateTime!
+
+ """
+ Check if this comment was created via an email reply.
+ """
+ createdViaEmail: Boolean!
+
+ """
+ Identifies the primary key from the database.
+ """
+ databaseId: Int
+
+ """
+ The diff hunk to which the comment applies.
+ """
+ diffHunk: String!
+
+ """
+ Identifies when the comment was created in a draft state.
+ """
+ draftedAt: DateTime!
+
+ """
+ The actor who edited the comment.
+ """
+ editor: Actor
+ id: ID!
+
+ """
+ Check if this comment was edited and includes an edit with the creation data
+ """
+ includesCreatedEdit: Boolean!
+
+ """
+ Returns whether or not a comment has been minimized.
+ """
+ isMinimized: Boolean!
+
+ """
+ The moment the editor made the last edit
+ """
+ lastEditedAt: DateTime
+
+ """
+ Returns why the comment was minimized.
+ """
+ minimizedReason: String
+
+ """
+ Identifies the original commit associated with the comment.
+ """
+ originalCommit: Commit
+
+ """
+ The original line index in the diff to which the comment applies.
+ """
+ originalPosition: Int!
+
+ """
+ Identifies when the comment body is outdated
+ """
+ outdated: Boolean!
+
+ """
+ The path to which the comment applies.
+ """
+ path: String!
+
+ """
+ The line index in the diff to which the comment applies.
+ """
+ position: Int
+
+ """
+ Identifies when the comment was published at.
+ """
+ publishedAt: DateTime
+
+ """
+ The pull request associated with this review comment.
+ """
+ pullRequest: PullRequest!
+
+ """
+ The pull request review associated with this review comment.
+ """
+ pullRequestReview: PullRequestReview
+
+ """
+ A list of reactions grouped by content left on the subject.
+ """
+ reactionGroups: [ReactionGroup!]
+
+ """
+ A list of Reactions left on the Issue.
+ """
+ reactions(
"""
Returns the elements in the list that come after the specified cursor.
"""
@@ -13868,6 +21666,11 @@ type Organization implements Actor & MemberStatusable & Node & ProfileOwner & Pr
"""
before: String
+ """
+ Allows filtering Reactions by emoji.
+ """
+ content: ReactionContent
+
"""
Returns the first _n_ elements from the list.
"""
@@ -13879,110 +21682,110 @@ type Organization implements Actor & MemberStatusable & Node & ProfileOwner & Pr
last: Int
"""
- If true, filters teams that are mapped to an LDAP Group (Enterprise only)
- """
- ldapMapped: Boolean
-
- """
- Ordering options for teams returned from the connection
- """
- orderBy: TeamOrder
-
- """
- If non-null, filters teams according to privacy
- """
- privacy: TeamPrivacy
-
- """
- If non-null, filters teams with query on team name and team slug
+ Allows specifying the order in which reactions are returned.
"""
- query: String
+ orderBy: ReactionOrder
+ ): ReactionConnection!
- """
- If non-null, filters teams according to whether the viewer is an admin or member on team
- """
- role: TeamRole
+ """
+ The comment this is a reply to.
+ """
+ replyTo: PullRequestReviewComment
- """
- If true, restrict to only root teams
- """
- rootTeamsOnly: Boolean = false
+ """
+ The repository associated with this node.
+ """
+ repository: Repository!
- """
- User logins to filter by
- """
- userLogins: [String!]
- ): TeamConnection!
+ """
+ The HTTP path permalink for this review comment.
+ """
+ resourcePath: URI!
"""
- The HTTP path listing organization's teams
+ Identifies the state of the comment.
"""
- teamsResourcePath: URI!
+ state: PullRequestReviewCommentState!
"""
- The HTTP URL listing organization's teams
+ Identifies when the comment was last updated.
"""
- teamsUrl: URI!
+ updatedAt: DateTime!
"""
- The HTTP URL for this organization.
+ The HTTP URL permalink for this review comment.
"""
url: URI!
"""
- Organization is adminable by the viewer.
+ A list of edits to this content.
"""
- viewerCanAdminister: Boolean!
+ userContentEdits(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): UserContentEditConnection
"""
- Can the viewer pin repositories and gists to the profile?
+ Check if the current viewer can delete this object.
"""
- viewerCanChangePinnedItems: Boolean!
+ viewerCanDelete: Boolean!
"""
- Can the current viewer create new projects on this owner.
+ Check if the current viewer can minimize this object.
"""
- viewerCanCreateProjects: Boolean!
+ viewerCanMinimize: Boolean!
"""
- Viewer can create repositories on this organization
+ Can user react to this subject
"""
- viewerCanCreateRepositories: Boolean!
+ viewerCanReact: Boolean!
"""
- Viewer can create teams on this organization.
+ Check if the current viewer can update this object.
"""
- viewerCanCreateTeams: Boolean!
+ viewerCanUpdate: Boolean!
"""
- Viewer is an active member of this organization.
+ Reasons why the current viewer can not update this comment.
"""
- viewerIsAMember: Boolean!
+ viewerCannotUpdateReasons: [CommentCannotUpdateReason!]!
"""
- The organization's public profile URL.
+ Did the viewer author this comment.
"""
- websiteUrl: URI
+ viewerDidAuthor: Boolean!
}
"""
-An audit entry in an organization audit log.
-"""
-union OrganizationAuditEntry @preview(toggledBy: "audit-log-preview") = MembersCanDeleteReposClearAuditEntry | MembersCanDeleteReposDisableAuditEntry | MembersCanDeleteReposEnableAuditEntry | OauthApplicationCreateAuditEntry | OrgAddBillingManagerAuditEntry | OrgAddMemberAuditEntry | OrgBlockUserAuditEntry | OrgConfigDisableCollaboratorsOnlyAuditEntry | OrgConfigEnableCollaboratorsOnlyAuditEntry | OrgDisableOauthAppRestrictionsAuditEntry | OrgDisableSamlAuditEntry | OrgDisableTwoFactorRequirementAuditEntry | OrgEnableOauthAppRestrictionsAuditEntry | OrgEnableSamlAuditEntry | OrgEnableTwoFactorRequirementAuditEntry | OrgInviteMemberAuditEntry | OrgInviteToBusinessAuditEntry | OrgOauthAppAccessApprovedAuditEntry | OrgOauthAppAccessDeniedAuditEntry | OrgOauthAppAccessRequestedAuditEntry | OrgRemoveBillingManagerAuditEntry | OrgRemoveMemberAuditEntry | OrgRemoveOutsideCollaboratorAuditEntry | OrgRestoreMemberAuditEntry | OrgUnblockUserAuditEntry | OrgUpdateDefaultRepositoryPermissionAuditEntry | OrgUpdateMemberAuditEntry | OrgUpdateMemberRepositoryCreationPermissionAuditEntry | OrgUpdateMemberRepositoryInvitationPermissionAuditEntry | PrivateRepositoryForkingDisableAuditEntry | PrivateRepositoryForkingEnableAuditEntry | RepoAccessAuditEntry | RepoAddMemberAuditEntry | RepoConfigDisableAnonymousGitAccessAuditEntry | RepoConfigDisableCollaboratorsOnlyAuditEntry | RepoConfigDisableContributorsOnlyAuditEntry | RepoConfigDisableSockpuppetDisallowedAuditEntry | RepoConfigEnableAnonymousGitAccessAuditEntry | RepoConfigEnableCollaboratorsOnlyAuditEntry | RepoConfigEnableContributorsOnlyAuditEntry | RepoConfigEnableSockpuppetDisallowedAuditEntry | RepoConfigLockAnonymousGitAccessAuditEntry | RepoConfigUnlockAnonymousGitAccessAuditEntry | RepoRemoveMemberAuditEntry | RepositoryVisibilityChangeDisableAuditEntry | RepositoryVisibilityChangeEnableAuditEntry | TeamAddMemberAuditEntry | TeamAddRepositoryAuditEntry | TeamChangeParentTeamAuditEntry | TeamRemoveMemberAuditEntry | TeamRemoveRepositoryAuditEntry
-
-"""
-The connection type for OrganizationAuditEntry.
+The connection type for PullRequestReviewComment.
"""
-type OrganizationAuditEntryConnection {
+type PullRequestReviewCommentConnection {
"""
A list of edges.
"""
- edges: [OrganizationAuditEntryEdge]
+ edges: [PullRequestReviewCommentEdge]
"""
A list of nodes.
"""
- nodes: [OrganizationAuditEntry]
+ nodes: [PullRequestReviewComment]
"""
Information to aid in pagination.
@@ -13996,58 +21799,48 @@ type OrganizationAuditEntryConnection {
}
"""
-Metadata for an audit entry with action org.*
+An edge in a connection.
"""
-interface OrganizationAuditEntryData @preview(toggledBy: "audit-log-preview") {
- """
- The Organization associated with the Audit Entry.
- """
- organization: Organization
-
- """
- The name of the Organization.
- """
- organizationName: String
-
+type PullRequestReviewCommentEdge {
"""
- The HTTP path for the organization
+ A cursor for use in pagination.
"""
- organizationResourcePath: URI
+ cursor: String!
"""
- The HTTP URL for the organization
+ The item at the end of the edge.
"""
- organizationUrl: URI
+ node: PullRequestReviewComment
}
"""
-An edge in a connection.
+The possible states of a pull request review comment.
"""
-type OrganizationAuditEntryEdge {
+enum PullRequestReviewCommentState {
"""
- A cursor for use in pagination.
+ A comment that is part of a pending review
"""
- cursor: String!
+ PENDING
"""
- The item at the end of the edge.
+ A comment that is part of a submitted review
"""
- node: OrganizationAuditEntry
+ SUBMITTED
}
"""
-The connection type for Organization.
+The connection type for PullRequestReview.
"""
-type OrganizationConnection {
+type PullRequestReviewConnection {
"""
A list of edges.
"""
- edges: [OrganizationEdge]
+ edges: [PullRequestReviewEdge]
"""
A list of nodes.
"""
- nodes: [Organization]
+ nodes: [PullRequestReview]
"""
Information to aid in pagination.
@@ -14061,33 +21854,13 @@ type OrganizationConnection {
}
"""
-An edge in a connection.
-"""
-type OrganizationEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
-
- """
- The item at the end of the edge.
- """
- node: Organization
-}
-
-"""
-An Identity Provider configured to provision SAML and SCIM identities for Organizations
+This aggregates pull request reviews made by a user within one repository.
"""
-type OrganizationIdentityProvider implements Node {
- """
- The digest algorithm used to sign SAML requests for the Identity Provider.
- """
- digestMethod: URI
-
+type PullRequestReviewContributionsByRepository {
"""
- External Identities provisioned by this Identity Provider
+ The pull request review contributions.
"""
- externalIdentities(
+ contributions(
"""
Returns the elements in the list that come after the specified cursor.
"""
@@ -14107,105 +21880,43 @@ type OrganizationIdentityProvider implements Node {
Returns the last _n_ elements from the list.
"""
last: Int
- ): ExternalIdentityConnection!
- id: ID!
- """
- The x509 certificate used by the Identity Provder to sign assertions and responses.
- """
- idpCertificate: X509Certificate
-
- """
- The Issuer Entity ID for the SAML Identity Provider
- """
- issuer: String
-
- """
- Organization this Identity Provider belongs to
- """
- organization: Organization
-
- """
- The signature algorithm used to sign SAML requests for the Identity Provider.
- """
- signatureMethod: URI
-
- """
- The URL endpoint for the Identity Provider's SAML SSO.
- """
- ssoUrl: URI
-}
-
-"""
-An Invitation for a user to an organization.
-"""
-type OrganizationInvitation implements Node {
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- The email address of the user invited to the organization.
- """
- email: String
- id: ID!
-
- """
- The type of invitation that was sent (e.g. email, user).
- """
- invitationType: OrganizationInvitationType!
-
- """
- The user who was invited to the organization.
- """
- invitee: User
-
- """
- The user who created the invitation.
- """
- inviter: User!
-
- """
- The organization the invite is for
- """
- organization: Organization!
+ """
+ Ordering options for contributions returned from the connection.
+ """
+ orderBy: ContributionOrder = {direction: DESC}
+ ): CreatedPullRequestReviewContributionConnection!
"""
- The user's pending role in the organization (e.g. member, owner).
+ The repository in which the pull request reviews were made.
"""
- role: OrganizationInvitationRole!
+ repository: Repository!
}
"""
-The connection type for OrganizationInvitation.
+The review status of a pull request.
"""
-type OrganizationInvitationConnection {
- """
- A list of edges.
+enum PullRequestReviewDecision {
"""
- edges: [OrganizationInvitationEdge]
-
- """
- A list of nodes.
+ The pull request has received an approving review.
"""
- nodes: [OrganizationInvitation]
+ APPROVED
"""
- Information to aid in pagination.
+ Changes have been requested on the pull request.
"""
- pageInfo: PageInfo!
+ CHANGES_REQUESTED
"""
- Identifies the total count of items in the connection.
+ A review is required before the pull request can be merged.
"""
- totalCount: Int!
+ REVIEW_REQUIRED
}
"""
An edge in a connection.
"""
-type OrganizationInvitationEdge {
+type PullRequestReviewEdge {
"""
A cursor for use in pagination.
"""
@@ -14214,312 +21925,333 @@ type OrganizationInvitationEdge {
"""
The item at the end of the edge.
"""
- node: OrganizationInvitation
+ node: PullRequestReview
}
"""
-The possible organization invitation roles.
+The possible events to perform on a pull request review.
"""
-enum OrganizationInvitationRole {
+enum PullRequestReviewEvent {
"""
- The user is invited to be an admin of the organization.
+ Submit feedback and approve merging these changes.
"""
- ADMIN
+ APPROVE
"""
- The user is invited to be a billing manager of the organization.
+ Submit general feedback without explicit approval.
"""
- BILLING_MANAGER
+ COMMENT
"""
- The user is invited to be a direct member of the organization.
+ Dismiss review so it now longer effects merging.
"""
- DIRECT_MEMBER
+ DISMISS
"""
- The user's previous role will be reinstated.
+ Submit feedback that must be addressed before merging.
"""
- REINSTATE
+ REQUEST_CHANGES
}
"""
-The possible organization invitation types.
+The possible states of a pull request review.
"""
-enum OrganizationInvitationType {
+enum PullRequestReviewState {
"""
- The invitation was to an email address.
+ A review allowing the pull request to merge.
"""
- EMAIL
+ APPROVED
"""
- The invitation was to an existing user.
+ A review blocking the pull request from merging.
"""
- USER
+ CHANGES_REQUESTED
+
+ """
+ An informational review.
+ """
+ COMMENTED
+
+ """
+ A review that has been dismissed.
+ """
+ DISMISSED
+
+ """
+ A review that has not yet been submitted.
+ """
+ PENDING
}
"""
-The connection type for User.
+A threaded list of comments for a given pull request.
"""
-type OrganizationMemberConnection {
+type PullRequestReviewThread implements Node {
"""
- A list of edges.
+ A list of pull request comments associated with the thread.
"""
- edges: [OrganizationMemberEdge]
+ comments(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Skips the first _n_ elements in the list.
+ """
+ skip: Int
+ ): PullRequestReviewCommentConnection!
"""
- A list of nodes.
+ The side of the diff on which this thread was placed.
"""
- nodes: [User]
+ diffSide: DiffSide!
+ id: ID!
"""
- Information to aid in pagination.
+ Whether or not the thread has been collapsed (outdated or resolved)
"""
- pageInfo: PageInfo!
+ isCollapsed: Boolean!
"""
- Identifies the total count of items in the connection.
+ Indicates whether this thread was outdated by newer changes.
"""
- totalCount: Int!
-}
+ isOutdated: Boolean!
-"""
-Represents a user within an organization.
-"""
-type OrganizationMemberEdge {
"""
- A cursor for use in pagination.
+ Whether this thread has been resolved
"""
- cursor: String!
+ isResolved: Boolean!
"""
- Whether the organization member has two factor enabled or not. Returns null if information is not available to viewer.
+ The line in the file to which this thread refers
"""
- hasTwoFactorEnabled: Boolean
+ line: Int
"""
- The item at the end of the edge.
+ The original line in the file to which this thread refers.
"""
- node: User
+ originalLine: Int
"""
- The role this user has in the organization.
+ The original start line in the file to which this thread refers (multi-line only).
"""
- role: OrganizationMemberRole
-}
+ originalStartLine: Int
-"""
-The possible roles within an organization for its members.
-"""
-enum OrganizationMemberRole {
"""
- The user is an administrator of the organization.
+ Identifies the file path of this thread.
"""
- ADMIN
+ path: String!
"""
- The user is a member of the organization.
+ Identifies the pull request associated with this thread.
"""
- MEMBER
-}
+ pullRequest: PullRequest!
-"""
-An organization teams hovercard context
-"""
-type OrganizationTeamsHovercardContext implements HovercardContext @preview(toggledBy: "hagar-preview") {
"""
- A string describing this context
+ Identifies the repository associated with this thread.
"""
- message: String!
+ repository: Repository!
"""
- An octicon to accompany this context
+ The user who resolved this thread
"""
- octicon: String!
+ resolvedBy: User
"""
- Teams in this organization the user is a member of that are relevant
+ The side of the diff that the first line of the thread starts on (multi-line only)
"""
- relevantTeams(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
+ startDiffSide: DiffSide
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): TeamConnection!
+ """
+ The start line in the file to which this thread refers (multi-line only)
+ """
+ startLine: Int
"""
- The path for the full team list for this user
+ Indicates whether the current viewer can reply to this thread.
"""
- teamsResourcePath: URI!
+ viewerCanReply: Boolean!
"""
- The URL for the full team list for this user
+ Whether or not the viewer can resolve this thread
"""
- teamsUrl: URI!
+ viewerCanResolve: Boolean!
"""
- The total number of teams the user is on in the organization
+ Whether or not the viewer can unresolve this thread
"""
- totalTeamCount: Int!
+ viewerCanUnresolve: Boolean!
}
"""
-An organization list hovercard context
+Review comment threads for a pull request review.
"""
-type OrganizationsHovercardContext implements HovercardContext @preview(toggledBy: "hagar-preview") {
+type PullRequestReviewThreadConnection {
"""
- A string describing this context
+ A list of edges.
"""
- message: String!
+ edges: [PullRequestReviewThreadEdge]
"""
- An octicon to accompany this context
+ A list of nodes.
"""
- octicon: String!
+ nodes: [PullRequestReviewThread]
"""
- Organizations this user is a member of that are relevant
+ Information to aid in pagination.
"""
- relevantOrganizations(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
+ pageInfo: PageInfo!
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
+ """
+ Identifies the total count of items in the connection.
+ """
+ totalCount: Int!
+}
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): OrganizationConnection!
+"""
+An edge in a connection.
+"""
+type PullRequestReviewThreadEdge {
+ """
+ A cursor for use in pagination.
+ """
+ cursor: String!
"""
- The total number of organizations this user is in
+ The item at the end of the edge.
"""
- totalOrganizationCount: Int!
+ node: PullRequestReviewThread
}
"""
-Information about pagination in a connection.
+Represents the latest point in the pull request timeline for which the viewer has seen the pull request's commits.
"""
-type PageInfo {
+type PullRequestRevisionMarker {
"""
- When paginating forwards, the cursor to continue.
+ Identifies the date and time when the object was created.
"""
- endCursor: String
+ createdAt: DateTime!
"""
- When paginating forwards, are there more items?
+ The last commit the viewer has seen.
+ """
+ lastSeenCommit: Commit!
+
+ """
+ The pull request to which the marker belongs.
+ """
+ pullRequest: PullRequest!
+}
+
+"""
+The possible states of a pull request.
+"""
+enum PullRequestState {
+ """
+ A pull request that has been closed without being merged.
"""
- hasNextPage: Boolean!
+ CLOSED
"""
- When paginating backwards, are there more items?
+ A pull request that has been closed by being merged.
"""
- hasPreviousPage: Boolean!
+ MERGED
"""
- When paginating backwards, the cursor to continue.
+ A pull request that is still open.
"""
- startCursor: String
+ OPEN
}
"""
-Types that can grant permissions on a repository to a user
+The connection type for PullRequestTimelineItem.
"""
-union PermissionGranter = Organization | Repository | Team
+type PullRequestTimelineConnection {
+ """
+ A list of edges.
+ """
+ edges: [PullRequestTimelineItemEdge]
-"""
-A level of permission and source for a user's access to a repository.
-"""
-type PermissionSource {
"""
- The organization the repository belongs to.
+ A list of nodes.
"""
- organization: Organization!
+ nodes: [PullRequestTimelineItem]
"""
- The level of access this source has granted to the user.
+ Information to aid in pagination.
"""
- permission: DefaultRepositoryPermissionField!
+ pageInfo: PageInfo!
"""
- The source of this permission.
+ Identifies the total count of items in the connection.
"""
- source: PermissionGranter!
+ totalCount: Int!
}
"""
-Autogenerated input type of PinIssue
+An item in an pull request timeline
"""
-input PinIssueInput {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The ID of the issue to be pinned
- """
- issueId: ID! @possibleTypes(concreteTypes: ["Issue"])
-}
+union PullRequestTimelineItem = AssignedEvent | BaseRefDeletedEvent | BaseRefForcePushedEvent | ClosedEvent | Commit | CommitCommentThread | CrossReferencedEvent | DemilestonedEvent | DeployedEvent | DeploymentEnvironmentChangedEvent | HeadRefDeletedEvent | HeadRefForcePushedEvent | HeadRefRestoredEvent | IssueComment | LabeledEvent | LockedEvent | MergedEvent | MilestonedEvent | PullRequestReview | PullRequestReviewComment | PullRequestReviewThread | ReferencedEvent | RenamedTitleEvent | ReopenedEvent | ReviewDismissedEvent | ReviewRequestRemovedEvent | ReviewRequestedEvent | SubscribedEvent | UnassignedEvent | UnlabeledEvent | UnlockedEvent | UnsubscribedEvent | UserBlockedEvent
"""
-Autogenerated return type of PinIssue
+An edge in a connection.
"""
-type PinIssuePayload {
+type PullRequestTimelineItemEdge {
"""
- A unique identifier for the client performing the mutation.
+ A cursor for use in pagination.
"""
- clientMutationId: String
+ cursor: String!
"""
- The issue that was pinned
+ The item at the end of the edge.
"""
- issue: Issue
+ node: PullRequestTimelineItem
}
"""
-Types that can be pinned to a profile page.
+An item in a pull request timeline
"""
-union PinnableItem = Gist | Repository
+union PullRequestTimelineItems = AddedToProjectEvent | AssignedEvent | AutomaticBaseChangeFailedEvent | AutomaticBaseChangeSucceededEvent | BaseRefChangedEvent | BaseRefDeletedEvent | BaseRefForcePushedEvent | ClosedEvent | CommentDeletedEvent | ConnectedEvent | ConvertToDraftEvent | ConvertedNoteToIssueEvent | CrossReferencedEvent | DemilestonedEvent | DeployedEvent | DeploymentEnvironmentChangedEvent | DisconnectedEvent | HeadRefDeletedEvent | HeadRefForcePushedEvent | HeadRefRestoredEvent | IssueComment | LabeledEvent | LockedEvent | MarkedAsDuplicateEvent | MentionedEvent | MergedEvent | MilestonedEvent | MovedColumnsInProjectEvent | PinnedEvent | PullRequestCommit | PullRequestCommitCommentThread | PullRequestReview | PullRequestReviewThread | PullRequestRevisionMarker | ReadyForReviewEvent | ReferencedEvent | RemovedFromProjectEvent | RenamedTitleEvent | ReopenedEvent | ReviewDismissedEvent | ReviewRequestRemovedEvent | ReviewRequestedEvent | SubscribedEvent | TransferredEvent | UnassignedEvent | UnlabeledEvent | UnlockedEvent | UnmarkedAsDuplicateEvent | UnpinnedEvent | UnsubscribedEvent | UserBlockedEvent
"""
-The connection type for PinnableItem.
+The connection type for PullRequestTimelineItems.
"""
-type PinnableItemConnection {
+type PullRequestTimelineItemsConnection {
"""
A list of edges.
"""
- edges: [PinnableItemEdge]
+ edges: [PullRequestTimelineItemsEdge]
+
+ """
+ Identifies the count of items after applying `before` and `after` filters.
+ """
+ filteredCount: Int!
"""
A list of nodes.
"""
- nodes: [PinnableItem]
+ nodes: [PullRequestTimelineItems]
+
+ """
+ Identifies the count of items after applying `before`/`after` filters and `first`/`last`/`skip` slicing.
+ """
+ pageCount: Int!
"""
Information to aid in pagination.
@@ -14530,12 +22262,17 @@ type PinnableItemConnection {
Identifies the total count of items in the connection.
"""
totalCount: Int!
+
+ """
+ Identifies the date and time when the timeline was last updated.
+ """
+ updatedAt: DateTime!
}
"""
An edge in a connection.
"""
-type PinnableItemEdge {
+type PullRequestTimelineItemsEdge {
"""
A cursor for use in pagination.
"""
@@ -14544,501 +22281,465 @@ type PinnableItemEdge {
"""
The item at the end of the edge.
"""
- node: PinnableItem
+ node: PullRequestTimelineItems
}
"""
-Represents items that can be pinned to a profile page or dashboard.
+The possible item types found in a timeline.
"""
-enum PinnableItemType {
- """
- A gist.
- """
- GIST
-
- """
- An issue.
- """
- ISSUE
-
+enum PullRequestTimelineItemsItemType {
"""
- An organization.
+ Represents a 'added_to_project' event on a given issue or pull request.
"""
- ORGANIZATION
+ ADDED_TO_PROJECT_EVENT
"""
- A project.
+ Represents an 'assigned' event on any assignable object.
"""
- PROJECT
+ ASSIGNED_EVENT
"""
- A pull request.
+ Represents a 'automatic_base_change_failed' event on a given pull request.
"""
- PULL_REQUEST
+ AUTOMATIC_BASE_CHANGE_FAILED_EVENT
"""
- A repository.
+ Represents a 'automatic_base_change_succeeded' event on a given pull request.
"""
- REPOSITORY
+ AUTOMATIC_BASE_CHANGE_SUCCEEDED_EVENT
"""
- A team.
+ Represents a 'base_ref_changed' event on a given issue or pull request.
"""
- TEAM
+ BASE_REF_CHANGED_EVENT
"""
- A user.
+ Represents a 'base_ref_deleted' event on a given pull request.
"""
- USER
-}
+ BASE_REF_DELETED_EVENT
-"""
-Represents a 'pinned' event on a given issue or pull request.
-"""
-type PinnedEvent implements Node {
"""
- Identifies the actor who performed the event.
+ Represents a 'base_ref_force_pushed' event on a given pull request.
"""
- actor: Actor
+ BASE_REF_FORCE_PUSHED_EVENT
"""
- Identifies the date and time when the object was created.
+ Represents a 'closed' event on any `Closable`.
"""
- createdAt: DateTime!
- id: ID!
+ CLOSED_EVENT
"""
- Identifies the issue associated with the event.
+ Represents a 'comment_deleted' event on a given issue or pull request.
"""
- issue: Issue!
-}
+ COMMENT_DELETED_EVENT
-"""
-A Pinned Issue is a issue pinned to a repository's index page.
-"""
-type PinnedIssue implements Node @preview(toggledBy: "elektra-preview") {
"""
- Identifies the primary key from the database.
+ Represents a 'connected' event on a given issue or pull request.
"""
- databaseId: Int
- id: ID!
+ CONNECTED_EVENT
"""
- The issue that was pinned.
+ Represents a 'converted_note_to_issue' event on a given issue or pull request.
"""
- issue: Issue!
+ CONVERTED_NOTE_TO_ISSUE_EVENT
"""
- The actor that pinned this issue.
+ Represents a 'convert_to_draft' event on a given pull request.
"""
- pinnedBy: Actor!
+ CONVERT_TO_DRAFT_EVENT
"""
- The repository that this issue was pinned to.
+ Represents a mention made by one issue or pull request to another.
"""
- repository: Repository!
-}
+ CROSS_REFERENCED_EVENT
-"""
-The connection type for PinnedIssue.
-"""
-type PinnedIssueConnection @preview(toggledBy: "elektra-preview") {
"""
- A list of edges.
+ Represents a 'demilestoned' event on a given issue or pull request.
"""
- edges: [PinnedIssueEdge]
+ DEMILESTONED_EVENT
"""
- A list of nodes.
+ Represents a 'deployed' event on a given pull request.
"""
- nodes: [PinnedIssue]
+ DEPLOYED_EVENT
"""
- Information to aid in pagination.
+ Represents a 'deployment_environment_changed' event on a given pull request.
"""
- pageInfo: PageInfo!
+ DEPLOYMENT_ENVIRONMENT_CHANGED_EVENT
"""
- Identifies the total count of items in the connection.
+ Represents a 'disconnected' event on a given issue or pull request.
"""
- totalCount: Int!
-}
+ DISCONNECTED_EVENT
-"""
-An edge in a connection.
-"""
-type PinnedIssueEdge @preview(toggledBy: "elektra-preview") {
"""
- A cursor for use in pagination.
+ Represents a 'head_ref_deleted' event on a given pull request.
"""
- cursor: String!
+ HEAD_REF_DELETED_EVENT
"""
- The item at the end of the edge.
+ Represents a 'head_ref_force_pushed' event on a given pull request.
"""
- node: PinnedIssue
-}
-
-"""
-An ISO-8601 encoded UTC date string with millisecond precison.
-"""
-scalar PreciseDateTime @preview(toggledBy: "audit-log-preview")
+ HEAD_REF_FORCE_PUSHED_EVENT
-"""
-Audit log entry for a private_repository_forking.disable event.
-"""
-type PrivateRepositoryForkingDisableAuditEntry implements AuditEntry & EnterpriseAuditEntryData & Node & OrganizationAuditEntryData & RepositoryAuditEntryData @preview(toggledBy: "audit-log-preview") {
"""
- The action name
+ Represents a 'head_ref_restored' event on a given pull request.
"""
- action: String!
+ HEAD_REF_RESTORED_EVENT
"""
- The user who initiated the action
+ Represents a comment on an Issue.
"""
- actor: AuditEntryActor
+ ISSUE_COMMENT
"""
- The IP address of the actor
+ Represents a 'labeled' event on a given issue or pull request.
"""
- actorIp: String
+ LABELED_EVENT
"""
- A readable representation of the actor's location
+ Represents a 'locked' event on a given issue or pull request.
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ LOCKED_EVENT
"""
- The username of the user who initiated the action
+ Represents a 'marked_as_duplicate' event on a given issue or pull request.
"""
- actorLogin: String
+ MARKED_AS_DUPLICATE_EVENT
"""
- The HTTP path for the actor.
+ Represents a 'mentioned' event on a given issue or pull request.
"""
- actorResourcePath: URI
+ MENTIONED_EVENT
"""
- The HTTP URL for the actor.
+ Represents a 'merged' event on a given pull request.
"""
- actorUrl: URI
+ MERGED_EVENT
"""
- The time the action was initiated
+ Represents a 'milestoned' event on a given issue or pull request.
"""
- createdAt: PreciseDateTime!
+ MILESTONED_EVENT
"""
- The HTTP path for this enterprise.
+ Represents a 'moved_columns_in_project' event on a given issue or pull request.
"""
- enterpriseResourcePath: URI
+ MOVED_COLUMNS_IN_PROJECT_EVENT
"""
- The slug of the enterprise.
+ Represents a 'pinned' event on a given issue or pull request.
"""
- enterpriseSlug: String
+ PINNED_EVENT
"""
- The HTTP URL for this enterprise.
+ Represents a Git commit part of a pull request.
"""
- enterpriseUrl: URI
- id: ID!
+ PULL_REQUEST_COMMIT
"""
- The Organization associated with the Audit Entry.
+ Represents a commit comment thread part of a pull request.
"""
- organization: Organization
+ PULL_REQUEST_COMMIT_COMMENT_THREAD
"""
- The name of the Organization.
+ A review object for a given pull request.
"""
- organizationName: String
+ PULL_REQUEST_REVIEW
"""
- The HTTP path for the organization
+ A threaded list of comments for a given pull request.
"""
- organizationResourcePath: URI
+ PULL_REQUEST_REVIEW_THREAD
"""
- The HTTP URL for the organization
+ Represents the latest point in the pull request timeline for which the viewer has seen the pull request's commits.
"""
- organizationUrl: URI
+ PULL_REQUEST_REVISION_MARKER
"""
- The repository associated with the action
+ Represents a 'ready_for_review' event on a given pull request.
"""
- repository: Repository
+ READY_FOR_REVIEW_EVENT
"""
- The name of the repository
+ Represents a 'referenced' event on a given `ReferencedSubject`.
"""
- repositoryName: String
+ REFERENCED_EVENT
"""
- The HTTP path for the repository
+ Represents a 'removed_from_project' event on a given issue or pull request.
"""
- repositoryResourcePath: URI
+ REMOVED_FROM_PROJECT_EVENT
"""
- The HTTP URL for the repository
+ Represents a 'renamed' event on a given issue or pull request
"""
- repositoryUrl: URI
+ RENAMED_TITLE_EVENT
"""
- The user affected by the action
+ Represents a 'reopened' event on any `Closable`.
"""
- user: User
+ REOPENED_EVENT
"""
- For actions involving two users, the actor is the initiator and the user is the affected user.
+ Represents a 'review_dismissed' event on a given issue or pull request.
"""
- userLogin: String
+ REVIEW_DISMISSED_EVENT
"""
- The HTTP path for the user.
+ Represents an 'review_requested' event on a given pull request.
"""
- userResourcePath: URI
+ REVIEW_REQUESTED_EVENT
"""
- The HTTP URL for the user.
+ Represents an 'review_request_removed' event on a given pull request.
"""
- userUrl: URI
-}
+ REVIEW_REQUEST_REMOVED_EVENT
-"""
-Audit log entry for a private_repository_forking.enable event.
-"""
-type PrivateRepositoryForkingEnableAuditEntry implements AuditEntry & EnterpriseAuditEntryData & Node & OrganizationAuditEntryData & RepositoryAuditEntryData @preview(toggledBy: "audit-log-preview") {
"""
- The action name
+ Represents a 'subscribed' event on a given `Subscribable`.
"""
- action: String!
+ SUBSCRIBED_EVENT
"""
- The user who initiated the action
+ Represents a 'transferred' event on a given issue or pull request.
"""
- actor: AuditEntryActor
+ TRANSFERRED_EVENT
"""
- The IP address of the actor
+ Represents an 'unassigned' event on any assignable object.
"""
- actorIp: String
+ UNASSIGNED_EVENT
"""
- A readable representation of the actor's location
+ Represents an 'unlabeled' event on a given issue or pull request.
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ UNLABELED_EVENT
"""
- The username of the user who initiated the action
+ Represents an 'unlocked' event on a given issue or pull request.
"""
- actorLogin: String
+ UNLOCKED_EVENT
"""
- The HTTP path for the actor.
+ Represents an 'unmarked_as_duplicate' event on a given issue or pull request.
"""
- actorResourcePath: URI
+ UNMARKED_AS_DUPLICATE_EVENT
"""
- The HTTP URL for the actor.
+ Represents an 'unpinned' event on a given issue or pull request.
"""
- actorUrl: URI
+ UNPINNED_EVENT
"""
- The time the action was initiated
+ Represents an 'unsubscribed' event on a given `Subscribable`.
"""
- createdAt: PreciseDateTime!
+ UNSUBSCRIBED_EVENT
"""
- The HTTP path for this enterprise.
+ Represents a 'user_blocked' event on a given user.
"""
- enterpriseResourcePath: URI
+ USER_BLOCKED_EVENT
+}
+"""
+The possible target states when updating a pull request.
+"""
+enum PullRequestUpdateState {
"""
- The slug of the enterprise.
+ A pull request that has been closed without being merged.
"""
- enterpriseSlug: String
+ CLOSED
"""
- The HTTP URL for this enterprise.
+ A pull request that is still open.
"""
- enterpriseUrl: URI
+ OPEN
+}
+
+"""
+A Git push.
+"""
+type Push implements Node {
id: ID!
"""
- The Organization associated with the Audit Entry.
+ The SHA after the push
"""
- organization: Organization
+ nextSha: GitObjectID
"""
- The name of the Organization.
+ The permalink for this push.
"""
- organizationName: String
+ permalink: URI!
"""
- The HTTP path for the organization
+ The SHA before the push
"""
- organizationResourcePath: URI
+ previousSha: GitObjectID
"""
- The HTTP URL for the organization
+ The user who pushed
"""
- organizationUrl: URI
+ pusher: User!
"""
- The repository associated with the action
+ The repository that was pushed to
"""
- repository: Repository
+ repository: Repository!
+}
+"""
+A team, user or app who has the ability to push to a protected branch.
+"""
+type PushAllowance implements Node {
"""
- The name of the repository
+ The actor that can push.
"""
- repositoryName: String
+ actor: PushAllowanceActor
"""
- The HTTP path for the repository
+ Identifies the branch protection rule associated with the allowed user or team.
"""
- repositoryResourcePath: URI
+ branchProtectionRule: BranchProtectionRule
+ id: ID!
+}
- """
- The HTTP URL for the repository
- """
- repositoryUrl: URI
+"""
+Types that can be an actor.
+"""
+union PushAllowanceActor = App | Team | User
+"""
+The connection type for PushAllowance.
+"""
+type PushAllowanceConnection {
"""
- The user affected by the action
+ A list of edges.
"""
- user: User
+ edges: [PushAllowanceEdge]
"""
- For actions involving two users, the actor is the initiator and the user is the affected user.
+ A list of nodes.
"""
- userLogin: String
+ nodes: [PushAllowance]
"""
- The HTTP path for the user.
+ Information to aid in pagination.
"""
- userResourcePath: URI
+ pageInfo: PageInfo!
"""
- The HTTP URL for the user.
+ Identifies the total count of items in the connection.
"""
- userUrl: URI
+ totalCount: Int!
}
"""
-A curatable list of repositories relating to a repository owner, which defaults
-to showing the most popular repositories they own.
+An edge in a connection.
"""
-type ProfileItemShowcase {
+type PushAllowanceEdge {
"""
- Whether or not the owner has pinned any repositories or gists.
+ A cursor for use in pagination.
"""
- hasPinnedItems: Boolean!
+ cursor: String!
"""
- The repositories and gists in the showcase. If the profile owner has any
- pinned items, those will be returned. Otherwise, the profile owner's popular
- repositories will be returned.
+ The item at the end of the edge.
"""
- items(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): PinnableItemConnection!
+ node: PushAllowance
}
"""
-Represents any entity on GitHub that has a profile page.
+The query root of GitHub's GraphQL interface.
"""
-interface ProfileOwner {
+type Query {
"""
- Determine if this repository owner has any items that can be pinned to their profile.
+ Look up a code of conduct by its key
"""
- anyPinnableItems(
+ codeOfConduct(
"""
- Filter to only a particular kind of pinnable item.
+ The code of conduct's key
"""
- type: PinnableItemType
- ): Boolean!
+ key: String!
+ ): CodeOfConduct
"""
- The public profile email.
+ Look up a code of conduct by its key
"""
- email: String
- id: ID!
+ codesOfConduct: [CodeOfConduct]
"""
- Showcases a selection of repositories and gists that the profile owner has
- either curated or that have been selected automatically based on popularity.
+ Look up an enterprise by URL slug.
"""
- itemShowcase: ProfileItemShowcase!
+ enterprise(
+ """
+ The enterprise invitation token.
+ """
+ invitationToken: String
+
+ """
+ The enterprise URL slug.
+ """
+ slug: String!
+ ): Enterprise
"""
- The public profile location.
+ Look up an open source license by its key
"""
- location: String
+ license(
+ """
+ The license's downcased SPDX ID
+ """
+ key: String!
+ ): License
"""
- The username used to login.
+ Return a list of known open source licenses
"""
- login: String!
+ licenses: [License]!
"""
- The public profile name.
+ Return information about the GitHub instance
"""
- name: String
+ meta: GitHubMetadata!
"""
- A list of repositories and gists this profile owner can pin to their profile.
+ Fetches an object given its ID.
"""
- pinnableItems(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
+ node(
"""
- Returns the first _n_ elements from the list.
+ ID of the object.
"""
- first: Int
+ id: ID!
+ ): Node
+ """
+ Lookup nodes by a list of IDs.
+ """
+ nodes(
"""
- Returns the last _n_ elements from the list.
+ The list of node IDs.
"""
- last: Int
+ ids: [ID!]!
+ ): [Node]!
+ """
+ Lookup a organization by login.
+ """
+ organization(
"""
- Filter the types of pinnable items that are returned.
+ The organization's login.
"""
- types: [PinnableItemType!]
- ): PinnableItemConnection!
+ login: String!
+ ): Organization
"""
- A list of repositories and gists this profile owner has pinned to their profile
+ A list of organizations.
"""
- pinnedItems(
+ organizations(
"""
Returns the elements in the list that come after the specified cursor.
"""
@@ -15058,57 +22759,62 @@ interface ProfileOwner {
Returns the last _n_ elements from the list.
"""
last: Int
-
- """
- Filter the types of pinned items that are returned.
- """
- types: [PinnableItemType!]
- ): PinnableItemConnection!
-
- """
- Returns how many more items this profile owner can pin to their profile.
- """
- pinnedItemsRemaining: Int!
+ ): OrganizationConnection!
"""
- Can the viewer pin repositories and gists to the profile?
+ The client's rate limit information.
"""
- viewerCanChangePinnedItems: Boolean!
+ rateLimit(
+ """
+ If true, calculate the cost for the query without evaluating it
+ """
+ dryRun: Boolean = false
+ ): RateLimit
"""
- The public profile website URL.
+ Hack to workaround https://github.com/facebook/relay/issues/112 re-exposing the root query object
"""
- websiteUrl: URI
-}
+ relay: Query!
-"""
-Projects manage issues, pull requests and notes within a project owner.
-"""
-type Project implements Closable & Node & Updatable {
"""
- The project's description body.
+ Lookup a given repository by the owner and repository name.
"""
- body: String
+ repository(
+ """
+ The name of the repository
+ """
+ name: String!
- """
- The projects description body rendered to HTML.
- """
- bodyHTML: HTML!
+ """
+ The login field of a user or organization
+ """
+ owner: String!
+ ): Repository
"""
- `true` if the object is closed (definition of closed may depend on type)
+ Lookup a repository owner (ie. either a User or an Organization) by login.
"""
- closed: Boolean!
+ repositoryOwner(
+ """
+ The username to lookup the owner by.
+ """
+ login: String!
+ ): RepositoryOwner
"""
- Identifies the date and time when the object was closed.
+ Lookup resource by a URL.
"""
- closedAt: DateTime
+ resource(
+ """
+ The URL.
+ """
+ url: URI!
+ ): UniformResourceLocatable
"""
- List of columns in the project
+ Perform a search across resources.
"""
- columns(
+ search(
"""
Returns the elements in the list that come after the specified cursor.
"""
@@ -15128,53 +22834,27 @@ type Project implements Closable & Node & Updatable {
Returns the last _n_ elements from the list.
"""
last: Int
- ): ProjectColumnConnection!
-
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
-
- """
- The actor who originally created the project.
- """
- creator: Actor
-
- """
- Identifies the primary key from the database.
- """
- databaseId: Int
- id: ID!
-
- """
- The project's name.
- """
- name: String!
- """
- The project's number.
- """
- number: Int!
+ """
+ The search string to look for.
+ """
+ query: String!
- """
- The project's owner. Currently limited to repositories, organizations, and users.
- """
- owner: ProjectOwner!
+ """
+ The types of search items to search within.
+ """
+ type: SearchType!
+ ): SearchResultItemConnection!
"""
- List of pending cards in this project
+ GitHub Security Advisories
"""
- pendingCards(
+ securityAdvisories(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
- """
- A list of archived states to filter the cards by
- """
- archivedStates: [ProjectCardArchivedState] = [ARCHIVED, NOT_ARCHIVED]
-
"""
Returns the elements in the list that come before the specified cursor.
"""
@@ -15189,220 +22869,187 @@ type Project implements Closable & Node & Updatable {
Returns the last _n_ elements from the list.
"""
last: Int
- ): ProjectCardConnection!
-
- """
- The HTTP path for this project
- """
- resourcePath: URI!
-
- """
- Whether the project is open or closed.
- """
- state: ProjectState!
-
- """
- Identifies the date and time when the object was last updated.
- """
- updatedAt: DateTime!
-
- """
- The HTTP URL for this project
- """
- url: URI!
-
- """
- Check if the current viewer can update this object.
- """
- viewerCanUpdate: Boolean!
-}
-"""
-A card in a project.
-"""
-type ProjectCard implements Node {
- """
- The project column this card is associated under. A card may only belong to one
- project column at a time. The column field will be null if the card is created
- in a pending state and has yet to be associated with a column. Once cards are
- associated with a column, they will not become pending in the future.
- """
- column: ProjectColumn
+ """
+ Filter advisories to those published since a time in the past.
+ """
+ publishedSince: DateTime
- """
- The card content item
- """
- content: ProjectCardItem
+ """
+ Filter advisories to those updated since a time in the past.
+ """
+ updatedSince: DateTime
+ ): SecurityAdvisoryConnection!
"""
- Identifies the date and time when the object was created.
+ Fetch a Security Advisory by its GHSA ID
"""
- createdAt: DateTime!
+ securityAdvisory(
+ """
+ GitHub Security Advisory ID.
+ """
+ ghsaId: String!
+ ): SecurityAdvisory
"""
- The actor who created this card
+ Software Vulnerabilities documented by GitHub Security Advisories
"""
- creator: Actor
+ securityVulnerabilities(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
- """
- Identifies the primary key from the database.
- """
- databaseId: Int
- id: ID!
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
- """
- Whether the card is archived
- """
- isArchived: Boolean!
+ """
+ An ecosystem to filter vulnerabilities by.
+ """
+ ecosystem: SecurityAdvisoryEcosystem
- """
- The card note
- """
- note: String
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
- """
- The project that contains this card.
- """
- project: Project!
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
- """
- The HTTP path for this card
- """
- resourcePath: URI!
+ """
+ A package name to filter vulnerabilities by.
+ """
+ package: String
- """
- The state of ProjectCard
- """
- state: ProjectCardState
+ """
+ A list of severities to filter vulnerabilities by.
+ """
+ severities: [SecurityAdvisorySeverity!]
+ ): SecurityVulnerabilityConnection!
"""
- Identifies the date and time when the object was last updated.
+ Look up a topic by name.
"""
- updatedAt: DateTime!
+ topic(
+ """
+ The topic's name.
+ """
+ name: String!
+ ): Topic
"""
- The HTTP URL for this card
+ Lookup a user by login.
"""
- url: URI!
-}
+ user(
+ """
+ The user's login.
+ """
+ login: String!
+ ): User
-"""
-The possible archived states of a project card.
-"""
-enum ProjectCardArchivedState {
"""
- A project card that is archived
+ A list of users.
"""
- ARCHIVED
+ users(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): UserConnection!
"""
- A project card that is not archived
+ The currently authenticated user.
"""
- NOT_ARCHIVED
+ viewer: User!
}
"""
-The connection type for ProjectCard.
+Represents the client's rate limit.
"""
-type ProjectCardConnection {
- """
- A list of edges.
- """
- edges: [ProjectCardEdge]
-
- """
- A list of nodes.
- """
- nodes: [ProjectCard]
-
+type RateLimit {
"""
- Information to aid in pagination.
+ The point cost for the current query counting against the rate limit.
"""
- pageInfo: PageInfo!
+ cost: Int!
"""
- Identifies the total count of items in the connection.
+ The maximum number of points the client is permitted to consume in a 60 minute window.
"""
- totalCount: Int!
-}
+ limit: Int!
-"""
-An edge in a connection.
-"""
-type ProjectCardEdge {
"""
- A cursor for use in pagination.
+ The maximum number of nodes this query may return
"""
- cursor: String!
+ nodeCount: Int!
"""
- The item at the end of the edge.
+ The number of points remaining in the current rate limit window.
"""
- node: ProjectCard
-}
+ remaining: Int!
-"""
-An issue or PR and its owning repository to be used in a project card.
-"""
-input ProjectCardImport {
"""
- The issue or pull request number.
+ The time at which the current rate limit window resets in UTC epoch seconds.
"""
- number: Int!
+ resetAt: DateTime!
"""
- Repository name with owner (owner/repository).
+ The number of points used in the current rate limit window.
"""
- repository: String!
+ used: Int!
}
"""
-Types that can be inside Project Cards.
-"""
-union ProjectCardItem = Issue | PullRequest
-
-"""
-Various content states of a ProjectCard
+Represents a subject that can be reacted on.
"""
-enum ProjectCardState {
- """
- The card has content only.
- """
- CONTENT_ONLY
-
+interface Reactable {
"""
- The card has a note only.
+ Identifies the primary key from the database.
"""
- NOTE_ONLY
+ databaseId: Int
+ id: ID!
"""
- The card is redacted.
+ A list of reactions grouped by content left on the subject.
"""
- REDACTED
-}
+ reactionGroups: [ReactionGroup!]
-"""
-A column inside a project.
-"""
-type ProjectColumn implements Node {
"""
- List of cards in the column
+ A list of Reactions left on the Issue.
"""
- cards(
+ reactions(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
- A list of archived states to filter the cards by
+ Returns the elements in the list that come before the specified cursor.
"""
- archivedStates: [ProjectCardArchivedState] = [ARCHIVED, NOT_ARCHIVED]
+ before: String
"""
- Returns the elements in the list that come before the specified cursor.
+ Allows filtering Reactions by emoji.
"""
- before: String
+ content: ReactionContent
"""
Returns the first _n_ elements from the list.
@@ -15413,225 +23060,204 @@ type ProjectColumn implements Node {
Returns the last _n_ elements from the list.
"""
last: Int
- ): ProjectCardConnection!
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
+ """
+ Allows specifying the order in which reactions are returned.
+ """
+ orderBy: ReactionOrder
+ ): ReactionConnection!
"""
- Identifies the primary key from the database.
+ Can user react to this subject
"""
- databaseId: Int
- id: ID!
+ viewerCanReact: Boolean!
+}
+"""
+The connection type for User.
+"""
+type ReactingUserConnection {
"""
- The project column's name.
+ A list of edges.
"""
- name: String!
+ edges: [ReactingUserEdge]
"""
- The project that contains this column.
+ A list of nodes.
"""
- project: Project!
+ nodes: [User]
"""
- The semantic purpose of the column
+ Information to aid in pagination.
"""
- purpose: ProjectColumnPurpose
+ pageInfo: PageInfo!
"""
- The HTTP path for this project column
+ Identifies the total count of items in the connection.
"""
- resourcePath: URI!
+ totalCount: Int!
+}
+"""
+Represents a user that's made a reaction.
+"""
+type ReactingUserEdge {
"""
- Identifies the date and time when the object was last updated.
+ A cursor for use in pagination.
"""
- updatedAt: DateTime!
+ cursor: String!
+ node: User!
"""
- The HTTP URL for this project column
+ The moment when the user made the reaction.
"""
- url: URI!
+ reactedAt: DateTime!
}
"""
-The connection type for ProjectColumn.
+An emoji reaction to a particular piece of content.
"""
-type ProjectColumnConnection {
+type Reaction implements Node {
"""
- A list of edges.
+ Identifies the emoji reaction.
"""
- edges: [ProjectColumnEdge]
+ content: ReactionContent!
"""
- A list of nodes.
+ Identifies the date and time when the object was created.
"""
- nodes: [ProjectColumn]
+ createdAt: DateTime!
"""
- Information to aid in pagination.
+ Identifies the primary key from the database.
"""
- pageInfo: PageInfo!
+ databaseId: Int
+ id: ID!
"""
- Identifies the total count of items in the connection.
+ The reactable piece of content
"""
- totalCount: Int!
+ reactable: Reactable!
+
+ """
+ Identifies the user who created this reaction.
+ """
+ user: User
}
"""
-An edge in a connection.
+A list of reactions that have been left on the subject.
"""
-type ProjectColumnEdge {
+type ReactionConnection {
"""
- A cursor for use in pagination.
+ A list of edges.
"""
- cursor: String!
+ edges: [ReactionEdge]
"""
- The item at the end of the edge.
+ A list of nodes.
"""
- node: ProjectColumn
-}
+ nodes: [Reaction]
-"""
-A project column and a list of its issues and PRs.
-"""
-input ProjectColumnImport {
"""
- The name of the column.
+ Information to aid in pagination.
"""
- columnName: String!
+ pageInfo: PageInfo!
"""
- A list of issues and pull requests in the column.
+ Identifies the total count of items in the connection.
"""
- issues: [ProjectCardImport!]
+ totalCount: Int!
"""
- The position of the column, starting from 0.
+ Whether or not the authenticated user has left a reaction on the subject.
"""
- position: Int!
+ viewerHasReacted: Boolean!
}
"""
-The semantic purpose of the column - todo, in progress, or done.
+Emojis that can be attached to Issues, Pull Requests and Comments.
"""
-enum ProjectColumnPurpose {
- """
- The column contains cards which are complete
- """
- DONE
-
+enum ReactionContent {
"""
- The column contains cards which are currently being worked on
+ Represents the `:confused:` emoji.
"""
- IN_PROGRESS
+ CONFUSED
"""
- The column contains cards still to be worked on
+ Represents the `:eyes:` emoji.
"""
- TODO
-}
+ EYES
-"""
-A list of projects associated with the owner.
-"""
-type ProjectConnection {
"""
- A list of edges.
+ Represents the `:heart:` emoji.
"""
- edges: [ProjectEdge]
+ HEART
"""
- A list of nodes.
+ Represents the `:hooray:` emoji.
"""
- nodes: [Project]
+ HOORAY
"""
- Information to aid in pagination.
+ Represents the `:laugh:` emoji.
"""
- pageInfo: PageInfo!
+ LAUGH
"""
- Identifies the total count of items in the connection.
+ Represents the `:rocket:` emoji.
"""
- totalCount: Int!
-}
+ ROCKET
-"""
-An edge in a connection.
-"""
-type ProjectEdge {
"""
- A cursor for use in pagination.
+ Represents the `:-1:` emoji.
"""
- cursor: String!
+ THUMBS_DOWN
"""
- The item at the end of the edge.
+ Represents the `:+1:` emoji.
"""
- node: Project
+ THUMBS_UP
}
"""
-Ways in which lists of projects can be ordered upon return.
+An edge in a connection.
"""
-input ProjectOrder {
+type ReactionEdge {
"""
- The direction in which to order projects by the specified field.
+ A cursor for use in pagination.
"""
- direction: OrderDirection!
+ cursor: String!
"""
- The field in which to order projects by.
+ The item at the end of the edge.
"""
- field: ProjectOrderField!
+ node: Reaction
}
"""
-Properties by which project connections can be ordered.
+A group of emoji reactions to a particular piece of content.
"""
-enum ProjectOrderField {
- """
- Order projects by creation time
- """
- CREATED_AT
-
+type ReactionGroup {
"""
- Order projects by name
+ Identifies the emoji reaction.
"""
- NAME
+ content: ReactionContent!
"""
- Order projects by update time
+ Identifies when the reaction was created.
"""
- UPDATED_AT
-}
-
-"""
-Represents an owner of a Project.
-"""
-interface ProjectOwner {
- id: ID!
+ createdAt: DateTime
"""
- Find project by number.
+ The subject that was reacted to.
"""
- project(
- """
- The project number to find.
- """
- number: Int!
- ): Project
+ subject: Reactable!
"""
- A list of projects under the owner.
+ Users who have reacted to the reaction subject with the emotion represented by this reaction group
"""
- projects(
+ users(
"""
Returns the elements in the list that come after the specified cursor.
"""
@@ -15651,181 +23277,88 @@ interface ProjectOwner {
Returns the last _n_ elements from the list.
"""
last: Int
-
- """
- Ordering options for projects returned from the connection
- """
- orderBy: ProjectOrder
-
- """
- Query to search projects by, currently only searching by name.
- """
- search: String
-
- """
- A list of states to filter the projects by.
- """
- states: [ProjectState!]
- ): ProjectConnection!
-
- """
- The HTTP path listing owners projects
- """
- projectsResourcePath: URI!
-
- """
- The HTTP URL listing owners projects
- """
- projectsUrl: URI!
+ ): ReactingUserConnection!
"""
- Can the current viewer create new projects on this owner.
+ Whether or not the authenticated user has left a reaction on the subject.
"""
- viewerCanCreateProjects: Boolean!
+ viewerHasReacted: Boolean!
}
"""
-State of the project; either 'open' or 'closed'
+Ways in which lists of reactions can be ordered upon return.
"""
-enum ProjectState {
+input ReactionOrder {
"""
- The project is closed.
+ The direction in which to order reactions by the specified field.
"""
- CLOSED
+ direction: OrderDirection!
"""
- The project is open.
+ The field in which to order reactions by.
"""
- OPEN
+ field: ReactionOrderField!
}
"""
-GitHub-provided templates for Projects
+A list of fields that reactions can be ordered by.
"""
-enum ProjectTemplate {
- """
- Create a board with v2 triggers to automatically move cards across To do, In progress and Done columns.
- """
- AUTOMATED_KANBAN_V2
-
- """
- Create a board with triggers to automatically move cards across columns with review automation.
- """
- AUTOMATED_REVIEWS_KANBAN
-
- """
- Create a board with columns for To do, In progress and Done.
- """
- BASIC_KANBAN
-
+enum ReactionOrderField {
"""
- Create a board to triage and prioritize bugs with To do, priority, and Done columns.
+ Allows ordering a list of reactions by when they were created.
"""
- BUG_TRIAGE
+ CREATED_AT
}
"""
-A user's public key.
+Represents a 'ready_for_review' event on a given pull request.
"""
-type PublicKey implements Node {
- """
- The last time this authorization was used to perform an action. Values will be null for keys not owned by the user.
- """
- accessedAt: DateTime
-
+type ReadyForReviewEvent implements Node & UniformResourceLocatable {
"""
- Identifies the date and time when the key was created. Keys created before
- March 5th, 2014 have inaccurate values. Values will be null for keys not owned by the user.
+ Identifies the actor who performed the event.
"""
- createdAt: DateTime
+ actor: Actor
"""
- The fingerprint for this PublicKey.
+ Identifies the date and time when the object was created.
"""
- fingerprint: String!
+ createdAt: DateTime!
id: ID!
"""
- Whether this PublicKey is read-only or not. Values will be null for keys not owned by the user.
- """
- isReadOnly: Boolean
-
- """
- The public key string.
- """
- key: String!
-
- """
- Identifies the date and time when the key was updated. Keys created before
- March 5th, 2014 may have inaccurate values. Values will be null for keys not
- owned by the user.
- """
- updatedAt: DateTime
-}
-
-"""
-The connection type for PublicKey.
-"""
-type PublicKeyConnection {
- """
- A list of edges.
- """
- edges: [PublicKeyEdge]
-
- """
- A list of nodes.
- """
- nodes: [PublicKey]
-
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
-
- """
- Identifies the total count of items in the connection.
+ PullRequest referenced by event.
"""
- totalCount: Int!
-}
+ pullRequest: PullRequest!
-"""
-An edge in a connection.
-"""
-type PublicKeyEdge {
"""
- A cursor for use in pagination.
+ The HTTP path for this ready for review event.
"""
- cursor: String!
+ resourcePath: URI!
"""
- The item at the end of the edge.
+ The HTTP URL for this ready for review event.
"""
- node: PublicKey
+ url: URI!
}
"""
-A repository pull request.
+Represents a Git reference.
"""
-type PullRequest implements Assignable & Closable & Comment & Labelable & Lockable & Node & Reactable & RepositoryNode & Subscribable & UniformResourceLocatable & Updatable & UpdatableComment {
- """
- Reason that the conversation was locked.
- """
- activeLockReason: LockReason
-
- """
- The number of additions in this pull request.
- """
- additions: Int!
-
+type Ref implements Node {
"""
- A list of Users assigned to this object.
+ A list of pull requests with this ref as the head ref.
"""
- assignees(
+ associatedPullRequests(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
+ """
+ The base ref name to filter the pull requests by.
+ """
+ baseRefName: String
+
"""
Returns the elements in the list that come before the specified cursor.
"""
@@ -15836,312 +23369,299 @@ type PullRequest implements Assignable & Closable & Comment & Labelable & Lockab
"""
first: Int
+ """
+ The head ref name to filter the pull requests by.
+ """
+ headRefName: String
+
+ """
+ A list of label names to filter the pull requests by.
+ """
+ labels: [String!]
+
"""
Returns the last _n_ elements from the list.
"""
last: Int
- ): UserConnection!
+
+ """
+ Ordering options for pull requests returned from the connection.
+ """
+ orderBy: IssueOrder
+
+ """
+ A list of states to filter the pull requests by.
+ """
+ states: [PullRequestState!]
+ ): PullRequestConnection!
"""
- The actor who authored the comment.
+ Branch protection rules for this ref
"""
- author: Actor
+ branchProtectionRule: BranchProtectionRule
+ id: ID!
"""
- Author's association with the subject of the comment.
+ The ref name.
"""
- authorAssociation: CommentAuthorAssociation!
+ name: String!
"""
- Identifies the base Ref associated with the pull request.
+ The ref's prefix, such as `refs/heads/` or `refs/tags/`.
"""
- baseRef: Ref
+ prefix: String!
"""
- Identifies the name of the base Ref associated with the pull request, even if the ref has been deleted.
+ Branch protection rules that are viewable by non-admins
"""
- baseRefName: String!
+ refUpdateRule: RefUpdateRule
"""
- Identifies the oid of the base ref associated with the pull request, even if the ref has been deleted.
+ The repository the ref belongs to.
"""
- baseRefOid: GitObjectID!
+ repository: Repository!
"""
- The repository associated with this pull request's base Ref.
+ The object the ref points to. Returns null when object does not exist.
"""
- baseRepository: Repository
+ target: GitObject
+}
+"""
+The connection type for Ref.
+"""
+type RefConnection {
"""
- The body as Markdown.
+ A list of edges.
"""
- body: String!
+ edges: [RefEdge]
"""
- The body rendered to HTML.
+ A list of nodes.
"""
- bodyHTML: HTML!
+ nodes: [Ref]
"""
- The body rendered to text.
+ Information to aid in pagination.
"""
- bodyText: String!
+ pageInfo: PageInfo!
"""
- Whether or not the pull request is rebaseable.
+ Identifies the total count of items in the connection.
"""
- canBeRebased: Boolean! @preview(toggledBy: "merge-info-preview")
+ totalCount: Int!
+}
+"""
+An edge in a connection.
+"""
+type RefEdge {
"""
- The number of changed files in this pull request.
+ A cursor for use in pagination.
"""
- changedFiles: Int!
+ cursor: String!
"""
- `true` if the pull request is closed
+ The item at the end of the edge.
"""
- closed: Boolean!
+ node: Ref
+}
+"""
+Ways in which lists of git refs can be ordered upon return.
+"""
+input RefOrder {
"""
- Identifies the date and time when the object was closed.
+ The direction in which to order refs by the specified field.
"""
- closedAt: DateTime
+ direction: OrderDirection!
"""
- A list of comments associated with the pull request.
+ The field in which to order refs by.
"""
- comments(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): IssueCommentConnection!
+ field: RefOrderField!
+}
+"""
+Properties by which ref connections can be ordered.
+"""
+enum RefOrderField {
"""
- A list of commits present in this pull request's head branch not present in the base branch.
+ Order refs by their alphanumeric name
"""
- commits(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): PullRequestCommitConnection!
+ ALPHABETICAL
"""
- Identifies the date and time when the object was created.
+ Order refs by underlying commit date if the ref prefix is refs/tags/
"""
- createdAt: DateTime!
+ TAG_COMMIT_DATE
+}
+"""
+A ref update
+"""
+input RefUpdate @preview(toggledBy: "update-refs-preview") {
"""
- Check if this comment was created via an email reply.
+ The value this ref should be updated to.
"""
- createdViaEmail: Boolean!
+ afterOid: GitObjectID!
"""
- Identifies the primary key from the database.
+ The value this ref needs to point to before the update.
"""
- databaseId: Int
+ beforeOid: GitObjectID
"""
- The number of deletions in this pull request.
+ Force a non fast-forward update.
"""
- deletions: Int!
+ force: Boolean = false
"""
- The actor who edited this pull request's body.
+ The fully qualified name of the ref to be update. For example `refs/heads/branch-name`
"""
- editor: Actor
+ name: GitRefname!
+}
+"""
+A ref update rules for a viewer.
+"""
+type RefUpdateRule {
"""
- Lists the files changed within this pull request.
+ Can this branch be deleted.
"""
- files(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): PullRequestChangedFileConnection
+ allowsDeletions: Boolean!
"""
- Identifies the head Ref associated with the pull request.
+ Are force pushes allowed on this branch.
"""
- headRef: Ref
+ allowsForcePushes: Boolean!
"""
- Identifies the name of the head Ref associated with the pull request, even if the ref has been deleted.
+ Identifies the protection rule pattern.
"""
- headRefName: String!
+ pattern: String!
"""
- Identifies the oid of the head ref associated with the pull request, even if the ref has been deleted.
+ Number of approving reviews required to update matching branches.
"""
- headRefOid: GitObjectID!
+ requiredApprovingReviewCount: Int
"""
- The repository associated with this pull request's head Ref.
+ List of required status check contexts that must pass for commits to be accepted to matching branches.
"""
- headRepository: Repository
+ requiredStatusCheckContexts: [String]
"""
- The owner of the repository associated with this pull request's head Ref.
+ Are merge commits prohibited from being pushed to this branch.
"""
- headRepositoryOwner: RepositoryOwner
+ requiresLinearHistory: Boolean!
"""
- The hovercard information for this issue
+ Are commits required to be signed.
"""
- hovercard(
- """
- Whether or not to include notification contexts
- """
- includeNotificationContexts: Boolean = true
- ): Hovercard! @preview(toggledBy: "hagar-preview")
- id: ID!
+ requiresSignatures: Boolean!
"""
- Check if this comment was edited and includes an edit with the creation data
+ Can the viewer push to the branch
"""
- includesCreatedEdit: Boolean!
+ viewerCanPush: Boolean!
+}
+"""
+Represents a 'referenced' event on a given `ReferencedSubject`.
+"""
+type ReferencedEvent implements Node {
"""
- The head and base repositories are different.
+ Identifies the actor who performed the event.
"""
- isCrossRepository: Boolean!
+ actor: Actor
"""
- Identifies if the pull request is a draft.
+ Identifies the commit associated with the 'referenced' event.
"""
- isDraft: Boolean! @preview(toggledBy: "shadow-cat-preview")
+ commit: Commit
"""
- A list of labels associated with the object.
+ Identifies the repository associated with the 'referenced' event.
"""
- labels(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
+ commitRepository: Repository!
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): LabelConnection
+ """
+ Identifies the date and time when the object was created.
+ """
+ createdAt: DateTime!
+ id: ID!
"""
- The moment the editor made the last edit
+ Reference originated in a different repository.
"""
- lastEditedAt: DateTime
+ isCrossRepository: Boolean!
"""
- `true` if the pull request is locked
+ Checks if the commit message itself references the subject. Can be false in the case of a commit comment reference.
"""
- locked: Boolean!
+ isDirectReference: Boolean!
"""
- Indicates whether maintainers can modify the pull request.
+ Object referenced by event.
"""
- maintainerCanModify: Boolean!
+ subject: ReferencedSubject!
+}
+"""
+Any referencable object
+"""
+union ReferencedSubject = Issue | PullRequest
+
+"""
+A release contains the content for a release.
+"""
+type Release implements Node & UniformResourceLocatable {
"""
- The commit that was created when this pull request was merged.
+ The author of the release
"""
- mergeCommit: Commit
+ author: User
"""
- Detailed information about the current pull request merge state status.
+ Identifies the date and time when the object was created.
"""
- mergeStateStatus: MergeStateStatus! @preview(toggledBy: "merge-info-preview")
+ createdAt: DateTime!
"""
- Whether or not the pull request can be merged based on the existence of merge conflicts.
+ The description of the release.
"""
- mergeable: MergeableState!
+ description: String
"""
- Whether or not the pull request was merged.
+ The description of this release rendered to HTML.
"""
- merged: Boolean!
+ descriptionHTML: HTML
+ id: ID!
"""
- The date and time that the pull request was merged.
+ Whether or not the release is a draft
"""
- mergedAt: DateTime
+ isDraft: Boolean!
"""
- The actor who merged the pull request.
+ Whether or not the release is a prerelease
"""
- mergedBy: Actor
+ isPrerelease: Boolean!
"""
- Identifies the milestone associated with the pull request.
+ The title of the release.
"""
- milestone: Milestone
+ name: String
"""
- Identifies the pull request number.
+ Identifies the date and time when the release was created.
"""
- number: Int!
+ publishedAt: DateTime
"""
- A list of Users that are participating in the Pull Request conversation.
+ List of releases assets which are dependent on this release.
"""
- participants(
+ releaseAssets(
"""
Returns the elements in the list that come after the specified cursor.
"""
@@ -16161,3359 +23681,2790 @@ type PullRequest implements Assignable & Closable & Comment & Labelable & Lockab
Returns the last _n_ elements from the list.
"""
last: Int
- ): UserConnection!
- """
- The permalink to the pull request.
- """
- permalink: URI!
+ """
+ A list of names to filter the assets by.
+ """
+ name: String
+ ): ReleaseAssetConnection!
"""
- The commit that GitHub automatically generated to test if this pull request
- could be merged. This field will not return a value if the pull request is
- merged, or if the test merge commit is still being generated. See the
- `mergeable` field for more details on the mergeability of the pull request.
+ The HTTP path for this issue
"""
- potentialMergeCommit: Commit
+ resourcePath: URI!
"""
- List of project cards associated with this pull request.
+ A description of the release, rendered to HTML without any links in it.
"""
- projectCards(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- A list of archived states to filter the cards by
- """
- archivedStates: [ProjectCardArchivedState] = [ARCHIVED, NOT_ARCHIVED]
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
+ shortDescriptionHTML(
"""
- Returns the last _n_ elements from the list.
+ How many characters to return.
"""
- last: Int
- ): ProjectCardConnection!
+ limit: Int = 200
+ ): HTML
"""
- Identifies when the comment was published at.
+ The Git tag the release points to
"""
- publishedAt: DateTime
+ tag: Ref
"""
- A list of reactions grouped by content left on the subject.
+ The name of the release's Git tag
"""
- reactionGroups: [ReactionGroup!]
+ tagName: String!
"""
- A list of Reactions left on the Issue.
+ Identifies the date and time when the object was last updated.
"""
- reactions(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
+ updatedAt: DateTime!
- """
- Allows filtering Reactions by emoji.
- """
- content: ReactionContent
+ """
+ The HTTP URL for this issue
+ """
+ url: URI!
+}
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
+"""
+A release asset contains the content for a release asset.
+"""
+type ReleaseAsset implements Node {
+ """
+ The asset's content-type
+ """
+ contentType: String!
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
+ """
+ Identifies the date and time when the object was created.
+ """
+ createdAt: DateTime!
- """
- Allows specifying the order in which reactions are returned.
- """
- orderBy: ReactionOrder
- ): ReactionConnection!
+ """
+ The number of times this asset was downloaded
+ """
+ downloadCount: Int!
"""
- The repository associated with this node.
+ Identifies the URL where you can download the release asset via the browser.
"""
- repository: Repository!
+ downloadUrl: URI!
+ id: ID!
"""
- The HTTP path for this pull request.
+ Identifies the title of the release asset.
"""
- resourcePath: URI!
+ name: String!
"""
- The HTTP path for reverting this pull request.
+ Release that the asset is associated with
"""
- revertResourcePath: URI!
+ release: Release
"""
- The HTTP URL for reverting this pull request.
+ The size (in bytes) of the asset
"""
- revertUrl: URI!
+ size: Int!
"""
- A list of review requests associated with the pull request.
+ Identifies the date and time when the object was last updated.
"""
- reviewRequests(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
+ updatedAt: DateTime!
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
+ """
+ The user that performed the upload
+ """
+ uploadedBy: User!
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
+ """
+ Identifies the URL of the release asset.
+ """
+ url: URI!
+}
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): ReviewRequestConnection
+"""
+The connection type for ReleaseAsset.
+"""
+type ReleaseAssetConnection {
+ """
+ A list of edges.
+ """
+ edges: [ReleaseAssetEdge]
"""
- The list of all review threads for this pull request.
+ A list of nodes.
"""
- reviewThreads(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
+ nodes: [ReleaseAsset]
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
+ """
+ Information to aid in pagination.
+ """
+ pageInfo: PageInfo!
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
+ """
+ Identifies the total count of items in the connection.
+ """
+ totalCount: Int!
+}
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): PullRequestReviewThreadConnection!
+"""
+An edge in a connection.
+"""
+type ReleaseAssetEdge {
+ """
+ A cursor for use in pagination.
+ """
+ cursor: String!
"""
- A list of reviews associated with the pull request.
+ The item at the end of the edge.
"""
- reviews(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
+ node: ReleaseAsset
+}
- """
- Filter by author of the review.
- """
- author: String
+"""
+The connection type for Release.
+"""
+type ReleaseConnection {
+ """
+ A list of edges.
+ """
+ edges: [ReleaseEdge]
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
+ """
+ A list of nodes.
+ """
+ nodes: [Release]
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
+ """
+ Information to aid in pagination.
+ """
+ pageInfo: PageInfo!
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
+ """
+ Identifies the total count of items in the connection.
+ """
+ totalCount: Int!
+}
- """
- A list of states to filter the reviews.
- """
- states: [PullRequestReviewState!]
- ): PullRequestReviewConnection
+"""
+An edge in a connection.
+"""
+type ReleaseEdge {
+ """
+ A cursor for use in pagination.
+ """
+ cursor: String!
"""
- Identifies the state of the pull request.
+ The item at the end of the edge.
"""
- state: PullRequestState!
+ node: Release
+}
+"""
+Ways in which lists of releases can be ordered upon return.
+"""
+input ReleaseOrder {
"""
- A list of reviewer suggestions based on commit history and past review comments.
+ The direction in which to order releases by the specified field.
"""
- suggestedReviewers: [SuggestedReviewer]!
+ direction: OrderDirection!
"""
- A list of events, comments, commits, etc. associated with the pull request.
+ The field in which to order releases by.
"""
- timeline(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
+ field: ReleaseOrderField!
+}
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
+"""
+Properties by which release connections can be ordered.
+"""
+enum ReleaseOrderField {
+ """
+ Order releases by creation time
+ """
+ CREATED_AT
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
+ """
+ Order releases alphabetically by name
+ """
+ NAME
+}
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
+"""
+Autogenerated input type of RemoveAssigneesFromAssignable
+"""
+input RemoveAssigneesFromAssignableInput {
+ """
+ The id of the assignable object to remove assignees from.
+ """
+ assignableId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "Assignable")
- """
- Allows filtering timeline events by a `since` timestamp.
- """
- since: DateTime
- ): PullRequestTimelineConnection! @deprecated(reason: "`timeline` will be removed Use PullRequest.timelineItems instead. Removal on 2019-10-01 UTC.")
+ """
+ The id of users to remove as assignees.
+ """
+ assigneeIds: [ID!]! @possibleTypes(concreteTypes: ["User"])
"""
- A list of events, comments, commits, etc. associated with the pull request.
+ A unique identifier for the client performing the mutation.
"""
- timelineItems(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
+ clientMutationId: String
+}
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
+"""
+Autogenerated return type of RemoveAssigneesFromAssignable
+"""
+type RemoveAssigneesFromAssignablePayload {
+ """
+ The item that was unassigned.
+ """
+ assignable: Assignable
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
+ """
+ A unique identifier for the client performing the mutation.
+ """
+ clientMutationId: String
+}
- """
- Filter timeline items by type.
- """
- itemTypes: [PullRequestTimelineItemsItemType!]
+"""
+Autogenerated input type of RemoveEnterpriseAdmin
+"""
+input RemoveEnterpriseAdminInput {
+ """
+ A unique identifier for the client performing the mutation.
+ """
+ clientMutationId: String
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
+ """
+ The Enterprise ID from which to remove the administrator.
+ """
+ enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"])
- """
- Filter timeline items by a `since` timestamp.
- """
- since: DateTime
+ """
+ The login of the user to remove as an administrator.
+ """
+ login: String!
+}
- """
- Skips the first _n_ elements in the list.
- """
- skip: Int
- ): PullRequestTimelineItemsConnection!
+"""
+Autogenerated return type of RemoveEnterpriseAdmin
+"""
+type RemoveEnterpriseAdminPayload {
+ """
+ The user who was removed as an administrator.
+ """
+ admin: User
"""
- Identifies the pull request title.
+ A unique identifier for the client performing the mutation.
"""
- title: String!
+ clientMutationId: String
"""
- Identifies the date and time when the object was last updated.
+ The updated enterprise.
"""
- updatedAt: DateTime!
+ enterprise: Enterprise
"""
- The HTTP URL for this pull request.
+ A message confirming the result of removing an administrator.
"""
- url: URI!
+ message: String
"""
- A list of edits to this content.
+ The viewer performing the mutation.
"""
- userContentEdits(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
+ viewer: User
+}
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
+"""
+Autogenerated input type of RemoveLabelsFromLabelable
+"""
+input RemoveLabelsFromLabelableInput {
+ """
+ A unique identifier for the client performing the mutation.
+ """
+ clientMutationId: String
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
+ """
+ The ids of labels to remove.
+ """
+ labelIds: [ID!]! @possibleTypes(concreteTypes: ["Label"])
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): UserContentEditConnection
+ """
+ The id of the Labelable to remove labels from.
+ """
+ labelableId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "Labelable")
+}
+"""
+Autogenerated return type of RemoveLabelsFromLabelable
+"""
+type RemoveLabelsFromLabelablePayload {
"""
- Whether or not the viewer can apply suggestion.
+ A unique identifier for the client performing the mutation.
"""
- viewerCanApplySuggestion: Boolean!
+ clientMutationId: String
"""
- Can user react to this subject
+ The Labelable the labels were removed from.
"""
- viewerCanReact: Boolean!
+ labelable: Labelable
+}
+"""
+Autogenerated input type of RemoveOutsideCollaborator
+"""
+input RemoveOutsideCollaboratorInput {
"""
- Check if the viewer is able to change their subscription status for the repository.
+ A unique identifier for the client performing the mutation.
"""
- viewerCanSubscribe: Boolean!
+ clientMutationId: String
"""
- Check if the current viewer can update this object.
+ The ID of the organization to remove the outside collaborator from.
"""
- viewerCanUpdate: Boolean!
+ organizationId: ID! @possibleTypes(concreteTypes: ["Organization"])
"""
- Reasons why the current viewer can not update this comment.
+ The ID of the outside collaborator to remove.
"""
- viewerCannotUpdateReasons: [CommentCannotUpdateReason!]!
+ userId: ID! @possibleTypes(concreteTypes: ["User"])
+}
+"""
+Autogenerated return type of RemoveOutsideCollaborator
+"""
+type RemoveOutsideCollaboratorPayload {
"""
- Did the viewer author this comment.
+ A unique identifier for the client performing the mutation.
"""
- viewerDidAuthor: Boolean!
+ clientMutationId: String
"""
- Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
+ The user that was removed as an outside collaborator.
"""
- viewerSubscription: SubscriptionState
+ removedUser: User
}
"""
-A file changed in a pull request.
+Autogenerated input type of RemoveReaction
"""
-type PullRequestChangedFile {
+input RemoveReactionInput {
"""
- The number of additions to the file.
+ A unique identifier for the client performing the mutation.
"""
- additions: Int!
+ clientMutationId: String
"""
- The number of deletions to the file.
+ The name of the emoji reaction to remove.
"""
- deletions: Int!
+ content: ReactionContent!
"""
- The path of the file.
+ The Node ID of the subject to modify.
"""
- path: String!
+ subjectId: ID! @possibleTypes(concreteTypes: ["CommitComment", "Issue", "IssueComment", "PullRequest", "PullRequestReview", "PullRequestReviewComment", "TeamDiscussion", "TeamDiscussionComment"], abstractType: "Reactable")
}
"""
-The connection type for PullRequestChangedFile.
+Autogenerated return type of RemoveReaction
"""
-type PullRequestChangedFileConnection {
+type RemoveReactionPayload {
+ """
+ A unique identifier for the client performing the mutation.
+ """
+ clientMutationId: String
+
"""
- A list of edges.
+ The reaction object.
"""
- edges: [PullRequestChangedFileEdge]
+ reaction: Reaction
"""
- A list of nodes.
+ The reactable subject.
"""
- nodes: [PullRequestChangedFile]
+ subject: Reactable
+}
+"""
+Autogenerated input type of RemoveStar
+"""
+input RemoveStarInput {
"""
- Information to aid in pagination.
+ A unique identifier for the client performing the mutation.
"""
- pageInfo: PageInfo!
+ clientMutationId: String
"""
- Identifies the total count of items in the connection.
+ The Starrable ID to unstar.
"""
- totalCount: Int!
+ starrableId: ID! @possibleTypes(concreteTypes: ["Gist", "Repository", "Topic"], abstractType: "Starrable")
}
"""
-An edge in a connection.
+Autogenerated return type of RemoveStar
"""
-type PullRequestChangedFileEdge {
+type RemoveStarPayload {
"""
- A cursor for use in pagination.
+ A unique identifier for the client performing the mutation.
"""
- cursor: String!
+ clientMutationId: String
"""
- The item at the end of the edge.
+ The starrable.
"""
- node: PullRequestChangedFile
+ starrable: Starrable
}
"""
-Represents a Git commit part of a pull request.
+Represents a 'removed_from_project' event on a given issue or pull request.
"""
-type PullRequestCommit implements Node & UniformResourceLocatable {
+type RemovedFromProjectEvent implements Node {
"""
- The Git commit object
+ Identifies the actor who performed the event.
"""
- commit: Commit!
- id: ID!
+ actor: Actor
"""
- The pull request this commit belongs to
+ Identifies the date and time when the object was created.
"""
- pullRequest: PullRequest!
+ createdAt: DateTime!
"""
- The HTTP path for this pull request commit
+ Identifies the primary key from the database.
"""
- resourcePath: URI!
+ databaseId: Int
+ id: ID!
"""
- The HTTP URL for this pull request commit
+ Project referenced by event.
"""
- url: URI!
+ project: Project @preview(toggledBy: "starfox-preview")
+
+ """
+ Column name referenced by this project event.
+ """
+ projectColumnName: String! @preview(toggledBy: "starfox-preview")
}
"""
-Represents a commit comment thread part of a pull request.
+Represents a 'renamed' event on a given issue or pull request
"""
-type PullRequestCommitCommentThread implements Node & RepositoryNode {
+type RenamedTitleEvent implements Node {
"""
- The comments that exist in this thread.
+ Identifies the actor who performed the event.
"""
- comments(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
+ actor: Actor
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): CommitCommentConnection!
+ """
+ Identifies the date and time when the object was created.
+ """
+ createdAt: DateTime!
"""
- The commit the comments were made on.
+ Identifies the current title of the issue or pull request.
"""
- commit: Commit!
+ currentTitle: String!
id: ID!
"""
- The file the comments were made on.
+ Identifies the previous title of the issue or pull request.
"""
- path: String
+ previousTitle: String!
"""
- The position in the diff for the commit that the comment was made on.
+ Subject that was renamed.
"""
- position: Int
+ subject: RenamedTitleSubject!
+}
+
+"""
+An object which has a renamable title
+"""
+union RenamedTitleSubject = Issue | PullRequest
+"""
+Autogenerated input type of ReopenIssue
+"""
+input ReopenIssueInput {
"""
- The pull request this commit comment thread belongs to
+ A unique identifier for the client performing the mutation.
"""
- pullRequest: PullRequest!
+ clientMutationId: String
"""
- The repository associated with this node.
+ ID of the issue to be opened.
"""
- repository: Repository!
+ issueId: ID! @possibleTypes(concreteTypes: ["Issue"])
}
"""
-The connection type for PullRequestCommit.
+Autogenerated return type of ReopenIssue
"""
-type PullRequestCommitConnection {
+type ReopenIssuePayload {
"""
- A list of edges.
+ A unique identifier for the client performing the mutation.
"""
- edges: [PullRequestCommitEdge]
+ clientMutationId: String
"""
- A list of nodes.
+ The issue that was opened.
"""
- nodes: [PullRequestCommit]
+ issue: Issue
+}
+"""
+Autogenerated input type of ReopenPullRequest
+"""
+input ReopenPullRequestInput {
"""
- Information to aid in pagination.
+ A unique identifier for the client performing the mutation.
"""
- pageInfo: PageInfo!
+ clientMutationId: String
"""
- Identifies the total count of items in the connection.
+ ID of the pull request to be reopened.
"""
- totalCount: Int!
+ pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"])
}
"""
-An edge in a connection.
+Autogenerated return type of ReopenPullRequest
"""
-type PullRequestCommitEdge {
+type ReopenPullRequestPayload {
"""
- A cursor for use in pagination.
+ A unique identifier for the client performing the mutation.
"""
- cursor: String!
+ clientMutationId: String
"""
- The item at the end of the edge.
+ The pull request that was reopened.
"""
- node: PullRequestCommit
+ pullRequest: PullRequest
}
"""
-The connection type for PullRequest.
+Represents a 'reopened' event on any `Closable`.
"""
-type PullRequestConnection {
- """
- A list of edges.
- """
- edges: [PullRequestEdge]
-
+type ReopenedEvent implements Node {
"""
- A list of nodes.
+ Identifies the actor who performed the event.
"""
- nodes: [PullRequest]
+ actor: Actor
"""
- Information to aid in pagination.
+ Object that was reopened.
"""
- pageInfo: PageInfo!
+ closable: Closable!
"""
- Identifies the total count of items in the connection.
+ Identifies the date and time when the object was created.
"""
- totalCount: Int!
+ createdAt: DateTime!
+ id: ID!
}
"""
-This aggregates pull requests opened by a user within one repository.
+Audit log entry for a repo.access event.
"""
-type PullRequestContributionsByRepository {
+type RepoAccessAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData {
"""
- The pull request contributions.
+ The action name
"""
- contributions(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
+ action: String!
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
+ """
+ The user who initiated the action
+ """
+ actor: AuditEntryActor
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
+ """
+ The IP address of the actor
+ """
+ actorIp: String
- """
- Ordering options for contributions returned from the connection.
- """
- orderBy: ContributionOrder = {field: OCCURRED_AT, direction: DESC}
- ): CreatedPullRequestContributionConnection!
+ """
+ A readable representation of the actor's location
+ """
+ actorLocation: ActorLocation
"""
- The repository in which the pull requests were opened.
+ The username of the user who initiated the action
"""
- repository: Repository!
-}
+ actorLogin: String
-"""
-An edge in a connection.
-"""
-type PullRequestEdge {
"""
- A cursor for use in pagination.
+ The HTTP path for the actor.
"""
- cursor: String!
+ actorResourcePath: URI
"""
- The item at the end of the edge.
+ The HTTP URL for the actor.
"""
- node: PullRequest
-}
+ actorUrl: URI
-"""
-Ways in which lists of issues can be ordered upon return.
-"""
-input PullRequestOrder {
"""
- The direction in which to order pull requests by the specified field.
+ The time the action was initiated
"""
- direction: OrderDirection!
+ createdAt: PreciseDateTime!
+ id: ID!
"""
- The field in which to order pull requests by.
+ The corresponding operation type for the action
"""
- field: PullRequestOrderField!
-}
+ operationType: OperationType
-"""
-Properties by which pull_requests connections can be ordered.
-"""
-enum PullRequestOrderField {
"""
- Order pull_requests by creation time
+ The Organization associated with the Audit Entry.
"""
- CREATED_AT
+ organization: Organization
"""
- Order pull_requests by update time
+ The name of the Organization.
"""
- UPDATED_AT
-}
+ organizationName: String
-"""
-A review object for a given pull request.
-"""
-type PullRequestReview implements Comment & Deletable & Node & Reactable & RepositoryNode & Updatable & UpdatableComment {
"""
- The actor who authored the comment.
+ The HTTP path for the organization
"""
- author: Actor
+ organizationResourcePath: URI
"""
- Author's association with the subject of the comment.
+ The HTTP URL for the organization
"""
- authorAssociation: CommentAuthorAssociation!
+ organizationUrl: URI
"""
- Identifies the pull request review body.
+ The repository associated with the action
"""
- body: String!
+ repository: Repository
"""
- The body of this review rendered to HTML.
+ The name of the repository
"""
- bodyHTML: HTML!
+ repositoryName: String
"""
- The body of this review rendered as plain text.
+ The HTTP path for the repository
"""
- bodyText: String!
+ repositoryResourcePath: URI
"""
- A list of review comments for the current pull request review.
+ The HTTP URL for the repository
"""
- comments(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): PullRequestReviewCommentConnection!
+ repositoryUrl: URI
"""
- Identifies the commit associated with this pull request review.
+ The user affected by the action
"""
- commit: Commit
+ user: User
"""
- Identifies the date and time when the object was created.
+ For actions involving two users, the actor is the initiator and the user is the affected user.
"""
- createdAt: DateTime!
+ userLogin: String
"""
- Check if this comment was created via an email reply.
+ The HTTP path for the user.
"""
- createdViaEmail: Boolean!
+ userResourcePath: URI
"""
- Identifies the primary key from the database.
+ The HTTP URL for the user.
"""
- databaseId: Int
+ userUrl: URI
"""
- The actor who edited the comment.
+ The visibility of the repository
"""
- editor: Actor
- id: ID!
+ visibility: RepoAccessAuditEntryVisibility
+}
+"""
+The privacy of a repository
+"""
+enum RepoAccessAuditEntryVisibility {
"""
- Check if this comment was edited and includes an edit with the creation data
+ The repository is visible only to users in the same business.
"""
- includesCreatedEdit: Boolean!
+ INTERNAL
"""
- The moment the editor made the last edit
+ The repository is visible only to those with explicit access.
"""
- lastEditedAt: DateTime
+ PRIVATE
"""
- A list of teams that this review was made on behalf of.
+ The repository is visible to everyone.
"""
- onBehalfOf(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): TeamConnection!
+ PUBLIC
+}
+"""
+Audit log entry for a repo.add_member event.
+"""
+type RepoAddMemberAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData {
"""
- Identifies when the comment was published at.
+ The action name
"""
- publishedAt: DateTime
+ action: String!
"""
- Identifies the pull request associated with this pull request review.
+ The user who initiated the action
"""
- pullRequest: PullRequest!
+ actor: AuditEntryActor
"""
- A list of reactions grouped by content left on the subject.
+ The IP address of the actor
"""
- reactionGroups: [ReactionGroup!]
+ actorIp: String
"""
- A list of Reactions left on the Issue.
+ A readable representation of the actor's location
"""
- reactions(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Allows filtering Reactions by emoji.
- """
- content: ReactionContent
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Allows specifying the order in which reactions are returned.
- """
- orderBy: ReactionOrder
- ): ReactionConnection!
+ actorLocation: ActorLocation
"""
- The repository associated with this node.
+ The username of the user who initiated the action
"""
- repository: Repository!
+ actorLogin: String
"""
- The HTTP path permalink for this PullRequestReview.
+ The HTTP path for the actor.
"""
- resourcePath: URI!
+ actorResourcePath: URI
"""
- Identifies the current state of the pull request review.
+ The HTTP URL for the actor.
"""
- state: PullRequestReviewState!
+ actorUrl: URI
"""
- Identifies when the Pull Request Review was submitted
+ The time the action was initiated
"""
- submittedAt: DateTime
+ createdAt: PreciseDateTime!
+ id: ID!
"""
- Identifies the date and time when the object was last updated.
+ The corresponding operation type for the action
"""
- updatedAt: DateTime!
+ operationType: OperationType
"""
- The HTTP URL permalink for this PullRequestReview.
+ The Organization associated with the Audit Entry.
"""
- url: URI!
+ organization: Organization
"""
- A list of edits to this content.
+ The name of the Organization.
"""
- userContentEdits(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
+ organizationName: String
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
+ """
+ The HTTP path for the organization
+ """
+ organizationResourcePath: URI
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
+ """
+ The HTTP URL for the organization
+ """
+ organizationUrl: URI
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): UserContentEditConnection
+ """
+ The repository associated with the action
+ """
+ repository: Repository
"""
- Check if the current viewer can delete this object.
+ The name of the repository
"""
- viewerCanDelete: Boolean!
+ repositoryName: String
"""
- Can user react to this subject
+ The HTTP path for the repository
"""
- viewerCanReact: Boolean!
+ repositoryResourcePath: URI
"""
- Check if the current viewer can update this object.
+ The HTTP URL for the repository
"""
- viewerCanUpdate: Boolean!
+ repositoryUrl: URI
"""
- Reasons why the current viewer can not update this comment.
+ The user affected by the action
"""
- viewerCannotUpdateReasons: [CommentCannotUpdateReason!]!
+ user: User
"""
- Did the viewer author this comment.
+ For actions involving two users, the actor is the initiator and the user is the affected user.
"""
- viewerDidAuthor: Boolean!
-}
+ userLogin: String
-"""
-A review comment associated with a given repository pull request.
-"""
-type PullRequestReviewComment implements Comment & Deletable & Minimizable & Node & Reactable & RepositoryNode & Updatable & UpdatableComment {
"""
- The actor who authored the comment.
+ The HTTP path for the user.
"""
- author: Actor
+ userResourcePath: URI
"""
- Author's association with the subject of the comment.
+ The HTTP URL for the user.
"""
- authorAssociation: CommentAuthorAssociation!
+ userUrl: URI
"""
- The comment body of this review comment.
+ The visibility of the repository
"""
- body: String!
+ visibility: RepoAddMemberAuditEntryVisibility
+}
+"""
+The privacy of a repository
+"""
+enum RepoAddMemberAuditEntryVisibility {
"""
- The comment body of this review comment rendered to HTML.
+ The repository is visible only to users in the same business.
"""
- bodyHTML: HTML!
+ INTERNAL
"""
- The comment body of this review comment rendered as plain text.
+ The repository is visible only to those with explicit access.
"""
- bodyText: String!
+ PRIVATE
"""
- Identifies the commit associated with the comment.
+ The repository is visible to everyone.
"""
- commit: Commit!
+ PUBLIC
+}
+"""
+Audit log entry for a repo.add_topic event.
+"""
+type RepoAddTopicAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData & TopicAuditEntryData {
"""
- Identifies when the comment was created.
+ The action name
"""
- createdAt: DateTime!
+ action: String!
"""
- Check if this comment was created via an email reply.
+ The user who initiated the action
"""
- createdViaEmail: Boolean!
+ actor: AuditEntryActor
"""
- Identifies the primary key from the database.
+ The IP address of the actor
"""
- databaseId: Int
+ actorIp: String
"""
- The diff hunk to which the comment applies.
+ A readable representation of the actor's location
"""
- diffHunk: String!
+ actorLocation: ActorLocation
"""
- Identifies when the comment was created in a draft state.
+ The username of the user who initiated the action
"""
- draftedAt: DateTime!
+ actorLogin: String
"""
- The actor who edited the comment.
+ The HTTP path for the actor.
"""
- editor: Actor
- id: ID!
+ actorResourcePath: URI
"""
- Check if this comment was edited and includes an edit with the creation data
+ The HTTP URL for the actor.
"""
- includesCreatedEdit: Boolean!
+ actorUrl: URI
"""
- Returns whether or not a comment has been minimized.
+ The time the action was initiated
"""
- isMinimized: Boolean!
+ createdAt: PreciseDateTime!
+ id: ID!
"""
- The moment the editor made the last edit
+ The corresponding operation type for the action
"""
- lastEditedAt: DateTime
+ operationType: OperationType
"""
- Returns why the comment was minimized.
+ The Organization associated with the Audit Entry.
"""
- minimizedReason: String
+ organization: Organization
"""
- Identifies the original commit associated with the comment.
+ The name of the Organization.
"""
- originalCommit: Commit
+ organizationName: String
"""
- The original line index in the diff to which the comment applies.
+ The HTTP path for the organization
"""
- originalPosition: Int!
+ organizationResourcePath: URI
"""
- Identifies when the comment body is outdated
+ The HTTP URL for the organization
"""
- outdated: Boolean!
+ organizationUrl: URI
"""
- The path to which the comment applies.
+ The repository associated with the action
"""
- path: String!
+ repository: Repository
"""
- The line index in the diff to which the comment applies.
+ The name of the repository
"""
- position: Int
+ repositoryName: String
"""
- Identifies when the comment was published at.
+ The HTTP path for the repository
"""
- publishedAt: DateTime
+ repositoryResourcePath: URI
"""
- The pull request associated with this review comment.
+ The HTTP URL for the repository
"""
- pullRequest: PullRequest!
+ repositoryUrl: URI
"""
- The pull request review associated with this review comment.
+ The name of the topic added to the repository
"""
- pullRequestReview: PullRequestReview
+ topic: Topic
"""
- A list of reactions grouped by content left on the subject.
+ The name of the topic added to the repository
"""
- reactionGroups: [ReactionGroup!]
+ topicName: String
"""
- A list of Reactions left on the Issue.
+ The user affected by the action
"""
- reactions(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Allows filtering Reactions by emoji.
- """
- content: ReactionContent
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Allows specifying the order in which reactions are returned.
- """
- orderBy: ReactionOrder
- ): ReactionConnection!
+ user: User
"""
- The comment this is a reply to.
+ For actions involving two users, the actor is the initiator and the user is the affected user.
"""
- replyTo: PullRequestReviewComment
+ userLogin: String
"""
- The repository associated with this node.
+ The HTTP path for the user.
"""
- repository: Repository!
+ userResourcePath: URI
"""
- The HTTP path permalink for this review comment.
+ The HTTP URL for the user.
"""
- resourcePath: URI!
+ userUrl: URI
+}
+"""
+Audit log entry for a repo.archived event.
+"""
+type RepoArchivedAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData {
"""
- Identifies the state of the comment.
+ The action name
"""
- state: PullRequestReviewCommentState!
+ action: String!
"""
- Identifies when the comment was last updated.
+ The user who initiated the action
"""
- updatedAt: DateTime!
+ actor: AuditEntryActor
"""
- The HTTP URL permalink for this review comment.
+ The IP address of the actor
"""
- url: URI!
+ actorIp: String
"""
- A list of edits to this content.
+ A readable representation of the actor's location
"""
- userContentEdits(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): UserContentEditConnection
+ actorLocation: ActorLocation
"""
- Check if the current viewer can delete this object.
+ The username of the user who initiated the action
"""
- viewerCanDelete: Boolean!
+ actorLogin: String
"""
- Check if the current viewer can minimize this object.
+ The HTTP path for the actor.
"""
- viewerCanMinimize: Boolean!
+ actorResourcePath: URI
"""
- Can user react to this subject
+ The HTTP URL for the actor.
"""
- viewerCanReact: Boolean!
+ actorUrl: URI
"""
- Check if the current viewer can update this object.
+ The time the action was initiated
"""
- viewerCanUpdate: Boolean!
+ createdAt: PreciseDateTime!
+ id: ID!
"""
- Reasons why the current viewer can not update this comment.
+ The corresponding operation type for the action
"""
- viewerCannotUpdateReasons: [CommentCannotUpdateReason!]!
+ operationType: OperationType
"""
- Did the viewer author this comment.
+ The Organization associated with the Audit Entry.
"""
- viewerDidAuthor: Boolean!
-}
+ organization: Organization
-"""
-The connection type for PullRequestReviewComment.
-"""
-type PullRequestReviewCommentConnection {
"""
- A list of edges.
+ The name of the Organization.
"""
- edges: [PullRequestReviewCommentEdge]
+ organizationName: String
"""
- A list of nodes.
+ The HTTP path for the organization
"""
- nodes: [PullRequestReviewComment]
+ organizationResourcePath: URI
"""
- Information to aid in pagination.
+ The HTTP URL for the organization
"""
- pageInfo: PageInfo!
+ organizationUrl: URI
"""
- Identifies the total count of items in the connection.
+ The repository associated with the action
"""
- totalCount: Int!
-}
+ repository: Repository
-"""
-An edge in a connection.
-"""
-type PullRequestReviewCommentEdge {
"""
- A cursor for use in pagination.
+ The name of the repository
"""
- cursor: String!
+ repositoryName: String
"""
- The item at the end of the edge.
+ The HTTP path for the repository
"""
- node: PullRequestReviewComment
-}
+ repositoryResourcePath: URI
-"""
-The possible states of a pull request review comment.
-"""
-enum PullRequestReviewCommentState {
"""
- A comment that is part of a pending review
+ The HTTP URL for the repository
"""
- PENDING
+ repositoryUrl: URI
"""
- A comment that is part of a submitted review
+ The user affected by the action
"""
- SUBMITTED
-}
+ user: User
-"""
-The connection type for PullRequestReview.
-"""
-type PullRequestReviewConnection {
"""
- A list of edges.
+ For actions involving two users, the actor is the initiator and the user is the affected user.
"""
- edges: [PullRequestReviewEdge]
+ userLogin: String
"""
- A list of nodes.
+ The HTTP path for the user.
"""
- nodes: [PullRequestReview]
+ userResourcePath: URI
"""
- Information to aid in pagination.
+ The HTTP URL for the user.
"""
- pageInfo: PageInfo!
+ userUrl: URI
"""
- Identifies the total count of items in the connection.
+ The visibility of the repository
"""
- totalCount: Int!
+ visibility: RepoArchivedAuditEntryVisibility
}
"""
-This aggregates pull request reviews made by a user within one repository.
+The privacy of a repository
"""
-type PullRequestReviewContributionsByRepository {
+enum RepoArchivedAuditEntryVisibility {
"""
- The pull request review contributions.
+ The repository is visible only to users in the same business.
"""
- contributions(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
+ INTERNAL
- """
- Ordering options for contributions returned from the connection.
- """
- orderBy: ContributionOrder = {field: OCCURRED_AT, direction: DESC}
- ): CreatedPullRequestReviewContributionConnection!
+ """
+ The repository is visible only to those with explicit access.
+ """
+ PRIVATE
"""
- The repository in which the pull request reviews were made.
+ The repository is visible to everyone.
"""
- repository: Repository!
+ PUBLIC
}
"""
-An edge in a connection.
+Audit log entry for a repo.change_merge_setting event.
"""
-type PullRequestReviewEdge {
+type RepoChangeMergeSettingAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData {
"""
- A cursor for use in pagination.
+ The action name
"""
- cursor: String!
+ action: String!
"""
- The item at the end of the edge.
+ The user who initiated the action
"""
- node: PullRequestReview
-}
+ actor: AuditEntryActor
-"""
-The possible events to perform on a pull request review.
-"""
-enum PullRequestReviewEvent {
"""
- Submit feedback and approve merging these changes.
+ The IP address of the actor
"""
- APPROVE
+ actorIp: String
"""
- Submit general feedback without explicit approval.
+ A readable representation of the actor's location
"""
- COMMENT
+ actorLocation: ActorLocation
"""
- Dismiss review so it now longer effects merging.
+ The username of the user who initiated the action
"""
- DISMISS
+ actorLogin: String
"""
- Submit feedback that must be addressed before merging.
+ The HTTP path for the actor.
"""
- REQUEST_CHANGES
-}
+ actorResourcePath: URI
-"""
-The possible states of a pull request review.
-"""
-enum PullRequestReviewState {
"""
- A review allowing the pull request to merge.
+ The HTTP URL for the actor.
"""
- APPROVED
+ actorUrl: URI
"""
- A review blocking the pull request from merging.
+ The time the action was initiated
"""
- CHANGES_REQUESTED
+ createdAt: PreciseDateTime!
+ id: ID!
"""
- An informational review.
+ Whether the change was to enable (true) or disable (false) the merge type
"""
- COMMENTED
+ isEnabled: Boolean
"""
- A review that has been dismissed.
+ The merge method affected by the change
"""
- DISMISSED
+ mergeType: RepoChangeMergeSettingAuditEntryMergeType
"""
- A review that has not yet been submitted.
+ The corresponding operation type for the action
"""
- PENDING
-}
+ operationType: OperationType
-"""
-A threaded list of comments for a given pull request.
-"""
-type PullRequestReviewThread implements Node {
"""
- A list of pull request comments associated with the thread.
+ The Organization associated with the Audit Entry.
"""
- comments(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
+ organization: Organization
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): PullRequestReviewCommentConnection!
- id: ID!
+ """
+ The name of the Organization.
+ """
+ organizationName: String
"""
- Whether this thread has been resolved
+ The HTTP path for the organization
"""
- isResolved: Boolean!
+ organizationResourcePath: URI
"""
- Identifies the pull request associated with this thread.
+ The HTTP URL for the organization
"""
- pullRequest: PullRequest!
+ organizationUrl: URI
"""
- Identifies the repository associated with this thread.
+ The repository associated with the action
"""
- repository: Repository!
+ repository: Repository
"""
- The user who resolved this thread
+ The name of the repository
"""
- resolvedBy: User
+ repositoryName: String
"""
- Whether or not the viewer can resolve this thread
+ The HTTP path for the repository
"""
- viewerCanResolve: Boolean!
+ repositoryResourcePath: URI
"""
- Whether or not the viewer can unresolve this thread
+ The HTTP URL for the repository
"""
- viewerCanUnresolve: Boolean!
-}
+ repositoryUrl: URI
-"""
-Review comment threads for a pull request review.
-"""
-type PullRequestReviewThreadConnection {
"""
- A list of edges.
+ The user affected by the action
"""
- edges: [PullRequestReviewThreadEdge]
+ user: User
"""
- A list of nodes.
+ For actions involving two users, the actor is the initiator and the user is the affected user.
"""
- nodes: [PullRequestReviewThread]
+ userLogin: String
"""
- Information to aid in pagination.
+ The HTTP path for the user.
"""
- pageInfo: PageInfo!
+ userResourcePath: URI
"""
- Identifies the total count of items in the connection.
+ The HTTP URL for the user.
"""
- totalCount: Int!
+ userUrl: URI
}
"""
-An edge in a connection.
+The merge options available for pull requests to this repository.
"""
-type PullRequestReviewThreadEdge {
+enum RepoChangeMergeSettingAuditEntryMergeType {
"""
- A cursor for use in pagination.
+ The pull request is added to the base branch in a merge commit.
"""
- cursor: String!
+ MERGE
"""
- The item at the end of the edge.
+ Commits from the pull request are added onto the base branch individually without a merge commit.
"""
- node: PullRequestReviewThread
+ REBASE
+
+ """
+ The pull request's commits are squashed into a single commit before they are merged to the base branch.
+ """
+ SQUASH
}
"""
-Represents the latest point in the pull request timeline for which the viewer has seen the pull request's commits.
+Audit log entry for a repo.config.disable_anonymous_git_access event.
"""
-type PullRequestRevisionMarker {
+type RepoConfigDisableAnonymousGitAccessAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData {
"""
- Identifies the date and time when the object was created.
+ The action name
"""
- createdAt: DateTime!
+ action: String!
"""
- The last commit the viewer has seen.
+ The user who initiated the action
"""
- lastSeenCommit: Commit!
+ actor: AuditEntryActor
"""
- The pull request to which the marker belongs.
+ The IP address of the actor
"""
- pullRequest: PullRequest!
-}
+ actorIp: String
-"""
-The possible states of a pull request.
-"""
-enum PullRequestState {
"""
- A pull request that has been closed without being merged.
+ A readable representation of the actor's location
"""
- CLOSED
+ actorLocation: ActorLocation
"""
- A pull request that has been closed by being merged.
+ The username of the user who initiated the action
"""
- MERGED
+ actorLogin: String
"""
- A pull request that is still open.
+ The HTTP path for the actor.
"""
- OPEN
-}
+ actorResourcePath: URI
-"""
-The connection type for PullRequestTimelineItem.
-"""
-type PullRequestTimelineConnection {
"""
- A list of edges.
+ The HTTP URL for the actor.
"""
- edges: [PullRequestTimelineItemEdge]
+ actorUrl: URI
"""
- A list of nodes.
+ The time the action was initiated
"""
- nodes: [PullRequestTimelineItem]
+ createdAt: PreciseDateTime!
+ id: ID!
"""
- Information to aid in pagination.
+ The corresponding operation type for the action
"""
- pageInfo: PageInfo!
+ operationType: OperationType
"""
- Identifies the total count of items in the connection.
+ The Organization associated with the Audit Entry.
"""
- totalCount: Int!
-}
+ organization: Organization
-"""
-An item in an pull request timeline
-"""
-union PullRequestTimelineItem = AssignedEvent | BaseRefForcePushedEvent | ClosedEvent | Commit | CommitCommentThread | CrossReferencedEvent | DemilestonedEvent | DeployedEvent | DeploymentEnvironmentChangedEvent | HeadRefDeletedEvent | HeadRefForcePushedEvent | HeadRefRestoredEvent | IssueComment | LabeledEvent | LockedEvent | MergedEvent | MilestonedEvent | PullRequestReview | PullRequestReviewComment | PullRequestReviewThread | ReferencedEvent | RenamedTitleEvent | ReopenedEvent | ReviewDismissedEvent | ReviewRequestRemovedEvent | ReviewRequestedEvent | SubscribedEvent | UnassignedEvent | UnlabeledEvent | UnlockedEvent | UnsubscribedEvent | UserBlockedEvent
+ """
+ The name of the Organization.
+ """
+ organizationName: String
+
+ """
+ The HTTP path for the organization
+ """
+ organizationResourcePath: URI
+
+ """
+ The HTTP URL for the organization
+ """
+ organizationUrl: URI
+
+ """
+ The repository associated with the action
+ """
+ repository: Repository
+
+ """
+ The name of the repository
+ """
+ repositoryName: String
-"""
-An edge in a connection.
-"""
-type PullRequestTimelineItemEdge {
"""
- A cursor for use in pagination.
+ The HTTP path for the repository
"""
- cursor: String!
+ repositoryResourcePath: URI
"""
- The item at the end of the edge.
+ The HTTP URL for the repository
"""
- node: PullRequestTimelineItem
-}
+ repositoryUrl: URI
-"""
-An item in a pull request timeline
-"""
-union PullRequestTimelineItems = AddedToProjectEvent | AssignedEvent | BaseRefChangedEvent | BaseRefForcePushedEvent | ClosedEvent | CommentDeletedEvent | ConvertedNoteToIssueEvent | CrossReferencedEvent | DemilestonedEvent | DeployedEvent | DeploymentEnvironmentChangedEvent | HeadRefDeletedEvent | HeadRefForcePushedEvent | HeadRefRestoredEvent | IssueComment | LabeledEvent | LockedEvent | MentionedEvent | MergedEvent | MilestonedEvent | MovedColumnsInProjectEvent | PinnedEvent | PullRequestCommit | PullRequestCommitCommentThread | PullRequestReview | PullRequestReviewThread | PullRequestRevisionMarker | ReadyForReviewEvent | ReferencedEvent | RemovedFromProjectEvent | RenamedTitleEvent | ReopenedEvent | ReviewDismissedEvent | ReviewRequestRemovedEvent | ReviewRequestedEvent | SubscribedEvent | TransferredEvent | UnassignedEvent | UnlabeledEvent | UnlockedEvent | UnpinnedEvent | UnsubscribedEvent | UserBlockedEvent
+ """
+ The user affected by the action
+ """
+ user: User
-"""
-The connection type for PullRequestTimelineItems.
-"""
-type PullRequestTimelineItemsConnection {
"""
- A list of edges.
+ For actions involving two users, the actor is the initiator and the user is the affected user.
"""
- edges: [PullRequestTimelineItemsEdge]
+ userLogin: String
"""
- Identifies the count of items after applying `before` and `after` filters.
+ The HTTP path for the user.
"""
- filteredCount: Int!
+ userResourcePath: URI
"""
- A list of nodes.
+ The HTTP URL for the user.
"""
- nodes: [PullRequestTimelineItems]
+ userUrl: URI
+}
+"""
+Audit log entry for a repo.config.disable_collaborators_only event.
+"""
+type RepoConfigDisableCollaboratorsOnlyAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData {
"""
- Identifies the count of items after applying `before`/`after` filters and `first`/`last`/`skip` slicing.
+ The action name
"""
- pageCount: Int!
+ action: String!
"""
- Information to aid in pagination.
+ The user who initiated the action
"""
- pageInfo: PageInfo!
+ actor: AuditEntryActor
"""
- Identifies the total count of items in the connection.
+ The IP address of the actor
"""
- totalCount: Int!
+ actorIp: String
"""
- Identifies the date and time when the timeline was last updated.
+ A readable representation of the actor's location
"""
- updatedAt: DateTime!
-}
+ actorLocation: ActorLocation
-"""
-An edge in a connection.
-"""
-type PullRequestTimelineItemsEdge {
"""
- A cursor for use in pagination.
+ The username of the user who initiated the action
"""
- cursor: String!
+ actorLogin: String
"""
- The item at the end of the edge.
+ The HTTP path for the actor.
"""
- node: PullRequestTimelineItems
-}
+ actorResourcePath: URI
-"""
-The possible item types found in a timeline.
-"""
-enum PullRequestTimelineItemsItemType {
"""
- Represents a 'added_to_project' event on a given issue or pull request.
+ The HTTP URL for the actor.
"""
- ADDED_TO_PROJECT_EVENT
+ actorUrl: URI
"""
- Represents an 'assigned' event on any assignable object.
+ The time the action was initiated
"""
- ASSIGNED_EVENT
+ createdAt: PreciseDateTime!
+ id: ID!
"""
- Represents a 'base_ref_changed' event on a given issue or pull request.
+ The corresponding operation type for the action
"""
- BASE_REF_CHANGED_EVENT
+ operationType: OperationType
"""
- Represents a 'base_ref_force_pushed' event on a given pull request.
+ The Organization associated with the Audit Entry.
"""
- BASE_REF_FORCE_PUSHED_EVENT
+ organization: Organization
"""
- Represents a 'closed' event on any `Closable`.
+ The name of the Organization.
"""
- CLOSED_EVENT
+ organizationName: String
"""
- Represents a 'comment_deleted' event on a given issue or pull request.
+ The HTTP path for the organization
"""
- COMMENT_DELETED_EVENT
+ organizationResourcePath: URI
"""
- Represents a 'converted_note_to_issue' event on a given issue or pull request.
+ The HTTP URL for the organization
"""
- CONVERTED_NOTE_TO_ISSUE_EVENT
+ organizationUrl: URI
"""
- Represents a mention made by one issue or pull request to another.
+ The repository associated with the action
"""
- CROSS_REFERENCED_EVENT
+ repository: Repository
"""
- Represents a 'demilestoned' event on a given issue or pull request.
+ The name of the repository
"""
- DEMILESTONED_EVENT
+ repositoryName: String
"""
- Represents a 'deployed' event on a given pull request.
+ The HTTP path for the repository
"""
- DEPLOYED_EVENT
+ repositoryResourcePath: URI
"""
- Represents a 'deployment_environment_changed' event on a given pull request.
+ The HTTP URL for the repository
"""
- DEPLOYMENT_ENVIRONMENT_CHANGED_EVENT
+ repositoryUrl: URI
"""
- Represents a 'head_ref_deleted' event on a given pull request.
+ The user affected by the action
"""
- HEAD_REF_DELETED_EVENT
+ user: User
"""
- Represents a 'head_ref_force_pushed' event on a given pull request.
+ For actions involving two users, the actor is the initiator and the user is the affected user.
"""
- HEAD_REF_FORCE_PUSHED_EVENT
+ userLogin: String
"""
- Represents a 'head_ref_restored' event on a given pull request.
+ The HTTP path for the user.
"""
- HEAD_REF_RESTORED_EVENT
+ userResourcePath: URI
"""
- Represents a comment on an Issue.
+ The HTTP URL for the user.
"""
- ISSUE_COMMENT
+ userUrl: URI
+}
+"""
+Audit log entry for a repo.config.disable_contributors_only event.
+"""
+type RepoConfigDisableContributorsOnlyAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData {
"""
- Represents a 'labeled' event on a given issue or pull request.
+ The action name
"""
- LABELED_EVENT
+ action: String!
"""
- Represents a 'locked' event on a given issue or pull request.
+ The user who initiated the action
"""
- LOCKED_EVENT
+ actor: AuditEntryActor
"""
- Represents a 'mentioned' event on a given issue or pull request.
+ The IP address of the actor
"""
- MENTIONED_EVENT
+ actorIp: String
"""
- Represents a 'merged' event on a given pull request.
+ A readable representation of the actor's location
"""
- MERGED_EVENT
+ actorLocation: ActorLocation
"""
- Represents a 'milestoned' event on a given issue or pull request.
+ The username of the user who initiated the action
"""
- MILESTONED_EVENT
+ actorLogin: String
"""
- Represents a 'moved_columns_in_project' event on a given issue or pull request.
+ The HTTP path for the actor.
"""
- MOVED_COLUMNS_IN_PROJECT_EVENT
+ actorResourcePath: URI
"""
- Represents a 'pinned' event on a given issue or pull request.
+ The HTTP URL for the actor.
"""
- PINNED_EVENT
+ actorUrl: URI
"""
- Represents a Git commit part of a pull request.
+ The time the action was initiated
"""
- PULL_REQUEST_COMMIT
+ createdAt: PreciseDateTime!
+ id: ID!
"""
- Represents a commit comment thread part of a pull request.
+ The corresponding operation type for the action
"""
- PULL_REQUEST_COMMIT_COMMENT_THREAD
+ operationType: OperationType
"""
- A review object for a given pull request.
+ The Organization associated with the Audit Entry.
"""
- PULL_REQUEST_REVIEW
+ organization: Organization
"""
- A threaded list of comments for a given pull request.
+ The name of the Organization.
"""
- PULL_REQUEST_REVIEW_THREAD
+ organizationName: String
"""
- Represents the latest point in the pull request timeline for which the viewer has seen the pull request's commits.
+ The HTTP path for the organization
"""
- PULL_REQUEST_REVISION_MARKER
+ organizationResourcePath: URI
"""
- Represents a 'ready_for_review' event on a given pull request.
+ The HTTP URL for the organization
"""
- READY_FOR_REVIEW_EVENT
+ organizationUrl: URI
"""
- Represents a 'referenced' event on a given `ReferencedSubject`.
+ The repository associated with the action
"""
- REFERENCED_EVENT
+ repository: Repository
"""
- Represents a 'removed_from_project' event on a given issue or pull request.
+ The name of the repository
"""
- REMOVED_FROM_PROJECT_EVENT
+ repositoryName: String
"""
- Represents a 'renamed' event on a given issue or pull request
+ The HTTP path for the repository
"""
- RENAMED_TITLE_EVENT
+ repositoryResourcePath: URI
"""
- Represents a 'reopened' event on any `Closable`.
+ The HTTP URL for the repository
"""
- REOPENED_EVENT
+ repositoryUrl: URI
"""
- Represents a 'review_dismissed' event on a given issue or pull request.
+ The user affected by the action
"""
- REVIEW_DISMISSED_EVENT
+ user: User
"""
- Represents an 'review_requested' event on a given pull request.
+ For actions involving two users, the actor is the initiator and the user is the affected user.
"""
- REVIEW_REQUESTED_EVENT
+ userLogin: String
"""
- Represents an 'review_request_removed' event on a given pull request.
+ The HTTP path for the user.
"""
- REVIEW_REQUEST_REMOVED_EVENT
+ userResourcePath: URI
"""
- Represents a 'subscribed' event on a given `Subscribable`.
+ The HTTP URL for the user.
"""
- SUBSCRIBED_EVENT
+ userUrl: URI
+}
+"""
+Audit log entry for a repo.config.disable_sockpuppet_disallowed event.
+"""
+type RepoConfigDisableSockpuppetDisallowedAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData {
"""
- Represents a 'transferred' event on a given issue or pull request.
+ The action name
"""
- TRANSFERRED_EVENT
+ action: String!
"""
- Represents an 'unassigned' event on any assignable object.
+ The user who initiated the action
"""
- UNASSIGNED_EVENT
+ actor: AuditEntryActor
"""
- Represents an 'unlabeled' event on a given issue or pull request.
+ The IP address of the actor
"""
- UNLABELED_EVENT
+ actorIp: String
"""
- Represents an 'unlocked' event on a given issue or pull request.
+ A readable representation of the actor's location
"""
- UNLOCKED_EVENT
+ actorLocation: ActorLocation
"""
- Represents an 'unpinned' event on a given issue or pull request.
+ The username of the user who initiated the action
"""
- UNPINNED_EVENT
+ actorLogin: String
"""
- Represents an 'unsubscribed' event on a given `Subscribable`.
+ The HTTP path for the actor.
"""
- UNSUBSCRIBED_EVENT
+ actorResourcePath: URI
"""
- Represents a 'user_blocked' event on a given user.
+ The HTTP URL for the actor.
"""
- USER_BLOCKED_EVENT
-}
+ actorUrl: URI
-"""
-A Git push.
-"""
-type Push implements Node @preview(toggledBy: "antiope-preview") {
+ """
+ The time the action was initiated
+ """
+ createdAt: PreciseDateTime!
id: ID!
"""
- The SHA after the push
+ The corresponding operation type for the action
"""
- nextSha: GitObjectID
+ operationType: OperationType
"""
- The permalink for this push.
+ The Organization associated with the Audit Entry.
"""
- permalink: URI!
+ organization: Organization
"""
- The SHA before the push
+ The name of the Organization.
"""
- previousSha: GitObjectID
+ organizationName: String
"""
- The user who pushed
+ The HTTP path for the organization
"""
- pusher: User!
+ organizationResourcePath: URI
"""
- The repository that was pushed to
+ The HTTP URL for the organization
"""
- repository: Repository!
-}
+ organizationUrl: URI
-"""
-A team or user who has the ability to push to a protected branch.
-"""
-type PushAllowance implements Node {
"""
- The actor that can push.
+ The repository associated with the action
"""
- actor: PushAllowanceActor
+ repository: Repository
"""
- Identifies the branch protection rule associated with the allowed user or team.
+ The name of the repository
"""
- branchProtectionRule: BranchProtectionRule
- id: ID!
-}
-
-"""
-Types that can be an actor.
-"""
-union PushAllowanceActor = Team | User
+ repositoryName: String
-"""
-The connection type for PushAllowance.
-"""
-type PushAllowanceConnection {
"""
- A list of edges.
+ The HTTP path for the repository
"""
- edges: [PushAllowanceEdge]
+ repositoryResourcePath: URI
"""
- A list of nodes.
+ The HTTP URL for the repository
"""
- nodes: [PushAllowance]
+ repositoryUrl: URI
"""
- Information to aid in pagination.
+ The user affected by the action
"""
- pageInfo: PageInfo!
+ user: User
"""
- Identifies the total count of items in the connection.
+ For actions involving two users, the actor is the initiator and the user is the affected user.
"""
- totalCount: Int!
-}
+ userLogin: String
-"""
-An edge in a connection.
-"""
-type PushAllowanceEdge {
"""
- A cursor for use in pagination.
+ The HTTP path for the user.
"""
- cursor: String!
+ userResourcePath: URI
"""
- The item at the end of the edge.
+ The HTTP URL for the user.
"""
- node: PushAllowance
+ userUrl: URI
}
"""
-The query root of GitHub's GraphQL interface.
+Audit log entry for a repo.config.enable_anonymous_git_access event.
"""
-type Query {
+type RepoConfigEnableAnonymousGitAccessAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData {
"""
- Look up a code of conduct by its key
+ The action name
"""
- codeOfConduct(
- """
- The code of conduct's key
- """
- key: String!
- ): CodeOfConduct
+ action: String!
"""
- Look up a code of conduct by its key
+ The user who initiated the action
"""
- codesOfConduct: [CodeOfConduct]
+ actor: AuditEntryActor
"""
- Look up an open source license by its key
+ The IP address of the actor
"""
- license(
- """
- The license's downcased SPDX ID
- """
- key: String!
- ): License
+ actorIp: String
"""
- Return a list of known open source licenses
+ A readable representation of the actor's location
"""
- licenses: [License]!
+ actorLocation: ActorLocation
"""
- Return information about the GitHub instance
+ The username of the user who initiated the action
"""
- meta: GitHubMetadata!
+ actorLogin: String
"""
- Fetches an object given its ID.
+ The HTTP path for the actor.
"""
- node(
- """
- ID of the object.
- """
- id: ID!
- ): Node
+ actorResourcePath: URI
"""
- Lookup nodes by a list of IDs.
+ The HTTP URL for the actor.
"""
- nodes(
- """
- The list of node IDs.
- """
- ids: [ID!]!
- ): [Node]!
+ actorUrl: URI
"""
- Lookup a organization by login.
+ The time the action was initiated
"""
- organization(
- """
- The organization's login.
- """
- login: String!
- ): Organization
+ createdAt: PreciseDateTime!
+ id: ID!
"""
- A list of organizations.
+ The corresponding operation type for the action
"""
- organizations(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): OrganizationConnection!
+ operationType: OperationType
"""
- The client's rate limit information.
+ The Organization associated with the Audit Entry.
"""
- rateLimit(
- """
- If true, calculate the cost for the query without evaluating it
- """
- dryRun: Boolean = false
- ): RateLimit
+ organization: Organization
"""
- Hack to workaround https://github.com/facebook/relay/issues/112 re-exposing the root query object
+ The name of the Organization.
"""
- relay: Query!
+ organizationName: String
"""
- Lookup a given repository by the owner and repository name.
+ The HTTP path for the organization
"""
- repository(
- """
- The name of the repository
- """
- name: String!
-
- """
- The login field of a user or organization
- """
- owner: String!
- ): Repository
+ organizationResourcePath: URI
"""
- Lookup a repository owner (ie. either a User or an Organization) by login.
+ The HTTP URL for the organization
"""
- repositoryOwner(
- """
- The username to lookup the owner by.
- """
- login: String!
- ): RepositoryOwner
+ organizationUrl: URI
"""
- Lookup resource by a URL.
+ The repository associated with the action
"""
- resource(
- """
- The URL.
- """
- url: URI!
- ): UniformResourceLocatable
+ repository: Repository
"""
- Perform a search across resources.
+ The name of the repository
"""
- search(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- The search string to look for.
- """
- query: String!
-
- """
- The types of search items to search within.
- """
- type: SearchType!
- ): SearchResultItemConnection!
+ repositoryName: String
"""
- GitHub Security Advisories
+ The HTTP path for the repository
"""
- securityAdvisories(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
+ repositoryResourcePath: URI
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
+ """
+ The HTTP URL for the repository
+ """
+ repositoryUrl: URI
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
+ """
+ The user affected by the action
+ """
+ user: User
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
+ """
+ For actions involving two users, the actor is the initiator and the user is the affected user.
+ """
+ userLogin: String
- """
- Filter advisories to those published since a time in the past.
- """
- publishedSince: DateTime
+ """
+ The HTTP path for the user.
+ """
+ userResourcePath: URI
- """
- Filter advisories to those updated since a time in the past.
- """
- updatedSince: DateTime
- ): SecurityAdvisoryConnection!
+ """
+ The HTTP URL for the user.
+ """
+ userUrl: URI
+}
+"""
+Audit log entry for a repo.config.enable_collaborators_only event.
+"""
+type RepoConfigEnableCollaboratorsOnlyAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData {
"""
- Fetch a Security Advisory by its GHSA ID
+ The action name
"""
- securityAdvisory(
- """
- GitHub Security Advisory ID.
- """
- ghsaId: String!
- ): SecurityAdvisory
+ action: String!
"""
- Software Vulnerabilities documented by GitHub Security Advisories
+ The user who initiated the action
"""
- securityVulnerabilities(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
+ actor: AuditEntryActor
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
+ """
+ The IP address of the actor
+ """
+ actorIp: String
- """
- An ecosystem to filter vulnerabilities by.
- """
- ecosystem: SecurityAdvisoryEcosystem
+ """
+ A readable representation of the actor's location
+ """
+ actorLocation: ActorLocation
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
+ """
+ The username of the user who initiated the action
+ """
+ actorLogin: String
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
+ """
+ The HTTP path for the actor.
+ """
+ actorResourcePath: URI
- """
- A package name to filter vulnerabilities by.
- """
- package: String
+ """
+ The HTTP URL for the actor.
+ """
+ actorUrl: URI
- """
- A list of severities to filter vulnerabilities by.
- """
- severities: [SecurityAdvisorySeverity!]
- ): SecurityVulnerabilityConnection!
+ """
+ The time the action was initiated
+ """
+ createdAt: PreciseDateTime!
+ id: ID!
"""
- Look up a topic by name.
+ The corresponding operation type for the action
"""
- topic(
- """
- The topic's name.
- """
- name: String!
- ): Topic
+ operationType: OperationType
"""
- Lookup a user by login.
+ The Organization associated with the Audit Entry.
"""
- user(
- """
- The user's login.
- """
- login: String!
- ): User
+ organization: Organization
"""
- A list of users.
+ The name of the Organization.
"""
- users(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
+ organizationName: String
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
+ """
+ The HTTP path for the organization
+ """
+ organizationResourcePath: URI
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
+ """
+ The HTTP URL for the organization
+ """
+ organizationUrl: URI
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): UserConnection!
+ """
+ The repository associated with the action
+ """
+ repository: Repository
"""
- The currently authenticated user.
+ The name of the repository
"""
- viewer: User!
-}
+ repositoryName: String
-"""
-Represents the client's rate limit.
-"""
-type RateLimit {
"""
- The point cost for the current query counting against the rate limit.
+ The HTTP path for the repository
"""
- cost: Int!
+ repositoryResourcePath: URI
"""
- The maximum number of points the client is permitted to consume in a 60 minute window.
+ The HTTP URL for the repository
"""
- limit: Int!
+ repositoryUrl: URI
"""
- The maximum number of nodes this query may return
+ The user affected by the action
"""
- nodeCount: Int!
+ user: User
"""
- The number of points remaining in the current rate limit window.
+ For actions involving two users, the actor is the initiator and the user is the affected user.
"""
- remaining: Int!
+ userLogin: String
"""
- The time at which the current rate limit window resets in UTC epoch seconds.
+ The HTTP path for the user.
"""
- resetAt: DateTime!
+ userResourcePath: URI
+
+ """
+ The HTTP URL for the user.
+ """
+ userUrl: URI
}
"""
-Represents a subject that can be reacted on.
+Audit log entry for a repo.config.enable_contributors_only event.
"""
-interface Reactable {
+type RepoConfigEnableContributorsOnlyAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData {
"""
- Identifies the primary key from the database.
+ The action name
"""
- databaseId: Int
- id: ID!
+ action: String!
"""
- A list of reactions grouped by content left on the subject.
+ The user who initiated the action
"""
- reactionGroups: [ReactionGroup!]
+ actor: AuditEntryActor
"""
- A list of Reactions left on the Issue.
+ The IP address of the actor
"""
- reactions(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Allows filtering Reactions by emoji.
- """
- content: ReactionContent
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
+ actorIp: String
- """
- Allows specifying the order in which reactions are returned.
- """
- orderBy: ReactionOrder
- ): ReactionConnection!
+ """
+ A readable representation of the actor's location
+ """
+ actorLocation: ActorLocation
"""
- Can user react to this subject
+ The username of the user who initiated the action
"""
- viewerCanReact: Boolean!
-}
+ actorLogin: String
-"""
-The connection type for User.
-"""
-type ReactingUserConnection {
"""
- A list of edges.
+ The HTTP path for the actor.
"""
- edges: [ReactingUserEdge]
+ actorResourcePath: URI
"""
- A list of nodes.
+ The HTTP URL for the actor.
"""
- nodes: [User]
+ actorUrl: URI
"""
- Information to aid in pagination.
+ The time the action was initiated
"""
- pageInfo: PageInfo!
+ createdAt: PreciseDateTime!
+ id: ID!
"""
- Identifies the total count of items in the connection.
+ The corresponding operation type for the action
"""
- totalCount: Int!
-}
+ operationType: OperationType
-"""
-Represents a user that's made a reaction.
-"""
-type ReactingUserEdge {
"""
- A cursor for use in pagination.
+ The Organization associated with the Audit Entry.
"""
- cursor: String!
- node: User!
+ organization: Organization
"""
- The moment when the user made the reaction.
+ The name of the Organization.
"""
- reactedAt: DateTime!
-}
+ organizationName: String
-"""
-An emoji reaction to a particular piece of content.
-"""
-type Reaction implements Node {
"""
- Identifies the emoji reaction.
+ The HTTP path for the organization
"""
- content: ReactionContent!
+ organizationResourcePath: URI
"""
- Identifies the date and time when the object was created.
+ The HTTP URL for the organization
"""
- createdAt: DateTime!
+ organizationUrl: URI
"""
- Identifies the primary key from the database.
+ The repository associated with the action
"""
- databaseId: Int
- id: ID!
+ repository: Repository
"""
- The reactable piece of content
+ The name of the repository
"""
- reactable: Reactable!
+ repositoryName: String
"""
- Identifies the user who created this reaction.
+ The HTTP path for the repository
"""
- user: User
-}
+ repositoryResourcePath: URI
-"""
-A list of reactions that have been left on the subject.
-"""
-type ReactionConnection {
"""
- A list of edges.
+ The HTTP URL for the repository
"""
- edges: [ReactionEdge]
+ repositoryUrl: URI
"""
- A list of nodes.
+ The user affected by the action
"""
- nodes: [Reaction]
+ user: User
"""
- Information to aid in pagination.
+ For actions involving two users, the actor is the initiator and the user is the affected user.
"""
- pageInfo: PageInfo!
+ userLogin: String
"""
- Identifies the total count of items in the connection.
+ The HTTP path for the user.
"""
- totalCount: Int!
+ userResourcePath: URI
"""
- Whether or not the authenticated user has left a reaction on the subject.
+ The HTTP URL for the user.
"""
- viewerHasReacted: Boolean!
+ userUrl: URI
}
"""
-Emojis that can be attached to Issues, Pull Requests and Comments.
+Audit log entry for a repo.config.enable_sockpuppet_disallowed event.
"""
-enum ReactionContent {
+type RepoConfigEnableSockpuppetDisallowedAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData {
"""
- Represents the 😕 emoji.
+ The action name
"""
- CONFUSED
+ action: String!
"""
- Represents the 👀 emoji.
+ The user who initiated the action
"""
- EYES
+ actor: AuditEntryActor
"""
- Represents the ❤️ emoji.
+ The IP address of the actor
"""
- HEART
+ actorIp: String
"""
- Represents the 🎉 emoji.
+ A readable representation of the actor's location
"""
- HOORAY
+ actorLocation: ActorLocation
"""
- Represents the 😄 emoji.
+ The username of the user who initiated the action
"""
- LAUGH
+ actorLogin: String
"""
- Represents the 🚀 emoji.
+ The HTTP path for the actor.
"""
- ROCKET
+ actorResourcePath: URI
"""
- Represents the 👎 emoji.
+ The HTTP URL for the actor.
"""
- THUMBS_DOWN
+ actorUrl: URI
"""
- Represents the 👍 emoji.
+ The time the action was initiated
"""
- THUMBS_UP
-}
+ createdAt: PreciseDateTime!
+ id: ID!
-"""
-An edge in a connection.
-"""
-type ReactionEdge {
"""
- A cursor for use in pagination.
+ The corresponding operation type for the action
"""
- cursor: String!
+ operationType: OperationType
"""
- The item at the end of the edge.
+ The Organization associated with the Audit Entry.
"""
- node: Reaction
-}
+ organization: Organization
-"""
-A group of emoji reactions to a particular piece of content.
-"""
-type ReactionGroup {
"""
- Identifies the emoji reaction.
+ The name of the Organization.
"""
- content: ReactionContent!
+ organizationName: String
"""
- Identifies when the reaction was created.
+ The HTTP path for the organization
"""
- createdAt: DateTime
+ organizationResourcePath: URI
"""
- The subject that was reacted to.
+ The HTTP URL for the organization
"""
- subject: Reactable!
+ organizationUrl: URI
"""
- Users who have reacted to the reaction subject with the emotion represented by this reaction group
+ The repository associated with the action
"""
- users(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
+ repository: Repository
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
+ """
+ The name of the repository
+ """
+ repositoryName: String
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
+ """
+ The HTTP path for the repository
+ """
+ repositoryResourcePath: URI
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): ReactingUserConnection!
+ """
+ The HTTP URL for the repository
+ """
+ repositoryUrl: URI
"""
- Whether or not the authenticated user has left a reaction on the subject.
+ The user affected by the action
"""
- viewerHasReacted: Boolean!
-}
+ user: User
-"""
-Ways in which lists of reactions can be ordered upon return.
-"""
-input ReactionOrder {
"""
- The direction in which to order reactions by the specified field.
+ For actions involving two users, the actor is the initiator and the user is the affected user.
"""
- direction: OrderDirection!
+ userLogin: String
"""
- The field in which to order reactions by.
+ The HTTP path for the user.
"""
- field: ReactionOrderField!
-}
+ userResourcePath: URI
-"""
-A list of fields that reactions can be ordered by.
-"""
-enum ReactionOrderField {
"""
- Allows ordering a list of reactions by when they were created.
+ The HTTP URL for the user.
"""
- CREATED_AT
+ userUrl: URI
}
"""
-Represents a 'ready_for_review' event on a given pull request.
+Audit log entry for a repo.config.lock_anonymous_git_access event.
"""
-type ReadyForReviewEvent implements Node & UniformResourceLocatable {
+type RepoConfigLockAnonymousGitAccessAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData {
"""
- Identifies the actor who performed the event.
+ The action name
"""
- actor: Actor
+ action: String!
"""
- Identifies the date and time when the object was created.
+ The user who initiated the action
"""
- createdAt: DateTime!
- id: ID!
+ actor: AuditEntryActor
"""
- PullRequest referenced by event.
+ The IP address of the actor
"""
- pullRequest: PullRequest!
+ actorIp: String
"""
- The HTTP path for this ready for review event.
+ A readable representation of the actor's location
"""
- resourcePath: URI!
+ actorLocation: ActorLocation
"""
- The HTTP URL for this ready for review event.
+ The username of the user who initiated the action
"""
- url: URI!
-}
+ actorLogin: String
-"""
-Represents a Git reference.
-"""
-type Ref implements Node {
"""
- A list of pull requests with this ref as the head ref.
+ The HTTP path for the actor.
"""
- associatedPullRequests(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- The base ref name to filter the pull requests by.
- """
- baseRefName: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- The head ref name to filter the pull requests by.
- """
- headRefName: String
-
- """
- A list of label names to filter the pull requests by.
- """
- labels: [String!]
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for pull requests returned from the connection.
- """
- orderBy: IssueOrder
+ actorResourcePath: URI
- """
- A list of states to filter the pull requests by.
- """
- states: [PullRequestState!]
- ): PullRequestConnection!
- id: ID!
+ """
+ The HTTP URL for the actor.
+ """
+ actorUrl: URI
"""
- The ref name.
+ The time the action was initiated
"""
- name: String!
+ createdAt: PreciseDateTime!
+ id: ID!
"""
- The ref's prefix, such as `refs/heads/` or `refs/tags/`.
+ The corresponding operation type for the action
"""
- prefix: String!
+ operationType: OperationType
"""
- The repository the ref belongs to.
+ The Organization associated with the Audit Entry.
"""
- repository: Repository!
+ organization: Organization
"""
- The object the ref points to.
+ The name of the Organization.
"""
- target: GitObject!
-}
+ organizationName: String
-"""
-The connection type for Ref.
-"""
-type RefConnection {
"""
- A list of edges.
+ The HTTP path for the organization
"""
- edges: [RefEdge]
+ organizationResourcePath: URI
"""
- A list of nodes.
+ The HTTP URL for the organization
"""
- nodes: [Ref]
+ organizationUrl: URI
"""
- Information to aid in pagination.
+ The repository associated with the action
"""
- pageInfo: PageInfo!
+ repository: Repository
"""
- Identifies the total count of items in the connection.
+ The name of the repository
"""
- totalCount: Int!
-}
+ repositoryName: String
-"""
-An edge in a connection.
-"""
-type RefEdge {
"""
- A cursor for use in pagination.
+ The HTTP path for the repository
"""
- cursor: String!
+ repositoryResourcePath: URI
"""
- The item at the end of the edge.
+ The HTTP URL for the repository
"""
- node: Ref
-}
+ repositoryUrl: URI
-"""
-Ways in which lists of git refs can be ordered upon return.
-"""
-input RefOrder {
"""
- The direction in which to order refs by the specified field.
+ The user affected by the action
"""
- direction: OrderDirection!
+ user: User
"""
- The field in which to order refs by.
+ For actions involving two users, the actor is the initiator and the user is the affected user.
"""
- field: RefOrderField!
-}
+ userLogin: String
-"""
-Properties by which ref connections can be ordered.
-"""
-enum RefOrderField {
"""
- Order refs by their alphanumeric name
+ The HTTP path for the user.
"""
- ALPHABETICAL
+ userResourcePath: URI
"""
- Order refs by underlying commit date if the ref prefix is refs/tags/
+ The HTTP URL for the user.
"""
- TAG_COMMIT_DATE
+ userUrl: URI
}
"""
-Represents a 'referenced' event on a given `ReferencedSubject`.
+Audit log entry for a repo.config.unlock_anonymous_git_access event.
"""
-type ReferencedEvent implements Node {
+type RepoConfigUnlockAnonymousGitAccessAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData {
"""
- Identifies the actor who performed the event.
+ The action name
"""
- actor: Actor
+ action: String!
"""
- Identifies the commit associated with the 'referenced' event.
+ The user who initiated the action
"""
- commit: Commit
+ actor: AuditEntryActor
"""
- Identifies the repository associated with the 'referenced' event.
+ The IP address of the actor
"""
- commitRepository: Repository!
+ actorIp: String
"""
- Identifies the date and time when the object was created.
+ A readable representation of the actor's location
"""
- createdAt: DateTime!
- id: ID!
+ actorLocation: ActorLocation
"""
- Reference originated in a different repository.
+ The username of the user who initiated the action
"""
- isCrossRepository: Boolean!
+ actorLogin: String
"""
- Checks if the commit message itself references the subject. Can be false in the case of a commit comment reference.
+ The HTTP path for the actor.
"""
- isDirectReference: Boolean!
+ actorResourcePath: URI
"""
- Object referenced by event.
+ The HTTP URL for the actor.
"""
- subject: ReferencedSubject!
-}
-
-"""
-Any referencable object
-"""
-union ReferencedSubject = Issue | PullRequest
-
-"""
-Represents an owner of a registry package.
-"""
-interface RegistryPackageOwner {
- id: ID!
-}
+ actorUrl: URI
-"""
-Represents an interface to search packages on an object.
-"""
-interface RegistryPackageSearch {
+ """
+ The time the action was initiated
+ """
+ createdAt: PreciseDateTime!
id: ID!
-}
-"""
-A release contains the content for a release.
-"""
-type Release implements Node & UniformResourceLocatable {
"""
- The author of the release
+ The corresponding operation type for the action
"""
- author: User
+ operationType: OperationType
"""
- Identifies the date and time when the object was created.
+ The Organization associated with the Audit Entry.
"""
- createdAt: DateTime!
+ organization: Organization
"""
- Identifies the description of the release.
+ The name of the Organization.
"""
- description: String
- id: ID!
+ organizationName: String
"""
- Whether or not the release is a draft
+ The HTTP path for the organization
"""
- isDraft: Boolean!
+ organizationResourcePath: URI
"""
- Whether or not the release is a prerelease
+ The HTTP URL for the organization
"""
- isPrerelease: Boolean!
+ organizationUrl: URI
"""
- Identifies the title of the release.
+ The repository associated with the action
"""
- name: String
+ repository: Repository
"""
- Identifies the date and time when the release was created.
+ The name of the repository
"""
- publishedAt: DateTime
+ repositoryName: String
"""
- List of releases assets which are dependent on this release.
+ The HTTP path for the repository
"""
- releaseAssets(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
+ repositoryResourcePath: URI
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
+ """
+ The HTTP URL for the repository
+ """
+ repositoryUrl: URI
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
+ """
+ The user affected by the action
+ """
+ user: User
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
+ """
+ For actions involving two users, the actor is the initiator and the user is the affected user.
+ """
+ userLogin: String
- """
- A list of names to filter the assets by.
- """
- name: String
- ): ReleaseAssetConnection!
+ """
+ The HTTP path for the user.
+ """
+ userResourcePath: URI
"""
- The HTTP path for this issue
+ The HTTP URL for the user.
"""
- resourcePath: URI!
+ userUrl: URI
+}
+"""
+Audit log entry for a repo.create event.
+"""
+type RepoCreateAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData {
"""
- The Git tag the release points to
+ The action name
"""
- tag: Ref
+ action: String!
"""
- The name of the release's Git tag
+ The user who initiated the action
"""
- tagName: String!
+ actor: AuditEntryActor
"""
- Identifies the date and time when the object was last updated.
+ The IP address of the actor
"""
- updatedAt: DateTime!
+ actorIp: String
"""
- The HTTP URL for this issue
+ A readable representation of the actor's location
"""
- url: URI!
-}
+ actorLocation: ActorLocation
-"""
-A release asset contains the content for a release asset.
-"""
-type ReleaseAsset implements Node {
"""
- The asset's content-type
+ The username of the user who initiated the action
"""
- contentType: String!
+ actorLogin: String
"""
- Identifies the date and time when the object was created.
+ The HTTP path for the actor.
"""
- createdAt: DateTime!
+ actorResourcePath: URI
"""
- The number of times this asset was downloaded
+ The HTTP URL for the actor.
"""
- downloadCount: Int!
+ actorUrl: URI
"""
- Identifies the URL where you can download the release asset via the browser.
+ The time the action was initiated
"""
- downloadUrl: URI!
- id: ID!
+ createdAt: PreciseDateTime!
"""
- Identifies the title of the release asset.
+ The name of the parent repository for this forked repository.
"""
- name: String!
+ forkParentName: String
"""
- Release that the asset is associated with
+ The name of the root repository for this netork.
"""
- release: Release
+ forkSourceName: String
+ id: ID!
"""
- The size (in bytes) of the asset
+ The corresponding operation type for the action
"""
- size: Int!
+ operationType: OperationType
"""
- Identifies the date and time when the object was last updated.
+ The Organization associated with the Audit Entry.
"""
- updatedAt: DateTime!
+ organization: Organization
"""
- The user that performed the upload
+ The name of the Organization.
"""
- uploadedBy: User!
+ organizationName: String
"""
- Identifies the URL of the release asset.
+ The HTTP path for the organization
"""
- url: URI!
-}
+ organizationResourcePath: URI
-"""
-The connection type for ReleaseAsset.
-"""
-type ReleaseAssetConnection {
"""
- A list of edges.
+ The HTTP URL for the organization
"""
- edges: [ReleaseAssetEdge]
+ organizationUrl: URI
"""
- A list of nodes.
+ The repository associated with the action
"""
- nodes: [ReleaseAsset]
+ repository: Repository
"""
- Information to aid in pagination.
+ The name of the repository
"""
- pageInfo: PageInfo!
+ repositoryName: String
"""
- Identifies the total count of items in the connection.
+ The HTTP path for the repository
"""
- totalCount: Int!
-}
+ repositoryResourcePath: URI
-"""
-An edge in a connection.
-"""
-type ReleaseAssetEdge {
"""
- A cursor for use in pagination.
+ The HTTP URL for the repository
"""
- cursor: String!
+ repositoryUrl: URI
"""
- The item at the end of the edge.
+ The user affected by the action
"""
- node: ReleaseAsset
-}
+ user: User
-"""
-The connection type for Release.
-"""
-type ReleaseConnection {
"""
- A list of edges.
+ For actions involving two users, the actor is the initiator and the user is the affected user.
"""
- edges: [ReleaseEdge]
+ userLogin: String
"""
- A list of nodes.
+ The HTTP path for the user.
"""
- nodes: [Release]
+ userResourcePath: URI
"""
- Information to aid in pagination.
+ The HTTP URL for the user.
"""
- pageInfo: PageInfo!
+ userUrl: URI
"""
- Identifies the total count of items in the connection.
+ The visibility of the repository
"""
- totalCount: Int!
+ visibility: RepoCreateAuditEntryVisibility
}
"""
-An edge in a connection.
+The privacy of a repository
"""
-type ReleaseEdge {
+enum RepoCreateAuditEntryVisibility {
"""
- A cursor for use in pagination.
+ The repository is visible only to users in the same business.
"""
- cursor: String!
+ INTERNAL
"""
- The item at the end of the edge.
+ The repository is visible only to those with explicit access.
"""
- node: Release
+ PRIVATE
+
+ """
+ The repository is visible to everyone.
+ """
+ PUBLIC
}
"""
-Ways in which lists of releases can be ordered upon return.
+Audit log entry for a repo.destroy event.
"""
-input ReleaseOrder {
+type RepoDestroyAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData {
"""
- The direction in which to order releases by the specified field.
+ The action name
"""
- direction: OrderDirection!
+ action: String!
"""
- The field in which to order releases by.
+ The user who initiated the action
"""
- field: ReleaseOrderField!
-}
+ actor: AuditEntryActor
-"""
-Properties by which release connections can be ordered.
-"""
-enum ReleaseOrderField {
"""
- Order releases by creation time
+ The IP address of the actor
"""
- CREATED_AT
+ actorIp: String
"""
- Order releases alphabetically by name
+ A readable representation of the actor's location
"""
- NAME
-}
+ actorLocation: ActorLocation
-"""
-Autogenerated input type of RemoveAssigneesFromAssignable
-"""
-input RemoveAssigneesFromAssignableInput {
"""
- The id of the assignable object to remove assignees from.
+ The username of the user who initiated the action
"""
- assignableId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "Assignable")
+ actorLogin: String
"""
- The id of users to remove as assignees.
+ The HTTP path for the actor.
"""
- assigneeIds: [ID!]! @possibleTypes(concreteTypes: ["User"])
+ actorResourcePath: URI
"""
- A unique identifier for the client performing the mutation.
+ The HTTP URL for the actor.
"""
- clientMutationId: String
-}
+ actorUrl: URI
-"""
-Autogenerated return type of RemoveAssigneesFromAssignable
-"""
-type RemoveAssigneesFromAssignablePayload {
"""
- The item that was unassigned.
+ The time the action was initiated
"""
- assignable: Assignable
+ createdAt: PreciseDateTime!
+ id: ID!
"""
- A unique identifier for the client performing the mutation.
+ The corresponding operation type for the action
"""
- clientMutationId: String
-}
+ operationType: OperationType
-"""
-Autogenerated input type of RemoveLabelsFromLabelable
-"""
-input RemoveLabelsFromLabelableInput {
"""
- A unique identifier for the client performing the mutation.
+ The Organization associated with the Audit Entry.
"""
- clientMutationId: String
+ organization: Organization
"""
- The ids of labels to remove.
+ The name of the Organization.
"""
- labelIds: [ID!]! @possibleTypes(concreteTypes: ["Label"])
+ organizationName: String
"""
- The id of the Labelable to remove labels from.
+ The HTTP path for the organization
"""
- labelableId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "Labelable")
-}
+ organizationResourcePath: URI
-"""
-Autogenerated return type of RemoveLabelsFromLabelable
-"""
-type RemoveLabelsFromLabelablePayload {
"""
- A unique identifier for the client performing the mutation.
+ The HTTP URL for the organization
"""
- clientMutationId: String
+ organizationUrl: URI
"""
- The Labelable the labels were removed from.
+ The repository associated with the action
"""
- labelable: Labelable
-}
+ repository: Repository
-"""
-Autogenerated input type of RemoveOutsideCollaborator
-"""
-input RemoveOutsideCollaboratorInput {
"""
- A unique identifier for the client performing the mutation.
+ The name of the repository
"""
- clientMutationId: String
+ repositoryName: String
"""
- The ID of the organization to remove the outside collaborator from.
+ The HTTP path for the repository
"""
- organizationId: ID! @possibleTypes(concreteTypes: ["Organization"])
+ repositoryResourcePath: URI
"""
- The ID of the outside collaborator to remove.
+ The HTTP URL for the repository
"""
- userId: ID! @possibleTypes(concreteTypes: ["User"])
-}
+ repositoryUrl: URI
-"""
-Autogenerated return type of RemoveOutsideCollaborator
-"""
-type RemoveOutsideCollaboratorPayload {
"""
- A unique identifier for the client performing the mutation.
+ The user affected by the action
"""
- clientMutationId: String
+ user: User
"""
- The user that was removed as an outside collaborator.
+ For actions involving two users, the actor is the initiator and the user is the affected user.
"""
- removedUser: User
-}
+ userLogin: String
-"""
-Autogenerated input type of RemoveReaction
-"""
-input RemoveReactionInput {
"""
- A unique identifier for the client performing the mutation.
+ The HTTP path for the user.
"""
- clientMutationId: String
+ userResourcePath: URI
"""
- The name of the emoji reaction to remove.
+ The HTTP URL for the user.
"""
- content: ReactionContent!
+ userUrl: URI
"""
- The Node ID of the subject to modify.
+ The visibility of the repository
"""
- subjectId: ID! @possibleTypes(concreteTypes: ["CommitComment", "Issue", "IssueComment", "PullRequest", "PullRequestReview", "PullRequestReviewComment", "TeamDiscussion", "TeamDiscussionComment"], abstractType: "Reactable")
+ visibility: RepoDestroyAuditEntryVisibility
}
"""
-Autogenerated return type of RemoveReaction
+The privacy of a repository
"""
-type RemoveReactionPayload {
+enum RepoDestroyAuditEntryVisibility {
"""
- A unique identifier for the client performing the mutation.
+ The repository is visible only to users in the same business.
"""
- clientMutationId: String
+ INTERNAL
"""
- The reaction object.
+ The repository is visible only to those with explicit access.
"""
- reaction: Reaction
+ PRIVATE
"""
- The reactable subject.
+ The repository is visible to everyone.
"""
- subject: Reactable
+ PUBLIC
}
"""
-Autogenerated input type of RemoveStar
+Audit log entry for a repo.remove_member event.
"""
-input RemoveStarInput {
+type RepoRemoveMemberAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData {
"""
- A unique identifier for the client performing the mutation.
+ The action name
"""
- clientMutationId: String
+ action: String!
"""
- The Starrable ID to unstar.
+ The user who initiated the action
"""
- starrableId: ID! @possibleTypes(concreteTypes: ["Gist", "Repository", "Topic"], abstractType: "Starrable")
-}
+ actor: AuditEntryActor
-"""
-Autogenerated return type of RemoveStar
-"""
-type RemoveStarPayload {
"""
- A unique identifier for the client performing the mutation.
+ The IP address of the actor
"""
- clientMutationId: String
+ actorIp: String
"""
- The starrable.
+ A readable representation of the actor's location
"""
- starrable: Starrable
-}
+ actorLocation: ActorLocation
-"""
-Represents a 'removed_from_project' event on a given issue or pull request.
-"""
-type RemovedFromProjectEvent implements Node {
"""
- Identifies the actor who performed the event.
+ The username of the user who initiated the action
"""
- actor: Actor
+ actorLogin: String
"""
- Identifies the date and time when the object was created.
+ The HTTP path for the actor.
"""
- createdAt: DateTime!
+ actorResourcePath: URI
"""
- Identifies the primary key from the database.
+ The HTTP URL for the actor.
"""
- databaseId: Int
- id: ID!
+ actorUrl: URI
"""
- Project referenced by event.
+ The time the action was initiated
"""
- project: Project @preview(toggledBy: "starfox-preview")
+ createdAt: PreciseDateTime!
+ id: ID!
"""
- Column name referenced by this project event.
+ The corresponding operation type for the action
"""
- projectColumnName: String! @preview(toggledBy: "starfox-preview")
-}
+ operationType: OperationType
-"""
-Represents a 'renamed' event on a given issue or pull request
-"""
-type RenamedTitleEvent implements Node {
"""
- Identifies the actor who performed the event.
+ The Organization associated with the Audit Entry.
"""
- actor: Actor
+ organization: Organization
"""
- Identifies the date and time when the object was created.
+ The name of the Organization.
"""
- createdAt: DateTime!
+ organizationName: String
"""
- Identifies the current title of the issue or pull request.
+ The HTTP path for the organization
"""
- currentTitle: String!
- id: ID!
+ organizationResourcePath: URI
"""
- Identifies the previous title of the issue or pull request.
+ The HTTP URL for the organization
"""
- previousTitle: String!
+ organizationUrl: URI
"""
- Subject that was renamed.
+ The repository associated with the action
"""
- subject: RenamedTitleSubject!
-}
-
-"""
-An object which has a renamable title
-"""
-union RenamedTitleSubject = Issue | PullRequest
+ repository: Repository
-"""
-Autogenerated input type of ReopenIssue
-"""
-input ReopenIssueInput {
"""
- A unique identifier for the client performing the mutation.
+ The name of the repository
"""
- clientMutationId: String
+ repositoryName: String
"""
- ID of the issue to be opened.
+ The HTTP path for the repository
"""
- issueId: ID! @possibleTypes(concreteTypes: ["Issue"])
-}
+ repositoryResourcePath: URI
-"""
-Autogenerated return type of ReopenIssue
-"""
-type ReopenIssuePayload {
"""
- A unique identifier for the client performing the mutation.
+ The HTTP URL for the repository
"""
- clientMutationId: String
+ repositoryUrl: URI
"""
- The issue that was opened.
+ The user affected by the action
"""
- issue: Issue
-}
+ user: User
-"""
-Autogenerated input type of ReopenPullRequest
-"""
-input ReopenPullRequestInput {
"""
- A unique identifier for the client performing the mutation.
+ For actions involving two users, the actor is the initiator and the user is the affected user.
"""
- clientMutationId: String
+ userLogin: String
"""
- ID of the pull request to be reopened.
+ The HTTP path for the user.
"""
- pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"])
-}
+ userResourcePath: URI
-"""
-Autogenerated return type of ReopenPullRequest
-"""
-type ReopenPullRequestPayload {
"""
- A unique identifier for the client performing the mutation.
+ The HTTP URL for the user.
"""
- clientMutationId: String
+ userUrl: URI
"""
- The pull request that was reopened.
+ The visibility of the repository
"""
- pullRequest: PullRequest
+ visibility: RepoRemoveMemberAuditEntryVisibility
}
"""
-Represents a 'reopened' event on any `Closable`.
+The privacy of a repository
"""
-type ReopenedEvent implements Node {
+enum RepoRemoveMemberAuditEntryVisibility {
"""
- Identifies the actor who performed the event.
+ The repository is visible only to users in the same business.
"""
- actor: Actor
+ INTERNAL
"""
- Object that was reopened.
+ The repository is visible only to those with explicit access.
"""
- closable: Closable!
+ PRIVATE
"""
- Identifies the date and time when the object was created.
+ The repository is visible to everyone.
"""
- createdAt: DateTime!
- id: ID!
+ PUBLIC
}
"""
-Audit log entry for a repo.access event.
+Audit log entry for a repo.remove_topic event.
"""
-type RepoAccessAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData @preview(toggledBy: "audit-log-preview") {
+type RepoRemoveTopicAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData & TopicAuditEntryData {
"""
The action name
"""
@@ -19532,7 +26483,7 @@ type RepoAccessAuditEntry implements AuditEntry & Node & OrganizationAuditEntryD
"""
A readable representation of the actor's location
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ actorLocation: ActorLocation
"""
The username of the user who initiated the action
@@ -19555,6 +26506,11 @@ type RepoAccessAuditEntry implements AuditEntry & Node & OrganizationAuditEntryD
createdAt: PreciseDateTime!
id: ID!
+ """
+ The corresponding operation type for the action
+ """
+ operationType: OperationType
+
"""
The Organization associated with the Audit Entry.
"""
@@ -19591,2483 +26547,2814 @@ type RepoAccessAuditEntry implements AuditEntry & Node & OrganizationAuditEntryD
repositoryResourcePath: URI
"""
- The HTTP URL for the repository
+ The HTTP URL for the repository
+ """
+ repositoryUrl: URI
+
+ """
+ The name of the topic added to the repository
+ """
+ topic: Topic
+
+ """
+ The name of the topic added to the repository
+ """
+ topicName: String
+
+ """
+ The user affected by the action
+ """
+ user: User
+
+ """
+ For actions involving two users, the actor is the initiator and the user is the affected user.
+ """
+ userLogin: String
+
+ """
+ The HTTP path for the user.
+ """
+ userResourcePath: URI
+
+ """
+ The HTTP URL for the user.
+ """
+ userUrl: URI
+}
+
+"""
+The reasons a piece of content can be reported or minimized.
+"""
+enum ReportedContentClassifiers {
+ """
+ A duplicated piece of content
+ """
+ DUPLICATE
+
+ """
+ An irrelevant piece of content
+ """
+ OFF_TOPIC
+
+ """
+ An outdated piece of content
+ """
+ OUTDATED
+
+ """
+ The content has been resolved
+ """
+ RESOLVED
+}
+
+"""
+A repository contains the content for a project.
+"""
+type Repository implements Node & ProjectOwner & RepositoryInfo & Starrable & Subscribable & UniformResourceLocatable {
+ """
+ A list of users that can be assigned to issues in this repository.
+ """
+ assignableUsers(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Filters users with query on user name and login
+ """
+ query: String
+ ): UserConnection!
+
+ """
+ A list of branch protection rules for this repository.
+ """
+ branchProtectionRules(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): BranchProtectionRuleConnection!
+
+ """
+ Returns the code of conduct for this repository
+ """
+ codeOfConduct: CodeOfConduct
+
+ """
+ A list of collaborators associated with the repository.
+ """
+ collaborators(
+ """
+ Collaborators affiliation level with a repository.
+ """
+ affiliation: CollaboratorAffiliation
+
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Filters users with query on user name and login
+ """
+ query: String
+ ): RepositoryCollaboratorConnection
+
+ """
+ A list of commit comments associated with the repository.
"""
- repositoryUrl: URI
+ commitComments(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
- """
- The user affected by the action
- """
- user: User
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
- """
- For actions involving two users, the actor is the initiator and the user is the affected user.
- """
- userLogin: String
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
- """
- The HTTP path for the user.
- """
- userResourcePath: URI
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): CommitCommentConnection!
"""
- The HTTP URL for the user.
+ Returns a list of contact links associated to the repository
"""
- userUrl: URI
+ contactLinks: [RepositoryContactLink!]
"""
- The visibility of the repository
+ Identifies the date and time when the object was created.
"""
- visibility: RepoAccessAuditEntryVisibility
-}
+ createdAt: DateTime!
-"""
-The privacy of a repository
-"""
-enum RepoAccessAuditEntryVisibility @preview(toggledBy: "audit-log-preview") {
"""
- The repository is visible only to users in the same business.
+ Identifies the primary key from the database.
"""
- INTERNAL
+ databaseId: Int
"""
- The repository is visible only to those with explicit access.
+ The Ref associated with the repository's default branch.
"""
- PRIVATE
+ defaultBranchRef: Ref
"""
- The repository is visible to everyone.
+ Whether or not branches are automatically deleted when merged in this repository.
"""
- PUBLIC
-}
+ deleteBranchOnMerge: Boolean!
-"""
-Audit log entry for a repo.add_member event.
-"""
-type RepoAddMemberAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData @preview(toggledBy: "audit-log-preview") {
"""
- The action name
+ A list of deploy keys that are on this repository.
"""
- action: String!
+ deployKeys(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
- """
- The user who initiated the action
- """
- actor: AuditEntryActor
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
- """
- The IP address of the actor
- """
- actorIp: String
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
- """
- A readable representation of the actor's location
- """
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): DeployKeyConnection!
"""
- The username of the user who initiated the action
+ Deployments associated with the repository
"""
- actorLogin: String
+ deployments(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
- """
- The HTTP path for the actor.
- """
- actorResourcePath: URI
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
- """
- The HTTP URL for the actor.
- """
- actorUrl: URI
+ """
+ Environments to list deployments for
+ """
+ environments: [String!]
- """
- The time the action was initiated
- """
- createdAt: PreciseDateTime!
- id: ID!
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
- """
- The Organization associated with the Audit Entry.
- """
- organization: Organization
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
- """
- The name of the Organization.
- """
- organizationName: String
+ """
+ Ordering options for deployments returned from the connection.
+ """
+ orderBy: DeploymentOrder = {field: CREATED_AT, direction: ASC}
+ ): DeploymentConnection!
"""
- The HTTP path for the organization
+ The description of the repository.
"""
- organizationResourcePath: URI
+ description: String
"""
- The HTTP URL for the organization
+ The description of the repository rendered to HTML.
"""
- organizationUrl: URI
+ descriptionHTML: HTML!
"""
- The repository associated with the action
+ The number of kilobytes this repository occupies on disk.
"""
- repository: Repository
+ diskUsage: Int
"""
- The name of the repository
+ Returns how many forks there are of this repository in the whole network.
"""
- repositoryName: String
+ forkCount: Int!
"""
- The HTTP path for the repository
+ A list of direct forked repositories.
"""
- repositoryResourcePath: URI
+ forks(
+ """
+ Array of viewer's affiliation options for repositories returned from the
+ connection. For example, OWNER will include only repositories that the
+ current viewer owns.
+ """
+ affiliations: [RepositoryAffiliation]
- """
- The HTTP URL for the repository
- """
- repositoryUrl: URI
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
- """
- The user affected by the action
- """
- user: User
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
- """
- For actions involving two users, the actor is the initiator and the user is the affected user.
- """
- userLogin: String
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
- """
- The HTTP path for the user.
- """
- userResourcePath: URI
+ """
+ If non-null, filters repositories according to whether they have been locked
+ """
+ isLocked: Boolean
- """
- The HTTP URL for the user.
- """
- userUrl: URI
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
- """
- The visibility of the repository
- """
- visibility: RepoAddMemberAuditEntryVisibility
-}
+ """
+ Ordering options for repositories returned from the connection
+ """
+ orderBy: RepositoryOrder
-"""
-The privacy of a repository
-"""
-enum RepoAddMemberAuditEntryVisibility @preview(toggledBy: "audit-log-preview") {
- """
- The repository is visible only to users in the same business.
- """
- INTERNAL
+ """
+ Array of owner's affiliation options for repositories returned from the
+ connection. For example, OWNER will include only repositories that the
+ organization or user being viewed owns.
+ """
+ ownerAffiliations: [RepositoryAffiliation] = [OWNER, COLLABORATOR]
- """
- The repository is visible only to those with explicit access.
- """
- PRIVATE
+ """
+ If non-null, filters repositories according to privacy
+ """
+ privacy: RepositoryPrivacy
+ ): RepositoryConnection!
"""
- The repository is visible to everyone.
+ Indicates if the repository has anonymous Git read access feature enabled.
"""
- PUBLIC
-}
+ hasAnonymousAccessEnabled: Boolean!
-"""
-Audit log entry for a repo.config.disable_anonymous_git_access event.
-"""
-type RepoConfigDisableAnonymousGitAccessAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData @preview(toggledBy: "audit-log-preview") {
"""
- The action name
+ Indicates if the repository has issues feature enabled.
"""
- action: String!
+ hasIssuesEnabled: Boolean!
"""
- The user who initiated the action
+ Indicates if the repository has the Projects feature enabled.
"""
- actor: AuditEntryActor
+ hasProjectsEnabled: Boolean!
"""
- The IP address of the actor
+ Indicates if the repository has wiki feature enabled.
"""
- actorIp: String
+ hasWikiEnabled: Boolean!
"""
- A readable representation of the actor's location
+ The repository's URL.
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ homepageUrl: URI
+ id: ID!
"""
- The username of the user who initiated the action
+ Indicates if the repository is unmaintained.
"""
- actorLogin: String
+ isArchived: Boolean!
"""
- The HTTP path for the actor.
+ Returns true if blank issue creation is allowed
"""
- actorResourcePath: URI
+ isBlankIssuesEnabled: Boolean!
"""
- The HTTP URL for the actor.
+ Returns whether or not this repository disabled.
"""
- actorUrl: URI
+ isDisabled: Boolean!
"""
- The time the action was initiated
+ Returns whether or not this repository is empty.
"""
- createdAt: PreciseDateTime!
- id: ID!
+ isEmpty: Boolean!
"""
- The Organization associated with the Audit Entry.
+ Identifies if the repository is a fork.
"""
- organization: Organization
+ isFork: Boolean!
"""
- The name of the Organization.
+ Indicates if a repository is either owned by an organization, or is a private fork of an organization repository.
"""
- organizationName: String
+ isInOrganization: Boolean!
"""
- The HTTP path for the organization
+ Indicates if the repository has been locked or not.
"""
- organizationResourcePath: URI
+ isLocked: Boolean!
"""
- The HTTP URL for the organization
+ Identifies if the repository is a mirror.
"""
- organizationUrl: URI
+ isMirror: Boolean!
"""
- The repository associated with the action
+ Identifies if the repository is private.
"""
- repository: Repository
+ isPrivate: Boolean!
"""
- The name of the repository
+ Returns true if this repository has a security policy
"""
- repositoryName: String
+ isSecurityPolicyEnabled: Boolean
"""
- The HTTP path for the repository
+ Identifies if the repository is a template that can be used to generate new repositories.
"""
- repositoryResourcePath: URI
+ isTemplate: Boolean!
"""
- The HTTP URL for the repository
+ Is this repository a user configuration repository?
"""
- repositoryUrl: URI
+ isUserConfigurationRepository: Boolean!
"""
- The user affected by the action
+ Returns a single issue from the current repository by number.
"""
- user: User
+ issue(
+ """
+ The number for the issue to be returned.
+ """
+ number: Int!
+ ): Issue
"""
- For actions involving two users, the actor is the initiator and the user is the affected user.
+ Returns a single issue-like object from the current repository by number.
"""
- userLogin: String
+ issueOrPullRequest(
+ """
+ The number for the issue to be returned.
+ """
+ number: Int!
+ ): IssueOrPullRequest
"""
- The HTTP path for the user.
+ Returns a list of issue templates associated to the repository
"""
- userResourcePath: URI
+ issueTemplates: [IssueTemplate!]
"""
- The HTTP URL for the user.
+ A list of issues that have been opened in the repository.
"""
- userUrl: URI
-}
+ issues(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Filtering options for issues returned from the connection.
+ """
+ filterBy: IssueFilters
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ A list of label names to filter the pull requests by.
+ """
+ labels: [String!]
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Ordering options for issues returned from the connection.
+ """
+ orderBy: IssueOrder
+
+ """
+ A list of states to filter the issues by.
+ """
+ states: [IssueState!]
+ ): IssueConnection!
-"""
-Audit log entry for a repo.config.disable_collaborators_only event.
-"""
-type RepoConfigDisableCollaboratorsOnlyAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData @preview(toggledBy: "audit-log-preview") {
"""
- The action name
+ Returns a single label by name
"""
- action: String!
+ label(
+ """
+ Label name
+ """
+ name: String!
+ ): Label
"""
- The user who initiated the action
+ A list of labels associated with the repository.
"""
- actor: AuditEntryActor
+ labels(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Ordering options for labels returned from the connection.
+ """
+ orderBy: LabelOrder = {field: CREATED_AT, direction: ASC}
+
+ """
+ If provided, searches labels by name and description.
+ """
+ query: String
+ ): LabelConnection
"""
- The IP address of the actor
+ A list containing a breakdown of the language composition of the repository.
"""
- actorIp: String
+ languages(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Order for connection
+ """
+ orderBy: LanguageOrder
+ ): LanguageConnection
"""
- A readable representation of the actor's location
+ The license associated with the repository
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ licenseInfo: License
"""
- The username of the user who initiated the action
+ The reason the repository has been locked.
"""
- actorLogin: String
+ lockReason: RepositoryLockReason
"""
- The HTTP path for the actor.
+ A list of Users that can be mentioned in the context of the repository.
"""
- actorResourcePath: URI
+ mentionableUsers(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Filters users with query on user name and login
+ """
+ query: String
+ ): UserConnection!
"""
- The HTTP URL for the actor.
+ Whether or not PRs are merged with a merge commit on this repository.
"""
- actorUrl: URI
+ mergeCommitAllowed: Boolean!
"""
- The time the action was initiated
+ Returns a single milestone from the current repository by number.
"""
- createdAt: PreciseDateTime!
- id: ID!
+ milestone(
+ """
+ The number for the milestone to be returned.
+ """
+ number: Int!
+ ): Milestone
"""
- The Organization associated with the Audit Entry.
+ A list of milestones associated with the repository.
"""
- organization: Organization
+ milestones(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Ordering options for milestones.
+ """
+ orderBy: MilestoneOrder
- """
- The name of the Organization.
- """
- organizationName: String
+ """
+ Filters milestones with a query on the title
+ """
+ query: String
- """
- The HTTP path for the organization
- """
- organizationResourcePath: URI
+ """
+ Filter by the state of the milestones.
+ """
+ states: [MilestoneState!]
+ ): MilestoneConnection
"""
- The HTTP URL for the organization
+ The repository's original mirror URL.
"""
- organizationUrl: URI
+ mirrorUrl: URI
"""
- The repository associated with the action
+ The name of the repository.
"""
- repository: Repository
+ name: String!
"""
- The name of the repository
+ The repository's name with owner.
"""
- repositoryName: String
+ nameWithOwner: String!
"""
- The HTTP path for the repository
+ A Git object in the repository
"""
- repositoryResourcePath: URI
+ object(
+ """
+ A Git revision expression suitable for rev-parse
+ """
+ expression: String
- """
- The HTTP URL for the repository
- """
- repositoryUrl: URI
+ """
+ The Git object ID
+ """
+ oid: GitObjectID
+ ): GitObject
"""
- The user affected by the action
+ The image used to represent this repository in Open Graph data.
"""
- user: User
+ openGraphImageUrl: URI!
"""
- For actions involving two users, the actor is the initiator and the user is the affected user.
+ The User owner of the repository.
"""
- userLogin: String
+ owner: RepositoryOwner!
"""
- The HTTP path for the user.
+ The repository parent, if this is a fork.
"""
- userResourcePath: URI
+ parent: Repository
"""
- The HTTP URL for the user.
+ A list of pinned issues for this repository.
"""
- userUrl: URI
-}
+ pinnedIssues(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
-"""
-Audit log entry for a repo.config.disable_contributors_only event.
-"""
-type RepoConfigDisableContributorsOnlyAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData @preview(toggledBy: "audit-log-preview") {
- """
- The action name
- """
- action: String!
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
- """
- The user who initiated the action
- """
- actor: AuditEntryActor
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
- """
- The IP address of the actor
- """
- actorIp: String
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): PinnedIssueConnection @preview(toggledBy: "elektra-preview")
"""
- A readable representation of the actor's location
+ The primary language of the repository's code.
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ primaryLanguage: Language
"""
- The username of the user who initiated the action
+ Find project by number.
"""
- actorLogin: String
+ project(
+ """
+ The project number to find.
+ """
+ number: Int!
+ ): Project
"""
- The HTTP path for the actor.
+ A list of projects under the owner.
"""
- actorResourcePath: URI
+ projects(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
- """
- The HTTP URL for the actor.
- """
- actorUrl: URI
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
- """
- The time the action was initiated
- """
- createdAt: PreciseDateTime!
- id: ID!
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
- """
- The Organization associated with the Audit Entry.
- """
- organization: Organization
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
- """
- The name of the Organization.
- """
- organizationName: String
+ """
+ Ordering options for projects returned from the connection
+ """
+ orderBy: ProjectOrder
- """
- The HTTP path for the organization
- """
- organizationResourcePath: URI
+ """
+ Query to search projects by, currently only searching by name.
+ """
+ search: String
- """
- The HTTP URL for the organization
- """
- organizationUrl: URI
+ """
+ A list of states to filter the projects by.
+ """
+ states: [ProjectState!]
+ ): ProjectConnection!
"""
- The repository associated with the action
+ The HTTP path listing the repository's projects
"""
- repository: Repository
+ projectsResourcePath: URI!
"""
- The name of the repository
+ The HTTP URL listing the repository's projects
"""
- repositoryName: String
+ projectsUrl: URI!
"""
- The HTTP path for the repository
+ Returns a single pull request from the current repository by number.
"""
- repositoryResourcePath: URI
+ pullRequest(
+ """
+ The number for the pull request to be returned.
+ """
+ number: Int!
+ ): PullRequest
"""
- The HTTP URL for the repository
+ A list of pull requests that have been opened in the repository.
"""
- repositoryUrl: URI
+ pullRequests(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
- """
- The user affected by the action
- """
- user: User
+ """
+ The base ref name to filter the pull requests by.
+ """
+ baseRefName: String
- """
- For actions involving two users, the actor is the initiator and the user is the affected user.
- """
- userLogin: String
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
- """
- The HTTP path for the user.
- """
- userResourcePath: URI
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
- """
- The HTTP URL for the user.
- """
- userUrl: URI
-}
+ """
+ The head ref name to filter the pull requests by.
+ """
+ headRefName: String
-"""
-Audit log entry for a repo.config.disable_sockpuppet_disallowed event.
-"""
-type RepoConfigDisableSockpuppetDisallowedAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData @preview(toggledBy: "audit-log-preview") {
- """
- The action name
- """
- action: String!
+ """
+ A list of label names to filter the pull requests by.
+ """
+ labels: [String!]
- """
- The user who initiated the action
- """
- actor: AuditEntryActor
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
- """
- The IP address of the actor
- """
- actorIp: String
+ """
+ Ordering options for pull requests returned from the connection.
+ """
+ orderBy: IssueOrder
+
+ """
+ A list of states to filter the pull requests by.
+ """
+ states: [PullRequestState!]
+ ): PullRequestConnection!
"""
- A readable representation of the actor's location
+ Identifies when the repository was last pushed to.
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ pushedAt: DateTime
"""
- The username of the user who initiated the action
+ Whether or not rebase-merging is enabled on this repository.
"""
- actorLogin: String
+ rebaseMergeAllowed: Boolean!
"""
- The HTTP path for the actor.
+ Fetch a given ref from the repository
"""
- actorResourcePath: URI
+ ref(
+ """
+ The ref to retrieve. Fully qualified matches are checked in order
+ (`refs/heads/master`) before falling back onto checks for short name matches (`master`).
+ """
+ qualifiedName: String!
+ ): Ref
"""
- The HTTP URL for the actor.
+ Fetch a list of refs from the repository
"""
- actorUrl: URI
+ refs(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
- """
- The time the action was initiated
- """
- createdAt: PreciseDateTime!
- id: ID!
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
- """
- The Organization associated with the Audit Entry.
- """
- organization: Organization
+ """
+ DEPRECATED: use orderBy. The ordering direction.
+ """
+ direction: OrderDirection
- """
- The name of the Organization.
- """
- organizationName: String
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
- """
- The HTTP path for the organization
- """
- organizationResourcePath: URI
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
- """
- The HTTP URL for the organization
- """
- organizationUrl: URI
+ """
+ Ordering options for refs returned from the connection.
+ """
+ orderBy: RefOrder
- """
- The repository associated with the action
- """
- repository: Repository
+ """
+ Filters refs with query on name
+ """
+ query: String
- """
- The name of the repository
- """
- repositoryName: String
+ """
+ A ref name prefix like `refs/heads/`, `refs/tags/`, etc.
+ """
+ refPrefix: String!
+ ): RefConnection
"""
- The HTTP path for the repository
+ Lookup a single release given various criteria.
"""
- repositoryResourcePath: URI
+ release(
+ """
+ The name of the Tag the Release was created from
+ """
+ tagName: String!
+ ): Release
"""
- The HTTP URL for the repository
+ List of releases which are dependent on this repository.
"""
- repositoryUrl: URI
+ releases(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
- """
- The user affected by the action
- """
- user: User
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
- """
- For actions involving two users, the actor is the initiator and the user is the affected user.
- """
- userLogin: String
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
- """
- The HTTP path for the user.
- """
- userResourcePath: URI
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
- """
- The HTTP URL for the user.
- """
- userUrl: URI
-}
+ """
+ Order for connection
+ """
+ orderBy: ReleaseOrder
+ ): ReleaseConnection!
-"""
-Audit log entry for a repo.config.enable_anonymous_git_access event.
-"""
-type RepoConfigEnableAnonymousGitAccessAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData @preview(toggledBy: "audit-log-preview") {
"""
- The action name
+ A list of applied repository-topic associations for this repository.
"""
- action: String!
+ repositoryTopics(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
- """
- The user who initiated the action
- """
- actor: AuditEntryActor
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
- """
- The IP address of the actor
- """
- actorIp: String
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
- """
- A readable representation of the actor's location
- """
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): RepositoryTopicConnection!
"""
- The username of the user who initiated the action
+ The HTTP path for this repository
"""
- actorLogin: String
+ resourcePath: URI!
"""
- The HTTP path for the actor.
+ The security policy URL.
"""
- actorResourcePath: URI
+ securityPolicyUrl: URI
"""
- The HTTP URL for the actor.
+ A description of the repository, rendered to HTML without any links in it.
"""
- actorUrl: URI
+ shortDescriptionHTML(
+ """
+ How many characters to return.
+ """
+ limit: Int = 200
+ ): HTML!
"""
- The time the action was initiated
+ Whether or not squash-merging is enabled on this repository.
"""
- createdAt: PreciseDateTime!
- id: ID!
+ squashMergeAllowed: Boolean!
"""
- The Organization associated with the Audit Entry.
+ The SSH URL to clone this repository
"""
- organization: Organization
+ sshUrl: GitSSHRemote!
"""
- The name of the Organization.
+ Returns a count of how many stargazers there are on this object
"""
- organizationName: String
+ stargazerCount: Int!
"""
- The HTTP path for the organization
+ A list of users who have starred this starrable.
"""
- organizationResourcePath: URI
+ stargazers(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
- """
- The HTTP URL for the organization
- """
- organizationUrl: URI
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
- """
- The repository associated with the action
- """
- repository: Repository
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
- """
- The name of the repository
- """
- repositoryName: String
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
- """
- The HTTP path for the repository
- """
- repositoryResourcePath: URI
+ """
+ Order for connection
+ """
+ orderBy: StarOrder
+ ): StargazerConnection!
"""
- The HTTP URL for the repository
+ Returns a list of all submodules in this repository parsed from the
+ .gitmodules file as of the default branch's HEAD commit.
"""
- repositoryUrl: URI
+ submodules(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
- """
- The user affected by the action
- """
- user: User
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): SubmoduleConnection!
"""
- For actions involving two users, the actor is the initiator and the user is the affected user.
+ Temporary authentication token for cloning this repository.
"""
- userLogin: String
+ tempCloneToken: String
"""
- The HTTP path for the user.
+ The repository from which this repository was generated, if any.
"""
- userResourcePath: URI
+ templateRepository: Repository
"""
- The HTTP URL for the user.
+ Identifies the date and time when the object was last updated.
"""
- userUrl: URI
-}
+ updatedAt: DateTime!
-"""
-Audit log entry for a repo.config.enable_collaborators_only event.
-"""
-type RepoConfigEnableCollaboratorsOnlyAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData @preview(toggledBy: "audit-log-preview") {
"""
- The action name
+ The HTTP URL for this repository
"""
- action: String!
+ url: URI!
"""
- The user who initiated the action
+ Whether this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar.
"""
- actor: AuditEntryActor
+ usesCustomOpenGraphImage: Boolean!
"""
- The IP address of the actor
+ Indicates whether the viewer has admin permissions on this repository.
"""
- actorIp: String
+ viewerCanAdminister: Boolean!
"""
- A readable representation of the actor's location
+ Can the current viewer create new projects on this owner.
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ viewerCanCreateProjects: Boolean!
"""
- The username of the user who initiated the action
+ Check if the viewer is able to change their subscription status for the repository.
"""
- actorLogin: String
+ viewerCanSubscribe: Boolean!
"""
- The HTTP path for the actor.
+ Indicates whether the viewer can update the topics of this repository.
"""
- actorResourcePath: URI
+ viewerCanUpdateTopics: Boolean!
"""
- The HTTP URL for the actor.
+ The last commit email for the viewer.
"""
- actorUrl: URI
+ viewerDefaultCommitEmail: String
"""
- The time the action was initiated
+ The last used merge method by the viewer or the default for the repository.
"""
- createdAt: PreciseDateTime!
- id: ID!
+ viewerDefaultMergeMethod: PullRequestMergeMethod!
"""
- The Organization associated with the Audit Entry.
+ Returns a boolean indicating whether the viewing user has starred this starrable.
"""
- organization: Organization
+ viewerHasStarred: Boolean!
"""
- The name of the Organization.
+ The users permission level on the repository. Will return null if authenticated as an GitHub App.
"""
- organizationName: String
+ viewerPermission: RepositoryPermission
"""
- The HTTP path for the organization
+ A list of emails this viewer can commit with.
"""
- organizationResourcePath: URI
+ viewerPossibleCommitEmails: [String!]
"""
- The HTTP URL for the organization
+ Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
"""
- organizationUrl: URI
+ viewerSubscription: SubscriptionState
"""
- The repository associated with the action
+ A list of vulnerability alerts that are on this repository.
"""
- repository: Repository
+ vulnerabilityAlerts(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
- """
- The name of the repository
- """
- repositoryName: String
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
- """
- The HTTP path for the repository
- """
- repositoryResourcePath: URI
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
- """
- The HTTP URL for the repository
- """
- repositoryUrl: URI
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): RepositoryVulnerabilityAlertConnection
"""
- The user affected by the action
+ A list of users watching the repository.
"""
- user: User
+ watchers(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
- """
- For actions involving two users, the actor is the initiator and the user is the affected user.
- """
- userLogin: String
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
- """
- The HTTP path for the user.
- """
- userResourcePath: URI
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
- """
- The HTTP URL for the user.
- """
- userUrl: URI
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): UserConnection!
}
"""
-Audit log entry for a repo.config.enable_contributors_only event.
+The affiliation of a user to a repository
"""
-type RepoConfigEnableContributorsOnlyAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData @preview(toggledBy: "audit-log-preview") {
- """
- The action name
- """
- action: String!
-
+enum RepositoryAffiliation {
"""
- The user who initiated the action
+ Repositories that the user has been added to as a collaborator.
"""
- actor: AuditEntryActor
+ COLLABORATOR
"""
- The IP address of the actor
+ Repositories that the user has access to through being a member of an
+ organization. This includes every repository on every team that the user is on.
"""
- actorIp: String
+ ORGANIZATION_MEMBER
"""
- A readable representation of the actor's location
+ Repositories that are owned by the authenticated user.
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ OWNER
+}
+"""
+Metadata for an audit entry with action repo.*
+"""
+interface RepositoryAuditEntryData {
"""
- The username of the user who initiated the action
+ The repository associated with the action
"""
- actorLogin: String
+ repository: Repository
"""
- The HTTP path for the actor.
+ The name of the repository
"""
- actorResourcePath: URI
+ repositoryName: String
"""
- The HTTP URL for the actor.
+ The HTTP path for the repository
"""
- actorUrl: URI
+ repositoryResourcePath: URI
"""
- The time the action was initiated
+ The HTTP URL for the repository
"""
- createdAt: PreciseDateTime!
- id: ID!
+ repositoryUrl: URI
+}
+"""
+The connection type for User.
+"""
+type RepositoryCollaboratorConnection {
"""
- The Organization associated with the Audit Entry.
+ A list of edges.
"""
- organization: Organization
+ edges: [RepositoryCollaboratorEdge]
"""
- The name of the Organization.
+ A list of nodes.
"""
- organizationName: String
+ nodes: [User]
"""
- The HTTP path for the organization
+ Information to aid in pagination.
"""
- organizationResourcePath: URI
+ pageInfo: PageInfo!
"""
- The HTTP URL for the organization
+ Identifies the total count of items in the connection.
"""
- organizationUrl: URI
+ totalCount: Int!
+}
+"""
+Represents a user who is a collaborator of a repository.
+"""
+type RepositoryCollaboratorEdge {
"""
- The repository associated with the action
+ A cursor for use in pagination.
"""
- repository: Repository
+ cursor: String!
+ node: User!
"""
- The name of the repository
+ The permission the user has on the repository.
"""
- repositoryName: String
+ permission: RepositoryPermission!
"""
- The HTTP path for the repository
+ A list of sources for the user's access to the repository.
"""
- repositoryResourcePath: URI
+ permissionSources: [PermissionSource!]
+}
+"""
+A list of repositories owned by the subject.
+"""
+type RepositoryConnection {
"""
- The HTTP URL for the repository
+ A list of edges.
"""
- repositoryUrl: URI
+ edges: [RepositoryEdge]
"""
- The user affected by the action
+ A list of nodes.
"""
- user: User
+ nodes: [Repository]
"""
- For actions involving two users, the actor is the initiator and the user is the affected user.
+ Information to aid in pagination.
"""
- userLogin: String
+ pageInfo: PageInfo!
"""
- The HTTP path for the user.
+ Identifies the total count of items in the connection.
"""
- userResourcePath: URI
+ totalCount: Int!
"""
- The HTTP URL for the user.
+ The total size in kilobytes of all repositories in the connection.
"""
- userUrl: URI
+ totalDiskUsage: Int!
}
"""
-Audit log entry for a repo.config.enable_sockpuppet_disallowed event.
+A repository contact link.
"""
-type RepoConfigEnableSockpuppetDisallowedAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData @preview(toggledBy: "audit-log-preview") {
- """
- The action name
- """
- action: String!
-
+type RepositoryContactLink {
"""
- The user who initiated the action
+ The contact link purpose.
"""
- actor: AuditEntryActor
+ about: String!
"""
- The IP address of the actor
+ The contact link name.
"""
- actorIp: String
+ name: String!
"""
- A readable representation of the actor's location
+ The contact link URL.
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ url: URI!
+}
+"""
+The reason a repository is listed as 'contributed'.
+"""
+enum RepositoryContributionType {
"""
- The username of the user who initiated the action
+ Created a commit
"""
- actorLogin: String
+ COMMIT
"""
- The HTTP path for the actor.
+ Created an issue
"""
- actorResourcePath: URI
+ ISSUE
"""
- The HTTP URL for the actor.
+ Created a pull request
"""
- actorUrl: URI
+ PULL_REQUEST
"""
- The time the action was initiated
+ Reviewed a pull request
"""
- createdAt: PreciseDateTime!
- id: ID!
+ PULL_REQUEST_REVIEW
"""
- The Organization associated with the Audit Entry.
+ Created the repository
"""
- organization: Organization
+ REPOSITORY
+}
+"""
+An edge in a connection.
+"""
+type RepositoryEdge {
"""
- The name of the Organization.
+ A cursor for use in pagination.
"""
- organizationName: String
+ cursor: String!
"""
- The HTTP path for the organization
+ The item at the end of the edge.
"""
- organizationResourcePath: URI
+ node: Repository
+}
+"""
+A subset of repository info.
+"""
+interface RepositoryInfo {
"""
- The HTTP URL for the organization
+ Identifies the date and time when the object was created.
"""
- organizationUrl: URI
+ createdAt: DateTime!
"""
- The repository associated with the action
+ The description of the repository.
"""
- repository: Repository
+ description: String
"""
- The name of the repository
+ The description of the repository rendered to HTML.
"""
- repositoryName: String
+ descriptionHTML: HTML!
"""
- The HTTP path for the repository
+ Returns how many forks there are of this repository in the whole network.
"""
- repositoryResourcePath: URI
+ forkCount: Int!
"""
- The HTTP URL for the repository
+ Indicates if the repository has anonymous Git read access feature enabled.
"""
- repositoryUrl: URI
+ hasAnonymousAccessEnabled: Boolean!
"""
- The user affected by the action
+ Indicates if the repository has issues feature enabled.
"""
- user: User
+ hasIssuesEnabled: Boolean!
"""
- For actions involving two users, the actor is the initiator and the user is the affected user.
+ Indicates if the repository has the Projects feature enabled.
"""
- userLogin: String
+ hasProjectsEnabled: Boolean!
"""
- The HTTP path for the user.
+ Indicates if the repository has wiki feature enabled.
"""
- userResourcePath: URI
+ hasWikiEnabled: Boolean!
"""
- The HTTP URL for the user.
+ The repository's URL.
"""
- userUrl: URI
-}
+ homepageUrl: URI
-"""
-Audit log entry for a repo.config.lock_anonymous_git_access event.
-"""
-type RepoConfigLockAnonymousGitAccessAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData @preview(toggledBy: "audit-log-preview") {
"""
- The action name
+ Indicates if the repository is unmaintained.
"""
- action: String!
+ isArchived: Boolean!
"""
- The user who initiated the action
+ Identifies if the repository is a fork.
"""
- actor: AuditEntryActor
+ isFork: Boolean!
"""
- The IP address of the actor
+ Indicates if a repository is either owned by an organization, or is a private fork of an organization repository.
"""
- actorIp: String
+ isInOrganization: Boolean!
"""
- A readable representation of the actor's location
+ Indicates if the repository has been locked or not.
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ isLocked: Boolean!
"""
- The username of the user who initiated the action
+ Identifies if the repository is a mirror.
"""
- actorLogin: String
+ isMirror: Boolean!
"""
- The HTTP path for the actor.
+ Identifies if the repository is private.
"""
- actorResourcePath: URI
+ isPrivate: Boolean!
"""
- The HTTP URL for the actor.
+ Identifies if the repository is a template that can be used to generate new repositories.
"""
- actorUrl: URI
+ isTemplate: Boolean!
"""
- The time the action was initiated
+ The license associated with the repository
"""
- createdAt: PreciseDateTime!
- id: ID!
+ licenseInfo: License
"""
- The Organization associated with the Audit Entry.
+ The reason the repository has been locked.
"""
- organization: Organization
+ lockReason: RepositoryLockReason
"""
- The name of the Organization.
+ The repository's original mirror URL.
"""
- organizationName: String
+ mirrorUrl: URI
"""
- The HTTP path for the organization
+ The name of the repository.
"""
- organizationResourcePath: URI
+ name: String!
"""
- The HTTP URL for the organization
+ The repository's name with owner.
"""
- organizationUrl: URI
+ nameWithOwner: String!
"""
- The repository associated with the action
+ The image used to represent this repository in Open Graph data.
"""
- repository: Repository
+ openGraphImageUrl: URI!
"""
- The name of the repository
+ The User owner of the repository.
"""
- repositoryName: String
+ owner: RepositoryOwner!
"""
- The HTTP path for the repository
+ Identifies when the repository was last pushed to.
"""
- repositoryResourcePath: URI
+ pushedAt: DateTime
"""
- The HTTP URL for the repository
+ The HTTP path for this repository
"""
- repositoryUrl: URI
+ resourcePath: URI!
"""
- The user affected by the action
+ A description of the repository, rendered to HTML without any links in it.
"""
- user: User
+ shortDescriptionHTML(
+ """
+ How many characters to return.
+ """
+ limit: Int = 200
+ ): HTML!
"""
- For actions involving two users, the actor is the initiator and the user is the affected user.
+ Identifies the date and time when the object was last updated.
"""
- userLogin: String
+ updatedAt: DateTime!
"""
- The HTTP path for the user.
+ The HTTP URL for this repository
"""
- userResourcePath: URI
+ url: URI!
"""
- The HTTP URL for the user.
+ Whether this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar.
"""
- userUrl: URI
+ usesCustomOpenGraphImage: Boolean!
}
"""
-Audit log entry for a repo.config.unlock_anonymous_git_access event.
+An invitation for a user to be added to a repository.
"""
-type RepoConfigUnlockAnonymousGitAccessAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData @preview(toggledBy: "audit-log-preview") {
+type RepositoryInvitation implements Node {
"""
- The action name
+ The email address that received the invitation.
"""
- action: String!
+ email: String
+ id: ID!
"""
- The user who initiated the action
+ The user who received the invitation.
"""
- actor: AuditEntryActor
+ invitee: User
"""
- The IP address of the actor
+ The user who created the invitation.
"""
- actorIp: String
+ inviter: User!
"""
- A readable representation of the actor's location
+ The permalink for this repository invitation.
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ permalink: URI!
"""
- The username of the user who initiated the action
+ The permission granted on this repository by this invitation.
"""
- actorLogin: String
+ permission: RepositoryPermission!
"""
- The HTTP path for the actor.
+ The Repository the user is invited to.
"""
- actorResourcePath: URI
+ repository: RepositoryInfo
+}
+"""
+The connection type for RepositoryInvitation.
+"""
+type RepositoryInvitationConnection {
"""
- The HTTP URL for the actor.
+ A list of edges.
"""
- actorUrl: URI
+ edges: [RepositoryInvitationEdge]
"""
- The time the action was initiated
+ A list of nodes.
"""
- createdAt: PreciseDateTime!
- id: ID!
+ nodes: [RepositoryInvitation]
"""
- The Organization associated with the Audit Entry.
+ Information to aid in pagination.
"""
- organization: Organization
+ pageInfo: PageInfo!
"""
- The name of the Organization.
+ Identifies the total count of items in the connection.
"""
- organizationName: String
+ totalCount: Int!
+}
+"""
+An edge in a connection.
+"""
+type RepositoryInvitationEdge {
"""
- The HTTP path for the organization
+ A cursor for use in pagination.
"""
- organizationResourcePath: URI
+ cursor: String!
"""
- The HTTP URL for the organization
+ The item at the end of the edge.
"""
- organizationUrl: URI
+ node: RepositoryInvitation
+}
+"""
+Ordering options for repository invitation connections.
+"""
+input RepositoryInvitationOrder {
"""
- The repository associated with the action
+ The ordering direction.
"""
- repository: Repository
+ direction: OrderDirection!
"""
- The name of the repository
+ The field to order repository invitations by.
"""
- repositoryName: String
+ field: RepositoryInvitationOrderField!
+}
+"""
+Properties by which repository invitation connections can be ordered.
+"""
+enum RepositoryInvitationOrderField {
"""
- The HTTP path for the repository
+ Order repository invitations by creation time
"""
- repositoryResourcePath: URI
+ CREATED_AT
"""
- The HTTP URL for the repository
+ Order repository invitations by invitee login
"""
- repositoryUrl: URI
+ INVITEE_LOGIN @deprecated(reason: "`INVITEE_LOGIN` is no longer a valid field value. Repository invitations can now be associated with an email, not only an invitee. Removal on 2020-10-01 UTC.")
+}
+"""
+The possible reasons a given repository could be in a locked state.
+"""
+enum RepositoryLockReason {
"""
- The user affected by the action
+ The repository is locked due to a billing related reason.
"""
- user: User
+ BILLING
"""
- For actions involving two users, the actor is the initiator and the user is the affected user.
+ The repository is locked due to a migration.
"""
- userLogin: String
+ MIGRATING
"""
- The HTTP path for the user.
+ The repository is locked due to a move.
"""
- userResourcePath: URI
+ MOVING
"""
- The HTTP URL for the user.
+ The repository is locked due to a rename.
"""
- userUrl: URI
+ RENAME
}
"""
-Audit log entry for a repo.remove_member event.
+Represents a object that belongs to a repository.
+"""
+interface RepositoryNode {
+ """
+ The repository associated with this node.
+ """
+ repository: Repository!
+}
+
+"""
+Ordering options for repository connections
"""
-type RepoRemoveMemberAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData @preview(toggledBy: "audit-log-preview") {
+input RepositoryOrder {
"""
- The action name
+ The ordering direction.
"""
- action: String!
+ direction: OrderDirection!
"""
- The user who initiated the action
+ The field to order repositories by.
"""
- actor: AuditEntryActor
+ field: RepositoryOrderField!
+}
+"""
+Properties by which repository connections can be ordered.
+"""
+enum RepositoryOrderField {
"""
- The IP address of the actor
+ Order repositories by creation time
"""
- actorIp: String
+ CREATED_AT
"""
- A readable representation of the actor's location
+ Order repositories by name
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ NAME
"""
- The username of the user who initiated the action
+ Order repositories by push time
"""
- actorLogin: String
+ PUSHED_AT
"""
- The HTTP path for the actor.
+ Order repositories by number of stargazers
"""
- actorResourcePath: URI
+ STARGAZERS
"""
- The HTTP URL for the actor.
+ Order repositories by update time
"""
- actorUrl: URI
+ UPDATED_AT
+}
+"""
+Represents an owner of a Repository.
+"""
+interface RepositoryOwner {
"""
- The time the action was initiated
+ A URL pointing to the owner's public avatar.
"""
- createdAt: PreciseDateTime!
+ avatarUrl(
+ """
+ The size of the resulting square image.
+ """
+ size: Int
+ ): URI!
id: ID!
"""
- The Organization associated with the Audit Entry.
+ The username used to login.
"""
- organization: Organization
+ login: String!
"""
- The name of the Organization.
+ A list of repositories that the user owns.
"""
- organizationName: String
+ repositories(
+ """
+ Array of viewer's affiliation options for repositories returned from the
+ connection. For example, OWNER will include only repositories that the
+ current viewer owns.
+ """
+ affiliations: [RepositoryAffiliation]
- """
- The HTTP path for the organization
- """
- organizationResourcePath: URI
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
- """
- The HTTP URL for the organization
- """
- organizationUrl: URI
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
- """
- The repository associated with the action
- """
- repository: Repository
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ If non-null, filters repositories according to whether they are forks of another repository
+ """
+ isFork: Boolean
+
+ """
+ If non-null, filters repositories according to whether they have been locked
+ """
+ isLocked: Boolean
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Ordering options for repositories returned from the connection
+ """
+ orderBy: RepositoryOrder
+
+ """
+ Array of owner's affiliation options for repositories returned from the
+ connection. For example, OWNER will include only repositories that the
+ organization or user being viewed owns.
+ """
+ ownerAffiliations: [RepositoryAffiliation] = [OWNER, COLLABORATOR]
+
+ """
+ If non-null, filters repositories according to privacy
+ """
+ privacy: RepositoryPrivacy
+ ): RepositoryConnection!
"""
- The name of the repository
+ Find Repository.
"""
- repositoryName: String
+ repository(
+ """
+ Name of Repository to find.
+ """
+ name: String!
+ ): Repository
"""
- The HTTP path for the repository
+ The HTTP URL for the owner.
"""
- repositoryResourcePath: URI
+ resourcePath: URI!
"""
- The HTTP URL for the repository
+ The HTTP URL for the owner.
"""
- repositoryUrl: URI
+ url: URI!
+}
+"""
+The access level to a repository
+"""
+enum RepositoryPermission {
"""
- The user affected by the action
+ Can read, clone, and push to this repository. Can also manage issues, pull
+ requests, and repository settings, including adding collaborators
"""
- user: User
+ ADMIN
"""
- For actions involving two users, the actor is the initiator and the user is the affected user.
+ Can read, clone, and push to this repository. They can also manage issues, pull requests, and some repository settings
"""
- userLogin: String
+ MAINTAIN
"""
- The HTTP path for the user.
+ Can read and clone this repository. Can also open and comment on issues and pull requests
"""
- userResourcePath: URI
+ READ
"""
- The HTTP URL for the user.
+ Can read and clone this repository. Can also manage issues and pull requests
"""
- userUrl: URI
+ TRIAGE
"""
- The visibility of the repository
+ Can read, clone, and push to this repository. Can also manage issues and pull requests
"""
- visibility: RepoRemoveMemberAuditEntryVisibility
+ WRITE
}
"""
The privacy of a repository
"""
-enum RepoRemoveMemberAuditEntryVisibility @preview(toggledBy: "audit-log-preview") {
- """
- The repository is visible only to users in the same business.
- """
- INTERNAL
-
+enum RepositoryPrivacy {
"""
- The repository is visible only to those with explicit access.
+ Private
"""
PRIVATE
"""
- The repository is visible to everyone.
+ Public
"""
PUBLIC
}
"""
-The reasons a piece of content can be reported or minimized.
+A repository-topic connects a repository to a topic.
"""
-enum ReportedContentClassifiers {
+type RepositoryTopic implements Node & UniformResourceLocatable {
+ id: ID!
+
"""
- An irrelevant piece of content
+ The HTTP path for this repository-topic.
"""
- OFF_TOPIC
+ resourcePath: URI!
"""
- An outdated piece of content
+ The topic.
"""
- OUTDATED
+ topic: Topic!
"""
- The content has been resolved
+ The HTTP URL for this repository-topic.
"""
- RESOLVED
+ url: URI!
}
"""
-A repository contains the content for a project.
+The connection type for RepositoryTopic.
"""
-type Repository implements Node & ProjectOwner & RegistryPackageOwner & RepositoryInfo & Starrable & Subscribable & UniformResourceLocatable {
+type RepositoryTopicConnection {
"""
- A list of users that can be assigned to issues in this repository.
+ A list of edges.
"""
- assignableUsers(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
+ edges: [RepositoryTopicEdge]
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): UserConnection!
+ """
+ A list of nodes.
+ """
+ nodes: [RepositoryTopic]
"""
- A list of branch protection rules for this repository.
+ Information to aid in pagination.
"""
- branchProtectionRules(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
+ pageInfo: PageInfo!
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
+ """
+ Identifies the total count of items in the connection.
+ """
+ totalCount: Int!
+}
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
+"""
+An edge in a connection.
+"""
+type RepositoryTopicEdge {
+ """
+ A cursor for use in pagination.
+ """
+ cursor: String!
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): BranchProtectionRuleConnection!
+ """
+ The item at the end of the edge.
+ """
+ node: RepositoryTopic
+}
+"""
+The repository's visibility level.
+"""
+enum RepositoryVisibility {
"""
- Returns the code of conduct for this repository
+ The repository is visible only to users in the same business.
"""
- codeOfConduct: CodeOfConduct
+ INTERNAL
"""
- A list of collaborators associated with the repository.
+ The repository is visible only to those with explicit access.
"""
- collaborators(
- """
- Collaborators affiliation level with a repository.
- """
- affiliation: CollaboratorAffiliation
-
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): RepositoryCollaboratorConnection
+ PRIVATE
"""
- A list of commit comments associated with the repository.
+ The repository is visible to everyone.
"""
- commitComments(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
+ PUBLIC
+}
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): CommitCommentConnection!
+"""
+Audit log entry for a repository_visibility_change.disable event.
+"""
+type RepositoryVisibilityChangeDisableAuditEntry implements AuditEntry & EnterpriseAuditEntryData & Node & OrganizationAuditEntryData {
+ """
+ The action name
+ """
+ action: String!
"""
- Identifies the date and time when the object was created.
+ The user who initiated the action
"""
- createdAt: DateTime!
+ actor: AuditEntryActor
"""
- Identifies the primary key from the database.
+ The IP address of the actor
"""
- databaseId: Int
+ actorIp: String
"""
- The Ref associated with the repository's default branch.
+ A readable representation of the actor's location
"""
- defaultBranchRef: Ref
+ actorLocation: ActorLocation
"""
- A list of deploy keys that are on this repository.
+ The username of the user who initiated the action
"""
- deployKeys(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
+ actorLogin: String
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
+ """
+ The HTTP path for the actor.
+ """
+ actorResourcePath: URI
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
+ """
+ The HTTP URL for the actor.
+ """
+ actorUrl: URI
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): DeployKeyConnection!
+ """
+ The time the action was initiated
+ """
+ createdAt: PreciseDateTime!
"""
- Deployments associated with the repository
+ The HTTP path for this enterprise.
"""
- deployments(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
+ enterpriseResourcePath: URI
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
+ """
+ The slug of the enterprise.
+ """
+ enterpriseSlug: String
- """
- Environments to list deployments for
- """
- environments: [String!]
+ """
+ The HTTP URL for this enterprise.
+ """
+ enterpriseUrl: URI
+ id: ID!
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
+ """
+ The corresponding operation type for the action
+ """
+ operationType: OperationType
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
+ """
+ The Organization associated with the Audit Entry.
+ """
+ organization: Organization
- """
- Ordering options for deployments returned from the connection.
- """
- orderBy: DeploymentOrder = {field: CREATED_AT, direction: ASC}
- ): DeploymentConnection!
+ """
+ The name of the Organization.
+ """
+ organizationName: String
"""
- The description of the repository.
+ The HTTP path for the organization
"""
- description: String
+ organizationResourcePath: URI
"""
- The description of the repository rendered to HTML.
+ The HTTP URL for the organization
"""
- descriptionHTML: HTML!
+ organizationUrl: URI
"""
- The number of kilobytes this repository occupies on disk.
+ The user affected by the action
"""
- diskUsage: Int
+ user: User
"""
- Returns how many forks there are of this repository in the whole network.
+ For actions involving two users, the actor is the initiator and the user is the affected user.
"""
- forkCount: Int!
+ userLogin: String
"""
- A list of direct forked repositories.
+ The HTTP path for the user.
"""
- forks(
- """
- Array of viewer's affiliation options for repositories returned from the
- connection. For example, OWNER will include only repositories that the
- current viewer owns.
- """
- affiliations: [RepositoryAffiliation]
+ userResourcePath: URI
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
+ """
+ The HTTP URL for the user.
+ """
+ userUrl: URI
+}
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
+"""
+Audit log entry for a repository_visibility_change.enable event.
+"""
+type RepositoryVisibilityChangeEnableAuditEntry implements AuditEntry & EnterpriseAuditEntryData & Node & OrganizationAuditEntryData {
+ """
+ The action name
+ """
+ action: String!
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
+ """
+ The user who initiated the action
+ """
+ actor: AuditEntryActor
- """
- If non-null, filters repositories according to whether they have been locked
- """
- isLocked: Boolean
+ """
+ The IP address of the actor
+ """
+ actorIp: String
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
+ """
+ A readable representation of the actor's location
+ """
+ actorLocation: ActorLocation
- """
- Ordering options for repositories returned from the connection
- """
- orderBy: RepositoryOrder
+ """
+ The username of the user who initiated the action
+ """
+ actorLogin: String
- """
- Array of owner's affiliation options for repositories returned from the
- connection. For example, OWNER will include only repositories that the
- organization or user being viewed owns.
- """
- ownerAffiliations: [RepositoryAffiliation] = [OWNER, COLLABORATOR]
+ """
+ The HTTP path for the actor.
+ """
+ actorResourcePath: URI
- """
- If non-null, filters repositories according to privacy
- """
- privacy: RepositoryPrivacy
- ): RepositoryConnection!
+ """
+ The HTTP URL for the actor.
+ """
+ actorUrl: URI
"""
- Indicates if the repository has anonymous Git read access feature enabled.
+ The time the action was initiated
"""
- hasAnonymousAccessEnabled: Boolean!
+ createdAt: PreciseDateTime!
"""
- Indicates if the repository has issues feature enabled.
+ The HTTP path for this enterprise.
"""
- hasIssuesEnabled: Boolean!
+ enterpriseResourcePath: URI
"""
- Indicates if the repository has wiki feature enabled.
+ The slug of the enterprise.
"""
- hasWikiEnabled: Boolean!
+ enterpriseSlug: String
"""
- The repository's URL.
+ The HTTP URL for this enterprise.
"""
- homepageUrl: URI
+ enterpriseUrl: URI
id: ID!
"""
- Indicates if the repository is unmaintained.
+ The corresponding operation type for the action
"""
- isArchived: Boolean!
+ operationType: OperationType
"""
- Returns whether or not this repository disabled.
+ The Organization associated with the Audit Entry.
"""
- isDisabled: Boolean!
+ organization: Organization
"""
- Identifies if the repository is a fork.
+ The name of the Organization.
"""
- isFork: Boolean!
+ organizationName: String
"""
- Indicates if the repository has been locked or not.
+ The HTTP path for the organization
"""
- isLocked: Boolean!
+ organizationResourcePath: URI
"""
- Identifies if the repository is a mirror.
+ The HTTP URL for the organization
"""
- isMirror: Boolean!
+ organizationUrl: URI
"""
- Identifies if the repository is private.
+ The user affected by the action
"""
- isPrivate: Boolean!
+ user: User
"""
- Identifies if the repository is a template that can be used to generate new repositories.
+ For actions involving two users, the actor is the initiator and the user is the affected user.
"""
- isTemplate: Boolean!
+ userLogin: String
"""
- Returns a single issue from the current repository by number.
+ The HTTP path for the user.
"""
- issue(
- """
- The number for the issue to be returned.
- """
- number: Int!
- ): Issue
+ userResourcePath: URI
"""
- Returns a single issue-like object from the current repository by number.
+ The HTTP URL for the user.
"""
- issueOrPullRequest(
- """
- The number for the issue to be returned.
- """
- number: Int!
- ): IssueOrPullRequest
+ userUrl: URI
+}
+"""
+A alert for a repository with an affected vulnerability.
+"""
+type RepositoryVulnerabilityAlert implements Node & RepositoryNode {
"""
- A list of issues that have been opened in the repository.
+ When was the alert created?
"""
- issues(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Filtering options for issues returned from the connection.
- """
- filterBy: IssueFilters
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- A list of label names to filter the pull requests by.
- """
- labels: [String!]
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for issues returned from the connection.
- """
- orderBy: IssueOrder
-
- """
- A list of states to filter the issues by.
- """
- states: [IssueState!]
- ): IssueConnection!
+ createdAt: DateTime!
"""
- Returns a single label by name
+ The reason the alert was dismissed
"""
- label(
- """
- Label name
- """
- name: String!
- ): Label
+ dismissReason: String
"""
- A list of labels associated with the repository.
+ When was the alert dimissed?
"""
- labels(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- If provided, searches labels by name and description.
- """
- query: String
- ): LabelConnection
+ dismissedAt: DateTime
"""
- A list containing a breakdown of the language composition of the repository.
+ The user who dismissed the alert
"""
- languages(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Order for connection
- """
- orderBy: LanguageOrder
- ): LanguageConnection
+ dismisser: User
+ id: ID!
"""
- The license associated with the repository
+ The associated repository
"""
- licenseInfo: License
+ repository: Repository!
"""
- The reason the repository has been locked.
+ The associated security advisory
"""
- lockReason: RepositoryLockReason
+ securityAdvisory: SecurityAdvisory
"""
- A list of Users that can be mentioned in the context of the repository.
+ The associated security vulnerablity
"""
- mentionableUsers(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): UserConnection!
+ securityVulnerability: SecurityVulnerability
"""
- Whether or not PRs are merged with a merge commit on this repository.
+ The vulnerable manifest filename
"""
- mergeCommitAllowed: Boolean!
+ vulnerableManifestFilename: String!
"""
- Returns a single milestone from the current repository by number.
+ The vulnerable manifest path
"""
- milestone(
- """
- The number for the milestone to be returned.
- """
- number: Int!
- ): Milestone
+ vulnerableManifestPath: String!
"""
- A list of milestones associated with the repository.
+ The vulnerable requirements
"""
- milestones(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for milestones.
- """
- orderBy: MilestoneOrder
-
- """
- Filter by the state of the milestones.
- """
- states: [MilestoneState!]
- ): MilestoneConnection
+ vulnerableRequirements: String
+}
+"""
+The connection type for RepositoryVulnerabilityAlert.
+"""
+type RepositoryVulnerabilityAlertConnection {
"""
- The repository's original mirror URL.
+ A list of edges.
"""
- mirrorUrl: URI
+ edges: [RepositoryVulnerabilityAlertEdge]
"""
- The name of the repository.
+ A list of nodes.
"""
- name: String!
+ nodes: [RepositoryVulnerabilityAlert]
"""
- The repository's name with owner.
+ Information to aid in pagination.
"""
- nameWithOwner: String!
+ pageInfo: PageInfo!
"""
- A Git object in the repository
+ Identifies the total count of items in the connection.
"""
- object(
- """
- A Git revision expression suitable for rev-parse
- """
- expression: String
-
- """
- The Git object ID
- """
- oid: GitObjectID
- ): GitObject
+ totalCount: Int!
+}
+"""
+An edge in a connection.
+"""
+type RepositoryVulnerabilityAlertEdge {
"""
- The image used to represent this repository in Open Graph data.
+ A cursor for use in pagination.
"""
- openGraphImageUrl: URI!
+ cursor: String!
"""
- The User owner of the repository.
+ The item at the end of the edge.
"""
- owner: RepositoryOwner!
+ node: RepositoryVulnerabilityAlert
+}
+"""
+Autogenerated input type of RequestReviews
+"""
+input RequestReviewsInput {
"""
- The repository parent, if this is a fork.
+ A unique identifier for the client performing the mutation.
"""
- parent: Repository
+ clientMutationId: String
"""
- A list of pinned issues for this repository.
+ The Node ID of the pull request to modify.
"""
- pinnedIssues(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
+ pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"])
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
+ """
+ The Node IDs of the team to request.
+ """
+ teamIds: [ID!] @possibleTypes(concreteTypes: ["Team"])
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): PinnedIssueConnection @preview(toggledBy: "elektra-preview")
+ """
+ Add users to the set rather than replace.
+ """
+ union: Boolean
"""
- The primary language of the repository's code.
+ The Node IDs of the user to request.
"""
- primaryLanguage: Language
+ userIds: [ID!] @possibleTypes(concreteTypes: ["User"])
+}
+"""
+Autogenerated return type of RequestReviews
+"""
+type RequestReviewsPayload {
"""
- Find project by number.
+ Identifies the actor who performed the event.
"""
- project(
- """
- The project number to find.
- """
- number: Int!
- ): Project
+ actor: Actor
"""
- A list of projects under the owner.
+ A unique identifier for the client performing the mutation.
"""
- projects(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
+ clientMutationId: String
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
+ """
+ The pull request that is getting requests.
+ """
+ pullRequest: PullRequest
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
+ """
+ The edge from the pull request to the requested reviewers.
+ """
+ requestedReviewersEdge: UserEdge
+}
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
+"""
+The possible states that can be requested when creating a check run.
+"""
+enum RequestableCheckStatusState {
+ """
+ The check suite or run has been completed.
+ """
+ COMPLETED
- """
- Ordering options for projects returned from the connection
- """
- orderBy: ProjectOrder
+ """
+ The check suite or run is in progress.
+ """
+ IN_PROGRESS
- """
- Query to search projects by, currently only searching by name.
- """
- search: String
+ """
+ The check suite or run has been queued.
+ """
+ QUEUED
+}
- """
- A list of states to filter the projects by.
- """
- states: [ProjectState!]
- ): ProjectConnection!
+"""
+Types that can be requested reviewers.
+"""
+union RequestedReviewer = Mannequin | Team | User
+"""
+Autogenerated input type of RerequestCheckSuite
+"""
+input RerequestCheckSuiteInput {
"""
- The HTTP path listing the repository's projects
+ The Node ID of the check suite.
"""
- projectsResourcePath: URI!
+ checkSuiteId: ID! @possibleTypes(concreteTypes: ["CheckSuite"])
"""
- The HTTP URL listing the repository's projects
+ A unique identifier for the client performing the mutation.
"""
- projectsUrl: URI!
+ clientMutationId: String
"""
- Returns a single pull request from the current repository by number.
+ The Node ID of the repository.
"""
- pullRequest(
- """
- The number for the pull request to be returned.
- """
- number: Int!
- ): PullRequest
+ repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
+}
+"""
+Autogenerated return type of RerequestCheckSuite
+"""
+type RerequestCheckSuitePayload {
"""
- A list of pull requests that have been opened in the repository.
+ The requested check suite.
"""
- pullRequests(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- The base ref name to filter the pull requests by.
- """
- baseRefName: String
+ checkSuite: CheckSuite
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
+ """
+ A unique identifier for the client performing the mutation.
+ """
+ clientMutationId: String
+}
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
+"""
+Autogenerated input type of ResolveReviewThread
+"""
+input ResolveReviewThreadInput {
+ """
+ A unique identifier for the client performing the mutation.
+ """
+ clientMutationId: String
- """
- The head ref name to filter the pull requests by.
- """
- headRefName: String
+ """
+ The ID of the thread to resolve
+ """
+ threadId: ID! @possibleTypes(concreteTypes: ["PullRequestReviewThread"])
+}
- """
- A list of label names to filter the pull requests by.
- """
- labels: [String!]
+"""
+Autogenerated return type of ResolveReviewThread
+"""
+type ResolveReviewThreadPayload {
+ """
+ A unique identifier for the client performing the mutation.
+ """
+ clientMutationId: String
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
+ """
+ The thread to resolve.
+ """
+ thread: PullRequestReviewThread
+}
- """
- Ordering options for pull requests returned from the connection.
- """
- orderBy: IssueOrder
+"""
+Represents a private contribution a user made on GitHub.
+"""
+type RestrictedContribution implements Contribution {
+ """
+ Whether this contribution is associated with a record you do not have access to. For
+ example, your own 'first issue' contribution may have been made on a repository you can no
+ longer access.
+ """
+ isRestricted: Boolean!
- """
- A list of states to filter the pull requests by.
- """
- states: [PullRequestState!]
- ): PullRequestConnection!
+ """
+ When this contribution was made.
+ """
+ occurredAt: DateTime!
"""
- Identifies when the repository was last pushed to.
+ The HTTP path for this contribution.
"""
- pushedAt: DateTime
+ resourcePath: URI!
"""
- Whether or not rebase-merging is enabled on this repository.
+ The HTTP URL for this contribution.
"""
- rebaseMergeAllowed: Boolean!
+ url: URI!
"""
- Fetch a given ref from the repository
+ The user who made this contribution.
"""
- ref(
- """
- The ref to retrieve. Fully qualified matches are checked in order
- (`refs/heads/master`) before falling back onto checks for short name matches (`master`).
- """
- qualifiedName: String!
- ): Ref
+ user: User!
+}
+"""
+A team or user who has the ability to dismiss a review on a protected branch.
+"""
+type ReviewDismissalAllowance implements Node {
"""
- Fetch a list of refs from the repository
+ The actor that can dismiss.
"""
- refs(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
+ actor: ReviewDismissalAllowanceActor
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
+ """
+ Identifies the branch protection rule associated with the allowed user or team.
+ """
+ branchProtectionRule: BranchProtectionRule
+ id: ID!
+}
- """
- DEPRECATED: use orderBy. The ordering direction.
- """
- direction: OrderDirection
+"""
+Types that can be an actor.
+"""
+union ReviewDismissalAllowanceActor = Team | User
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
+"""
+The connection type for ReviewDismissalAllowance.
+"""
+type ReviewDismissalAllowanceConnection {
+ """
+ A list of edges.
+ """
+ edges: [ReviewDismissalAllowanceEdge]
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
+ """
+ A list of nodes.
+ """
+ nodes: [ReviewDismissalAllowance]
- """
- Ordering options for refs returned from the connection.
- """
- orderBy: RefOrder
+ """
+ Information to aid in pagination.
+ """
+ pageInfo: PageInfo!
- """
- A ref name prefix like `refs/heads/`, `refs/tags/`, etc.
- """
- refPrefix: String!
- ): RefConnection
+ """
+ Identifies the total count of items in the connection.
+ """
+ totalCount: Int!
+}
+"""
+An edge in a connection.
+"""
+type ReviewDismissalAllowanceEdge {
"""
- Lookup a single release given various criteria.
+ A cursor for use in pagination.
"""
- release(
- """
- The name of the Tag the Release was created from
- """
- tagName: String!
- ): Release
+ cursor: String!
"""
- List of releases which are dependent on this repository.
+ The item at the end of the edge.
"""
- releases(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
+ node: ReviewDismissalAllowance
+}
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
+"""
+Represents a 'review_dismissed' event on a given issue or pull request.
+"""
+type ReviewDismissedEvent implements Node & UniformResourceLocatable {
+ """
+ Identifies the actor who performed the event.
+ """
+ actor: Actor
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
+ """
+ Identifies the date and time when the object was created.
+ """
+ createdAt: DateTime!
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
+ """
+ Identifies the primary key from the database.
+ """
+ databaseId: Int
- """
- Order for connection
- """
- orderBy: ReleaseOrder
- ): ReleaseConnection!
+ """
+ Identifies the optional message associated with the 'review_dismissed' event.
+ """
+ dismissalMessage: String
"""
- A list of applied repository-topic associations for this repository.
+ Identifies the optional message associated with the event, rendered to HTML.
"""
- repositoryTopics(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
+ dismissalMessageHTML: String
+ id: ID!
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
+ """
+ Identifies the previous state of the review with the 'review_dismissed' event.
+ """
+ previousReviewState: PullRequestReviewState!
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
+ """
+ PullRequest referenced by event.
+ """
+ pullRequest: PullRequest!
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): RepositoryTopicConnection!
+ """
+ Identifies the commit which caused the review to become stale.
+ """
+ pullRequestCommit: PullRequestCommit
"""
- The HTTP path for this repository
+ The HTTP path for this review dismissed event.
"""
resourcePath: URI!
"""
- A description of the repository, rendered to HTML without any links in it.
+ Identifies the review associated with the 'review_dismissed' event.
"""
- shortDescriptionHTML(
- """
- How many characters to return.
- """
- limit: Int = 200
- ): HTML!
+ review: PullRequestReview
"""
- Whether or not squash-merging is enabled on this repository.
+ The HTTP URL for this review dismissed event.
"""
- squashMergeAllowed: Boolean!
+ url: URI!
+}
+"""
+A request for a user to review a pull request.
+"""
+type ReviewRequest implements Node {
"""
- The SSH URL to clone this repository
+ Whether this request was created for a code owner
"""
- sshUrl: GitSSHRemote!
+ asCodeOwner: Boolean!
"""
- A list of users who have starred this starrable.
+ Identifies the primary key from the database.
"""
- stargazers(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
+ databaseId: Int
+ id: ID!
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
+ """
+ Identifies the pull request associated with this review request.
+ """
+ pullRequest: PullRequest!
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
+ """
+ The reviewer that is requested.
+ """
+ requestedReviewer: RequestedReviewer
+}
- """
- Order for connection
- """
- orderBy: StarOrder
- ): StargazerConnection!
+"""
+The connection type for ReviewRequest.
+"""
+type ReviewRequestConnection {
+ """
+ A list of edges.
+ """
+ edges: [ReviewRequestEdge]
"""
- Temporary authentication token for cloning this repository.
+ A list of nodes.
"""
- tempCloneToken: String @preview(toggledBy: "daredevil-preview")
+ nodes: [ReviewRequest]
"""
- The repository from which this repository was generated, if any.
+ Information to aid in pagination.
"""
- templateRepository: Repository
+ pageInfo: PageInfo!
"""
- Identifies the date and time when the object was last updated.
+ Identifies the total count of items in the connection.
"""
- updatedAt: DateTime!
+ totalCount: Int!
+}
+"""
+An edge in a connection.
+"""
+type ReviewRequestEdge {
"""
- The HTTP URL for this repository
+ A cursor for use in pagination.
"""
- url: URI!
+ cursor: String!
"""
- Whether this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar.
+ The item at the end of the edge.
"""
- usesCustomOpenGraphImage: Boolean!
+ node: ReviewRequest
+}
+"""
+Represents an 'review_request_removed' event on a given pull request.
+"""
+type ReviewRequestRemovedEvent implements Node {
"""
- Indicates whether the viewer has admin permissions on this repository.
+ Identifies the actor who performed the event.
"""
- viewerCanAdminister: Boolean!
+ actor: Actor
"""
- Can the current viewer create new projects on this owner.
+ Identifies the date and time when the object was created.
"""
- viewerCanCreateProjects: Boolean!
+ createdAt: DateTime!
+ id: ID!
"""
- Check if the viewer is able to change their subscription status for the repository.
+ PullRequest referenced by event.
"""
- viewerCanSubscribe: Boolean!
+ pullRequest: PullRequest!
"""
- Indicates whether the viewer can update the topics of this repository.
+ Identifies the reviewer whose review request was removed.
"""
- viewerCanUpdateTopics: Boolean!
+ requestedReviewer: RequestedReviewer
+}
+"""
+Represents an 'review_requested' event on a given pull request.
+"""
+type ReviewRequestedEvent implements Node {
"""
- Returns a boolean indicating whether the viewing user has starred this starrable.
+ Identifies the actor who performed the event.
"""
- viewerHasStarred: Boolean!
+ actor: Actor
"""
- The users permission level on the repository. Will return null if authenticated as an GitHub App.
+ Identifies the date and time when the object was created.
"""
- viewerPermission: RepositoryPermission
+ createdAt: DateTime!
+ id: ID!
"""
- Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
+ PullRequest referenced by event.
"""
- viewerSubscription: SubscriptionState
+ pullRequest: PullRequest!
"""
- A list of vulnerability alerts that are on this repository.
+ Identifies the reviewer whose review was requested.
"""
- vulnerabilityAlerts(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
+ requestedReviewer: RequestedReviewer
+}
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
+"""
+A hovercard context with a message describing the current code review state of the pull
+request.
+"""
+type ReviewStatusHovercardContext implements HovercardContext {
+ """
+ A string describing this context
+ """
+ message: String!
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
+ """
+ An octicon to accompany this context
+ """
+ octicon: String!
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): RepositoryVulnerabilityAlertConnection @preview(toggledBy: "vixen-preview")
+ """
+ The current status of the pull request with respect to code review.
+ """
+ reviewDecision: PullRequestReviewDecision
+}
+"""
+The possible digest algorithms used to sign SAML requests for an identity provider.
+"""
+enum SamlDigestAlgorithm {
"""
- A list of users watching the repository.
+ SHA1
"""
- watchers(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
+ SHA1
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
+ """
+ SHA256
+ """
+ SHA256
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
+ """
+ SHA384
+ """
+ SHA384
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): UserConnection!
+ """
+ SHA512
+ """
+ SHA512
}
"""
-The affiliation of a user to a repository
+The possible signature algorithms used to sign SAML requests for a Identity Provider.
"""
-enum RepositoryAffiliation {
+enum SamlSignatureAlgorithm {
"""
- Repositories that the user has been added to as a collaborator.
+ RSA-SHA1
"""
- COLLABORATOR
+ RSA_SHA1
"""
- Repositories that the user has access to through being a member of an
- organization. This includes every repository on every team that the user is on.
+ RSA-SHA256
"""
- ORGANIZATION_MEMBER
+ RSA_SHA256
"""
- Repositories that are owned by the authenticated user.
+ RSA-SHA384
"""
- OWNER
+ RSA_SHA384
+
+ """
+ RSA-SHA512
+ """
+ RSA_SHA512
}
"""
-Metadata for an audit entry with action repo.*
+A Saved Reply is text a user can use to reply quickly.
"""
-interface RepositoryAuditEntryData @preview(toggledBy: "audit-log-preview") {
+type SavedReply implements Node {
"""
- The repository associated with the action
+ The body of the saved reply.
"""
- repository: Repository
+ body: String!
"""
- The name of the repository
+ The saved reply body rendered to HTML.
"""
- repositoryName: String
+ bodyHTML: HTML!
"""
- The HTTP path for the repository
+ Identifies the primary key from the database.
"""
- repositoryResourcePath: URI
+ databaseId: Int
+ id: ID!
"""
- The HTTP URL for the repository
+ The title of the saved reply.
"""
- repositoryUrl: URI
+ title: String!
+
+ """
+ The user that saved this reply.
+ """
+ user: Actor
}
"""
-The connection type for User.
+The connection type for SavedReply.
"""
-type RepositoryCollaboratorConnection {
+type SavedReplyConnection {
"""
A list of edges.
"""
- edges: [RepositoryCollaboratorEdge]
+ edges: [SavedReplyEdge]
"""
A list of nodes.
"""
- nodes: [User]
+ nodes: [SavedReply]
"""
Information to aid in pagination.
@@ -22081,384 +29368,526 @@ type RepositoryCollaboratorConnection {
}
"""
-Represents a user who is a collaborator of a repository.
+An edge in a connection.
"""
-type RepositoryCollaboratorEdge {
+type SavedReplyEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
- node: User!
"""
- The permission the user has on the repository.
+ The item at the end of the edge.
"""
- permission: RepositoryPermission!
+ node: SavedReply
+}
+
+"""
+Ordering options for saved reply connections.
+"""
+input SavedReplyOrder {
+ """
+ The ordering direction.
+ """
+ direction: OrderDirection!
"""
- A list of sources for the user's access to the repository.
+ The field to order saved replies by.
"""
- permissionSources: [PermissionSource!]
+ field: SavedReplyOrderField!
}
"""
-A list of repositories owned by the subject.
+Properties by which saved reply connections can be ordered.
"""
-type RepositoryConnection {
+enum SavedReplyOrderField {
+ """
+ Order saved reply by when they were updated.
+ """
+ UPDATED_AT
+}
+
+"""
+The results of a search.
+"""
+union SearchResultItem = App | Issue | Organization | PullRequest | Repository | User
+
+"""
+A list of results that matched against a search query.
+"""
+type SearchResultItemConnection {
+ """
+ The number of pieces of code that matched the search query.
+ """
+ codeCount: Int!
+
"""
A list of edges.
"""
- edges: [RepositoryEdge]
+ edges: [SearchResultItemEdge]
+
+ """
+ The number of issues that matched the search query.
+ """
+ issueCount: Int!
"""
A list of nodes.
"""
- nodes: [Repository]
+ nodes: [SearchResultItem]
+
+ """
+ Information to aid in pagination.
+ """
+ pageInfo: PageInfo!
+
+ """
+ The number of repositories that matched the search query.
+ """
+ repositoryCount: Int!
"""
- Information to aid in pagination.
+ The number of users that matched the search query.
+ """
+ userCount: Int!
+
+ """
+ The number of wiki pages that matched the search query.
+ """
+ wikiCount: Int!
+}
+
+"""
+An edge in a connection.
+"""
+type SearchResultItemEdge {
+ """
+ A cursor for use in pagination.
+ """
+ cursor: String!
+
+ """
+ The item at the end of the edge.
+ """
+ node: SearchResultItem
+
+ """
+ Text matches on the result found.
+ """
+ textMatches: [TextMatch]
+}
+
+"""
+Represents the individual results of a search.
+"""
+enum SearchType {
+ """
+ Returns results matching issues in repositories.
"""
- pageInfo: PageInfo!
+ ISSUE
"""
- Identifies the total count of items in the connection.
+ Returns results matching repositories.
"""
- totalCount: Int!
+ REPOSITORY
"""
- The total size in kilobytes of all repositories in the connection.
+ Returns results matching users and organizations on GitHub.
"""
- totalDiskUsage: Int!
+ USER
}
"""
-The reason a repository is listed as 'contributed'.
+A GitHub Security Advisory
"""
-enum RepositoryContributionType {
+type SecurityAdvisory implements Node {
"""
- Created a commit
+ Identifies the primary key from the database.
"""
- COMMIT
+ databaseId: Int
"""
- Created an issue
+ This is a long plaintext description of the advisory
"""
- ISSUE
+ description: String!
"""
- Created a pull request
+ The GitHub Security Advisory ID
"""
- PULL_REQUEST
+ ghsaId: String!
+ id: ID!
"""
- Reviewed a pull request
+ A list of identifiers for this advisory
"""
- PULL_REQUEST_REVIEW
+ identifiers: [SecurityAdvisoryIdentifier!]!
"""
- Created the repository
+ The organization that originated the advisory
"""
- REPOSITORY
-}
+ origin: String!
-"""
-An edge in a connection.
-"""
-type RepositoryEdge {
"""
- A cursor for use in pagination.
+ The permalink for the advisory
"""
- cursor: String!
+ permalink: URI
"""
- The item at the end of the edge.
+ When the advisory was published
"""
- node: Repository
-}
+ publishedAt: DateTime!
-"""
-A subset of repository info.
-"""
-interface RepositoryInfo {
"""
- Identifies the date and time when the object was created.
+ A list of references for this advisory
"""
- createdAt: DateTime!
+ references: [SecurityAdvisoryReference!]!
"""
- The description of the repository.
+ The severity of the advisory
"""
- description: String
+ severity: SecurityAdvisorySeverity!
"""
- The description of the repository rendered to HTML.
+ A short plaintext summary of the advisory
"""
- descriptionHTML: HTML!
+ summary: String!
"""
- Returns how many forks there are of this repository in the whole network.
+ When the advisory was last updated
"""
- forkCount: Int!
+ updatedAt: DateTime!
"""
- Indicates if the repository has anonymous Git read access feature enabled.
+ Vulnerabilities associated with this Advisory
"""
- hasAnonymousAccessEnabled: Boolean!
+ vulnerabilities(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ An ecosystem to filter vulnerabilities by.
+ """
+ ecosystem: SecurityAdvisoryEcosystem
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ A package name to filter vulnerabilities by.
+ """
+ package: String
+
+ """
+ A list of severities to filter vulnerabilities by.
+ """
+ severities: [SecurityAdvisorySeverity!]
+ ): SecurityVulnerabilityConnection!
"""
- Indicates if the repository has issues feature enabled.
+ When the advisory was withdrawn, if it has been withdrawn
"""
- hasIssuesEnabled: Boolean!
+ withdrawnAt: DateTime
+}
+"""
+The connection type for SecurityAdvisory.
+"""
+type SecurityAdvisoryConnection {
"""
- Indicates if the repository has wiki feature enabled.
+ A list of edges.
"""
- hasWikiEnabled: Boolean!
+ edges: [SecurityAdvisoryEdge]
"""
- The repository's URL.
+ A list of nodes.
"""
- homepageUrl: URI
+ nodes: [SecurityAdvisory]
"""
- Indicates if the repository is unmaintained.
+ Information to aid in pagination.
"""
- isArchived: Boolean!
+ pageInfo: PageInfo!
"""
- Identifies if the repository is a fork.
+ Identifies the total count of items in the connection.
"""
- isFork: Boolean!
+ totalCount: Int!
+}
+"""
+The possible ecosystems of a security vulnerability's package.
+"""
+enum SecurityAdvisoryEcosystem {
"""
- Indicates if the repository has been locked or not.
+ PHP packages hosted at packagist.org
"""
- isLocked: Boolean!
+ COMPOSER
"""
- Identifies if the repository is a mirror.
+ Java artifacts hosted at the Maven central repository
"""
- isMirror: Boolean!
+ MAVEN
"""
- Identifies if the repository is private.
+ JavaScript packages hosted at npmjs.com
"""
- isPrivate: Boolean!
+ NPM
"""
- Identifies if the repository is a template that can be used to generate new repositories.
+ .NET packages hosted at the NuGet Gallery
"""
- isTemplate: Boolean!
+ NUGET
"""
- The license associated with the repository
+ Python packages hosted at PyPI.org
"""
- licenseInfo: License
+ PIP
"""
- The reason the repository has been locked.
+ Ruby gems hosted at RubyGems.org
"""
- lockReason: RepositoryLockReason
+ RUBYGEMS
+}
+"""
+An edge in a connection.
+"""
+type SecurityAdvisoryEdge {
"""
- The repository's original mirror URL.
+ A cursor for use in pagination.
"""
- mirrorUrl: URI
+ cursor: String!
"""
- The name of the repository.
+ The item at the end of the edge.
"""
- name: String!
+ node: SecurityAdvisory
+}
+"""
+A GitHub Security Advisory Identifier
+"""
+type SecurityAdvisoryIdentifier {
"""
- The repository's name with owner.
+ The identifier type, e.g. GHSA, CVE
"""
- nameWithOwner: String!
+ type: String!
"""
- The image used to represent this repository in Open Graph data.
+ The identifier
"""
- openGraphImageUrl: URI!
+ value: String!
+}
+
+"""
+An individual package
+"""
+type SecurityAdvisoryPackage {
+ """
+ The ecosystem the package belongs to, e.g. RUBYGEMS, NPM
+ """
+ ecosystem: SecurityAdvisoryEcosystem!
"""
- The User owner of the repository.
+ The package name
"""
- owner: RepositoryOwner!
+ name: String!
+}
+"""
+An individual package version
+"""
+type SecurityAdvisoryPackageVersion {
"""
- Identifies when the repository was last pushed to.
+ The package name or version
"""
- pushedAt: DateTime
+ identifier: String!
+}
+"""
+A GitHub Security Advisory Reference
+"""
+type SecurityAdvisoryReference {
"""
- The HTTP path for this repository
+ A publicly accessible reference
"""
- resourcePath: URI!
+ url: URI!
+}
+"""
+Severity of the vulnerability.
+"""
+enum SecurityAdvisorySeverity {
"""
- A description of the repository, rendered to HTML without any links in it.
+ Critical.
"""
- shortDescriptionHTML(
- """
- How many characters to return.
- """
- limit: Int = 200
- ): HTML!
+ CRITICAL
"""
- Identifies the date and time when the object was last updated.
+ High.
"""
- updatedAt: DateTime!
+ HIGH
"""
- The HTTP URL for this repository
+ Low.
"""
- url: URI!
+ LOW
"""
- Whether this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar.
+ Moderate.
"""
- usesCustomOpenGraphImage: Boolean!
+ MODERATE
}
"""
-An invitation for a user to be added to a repository.
+An individual vulnerability within an Advisory
"""
-type RepositoryInvitation implements Node {
- id: ID!
+type SecurityVulnerability {
+ """
+ The Advisory associated with this Vulnerability
+ """
+ advisory: SecurityAdvisory!
"""
- The user who received the invitation.
+ The first version containing a fix for the vulnerability
"""
- invitee: User!
+ firstPatchedVersion: SecurityAdvisoryPackageVersion
"""
- The user who created the invitation.
+ A description of the vulnerable package
"""
- inviter: User!
+ package: SecurityAdvisoryPackage!
"""
- The permission granted on this repository by this invitation.
+ The severity of the vulnerability within this package
"""
- permission: RepositoryPermission!
+ severity: SecurityAdvisorySeverity!
"""
- The Repository the user is invited to.
+ When the vulnerability was last updated
"""
- repository: RepositoryInfo
+ updatedAt: DateTime!
+
+ """
+ A string that describes the vulnerable package versions.
+ This string follows a basic syntax with a few forms.
+ + `= 0.2.0` denotes a single vulnerable version.
+ + `<= 1.0.8` denotes a version range up to and including the specified version
+ + `< 0.1.11` denotes a version range up to, but excluding, the specified version
+ + `>= 4.3.0, < 4.3.5` denotes a version range with a known minimum and maximum version.
+ + `>= 0.0.1` denotes a version range with a known minimum, but no known maximum
+ """
+ vulnerableVersionRange: String!
}
"""
-The possible reasons a given repository could be in a locked state.
+The connection type for SecurityVulnerability.
"""
-enum RepositoryLockReason {
+type SecurityVulnerabilityConnection {
"""
- The repository is locked due to a billing related reason.
+ A list of edges.
"""
- BILLING
+ edges: [SecurityVulnerabilityEdge]
"""
- The repository is locked due to a migration.
+ A list of nodes.
"""
- MIGRATING
+ nodes: [SecurityVulnerability]
"""
- The repository is locked due to a move.
+ Information to aid in pagination.
"""
- MOVING
+ pageInfo: PageInfo!
"""
- The repository is locked due to a rename.
+ Identifies the total count of items in the connection.
"""
- RENAME
+ totalCount: Int!
}
"""
-Represents a object that belongs to a repository.
+An edge in a connection.
"""
-interface RepositoryNode {
+type SecurityVulnerabilityEdge {
"""
- The repository associated with this node.
+ A cursor for use in pagination.
"""
- repository: Repository!
+ cursor: String!
+
+ """
+ The item at the end of the edge.
+ """
+ node: SecurityVulnerability
}
"""
-Ordering options for repository connections
+Represents an S/MIME signature on a Commit or Tag.
"""
-input RepositoryOrder {
+type SmimeSignature implements GitSignature {
"""
- The ordering direction.
+ Email used to sign this object.
"""
- direction: OrderDirection!
+ email: String!
"""
- The field to order repositories by.
+ True if the signature is valid and verified by GitHub.
"""
- field: RepositoryOrderField!
-}
+ isValid: Boolean!
-"""
-Properties by which repository connections can be ordered.
-"""
-enum RepositoryOrderField {
"""
- Order repositories by creation time
+ Payload for GPG signing object. Raw ODB object without the signature header.
"""
- CREATED_AT
+ payload: String!
"""
- Order repositories by name
+ ASCII-armored signature header from object.
"""
- NAME
+ signature: String!
"""
- Order repositories by push time
+ GitHub user corresponding to the email signing this commit.
"""
- PUSHED_AT
+ signer: User
"""
- Order repositories by number of stargazers
+ The state of this signature. `VALID` if signature is valid and verified by
+ GitHub, otherwise represents reason why signature is considered invalid.
"""
- STARGAZERS
+ state: GitSignatureState!
"""
- Order repositories by update time
+ True if the signature was made with GitHub's signing key.
"""
- UPDATED_AT
+ wasSignedByGitHub: Boolean!
}
"""
-Represents an owner of a Repository.
+Entites that can sponsor others via GitHub Sponsors
"""
-interface RepositoryOwner {
- """
- A URL pointing to the owner's public avatar.
- """
- avatarUrl(
- """
- The size of the resulting square image.
- """
- size: Int
- ): URI!
- id: ID!
-
- """
- The username used to login.
- """
- login: String!
+union Sponsor = Organization | User
+"""
+Entities that can be sponsored through GitHub Sponsors
+"""
+interface Sponsorable {
"""
- A list of repositories this user has pinned to their profile
+ This object's sponsorships as the maintainer.
"""
- pinnedRepositories(
- """
- Array of viewer's affiliation options for repositories returned from the
- connection. For example, OWNER will include only repositories that the
- current viewer owns.
- """
- affiliations: [RepositoryAffiliation]
-
+ sponsorshipsAsMaintainer(
"""
Returns the elements in the list that come after the specified cursor.
"""
@@ -22475,9 +29904,9 @@ interface RepositoryOwner {
first: Int
"""
- If non-null, filters repositories according to whether they have been locked
+ Whether or not to include private sponsorships in the result set
"""
- isLocked: Boolean
+ includePrivate: Boolean = false
"""
Returns the last _n_ elements from the list.
@@ -22485,34 +29914,16 @@ interface RepositoryOwner {
last: Int
"""
- Ordering options for repositories returned from the connection
- """
- orderBy: RepositoryOrder
-
- """
- Array of owner's affiliation options for repositories returned from the
- connection. For example, OWNER will include only repositories that the
- organization or user being viewed owns.
- """
- ownerAffiliations: [RepositoryAffiliation] = [OWNER, COLLABORATOR]
-
- """
- If non-null, filters repositories according to privacy
+ Ordering options for sponsorships returned from this connection. If left
+ blank, the sponsorships will be ordered based on relevancy to the viewer.
"""
- privacy: RepositoryPrivacy
- ): RepositoryConnection! @deprecated(reason: "pinnedRepositories will be removed Use ProfileOwner.pinnedItems instead. Removal on 2019-10-01 UTC.")
+ orderBy: SponsorshipOrder
+ ): SponsorshipConnection!
"""
- A list of repositories that the user owns.
+ This object's sponsorships as the sponsor.
"""
- repositories(
- """
- Array of viewer's affiliation options for repositories returned from the
- connection. For example, OWNER will include only repositories that the
- current viewer owns.
- """
- affiliations: [RepositoryAffiliation]
-
+ sponsorshipsAsSponsor(
"""
Returns the elements in the list that come after the specified cursor.
"""
@@ -22528,95 +29939,109 @@ interface RepositoryOwner {
"""
first: Int
- """
- If non-null, filters repositories according to whether they are forks of another repository
- """
- isFork: Boolean
-
- """
- If non-null, filters repositories according to whether they have been locked
- """
- isLocked: Boolean
-
"""
Returns the last _n_ elements from the list.
"""
last: Int
"""
- Ordering options for repositories returned from the connection
+ Ordering options for sponsorships returned from this connection. If left
+ blank, the sponsorships will be ordered based on relevancy to the viewer.
"""
- orderBy: RepositoryOrder
+ orderBy: SponsorshipOrder
+ ): SponsorshipConnection!
+}
- """
- Array of owner's affiliation options for repositories returned from the
- connection. For example, OWNER will include only repositories that the
- organization or user being viewed owns.
- """
- ownerAffiliations: [RepositoryAffiliation] = [OWNER, COLLABORATOR]
+"""
+A sponsorship relationship between a sponsor and a maintainer
+"""
+type Sponsorship implements Node {
+ """
+ Identifies the date and time when the object was created.
+ """
+ createdAt: DateTime!
+ id: ID!
- """
- If non-null, filters repositories according to privacy
- """
- privacy: RepositoryPrivacy
- ): RepositoryConnection!
+ """
+ The entity that is being sponsored
+ """
+ maintainer: User! @deprecated(reason: "`Sponsorship.maintainer` will be removed. Use `Sponsorship.sponsorable` instead. Removal on 2020-04-01 UTC.")
"""
- Find Repository.
+ The privacy level for this sponsorship.
"""
- repository(
- """
- Name of Repository to find.
- """
- name: String!
- ): Repository
+ privacyLevel: SponsorshipPrivacy!
"""
- The HTTP URL for the owner.
+ The user that is sponsoring. Returns null if the sponsorship is private or if sponsor is not a user.
"""
- resourcePath: URI!
+ sponsor: User @deprecated(reason: "`Sponsorship.sponsor` will be removed. Use `Sponsorship.sponsorEntity` instead. Removal on 2020-10-01 UTC.")
"""
- The HTTP URL for the owner.
+ The user or organization that is sponsoring. Returns null if the sponsorship is private.
"""
- url: URI!
+ sponsorEntity: Sponsor
+
+ """
+ The entity that is being sponsored
+ """
+ sponsorable: Sponsorable!
}
"""
-The access level to a repository
+The connection type for Sponsorship.
"""
-enum RepositoryPermission {
+type SponsorshipConnection {
"""
- Can read, clone, and push to this repository. Can also manage issues, pull
- requests, and repository settings, including adding collaborators
+ A list of edges.
"""
- ADMIN
+ edges: [SponsorshipEdge]
"""
- Can read, clone, and push to this repository. They can also manage issues, pull requests, and some repository settings
+ A list of nodes.
"""
- MAINTAIN
+ nodes: [Sponsorship]
"""
- Can read and clone this repository. Can also open and comment on issues and pull requests
+ Information to aid in pagination.
"""
- READ
+ pageInfo: PageInfo!
"""
- Can read and clone this repository. Can also manage issues and pull requests
+ Identifies the total count of items in the connection.
"""
- TRIAGE
+ totalCount: Int!
+}
+
+"""
+An edge in a connection.
+"""
+type SponsorshipEdge {
+ """
+ A cursor for use in pagination.
+ """
+ cursor: String!
"""
- Can read, clone, and push to this repository. Can also manage issues and pull requests
+ The item at the end of the edge.
"""
- WRITE
+ node: Sponsorship
}
"""
-The privacy of a repository
+Ordering options for sponsorship connections.
"""
-enum RepositoryPrivacy {
+input SponsorshipOrder {
+ """
+ The ordering direction.
+ """
+ direction: OrderDirection!
+}
+
+"""
+The privacy of a sponsorship
+"""
+enum SponsorshipPrivacy {
"""
Private
"""
@@ -22629,40 +30054,43 @@ enum RepositoryPrivacy {
}
"""
-A repository-topic connects a repository to a topic.
+Ways in which star connections can be ordered.
"""
-type RepositoryTopic implements Node & UniformResourceLocatable {
- id: ID!
-
+input StarOrder {
"""
- The HTTP path for this repository-topic.
+ The direction in which to order nodes.
"""
- resourcePath: URI!
+ direction: OrderDirection!
"""
- The topic.
+ The field in which to order nodes by.
"""
- topic: Topic!
+ field: StarOrderField!
+}
+"""
+Properties by which star connections can be ordered.
+"""
+enum StarOrderField {
"""
- The HTTP URL for this repository-topic.
+ Allows ordering a list of stars by when they were created.
"""
- url: URI!
+ STARRED_AT
}
"""
-The connection type for RepositoryTopic.
+The connection type for User.
"""
-type RepositoryTopicConnection {
+type StargazerConnection {
"""
A list of edges.
"""
- edges: [RepositoryTopicEdge]
+ edges: [StargazerEdge]
"""
A list of nodes.
"""
- nodes: [RepositoryTopic]
+ nodes: [User]
"""
Information to aid in pagination.
@@ -22676,306 +30104,425 @@ type RepositoryTopicConnection {
}
"""
-An edge in a connection.
+Represents a user that's starred a repository.
"""
-type RepositoryTopicEdge {
+type StargazerEdge {
"""
A cursor for use in pagination.
"""
cursor: String!
+ node: User!
"""
- The item at the end of the edge.
+ Identifies when the item was starred.
"""
- node: RepositoryTopic
+ starredAt: DateTime!
}
"""
-The repository's visibility level.
+Things that can be starred.
"""
-enum RepositoryVisibility {
+interface Starrable {
+ id: ID!
+
"""
- The repository is visible only to users in the same business.
+ Returns a count of how many stargazers there are on this object
"""
- INTERNAL
+ stargazerCount: Int!
"""
- The repository is visible only to those with explicit access.
+ A list of users who have starred this starrable.
"""
- PRIVATE
+ stargazers(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Order for connection
+ """
+ orderBy: StarOrder
+ ): StargazerConnection!
"""
- The repository is visible to everyone.
+ Returns a boolean indicating whether the viewing user has starred this starrable.
"""
- PUBLIC
+ viewerHasStarred: Boolean!
}
"""
-Audit log entry for a repository_visibility_change.disable event.
+The connection type for Repository.
"""
-type RepositoryVisibilityChangeDisableAuditEntry implements AuditEntry & EnterpriseAuditEntryData & Node & OrganizationAuditEntryData @preview(toggledBy: "audit-log-preview") {
+type StarredRepositoryConnection {
"""
- The action name
+ A list of edges.
"""
- action: String!
+ edges: [StarredRepositoryEdge]
"""
- The user who initiated the action
+ Is the list of stars for this user truncated? This is true for users that have many stars.
"""
- actor: AuditEntryActor
+ isOverLimit: Boolean!
"""
- The IP address of the actor
+ A list of nodes.
"""
- actorIp: String
+ nodes: [Repository]
"""
- A readable representation of the actor's location
+ Information to aid in pagination.
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ pageInfo: PageInfo!
"""
- The username of the user who initiated the action
+ Identifies the total count of items in the connection.
"""
- actorLogin: String
+ totalCount: Int!
+}
+"""
+Represents a starred repository.
+"""
+type StarredRepositoryEdge {
"""
- The HTTP path for the actor.
+ A cursor for use in pagination.
"""
- actorResourcePath: URI
+ cursor: String!
+ node: Repository!
"""
- The HTTP URL for the actor.
+ Identifies when the item was starred.
"""
- actorUrl: URI
+ starredAt: DateTime!
+}
+"""
+Represents a commit status.
+"""
+type Status implements Node {
"""
- The time the action was initiated
+ A list of status contexts and check runs for this commit.
"""
- createdAt: PreciseDateTime!
+ combinedContexts(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): StatusCheckRollupContextConnection!
"""
- The HTTP path for this enterprise.
+ The commit this status is attached to.
"""
- enterpriseResourcePath: URI
+ commit: Commit
"""
- The slug of the enterprise.
+ Looks up an individual status context by context name.
"""
- enterpriseSlug: String
+ context(
+ """
+ The context name.
+ """
+ name: String!
+ ): StatusContext
"""
- The HTTP URL for this enterprise.
+ The individual status contexts for this commit.
"""
- enterpriseUrl: URI
+ contexts: [StatusContext!]!
id: ID!
"""
- The Organization associated with the Audit Entry.
+ The combined commit status.
"""
- organization: Organization
+ state: StatusState!
+}
+"""
+Represents the rollup for both the check runs and status for a commit.
+"""
+type StatusCheckRollup implements Node {
"""
- The name of the Organization.
+ The commit the status and check runs are attached to.
"""
- organizationName: String
+ commit: Commit
"""
- The HTTP path for the organization
+ A list of status contexts and check runs for this commit.
"""
- organizationResourcePath: URI
+ contexts(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): StatusCheckRollupContextConnection!
+ id: ID!
"""
- The HTTP URL for the organization
+ The combined status for the commit.
"""
- organizationUrl: URI
+ state: StatusState!
+}
+"""
+Types that can be inside a StatusCheckRollup context.
+"""
+union StatusCheckRollupContext = CheckRun | StatusContext
+
+"""
+The connection type for StatusCheckRollupContext.
+"""
+type StatusCheckRollupContextConnection {
"""
- The user affected by the action
+ A list of edges.
"""
- user: User
+ edges: [StatusCheckRollupContextEdge]
"""
- For actions involving two users, the actor is the initiator and the user is the affected user.
+ A list of nodes.
"""
- userLogin: String
+ nodes: [StatusCheckRollupContext]
"""
- The HTTP path for the user.
+ Information to aid in pagination.
"""
- userResourcePath: URI
+ pageInfo: PageInfo!
"""
- The HTTP URL for the user.
+ Identifies the total count of items in the connection.
"""
- userUrl: URI
+ totalCount: Int!
}
"""
-Audit log entry for a repository_visibility_change.enable event.
+An edge in a connection.
"""
-type RepositoryVisibilityChangeEnableAuditEntry implements AuditEntry & EnterpriseAuditEntryData & Node & OrganizationAuditEntryData @preview(toggledBy: "audit-log-preview") {
- """
- The action name
- """
- action: String!
-
+type StatusCheckRollupContextEdge {
"""
- The user who initiated the action
+ A cursor for use in pagination.
"""
- actor: AuditEntryActor
+ cursor: String!
"""
- The IP address of the actor
+ The item at the end of the edge.
"""
- actorIp: String
+ node: StatusCheckRollupContext
+}
+"""
+Represents an individual commit status context
+"""
+type StatusContext implements Node {
"""
- A readable representation of the actor's location
+ The avatar of the OAuth application or the user that created the status
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ avatarUrl(
+ """
+ The size of the resulting square image.
+ """
+ size: Int = 40
+ ): URI
"""
- The username of the user who initiated the action
+ This commit this status context is attached to.
"""
- actorLogin: String
+ commit: Commit
"""
- The HTTP path for the actor.
+ The name of this status context.
"""
- actorResourcePath: URI
+ context: String!
"""
- The HTTP URL for the actor.
+ Identifies the date and time when the object was created.
"""
- actorUrl: URI
+ createdAt: DateTime!
"""
- The time the action was initiated
+ The actor who created this status context.
"""
- createdAt: PreciseDateTime!
+ creator: Actor
"""
- The HTTP path for this enterprise.
+ The description for this status context.
"""
- enterpriseResourcePath: URI
+ description: String
+ id: ID!
"""
- The slug of the enterprise.
+ The state of this status context.
"""
- enterpriseSlug: String
+ state: StatusState!
"""
- The HTTP URL for this enterprise.
+ The URL for this status context.
"""
- enterpriseUrl: URI
- id: ID!
+ targetUrl: URI
+}
+"""
+The possible commit status states.
+"""
+enum StatusState {
"""
- The Organization associated with the Audit Entry.
+ Status is errored.
"""
- organization: Organization
+ ERROR
"""
- The name of the Organization.
+ Status is expected.
"""
- organizationName: String
+ EXPECTED
"""
- The HTTP path for the organization
+ Status is failing.
"""
- organizationResourcePath: URI
+ FAILURE
"""
- The HTTP URL for the organization
+ Status is pending.
"""
- organizationUrl: URI
+ PENDING
"""
- The user affected by the action
+ Status is successful.
"""
- user: User
+ SUCCESS
+}
+"""
+Autogenerated input type of SubmitPullRequestReview
+"""
+input SubmitPullRequestReviewInput {
"""
- For actions involving two users, the actor is the initiator and the user is the affected user.
+ The text field to set on the Pull Request Review.
"""
- userLogin: String
+ body: String
"""
- The HTTP path for the user.
+ A unique identifier for the client performing the mutation.
"""
- userResourcePath: URI
+ clientMutationId: String
"""
- The HTTP URL for the user.
+ The event to send to the Pull Request Review.
"""
- userUrl: URI
-}
+ event: PullRequestReviewEvent!
-"""
-A alert for a repository with an affected vulnerability.
-"""
-type RepositoryVulnerabilityAlert implements Node & RepositoryNode @preview(toggledBy: "vixen-preview") {
"""
- The reason the alert was dismissed
+ The Pull Request ID to submit any pending reviews.
"""
- dismissReason: String
+ pullRequestId: ID @possibleTypes(concreteTypes: ["PullRequest"])
"""
- When was the alert dimissed?
+ The Pull Request Review ID to submit.
"""
- dismissedAt: DateTime
+ pullRequestReviewId: ID @possibleTypes(concreteTypes: ["PullRequestReview"])
+}
+"""
+Autogenerated return type of SubmitPullRequestReview
+"""
+type SubmitPullRequestReviewPayload {
"""
- The user who dismissed the alert
+ A unique identifier for the client performing the mutation.
"""
- dismisser: User
- id: ID!
+ clientMutationId: String
"""
- The associated repository
+ The submitted pull request review.
"""
- repository: Repository!
+ pullRequestReview: PullRequestReview
+}
+"""
+A pointer to a repository at a specific revision embedded inside another repository.
+"""
+type Submodule {
"""
- The associated security advisory
+ The branch of the upstream submodule for tracking updates
"""
- securityAdvisory: SecurityAdvisory
+ branch: String
"""
- The associated security vulnerablity
+ The git URL of the submodule repository
"""
- securityVulnerability: SecurityVulnerability
+ gitUrl: URI!
"""
- The vulnerable manifest filename
+ The name of the submodule in .gitmodules
"""
- vulnerableManifestFilename: String!
+ name: String!
"""
- The vulnerable manifest path
+ The path in the superproject that this submodule is located in
"""
- vulnerableManifestPath: String!
+ path: String!
"""
- The vulnerable requirements
+ The commit revision of the subproject repository being tracked by the submodule
"""
- vulnerableRequirements: String
+ subprojectCommitOid: GitObjectID
}
"""
-The connection type for RepositoryVulnerabilityAlert.
+The connection type for Submodule.
"""
-type RepositoryVulnerabilityAlertConnection @preview(toggledBy: "vixen-preview") {
+type SubmoduleConnection {
"""
A list of edges.
"""
- edges: [RepositoryVulnerabilityAlertEdge]
+ edges: [SubmoduleEdge]
"""
A list of nodes.
"""
- nodes: [RepositoryVulnerabilityAlert]
+ nodes: [Submodule]
"""
Information to aid in pagination.
@@ -22991,7 +30538,7 @@ type RepositoryVulnerabilityAlertConnection @preview(toggledBy: "vixen-preview")
"""
An edge in a connection.
"""
-type RepositoryVulnerabilityAlertEdge @preview(toggledBy: "vixen-preview") {
+type SubmoduleEdge {
"""
A cursor for use in pagination.
"""
@@ -23000,250 +30547,221 @@ type RepositoryVulnerabilityAlertEdge @preview(toggledBy: "vixen-preview") {
"""
The item at the end of the edge.
"""
- node: RepositoryVulnerabilityAlert
+ node: Submodule
}
"""
-Autogenerated input type of RequestReviews
+Entities that can be subscribed to for web and email notifications.
"""
-input RequestReviewsInput {
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
- """
- The Node ID of the pull request to modify.
- """
- pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"])
-
- """
- The Node IDs of the team to request.
- """
- teamIds: [ID!] @possibleTypes(concreteTypes: ["Team"])
+interface Subscribable {
+ id: ID!
"""
- Add users to the set rather than replace.
+ Check if the viewer is able to change their subscription status for the repository.
"""
- union: Boolean
+ viewerCanSubscribe: Boolean!
"""
- The Node IDs of the user to request.
+ Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
"""
- userIds: [ID!] @possibleTypes(concreteTypes: ["User"])
+ viewerSubscription: SubscriptionState
}
"""
-Autogenerated return type of RequestReviews
+Represents a 'subscribed' event on a given `Subscribable`.
"""
-type RequestReviewsPayload {
+type SubscribedEvent implements Node {
"""
- A unique identifier for the client performing the mutation.
+ Identifies the actor who performed the event.
"""
- clientMutationId: String
+ actor: Actor
"""
- The pull request that is getting requests.
+ Identifies the date and time when the object was created.
"""
- pullRequest: PullRequest
+ createdAt: DateTime!
+ id: ID!
"""
- The edge from the pull request to the requested reviewers.
+ Object referenced by event.
"""
- requestedReviewersEdge: UserEdge
+ subscribable: Subscribable!
}
"""
-The possible states that can be requested when creating a check run.
+The possible states of a subscription.
"""
-enum RequestableCheckStatusState @preview(toggledBy: "antiope-preview") {
+enum SubscriptionState {
"""
- The check suite or run has been completed.
+ The User is never notified.
"""
- COMPLETED
+ IGNORED
"""
- The check suite or run is in progress.
+ The User is notified of all conversations.
"""
- IN_PROGRESS
+ SUBSCRIBED
"""
- The check suite or run has been queued.
+ The User is only notified when participating or @mentioned.
"""
- QUEUED
+ UNSUBSCRIBED
}
"""
-Types that can be requested reviewers.
-"""
-union RequestedReviewer = Mannequin | Team | User
-
-"""
-Autogenerated input type of RerequestCheckSuite
+A suggestion to review a pull request based on a user's commit history and review comments.
"""
-input RerequestCheckSuiteInput @preview(toggledBy: "antiope-preview") {
- """
- The Node ID of the check suite.
- """
- checkSuiteId: ID! @possibleTypes(concreteTypes: ["CheckSuite"])
-
- """
- A unique identifier for the client performing the mutation.
- """
- clientMutationId: String
-
+type SuggestedReviewer {
"""
- The Node ID of the repository.
+ Is this suggestion based on past commits?
"""
- repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
-}
+ isAuthor: Boolean!
-"""
-Autogenerated return type of RerequestCheckSuite
-"""
-type RerequestCheckSuitePayload @preview(toggledBy: "antiope-preview") {
"""
- The requested check suite.
+ Is this suggestion based on past review comments?
"""
- checkSuite: CheckSuite
+ isCommenter: Boolean!
"""
- A unique identifier for the client performing the mutation.
+ Identifies the user suggested to review the pull request.
"""
- clientMutationId: String
+ reviewer: User!
}
"""
-Autogenerated input type of ResolveReviewThread
+Represents a Git tag.
"""
-input ResolveReviewThreadInput {
+type Tag implements GitObject & Node {
"""
- A unique identifier for the client performing the mutation.
+ An abbreviated version of the Git object ID
"""
- clientMutationId: String
+ abbreviatedOid: String!
"""
- The ID of the thread to resolve
+ The HTTP path for this Git object
"""
- threadId: ID! @possibleTypes(concreteTypes: ["PullRequestReviewThread"])
-}
+ commitResourcePath: URI!
-"""
-Autogenerated return type of ResolveReviewThread
-"""
-type ResolveReviewThreadPayload {
"""
- A unique identifier for the client performing the mutation.
+ The HTTP URL for this Git object
"""
- clientMutationId: String
+ commitUrl: URI!
+ id: ID!
"""
- The thread to resolve.
+ The Git tag message.
"""
- thread: PullRequestReviewThread
-}
+ message: String
-"""
-Represents a private contribution a user made on GitHub.
-"""
-type RestrictedContribution implements Contribution {
"""
- Whether this contribution is associated with a record you do not have access to. For
- example, your own 'first issue' contribution may have been made on a repository you can no
- longer access.
+ The Git tag name.
"""
- isRestricted: Boolean!
+ name: String!
"""
- When this contribution was made.
+ The Git object ID
"""
- occurredAt: DateTime!
+ oid: GitObjectID!
"""
- The HTTP path for this contribution.
+ The Repository the Git object belongs to
"""
- resourcePath: URI!
+ repository: Repository!
"""
- The HTTP URL for this contribution.
+ Details about the tag author.
"""
- url: URI!
+ tagger: GitActor
"""
- The user who made this contribution.
+ The Git object the tag points to.
"""
- user: User!
+ target: GitObject!
}
"""
-A team or user who has the ability to dismiss a review on a protected branch.
+A team of users in an organization.
"""
-type ReviewDismissalAllowance implements Node {
+type Team implements MemberStatusable & Node & Subscribable {
"""
- The actor that can dismiss.
+ A list of teams that are ancestors of this team.
"""
- actor: ReviewDismissalAllowanceActor
+ ancestors(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
- """
- Identifies the branch protection rule associated with the allowed user or team.
- """
- branchProtectionRule: BranchProtectionRule
- id: ID!
-}
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
-"""
-Types that can be an actor.
-"""
-union ReviewDismissalAllowanceActor = Team | User
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): TeamConnection!
-"""
-The connection type for ReviewDismissalAllowance.
-"""
-type ReviewDismissalAllowanceConnection {
"""
- A list of edges.
+ A URL pointing to the team's avatar.
"""
- edges: [ReviewDismissalAllowanceEdge]
+ avatarUrl(
+ """
+ The size in pixels of the resulting square image.
+ """
+ size: Int = 400
+ ): URI
"""
- A list of nodes.
+ List of child teams belonging to this team
"""
- nodes: [ReviewDismissalAllowance]
+ childTeams(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
-"""
-An edge in a connection.
-"""
-type ReviewDismissalAllowanceEdge {
- """
- A cursor for use in pagination.
- """
- cursor: String!
+ """
+ Whether to list immediate child teams or all descendant child teams.
+ """
+ immediateOnly: Boolean = true
- """
- The item at the end of the edge.
- """
- node: ReviewDismissalAllowance
-}
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Order for connection
+ """
+ orderBy: TeamOrder
+
+ """
+ User logins to filter by
+ """
+ userLogins: [String!]
+ ): TeamConnection!
-"""
-Represents a 'review_dismissed' event on a given issue or pull request.
-"""
-type ReviewDismissedEvent implements Node & UniformResourceLocatable {
"""
- Identifies the actor who performed the event.
+ The slug corresponding to the organization and team.
"""
- actor: Actor
+ combinedSlug: String!
"""
Identifies the date and time when the object was created.
@@ -23256,1082 +30774,924 @@ type ReviewDismissedEvent implements Node & UniformResourceLocatable {
databaseId: Int
"""
- Identifies the optional message associated with the 'review_dismissed' event.
+ The description of the team.
"""
- dismissalMessage: String
+ description: String
"""
- Identifies the optional message associated with the event, rendered to HTML.
+ Find a team discussion by its number.
"""
- dismissalMessageHTML: String
- id: ID!
+ discussion(
+ """
+ The sequence number of the discussion to find.
+ """
+ number: Int!
+ ): TeamDiscussion
"""
- Identifies the message associated with the 'review_dismissed' event.
+ A list of team discussions.
"""
- message: String! @deprecated(reason: "`message` is being removed because it not nullable, whereas the underlying field is optional. Use `dismissalMessage` instead. Removal on 2019-07-01 UTC.")
+ discussions(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
- """
- The message associated with the event, rendered to HTML.
- """
- messageHtml: HTML! @deprecated(reason: "`messageHtml` is being removed because it not nullable, whereas the underlying field is optional. Use `dismissalMessageHTML` instead. Removal on 2019-07-01 UTC.")
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
- """
- Identifies the previous state of the review with the 'review_dismissed' event.
- """
- previousReviewState: PullRequestReviewState!
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
- """
- PullRequest referenced by event.
- """
- pullRequest: PullRequest!
+ """
+ If provided, filters discussions according to whether or not they are pinned.
+ """
+ isPinned: Boolean
- """
- Identifies the commit which caused the review to become stale.
- """
- pullRequestCommit: PullRequestCommit
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Order for connection
+ """
+ orderBy: TeamDiscussionOrder
+ ): TeamDiscussionConnection!
"""
- The HTTP path for this review dismissed event.
+ The HTTP path for team discussions
"""
- resourcePath: URI!
+ discussionsResourcePath: URI!
"""
- Identifies the review associated with the 'review_dismissed' event.
+ The HTTP URL for team discussions
"""
- review: PullRequestReview
+ discussionsUrl: URI!
"""
- The HTTP URL for this review dismissed event.
+ The HTTP path for editing this team
"""
- url: URI!
-}
+ editTeamResourcePath: URI!
-"""
-A request for a user to review a pull request.
-"""
-type ReviewRequest implements Node {
"""
- Identifies the primary key from the database.
+ The HTTP URL for editing this team
"""
- databaseId: Int
+ editTeamUrl: URI!
id: ID!
"""
- Identifies the pull request associated with this review request.
+ A list of pending invitations for users to this team
"""
- pullRequest: PullRequest!
+ invitations(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
- """
- The reviewer that is requested.
- """
- requestedReviewer: RequestedReviewer
-}
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
-"""
-The connection type for ReviewRequest.
-"""
-type ReviewRequestConnection {
- """
- A list of edges.
- """
- edges: [ReviewRequestEdge]
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
- """
- A list of nodes.
- """
- nodes: [ReviewRequest]
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): OrganizationInvitationConnection
"""
- Information to aid in pagination.
+ Get the status messages members of this entity have set that are either public or visible only to the organization.
"""
- pageInfo: PageInfo!
+ memberStatuses(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
- """
- Identifies the total count of items in the connection.
- """
- totalCount: Int!
-}
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Ordering options for user statuses returned from the connection.
+ """
+ orderBy: UserStatusOrder = {field: UPDATED_AT, direction: DESC}
+ ): UserStatusConnection!
-"""
-An edge in a connection.
-"""
-type ReviewRequestEdge {
"""
- A cursor for use in pagination.
+ A list of users who are members of this team.
"""
- cursor: String!
+ members(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Filter by membership type
+ """
+ membership: TeamMembershipType = ALL
- """
- The item at the end of the edge.
- """
- node: ReviewRequest
-}
+ """
+ Order for the connection.
+ """
+ orderBy: TeamMemberOrder
-"""
-Represents an 'review_request_removed' event on a given pull request.
-"""
-type ReviewRequestRemovedEvent implements Node {
- """
- Identifies the actor who performed the event.
- """
- actor: Actor
+ """
+ The search string to look for.
+ """
+ query: String
- """
- Identifies the date and time when the object was created.
- """
- createdAt: DateTime!
- id: ID!
+ """
+ Filter by team member role
+ """
+ role: TeamMemberRole
+ ): TeamMemberConnection!
"""
- PullRequest referenced by event.
+ The HTTP path for the team' members
"""
- pullRequest: PullRequest!
+ membersResourcePath: URI!
"""
- Identifies the reviewer whose review request was removed.
+ The HTTP URL for the team' members
"""
- requestedReviewer: RequestedReviewer
-}
+ membersUrl: URI!
-"""
-Represents an 'review_requested' event on a given pull request.
-"""
-type ReviewRequestedEvent implements Node {
"""
- Identifies the actor who performed the event.
+ The name of the team.
"""
- actor: Actor
+ name: String!
"""
- Identifies the date and time when the object was created.
+ The HTTP path creating a new team
"""
- createdAt: DateTime!
- id: ID!
+ newTeamResourcePath: URI!
"""
- PullRequest referenced by event.
+ The HTTP URL creating a new team
"""
- pullRequest: PullRequest!
+ newTeamUrl: URI!
"""
- Identifies the reviewer whose review was requested.
+ The organization that owns this team.
"""
- requestedReviewer: RequestedReviewer
-}
+ organization: Organization!
-"""
-A hovercard context with a message describing the current code review state of the pull
-request.
-"""
-type ReviewStatusHovercardContext implements HovercardContext @preview(toggledBy: "hagar-preview") {
"""
- A string describing this context
+ The parent team of the team.
"""
- message: String!
+ parentTeam: Team
"""
- An octicon to accompany this context
+ The level of privacy the team has.
"""
- octicon: String!
-}
-
-"""
-The results of a search.
-"""
-union SearchResultItem = App | Issue | Organization | PullRequest | Repository | User
+ privacy: TeamPrivacy!
-"""
-A list of results that matched against a search query.
-"""
-type SearchResultItemConnection {
"""
- The number of pieces of code that matched the search query.
+ A list of repositories this team has access to.
"""
- codeCount: Int!
+ repositories(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
- """
- A list of edges.
- """
- edges: [SearchResultItemEdge]
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
- """
- The number of issues that matched the search query.
- """
- issueCount: Int!
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
- """
- A list of nodes.
- """
- nodes: [SearchResultItem]
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
- """
- Information to aid in pagination.
- """
- pageInfo: PageInfo!
+ """
+ Order for the connection.
+ """
+ orderBy: TeamRepositoryOrder
- """
- The number of repositories that matched the search query.
- """
- repositoryCount: Int!
+ """
+ The search string to look for.
+ """
+ query: String
+ ): TeamRepositoryConnection!
"""
- The number of users that matched the search query.
+ The HTTP path for this team's repositories
"""
- userCount: Int!
+ repositoriesResourcePath: URI!
"""
- The number of wiki pages that matched the search query.
+ The HTTP URL for this team's repositories
"""
- wikiCount: Int!
-}
+ repositoriesUrl: URI!
-"""
-An edge in a connection.
-"""
-type SearchResultItemEdge {
"""
- A cursor for use in pagination.
+ The HTTP path for this team
"""
- cursor: String!
+ resourcePath: URI!
"""
- The item at the end of the edge.
+ What algorithm is used for review assignment for this team
"""
- node: SearchResultItem
+ reviewRequestDelegationAlgorithm: TeamReviewAssignmentAlgorithm @preview(toggledBy: "stone-crop-preview")
"""
- Text matches on the result found.
+ True if review assignment is enabled for this team
"""
- textMatches: [TextMatch]
-}
+ reviewRequestDelegationEnabled: Boolean! @preview(toggledBy: "stone-crop-preview")
-"""
-Represents the individual results of a search.
-"""
-enum SearchType {
"""
- Returns results matching issues in repositories.
+ How many team members are required for review assignment for this team
"""
- ISSUE
+ reviewRequestDelegationMemberCount: Int @preview(toggledBy: "stone-crop-preview")
"""
- Returns results matching repositories.
+ When assigning team members via delegation, whether the entire team should be notified as well.
"""
- REPOSITORY
+ reviewRequestDelegationNotifyTeam: Boolean! @preview(toggledBy: "stone-crop-preview")
"""
- Returns results matching users and organizations on GitHub.
+ The slug corresponding to the team.
"""
- USER
-}
+ slug: String!
-"""
-A GitHub Security Advisory
-"""
-type SecurityAdvisory implements Node {
"""
- Identifies the primary key from the database.
+ The HTTP path for this team's teams
"""
- databaseId: Int
+ teamsResourcePath: URI!
"""
- This is a long plaintext description of the advisory
+ The HTTP URL for this team's teams
"""
- description: String!
+ teamsUrl: URI!
"""
- The GitHub Security Advisory ID
+ Identifies the date and time when the object was last updated.
"""
- ghsaId: String!
- id: ID!
+ updatedAt: DateTime!
"""
- A list of identifiers for this advisory
+ The HTTP URL for this team
"""
- identifiers: [SecurityAdvisoryIdentifier!]!
+ url: URI!
"""
- The organization that originated the advisory
+ Team is adminable by the viewer.
"""
- origin: String!
+ viewerCanAdminister: Boolean!
"""
- When the advisory was published
+ Check if the viewer is able to change their subscription status for the repository.
"""
- publishedAt: DateTime!
+ viewerCanSubscribe: Boolean!
"""
- A list of references for this advisory
+ Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
"""
- references: [SecurityAdvisoryReference!]!
+ viewerSubscription: SubscriptionState
+}
+"""
+Audit log entry for a team.add_member event.
+"""
+type TeamAddMemberAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & TeamAuditEntryData {
"""
- The severity of the advisory
+ The action name
"""
- severity: SecurityAdvisorySeverity!
+ action: String!
"""
- A short plaintext summary of the advisory
+ The user who initiated the action
"""
- summary: String!
+ actor: AuditEntryActor
"""
- When the advisory was last updated
+ The IP address of the actor
"""
- updatedAt: DateTime!
+ actorIp: String
"""
- Vulnerabilities associated with this Advisory
- """
- vulnerabilities(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- An ecosystem to filter vulnerabilities by.
- """
- ecosystem: SecurityAdvisoryEcosystem
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- A package name to filter vulnerabilities by.
- """
- package: String
-
- """
- A list of severities to filter vulnerabilities by.
- """
- severities: [SecurityAdvisorySeverity!]
- ): SecurityVulnerabilityConnection!
+ A readable representation of the actor's location
+ """
+ actorLocation: ActorLocation
"""
- When the advisory was withdrawn, if it has been withdrawn
+ The username of the user who initiated the action
"""
- withdrawnAt: DateTime
-}
+ actorLogin: String
-"""
-The connection type for SecurityAdvisory.
-"""
-type SecurityAdvisoryConnection {
"""
- A list of edges.
+ The HTTP path for the actor.
"""
- edges: [SecurityAdvisoryEdge]
+ actorResourcePath: URI
"""
- A list of nodes.
+ The HTTP URL for the actor.
"""
- nodes: [SecurityAdvisory]
+ actorUrl: URI
"""
- Information to aid in pagination.
+ The time the action was initiated
"""
- pageInfo: PageInfo!
+ createdAt: PreciseDateTime!
+ id: ID!
"""
- Identifies the total count of items in the connection.
+ Whether the team was mapped to an LDAP Group.
"""
- totalCount: Int!
-}
+ isLdapMapped: Boolean
-"""
-The possible ecosystems of a security vulnerability's package.
-"""
-enum SecurityAdvisoryEcosystem {
"""
- Java artifacts hosted at the Maven central repository
+ The corresponding operation type for the action
"""
- MAVEN
+ operationType: OperationType
"""
- JavaScript packages hosted at npmjs.com
+ The Organization associated with the Audit Entry.
"""
- NPM
+ organization: Organization
"""
- .NET packages hosted at the NuGet Gallery
+ The name of the Organization.
"""
- NUGET
+ organizationName: String
"""
- Python packages hosted at PyPI.org
+ The HTTP path for the organization
"""
- PIP
+ organizationResourcePath: URI
"""
- Ruby gems hosted at RubyGems.org
+ The HTTP URL for the organization
"""
- RUBYGEMS
-}
+ organizationUrl: URI
-"""
-An edge in a connection.
-"""
-type SecurityAdvisoryEdge {
"""
- A cursor for use in pagination.
+ The team associated with the action
"""
- cursor: String!
+ team: Team
"""
- The item at the end of the edge.
+ The name of the team
"""
- node: SecurityAdvisory
-}
+ teamName: String
-"""
-A GitHub Security Advisory Identifier
-"""
-type SecurityAdvisoryIdentifier {
"""
- The identifier type, e.g. GHSA, CVE
+ The HTTP path for this team
"""
- type: String!
+ teamResourcePath: URI
"""
- The identifier
+ The HTTP URL for this team
"""
- value: String!
-}
+ teamUrl: URI
-"""
-An individual package
-"""
-type SecurityAdvisoryPackage {
"""
- The ecosystem the package belongs to, e.g. RUBYGEMS, NPM
+ The user affected by the action
"""
- ecosystem: SecurityAdvisoryEcosystem!
+ user: User
"""
- The package name
+ For actions involving two users, the actor is the initiator and the user is the affected user.
"""
- name: String!
-}
+ userLogin: String
-"""
-An individual package version
-"""
-type SecurityAdvisoryPackageVersion {
"""
- The package name or version
+ The HTTP path for the user.
"""
- identifier: String!
-}
+ userResourcePath: URI
-"""
-A GitHub Security Advisory Reference
-"""
-type SecurityAdvisoryReference {
"""
- A publicly accessible reference
+ The HTTP URL for the user.
"""
- url: URI!
+ userUrl: URI
}
"""
-Severity of the vulnerability.
+Audit log entry for a team.add_repository event.
"""
-enum SecurityAdvisorySeverity {
+type TeamAddRepositoryAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData & TeamAuditEntryData {
"""
- Critical.
+ The action name
"""
- CRITICAL
+ action: String!
"""
- High.
+ The user who initiated the action
"""
- HIGH
+ actor: AuditEntryActor
"""
- Low.
+ The IP address of the actor
"""
- LOW
+ actorIp: String
"""
- Moderate.
+ A readable representation of the actor's location
"""
- MODERATE
-}
+ actorLocation: ActorLocation
-"""
-An individual vulnerability within an Advisory
-"""
-type SecurityVulnerability {
"""
- The Advisory associated with this Vulnerability
+ The username of the user who initiated the action
"""
- advisory: SecurityAdvisory!
+ actorLogin: String
"""
- The first version containing a fix for the vulnerability
+ The HTTP path for the actor.
"""
- firstPatchedVersion: SecurityAdvisoryPackageVersion
+ actorResourcePath: URI
"""
- A description of the vulnerable package
+ The HTTP URL for the actor.
"""
- package: SecurityAdvisoryPackage!
+ actorUrl: URI
"""
- The severity of the vulnerability within this package
+ The time the action was initiated
"""
- severity: SecurityAdvisorySeverity!
+ createdAt: PreciseDateTime!
+ id: ID!
"""
- When the vulnerability was last updated
+ Whether the team was mapped to an LDAP Group.
"""
- updatedAt: DateTime!
+ isLdapMapped: Boolean
"""
- A string that describes the vulnerable package versions.
- This string follows a basic syntax with a few forms.
- + `= 0.2.0` denotes a single vulnerable version.
- + `<= 1.0.8` denotes a version range up to and including the specified version
- + `< 0.1.11` denotes a version range up to, but excluding, the specified version
- + `>= 4.3.0, < 4.3.5` denotes a version range with a known minimum and maximum version.
- + `>= 0.0.1` denotes a version range with a known minimum, but no known maximum
+ The corresponding operation type for the action
"""
- vulnerableVersionRange: String!
-}
+ operationType: OperationType
-"""
-The connection type for SecurityVulnerability.
-"""
-type SecurityVulnerabilityConnection {
"""
- A list of edges.
+ The Organization associated with the Audit Entry.
"""
- edges: [SecurityVulnerabilityEdge]
+ organization: Organization
"""
- A list of nodes.
+ The name of the Organization.
"""
- nodes: [SecurityVulnerability]
+ organizationName: String
"""
- Information to aid in pagination.
+ The HTTP path for the organization
"""
- pageInfo: PageInfo!
+ organizationResourcePath: URI
"""
- Identifies the total count of items in the connection.
+ The HTTP URL for the organization
"""
- totalCount: Int!
-}
+ organizationUrl: URI
-"""
-An edge in a connection.
-"""
-type SecurityVulnerabilityEdge {
"""
- A cursor for use in pagination.
+ The repository associated with the action
"""
- cursor: String!
+ repository: Repository
"""
- The item at the end of the edge.
+ The name of the repository
"""
- node: SecurityVulnerability
-}
+ repositoryName: String
-"""
-Represents an S/MIME signature on a Commit or Tag.
-"""
-type SmimeSignature implements GitSignature {
"""
- Email used to sign this object.
+ The HTTP path for the repository
"""
- email: String!
+ repositoryResourcePath: URI
"""
- True if the signature is valid and verified by GitHub.
+ The HTTP URL for the repository
"""
- isValid: Boolean!
+ repositoryUrl: URI
"""
- Payload for GPG signing object. Raw ODB object without the signature header.
+ The team associated with the action
"""
- payload: String!
+ team: Team
"""
- ASCII-armored signature header from object.
+ The name of the team
"""
- signature: String!
+ teamName: String
"""
- GitHub user corresponding to the email signing this commit.
+ The HTTP path for this team
"""
- signer: User
+ teamResourcePath: URI
"""
- The state of this signature. `VALID` if signature is valid and verified by
- GitHub, otherwise represents reason why signature is considered invalid.
+ The HTTP URL for this team
"""
- state: GitSignatureState!
+ teamUrl: URI
"""
- True if the signature was made with GitHub's signing key.
+ The user affected by the action
"""
- wasSignedByGitHub: Boolean!
-}
+ user: User
-"""
-Ways in which star connections can be ordered.
-"""
-input StarOrder {
"""
- The direction in which to order nodes.
+ For actions involving two users, the actor is the initiator and the user is the affected user.
"""
- direction: OrderDirection!
+ userLogin: String
"""
- The field in which to order nodes by.
+ The HTTP path for the user.
"""
- field: StarOrderField!
-}
+ userResourcePath: URI
-"""
-Properties by which star connections can be ordered.
-"""
-enum StarOrderField {
"""
- Allows ordering a list of stars by when they were created.
+ The HTTP URL for the user.
"""
- STARRED_AT
+ userUrl: URI
}
"""
-The connection type for User.
+Metadata for an audit entry with action team.*
"""
-type StargazerConnection {
+interface TeamAuditEntryData {
"""
- A list of edges.
+ The team associated with the action
"""
- edges: [StargazerEdge]
+ team: Team
"""
- A list of nodes.
+ The name of the team
"""
- nodes: [User]
+ teamName: String
"""
- Information to aid in pagination.
+ The HTTP path for this team
"""
- pageInfo: PageInfo!
+ teamResourcePath: URI
"""
- Identifies the total count of items in the connection.
+ The HTTP URL for this team
"""
- totalCount: Int!
+ teamUrl: URI
}
"""
-Represents a user that's starred a repository.
+Audit log entry for a team.change_parent_team event.
"""
-type StargazerEdge {
+type TeamChangeParentTeamAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & TeamAuditEntryData {
"""
- A cursor for use in pagination.
+ The action name
"""
- cursor: String!
- node: User!
+ action: String!
"""
- Identifies when the item was starred.
+ The user who initiated the action
"""
- starredAt: DateTime!
-}
-
-"""
-Things that can be starred.
-"""
-interface Starrable {
- id: ID!
+ actor: AuditEntryActor
"""
- A list of users who have starred this starrable.
+ The IP address of the actor
"""
- stargazers(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
+ actorIp: String
- """
- Order for connection
- """
- orderBy: StarOrder
- ): StargazerConnection!
+ """
+ A readable representation of the actor's location
+ """
+ actorLocation: ActorLocation
"""
- Returns a boolean indicating whether the viewing user has starred this starrable.
+ The username of the user who initiated the action
"""
- viewerHasStarred: Boolean!
-}
+ actorLogin: String
-"""
-The connection type for Repository.
-"""
-type StarredRepositoryConnection {
"""
- A list of edges.
+ The HTTP path for the actor.
"""
- edges: [StarredRepositoryEdge]
+ actorResourcePath: URI
"""
- A list of nodes.
+ The HTTP URL for the actor.
"""
- nodes: [Repository]
+ actorUrl: URI
"""
- Information to aid in pagination.
+ The time the action was initiated
"""
- pageInfo: PageInfo!
+ createdAt: PreciseDateTime!
+ id: ID!
"""
- Identifies the total count of items in the connection.
+ Whether the team was mapped to an LDAP Group.
"""
- totalCount: Int!
-}
+ isLdapMapped: Boolean
-"""
-Represents a starred repository.
-"""
-type StarredRepositoryEdge {
"""
- A cursor for use in pagination.
+ The corresponding operation type for the action
"""
- cursor: String!
- node: Repository!
+ operationType: OperationType
"""
- Identifies when the item was starred.
+ The Organization associated with the Audit Entry.
"""
- starredAt: DateTime!
-}
+ organization: Organization
-"""
-Represents a commit status.
-"""
-type Status implements Node {
"""
- The commit this status is attached to.
+ The name of the Organization.
"""
- commit: Commit
+ organizationName: String
"""
- Looks up an individual status context by context name.
+ The HTTP path for the organization
"""
- context(
- """
- The context name.
- """
- name: String!
- ): StatusContext
+ organizationResourcePath: URI
"""
- The individual status contexts for this commit.
+ The HTTP URL for the organization
"""
- contexts: [StatusContext!]!
- id: ID!
+ organizationUrl: URI
"""
- The combined commit status.
+ The new parent team.
"""
- state: StatusState!
-}
+ parentTeam: Team
-"""
-Represents an individual commit status context
-"""
-type StatusContext implements Node {
"""
- The avatar of the OAuth application or the user that created the status
+ The name of the new parent team
"""
- avatarUrl(
- """
- The size of the resulting square image.
- """
- size: Int = 40
- ): URI
+ parentTeamName: String
"""
- This commit this status context is attached to.
+ The name of the former parent team
"""
- commit: Commit
+ parentTeamNameWas: String
"""
- The name of this status context.
+ The HTTP path for the parent team
"""
- context: String!
+ parentTeamResourcePath: URI
"""
- Identifies the date and time when the object was created.
+ The HTTP URL for the parent team
"""
- createdAt: DateTime!
+ parentTeamUrl: URI
"""
- The actor who created this status context.
+ The former parent team.
"""
- creator: Actor
+ parentTeamWas: Team
"""
- The description for this status context.
+ The HTTP path for the previous parent team
"""
- description: String
- id: ID!
+ parentTeamWasResourcePath: URI
"""
- The state of this status context.
+ The HTTP URL for the previous parent team
"""
- state: StatusState!
+ parentTeamWasUrl: URI
"""
- The URL for this status context.
+ The team associated with the action
"""
- targetUrl: URI
-}
+ team: Team
-"""
-The possible commit status states.
-"""
-enum StatusState {
"""
- Status is errored.
+ The name of the team
"""
- ERROR
+ teamName: String
"""
- Status is expected.
+ The HTTP path for this team
"""
- EXPECTED
+ teamResourcePath: URI
"""
- Status is failing.
+ The HTTP URL for this team
"""
- FAILURE
+ teamUrl: URI
"""
- Status is pending.
+ The user affected by the action
"""
- PENDING
+ user: User
"""
- Status is successful.
+ For actions involving two users, the actor is the initiator and the user is the affected user.
"""
- SUCCESS
-}
+ userLogin: String
-"""
-Autogenerated input type of SubmitPullRequestReview
-"""
-input SubmitPullRequestReviewInput {
"""
- The text field to set on the Pull Request Review.
+ The HTTP path for the user.
"""
- body: String
+ userResourcePath: URI
"""
- A unique identifier for the client performing the mutation.
+ The HTTP URL for the user.
"""
- clientMutationId: String
+ userUrl: URI
+}
+"""
+The connection type for Team.
+"""
+type TeamConnection {
"""
- The event to send to the Pull Request Review.
+ A list of edges.
"""
- event: PullRequestReviewEvent!
+ edges: [TeamEdge]
"""
- The Pull Request Review ID to submit.
+ A list of nodes.
"""
- pullRequestReviewId: ID! @possibleTypes(concreteTypes: ["PullRequestReview"])
-}
+ nodes: [Team]
-"""
-Autogenerated return type of SubmitPullRequestReview
-"""
-type SubmitPullRequestReviewPayload {
"""
- A unique identifier for the client performing the mutation.
+ Information to aid in pagination.
"""
- clientMutationId: String
+ pageInfo: PageInfo!
"""
- The submitted pull request review.
+ Identifies the total count of items in the connection.
"""
- pullRequestReview: PullRequestReview
+ totalCount: Int!
}
"""
-Entities that can be subscribed to for web and email notifications.
+A team discussion.
"""
-interface Subscribable {
- id: ID!
-
+type TeamDiscussion implements Comment & Deletable & Node & Reactable & Subscribable & UniformResourceLocatable & Updatable & UpdatableComment {
"""
- Check if the viewer is able to change their subscription status for the repository.
+ The actor who authored the comment.
"""
- viewerCanSubscribe: Boolean!
+ author: Actor
"""
- Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
+ Author's association with the discussion's team.
"""
- viewerSubscription: SubscriptionState
-}
+ authorAssociation: CommentAuthorAssociation!
-"""
-Represents a 'subscribed' event on a given `Subscribable`.
-"""
-type SubscribedEvent implements Node {
"""
- Identifies the actor who performed the event.
+ The body as Markdown.
"""
- actor: Actor
+ body: String!
"""
- Identifies the date and time when the object was created.
+ The body rendered to HTML.
"""
- createdAt: DateTime!
- id: ID!
+ bodyHTML: HTML!
"""
- Object referenced by event.
+ The body rendered to text.
"""
- subscribable: Subscribable!
-}
+ bodyText: String!
-"""
-The possible states of a subscription.
-"""
-enum SubscriptionState {
"""
- The User is never notified.
+ Identifies the discussion body hash.
"""
- IGNORED
+ bodyVersion: String!
"""
- The User is notified of all conversations.
+ A list of comments on this discussion.
"""
- SUBSCRIBED
+ comments(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ When provided, filters the connection such that results begin with the comment with this number.
+ """
+ fromComment: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Order for connection
+ """
+ orderBy: TeamDiscussionCommentOrder
+ ): TeamDiscussionCommentConnection!
"""
- The User is only notified when participating or @mentioned.
+ The HTTP path for discussion comments
"""
- UNSUBSCRIBED
-}
+ commentsResourcePath: URI!
-"""
-A suggestion to review a pull request based on a user's commit history and review comments.
-"""
-type SuggestedReviewer {
"""
- Is this suggestion based on past commits?
+ The HTTP URL for discussion comments
"""
- isAuthor: Boolean!
+ commentsUrl: URI!
"""
- Is this suggestion based on past review comments?
+ Identifies the date and time when the object was created.
"""
- isCommenter: Boolean!
+ createdAt: DateTime!
"""
- Identifies the user suggested to review the pull request.
+ Check if this comment was created via an email reply.
"""
- reviewer: User!
-}
+ createdViaEmail: Boolean!
-"""
-Represents a Git tag.
-"""
-type Tag implements GitObject & Node {
"""
- An abbreviated version of the Git object ID
+ Identifies the primary key from the database.
"""
- abbreviatedOid: String!
+ databaseId: Int
"""
- The HTTP path for this Git object
+ The actor who edited the comment.
"""
- commitResourcePath: URI!
+ editor: Actor
+ id: ID!
"""
- The HTTP URL for this Git object
+ Check if this comment was edited and includes an edit with the creation data
"""
- commitUrl: URI!
- id: ID!
+ includesCreatedEdit: Boolean!
"""
- The Git tag message.
+ Whether or not the discussion is pinned.
"""
- message: String
+ isPinned: Boolean!
"""
- The Git tag name.
+ Whether or not the discussion is only visible to team members and org admins.
"""
- name: String!
+ isPrivate: Boolean!
"""
- The Git object ID
+ The moment the editor made the last edit
"""
- oid: GitObjectID!
+ lastEditedAt: DateTime
"""
- The Repository the Git object belongs to
+ Identifies the discussion within its team.
"""
- repository: Repository!
+ number: Int!
"""
- Details about the tag author.
+ Identifies when the comment was published at.
"""
- tagger: GitActor
+ publishedAt: DateTime
"""
- The Git object the tag points to.
+ A list of reactions grouped by content left on the subject.
"""
- target: GitObject!
-}
+ reactionGroups: [ReactionGroup!]
-"""
-A team of users in an organization.
-"""
-type Team implements MemberStatusable & Node & Subscribable {
"""
- A list of teams that are ancestors of this team.
+ A list of Reactions left on the Issue.
"""
- ancestors(
+ reactions(
"""
Returns the elements in the list that come after the specified cursor.
"""
@@ -24342,6 +31702,11 @@ type Team implements MemberStatusable & Node & Subscribable {
"""
before: String
+ """
+ Allows filtering Reactions by emoji.
+ """
+ content: ReactionContent
+
"""
Returns the first _n_ elements from the list.
"""
@@ -24351,22 +31716,42 @@ type Team implements MemberStatusable & Node & Subscribable {
Returns the last _n_ elements from the list.
"""
last: Int
- ): TeamConnection!
- """
- A URL pointing to the team's avatar.
- """
- avatarUrl(
"""
- The size in pixels of the resulting square image.
+ Allows specifying the order in which reactions are returned.
"""
- size: Int = 400
- ): URI
+ orderBy: ReactionOrder
+ ): ReactionConnection!
"""
- List of child teams belonging to this team
+ The HTTP path for this discussion
"""
- childTeams(
+ resourcePath: URI!
+
+ """
+ The team that defines the context of this discussion.
+ """
+ team: Team!
+
+ """
+ The title of the discussion
+ """
+ title: String!
+
+ """
+ Identifies the date and time when the object was last updated.
+ """
+ updatedAt: DateTime!
+
+ """
+ The HTTP URL for this discussion
+ """
+ url: URI!
+
+ """
+ A list of edits to this content.
+ """
+ userContentEdits(
"""
Returns the elements in the list that come after the specified cursor.
"""
@@ -24382,31 +31767,86 @@ type Team implements MemberStatusable & Node & Subscribable {
"""
first: Int
- """
- Whether to list immediate child teams or all descendant child teams.
- """
- immediateOnly: Boolean = true
-
"""
Returns the last _n_ elements from the list.
"""
last: Int
+ ): UserContentEditConnection
- """
- Order for connection
- """
- orderBy: TeamOrder
+ """
+ Check if the current viewer can delete this object.
+ """
+ viewerCanDelete: Boolean!
- """
- User logins to filter by
- """
- userLogins: [String!]
- ): TeamConnection!
+ """
+ Whether or not the current viewer can pin this discussion.
+ """
+ viewerCanPin: Boolean!
"""
- The slug corresponding to the organization and team.
+ Can user react to this subject
"""
- combinedSlug: String!
+ viewerCanReact: Boolean!
+
+ """
+ Check if the viewer is able to change their subscription status for the repository.
+ """
+ viewerCanSubscribe: Boolean!
+
+ """
+ Check if the current viewer can update this object.
+ """
+ viewerCanUpdate: Boolean!
+
+ """
+ Reasons why the current viewer can not update this comment.
+ """
+ viewerCannotUpdateReasons: [CommentCannotUpdateReason!]!
+
+ """
+ Did the viewer author this comment.
+ """
+ viewerDidAuthor: Boolean!
+
+ """
+ Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
+ """
+ viewerSubscription: SubscriptionState
+}
+
+"""
+A comment on a team discussion.
+"""
+type TeamDiscussionComment implements Comment & Deletable & Node & Reactable & UniformResourceLocatable & Updatable & UpdatableComment {
+ """
+ The actor who authored the comment.
+ """
+ author: Actor
+
+ """
+ Author's association with the comment's team.
+ """
+ authorAssociation: CommentAuthorAssociation!
+
+ """
+ The body as Markdown.
+ """
+ body: String!
+
+ """
+ The body rendered to HTML.
+ """
+ bodyHTML: HTML!
+
+ """
+ The body rendered to text.
+ """
+ bodyText: String!
+
+ """
+ The current version of the body content.
+ """
+ bodyVersion: String!
"""
Identifies the date and time when the object was created.
@@ -24414,80 +31854,55 @@ type Team implements MemberStatusable & Node & Subscribable {
createdAt: DateTime!
"""
- The description of the team.
+ Check if this comment was created via an email reply.
"""
- description: String
+ createdViaEmail: Boolean!
"""
- Find a team discussion by its number.
+ Identifies the primary key from the database.
"""
- discussion(
- """
- The sequence number of the discussion to find.
- """
- number: Int!
- ): TeamDiscussion @preview(toggledBy: "echo-preview")
+ databaseId: Int
"""
- A list of team discussions.
+ The discussion this comment is about.
"""
- discussions(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- If provided, filters discussions according to whether or not they are pinned.
- """
- isPinned: Boolean
+ discussion: TeamDiscussion!
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
+ """
+ The actor who edited the comment.
+ """
+ editor: Actor
+ id: ID!
- """
- Order for connection
- """
- orderBy: TeamDiscussionOrder
- ): TeamDiscussionConnection! @preview(toggledBy: "echo-preview")
+ """
+ Check if this comment was edited and includes an edit with the creation data
+ """
+ includesCreatedEdit: Boolean!
"""
- The HTTP path for team discussions
+ The moment the editor made the last edit
"""
- discussionsResourcePath: URI! @preview(toggledBy: "echo-preview")
+ lastEditedAt: DateTime
"""
- The HTTP URL for team discussions
+ Identifies the comment number.
"""
- discussionsUrl: URI! @preview(toggledBy: "echo-preview")
+ number: Int!
"""
- The HTTP path for editing this team
+ Identifies when the comment was published at.
"""
- editTeamResourcePath: URI!
+ publishedAt: DateTime
"""
- The HTTP URL for editing this team
+ A list of reactions grouped by content left on the subject.
"""
- editTeamUrl: URI!
- id: ID!
+ reactionGroups: [ReactionGroup!]
"""
- A list of pending invitations for users to this team
+ A list of Reactions left on the Issue.
"""
- invitations(
+ reactions(
"""
Returns the elements in the list that come after the specified cursor.
"""
@@ -24499,29 +31914,9 @@ type Team implements MemberStatusable & Node & Subscribable {
before: String
"""
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): OrganizationInvitationConnection
-
- """
- Get the status messages members of this entity have set that are either public or visible only to the organization.
- """
- memberStatuses(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
+ Allows filtering Reactions by emoji.
"""
- before: String
+ content: ReactionContent
"""
Returns the first _n_ elements from the list.
@@ -24534,15 +31929,30 @@ type Team implements MemberStatusable & Node & Subscribable {
last: Int
"""
- Ordering options for user statuses returned from the connection.
+ Allows specifying the order in which reactions are returned.
"""
- orderBy: UserStatusOrder = {field: UPDATED_AT, direction: DESC}
- ): UserStatusConnection!
+ orderBy: ReactionOrder
+ ): ReactionConnection!
"""
- A list of users who are members of this team.
+ The HTTP path for this comment
"""
- members(
+ resourcePath: URI!
+
+ """
+ Identifies the date and time when the object was last updated.
+ """
+ updatedAt: DateTime!
+
+ """
+ The HTTP URL for this comment
+ """
+ url: URI!
+
+ """
+ A list of edits to this content.
+ """
+ userContentEdits(
"""
Returns the elements in the list that come after the specified cursor.
"""
@@ -24562,274 +31972,339 @@ type Team implements MemberStatusable & Node & Subscribable {
Returns the last _n_ elements from the list.
"""
last: Int
-
- """
- Filter by membership type
- """
- membership: TeamMembershipType = ALL
-
- """
- Order for the connection.
- """
- orderBy: TeamMemberOrder
-
- """
- The search string to look for.
- """
- query: String
-
- """
- Filter by team member role
- """
- role: TeamMemberRole
- ): TeamMemberConnection!
+ ): UserContentEditConnection
"""
- The HTTP path for the team' members
+ Check if the current viewer can delete this object.
"""
- membersResourcePath: URI!
+ viewerCanDelete: Boolean!
"""
- The HTTP URL for the team' members
+ Can user react to this subject
"""
- membersUrl: URI!
+ viewerCanReact: Boolean!
"""
- The name of the team.
+ Check if the current viewer can update this object.
"""
- name: String!
+ viewerCanUpdate: Boolean!
"""
- The HTTP path creating a new team
+ Reasons why the current viewer can not update this comment.
"""
- newTeamResourcePath: URI!
+ viewerCannotUpdateReasons: [CommentCannotUpdateReason!]!
"""
- The HTTP URL creating a new team
+ Did the viewer author this comment.
"""
- newTeamUrl: URI!
+ viewerDidAuthor: Boolean!
+}
+"""
+The connection type for TeamDiscussionComment.
+"""
+type TeamDiscussionCommentConnection {
"""
- The organization that owns this team.
+ A list of edges.
"""
- organization: Organization!
+ edges: [TeamDiscussionCommentEdge]
"""
- The parent team of the team.
+ A list of nodes.
"""
- parentTeam: Team
+ nodes: [TeamDiscussionComment]
"""
- The level of privacy the team has.
+ Information to aid in pagination.
"""
- privacy: TeamPrivacy!
+ pageInfo: PageInfo!
"""
- A list of repositories this team has access to.
+ Identifies the total count of items in the connection.
"""
- repositories(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
+ totalCount: Int!
+}
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
+"""
+An edge in a connection.
+"""
+type TeamDiscussionCommentEdge {
+ """
+ A cursor for use in pagination.
+ """
+ cursor: String!
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
+ """
+ The item at the end of the edge.
+ """
+ node: TeamDiscussionComment
+}
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
+"""
+Ways in which team discussion comment connections can be ordered.
+"""
+input TeamDiscussionCommentOrder {
+ """
+ The direction in which to order nodes.
+ """
+ direction: OrderDirection!
- """
- Order for the connection.
- """
- orderBy: TeamRepositoryOrder
+ """
+ The field by which to order nodes.
+ """
+ field: TeamDiscussionCommentOrderField!
+}
- """
- The search string to look for.
- """
- query: String
- ): TeamRepositoryConnection!
+"""
+Properties by which team discussion comment connections can be ordered.
+"""
+enum TeamDiscussionCommentOrderField {
+ """
+ Allows sequential ordering of team discussion comments (which is equivalent to chronological ordering).
+ """
+ NUMBER
+}
+"""
+The connection type for TeamDiscussion.
+"""
+type TeamDiscussionConnection {
"""
- The HTTP path for this team's repositories
+ A list of edges.
"""
- repositoriesResourcePath: URI!
+ edges: [TeamDiscussionEdge]
"""
- The HTTP URL for this team's repositories
+ A list of nodes.
"""
- repositoriesUrl: URI!
+ nodes: [TeamDiscussion]
"""
- The HTTP path for this team
+ Information to aid in pagination.
"""
- resourcePath: URI!
+ pageInfo: PageInfo!
"""
- The slug corresponding to the team.
+ Identifies the total count of items in the connection.
"""
- slug: String!
+ totalCount: Int!
+}
+"""
+An edge in a connection.
+"""
+type TeamDiscussionEdge {
"""
- The HTTP path for this team's teams
+ A cursor for use in pagination.
"""
- teamsResourcePath: URI!
+ cursor: String!
"""
- The HTTP URL for this team's teams
+ The item at the end of the edge.
"""
- teamsUrl: URI!
+ node: TeamDiscussion
+}
+"""
+Ways in which team discussion connections can be ordered.
+"""
+input TeamDiscussionOrder {
"""
- Identifies the date and time when the object was last updated.
+ The direction in which to order nodes.
"""
- updatedAt: DateTime!
+ direction: OrderDirection!
"""
- The HTTP URL for this team
+ The field by which to order nodes.
"""
- url: URI!
+ field: TeamDiscussionOrderField!
+}
+"""
+Properties by which team discussion connections can be ordered.
+"""
+enum TeamDiscussionOrderField {
"""
- Team is adminable by the viewer.
+ Allows chronological ordering of team discussions.
"""
- viewerCanAdminister: Boolean!
+ CREATED_AT
+}
+"""
+An edge in a connection.
+"""
+type TeamEdge {
"""
- Check if the viewer is able to change their subscription status for the repository.
+ A cursor for use in pagination.
"""
- viewerCanSubscribe: Boolean!
+ cursor: String!
"""
- Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
+ The item at the end of the edge.
"""
- viewerSubscription: SubscriptionState
+ node: Team
}
"""
-Audit log entry for a team.add_member event.
+The connection type for User.
"""
-type TeamAddMemberAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & TeamAuditEntryData @preview(toggledBy: "audit-log-preview") {
+type TeamMemberConnection {
"""
- The action name
+ A list of edges.
"""
- action: String!
+ edges: [TeamMemberEdge]
"""
- The user who initiated the action
+ A list of nodes.
"""
- actor: AuditEntryActor
+ nodes: [User]
"""
- The IP address of the actor
+ Information to aid in pagination.
"""
- actorIp: String
+ pageInfo: PageInfo!
"""
- A readable representation of the actor's location
+ Identifies the total count of items in the connection.
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ totalCount: Int!
+}
+"""
+Represents a user who is a member of a team.
+"""
+type TeamMemberEdge {
"""
- The username of the user who initiated the action
+ A cursor for use in pagination.
"""
- actorLogin: String
+ cursor: String!
"""
- The HTTP path for the actor.
+ The HTTP path to the organization's member access page.
"""
- actorResourcePath: URI
+ memberAccessResourcePath: URI!
"""
- The HTTP URL for the actor.
+ The HTTP URL to the organization's member access page.
"""
- actorUrl: URI
+ memberAccessUrl: URI!
+ node: User!
"""
- The time the action was initiated
+ The role the member has on the team.
"""
- createdAt: PreciseDateTime!
- id: ID!
+ role: TeamMemberRole!
+}
+"""
+Ordering options for team member connections
+"""
+input TeamMemberOrder {
"""
- Whether the team was mapped to an LDAP Group.
+ The ordering direction.
"""
- isLdapMapped: Boolean
+ direction: OrderDirection!
"""
- The Organization associated with the Audit Entry.
+ The field to order team members by.
"""
- organization: Organization
+ field: TeamMemberOrderField!
+}
+"""
+Properties by which team member connections can be ordered.
+"""
+enum TeamMemberOrderField {
"""
- The name of the Organization.
+ Order team members by creation time
"""
- organizationName: String
+ CREATED_AT
"""
- The HTTP path for the organization
+ Order team members by login
"""
- organizationResourcePath: URI
+ LOGIN
+}
+"""
+The possible team member roles; either 'maintainer' or 'member'.
+"""
+enum TeamMemberRole {
"""
- The HTTP URL for the organization
+ A team maintainer has permission to add and remove team members.
"""
- organizationUrl: URI
+ MAINTAINER
"""
- The team associated with the action
+ A team member has no administrative permissions on the team.
"""
- team: Team
+ MEMBER
+}
+"""
+Defines which types of team members are included in the returned list. Can be one of IMMEDIATE, CHILD_TEAM or ALL.
+"""
+enum TeamMembershipType {
"""
- The name of the team
+ Includes immediate and child team members for the team.
"""
- teamName: String
+ ALL
"""
- The HTTP path for this team
+ Includes only child team members for the team.
"""
- teamResourcePath: URI
+ CHILD_TEAM
"""
- The HTTP URL for this team
+ Includes only immediate members of the team.
"""
- teamUrl: URI
+ IMMEDIATE
+}
+"""
+Ways in which team connections can be ordered.
+"""
+input TeamOrder {
"""
- The user affected by the action
+ The direction in which to order nodes.
"""
- user: User
+ direction: OrderDirection!
"""
- For actions involving two users, the actor is the initiator and the user is the affected user.
+ The field in which to order nodes by.
"""
- userLogin: String
+ field: TeamOrderField!
+}
+
+"""
+Properties by which team connections can be ordered.
+"""
+enum TeamOrderField {
+ """
+ Allows ordering a list of teams by name.
+ """
+ NAME
+}
+"""
+The possible team privacy values.
+"""
+enum TeamPrivacy {
"""
- The HTTP path for the user.
+ A secret team can only be seen by its members.
"""
- userResourcePath: URI
+ SECRET
"""
- The HTTP URL for the user.
+ A visible team can be seen and @mentioned by every member of the organization.
"""
- userUrl: URI
+ VISIBLE
}
"""
-Audit log entry for a team.add_repository event.
+Audit log entry for a team.remove_member event.
"""
-type TeamAddRepositoryAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData & TeamAuditEntryData @preview(toggledBy: "audit-log-preview") {
+type TeamRemoveMemberAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & TeamAuditEntryData {
"""
The action name
"""
@@ -24848,7 +32323,7 @@ type TeamAddRepositoryAuditEntry implements AuditEntry & Node & OrganizationAudi
"""
A readable representation of the actor's location
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ actorLocation: ActorLocation
"""
The username of the user who initiated the action
@@ -24876,6 +32351,11 @@ type TeamAddRepositoryAuditEntry implements AuditEntry & Node & OrganizationAudi
"""
isLdapMapped: Boolean
+ """
+ The corresponding operation type for the action
+ """
+ operationType: OperationType
+
"""
The Organization associated with the Audit Entry.
"""
@@ -24896,26 +32376,6 @@ type TeamAddRepositoryAuditEntry implements AuditEntry & Node & OrganizationAudi
"""
organizationUrl: URI
- """
- The repository associated with the action
- """
- repository: Repository
-
- """
- The name of the repository
- """
- repositoryName: String
-
- """
- The HTTP path for the repository
- """
- repositoryResourcePath: URI
-
- """
- The HTTP URL for the repository
- """
- repositoryUrl: URI
-
"""
The team associated with the action
"""
@@ -24958,34 +32418,9 @@ type TeamAddRepositoryAuditEntry implements AuditEntry & Node & OrganizationAudi
}
"""
-Metadata for an audit entry with action team.*
-"""
-interface TeamAuditEntryData @preview(toggledBy: "audit-log-preview") {
- """
- The team associated with the action
- """
- team: Team
-
- """
- The name of the team
- """
- teamName: String
-
- """
- The HTTP path for this team
- """
- teamResourcePath: URI
-
- """
- The HTTP URL for this team
- """
- teamUrl: URI
-}
-
-"""
-Audit log entry for a team.change_parent_team event.
+Audit log entry for a team.remove_repository event.
"""
-type TeamChangeParentTeamAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & TeamAuditEntryData @preview(toggledBy: "audit-log-preview") {
+type TeamRemoveRepositoryAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData & TeamAuditEntryData {
"""
The action name
"""
@@ -25004,7 +32439,7 @@ type TeamChangeParentTeamAuditEntry implements AuditEntry & Node & OrganizationA
"""
A readable representation of the actor's location
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ actorLocation: ActorLocation
"""
The username of the user who initiated the action
@@ -25032,6 +32467,11 @@ type TeamChangeParentTeamAuditEntry implements AuditEntry & Node & OrganizationA
"""
isLdapMapped: Boolean
+ """
+ The corresponding operation type for the action
+ """
+ operationType: OperationType
+
"""
The Organization associated with the Audit Entry.
"""
@@ -25053,44 +32493,24 @@ type TeamChangeParentTeamAuditEntry implements AuditEntry & Node & OrganizationA
organizationUrl: URI
"""
- The new parent team.
- """
- parentTeam: Team
-
- """
- The name of the new parent team
- """
- parentTeamName: String
-
- """
- The name of the former parent team
- """
- parentTeamNameWas: String
-
- """
- The HTTP path for the parent team
- """
- parentTeamResourcePath: URI
-
- """
- The HTTP URL for the parent team
+ The repository associated with the action
"""
- parentTeamUrl: URI
+ repository: Repository
"""
- The former parent team.
+ The name of the repository
"""
- parentTeamWas: Team
+ repositoryName: String
"""
- The HTTP path for the previous parent team
+ The HTTP path for the repository
"""
- parentTeamWasResourcePath: URI
+ repositoryResourcePath: URI
"""
- The HTTP URL for the previous parent team
+ The HTTP URL for the repository
"""
- parentTeamWasUrl: URI
+ repositoryUrl: URI
"""
The team associated with the action
@@ -25134,18 +32554,18 @@ type TeamChangeParentTeamAuditEntry implements AuditEntry & Node & OrganizationA
}
"""
-The connection type for Team.
+The connection type for Repository.
"""
-type TeamConnection {
+type TeamRepositoryConnection {
"""
A list of edges.
"""
- edges: [TeamEdge]
+ edges: [TeamRepositoryEdge]
"""
A list of nodes.
"""
- nodes: [Team]
+ nodes: [Repository]
"""
Information to aid in pagination.
@@ -25159,204 +32579,172 @@ type TeamConnection {
}
"""
-A team discussion.
+Represents a team repository.
"""
-type TeamDiscussion implements Comment & Deletable & Node & Reactable & Subscribable & UniformResourceLocatable & Updatable & UpdatableComment @preview(toggledBy: "echo-preview") {
- """
- The actor who authored the comment.
- """
- author: Actor
-
- """
- Author's association with the discussion's team.
- """
- authorAssociation: CommentAuthorAssociation!
-
+type TeamRepositoryEdge {
"""
- The body as Markdown.
+ A cursor for use in pagination.
"""
- body: String!
+ cursor: String!
+ node: Repository!
"""
- The discussion body rendered to HTML.
+ The permission level the team has on the repository
"""
- bodyHTML: HTML!
+ permission: RepositoryPermission!
+}
+"""
+Ordering options for team repository connections
+"""
+input TeamRepositoryOrder {
"""
- The body rendered to text.
+ The ordering direction.
"""
- bodyText: String!
+ direction: OrderDirection!
"""
- Identifies the discussion body hash.
+ The field to order repositories by.
"""
- bodyVersion: String!
+ field: TeamRepositoryOrderField!
+}
+"""
+Properties by which team repository connections can be ordered.
+"""
+enum TeamRepositoryOrderField {
"""
- A list of comments on this discussion.
+ Order repositories by creation time
"""
- comments(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- When provided, filters the connection such that results begin with the comment with this number.
- """
- fromComment: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Order for connection
- """
- orderBy: TeamDiscussionCommentOrder
- ): TeamDiscussionCommentConnection!
+ CREATED_AT
"""
- The HTTP path for discussion comments
+ Order repositories by name
"""
- commentsResourcePath: URI!
+ NAME
"""
- The HTTP URL for discussion comments
+ Order repositories by permission
"""
- commentsUrl: URI!
+ PERMISSION
"""
- Identifies the date and time when the object was created.
+ Order repositories by push time
"""
- createdAt: DateTime!
+ PUSHED_AT
"""
- Check if this comment was created via an email reply.
+ Order repositories by number of stargazers
"""
- createdViaEmail: Boolean!
+ STARGAZERS
"""
- Identifies the primary key from the database.
+ Order repositories by update time
"""
- databaseId: Int
+ UPDATED_AT
+}
+"""
+The possible team review assignment algorithms
+"""
+enum TeamReviewAssignmentAlgorithm @preview(toggledBy: "stone-crop-preview") {
"""
- The actor who edited the comment.
+ Balance review load across the entire team
"""
- editor: Actor
- id: ID!
+ LOAD_BALANCE
"""
- Check if this comment was edited and includes an edit with the creation data
+ Alternate reviews between each team member
"""
- includesCreatedEdit: Boolean!
+ ROUND_ROBIN
+}
+"""
+The role of a user on a team.
+"""
+enum TeamRole {
"""
- Whether or not the discussion is pinned.
+ User has admin rights on the team.
"""
- isPinned: Boolean!
+ ADMIN
"""
- Whether or not the discussion is only visible to team members and org admins.
+ User is a member of the team.
"""
- isPrivate: Boolean!
+ MEMBER
+}
+"""
+A text match within a search result.
+"""
+type TextMatch {
"""
- The moment the editor made the last edit
+ The specific text fragment within the property matched on.
"""
- lastEditedAt: DateTime
+ fragment: String!
"""
- Identifies the discussion within its team.
+ Highlights within the matched fragment.
"""
- number: Int!
+ highlights: [TextMatchHighlight!]!
"""
- Identifies when the comment was published at.
+ The property matched on.
"""
- publishedAt: DateTime
+ property: String!
+}
+"""
+Represents a single highlight in a search result match.
+"""
+type TextMatchHighlight {
"""
- A list of reactions grouped by content left on the subject.
+ The indice in the fragment where the matched text begins.
"""
- reactionGroups: [ReactionGroup!]
+ beginIndice: Int!
"""
- A list of Reactions left on the Issue.
+ The indice in the fragment where the matched text ends.
"""
- reactions(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Allows filtering Reactions by emoji.
- """
- content: ReactionContent
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Allows specifying the order in which reactions are returned.
- """
- orderBy: ReactionOrder
- ): ReactionConnection!
+ endIndice: Int!
"""
- The HTTP path for this discussion
+ The text matched.
"""
- resourcePath: URI!
+ text: String!
+}
- """
- The team that defines the context of this discussion.
- """
- team: Team!
+"""
+A topic aggregates entities that are related to a subject.
+"""
+type Topic implements Node & Starrable {
+ id: ID!
"""
- The title of the discussion
+ The topic's name.
"""
- title: String!
+ name: String!
"""
- Identifies the date and time when the object was last updated.
+ A list of related topics, including aliases of this topic, sorted with the most relevant
+ first. Returns up to 10 Topics.
"""
- updatedAt: DateTime!
+ relatedTopics(
+ """
+ How many topics to return.
+ """
+ first: Int = 3
+ ): [Topic!]!
"""
- The HTTP URL for this discussion
+ Returns a count of how many stargazers there are on this object
"""
- url: URI!
+ stargazerCount: Int!
"""
- A list of edits to this content.
+ A list of users who have starred this starrable.
"""
- userContentEdits(
+ stargazers(
"""
Returns the elements in the list that come after the specified cursor.
"""
@@ -25372,86 +32760,81 @@ type TeamDiscussion implements Comment & Deletable & Node & Reactable & Subscrib
"""
first: Int
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): UserContentEditConnection
-
- """
- Check if the current viewer can delete this object.
- """
- viewerCanDelete: Boolean!
-
- """
- Whether or not the current viewer can pin this discussion.
- """
- viewerCanPin: Boolean!
-
- """
- Can user react to this subject
- """
- viewerCanReact: Boolean!
-
- """
- Check if the viewer is able to change their subscription status for the repository.
- """
- viewerCanSubscribe: Boolean!
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
- """
- Check if the current viewer can update this object.
- """
- viewerCanUpdate: Boolean!
+ """
+ Order for connection
+ """
+ orderBy: StarOrder
+ ): StargazerConnection!
"""
- Reasons why the current viewer can not update this comment.
+ Returns a boolean indicating whether the viewing user has starred this starrable.
"""
- viewerCannotUpdateReasons: [CommentCannotUpdateReason!]!
+ viewerHasStarred: Boolean!
+}
+"""
+Metadata for an audit entry with a topic.
+"""
+interface TopicAuditEntryData {
"""
- Did the viewer author this comment.
+ The name of the topic added to the repository
"""
- viewerDidAuthor: Boolean!
+ topic: Topic
"""
- Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
+ The name of the topic added to the repository
"""
- viewerSubscription: SubscriptionState
+ topicName: String
}
"""
-A comment on a team discussion.
+Autogenerated input type of TransferIssue
"""
-type TeamDiscussionComment implements Comment & Deletable & Node & Reactable & UniformResourceLocatable & Updatable & UpdatableComment @preview(toggledBy: "echo-preview") {
+input TransferIssueInput {
"""
- The actor who authored the comment.
+ A unique identifier for the client performing the mutation.
"""
- author: Actor
+ clientMutationId: String
"""
- Author's association with the comment's team.
+ The Node ID of the issue to be transferred
"""
- authorAssociation: CommentAuthorAssociation!
+ issueId: ID! @possibleTypes(concreteTypes: ["Issue"])
"""
- The body as Markdown.
+ The Node ID of the repository the issue should be transferred to
"""
- body: String!
+ repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
+}
+"""
+Autogenerated return type of TransferIssue
+"""
+type TransferIssuePayload {
"""
- The comment body rendered to HTML.
+ A unique identifier for the client performing the mutation.
"""
- bodyHTML: HTML!
+ clientMutationId: String
"""
- The body rendered to text.
+ The issue that was transferred
"""
- bodyText: String!
+ issue: Issue
+}
+"""
+Represents a 'transferred' event on a given issue or pull request.
+"""
+type TransferredEvent implements Node {
"""
- The current version of the body content.
+ Identifies the actor who performed the event.
"""
- bodyVersion: String!
+ actor: Actor
"""
Identifies the date and time when the object was created.
@@ -25459,1535 +32842,1539 @@ type TeamDiscussionComment implements Comment & Deletable & Node & Reactable & U
createdAt: DateTime!
"""
- Check if this comment was created via an email reply.
- """
- createdViaEmail: Boolean!
-
- """
- Identifies the primary key from the database.
+ The repository this came from
"""
- databaseId: Int
+ fromRepository: Repository
+ id: ID!
"""
- The discussion this comment is about.
+ Identifies the issue associated with the event.
"""
- discussion: TeamDiscussion!
+ issue: Issue!
+}
+"""
+Represents a Git tree.
+"""
+type Tree implements GitObject & Node {
"""
- The actor who edited the comment.
+ An abbreviated version of the Git object ID
"""
- editor: Actor
- id: ID!
+ abbreviatedOid: String!
"""
- Check if this comment was edited and includes an edit with the creation data
+ The HTTP path for this Git object
"""
- includesCreatedEdit: Boolean!
+ commitResourcePath: URI!
"""
- The moment the editor made the last edit
+ The HTTP URL for this Git object
"""
- lastEditedAt: DateTime
+ commitUrl: URI!
"""
- Identifies the comment number.
+ A list of tree entries.
"""
- number: Int!
+ entries: [TreeEntry!]
+ id: ID!
"""
- Identifies when the comment was published at.
+ The Git object ID
"""
- publishedAt: DateTime
+ oid: GitObjectID!
"""
- A list of reactions grouped by content left on the subject.
+ The Repository the Git object belongs to
"""
- reactionGroups: [ReactionGroup!]
+ repository: Repository!
+}
+"""
+Represents a Git tree entry.
+"""
+type TreeEntry {
"""
- A list of Reactions left on the Issue.
+ The extension of the file
"""
- reactions(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Allows filtering Reactions by emoji.
- """
- content: ReactionContent
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Allows specifying the order in which reactions are returned.
- """
- orderBy: ReactionOrder
- ): ReactionConnection!
+ extension: String
"""
- The HTTP path for this comment
+ Whether or not this tree entry is generated
"""
- resourcePath: URI!
+ isGenerated: Boolean!
"""
- Identifies the date and time when the object was last updated.
+ Entry file mode.
"""
- updatedAt: DateTime!
+ mode: Int!
"""
- The HTTP URL for this comment
+ Entry file name.
"""
- url: URI!
+ name: String!
"""
- A list of edits to this content.
+ Entry file object.
"""
- userContentEdits(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
- ): UserContentEditConnection
+ object: GitObject
"""
- Check if the current viewer can delete this object.
+ Entry file Git object ID.
"""
- viewerCanDelete: Boolean!
+ oid: GitObjectID!
"""
- Can user react to this subject
+ The full path of the file.
"""
- viewerCanReact: Boolean!
+ path: String
"""
- Check if the current viewer can update this object.
+ The Repository the tree entry belongs to
"""
- viewerCanUpdate: Boolean!
+ repository: Repository!
"""
- Reasons why the current viewer can not update this comment.
+ If the TreeEntry is for a directory occupied by a submodule project, this returns the corresponding submodule
"""
- viewerCannotUpdateReasons: [CommentCannotUpdateReason!]!
+ submodule: Submodule
"""
- Did the viewer author this comment.
+ Entry file type.
"""
- viewerDidAuthor: Boolean!
+ type: String!
}
"""
-The connection type for TeamDiscussionComment.
+An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.
"""
-type TeamDiscussionCommentConnection @preview(toggledBy: "echo-preview") {
- """
- A list of edges.
- """
- edges: [TeamDiscussionCommentEdge]
-
- """
- A list of nodes.
- """
- nodes: [TeamDiscussionComment]
+scalar URI
+"""
+Autogenerated input type of UnarchiveRepository
+"""
+input UnarchiveRepositoryInput {
"""
- Information to aid in pagination.
+ A unique identifier for the client performing the mutation.
"""
- pageInfo: PageInfo!
+ clientMutationId: String
"""
- Identifies the total count of items in the connection.
+ The ID of the repository to unarchive.
"""
- totalCount: Int!
+ repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
}
"""
-An edge in a connection.
+Autogenerated return type of UnarchiveRepository
"""
-type TeamDiscussionCommentEdge @preview(toggledBy: "echo-preview") {
+type UnarchiveRepositoryPayload {
"""
- A cursor for use in pagination.
+ A unique identifier for the client performing the mutation.
"""
- cursor: String!
+ clientMutationId: String
"""
- The item at the end of the edge.
+ The repository that was unarchived.
"""
- node: TeamDiscussionComment
+ repository: Repository
}
"""
-Ways in which team discussion comment connections can be ordered.
+Represents an 'unassigned' event on any assignable object.
"""
-input TeamDiscussionCommentOrder @preview(toggledBy: "echo-preview") {
+type UnassignedEvent implements Node {
"""
- The direction in which to order nodes.
+ Identifies the actor who performed the event.
"""
- direction: OrderDirection!
+ actor: Actor
"""
- The field by which to order nodes.
+ Identifies the assignable associated with the event.
"""
- field: TeamDiscussionCommentOrderField!
-}
+ assignable: Assignable!
-"""
-Properties by which team discussion comment connections can be ordered.
-"""
-enum TeamDiscussionCommentOrderField @preview(toggledBy: "echo-preview") {
"""
- Allows sequential ordering of team discussion comments (which is equivalent to chronological ordering).
+ Identifies the user or mannequin that was unassigned.
"""
- NUMBER
-}
+ assignee: Assignee
-"""
-The connection type for TeamDiscussion.
-"""
-type TeamDiscussionConnection @preview(toggledBy: "echo-preview") {
"""
- A list of edges.
+ Identifies the date and time when the object was created.
"""
- edges: [TeamDiscussionEdge]
+ createdAt: DateTime!
+ id: ID!
"""
- A list of nodes.
+ Identifies the subject (user) who was unassigned.
"""
- nodes: [TeamDiscussion]
+ user: User @deprecated(reason: "Assignees can now be mannequins. Use the `assignee` field instead. Removal on 2020-01-01 UTC.")
+}
+"""
+Autogenerated input type of UnfollowUser
+"""
+input UnfollowUserInput {
"""
- Information to aid in pagination.
+ A unique identifier for the client performing the mutation.
"""
- pageInfo: PageInfo!
+ clientMutationId: String
"""
- Identifies the total count of items in the connection.
+ ID of the user to unfollow.
"""
- totalCount: Int!
+ userId: ID! @possibleTypes(concreteTypes: ["User"])
}
"""
-An edge in a connection.
+Autogenerated return type of UnfollowUser
"""
-type TeamDiscussionEdge @preview(toggledBy: "echo-preview") {
+type UnfollowUserPayload {
"""
- A cursor for use in pagination.
+ A unique identifier for the client performing the mutation.
"""
- cursor: String!
+ clientMutationId: String
"""
- The item at the end of the edge.
+ The user that was unfollowed.
"""
- node: TeamDiscussion
+ user: User
}
"""
-Ways in which team discussion connections can be ordered.
+Represents a type that can be retrieved by a URL.
"""
-input TeamDiscussionOrder @preview(toggledBy: "echo-preview") {
+interface UniformResourceLocatable {
"""
- The direction in which to order nodes.
+ The HTML path to this resource.
"""
- direction: OrderDirection!
+ resourcePath: URI!
"""
- The field by which to order nodes.
+ The URL to this resource.
"""
- field: TeamDiscussionOrderField!
+ url: URI!
}
"""
-Properties by which team discussion connections can be ordered.
+Represents an unknown signature on a Commit or Tag.
"""
-enum TeamDiscussionOrderField @preview(toggledBy: "echo-preview") {
+type UnknownSignature implements GitSignature {
"""
- Allows chronological ordering of team discussions.
+ Email used to sign this object.
"""
- CREATED_AT
-}
+ email: String!
-"""
-An edge in a connection.
-"""
-type TeamEdge {
"""
- A cursor for use in pagination.
+ True if the signature is valid and verified by GitHub.
"""
- cursor: String!
+ isValid: Boolean!
"""
- The item at the end of the edge.
+ Payload for GPG signing object. Raw ODB object without the signature header.
"""
- node: Team
-}
+ payload: String!
-"""
-The connection type for User.
-"""
-type TeamMemberConnection {
"""
- A list of edges.
+ ASCII-armored signature header from object.
"""
- edges: [TeamMemberEdge]
+ signature: String!
"""
- A list of nodes.
+ GitHub user corresponding to the email signing this commit.
"""
- nodes: [User]
+ signer: User
"""
- Information to aid in pagination.
+ The state of this signature. `VALID` if signature is valid and verified by
+ GitHub, otherwise represents reason why signature is considered invalid.
"""
- pageInfo: PageInfo!
+ state: GitSignatureState!
"""
- Identifies the total count of items in the connection.
+ True if the signature was made with GitHub's signing key.
"""
- totalCount: Int!
+ wasSignedByGitHub: Boolean!
}
"""
-Represents a user who is a member of a team.
+Represents an 'unlabeled' event on a given issue or pull request.
"""
-type TeamMemberEdge {
+type UnlabeledEvent implements Node {
"""
- A cursor for use in pagination.
+ Identifies the actor who performed the event.
"""
- cursor: String!
+ actor: Actor
"""
- The HTTP path to the organization's member access page.
+ Identifies the date and time when the object was created.
"""
- memberAccessResourcePath: URI!
+ createdAt: DateTime!
+ id: ID!
"""
- The HTTP URL to the organization's member access page.
+ Identifies the label associated with the 'unlabeled' event.
"""
- memberAccessUrl: URI!
- node: User!
+ label: Label!
"""
- The role the member has on the team.
+ Identifies the `Labelable` associated with the event.
"""
- role: TeamMemberRole!
+ labelable: Labelable!
}
"""
-Ordering options for team member connections
+Autogenerated input type of UnlinkRepositoryFromProject
"""
-input TeamMemberOrder {
+input UnlinkRepositoryFromProjectInput {
"""
- The ordering direction.
+ A unique identifier for the client performing the mutation.
"""
- direction: OrderDirection!
+ clientMutationId: String
"""
- The field to order team members by.
+ The ID of the Project linked to the Repository.
"""
- field: TeamMemberOrderField!
+ projectId: ID! @possibleTypes(concreteTypes: ["Project"])
+
+ """
+ The ID of the Repository linked to the Project.
+ """
+ repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
}
"""
-Properties by which team member connections can be ordered.
+Autogenerated return type of UnlinkRepositoryFromProject
"""
-enum TeamMemberOrderField {
+type UnlinkRepositoryFromProjectPayload {
"""
- Order team members by creation time
+ A unique identifier for the client performing the mutation.
"""
- CREATED_AT
+ clientMutationId: String
"""
- Order team members by login
+ The linked Project.
"""
- LOGIN
+ project: Project
+
+ """
+ The linked Repository.
+ """
+ repository: Repository
}
"""
-The possible team member roles; either 'maintainer' or 'member'.
+Autogenerated input type of UnlockLockable
"""
-enum TeamMemberRole {
+input UnlockLockableInput {
"""
- A team maintainer has permission to add and remove team members.
+ A unique identifier for the client performing the mutation.
"""
- MAINTAINER
+ clientMutationId: String
"""
- A team member has no administrative permissions on the team.
+ ID of the issue or pull request to be unlocked.
"""
- MEMBER
+ lockableId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "Lockable")
}
"""
-Defines which types of team members are included in the returned list. Can be one of IMMEDIATE, CHILD_TEAM or ALL.
+Autogenerated return type of UnlockLockable
"""
-enum TeamMembershipType {
+type UnlockLockablePayload {
"""
- Includes immediate and child team members for the team.
+ Identifies the actor who performed the event.
"""
- ALL
+ actor: Actor
"""
- Includes only child team members for the team.
+ A unique identifier for the client performing the mutation.
"""
- CHILD_TEAM
+ clientMutationId: String
"""
- Includes only immediate members of the team.
+ The item that was unlocked.
"""
- IMMEDIATE
+ unlockedRecord: Lockable
}
"""
-Ways in which team connections can be ordered.
+Represents an 'unlocked' event on a given issue or pull request.
"""
-input TeamOrder {
+type UnlockedEvent implements Node {
"""
- The direction in which to order nodes.
+ Identifies the actor who performed the event.
"""
- direction: OrderDirection!
+ actor: Actor
"""
- The field in which to order nodes by.
+ Identifies the date and time when the object was created.
"""
- field: TeamOrderField!
-}
+ createdAt: DateTime!
+ id: ID!
-"""
-Properties by which team connections can be ordered.
-"""
-enum TeamOrderField {
"""
- Allows ordering a list of teams by name.
+ Object that was unlocked.
"""
- NAME
+ lockable: Lockable!
}
"""
-The possible team privacy values.
+Autogenerated input type of UnmarkFileAsViewed
"""
-enum TeamPrivacy {
+input UnmarkFileAsViewedInput {
"""
- A secret team can only be seen by its members.
+ A unique identifier for the client performing the mutation.
"""
- SECRET
+ clientMutationId: String
"""
- A visible team can be seen and @mentioned by every member of the organization.
+ The path of the file to mark as unviewed
"""
- VISIBLE
-}
+ path: String!
-"""
-Audit log entry for a team.remove_member event.
-"""
-type TeamRemoveMemberAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & TeamAuditEntryData @preview(toggledBy: "audit-log-preview") {
"""
- The action name
+ The Node ID of the pull request.
"""
- action: String!
+ pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"])
+}
+"""
+Autogenerated return type of UnmarkFileAsViewed
+"""
+type UnmarkFileAsViewedPayload {
"""
- The user who initiated the action
+ A unique identifier for the client performing the mutation.
"""
- actor: AuditEntryActor
+ clientMutationId: String
"""
- The IP address of the actor
+ The updated pull request.
"""
- actorIp: String
+ pullRequest: PullRequest
+}
+"""
+Autogenerated input type of UnmarkIssueAsDuplicate
+"""
+input UnmarkIssueAsDuplicateInput {
"""
- A readable representation of the actor's location
+ ID of the issue or pull request currently considered canonical/authoritative/original.
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ canonicalId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "IssueOrPullRequest")
"""
- The username of the user who initiated the action
+ A unique identifier for the client performing the mutation.
"""
- actorLogin: String
+ clientMutationId: String
"""
- The HTTP path for the actor.
+ ID of the issue or pull request currently marked as a duplicate.
"""
- actorResourcePath: URI
+ duplicateId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "IssueOrPullRequest")
+}
+"""
+Autogenerated return type of UnmarkIssueAsDuplicate
+"""
+type UnmarkIssueAsDuplicatePayload {
"""
- The HTTP URL for the actor.
+ A unique identifier for the client performing the mutation.
"""
- actorUrl: URI
+ clientMutationId: String
"""
- The time the action was initiated
+ The issue or pull request that was marked as a duplicate.
"""
- createdAt: PreciseDateTime!
- id: ID!
+ duplicate: IssueOrPullRequest
+}
+"""
+Represents an 'unmarked_as_duplicate' event on a given issue or pull request.
+"""
+type UnmarkedAsDuplicateEvent implements Node {
"""
- Whether the team was mapped to an LDAP Group.
+ Identifies the actor who performed the event.
"""
- isLdapMapped: Boolean
+ actor: Actor
"""
- The Organization associated with the Audit Entry.
+ The authoritative issue or pull request which has been duplicated by another.
"""
- organization: Organization
+ canonical: IssueOrPullRequest
"""
- The name of the Organization.
+ Identifies the date and time when the object was created.
"""
- organizationName: String
+ createdAt: DateTime!
"""
- The HTTP path for the organization
+ The issue or pull request which has been marked as a duplicate of another.
"""
- organizationResourcePath: URI
+ duplicate: IssueOrPullRequest
+ id: ID!
"""
- The HTTP URL for the organization
+ Canonical and duplicate belong to different repositories.
"""
- organizationUrl: URI
+ isCrossRepository: Boolean!
+}
+"""
+Autogenerated input type of UnminimizeComment
+"""
+input UnminimizeCommentInput {
"""
- The team associated with the action
+ A unique identifier for the client performing the mutation.
"""
- team: Team
+ clientMutationId: String
"""
- The name of the team
+ The Node ID of the subject to modify.
"""
- teamName: String
+ subjectId: ID! @possibleTypes(concreteTypes: ["CommitComment", "GistComment", "IssueComment", "PullRequestReviewComment"], abstractType: "Minimizable")
+}
+"""
+Autogenerated return type of UnminimizeComment
+"""
+type UnminimizeCommentPayload {
"""
- The HTTP path for this team
+ A unique identifier for the client performing the mutation.
"""
- teamResourcePath: URI
+ clientMutationId: String
"""
- The HTTP URL for this team
+ The comment that was unminimized.
"""
- teamUrl: URI
+ unminimizedComment: Minimizable
+}
+"""
+Autogenerated input type of UnpinIssue
+"""
+input UnpinIssueInput {
"""
- The user affected by the action
+ A unique identifier for the client performing the mutation.
"""
- user: User
+ clientMutationId: String
"""
- For actions involving two users, the actor is the initiator and the user is the affected user.
+ The ID of the issue to be unpinned
"""
- userLogin: String
+ issueId: ID! @possibleTypes(concreteTypes: ["Issue"])
+}
+"""
+Autogenerated return type of UnpinIssue
+"""
+type UnpinIssuePayload {
"""
- The HTTP path for the user.
+ A unique identifier for the client performing the mutation.
"""
- userResourcePath: URI
+ clientMutationId: String
"""
- The HTTP URL for the user.
+ The issue that was unpinned
"""
- userUrl: URI
+ issue: Issue
}
"""
-Audit log entry for a team.remove_repository event.
+Represents an 'unpinned' event on a given issue or pull request.
"""
-type TeamRemoveRepositoryAuditEntry implements AuditEntry & Node & OrganizationAuditEntryData & RepositoryAuditEntryData & TeamAuditEntryData @preview(toggledBy: "audit-log-preview") {
+type UnpinnedEvent implements Node {
"""
- The action name
+ Identifies the actor who performed the event.
"""
- action: String!
+ actor: Actor
"""
- The user who initiated the action
+ Identifies the date and time when the object was created.
"""
- actor: AuditEntryActor
+ createdAt: DateTime!
+ id: ID!
"""
- The IP address of the actor
+ Identifies the issue associated with the event.
"""
- actorIp: String
+ issue: Issue!
+}
+"""
+Autogenerated input type of UnresolveReviewThread
+"""
+input UnresolveReviewThreadInput {
"""
- A readable representation of the actor's location
+ A unique identifier for the client performing the mutation.
"""
- actorLocation: ActorLocation @preview(toggledBy: "audit-log-preview")
+ clientMutationId: String
"""
- The username of the user who initiated the action
+ The ID of the thread to unresolve
"""
- actorLogin: String
+ threadId: ID! @possibleTypes(concreteTypes: ["PullRequestReviewThread"])
+}
+"""
+Autogenerated return type of UnresolveReviewThread
+"""
+type UnresolveReviewThreadPayload {
"""
- The HTTP path for the actor.
+ A unique identifier for the client performing the mutation.
"""
- actorResourcePath: URI
+ clientMutationId: String
"""
- The HTTP URL for the actor.
+ The thread to resolve.
"""
- actorUrl: URI
+ thread: PullRequestReviewThread
+}
+"""
+Represents an 'unsubscribed' event on a given `Subscribable`.
+"""
+type UnsubscribedEvent implements Node {
"""
- The time the action was initiated
+ Identifies the actor who performed the event.
"""
- createdAt: PreciseDateTime!
- id: ID!
+ actor: Actor
"""
- Whether the team was mapped to an LDAP Group.
+ Identifies the date and time when the object was created.
"""
- isLdapMapped: Boolean
+ createdAt: DateTime!
+ id: ID!
"""
- The Organization associated with the Audit Entry.
+ Object referenced by event.
"""
- organization: Organization
+ subscribable: Subscribable!
+}
+"""
+Entities that can be updated.
+"""
+interface Updatable {
"""
- The name of the Organization.
+ Check if the current viewer can update this object.
"""
- organizationName: String
+ viewerCanUpdate: Boolean!
+}
+"""
+Comments that can be updated.
+"""
+interface UpdatableComment {
"""
- The HTTP path for the organization
+ Reasons why the current viewer can not update this comment.
"""
- organizationResourcePath: URI
+ viewerCannotUpdateReasons: [CommentCannotUpdateReason!]!
+}
+"""
+Autogenerated input type of UpdateBranchProtectionRule
+"""
+input UpdateBranchProtectionRuleInput {
"""
- The HTTP URL for the organization
+ Can this branch be deleted.
"""
- organizationUrl: URI
+ allowsDeletions: Boolean
"""
- The repository associated with the action
+ Are force pushes allowed on this branch.
"""
- repository: Repository
+ allowsForcePushes: Boolean
"""
- The name of the repository
+ The global relay id of the branch protection rule to be updated.
"""
- repositoryName: String
+ branchProtectionRuleId: ID! @possibleTypes(concreteTypes: ["BranchProtectionRule"])
"""
- The HTTP path for the repository
+ A unique identifier for the client performing the mutation.
"""
- repositoryResourcePath: URI
+ clientMutationId: String
"""
- The HTTP URL for the repository
+ Will new commits pushed to matching branches dismiss pull request review approvals.
"""
- repositoryUrl: URI
+ dismissesStaleReviews: Boolean
"""
- The team associated with the action
+ Can admins overwrite branch protection.
"""
- team: Team
+ isAdminEnforced: Boolean
"""
- The name of the team
+ The glob-like pattern used to determine matching branches.
"""
- teamName: String
+ pattern: String
"""
- The HTTP path for this team
+ A list of User, Team or App IDs allowed to push to matching branches.
"""
- teamResourcePath: URI
+ pushActorIds: [ID!]
"""
- The HTTP URL for this team
+ Number of approving reviews required to update matching branches.
"""
- teamUrl: URI
+ requiredApprovingReviewCount: Int
"""
- The user affected by the action
+ List of required status check contexts that must pass for commits to be accepted to matching branches.
"""
- user: User
+ requiredStatusCheckContexts: [String!]
"""
- For actions involving two users, the actor is the initiator and the user is the affected user.
+ Are approving reviews required to update matching branches.
"""
- userLogin: String
+ requiresApprovingReviews: Boolean
"""
- The HTTP path for the user.
+ Are reviews from code owners required to update matching branches.
"""
- userResourcePath: URI
+ requiresCodeOwnerReviews: Boolean
"""
- The HTTP URL for the user.
+ Are commits required to be signed.
"""
- userUrl: URI
-}
+ requiresCommitSignatures: Boolean
-"""
-The connection type for Repository.
-"""
-type TeamRepositoryConnection {
"""
- A list of edges.
+ Are merge commits prohibited from being pushed to this branch.
"""
- edges: [TeamRepositoryEdge]
+ requiresLinearHistory: Boolean
"""
- A list of nodes.
+ Are status checks required to update matching branches.
"""
- nodes: [Repository]
+ requiresStatusChecks: Boolean
"""
- Information to aid in pagination.
+ Are branches required to be up to date before merging.
"""
- pageInfo: PageInfo!
+ requiresStrictStatusChecks: Boolean
"""
- Identifies the total count of items in the connection.
+ Is pushing to matching branches restricted.
"""
- totalCount: Int!
-}
+ restrictsPushes: Boolean
-"""
-Represents a team repository.
-"""
-type TeamRepositoryEdge {
"""
- A cursor for use in pagination.
+ Is dismissal of pull request reviews restricted.
"""
- cursor: String!
- node: Repository!
+ restrictsReviewDismissals: Boolean
"""
- The permission level the team has on the repository
+ A list of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.
"""
- permission: RepositoryPermission!
+ reviewDismissalActorIds: [ID!]
}
"""
-Ordering options for team repository connections
+Autogenerated return type of UpdateBranchProtectionRule
"""
-input TeamRepositoryOrder {
+type UpdateBranchProtectionRulePayload {
"""
- The ordering direction.
+ The newly created BranchProtectionRule.
"""
- direction: OrderDirection!
+ branchProtectionRule: BranchProtectionRule
"""
- The field to order repositories by.
+ A unique identifier for the client performing the mutation.
"""
- field: TeamRepositoryOrderField!
+ clientMutationId: String
}
"""
-Properties by which team repository connections can be ordered.
+Autogenerated input type of UpdateCheckRun
"""
-enum TeamRepositoryOrderField {
- """
- Order repositories by creation time
- """
- CREATED_AT
-
- """
- Order repositories by name
- """
- NAME
-
- """
- Order repositories by permission
- """
- PERMISSION
-
- """
- Order repositories by push time
- """
- PUSHED_AT
-
+input UpdateCheckRunInput {
"""
- Order repositories by number of stargazers
+ Possible further actions the integrator can perform, which a user may trigger.
"""
- STARGAZERS
+ actions: [CheckRunAction!]
"""
- Order repositories by update time
+ The node of the check.
"""
- UPDATED_AT
-}
+ checkRunId: ID! @possibleTypes(concreteTypes: ["CheckRun"])
-"""
-The role of a user on a team.
-"""
-enum TeamRole {
"""
- User has admin rights on the team.
+ A unique identifier for the client performing the mutation.
"""
- ADMIN
+ clientMutationId: String
"""
- User is a member of the team.
+ The time that the check run finished.
"""
- MEMBER
-}
+ completedAt: DateTime
-"""
-A text match within a search result.
-"""
-type TextMatch {
"""
- The specific text fragment within the property matched on.
+ The final conclusion of the check.
"""
- fragment: String!
+ conclusion: CheckConclusionState
"""
- Highlights within the matched fragment.
+ The URL of the integrator's site that has the full details of the check.
"""
- highlights: [TextMatchHighlight!]!
+ detailsUrl: URI
"""
- The property matched on.
+ A reference for the run on the integrator's system.
"""
- property: String!
-}
+ externalId: String
-"""
-Represents a single highlight in a search result match.
-"""
-type TextMatchHighlight {
"""
- The indice in the fragment where the matched text begins.
+ The name of the check.
"""
- beginIndice: Int!
+ name: String
"""
- The indice in the fragment where the matched text ends.
+ Descriptive details about the run.
"""
- endIndice: Int!
+ output: CheckRunOutput
"""
- The text matched.
+ The node ID of the repository.
"""
- text: String!
-}
-
-"""
-A topic aggregates entities that are related to a subject.
-"""
-type Topic implements Node & Starrable {
- id: ID!
+ repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
"""
- The topic's name.
+ The time that the check run began.
"""
- name: String!
+ startedAt: DateTime
"""
- A list of related topics, including aliases of this topic, sorted with the most relevant
- first. Returns up to 10 Topics.
+ The current status.
"""
- relatedTopics(
- """
- How many topics to return.
- """
- first: Int = 3
- ): [Topic!]!
+ status: RequestableCheckStatusState
+}
+"""
+Autogenerated return type of UpdateCheckRun
+"""
+type UpdateCheckRunPayload {
"""
- A list of users who have starred this starrable.
+ The updated check run.
"""
- stargazers(
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Order for connection
- """
- orderBy: StarOrder
- ): StargazerConnection!
+ checkRun: CheckRun
"""
- Returns a boolean indicating whether the viewing user has starred this starrable.
+ A unique identifier for the client performing the mutation.
"""
- viewerHasStarred: Boolean!
+ clientMutationId: String
}
"""
-Represents a 'transferred' event on a given issue or pull request.
+Autogenerated input type of UpdateCheckSuitePreferences
"""
-type TransferredEvent implements Node {
+input UpdateCheckSuitePreferencesInput {
"""
- Identifies the actor who performed the event.
+ The check suite preferences to modify.
"""
- actor: Actor
+ autoTriggerPreferences: [CheckSuiteAutoTriggerPreference!]!
"""
- Identifies the date and time when the object was created.
+ A unique identifier for the client performing the mutation.
"""
- createdAt: DateTime!
+ clientMutationId: String
"""
- The repository this came from
+ The Node ID of the repository.
"""
- fromRepository: Repository
- id: ID!
+ repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
+}
+"""
+Autogenerated return type of UpdateCheckSuitePreferences
+"""
+type UpdateCheckSuitePreferencesPayload {
"""
- Identifies the issue associated with the event.
+ A unique identifier for the client performing the mutation.
"""
- issue: Issue!
+ clientMutationId: String
+
+ """
+ The updated repository.
+ """
+ repository: Repository
}
"""
-Represents a Git tree.
+Autogenerated input type of UpdateEnterpriseAllowPrivateRepositoryForkingSetting
"""
-type Tree implements GitObject & Node {
+input UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput {
"""
- An abbreviated version of the Git object ID
+ A unique identifier for the client performing the mutation.
"""
- abbreviatedOid: String!
+ clientMutationId: String
"""
- The HTTP path for this Git object
+ The ID of the enterprise on which to set the allow private repository forking setting.
"""
- commitResourcePath: URI!
+ enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"])
"""
- The HTTP URL for this Git object
+ The value for the allow private repository forking setting on the enterprise.
"""
- commitUrl: URI!
+ settingValue: EnterpriseEnabledDisabledSettingValue!
+}
+"""
+Autogenerated return type of UpdateEnterpriseAllowPrivateRepositoryForkingSetting
+"""
+type UpdateEnterpriseAllowPrivateRepositoryForkingSettingPayload {
"""
- A list of tree entries.
+ A unique identifier for the client performing the mutation.
"""
- entries: [TreeEntry!]
- id: ID!
+ clientMutationId: String
"""
- The Git object ID
+ The enterprise with the updated allow private repository forking setting.
"""
- oid: GitObjectID!
+ enterprise: Enterprise
"""
- The Repository the Git object belongs to
+ A message confirming the result of updating the allow private repository forking setting.
"""
- repository: Repository!
+ message: String
}
"""
-Represents a Git tree entry.
+Autogenerated input type of UpdateEnterpriseDefaultRepositoryPermissionSetting
"""
-type TreeEntry {
+input UpdateEnterpriseDefaultRepositoryPermissionSettingInput {
"""
- Entry file mode.
+ A unique identifier for the client performing the mutation.
"""
- mode: Int!
+ clientMutationId: String
"""
- Entry file name.
+ The ID of the enterprise on which to set the default repository permission setting.
"""
- name: String!
+ enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"])
"""
- Entry file object.
+ The value for the default repository permission setting on the enterprise.
"""
- object: GitObject
+ settingValue: EnterpriseDefaultRepositoryPermissionSettingValue!
+}
+"""
+Autogenerated return type of UpdateEnterpriseDefaultRepositoryPermissionSetting
+"""
+type UpdateEnterpriseDefaultRepositoryPermissionSettingPayload {
"""
- Entry file Git object ID.
+ A unique identifier for the client performing the mutation.
"""
- oid: GitObjectID!
+ clientMutationId: String
"""
- The Repository the tree entry belongs to
+ The enterprise with the updated default repository permission setting.
"""
- repository: Repository!
+ enterprise: Enterprise
"""
- Entry file type.
+ A message confirming the result of updating the default repository permission setting.
"""
- type: String!
+ message: String
}
"""
-An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.
-"""
-scalar URI
-
-"""
-Represents an 'unassigned' event on any assignable object.
+Autogenerated input type of UpdateEnterpriseMembersCanChangeRepositoryVisibilitySetting
"""
-type UnassignedEvent implements Node {
+input UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput {
"""
- Identifies the actor who performed the event.
- """
- actor: Actor
-
- """
- Identifies the assignable associated with the event.
+ A unique identifier for the client performing the mutation.
"""
- assignable: Assignable!
+ clientMutationId: String
"""
- Identifies the date and time when the object was created.
+ The ID of the enterprise on which to set the members can change repository visibility setting.
"""
- createdAt: DateTime!
- id: ID!
+ enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"])
"""
- Identifies the subject (user) who was unassigned.
+ The value for the members can change repository visibility setting on the enterprise.
"""
- user: User
+ settingValue: EnterpriseEnabledDisabledSettingValue!
}
"""
-Represents a type that can be retrieved by a URL.
+Autogenerated return type of UpdateEnterpriseMembersCanChangeRepositoryVisibilitySetting
"""
-interface UniformResourceLocatable {
+type UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingPayload {
"""
- The HTML path to this resource.
+ A unique identifier for the client performing the mutation.
"""
- resourcePath: URI!
+ clientMutationId: String
"""
- The URL to this resource.
+ The enterprise with the updated members can change repository visibility setting.
"""
- url: URI!
+ enterprise: Enterprise
+
+ """
+ A message confirming the result of updating the members can change repository visibility setting.
+ """
+ message: String
}
"""
-Represents an unknown signature on a Commit or Tag.
+Autogenerated input type of UpdateEnterpriseMembersCanCreateRepositoriesSetting
"""
-type UnknownSignature implements GitSignature {
+input UpdateEnterpriseMembersCanCreateRepositoriesSettingInput {
"""
- Email used to sign this object.
+ A unique identifier for the client performing the mutation.
"""
- email: String!
+ clientMutationId: String
"""
- True if the signature is valid and verified by GitHub.
+ The ID of the enterprise on which to set the members can create repositories setting.
"""
- isValid: Boolean!
+ enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"])
"""
- Payload for GPG signing object. Raw ODB object without the signature header.
+ Allow members to create internal repositories. Defaults to current value.
"""
- payload: String!
+ membersCanCreateInternalRepositories: Boolean
"""
- ASCII-armored signature header from object.
+ Allow members to create private repositories. Defaults to current value.
"""
- signature: String!
+ membersCanCreatePrivateRepositories: Boolean
"""
- GitHub user corresponding to the email signing this commit.
+ Allow members to create public repositories. Defaults to current value.
"""
- signer: User
+ membersCanCreatePublicRepositories: Boolean
"""
- The state of this signature. `VALID` if signature is valid and verified by
- GitHub, otherwise represents reason why signature is considered invalid.
+ When false, allow member organizations to set their own repository creation member privileges.
"""
- state: GitSignatureState!
+ membersCanCreateRepositoriesPolicyEnabled: Boolean
"""
- True if the signature was made with GitHub's signing key.
+ Value for the members can create repositories setting on the enterprise. This
+ or the granular public/private/internal allowed fields (but not both) must be provided.
"""
- wasSignedByGitHub: Boolean!
+ settingValue: EnterpriseMembersCanCreateRepositoriesSettingValue
}
"""
-Represents an 'unlabeled' event on a given issue or pull request.
+Autogenerated return type of UpdateEnterpriseMembersCanCreateRepositoriesSetting
"""
-type UnlabeledEvent implements Node {
- """
- Identifies the actor who performed the event.
- """
- actor: Actor
-
+type UpdateEnterpriseMembersCanCreateRepositoriesSettingPayload {
"""
- Identifies the date and time when the object was created.
+ A unique identifier for the client performing the mutation.
"""
- createdAt: DateTime!
- id: ID!
+ clientMutationId: String
"""
- Identifies the label associated with the 'unlabeled' event.
+ The enterprise with the updated members can create repositories setting.
"""
- label: Label!
+ enterprise: Enterprise
"""
- Identifies the `Labelable` associated with the event.
+ A message confirming the result of updating the members can create repositories setting.
"""
- labelable: Labelable!
+ message: String
}
"""
-Autogenerated input type of UnlockLockable
+Autogenerated input type of UpdateEnterpriseMembersCanDeleteIssuesSetting
"""
-input UnlockLockableInput {
+input UpdateEnterpriseMembersCanDeleteIssuesSettingInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
- ID of the issue or pull request to be unlocked.
+ The ID of the enterprise on which to set the members can delete issues setting.
"""
- lockableId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "Lockable")
+ enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"])
+
+ """
+ The value for the members can delete issues setting on the enterprise.
+ """
+ settingValue: EnterpriseEnabledDisabledSettingValue!
}
"""
-Autogenerated return type of UnlockLockable
+Autogenerated return type of UpdateEnterpriseMembersCanDeleteIssuesSetting
"""
-type UnlockLockablePayload {
+type UpdateEnterpriseMembersCanDeleteIssuesSettingPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
- The item that was unlocked.
+ The enterprise with the updated members can delete issues setting.
"""
- unlockedRecord: Lockable
+ enterprise: Enterprise
+
+ """
+ A message confirming the result of updating the members can delete issues setting.
+ """
+ message: String
}
"""
-Represents an 'unlocked' event on a given issue or pull request.
+Autogenerated input type of UpdateEnterpriseMembersCanDeleteRepositoriesSetting
"""
-type UnlockedEvent implements Node {
+input UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput {
"""
- Identifies the actor who performed the event.
+ A unique identifier for the client performing the mutation.
"""
- actor: Actor
+ clientMutationId: String
"""
- Identifies the date and time when the object was created.
+ The ID of the enterprise on which to set the members can delete repositories setting.
"""
- createdAt: DateTime!
- id: ID!
+ enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"])
"""
- Object that was unlocked.
+ The value for the members can delete repositories setting on the enterprise.
"""
- lockable: Lockable!
+ settingValue: EnterpriseEnabledDisabledSettingValue!
}
"""
-Autogenerated input type of UnmarkIssueAsDuplicate
+Autogenerated return type of UpdateEnterpriseMembersCanDeleteRepositoriesSetting
"""
-input UnmarkIssueAsDuplicateInput {
+type UpdateEnterpriseMembersCanDeleteRepositoriesSettingPayload {
"""
- ID of the issue or pull request currently considered canonical/authoritative/original.
+ A unique identifier for the client performing the mutation.
"""
- canonicalId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "IssueOrPullRequest")
+ clientMutationId: String
"""
- A unique identifier for the client performing the mutation.
+ The enterprise with the updated members can delete repositories setting.
"""
- clientMutationId: String
+ enterprise: Enterprise
"""
- ID of the issue or pull request currently marked as a duplicate.
+ A message confirming the result of updating the members can delete repositories setting.
"""
- duplicateId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "IssueOrPullRequest")
+ message: String
}
"""
-Autogenerated return type of UnmarkIssueAsDuplicate
+Autogenerated input type of UpdateEnterpriseMembersCanInviteCollaboratorsSetting
"""
-type UnmarkIssueAsDuplicatePayload {
+input UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
- The issue or pull request that was marked as a duplicate.
+ The ID of the enterprise on which to set the members can invite collaborators setting.
"""
- duplicate: IssueOrPullRequest
+ enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"])
+
+ """
+ The value for the members can invite collaborators setting on the enterprise.
+ """
+ settingValue: EnterpriseEnabledDisabledSettingValue!
}
"""
-Autogenerated input type of UnminimizeComment
+Autogenerated return type of UpdateEnterpriseMembersCanInviteCollaboratorsSetting
"""
-input UnminimizeCommentInput {
+type UpdateEnterpriseMembersCanInviteCollaboratorsSettingPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
- The Node ID of the subject to modify.
+ The enterprise with the updated members can invite collaborators setting.
"""
- subjectId: ID! @possibleTypes(concreteTypes: ["CommitComment", "GistComment", "IssueComment", "PullRequestReviewComment"], abstractType: "Minimizable")
+ enterprise: Enterprise
+
+ """
+ A message confirming the result of updating the members can invite collaborators setting.
+ """
+ message: String
}
"""
-Autogenerated return type of UnminimizeComment
+Autogenerated input type of UpdateEnterpriseMembersCanMakePurchasesSetting
"""
-type UnminimizeCommentPayload {
+input UpdateEnterpriseMembersCanMakePurchasesSettingInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
- The comment that was unminimized.
+ The ID of the enterprise on which to set the members can make purchases setting.
"""
- unminimizedComment: Minimizable
+ enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"])
+
+ """
+ The value for the members can make purchases setting on the enterprise.
+ """
+ settingValue: EnterpriseMembersCanMakePurchasesSettingValue!
}
"""
-Autogenerated input type of UnpinIssue
+Autogenerated return type of UpdateEnterpriseMembersCanMakePurchasesSetting
"""
-input UnpinIssueInput {
+type UpdateEnterpriseMembersCanMakePurchasesSettingPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
- The ID of the issue to be unpinned
+ The enterprise with the updated members can make purchases setting.
"""
- issueId: ID! @possibleTypes(concreteTypes: ["Issue"])
+ enterprise: Enterprise
+
+ """
+ A message confirming the result of updating the members can make purchases setting.
+ """
+ message: String
}
"""
-Autogenerated return type of UnpinIssue
+Autogenerated input type of UpdateEnterpriseMembersCanUpdateProtectedBranchesSetting
"""
-type UnpinIssuePayload {
+input UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
- The issue that was unpinned
+ The ID of the enterprise on which to set the members can update protected branches setting.
"""
- issue: Issue
+ enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"])
+
+ """
+ The value for the members can update protected branches setting on the enterprise.
+ """
+ settingValue: EnterpriseEnabledDisabledSettingValue!
}
"""
-Represents an 'unpinned' event on a given issue or pull request.
+Autogenerated return type of UpdateEnterpriseMembersCanUpdateProtectedBranchesSetting
"""
-type UnpinnedEvent implements Node {
+type UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingPayload {
"""
- Identifies the actor who performed the event.
+ A unique identifier for the client performing the mutation.
"""
- actor: Actor
+ clientMutationId: String
"""
- Identifies the date and time when the object was created.
+ The enterprise with the updated members can update protected branches setting.
"""
- createdAt: DateTime!
- id: ID!
+ enterprise: Enterprise
"""
- Identifies the issue associated with the event.
+ A message confirming the result of updating the members can update protected branches setting.
"""
- issue: Issue!
+ message: String
}
"""
-Autogenerated input type of UnresolveReviewThread
+Autogenerated input type of UpdateEnterpriseMembersCanViewDependencyInsightsSetting
"""
-input UnresolveReviewThreadInput {
+input UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
- The ID of the thread to unresolve
+ The ID of the enterprise on which to set the members can view dependency insights setting.
"""
- threadId: ID! @possibleTypes(concreteTypes: ["PullRequestReviewThread"])
+ enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"])
+
+ """
+ The value for the members can view dependency insights setting on the enterprise.
+ """
+ settingValue: EnterpriseEnabledDisabledSettingValue!
}
"""
-Autogenerated return type of UnresolveReviewThread
+Autogenerated return type of UpdateEnterpriseMembersCanViewDependencyInsightsSetting
"""
-type UnresolveReviewThreadPayload {
+type UpdateEnterpriseMembersCanViewDependencyInsightsSettingPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
- The thread to resolve.
+ The enterprise with the updated members can view dependency insights setting.
"""
- thread: PullRequestReviewThread
+ enterprise: Enterprise
+
+ """
+ A message confirming the result of updating the members can view dependency insights setting.
+ """
+ message: String
}
"""
-Represents an 'unsubscribed' event on a given `Subscribable`.
+Autogenerated input type of UpdateEnterpriseOrganizationProjectsSetting
"""
-type UnsubscribedEvent implements Node {
+input UpdateEnterpriseOrganizationProjectsSettingInput {
"""
- Identifies the actor who performed the event.
+ A unique identifier for the client performing the mutation.
"""
- actor: Actor
+ clientMutationId: String
"""
- Identifies the date and time when the object was created.
+ The ID of the enterprise on which to set the organization projects setting.
"""
- createdAt: DateTime!
- id: ID!
+ enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"])
"""
- Object referenced by event.
+ The value for the organization projects setting on the enterprise.
"""
- subscribable: Subscribable!
+ settingValue: EnterpriseEnabledDisabledSettingValue!
}
"""
-Entities that can be updated.
+Autogenerated return type of UpdateEnterpriseOrganizationProjectsSetting
"""
-interface Updatable {
+type UpdateEnterpriseOrganizationProjectsSettingPayload {
"""
- Check if the current viewer can update this object.
+ A unique identifier for the client performing the mutation.
"""
- viewerCanUpdate: Boolean!
-}
+ clientMutationId: String
-"""
-Comments that can be updated.
-"""
-interface UpdatableComment {
"""
- Reasons why the current viewer can not update this comment.
+ The enterprise with the updated organization projects setting.
"""
- viewerCannotUpdateReasons: [CommentCannotUpdateReason!]!
-}
+ enterprise: Enterprise
-"""
-Autogenerated input type of UpdateBranchProtectionRule
-"""
-input UpdateBranchProtectionRuleInput {
"""
- The global relay id of the branch protection rule to be updated.
+ A message confirming the result of updating the organization projects setting.
"""
- branchProtectionRuleId: ID! @possibleTypes(concreteTypes: ["BranchProtectionRule"])
+ message: String
+}
+"""
+Autogenerated input type of UpdateEnterpriseProfile
+"""
+input UpdateEnterpriseProfileInput {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
- Will new commits pushed to matching branches dismiss pull request review approvals.
- """
- dismissesStaleReviews: Boolean
-
- """
- Can admins overwrite branch protection.
+ The description of the enterprise.
"""
- isAdminEnforced: Boolean
+ description: String
"""
- The glob-like pattern used to determine matching branches.
+ The Enterprise ID to update.
"""
- pattern: String
+ enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"])
"""
- A list of User or Team IDs allowed to push to matching branches.
+ The location of the enterprise.
"""
- pushActorIds: [ID!]
+ location: String
"""
- Number of approving reviews required to update matching branches.
+ The name of the enterprise.
"""
- requiredApprovingReviewCount: Int
+ name: String
"""
- List of required status check contexts that must pass for commits to be accepted to matching branches.
+ The URL of the enterprise's website.
"""
- requiredStatusCheckContexts: [String!]
+ websiteUrl: String
+}
+"""
+Autogenerated return type of UpdateEnterpriseProfile
+"""
+type UpdateEnterpriseProfilePayload {
"""
- Are approving reviews required to update matching branches.
+ A unique identifier for the client performing the mutation.
"""
- requiresApprovingReviews: Boolean
+ clientMutationId: String
"""
- Are reviews from code owners required to update matching branches.
+ The updated enterprise.
"""
- requiresCodeOwnerReviews: Boolean
+ enterprise: Enterprise
+}
+"""
+Autogenerated input type of UpdateEnterpriseRepositoryProjectsSetting
+"""
+input UpdateEnterpriseRepositoryProjectsSettingInput {
"""
- Are commits required to be signed.
+ A unique identifier for the client performing the mutation.
"""
- requiresCommitSignatures: Boolean
+ clientMutationId: String
"""
- Are status checks required to update matching branches.
+ The ID of the enterprise on which to set the repository projects setting.
"""
- requiresStatusChecks: Boolean
+ enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"])
"""
- Are branches required to be up to date before merging.
+ The value for the repository projects setting on the enterprise.
"""
- requiresStrictStatusChecks: Boolean
+ settingValue: EnterpriseEnabledDisabledSettingValue!
+}
+"""
+Autogenerated return type of UpdateEnterpriseRepositoryProjectsSetting
+"""
+type UpdateEnterpriseRepositoryProjectsSettingPayload {
"""
- Is pushing to matching branches restricted.
+ A unique identifier for the client performing the mutation.
"""
- restrictsPushes: Boolean
+ clientMutationId: String
"""
- Is dismissal of pull request reviews restricted.
+ The enterprise with the updated repository projects setting.
"""
- restrictsReviewDismissals: Boolean
+ enterprise: Enterprise
"""
- A list of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.
+ A message confirming the result of updating the repository projects setting.
"""
- reviewDismissalActorIds: [ID!]
+ message: String
}
"""
-Autogenerated return type of UpdateBranchProtectionRule
+Autogenerated input type of UpdateEnterpriseTeamDiscussionsSetting
"""
-type UpdateBranchProtectionRulePayload {
+input UpdateEnterpriseTeamDiscussionsSettingInput {
"""
- The newly created BranchProtectionRule.
+ A unique identifier for the client performing the mutation.
"""
- branchProtectionRule: BranchProtectionRule
+ clientMutationId: String
"""
- A unique identifier for the client performing the mutation.
+ The ID of the enterprise on which to set the team discussions setting.
"""
- clientMutationId: String
+ enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"])
+
+ """
+ The value for the team discussions setting on the enterprise.
+ """
+ settingValue: EnterpriseEnabledDisabledSettingValue!
}
"""
-Autogenerated input type of UpdateCheckRun
+Autogenerated return type of UpdateEnterpriseTeamDiscussionsSetting
"""
-input UpdateCheckRunInput @preview(toggledBy: "antiope-preview") {
+type UpdateEnterpriseTeamDiscussionsSettingPayload {
"""
- Possible further actions the integrator can perform, which a user may trigger.
+ A unique identifier for the client performing the mutation.
"""
- actions: [CheckRunAction!]
+ clientMutationId: String
"""
- The node of the check.
+ The enterprise with the updated team discussions setting.
"""
- checkRunId: ID! @possibleTypes(concreteTypes: ["CheckRun"])
+ enterprise: Enterprise
"""
- A unique identifier for the client performing the mutation.
+ A message confirming the result of updating the team discussions setting.
"""
- clientMutationId: String
+ message: String
+}
+"""
+Autogenerated input type of UpdateEnterpriseTwoFactorAuthenticationRequiredSetting
+"""
+input UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput {
"""
- The time that the check run finished.
+ A unique identifier for the client performing the mutation.
"""
- completedAt: DateTime
+ clientMutationId: String
"""
- The final conclusion of the check.
+ The ID of the enterprise on which to set the two factor authentication required setting.
"""
- conclusion: CheckConclusionState
+ enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"])
"""
- The URL of the integrator's site that has the full details of the check.
+ The value for the two factor authentication required setting on the enterprise.
"""
- detailsUrl: URI
+ settingValue: EnterpriseEnabledSettingValue!
+}
+"""
+Autogenerated return type of UpdateEnterpriseTwoFactorAuthenticationRequiredSetting
+"""
+type UpdateEnterpriseTwoFactorAuthenticationRequiredSettingPayload {
"""
- A reference for the run on the integrator's system.
+ A unique identifier for the client performing the mutation.
"""
- externalId: String
+ clientMutationId: String
"""
- The name of the check.
+ The enterprise with the updated two factor authentication required setting.
"""
- name: String
+ enterprise: Enterprise
"""
- Descriptive details about the run.
+ A message confirming the result of updating the two factor authentication required setting.
"""
- output: CheckRunOutput
+ message: String
+}
+"""
+Autogenerated input type of UpdateIpAllowListEnabledSetting
+"""
+input UpdateIpAllowListEnabledSettingInput {
"""
- The node ID of the repository.
+ A unique identifier for the client performing the mutation.
"""
- repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
+ clientMutationId: String
"""
- The time that the check run began.
+ The ID of the owner on which to set the IP allow list enabled setting.
"""
- startedAt: DateTime
+ ownerId: ID! @possibleTypes(concreteTypes: ["Enterprise", "Organization"], abstractType: "IpAllowListOwner")
"""
- The current status.
+ The value for the IP allow list enabled setting.
"""
- status: RequestableCheckStatusState
+ settingValue: IpAllowListEnabledSettingValue!
}
"""
-Autogenerated return type of UpdateCheckRun
+Autogenerated return type of UpdateIpAllowListEnabledSetting
"""
-type UpdateCheckRunPayload @preview(toggledBy: "antiope-preview") {
+type UpdateIpAllowListEnabledSettingPayload {
"""
- The updated check run.
+ A unique identifier for the client performing the mutation.
"""
- checkRun: CheckRun
+ clientMutationId: String
"""
- A unique identifier for the client performing the mutation.
+ The IP allow list owner on which the setting was updated.
"""
- clientMutationId: String
+ owner: IpAllowListOwner
}
"""
-Autogenerated input type of UpdateCheckSuitePreferences
+Autogenerated input type of UpdateIpAllowListEntry
"""
-input UpdateCheckSuitePreferencesInput @preview(toggledBy: "antiope-preview") {
+input UpdateIpAllowListEntryInput {
"""
- The check suite preferences to modify.
+ An IP address or range of addresses in CIDR notation.
"""
- autoTriggerPreferences: [CheckSuiteAutoTriggerPreference!]!
+ allowListValue: String!
"""
A unique identifier for the client performing the mutation.
@@ -26995,24 +34382,34 @@ input UpdateCheckSuitePreferencesInput @preview(toggledBy: "antiope-preview") {
clientMutationId: String
"""
- The Node ID of the repository.
+ The ID of the IP allow list entry to update.
"""
- repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
+ ipAllowListEntryId: ID! @possibleTypes(concreteTypes: ["IpAllowListEntry"])
+
+ """
+ Whether the IP allow list entry is active when an IP allow list is enabled.
+ """
+ isActive: Boolean!
+
+ """
+ An optional name for the IP allow list entry.
+ """
+ name: String
}
"""
-Autogenerated return type of UpdateCheckSuitePreferences
+Autogenerated return type of UpdateIpAllowListEntry
"""
-type UpdateCheckSuitePreferencesPayload @preview(toggledBy: "antiope-preview") {
+type UpdateIpAllowListEntryPayload {
"""
A unique identifier for the client performing the mutation.
"""
clientMutationId: String
"""
- The updated repository.
+ The IP allow list entry that was updated.
"""
- repository: Repository
+ ipAllowListEntry: IpAllowListEntry
}
"""
@@ -27104,6 +34501,11 @@ input UpdateIssueInput {
Autogenerated return type of UpdateIssue
"""
type UpdateIssuePayload {
+ """
+ Identifies the actor who performed the event.
+ """
+ actor: Actor
+
"""
A unique identifier for the client performing the mutation.
"""
@@ -27289,6 +34691,11 @@ type UpdateProjectPayload {
Autogenerated input type of UpdatePullRequest
"""
input UpdatePullRequestInput {
+ """
+ An array of Node IDs of users for this pull request.
+ """
+ assigneeIds: [ID!] @possibleTypes(concreteTypes: ["User"])
+
"""
The name of the branch you want your changes pulled into. This should be an existing branch
on the current repository.
@@ -27305,16 +34712,36 @@ input UpdatePullRequestInput {
"""
clientMutationId: String
+ """
+ An array of Node IDs of labels for this pull request.
+ """
+ labelIds: [ID!] @possibleTypes(concreteTypes: ["Label"])
+
"""
Indicates whether maintainers can modify the pull request.
"""
maintainerCanModify: Boolean
+ """
+ The Node ID of the milestone for this pull request.
+ """
+ milestoneId: ID @possibleTypes(concreteTypes: ["Milestone"])
+
+ """
+ An array of Node IDs for projects associated with this pull request.
+ """
+ projectIds: [ID!]
+
"""
The Node ID of the pull request.
"""
pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"])
+ """
+ The target state of the pull request.
+ """
+ state: PullRequestUpdateState
+
"""
The title of the pull request.
"""
@@ -27325,6 +34752,11 @@ input UpdatePullRequestInput {
Autogenerated return type of UpdatePullRequest
"""
type UpdatePullRequestPayload {
+ """
+ Identifies the actor who performed the event.
+ """
+ actor: Actor
+
"""
A unique identifier for the client performing the mutation.
"""
@@ -27446,6 +34878,36 @@ type UpdateRefPayload {
ref: Ref
}
+"""
+Autogenerated input type of UpdateRefs
+"""
+input UpdateRefsInput @preview(toggledBy: "update-refs-preview") {
+ """
+ A unique identifier for the client performing the mutation.
+ """
+ clientMutationId: String
+
+ """
+ A list of ref updates.
+ """
+ refUpdates: [RefUpdate!]!
+
+ """
+ The Node ID of the repository.
+ """
+ repositoryId: ID! @possibleTypes(concreteTypes: ["Repository"])
+}
+
+"""
+Autogenerated return type of UpdateRefs
+"""
+type UpdateRefsPayload @preview(toggledBy: "update-refs-preview") {
+ """
+ A unique identifier for the client performing the mutation.
+ """
+ clientMutationId: String
+}
+
"""
Autogenerated input type of UpdateRepository
"""
@@ -27550,7 +35012,7 @@ type UpdateSubscriptionPayload {
"""
Autogenerated input type of UpdateTeamDiscussionComment
"""
-input UpdateTeamDiscussionCommentInput @preview(toggledBy: "echo-preview") {
+input UpdateTeamDiscussionCommentInput {
"""
The updated text of the comment.
"""
@@ -27575,7 +35037,7 @@ input UpdateTeamDiscussionCommentInput @preview(toggledBy: "echo-preview") {
"""
Autogenerated return type of UpdateTeamDiscussionComment
"""
-type UpdateTeamDiscussionCommentPayload @preview(toggledBy: "echo-preview") {
+type UpdateTeamDiscussionCommentPayload {
"""
A unique identifier for the client performing the mutation.
"""
@@ -27590,7 +35052,7 @@ type UpdateTeamDiscussionCommentPayload @preview(toggledBy: "echo-preview") {
"""
Autogenerated input type of UpdateTeamDiscussion
"""
-input UpdateTeamDiscussionInput @preview(toggledBy: "echo-preview") {
+input UpdateTeamDiscussionInput {
"""
The updated text of the discussion.
"""
@@ -27626,7 +35088,7 @@ input UpdateTeamDiscussionInput @preview(toggledBy: "echo-preview") {
"""
Autogenerated return type of UpdateTeamDiscussion
"""
-type UpdateTeamDiscussionPayload @preview(toggledBy: "echo-preview") {
+type UpdateTeamDiscussionPayload {
"""
A unique identifier for the client performing the mutation.
"""
@@ -27638,6 +35100,61 @@ type UpdateTeamDiscussionPayload @preview(toggledBy: "echo-preview") {
teamDiscussion: TeamDiscussion
}
+"""
+Autogenerated input type of UpdateTeamReviewAssignment
+"""
+input UpdateTeamReviewAssignmentInput @preview(toggledBy: "stone-crop-preview") {
+ """
+ The algorithm to use for review assignment
+ """
+ algorithm: TeamReviewAssignmentAlgorithm = ROUND_ROBIN
+
+ """
+ A unique identifier for the client performing the mutation.
+ """
+ clientMutationId: String
+
+ """
+ Turn on or off review assignment
+ """
+ enabled: Boolean!
+
+ """
+ An array of team member IDs to exclude
+ """
+ excludedTeamMemberIds: [ID!] @possibleTypes(concreteTypes: ["User"])
+
+ """
+ The Node ID of the team to update review assginments of
+ """
+ id: ID! @possibleTypes(concreteTypes: ["Team"])
+
+ """
+ Notify the entire team of the PR if it is delegated
+ """
+ notifyTeam: Boolean = true
+
+ """
+ The number of team members to assign
+ """
+ teamMemberCount: Int = 1
+}
+
+"""
+Autogenerated return type of UpdateTeamReviewAssignment
+"""
+type UpdateTeamReviewAssignmentPayload {
+ """
+ A unique identifier for the client performing the mutation.
+ """
+ clientMutationId: String
+
+ """
+ The team that was modified
+ """
+ team: Team
+}
+
"""
Autogenerated input type of UpdateTopics
"""
@@ -27681,7 +35198,7 @@ type UpdateTopicsPayload {
"""
A user is an individual's account on GitHub that owns repositories and can make new content.
"""
-type User implements Actor & Node & ProfileOwner & ProjectOwner & RegistryPackageOwner & RegistryPackageSearch & RepositoryOwner & UniformResourceLocatable {
+type User implements Actor & Node & ProfileOwner & ProjectOwner & RepositoryOwner & Sponsorable & UniformResourceLocatable {
"""
Determine if this repository owner has any items that can be pinned to their profile.
"""
@@ -27911,7 +35428,7 @@ type User implements Actor & Node & ProfileOwner & ProjectOwner & RegistryPackag
The ID of the subject to get the hovercard in the context of
"""
primarySubjectId: ID
- ): Hovercard! @preview(toggledBy: "hagar-preview")
+ ): Hovercard!
id: ID!
"""
@@ -28050,6 +35567,16 @@ type User implements Actor & Node & ProfileOwner & ProjectOwner & RegistryPackag
login: String!
): Organization
+ """
+ Verified email addresses that match verified domains for a specified organization the user is a member of.
+ """
+ organizationVerifiedDomainEmails(
+ """
+ The login of the organization to match verified domains from.
+ """
+ login: String!
+ ): [String!]!
+
"""
A list of organizations the user belongs to.
"""
@@ -28140,60 +35667,6 @@ type User implements Actor & Node & ProfileOwner & ProjectOwner & RegistryPackag
"""
pinnedItemsRemaining: Int!
- """
- A list of repositories this user has pinned to their profile
- """
- pinnedRepositories(
- """
- Array of viewer's affiliation options for repositories returned from the
- connection. For example, OWNER will include only repositories that the
- current viewer owns.
- """
- affiliations: [RepositoryAffiliation]
-
- """
- Returns the elements in the list that come after the specified cursor.
- """
- after: String
-
- """
- Returns the elements in the list that come before the specified cursor.
- """
- before: String
-
- """
- Returns the first _n_ elements from the list.
- """
- first: Int
-
- """
- If non-null, filters repositories according to whether they have been locked
- """
- isLocked: Boolean
-
- """
- Returns the last _n_ elements from the list.
- """
- last: Int
-
- """
- Ordering options for repositories returned from the connection
- """
- orderBy: RepositoryOrder
-
- """
- Array of owner's affiliation options for repositories returned from the
- connection. For example, OWNER will include only repositories that the
- organization or user being viewed owns.
- """
- ownerAffiliations: [RepositoryAffiliation] = [OWNER, COLLABORATOR]
-
- """
- If non-null, filters repositories according to privacy
- """
- privacy: RepositoryPrivacy
- ): RepositoryConnection! @deprecated(reason: "pinnedRepositories will be removed Use ProfileOwner.pinnedItems instead. Removal on 2019-10-01 UTC.")
-
"""
Find project by number.
"""
@@ -28454,6 +35927,103 @@ type User implements Actor & Node & ProfileOwner & ProjectOwner & RegistryPackag
"""
resourcePath: URI!
+ """
+ Replies this user has saved
+ """
+ savedReplies(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ The field to order saved replies by.
+ """
+ orderBy: SavedReplyOrder = {field: UPDATED_AT, direction: DESC}
+ ): SavedReplyConnection
+
+ """
+ This object's sponsorships as the maintainer.
+ """
+ sponsorshipsAsMaintainer(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Whether or not to include private sponsorships in the result set
+ """
+ includePrivate: Boolean = false
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Ordering options for sponsorships returned from this connection. If left
+ blank, the sponsorships will be ordered based on relevancy to the viewer.
+ """
+ orderBy: SponsorshipOrder
+ ): SponsorshipConnection!
+
+ """
+ This object's sponsorships as the sponsor.
+ """
+ sponsorshipsAsSponsor(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Ordering options for sponsorships returned from this connection. If left
+ blank, the sponsorships will be ordered based on relevancy to the viewer.
+ """
+ orderBy: SponsorshipOrder
+ ): SponsorshipConnection!
+
"""
Repositories the user has starred.
"""
@@ -28499,6 +36069,46 @@ type User implements Actor & Node & ProfileOwner & ProjectOwner & RegistryPackag
"""
suspendedAt: DateTime
+ """
+ Repositories the user has contributed to, ordered by contribution rank, plus repositories the user has created
+ """
+ topRepositories(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Ordering options for repositories returned from the connection
+ """
+ orderBy: RepositoryOrder!
+
+ """
+ How far back in time to fetch contributed repositories
+ """
+ since: DateTime
+ ): RepositoryConnection!
+
+ """
+ The user's Twitter username.
+ """
+ twitterUsername: String
+
"""
Identifies the date and time when the object was last updated.
"""
@@ -28766,6 +36376,26 @@ type UserEdge {
node: User
}
+"""
+Email attributes from External Identity
+"""
+type UserEmailMetadata {
+ """
+ Boolean to identify primary emails
+ """
+ primary: Boolean
+
+ """
+ Type of email
+ """
+ type: String
+
+ """
+ Email id
+ """
+ value: String!
+}
+
"""
The user's description of what they're currently doing.
"""
@@ -28780,6 +36410,11 @@ type UserStatus implements Node {
"""
emoji: String
+ """
+ The status emoji as HTML.
+ """
+ emojiHTML: HTML
+
"""
If set, the status will not be shown after this date.
"""
@@ -28884,7 +36519,7 @@ enum UserStatusOrderField {
"""
A hovercard context with a message describing how the viewer is related.
"""
-type ViewerHovercardContext implements HovercardContext @preview(toggledBy: "hagar-preview") {
+type ViewerHovercardContext implements HovercardContext {
"""
A string describing this context
"""
diff --git a/data/graphql/2.19/graphql_previews.enterprise.yml b/data/graphql/ghes-2.19/graphql_previews.enterprise.yml
similarity index 100%
rename from data/graphql/2.19/graphql_previews.enterprise.yml
rename to data/graphql/ghes-2.19/graphql_previews.enterprise.yml
diff --git a/data/graphql/2.19/graphql_upcoming_changes.public-enterprise.yml b/data/graphql/ghes-2.19/graphql_upcoming_changes.public-enterprise.yml
similarity index 100%
rename from data/graphql/2.19/graphql_upcoming_changes.public-enterprise.yml
rename to data/graphql/ghes-2.19/graphql_upcoming_changes.public-enterprise.yml
diff --git a/data/graphql/2.19/schema.docs-enterprise.graphql b/data/graphql/ghes-2.19/schema.docs-enterprise.graphql
similarity index 100%
rename from data/graphql/2.19/schema.docs-enterprise.graphql
rename to data/graphql/ghes-2.19/schema.docs-enterprise.graphql
diff --git a/data/graphql/2.20/graphql_previews.enterprise.yml b/data/graphql/ghes-2.20/graphql_previews.enterprise.yml
similarity index 100%
rename from data/graphql/2.20/graphql_previews.enterprise.yml
rename to data/graphql/ghes-2.20/graphql_previews.enterprise.yml
diff --git a/data/graphql/2.20/graphql_upcoming_changes.public-enterprise.yml b/data/graphql/ghes-2.20/graphql_upcoming_changes.public-enterprise.yml
similarity index 100%
rename from data/graphql/2.20/graphql_upcoming_changes.public-enterprise.yml
rename to data/graphql/ghes-2.20/graphql_upcoming_changes.public-enterprise.yml
diff --git a/data/graphql/2.20/schema.docs-enterprise.graphql b/data/graphql/ghes-2.20/schema.docs-enterprise.graphql
similarity index 100%
rename from data/graphql/2.20/schema.docs-enterprise.graphql
rename to data/graphql/ghes-2.20/schema.docs-enterprise.graphql
diff --git a/data/graphql/2.21/graphql_previews.enterprise.yml b/data/graphql/ghes-2.21/graphql_previews.enterprise.yml
similarity index 100%
rename from data/graphql/2.21/graphql_previews.enterprise.yml
rename to data/graphql/ghes-2.21/graphql_previews.enterprise.yml
diff --git a/data/graphql/2.21/graphql_upcoming_changes.public-enterprise.yml b/data/graphql/ghes-2.21/graphql_upcoming_changes.public-enterprise.yml
similarity index 100%
rename from data/graphql/2.21/graphql_upcoming_changes.public-enterprise.yml
rename to data/graphql/ghes-2.21/graphql_upcoming_changes.public-enterprise.yml
diff --git a/data/graphql/2.21/schema.docs-enterprise.graphql b/data/graphql/ghes-2.21/schema.docs-enterprise.graphql
similarity index 100%
rename from data/graphql/2.21/schema.docs-enterprise.graphql
rename to data/graphql/ghes-2.21/schema.docs-enterprise.graphql
diff --git a/data/graphql/2.22/graphql_previews.enterprise.yml b/data/graphql/ghes-2.22/graphql_previews.enterprise.yml
similarity index 100%
rename from data/graphql/2.22/graphql_previews.enterprise.yml
rename to data/graphql/ghes-2.22/graphql_previews.enterprise.yml
diff --git a/data/graphql/2.22/graphql_upcoming_changes.public-enterprise.yml b/data/graphql/ghes-2.22/graphql_upcoming_changes.public-enterprise.yml
similarity index 100%
rename from data/graphql/2.22/graphql_upcoming_changes.public-enterprise.yml
rename to data/graphql/ghes-2.22/graphql_upcoming_changes.public-enterprise.yml
diff --git a/data/graphql/2.22/schema.docs-enterprise.graphql b/data/graphql/ghes-2.22/schema.docs-enterprise.graphql
similarity index 100%
rename from data/graphql/2.22/schema.docs-enterprise.graphql
rename to data/graphql/ghes-2.22/schema.docs-enterprise.graphql
diff --git a/data/graphql/graphql_previews.yml b/data/graphql/graphql_previews.yml
index 6bdf9f5ff06f..6b8e09178014 100644
--- a/data/graphql/graphql_previews.yml
+++ b/data/graphql/graphql_previews.yml
@@ -52,7 +52,7 @@
- UpdateRefsInput
- UpdateRefsPayload
owning_teams:
- - '@github/pe-repos'
+ - '@github/reponauts'
- title: Access to a Repositories Dependency Graph
description: This preview adds support for reading a dependency graph for a repository.
toggled_by: ':hawkgirl-preview'
diff --git a/data/graphql/graphql_upcoming_changes.public.yml b/data/graphql/graphql_upcoming_changes.public.yml
index 4489b44b0c4b..3af44bb5429f 100644
--- a/data/graphql/graphql_upcoming_changes.public.yml
+++ b/data/graphql/graphql_upcoming_changes.public.yml
@@ -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
diff --git a/data/graphql/schema.docs.graphql b/data/graphql/schema.docs.graphql
index 2b5049134f66..208d3b7aed58 100644
--- a/data/graphql/schema.docs.graphql
+++ b/data/graphql/schema.docs.graphql
@@ -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.
"""
@@ -4472,6 +4487,16 @@ type ConvertedNoteToIssueEvent implements Node {
Autogenerated input type of CreateBranchProtectionRule
"""
input CreateBranchProtectionRuleInput {
+ """
+ Can this branch be deleted.
+ """
+ allowsDeletions: Boolean
+
+ """
+ Are force pushes allowed on this branch.
+ """
+ allowsForcePushes: Boolean
+
"""
A unique identifier for the client performing the mutation.
"""
@@ -4527,6 +4552,11 @@ input CreateBranchProtectionRuleInput {
"""
requiresCommitSignatures: Boolean
+ """
+ Are merge commits prohibited from being pushed to this branch.
+ """
+ requiresLinearHistory: Boolean
+
"""
Are status checks required to update matching branches.
"""
@@ -29733,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!
@@ -30018,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!
@@ -34882,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!
}
@@ -35796,6 +35814,16 @@ interface UpdatableComment {
Autogenerated input type of UpdateBranchProtectionRule
"""
input UpdateBranchProtectionRuleInput {
+ """
+ Can this branch be deleted.
+ """
+ allowsDeletions: Boolean
+
+ """
+ Are force pushes allowed on this branch.
+ """
+ allowsForcePushes: Boolean
+
"""
The global relay id of the branch protection rule to be updated.
"""
@@ -35851,6 +35879,11 @@ input UpdateBranchProtectionRuleInput {
"""
requiresCommitSignatures: Boolean
+ """
+ Are merge commits prohibited from being pushed to this branch.
+ """
+ requiresLinearHistory: Boolean
+
"""
Are status checks required to update matching branches.
"""
diff --git a/data/reusables/actions/actions-not-verified.md b/data/reusables/actions/actions-not-verified.md
index cb26fa9d61f6..2ab85ce6c125 100644
--- a/data/reusables/actions/actions-not-verified.md
+++ b/data/reusables/actions/actions-not-verified.md
@@ -1 +1 @@
-Anyone can publish an action in {% data variables.product.prodname_marketplace %} as long as they meet the terms of service. Unlike apps, {% data variables.product.prodname_actions %} listed in {% data variables.product.prodname_marketplace %} are not verified by {% data variables.product.prodname_dotcom %}.
+Anyone can publish an action in {% data variables.product.prodname_marketplace %}. {% data variables.product.prodname_dotcom %} verifies some partner organizations, but unlike verified apps, {% data variables.product.prodname_dotcom %} does not review or verify individual actions listed in {% data variables.product.prodname_marketplace %}.
diff --git a/data/reusables/actions/actions-use-policy-settings.md b/data/reusables/actions/actions-use-policy-settings.md
index b25cd5eb26be..02de83e2ef20 100644
--- a/data/reusables/actions/actions-use-policy-settings.md
+++ b/data/reusables/actions/actions-use-policy-settings.md
@@ -1,3 +1,3 @@
-If you choose the option to **Allow specific actions**, there are additional options that you can configure. For more information, see "[Allowing specific actions to run](#allowing-specific-actions-to-run)."
+If you choose **Allow select actions**, local actions are allowed, and there are additional options for allowing other specific actions. For more information, see "[Allowing specific actions to run](#allowing-specific-actions-to-run)."
When you allow local actions only, the policy blocks all access to actions authored by {% data variables.product.prodname_dotcom %}. For example, the [`actions/checkout`](https://github.com/actions/checkout) would not be accessible.
\ No newline at end of file
diff --git a/data/reusables/actions/allow-specific-actions-intro.md b/data/reusables/actions/allow-specific-actions-intro.md
index 413799db125b..3c7fe735a3f1 100644
--- a/data/reusables/actions/allow-specific-actions-intro.md
+++ b/data/reusables/actions/allow-specific-actions-intro.md
@@ -1,4 +1,4 @@
-When you select the **Allow select actions**, there are additional options that you need to choose to configure the allowed actions:
+When you choose **Allow select actions**, local actions are allowed, and there are additional options for allowing other specific actions:
- **Allow actions created by {% data variables.product.prodname_dotcom %}:** You can allow all actions created by {% data variables.product.prodname_dotcom %} to be used by workflows. Actions created by {% data variables.product.prodname_dotcom %} are located in the `actions` and `github` organization. For more information, see the [`actions`](https://github.com/actions) and [`github`](https://github.com/github) organizations.
- **Allow Marketplace actions by verified creators:** You can allow all {% data variables.product.prodname_marketplace %} actions created by verified creators to be used by workflows. When GitHub has verified the creator of the action as a partner organization, the {% octicon "verified" aria-label="The verified badge" %} badge is displayed next to the action in {% data variables.product.prodname_marketplace %}.
diff --git a/data/reusables/actions/enterprise-beta.md b/data/reusables/actions/enterprise-beta.md
index 30eac75a9196..5c456da70dfd 100644
--- a/data/reusables/actions/enterprise-beta.md
+++ b/data/reusables/actions/enterprise-beta.md
@@ -1,4 +1,4 @@
-{% if currentVersion != "free-pro-team@latest" and currentVersion == "enterprise-server@2.22" %}
+{% if enterpriseServerVersions contains currentVersion and currentVersion == "enterprise-server@2.22" %}
{% note %}
**Note:** {% data variables.product.prodname_actions %} support on {% data variables.product.prodname_ghe_server %} 2.22 is a limited public beta. To review the external storage requirements and request access to the beta, see "[Enabling {% data variables.product.prodname_actions %} and configuring storage](/enterprise/admin/github-actions/enabling-github-actions-and-configuring-storage)."
diff --git a/data/reusables/actions/enterprise-github-hosted-runners.md b/data/reusables/actions/enterprise-github-hosted-runners.md
index 178bf09abe72..948121d88157 100644
--- a/data/reusables/actions/enterprise-github-hosted-runners.md
+++ b/data/reusables/actions/enterprise-github-hosted-runners.md
@@ -1,4 +1,4 @@
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_gt "enterprise-server@2.21" %}
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" %}
{% note %}
**Note:** {% data variables.product.prodname_dotcom %}-hosted runners are not currently supported on {% data variables.product.prodname_ghe_server %}. You can see more information about planned future support on the [{% data variables.product.prodname_roadmap %}](https://github.com/github/roadmap/issues/72).
diff --git a/data/reusables/actions/enterprise-marketplace-actions.md b/data/reusables/actions/enterprise-marketplace-actions.md
index 5b5987de4b7e..6d326f2fb2c9 100644
--- a/data/reusables/actions/enterprise-marketplace-actions.md
+++ b/data/reusables/actions/enterprise-marketplace-actions.md
@@ -1,4 +1,4 @@
-{% if currentVersion != "free-pro-team@latest" %}
+{% if enterpriseServerVersions contains currentVersion %}
{% note %}
diff --git a/data/reusables/actions/enterprise-setup-prereq.md b/data/reusables/actions/enterprise-setup-prereq.md
index 3ead3e20f902..664651119243 100644
--- a/data/reusables/actions/enterprise-setup-prereq.md
+++ b/data/reusables/actions/enterprise-setup-prereq.md
@@ -1,4 +1,4 @@
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_gt "enterprise-server@2.21" %}
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" %}
#### Using self-hosted runners on {% data variables.product.prodname_ghe_server %}
diff --git a/data/reusables/apps/deprecating_auth_with_query_parameters.md b/data/reusables/apps/deprecating_auth_with_query_parameters.md
index c7642634c7eb..07fd7f59418b 100644
--- a/data/reusables/apps/deprecating_auth_with_query_parameters.md
+++ b/data/reusables/apps/deprecating_auth_with_query_parameters.md
@@ -1,9 +1,9 @@
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %}
{% warning %}
**Deprecation Notice:** {% data variables.product.prodname_dotcom %} will discontinue authentication to the API using query parameters. Authenticating to the API should be done with [HTTP basic authentication](/v3/auth/#via-oauth-and-personal-access-tokens).{% if currentVersion == "free-pro-team@latest" %} Using query parameters to authenticate to the API will no longer work on May 5, 2021. {% endif %} For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-10-deprecating-auth-through-query-param/).
-{% if currentVersion != "free-pro-team@latest" %} Authentication to the API using query parameters while available is no longer supported due to security concerns. Instead we recommend integrators move their access token, `client_id`, or `client_secret` in the header. {% data variables.product.prodname_dotcom %} will announce the removal of authentication by query parameters with advanced notice. {% endif %}
+{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} Authentication to the API using query parameters while available is no longer supported due to security concerns. Instead we recommend integrators move their access token, `client_id`, or `client_secret` in the header. {% data variables.product.prodname_dotcom %} will announce the removal of authentication by query parameters with advanced notice. {% endif %}
{% endwarning %}
{% endif %}
diff --git a/data/reusables/apps/deprecating_github_services_ghe.md b/data/reusables/apps/deprecating_github_services_ghe.md
index ebdcd4af063d..72e5d399fbb1 100644
--- a/data/reusables/apps/deprecating_github_services_ghe.md
+++ b/data/reusables/apps/deprecating_github_services_ghe.md
@@ -1,4 +1,4 @@
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.20" %}
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.20" %}
{% note %}
**Note:** GitHub Enterprise release 2.17 and higher no longer allows admins to install new GitHub Services, and existing services will stop working in GitHub Enterprise release 2.20 and higher. You can use the [Replacing GitHub Services guide](/v3/guides/replacing-github-services) to help you update your services to webhooks.
diff --git a/data/reusables/apps/deprecating_password_auth.md b/data/reusables/apps/deprecating_password_auth.md
index d10ba259e186..402d3b14b62f 100644
--- a/data/reusables/apps/deprecating_password_auth.md
+++ b/data/reusables/apps/deprecating_password_auth.md
@@ -1,9 +1,9 @@
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %}
{% warning %}
**Deprecation Notice:** {% data variables.product.prodname_dotcom %} will discontinue password authentication to the API. You must now authenticate to the {% data variables.product.prodname_dotcom %} API with an API token, such as an OAuth access token, GitHub App installation access token, or personal access token, depending on what you need to do with the token.{% if currentVersion == "free-pro-team@latest" %} Password authentication to the API will be removed on November 13, 2020.{% endif %} For more information,{% if currentVersion == "free-pro-team@latest" %} including scheduled brownouts,{% endif %} see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-password-auth/).
-{% if currentVersion != "free-pro-team@latest" %} Authenticating to the API using a password is currently available and not yet deprecated in {% data variables.product.prodname_ghe_server %}. {% data variables.product.prodname_dotcom %} will announce the deprecation and provide advanced notice before removing support for this feature.{% endif %}
+{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} Authenticating to the API using a password is currently available and not yet deprecated in {% data variables.product.product_name %}. {% data variables.product.prodname_dotcom %} will announce the deprecation and provide advanced notice before removing support for this feature.{% endif %}
{% endwarning %}
{% endif %}
diff --git a/data/reusables/apps/deprecating_token_oauth_authorizations.md b/data/reusables/apps/deprecating_token_oauth_authorizations.md
index 933bdb4aea63..030d31cf89f6 100644
--- a/data/reusables/apps/deprecating_token_oauth_authorizations.md
+++ b/data/reusables/apps/deprecating_token_oauth_authorizations.md
@@ -1,4 +1,4 @@
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.20" %}
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.20" %}
{% warning %}
**Deprecation Notice:** The `token` attribute is deprecated in some OAuth Authorizations API responses:
diff --git a/data/reusables/apps/expiring_user_authorization_tokens.md b/data/reusables/apps/expiring_user_authorization_tokens.md
index 48f37e42e067..a51d6a2083c1 100644
--- a/data/reusables/apps/expiring_user_authorization_tokens.md
+++ b/data/reusables/apps/expiring_user_authorization_tokens.md
@@ -1,3 +1,3 @@
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}
To keep user-to-server access tokens more secure, you can use access tokens that will expire after 8 hours, and a refresh token that can be exchanged for a new access token. For more information, see "[Refreshing user-to-server access tokens](/apps/building-github-apps/refreshing-user-to-server-access-tokens/)."
{% endif %}
diff --git a/data/reusables/branches/set-default-branch.md b/data/reusables/branches/set-default-branch.md
index f5ff905d85ca..20d94881f66d 100644
--- a/data/reusables/branches/set-default-branch.md
+++ b/data/reusables/branches/set-default-branch.md
@@ -1 +1 @@
-You can set the name of the default branch for new repositories. For more information, see "[Managing the default branch for your repositories](/github/setting-up-and-managing-your-github-user-account/managing-the-default-branch-name-for-your-repositories)," "[Managing the default branch name for repositories in your organization](/github/setting-up-and-managing-organizations-and-teams/managing-the-default-branch-name-for-repositories-in-your-organization)," or "[Enforcing a policy on the default branch name](/github/setting-up-and-managing-your-enterprise-account/enforcing-repository-management-policies-in-your-enterprise-account#enforcing-a-policy-on-the-default-branch-name)."
+You can set the name of the default branch for new repositories. For more information, see "[Managing the default branch for your repositories](/github/setting-up-and-managing-your-github-user-account/managing-the-default-branch-name-for-your-repositories)," "[Managing the default branch name for repositories in your organization](/github/setting-up-and-managing-organizations-and-teams/managing-the-default-branch-name-for-repositories-in-your-organization)," and {% if currentVersion == "free-pro-team@latest" %}"[Enforcing repository management policies in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-repository-management-policies-in-your-enterprise-account#enforcing-a-policy-on-the-default-branch-name)."{% else %}"[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-on-the-default-branch-name)."{% endif %}
diff --git a/data/reusables/cli/filter-issues-and-pull-requests-tip.md b/data/reusables/cli/filter-issues-and-pull-requests-tip.md
index 949b7938dbd4..efa57873ee21 100644
--- a/data/reusables/cli/filter-issues-and-pull-requests-tip.md
+++ b/data/reusables/cli/filter-issues-and-pull-requests-tip.md
@@ -1,4 +1,4 @@
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %}
{% tip %}
**Tip**: You can also filter issues or pull requests using the {% data variables.product.prodname_cli %}. For more information, see "[`gh issue list`](https://cli.github.com/manual/gh_issue_list)" or "[`gh pr list`](https://cli.github.com/manual/gh_pr_list)" in the {% data variables.product.prodname_cli %} documentation.
diff --git a/data/reusables/code-scanning/about-code-scanning.md b/data/reusables/code-scanning/about-code-scanning.md
index 70df68d69b81..054042ee8c75 100644
--- a/data/reusables/code-scanning/about-code-scanning.md
+++ b/data/reusables/code-scanning/about-code-scanning.md
@@ -1 +1 @@
-{% data variables.product.prodname_code_scanning_capc %} is a feature that you use to analyze the code in a {% data variables.product.prodname_dotcom %} repository to find security vulnerabilities and coding errors. Any problems identified by the analysis are shown in {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_ghe_server %}{% else %}{% data variables.product.prodname_dotcom %}{% endif %}.
+{% data variables.product.prodname_code_scanning_capc %} is a feature that you use to analyze the code in a {% data variables.product.prodname_dotcom %} repository to find security vulnerabilities and coding errors. Any problems identified by the analysis are shown in {% if currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}{% data variables.product.prodname_ghe_server %}{% else %}{% data variables.product.prodname_dotcom %}{% endif %}.
diff --git a/data/reusables/code-scanning/beta.md b/data/reusables/code-scanning/beta.md
index f3ecf073dd26..8b9209f1ea76 100644
--- a/data/reusables/code-scanning/beta.md
+++ b/data/reusables/code-scanning/beta.md
@@ -1,4 +1,4 @@
-{% if currentVersion == "enterprise-server@2.22" %}
+{% if currentVersion == "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}
{% note %}
diff --git a/data/reusables/code-scanning/click-alert-in-list.md b/data/reusables/code-scanning/click-alert-in-list.md
new file mode 100644
index 000000000000..314164be4219
--- /dev/null
+++ b/data/reusables/code-scanning/click-alert-in-list.md
@@ -0,0 +1,2 @@
+1. Under "Code scanning," click the alert you'd like to explore.
+ 
diff --git a/data/reusables/code-scanning/enterprise-enable-code-scanning-actions.md b/data/reusables/code-scanning/enterprise-enable-code-scanning-actions.md
index 5612481d72c8..94a6b63b955b 100644
--- a/data/reusables/code-scanning/enterprise-enable-code-scanning-actions.md
+++ b/data/reusables/code-scanning/enterprise-enable-code-scanning-actions.md
@@ -2,7 +2,7 @@
{% note %}
-**Note:** Your site administrator must enable {% data variables.product.prodname_code_scanning %} for {% data variables.product.product_location_enterprise %} before you can use this feature. If you want to use {% data variables.product.prodname_actions %} to scan your code, the site administrator must also enable {% data variables.product.prodname_actions %} and set up the infrastructure required. For more information, see "[Configuring {% data variables.product.prodname_code_scanning %} for your appliance](/enterprise/admin/configuration/configuring-code-scanning-for-your-appliance)."
+**Note:** Your site administrator must enable {% data variables.product.prodname_code_scanning %} for {% data variables.product.product_location %} before you can use this feature. If you want to use {% data variables.product.prodname_actions %} to scan your code, the site administrator must also enable {% data variables.product.prodname_actions %} and set up the infrastructure required. For more information, see "[Configuring {% data variables.product.prodname_code_scanning %} for your appliance](/enterprise/admin/configuration/configuring-code-scanning-for-your-appliance)."
{% endnote %}
diff --git a/data/reusables/code-scanning/enterprise-enable-code-scanning.md b/data/reusables/code-scanning/enterprise-enable-code-scanning.md
index c23014293889..b099f6ba3bd8 100644
--- a/data/reusables/code-scanning/enterprise-enable-code-scanning.md
+++ b/data/reusables/code-scanning/enterprise-enable-code-scanning.md
@@ -2,7 +2,7 @@
{% note %}
-**Note:** Your site administrator must enable {% data variables.product.prodname_code_scanning %} for {% data variables.product.product_location_enterprise %} before you can use this feature. For more information, see "[Configuring {% data variables.product.prodname_code_scanning %} for your appliance](/enterprise/admin/configuration/configuring-code-scanning-for-your-appliance)."
+**Note:** Your site administrator must enable {% data variables.product.prodname_code_scanning %} for {% data variables.product.product_location %} before you can use this feature. For more information, see "[Configuring {% data variables.product.prodname_code_scanning %} for your appliance](/enterprise/admin/configuration/configuring-code-scanning-for-your-appliance)."
{% endnote %}
diff --git a/data/reusables/code-scanning/false-positive-fix-codeql.md b/data/reusables/code-scanning/false-positive-fix-codeql.md
index 116630a498fe..011f129f1224 100644
--- a/data/reusables/code-scanning/false-positive-fix-codeql.md
+++ b/data/reusables/code-scanning/false-positive-fix-codeql.md
@@ -1 +1 @@
-If you dismiss a {% data variables.product.prodname_codeql %} alert as a false positive result, for example because the code uses a sanitization library that isn't supported, consider contributing to the {% data variables.product.prodname_codeql %} repository and improving the analysis. For more information about {% data variables.product.prodname_codeql %}, see "[Contributing to {% data variables.product.prodname_codeql %}](https://github.com/github/codeql/blob/main/CONTRIBUTING.md)."
+If you {% if currentVersion == "enterprise-server@2.22" %}close{% else %}dismiss{% endif %} a {% data variables.product.prodname_codeql %} alert as a false positive result, for example because the code uses a sanitization library that isn't supported, consider contributing to the {% data variables.product.prodname_codeql %} repository and improving the analysis. For more information about {% data variables.product.prodname_codeql %}, see "[Contributing to {% data variables.product.prodname_codeql %}](https://github.com/github/codeql/blob/main/CONTRIBUTING.md)."
diff --git a/data/reusables/community/interaction-limits-duration.md b/data/reusables/community/interaction-limits-duration.md
new file mode 100644
index 000000000000..fb858accd841
--- /dev/null
+++ b/data/reusables/community/interaction-limits-duration.md
@@ -0,0 +1 @@
+When you enable an interaction limit, you can choose a duration for the limit: 24 hours, 3 days, 1 week, 1 month, or 6 months.
\ No newline at end of file
diff --git a/data/reusables/community/interaction-limits-restrictions.md b/data/reusables/community/interaction-limits-restrictions.md
new file mode 100644
index 000000000000..1be2648d1626
--- /dev/null
+++ b/data/reusables/community/interaction-limits-restrictions.md
@@ -0,0 +1 @@
+Enabling an interaction limit for a repository restricts certain users from commenting, opening issues, creating pull requests, reacting with emojis, editing existing comments, and editing titles of issues and pull requests.
\ No newline at end of file
diff --git a/data/reusables/community/set-interaction-limit.md b/data/reusables/community/set-interaction-limit.md
new file mode 100644
index 000000000000..468a068f7090
--- /dev/null
+++ b/data/reusables/community/set-interaction-limit.md
@@ -0,0 +1 @@
+5. Under "Temporary interaction limits", to the right of the type of interaction limit you want to set, use the **Enable** drop-down menu, then click the duration you want for your interaction limit.
\ No newline at end of file
diff --git a/data/reusables/community/types-of-interaction-limits.md b/data/reusables/community/types-of-interaction-limits.md
new file mode 100644
index 000000000000..67967a2fa25d
--- /dev/null
+++ b/data/reusables/community/types-of-interaction-limits.md
@@ -0,0 +1,4 @@
+There are three types of interaction limits.
+ - **Limit to existing users**: Limits activity for users with accounts that are less than 24 hours old who do not have prior contributions and are not collaborators.
+ - **Limit to prior contributors**: Limits activity for users who have not previously contributed to the default branch of the repository and are not collaborators.
+ - **Limit to repository collaborators**: Limits activity for users who do not have write access to the repository.
\ No newline at end of file
diff --git a/data/reusables/dependabot/upgrade-dependency-to-minimum-secure-version.md b/data/reusables/dependabot/automated-tests-note.md
similarity index 80%
rename from data/reusables/dependabot/upgrade-dependency-to-minimum-secure-version.md
rename to data/reusables/dependabot/automated-tests-note.md
index 52127e64ed30..1f15a27f8e03 100644
--- a/data/reusables/dependabot/upgrade-dependency-to-minimum-secure-version.md
+++ b/data/reusables/dependabot/automated-tests-note.md
@@ -1,5 +1,3 @@
-The pull request will upgrade the dependency to the minimum possible secure version needed to avoid the vulnerability.
-
{% note %}
**Note:** It's good practice to have automated tests and acceptance processes in place so that checks are carried out before the pull request is merged. This is particularly important if the suggested version to upgrade to contains additional functionality, or a change that breaks your project's code. For more information about continuous integration, see "[About continuous integration](/actions/building-and-testing-code-with-continuous-integration/about-continuous-integration)."
diff --git a/data/reusables/dependabot/click-dependabot-tab.md b/data/reusables/dependabot/click-dependabot-tab.md
index 787f9870693f..81f569ccc647 100644
--- a/data/reusables/dependabot/click-dependabot-tab.md
+++ b/data/reusables/dependabot/click-dependabot-tab.md
@@ -1,2 +1,2 @@
-4. Under "Dependency graph", click **{% data variables.product.prodname_dependabot_short %}**.
- 
+4. Under "Dependency graph", click **{% data variables.product.prodname_dependabot %}**.
+ 
diff --git a/data/reusables/dependabot/default-labels.md b/data/reusables/dependabot/default-labels.md
index 00fa428e678f..9294fb86c13e 100644
--- a/data/reusables/dependabot/default-labels.md
+++ b/data/reusables/dependabot/default-labels.md
@@ -1 +1 @@
-By default, {% data variables.product.prodname_dependabot %} raises all pull requests with the `dependencies` label. If more than one package manager is defined, {% data variables.product.prodname_dependabot_short %} includes an additional label on each pull request. This indicates which language or ecosystem the pull request will update, for example: `java` for Gradle updates and `submodules` for git submodule updates. {% data variables.product.prodname_dependabot %} creates these default labels automatically, as necessary in your repository.
+By default, {% data variables.product.prodname_dependabot %} raises all pull requests with the `dependencies` label. If more than one package manager is defined, {% data variables.product.prodname_dependabot %} includes an additional label on each pull request. This indicates which language or ecosystem the pull request will update, for example: `java` for Gradle updates and `submodules` for git submodule updates. {% data variables.product.prodname_dependabot %} creates these default labels automatically, as necessary in your repository.
diff --git a/data/reusables/dependabot/initial-updates.md b/data/reusables/dependabot/initial-updates.md
index 869d31ff848e..fe4154576b85 100644
--- a/data/reusables/dependabot/initial-updates.md
+++ b/data/reusables/dependabot/initial-updates.md
@@ -1,3 +1,3 @@
When you first enable version updates, you may have many dependencies that are outdated and some may be many versions behind the latest version. {% data variables.product.prodname_dependabot %} checks for outdated dependencies as soon as it's enabled. You may see new pull requests for version updates within minutes of adding the configuration file, depending on the number of manifest files for which you configure updates.
-To keep pull requests manageable and easy to review, {% data variables.product.prodname_dependabot_short %} raises a maximum of five pull requests to start bringing dependencies up to the latest version. If you merge some of these first pull requests before the next scheduled update, then further pull requests are opened up to a maximum of five (you can change this limit).
+To keep pull requests manageable and easy to review, {% data variables.product.prodname_dependabot %} raises a maximum of five pull requests to start bringing dependencies up to the latest version. If you merge some of these first pull requests before the next scheduled update, then further pull requests are opened up to a maximum of five (you can change this limit).
diff --git a/data/reusables/dependabot/private-dependencies.md b/data/reusables/dependabot/private-dependencies.md
index dfcbae9c7300..717f1dbb9746 100644
--- a/data/reusables/dependabot/private-dependencies.md
+++ b/data/reusables/dependabot/private-dependencies.md
@@ -1 +1 @@
-Currently, {% data variables.product.prodname_dependabot_version_updates %} doesn't support manifest or lock files that contain any private git dependencies or private git registries. This is because, when running version updates, {% data variables.product.prodname_dependabot_short %} must be able to resolve all dependencies from their source to verify that version updates have been successful.
+Currently, {% data variables.product.prodname_dependabot_version_updates %} doesn't support manifest or lock files that contain any private git dependencies or private git registries. This is because, when running version updates, {% data variables.product.prodname_dependabot %} must be able to resolve all dependencies from their source to verify that version updates have been successful.
diff --git a/data/reusables/dependabot/pull-request-introduction.md b/data/reusables/dependabot/pull-request-introduction.md
new file mode 100644
index 000000000000..86b8dd0cf363
--- /dev/null
+++ b/data/reusables/dependabot/pull-request-introduction.md
@@ -0,0 +1 @@
+{% data variables.product.prodname_dependabot %} raises pull requests to update dependencies. Depending on how your repository is configured, {% data variables.product.prodname_dependabot %} may raise pull requests for version updates and/or for security updates. You manage these pull requests in the same way as any other pull request, but there are also some extra commands available. For information about enabling {% data variables.product.prodname_dependabot %} dependency updates, see "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-dependabot-security-updates)" and "[Enabling and disabling version updates](/github/administering-a-repository/enabling-and-disabling-version-updates)."
\ No newline at end of file
diff --git a/data/reusables/dependabot/supported-package-managers.md b/data/reusables/dependabot/supported-package-managers.md
index e1a515bb151a..9c62f5656fd0 100644
--- a/data/reusables/dependabot/supported-package-managers.md
+++ b/data/reusables/dependabot/supported-package-managers.md
@@ -7,7 +7,7 @@ Docker: `docker` |
Elm: `elm` |
git submodule: `gitsubmodule` |
GitHub Actions: `github-actions` |
-Go modules: `gomod` |
+Go modules: `gomod` | **X**
Gradle: `gradle` |
Maven: `maven` |
Mix: `mix` |
@@ -18,12 +18,12 @@ Terraform: `terraform` |
{% note %}
-**Note**: {% data variables.product.prodname_dependabot_short %} also supports the following package managers:
+**Note**: {% data variables.product.prodname_dependabot %} also supports the following package managers:
-`yarn` (v1 only) (specify `npm`)
-`pipenv`, `pip-compile`, and `poetry` (specify `pip`)
-For example, if you use `poetry` to manage your Python dependencies and want {% data variables.product.prodname_dependabot_short %} to monitor your dependency manifest file for new versions, use `package-ecosystem: "pip"` in your *dependabot.yml* file.
+For example, if you use `poetry` to manage your Python dependencies and want {% data variables.product.prodname_dependabot %} to monitor your dependency manifest file for new versions, use `package-ecosystem: "pip"` in your *dependabot.yml* file.
{% endnote %}
diff --git a/data/reusables/dependabot/version-updates-for-actions.md b/data/reusables/dependabot/version-updates-for-actions.md
index 3b63e3586d5f..f00b76cfe20d 100644
--- a/data/reusables/dependabot/version-updates-for-actions.md
+++ b/data/reusables/dependabot/version-updates-for-actions.md
@@ -1 +1 @@
-You can also enable {% data variables.product.prodname_dependabot_version_updates %} for the actions that you add to your workflow. For more information, see "[Keeping your actions up to date with {% data variables.product.prodname_dependabot %}](/github/administering-a-repository/keeping-your-actions-up-to-date-with-github-dependabot)."
+You can also enable {% data variables.product.prodname_dependabot_version_updates %} for the actions that you add to your workflow. For more information, see "[Keeping your actions up to date with {% data variables.product.prodname_dependabot %}](/github/administering-a-repository/keeping-your-actions-up-to-date-with-dependabot)."
diff --git a/data/reusables/enterprise-accounts/access-enterprise.md b/data/reusables/enterprise-accounts/access-enterprise.md
index eab147566452..a84682fa0ff6 100644
--- a/data/reusables/enterprise-accounts/access-enterprise.md
+++ b/data/reusables/enterprise-accounts/access-enterprise.md
@@ -1,20 +1,12 @@
-{% if currentVersion == "free-pro-team@latest" %}
-
-1. In the top-right corner of {% data variables.product.product_name %}, click your profile photo, then click **Your enterprises**.
+{% if currentVersion == "free-pro-team@latest" %}1. In the top-right corner of {% data variables.product.product_name %}, click your profile photo, then click **Your enterprises**.
1. In the list of enterprises, click the enterprise you want to view.
-{% endif %}
-
-{% if currentVersion ver_lt "enterprise-server@2.22" %}
-
-1. Navigate to your enterprise account by visiting {% raw %}https://HOSTNAME/enterprises/ENTERPRISE-NAME{% endraw %}, replacing `HOSTNAME` with your instance's hostname and `ENTERPRISE-NAME` with your enterprise account's name.
-
-{% elsif enterpriseServerVersions contains currentVersion %}
+{% elsif currentVersion ver_lt "enterprise-server@2.22" %}1. Navigate to your enterprise account by visiting {% raw %}https://HOSTNAME/enterprises/ENTERPRISE-NAME{% endraw %}, replacing `HOSTNAME` with your instance's hostname and `ENTERPRISE-NAME` with your enterprise account's name.
-1. In the top-right corner of {% data variables.product.product_name %}, click your profile photo, then click **Enterprise settings**.
+{% elsif enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}1. In the top-right corner of {% data variables.product.product_name %}, click your profile photo, then click **Enterprise settings**.
{% endif %}
diff --git a/data/reusables/enterprise-accounts/enterprise-accounts-billing.md b/data/reusables/enterprise-accounts/enterprise-accounts-billing.md
index d8656bd45b9f..cd4984777d60 100644
--- a/data/reusables/enterprise-accounts/enterprise-accounts-billing.md
+++ b/data/reusables/enterprise-accounts/enterprise-accounts-billing.md
@@ -1 +1 @@
-Enterprise accounts are currently available to {% data variables.product.prodname_ghe_cloud %} and {% data variables.product.prodname_ghe_server %} customers paying by invoice. Billing for all of the organizations and {% data variables.product.prodname_ghe_server %} instances connected to your enterprise account is aggregated into a single bill. For more information about managing your {% data variables.product.prodname_ghe_cloud %} subscription, see "[Viewing the subscription and usage for your enterprise account](/articles/viewing-the-subscription-and-usage-for-your-enterprise-account)." For more information about managing your {% data variables.product.prodname_ghe_server %} billing settings, see "[Managing billing for {% data variables.product.prodname_enterprise %}](/enterprise/admin/installation/managing-billing-for-github-enterprise)."
+Enterprise accounts are currently available to {% data variables.product.prodname_ghe_cloud %} and {% data variables.product.prodname_ghe_server %} customers paying by invoice. Billing for all of the organizations and {% data variables.product.prodname_ghe_server %} instances connected to your enterprise account is aggregated into a single bill. For more information about managing your {% data variables.product.prodname_ghe_cloud %} subscription, see "[Viewing the subscription and usage for your enterprise account](/articles/viewing-the-subscription-and-usage-for-your-enterprise-account)." For more information about managing your {% data variables.product.prodname_ghe_server %} billing settings, see "[Managing billing for your enterprise](/admin/overview/managing-billing-for-your-enterprise)."
diff --git a/data/reusables/enterprise-accounts/enterprise-administrators.md b/data/reusables/enterprise-accounts/enterprise-administrators.md
index ba2dbb7550d6..b4d889bf0079 100644
--- a/data/reusables/enterprise-accounts/enterprise-administrators.md
+++ b/data/reusables/enterprise-accounts/enterprise-administrators.md
@@ -1 +1 @@
-Currently, there are two administrative roles available in enterprise accounts: enterprise owners, who can access and manage all settings across the account, and billing managers, who can access and manage only the enterprise account's billing settings. Enterprise owners can also see all of the members and outside collaborators for every organization owned by the enterprise account.
+{% if enterpriseServerVersions contains currentVersion or currentVersion == "free-pro-team@latest" %}Currently, there are two administrative roles available in enterprises: enterprise owners, who can access and manage all settings across the enterprise, and billing managers, who can access and manage only the enterprise's billing settings. {% endif %}Enterprise owners can {% if enterpriseServerVersions contains currentVersion or currentVersion == "free-pro-team@latest" %}also {% endif %} see all of the members and outside collaborators for every organization owned by the enterprise.
diff --git a/data/reusables/enterprise-accounts/options-tab.md b/data/reusables/enterprise-accounts/options-tab.md
index 43d6fdb68dd2..572d7f72ad04 100644
--- a/data/reusables/enterprise-accounts/options-tab.md
+++ b/data/reusables/enterprise-accounts/options-tab.md
@@ -1,2 +1,2 @@
-1. Under {% if currentVersion ver_gt "enterprise-server@2.21" %} {% octicon "law" aria-label="The law icon" %} **Policies**{% else %}"{% octicon "gear" aria-label="The Settings gear" %} Settings"{% endif %}, click **Options**.
+1. Under {% if currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %} {% octicon "law" aria-label="The law icon" %} **Policies**{% else %}"{% octicon "gear" aria-label="The Settings gear" %} Settings"{% endif %}, click **Options**.
diff --git a/data/reusables/enterprise-accounts/pages-policies-save.md b/data/reusables/enterprise-accounts/pages-policies-save.md
new file mode 100644
index 000000000000..4df7ee9b90d0
--- /dev/null
+++ b/data/reusables/enterprise-accounts/pages-policies-save.md
@@ -0,0 +1,2 @@
+ 6. Click **Save**.
+ 
diff --git a/data/reusables/enterprise-accounts/pages-tab.md b/data/reusables/enterprise-accounts/pages-tab.md
new file mode 100644
index 000000000000..cbefd2fecc5b
--- /dev/null
+++ b/data/reusables/enterprise-accounts/pages-tab.md
@@ -0,0 +1,2 @@
+1. Under "{% octicon "law" aria-label="The law icon" %} Policies", click **Pages**.
+ 
\ No newline at end of file
diff --git a/data/reusables/enterprise-managed/about-billing.md b/data/reusables/enterprise-managed/about-billing.md
new file mode 100644
index 000000000000..9e7ed843b20d
--- /dev/null
+++ b/data/reusables/enterprise-managed/about-billing.md
@@ -0,0 +1 @@
+You will receive a monthly bill for {% data variables.product.prodname_ghe_managed %}, with charges that are calculated per licensed user per day.
\ No newline at end of file
diff --git a/data/reusables/enterprise/rate_limit.md b/data/reusables/enterprise/rate_limit.md
index dd52413e463c..22b12abd0467 100644
--- a/data/reusables/enterprise/rate_limit.md
+++ b/data/reusables/enterprise/rate_limit.md
@@ -1,3 +1,3 @@
-{% if currentVersion != "free-pro-team@latest" %}
-Note that the limits mentioned above are the default rate limits for a {% data variables.product.prodname_ghe_server %} instance. Contact your site administrator to confirm if rate limits are enabled and how they are configured.
+{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
+Note that the limits mentioned above are the default rate limits for {% data variables.product.product_name %}. Contact your site administrator to confirm if rate limits are enabled and how they are configured.
{% endif %}
diff --git a/data/reusables/enterprise_enterprise_support/installing-releases.md b/data/reusables/enterprise_enterprise_support/installing-releases.md
index eda56ca02aa6..e55d5f908489 100644
--- a/data/reusables/enterprise_enterprise_support/installing-releases.md
+++ b/data/reusables/enterprise_enterprise_support/installing-releases.md
@@ -1,3 +1,3 @@
### Installing {% data variables.product.prodname_ghe_server %} releases
-To ensure that {% data variables.product.product_location_enterprise %} is stable, you must install and implement {% data variables.product.prodname_ghe_server %} releases. Installing {% data variables.product.prodname_ghe_server %} releases ensures that you have the latest features, modifications, and enhancements as well as any updates to features, code corrections, patches or other general updates and fixes to {% data variables.product.prodname_ghe_server %}.
+To ensure that {% data variables.product.product_location %} is stable, you must install and implement {% data variables.product.prodname_ghe_server %} releases. Installing {% data variables.product.prodname_ghe_server %} releases ensures that you have the latest features, modifications, and enhancements as well as any updates to features, code corrections, patches or other general updates and fixes to {% data variables.product.prodname_ghe_server %}.
diff --git a/data/reusables/enterprise_enterprise_support/submit-support-ticket-first-section.md b/data/reusables/enterprise_enterprise_support/submit-support-ticket-first-section.md
index 32270b1250b5..27e5a4d28a45 100644
--- a/data/reusables/enterprise_enterprise_support/submit-support-ticket-first-section.md
+++ b/data/reusables/enterprise_enterprise_support/submit-support-ticket-first-section.md
@@ -14,7 +14,7 @@
- Choose **{% data variables.product.support_ticket_priority_urgent %}** to report {% if currentVersion == "free-pro-team@latest" %}critical system failure{% else %}fatal system failures, outages impacting critical system operations, security incidents, and expired licenses{% endif %}.
- Choose **{% data variables.product.support_ticket_priority_high %}** to report issues impacting business operations, including {% if currentVersion == "free-pro-team@latest" %}removing sensitive data (commits, issues, pull requests, uploaded attachments) from your own accounts and organization restorations{% else %}system performance issues{% endif %}, or to report critical bugs.
- Choose **{% data variables.product.support_ticket_priority_normal %}** to {% if currentVersion == "free-pro-team@latest" %}request account recovery or spam unflagging, report user login issues{% else %}make technical requests like configuration changes and third-party integrations{% endif %}, and to report non-critical bugs.
- - Choose **{% data variables.product.support_ticket_priority_low %}** to ask general questions and submit requests for new features, purchases, training, or health checks.{% if currentVersion != "free-pro-team@latest" %}
+ - Choose **{% data variables.product.support_ticket_priority_low %}** to ask general questions and submit requests for new features, purchases, training, or health checks.{% if enterpriseServerVersions contains currentVersion %}
1. From the "{% data variables.product.prodname_enterprise %} Series" drop-down menu, select the version of {% data variables.product.prodname_ghe_server %} you're using.
{% endif %}
diff --git a/data/reusables/enterprise_enterprise_support/submit-support-ticket-second-section.md b/data/reusables/enterprise_enterprise_support/submit-support-ticket-second-section.md
index cd04bf7ee758..aff7f808da3f 100644
--- a/data/reusables/enterprise_enterprise_support/submit-support-ticket-second-section.md
+++ b/data/reusables/enterprise_enterprise_support/submit-support-ticket-second-section.md
@@ -1,4 +1,4 @@
1. Click **Submit**.
-{% if currentVersion != "free-pro-team@latest" %}
+{% if enterpriseServerVersions contains currentVersion %}
If you chose not to include diagnostics with your support ticket, you can share diagnostic information with {% data variables.product.prodname_enterprise %} Support after submitting your support request. For more information, see "[Providing data to {% data variables.product.prodname_dotcom %} Support](/enterprise/admin/guides/enterprise-support/providing-data-to-github-support)."{% endif %}
diff --git a/data/reusables/enterprise_installation/aws-recommended-instance-types.md b/data/reusables/enterprise_installation/aws-recommended-instance-types.md
index ae0c13944551..469b0fe1442a 100644
--- a/data/reusables/enterprise_installation/aws-recommended-instance-types.md
+++ b/data/reusables/enterprise_installation/aws-recommended-instance-types.md
@@ -1,6 +1,6 @@
Based on your user license count, we recommend the following instance types.
-{% if currentVersion != "free-pro-team@latest" %}
+{% if enterpriseServerVersions contains currentVersion %}
| User licenses | Recommended type |
| :- | -: |
| Trial, demo, or 10 light users | r4.large |
diff --git a/data/reusables/enterprise_installation/aws-supported-instance-types.md b/data/reusables/enterprise_installation/aws-supported-instance-types.md
index 192e6cf1c016..2c5a7a83dde0 100644
--- a/data/reusables/enterprise_installation/aws-supported-instance-types.md
+++ b/data/reusables/enterprise_installation/aws-supported-instance-types.md
@@ -30,7 +30,7 @@
| EC2 instance type | Model |
| ----------------- | ----- |
-| R5 | r5.large, r5.xlarge, r5.2xlarge, r5.4xlarge, r5.12xlarge, r5.24xlarge{% if currentVersion != "free-pro-team@latest" and currentVersion ver_gt "enterprise-server@2.19" %}, r5n.large, r5n.xlarge, r5n.2xlarge, r5n.4xlarge, r5n.12xlarge, r5n.24xlarge, r5a.large, r5a.xlarge, r5a.2xlarge, r5a.4xlarge, r5a.12xlarge, r5a.24xlarge{% endif %} |
+| R5 | r5.large, r5.xlarge, r5.2xlarge, r5.4xlarge, r5.12xlarge, r5.24xlarge{% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.19" %}, r5n.large, r5n.xlarge, r5n.2xlarge, r5n.4xlarge, r5n.12xlarge, r5n.24xlarge, r5a.large, r5a.xlarge, r5a.2xlarge, r5a.4xlarge, r5a.12xlarge, r5a.24xlarge{% endif %} |
| EC2 instance type | Model |
| ----------------- | ----- |
diff --git a/data/reusables/enterprise_installation/disable-github-pages-warning.md b/data/reusables/enterprise_installation/disable-github-pages-warning.md
index e70581d8751c..ecac6ccacbf0 100644
--- a/data/reusables/enterprise_installation/disable-github-pages-warning.md
+++ b/data/reusables/enterprise_installation/disable-github-pages-warning.md
@@ -1,5 +1,7 @@
+{% if enterpriseServerVersions contains currentVersion %}
{% warning %}
-**Warning:** If subdomain isolation is disabled, we recommend also disabling {% data variables.product.prodname_pages %} on your appliance. There will be no way to isolate user-supplied {% data variables.product.prodname_pages %} content from the rest of your appliance's data. For more information, see "[Configuring {% data variables.product.prodname_pages %} on your appliance](/enterprise/admin/guides/installation/configuring-github-pages-on-your-appliance/)."
+**Warning:** If subdomain isolation is disabled, we recommend also disabling {% data variables.product.prodname_pages %} on your enterprise. There will be no way to isolate user-supplied {% data variables.product.prodname_pages %} content from the rest of your enterprise's data. For more information, see "[Configuring {% data variables.product.prodname_pages %} for your enterprise](/enterprise/admin/guides/installation/configuring-github-pages-for-your-enterprise/)."
{% endwarning %}
+{% endif %}
\ No newline at end of file
diff --git a/data/reusables/enterprise_installation/download-package.md b/data/reusables/enterprise_installation/download-package.md
index e9df23120520..6cc7a602ff50 100644
--- a/data/reusables/enterprise_installation/download-package.md
+++ b/data/reusables/enterprise_installation/download-package.md
@@ -1,4 +1,4 @@
-1. Download the upgrade package to {% data variables.product.product_location_enterprise %} using `curl `:
+1. Download the upgrade package to {% data variables.product.product_location %} using `curl `:
```shell
admin@HOSTNAME:~$ curl -L -O UPGRADE-PKG-URL
```
diff --git a/data/reusables/enterprise_installation/hardware-considerations-all-platforms.md b/data/reusables/enterprise_installation/hardware-considerations-all-platforms.md
index 4e1d98e183ff..796f0eaca886 100644
--- a/data/reusables/enterprise_installation/hardware-considerations-all-platforms.md
+++ b/data/reusables/enterprise_installation/hardware-considerations-all-platforms.md
@@ -4,11 +4,11 @@
#### Minimum requirements
-We recommend different hardware configurations depending on the number of user licenses for {% data variables.product.product_location_enterprise %}. If you provision more resources than the minimum requirements, your instance will perform and scale better.
+We recommend different hardware configurations depending on the number of user licenses for {% data variables.product.product_location %}. If you provision more resources than the minimum requirements, your instance will perform and scale better.
{% data reusables.enterprise_installation.hardware-rec-table %} For more information about adjusting resources for an existing instance, see "[Increasing storage capacity](/enterprise/admin/installation/increasing-storage-capacity)" and "[Increasing CPU or memory resources](/enterprise/admin/installation/increasing-cpu-or-memory-resources)."
-{% if currentVersion == "enterprise-server@2.22" %}
+{% if currentVersion == "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}
If you enable the beta for {% data variables.product.prodname_actions %} on your instance, we recommend planning for additional capacity.
@@ -32,7 +32,7 @@ We recommend a high-performance SSD with high input/output operations per second
Your instance requires a persistent data disk separate from the root disk. For more information, see "[System overview](/enterprise/admin/guides/installation/system-overview)."
-{% if currentVersion ver_gt "enterprise-server@2.21" %}
+{% if currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}
If you enable the beta of {% data variables.product.prodname_actions %} in {% data variables.product.prodname_ghe_server %} 2.22, you'll need to configure external blob storage. For more information, see "[Enabling {% data variables.product.prodname_actions %} and configuring storage](/enterprise/admin/github-actions/enabling-github-actions-and-configuring-storage)."
diff --git a/data/reusables/enterprise_installation/request-a-trial.md b/data/reusables/enterprise_installation/request-a-trial.md
index 79c161955ce9..b491981f85f2 100644
--- a/data/reusables/enterprise_installation/request-a-trial.md
+++ b/data/reusables/enterprise_installation/request-a-trial.md
@@ -1 +1 @@
-You can request a trial to evaluate {% data variables.product.prodname_ghe_server %}. For more information, see "[Setting up a trial of {% data variables.product.prodname_ghe_server %}](/articles/setting-up-a-trial-of-github-enterprise-server)."
+You can request a trial to evaluate {% data variables.product.prodname_ghe_server %}. For more information, see "Setting up a trial of {% data variables.product.prodname_ghe_server %}."
diff --git a/data/reusables/enterprise_installation/ssh-into-instance.md b/data/reusables/enterprise_installation/ssh-into-instance.md
index 2037f7413575..9dcd8e90d308 100644
--- a/data/reusables/enterprise_installation/ssh-into-instance.md
+++ b/data/reusables/enterprise_installation/ssh-into-instance.md
@@ -1,4 +1,4 @@
-1. SSH into {% data variables.product.product_location_enterprise %}.
+1. SSH into {% data variables.product.product_location %}.
```shell
$ ssh -p 122 admin@HOSTNAME
```
diff --git a/data/reusables/enterprise_management_console/enable-disable-code-scanning.md b/data/reusables/enterprise_management_console/enable-disable-code-scanning.md
index a6adf2088eba..4b1379243ea9 100644
--- a/data/reusables/enterprise_management_console/enable-disable-code-scanning.md
+++ b/data/reusables/enterprise_management_console/enable-disable-code-scanning.md
@@ -1,5 +1,5 @@
{% warning %}
-**Warning**: Changing this setting will cause {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_ghe_server %}{% else %}{% data variables.product.prodname_dotcom %}{% endif %} to restart. You should time this change carefully, to minimize downtime.
+**Warning**: Changing this setting will cause {% if currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}{% data variables.product.prodname_ghe_server %}{% else %}{% data variables.product.prodname_dotcom %}{% endif %} to restart. You should time this change carefully, to minimize downtime.
{% endwarning %}
diff --git a/data/reusables/enterprise_site_admin_settings/about-ssh-access.md b/data/reusables/enterprise_site_admin_settings/about-ssh-access.md
new file mode 100644
index 000000000000..4e1057532ce2
--- /dev/null
+++ b/data/reusables/enterprise_site_admin_settings/about-ssh-access.md
@@ -0,0 +1 @@
+SSH access allows you to run the {% data variables.product.product_name %} command line utilities to troubleshoot, run backups, and configure replication.
\ No newline at end of file
diff --git a/data/reusables/enterprise_site_admin_settings/about-the-management-console.md b/data/reusables/enterprise_site_admin_settings/about-the-management-console.md
new file mode 100644
index 000000000000..8c622226c61c
--- /dev/null
+++ b/data/reusables/enterprise_site_admin_settings/about-the-management-console.md
@@ -0,0 +1 @@
+You can use the {% data variables.enterprise.management_console %} to manage virtual appliance settings such as the domain, authentication, and SSL.
\ No newline at end of file
diff --git a/data/reusables/enterprise_site_admin_settings/about-the-site-admin-dashboard.md b/data/reusables/enterprise_site_admin_settings/about-the-site-admin-dashboard.md
new file mode 100644
index 000000000000..bab0827c406a
--- /dev/null
+++ b/data/reusables/enterprise_site_admin_settings/about-the-site-admin-dashboard.md
@@ -0,0 +1 @@
+You can use the site admin dashboard to manage users, organizations, and repositories in your enterprise directly in {% data variables.product.product_name %}.
\ No newline at end of file
diff --git a/data/reusables/enterprise_site_admin_settings/access-settings.md b/data/reusables/enterprise_site_admin_settings/access-settings.md
index 96af2b88bab7..d013169eb8bf 100644
--- a/data/reusables/enterprise_site_admin_settings/access-settings.md
+++ b/data/reusables/enterprise_site_admin_settings/access-settings.md
@@ -1,2 +1,2 @@
-1. From a {% data variables.product.prodname_ghe_server %} administrative account, click {% octicon "rocket" aria-label="The rocket ship" %} in the upper-right corner of any page.
+1. From an administrative account on {% data variables.product.product_name %}, click {% octicon "rocket" aria-label="The rocket ship" %} in the upper-right corner of any page.
diff --git a/data/reusables/enterprise_site_admin_settings/business.md b/data/reusables/enterprise_site_admin_settings/business.md
index edac9c3dd079..83944acdcef5 100644
--- a/data/reusables/enterprise_site_admin_settings/business.md
+++ b/data/reusables/enterprise_site_admin_settings/business.md
@@ -1,2 +1,2 @@
-1. In the left sidebar, click **Enterprise{% if currentVersion ver_gt "enterprise-server@2.21" %} overview{% endif %}**.
- 
+1. In the left sidebar, click **Enterprise{% if currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %} overview{% endif %}**.
+ 
diff --git a/data/reusables/enterprise_site_admin_settings/dormancy-threshold.md b/data/reusables/enterprise_site_admin_settings/dormancy-threshold.md
index 0e66a9eb7572..65cd4b1d6556 100644
--- a/data/reusables/enterprise_site_admin_settings/dormancy-threshold.md
+++ b/data/reusables/enterprise_site_admin_settings/dormancy-threshold.md
@@ -1 +1 @@
-The dormancy threshold is the length of time a user must be inactive to be considered dormant. The default dormancy threshold is 90 days, however you can customize the dormancy threshold for {% data variables.product.product_location_enterprise %}.
+The dormancy threshold is the length of time a user must be inactive to be considered dormant. The default dormancy threshold is 90 days, however you can customize the dormancy threshold for {% data variables.product.product_location %}.
diff --git a/data/reusables/enterprise_site_admin_settings/sign-in.md b/data/reusables/enterprise_site_admin_settings/sign-in.md
index 747a9b848bb6..93291bff5ced 100644
--- a/data/reusables/enterprise_site_admin_settings/sign-in.md
+++ b/data/reusables/enterprise_site_admin_settings/sign-in.md
@@ -1 +1 @@
-1. Sign in to {% data variables.product.product_location_enterprise %} at `http(s)://HOSTNAME/login`.
+1. Sign in to {% data variables.product.product_location %} at `http(s)://HOSTNAME/login`.
diff --git a/data/reusables/enterprise_user_management/built-in-authentication-option.md b/data/reusables/enterprise_user_management/built-in-authentication-option.md
index 37af582bf382..a7ff16d6b2b9 100644
--- a/data/reusables/enterprise_user_management/built-in-authentication-option.md
+++ b/data/reusables/enterprise_user_management/built-in-authentication-option.md
@@ -1 +1 @@
-Optionally, select **Allow built-in authentication** to invite users to use built-in authentication if they don’t belong to {% data variables.product.product_location_enterprise %}'s identity provider.
+Optionally, select **Allow built-in authentication** to invite users to use built-in authentication if they don’t belong to {% data variables.product.product_location %}'s identity provider.
diff --git a/data/reusables/enterprise_user_management/ldap-sync-nested-teams.md b/data/reusables/enterprise_user_management/ldap-sync-nested-teams.md
index 6500ebb0e147..5d88c18636fa 100644
--- a/data/reusables/enterprise_user_management/ldap-sync-nested-teams.md
+++ b/data/reusables/enterprise_user_management/ldap-sync-nested-teams.md
@@ -1 +1,3 @@
+{% if enterpriseServerVersions contains currentVersion %}
As part of its optimization configuration, LDAP Sync will not transfer your nested team structure. To create child and parent team relationships, you must manually recreate the nested team structure and sync it with the corresponding LDAP group. For more information, see "[Creating teams](/enterprise/{{ currentVersion }}/admin/guides/user-management/creating-teams/#creating-teams-with-ldap-sync-enabled)"
+{% endif %}
\ No newline at end of file
diff --git a/data/reusables/files/add-file.md b/data/reusables/files/add-file.md
index 2f5c4327ebec..9bf99b47f25a 100644
--- a/data/reusables/files/add-file.md
+++ b/data/reusables/files/add-file.md
@@ -1,4 +1,4 @@
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
1. Above the list of files, click **Create new file**.
{% else %}
diff --git a/data/reusables/gated-features/autolinks.md b/data/reusables/gated-features/autolinks.md
index 350993eeff5d..d545d6a5b4ac 100644
--- a/data/reusables/gated-features/autolinks.md
+++ b/data/reusables/gated-features/autolinks.md
@@ -1 +1 @@
-Autolinks are available in repositories with {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %}, and {% data variables.product.prodname_ghe_server %}. {% if currentVersion == "free-pro-team@latest" %}{% data reusables.gated-features.more-info %}{% endif %}
+Autolinks are available in repositories with {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %},{% if currentVersion == "github-ae@latest" %} {% data variables.product.prodname_ghe_managed %},{% endif %} and {% data variables.product.prodname_ghe_server %}. {% if currentVersion == "free-pro-team@latest" %}{% data reusables.gated-features.more-info %}{% endif %}
diff --git a/data/reusables/gated-features/branch-restrictions.md b/data/reusables/gated-features/branch-restrictions.md
index 9924a4055892..cf179ece173d 100644
--- a/data/reusables/gated-features/branch-restrictions.md
+++ b/data/reusables/gated-features/branch-restrictions.md
@@ -1 +1,3 @@
-Protected branches are available in public repositories with {% data variables.product.prodname_free_user %} and {% data variables.product.prodname_free_team %} for organizations, and in public and private repositories with {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %}, and {% data variables.product.prodname_ghe_server %}. The ability to restrict branches is a type of branch protection that's available for public and private repositories owned by organizations in {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %}, and {% data variables.product.prodname_ghe_server %}. {% if currentVersion == "free-pro-team@latest" %}{% data reusables.gated-features.more-info %}{% endif %}
+{% data reusables.gated-features.protected-branches %}
+
+Branch restriction is a type of branch protection that's available for public and private repositories owned by organizations in {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %},{% if currentVersion == "github-ae@latest" %} {% data variables.product.prodname_ghe_managed %},{% endif %} and {% data variables.product.prodname_ghe_server %}. {% if currentVersion == "free-pro-team@latest" %}{% data reusables.gated-features.more-info %}{% endif %}
diff --git a/data/reusables/gated-features/code-owners.md b/data/reusables/gated-features/code-owners.md
index 462bcc965367..3dc4547af8f2 100644
--- a/data/reusables/gated-features/code-owners.md
+++ b/data/reusables/gated-features/code-owners.md
@@ -1 +1 @@
-You can define code owners in public repositories with {% data variables.product.prodname_free_user %} and {% data variables.product.prodname_free_team %} for organizations, and in public and private repositories with {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %}, and {% data variables.product.prodname_ghe_server %}. {% if currentVersion == "free-pro-team@latest" %}{% data reusables.gated-features.more-info %}{% endif %}
+You can define code owners in public repositories with {% data variables.product.prodname_free_user %} and {% data variables.product.prodname_free_team %} for organizations, and in public and private repositories with {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %},{% if currentVersion == "github-ae@latest" %} {% data variables.product.prodname_ghe_managed %},{% endif %} and {% data variables.product.prodname_ghe_server %}. {% if currentVersion == "free-pro-team@latest" %}{% data reusables.gated-features.more-info %}{% endif %}
diff --git a/data/reusables/gated-features/code-review-assignment.md b/data/reusables/gated-features/code-review-assignment.md
index 3d7d1cce5bdf..fb8808fc4e01 100644
--- a/data/reusables/gated-features/code-review-assignment.md
+++ b/data/reusables/gated-features/code-review-assignment.md
@@ -1 +1 @@
-Code review assignment is available with {% data variables.product.prodname_team %}{% if currentVersion ver_gt "enterprise-server@2.19" %}, {% data variables.product.prodname_ghe_server %} 2.20+,{% endif %} and {% data variables.product.prodname_ghe_cloud %}. For more information, see "[GitHub's products](/articles/githubs-products)."
+Code review assignment is available with {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_server %} 2.20+,{% if currentVersion == "github-ae@latest" %} {% data variables.product.prodname_ghe_managed %},{% endif %} and {% data variables.product.prodname_ghe_cloud %}. For more information, see "[GitHub's products](/articles/githubs-products)."
diff --git a/data/reusables/gated-features/display-names.md b/data/reusables/gated-features/display-names.md
index 23eec9944529..c7c249338ac8 100644
--- a/data/reusables/gated-features/display-names.md
+++ b/data/reusables/gated-features/display-names.md
@@ -1 +1 @@
-Allowing members to see comment authors' profile names is available with {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_server %} 2.18+, and {% data variables.product.prodname_ghe_cloud %}. For more information, see "[GitHub's products](/articles/githubs-products)."
+Allowing members to see comment authors' profile names is available with {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_server %} 2.18+,{% if currentVersion == "github-ae@latest" %} {% data variables.product.prodname_ghe_managed %},{% endif %} and {% data variables.product.prodname_ghe_cloud %}. For more information, see "[GitHub's products](/articles/githubs-products)."
diff --git a/data/reusables/gated-features/draft-prs.md b/data/reusables/gated-features/draft-prs.md
index 0379025602e7..9c53c6d6c05e 100644
--- a/data/reusables/gated-features/draft-prs.md
+++ b/data/reusables/gated-features/draft-prs.md
@@ -1 +1 @@
-Draft pull requests are available in public repositories with {% data variables.product.prodname_free_team %} for organizations and legacy per-repository billing plans, and in public and private repositories with {% data variables.product.prodname_team %}{% if currentVersion != "free-pro-team@latest" %}, {% data variables.product.prodname_ghe_server %} 2.17+,{% endif %} and {% data variables.product.prodname_ghe_cloud %}. {% if currentVersion == "free-pro-team@latest" %}{% data reusables.gated-features.more-info %}{% endif %}
+Draft pull requests are available in public repositories with {% data variables.product.prodname_free_team %} for organizations and legacy per-repository billing plans, and in public and private repositories with {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_server %} 2.17+,{% if currentVersion == "github-ae@latest" %} {% data variables.product.prodname_ghe_managed %},{% endif %} and {% data variables.product.prodname_ghe_cloud %}. {% if currentVersion == "free-pro-team@latest" %}{% data reusables.gated-features.more-info %}{% endif %}
diff --git a/data/reusables/gated-features/enterprise-accounts.md b/data/reusables/gated-features/enterprise-accounts.md
index 50e068a931e4..e4c5549a8ccc 100644
--- a/data/reusables/gated-features/enterprise-accounts.md
+++ b/data/reusables/gated-features/enterprise-accounts.md
@@ -1 +1 @@
-Enterprise accounts are available with {% data variables.product.prodname_ghe_cloud %} and {% data variables.product.prodname_ghe_server %}. {% if currentVersion == "free-pro-team@latest" %}For more information, see "[About enterprise accounts](/articles/about-enterprise-accounts)."{% endif %}
+Enterprise accounts are available with {% data variables.product.prodname_ghe_cloud %}{% if currentVersion == "github-ae@latest" %}, {% data variables.product.prodname_ghe_managed %},{% endif %} and {% data variables.product.prodname_ghe_server %}. {% if currentVersion == "free-pro-team@latest" %}For more information, see "[About enterprise accounts](/articles/about-enterprise-accounts)."{% endif %}
diff --git a/data/reusables/gated-features/internal-repos.md b/data/reusables/gated-features/internal-repos.md
index 331ce8dc8650..8100ff30df27 100644
--- a/data/reusables/gated-features/internal-repos.md
+++ b/data/reusables/gated-features/internal-repos.md
@@ -1 +1 @@
-Internal repositories are available with {% data variables.product.prodname_ghe_cloud %} and {% data variables.product.prodname_ghe_server %} 2.20+. For more information, see GitHub's products."
+Internal repositories are available with {% data variables.product.prodname_ghe_cloud %}{% if currentVersion == "github-ae@latest" %}, {% data variables.product.prodname_ghe_managed %},{% endif %} and {% data variables.product.prodname_ghe_server %} 2.20+. For more information, see "GitHub's products."
diff --git a/data/reusables/gated-features/pages.md b/data/reusables/gated-features/pages.md
index 9dfbcd79f6ef..e24925cc9877 100644
--- a/data/reusables/gated-features/pages.md
+++ b/data/reusables/gated-features/pages.md
@@ -1 +1 @@
-{% data variables.product.prodname_pages %} is available in public repositories with {% data variables.product.prodname_free_user %} and {% data variables.product.prodname_free_team %} for organizations, and in public and private repositories with {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %}, and {% data variables.product.prodname_ghe_server %}. {% if currentVersion == "free-pro-team@latest" %}{% data reusables.gated-features.more-info %}{% endif %}
+{% data variables.product.prodname_pages %} is available in public repositories with {% data variables.product.prodname_free_user %} and {% data variables.product.prodname_free_team %} for organizations, and in public and private repositories with {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %},{% if currentVersion == "github-ae@latest" %} {% data variables.product.prodname_ghe_managed %},{% endif %} and {% data variables.product.prodname_ghe_server %}. {% if currentVersion == "free-pro-team@latest" %}{% data reusables.gated-features.more-info %}{% endif %}
diff --git a/data/reusables/gated-features/protected-branches.md b/data/reusables/gated-features/protected-branches.md
index 4a9272eba2ff..a9745fcec2b6 100644
--- a/data/reusables/gated-features/protected-branches.md
+++ b/data/reusables/gated-features/protected-branches.md
@@ -1 +1 @@
-Protected branches are available in public repositories with {% data variables.product.prodname_free_user %} and {% data variables.product.prodname_free_team %} for organizations, and in public and private repositories with {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %}, and {% data variables.product.prodname_ghe_server %}. {% if currentVersion == "free-pro-team@latest" %}{% data reusables.gated-features.more-info %}{% endif %}
+Protected branches are available in public repositories with {% data variables.product.prodname_free_user %} and {% data variables.product.prodname_free_team %} for organizations, and in public and private repositories with {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %},{% if currentVersion == "github-ae@latest" %} {% data variables.product.prodname_ghe_managed %},{% endif %} and {% data variables.product.prodname_ghe_server %}. {% if currentVersion == "free-pro-team@latest" %}{% data reusables.gated-features.more-info %}{% endif %}
diff --git a/data/reusables/gated-features/repository-insights.md b/data/reusables/gated-features/repository-insights.md
index c400b5bf830d..71016e9f967d 100644
--- a/data/reusables/gated-features/repository-insights.md
+++ b/data/reusables/gated-features/repository-insights.md
@@ -1 +1 @@
-This repository insights graph is available in public repositories with {% data variables.product.prodname_free_user %} and {% data variables.product.prodname_free_team %} for organizations, and in public and private repositories with {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %}, and {% data variables.product.prodname_ghe_server %}.{% if currentVersion == "free-pro-team@latest" %} For more information, see "[About repository graphs](/articles/about-repository-graphs)" and "[{% data variables.product.prodname_dotcom %}'s products](/articles/github-s-products)."{% endif %}
+This repository insights graph is available in public repositories with {% data variables.product.prodname_free_user %} and {% data variables.product.prodname_free_team %} for organizations, and in public and private repositories with {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %},{% if currentVersion == "github-ae@latest" %} {% data variables.product.prodname_ghe_managed %},{% endif %} and {% data variables.product.prodname_ghe_server %}.{% if currentVersion == "free-pro-team@latest" %} For more information, see "[About repository graphs](/articles/about-repository-graphs)" and "[{% data variables.product.prodname_dotcom %}'s products](/articles/github-s-products)."{% endif %}
diff --git a/data/reusables/gated-features/saml-sso.md b/data/reusables/gated-features/saml-sso.md
index 4dc2bef161b7..bad5e99d72b5 100644
--- a/data/reusables/gated-features/saml-sso.md
+++ b/data/reusables/gated-features/saml-sso.md
@@ -1 +1 @@
-SAML single sign-on is available with {% data variables.product.prodname_ghe_cloud %}. For more information, see "[GitHub's products](/articles/githubs-products)."
+SAML single sign-on is available with {% data variables.product.prodname_ghe_cloud %}{% if currentVersion == "github-ae@latest" %} and {% data variables.product.prodname_ghe_managed %}{% endif %}. For more information, see "[GitHub's products](/articles/githubs-products)."
diff --git a/data/reusables/gated-features/ssh-certificate-authorities.md b/data/reusables/gated-features/ssh-certificate-authorities.md
index a8edce3781e1..80098d6efadc 100644
--- a/data/reusables/gated-features/ssh-certificate-authorities.md
+++ b/data/reusables/gated-features/ssh-certificate-authorities.md
@@ -1 +1 @@
-Support for SSH certificate authorities is available with {% data variables.product.prodname_ghe_cloud %} and {% data variables.product.prodname_ghe_server %} 2.19+. For more information, see "[GitHub's products](/articles/githubs-products)."
+Support for SSH certificate authorities is available with {% data variables.product.prodname_ghe_cloud %}{% if currentVersion == "github-ae@latest" %}, {% data variables.product.prodname_ghe_managed %},{% endif %} and {% data variables.product.prodname_ghe_server %} 2.19+. For more information, see "[GitHub's products](/articles/githubs-products)."
diff --git a/data/reusables/gated-features/wikis.md b/data/reusables/gated-features/wikis.md
index fcdbdfec280f..61f560896e02 100644
--- a/data/reusables/gated-features/wikis.md
+++ b/data/reusables/gated-features/wikis.md
@@ -1 +1 @@
-Wikis are available in public repositories with {% data variables.product.prodname_free_user %} and {% data variables.product.prodname_free_team %} for organizations, and in public and private repositories with {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %}, and {% data variables.product.prodname_ghe_server %}. {% if currentVersion == "free-pro-team@latest" %}{% data reusables.gated-features.more-info %}{% endif %}
+Wikis are available in public repositories with {% data variables.product.prodname_free_user %} and {% data variables.product.prodname_free_team %} for organizations, and in public and private repositories with {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %},{% if currentVersion == "github-ae@latest" %} {% data variables.product.prodname_ghe_managed %},{% endif %} and {% data variables.product.prodname_ghe_server %}. {% if currentVersion == "free-pro-team@latest" %}{% data reusables.gated-features.more-info %}{% endif %}
diff --git a/data/reusables/gist/anonymous-gists-cannot-be-deleted.md b/data/reusables/gist/anonymous-gists-cannot-be-deleted.md
index 44325424b349..3d6ce66752c6 100644
--- a/data/reusables/gist/anonymous-gists-cannot-be-deleted.md
+++ b/data/reusables/gist/anonymous-gists-cannot-be-deleted.md
@@ -1,4 +1,4 @@
-{% if currentVersion != "free-pro-team@latest" %}
+{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
{% warning %}
**Warning:** Anonymous gists cannot be deleted from the web browser. To have an anonymous gist deleted, contact {% data variables.contact.contact_support %}. Please provide the URL of the gist you wish to delete.
diff --git a/data/reusables/github-actions/disabling-github-actions.md b/data/reusables/github-actions/disabling-github-actions.md
index 9344146d57e7..56bbb36beec0 100644
--- a/data/reusables/github-actions/disabling-github-actions.md
+++ b/data/reusables/github-actions/disabling-github-actions.md
@@ -1 +1 @@
-By default, {% if currentVersion ver_gt "enterprise-server@2.21" %}after {% data variables.product.prodname_actions %} is enabled on {% data variables.product.product_location %}, it{% else if if currentVersion == "free-pro-team@latest" %}{% data variables.product.prodname_actions %}{% endif %} is enabled on all repositories and organizations. You can choose to disable {% data variables.product.prodname_actions %} or limit them to private actions only, which means that people can only use actions that exist in your repository.
+By default, {% if currentVersion ver_gt "enterprise-server@2.21" %}after {% data variables.product.prodname_actions %} is enabled on {% data variables.product.product_location %}, it{% elsif currentVersion == "free-pro-team@latest" %}{% data variables.product.prodname_actions %}{% endif %} is enabled on all repositories and organizations. You can choose to disable {% data variables.product.prodname_actions %} or limit them to private actions only, which means that people can only use actions that exist in your repository.
diff --git a/data/reusables/github-actions/enabled-local-github-actions.md b/data/reusables/github-actions/enabled-local-github-actions.md
index 2eedbc2de9a0..0043c8e9608d 100644
--- a/data/reusables/github-actions/enabled-local-github-actions.md
+++ b/data/reusables/github-actions/enabled-local-github-actions.md
@@ -1 +1 @@
-When you enable local actions only, workflows can only run actions located in your repository or organization.
+When you enable local actions only, workflows can only run actions located in your repository, organization, or enterprise.
diff --git a/data/reusables/github-actions/self-hosted-runner-management-permissions-required.md b/data/reusables/github-actions/self-hosted-runner-management-permissions-required.md
index 3129be2838e8..9ddc7c7b5c24 100644
--- a/data/reusables/github-actions/self-hosted-runner-management-permissions-required.md
+++ b/data/reusables/github-actions/self-hosted-runner-management-permissions-required.md
@@ -1,9 +1,9 @@
-A self-hosted runner can be located in either your repository, organization, or {% if currentVersion == "free-pro-team@latest" %}enterprise account settings on {% data variables.product.prodname_dotcom %}{% else if currentVersion != "free-pro-team@latest" and currentVersion ver_gt "enterprise-server@2.21" %} enterprise settings on {% data variables.product.product_location %}{% endif %}. To manage a self-hosted runner, you must have the following permissions, depending on where the self-hosted runner was added:
+A self-hosted runner can be located in either your repository, organization, or {% if currentVersion == "free-pro-team@latest" %}enterprise account settings on {% data variables.product.prodname_dotcom %}{% elsif enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" %} enterprise settings on {% data variables.product.product_location %}{% endif %}. To manage a self-hosted runner, you must have the following permissions, depending on where the self-hosted runner was added:
- **User repository**: You must be the repository owner.
- **Organization**: You must be an organization owner.
- **Organization repository**: You must be an organization owner, or have admin access to the repository.
{% if currentVersion == "free-pro-team@latest" %}
- **Enterprise account**: You must be an enterprise owner.
-{% else if currentVersion != "free-pro-team@latest" and currentVersion ver_gt "enterprise-server@2.21" %}
+{% elsif enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" %}
- **Enterprise**: You must be a {% data variables.product.prodname_enterprise %} site administrator.
{% endif %}
diff --git a/data/reusables/github-actions/self-hosted-runner-navigate-to-repo-org-enterprise.md b/data/reusables/github-actions/self-hosted-runner-navigate-to-repo-org-enterprise.md
index e9454db628a2..12756c93a00f 100644
--- a/data/reusables/github-actions/self-hosted-runner-navigate-to-repo-org-enterprise.md
+++ b/data/reusables/github-actions/self-hosted-runner-navigate-to-repo-org-enterprise.md
@@ -1,6 +1,6 @@
1. Navigate to where your self-hosted runner is registered:
* **In an organization or repository**: navigate to the main page and click {% octicon "gear" aria-label="The Settings gear" %} **Settings**.
- * {% if currentVersion == "free-pro-team@latest" %}**If using an enterprise account**: navigate to your enterprise account by visiting `https://github.com/enterprises/ENTERPRISE-NAME`, replacing `ENTERPRISE-NAME` with your enterprise account's name.{% else if currentVersion != "free-pro-team@latest" and currentVersion ver_gt "enterprise-server@2.21" %}**If using an enterprise-level runner**:
+ * {% if currentVersion == "free-pro-team@latest" %}**If using an enterprise account**: navigate to your enterprise account by visiting `https://github.com/enterprises/ENTERPRISE-NAME`, replacing `ENTERPRISE-NAME` with your enterprise account's name.{% elsif enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" %}**If using an enterprise-level runner**:
1. In the upper-right corner of any page, click {% octicon "rocket" aria-label="The rocket ship" %}.
1. In the left sidebar, click **Enterprise overview**.
@@ -9,4 +9,4 @@
* **In an organization or repository**: click **Actions** in the left sidebar.
- * {% if currentVersion == "free-pro-team@latest" %}**If using an enterprise account**{% else if currentVersion != "free-pro-team@latest" and currentVersion ver_gt "enterprise-server@2.21" %}**If using an enterprise-level runner**{% endif %}: click **Actions** under "{% octicon "law" aria-label="The law icon" %} Policies".
+ * {% if currentVersion == "free-pro-team@latest" %}**If using an enterprise account**{% elsif enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" %}**If using an enterprise-level runner**{% endif %}: click **Actions** under "{% octicon "law" aria-label="The law icon" %} Policies".
diff --git a/data/reusables/github-ae/about-billing.md b/data/reusables/github-ae/about-billing.md
new file mode 100644
index 000000000000..9e7ed843b20d
--- /dev/null
+++ b/data/reusables/github-ae/about-billing.md
@@ -0,0 +1 @@
+You will receive a monthly bill for {% data variables.product.prodname_ghe_managed %}, with charges that are calculated per licensed user per day.
\ No newline at end of file
diff --git a/data/reusables/github-ae/github-ae-enables-you.md b/data/reusables/github-ae/github-ae-enables-you.md
new file mode 100644
index 000000000000..dd699d9ad63f
--- /dev/null
+++ b/data/reusables/github-ae/github-ae-enables-you.md
@@ -0,0 +1 @@
+{% data variables.product.prodname_ghe_managed %} enables you to move your software development to the cloud while meeting the most stringent security and compliance requirements.
diff --git a/data/reusables/github-insights/contributors-tab.md b/data/reusables/github-insights/contributors-tab.md
index 4f00212343d6..7eafbff08cad 100644
--- a/data/reusables/github-insights/contributors-tab.md
+++ b/data/reusables/github-insights/contributors-tab.md
@@ -1,2 +1,2 @@
-1. Under **{% octicon "gear" aria-label="The gear icon" %} Settings**, click **Contibutors**.
+1. Under **{% octicon "gear" aria-label="The gear icon" %} Settings**, click **Contributors**.
diff --git a/data/reusables/large_files/can-include-lfs-objects-archives.md b/data/reusables/large_files/can-include-lfs-objects-archives.md
index 83a7278c3796..95940064aa54 100644
--- a/data/reusables/large_files/can-include-lfs-objects-archives.md
+++ b/data/reusables/large_files/can-include-lfs-objects-archives.md
@@ -1,5 +1,3 @@
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
-
-You can choose whether {% data variables.large_files.product_name_long %}({% data variables.large_files.product_name_short %}) objects are included in source code archives, such as ZIP files and tarballs, that {% data variables.product.product_name %} creates for your repository. For more information, see "[Managing {% data variables.large_files.product_name_short %} objects in archives of your repository](/github/administering-a-repository/managing-git-lfs-objects-in-archives-of-your-repository)."
-
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}
+You can choose whether {% data variables.large_files.product_name_short %} objects are included in source code archives, such as ZIP files and tarballs, that {% data variables.product.product_name %} creates for your repository. For more information, see "[Managing {% data variables.large_files.product_name_short %} objects in archives of your repository](/github/administering-a-repository/managing-git-lfs-objects-in-archives-of-your-repository)."
{% endif %}
diff --git a/data/reusables/large_files/rejected_pushes.md b/data/reusables/large_files/rejected_pushes.md
index d647917efbb9..4d04d4d367be 100644
--- a/data/reusables/large_files/rejected_pushes.md
+++ b/data/reusables/large_files/rejected_pushes.md
@@ -1 +1 @@
-Users cannot push {% data variables.large_files.product_name_short %} assets to {% data variables.product.prodname_ghe_server %} if {% data variables.large_files.product_name_short %} is disabled on the appliance or repository.
+Users cannot push {% data variables.large_files.product_name_short %} assets to {% data variables.product.product_name %} if {% data variables.large_files.product_name_short %} is disabled on the enterprise or repository.
diff --git a/data/reusables/large_files/storage_assets_location.md b/data/reusables/large_files/storage_assets_location.md
index 2427a330c0cc..e80c727c0b1b 100644
--- a/data/reusables/large_files/storage_assets_location.md
+++ b/data/reusables/large_files/storage_assets_location.md
@@ -1 +1,3 @@
-By default, the {% data variables.large_files.product_name_long %} client stores large assets on the same server that hosts the Git repository. When {% data variables.large_files.product_name_short %} is enabled on the {% data variables.product.prodname_ghe_server %} appliance, large assets are stored on the data partition in `/data/user/storage`.
+{% if enterpriseServerVersions contains currentVersion %}
+By default, the {% data variables.large_files.product_name_long %} client stores large assets on the same server that hosts the Git repository. When {% data variables.large_files.product_name_short %} is enabled on {% data variables.product.product_location %}, large assets are stored on the data partition in `/data/user/storage`.
+{% endif %}
\ No newline at end of file
diff --git a/data/reusables/marketplace/downgrade-marketplace-only.md b/data/reusables/marketplace/downgrade-marketplace-only.md
index fe5ba60c5c72..aac9c9829445 100644
--- a/data/reusables/marketplace/downgrade-marketplace-only.md
+++ b/data/reusables/marketplace/downgrade-marketplace-only.md
@@ -1 +1 @@
-Canceling an app or downgrading an app to free does not affect your [other paid subcriptions](/articles/about-billing-on-github) on {% data variables.product.prodname_dotcom %}. If you want to cease all of your paid subscriptions on {% data variables.product.prodname_dotcom %}, you must downgrade each paid subscription separately.
+Canceling an app or downgrading an app to free does not affect your [other paid subscriptions](/articles/about-billing-on-github) on {% data variables.product.prodname_dotcom %}. If you want to cease all of your paid subscriptions on {% data variables.product.prodname_dotcom %}, you must downgrade each paid subscription separately.
diff --git a/data/reusables/notifications/outbound_email_tip.md b/data/reusables/notifications/outbound_email_tip.md
index 5a7b57bc3571..6e261ac61517 100644
--- a/data/reusables/notifications/outbound_email_tip.md
+++ b/data/reusables/notifications/outbound_email_tip.md
@@ -1,7 +1,7 @@
-{% if currentVersion != "free-pro-team@latest" %}
+{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
{% tip %}
- You'll only receive email notifications if outbound email support is enabled on {% data variables.product.product_location_enterprise %}. For more information, contact your site administrator.
+ You'll only receive email notifications if outbound email support is enabled on {% data variables.product.product_location %}. For more information, contact your site administrator.
{% endtip %}
{% endif %}
diff --git a/data/reusables/notifications/vulnerable-dependency-notification-delivery-method-customization.md b/data/reusables/notifications/vulnerable-dependency-notification-delivery-method-customization.md
new file mode 100644
index 000000000000..6b3de47d4c8b
--- /dev/null
+++ b/data/reusables/notifications/vulnerable-dependency-notification-delivery-method-customization.md
@@ -0,0 +1,3 @@
+You can choose the delivery method for notifications about {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %} on repositories that you are watching, as well as the frequency at which the notifications are sent to you.
+
+
diff --git a/data/reusables/notifications/vulnerable-dependency-notification-options.md b/data/reusables/notifications/vulnerable-dependency-notification-options.md
new file mode 100644
index 000000000000..6fd66803d4e8
--- /dev/null
+++ b/data/reusables/notifications/vulnerable-dependency-notification-options.md
@@ -0,0 +1,29 @@
+{% if currentVersion == "free-pro-team@latest" %}
+By default, you will receive notification of new {% data variables.product.prodname_dependabot_alerts %}:
+- by email, an email is sent every time a vulnerability with a critical or high severity is found (**Email each time a vulnerability is found** option)
+- in the user interface, a warning is shown in your repository's file and code views if there are any vulnerable dependencies (**UI alerts** option)
+- on the command line, warnings are displayed as callbacks when you push to repositories with any vulnerable dependencies (**Command Line** option)
+- in your inbox, as web notifications for new vulnerabilities with a critical or high severity (**Web** option)
+
+You can customize the way you are notified about {% data variables.product.prodname_dependabot_alerts %}. For example, you can receive a weekly digest email summarizing alerts for up to 10 of your repositories using the **Email a digest summary of vulnerabilities** and **Weekly security email digest** options.
+{% endif %}
+
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" %}
+By default, if your site administrator has configured email for notifications on your instance, you will receive {% data variables.product.prodname_dependabot_alerts %}:
+- by email, an email is sent every time a vulnerability {% if currentVersion ver_gt "enterprise-server@2.23" %}with a critical or high severity {% endif %}is found (**Email each time a vulnerability is found** option)
+- in the user interface, a warning is shown in your repository's file and code views if there are any vulnerable dependencies (**UI alerts** option)
+- on the command line, warnings are displayed as callbacks when you push to repositories with any vulnerable dependencies (**Command Line** option)
+- in your inbox, as web notifications {% if currentVersion ver_gt "enterprise-server@2.23" %}for new vulnerabilities with a critical or high severity {% endif %}(**Web** option)
+
+You can customize the way you are notified about {% data variables.product.prodname_dependabot_alerts %}. For example, you can receive a weekly digest email summarizing alerts for up to 10 of your repositories using the **Email a digest summary of vulnerabilities** and **Weekly security email digest** options.
+{% endif %}
+
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
+By default, if your site administrator has configured email for notifications on your instance, you will receive security alerts:
+- by email, an email is sent every time a vulnerability is found (**Email each time a vulnerability is found** option)
+- in the user interface, as warnings in your repository's file and code views (**UI alerts** option)
+- on the command line, as warnings that are displayed as callbacks when you push to repositories with vulnerabilities (**Command Line** option)
+- in your inbox, as web notifications (**Web** option)
+
+You can customize the way you are notified about security alerts. For example, you can receive a weekly digest email summarizing alerts for up to 10 of your repositories using the **Email a digest summary of vulnerabilities** and **Weekly security email digest** options.
+{% endif %}
diff --git a/data/reusables/organizations/organizations_include.md b/data/reusables/organizations/organizations_include.md
index d6d751844474..da902c12ed56 100644
--- a/data/reusables/organizations/organizations_include.md
+++ b/data/reusables/organizations/organizations_include.md
@@ -3,6 +3,6 @@ Organizations include:
- The option to upgrade to {% data variables.product.prodname_team %} or {% data variables.product.prodname_ghe_cloud %} for additional features, including sophisticated user authentication and management, and escalated support options. {% data reusables.gated-features.more-info %}{% endif %}
- Unlimited membership with a variety of roles that grant [different levels of access to the organization and its data](/articles/permission-levels-for-an-organization)
- The ability to give members [a range of access permissions to your organization's repositories](/articles/repository-permission-levels-for-an-organization)
-- [Nested teams that reflect your company or group's structure](/articles/about-teams) with cascading access permissions and mentions
+- [Nested teams that reflect your company or group's structure](/articles/about-teams) with cascading access permissions and mentions{% if currentVersion != "github-ae@latest" %}
- The ability for organization owners to view members' [two-factor authentication (2FA) status](/articles/about-two-factor-authentication)
-- The option to [require all organization members to use two-factor authentication](/articles/requiring-two-factor-authentication-in-your-organization)
+- The option to [require all organization members to use two-factor authentication](/articles/requiring-two-factor-authentication-in-your-organization){% endif %}
diff --git a/data/reusables/organizations/security.md b/data/reusables/organizations/security.md
index 0e5060f64f78..e8bb0ed5d76d 100644
--- a/data/reusables/organizations/security.md
+++ b/data/reusables/organizations/security.md
@@ -1,4 +1,4 @@
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}
1. In the left sidebar, click **Organization security**.
{% else %}
diff --git a/data/reusables/organizations/team_maintainers_can.md b/data/reusables/organizations/team_maintainers_can.md
index 4359aafdc9a1..586a4657f580 100644
--- a/data/reusables/organizations/team_maintainers_can.md
+++ b/data/reusables/organizations/team_maintainers_can.md
@@ -10,6 +10,6 @@ Members with team maintainer permissions can:
- [Add organization members to the team](/articles/adding-organization-members-to-a-team)
- [Remove organization members from the team](/articles/removing-organization-members-from-a-team)
- [Promote an existing team member to team maintainer](/articles/giving-team-maintainer-permissions-to-an-organization-member)
-- Remove the team's access to repositories{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
+- Remove the team's access to repositories{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %}
- [Manage code review assignment for the team](/github/setting-up-and-managing-organizations-and-teams/managing-code-review-assignment-for-your-team){% endif %}{% if currentVersion == "free-pro-team@latest" %}
- [Manage scheduled reminders for pull requests](/github/setting-up-and-managing-organizations-and-teams/managing-scheduled-reminders-for-pull-requests){% endif %}
diff --git a/data/reusables/package_registry/admins-can-configure-package-types.md b/data/reusables/package_registry/admins-can-configure-package-types.md
index efe344932d49..23e237356b15 100644
--- a/data/reusables/package_registry/admins-can-configure-package-types.md
+++ b/data/reusables/package_registry/admins-can-configure-package-types.md
@@ -1,4 +1,4 @@
-{% if currentVersion != "free-pro-team@latest" %}
+{% if enterpriseServerVersions contains currentVersion %}
{% note %}
**Note:** This package type may not be available for your instance, because site administrators can enable or disable each supported package type. For more information, see "[Configuring packages support for your enterprise](/enterprise/admin/packages/configuring-packages-support-for-your-enterprise)."
diff --git a/data/reusables/package_registry/docker_registry_deprecation_status.md b/data/reusables/package_registry/docker_registry_deprecation_status.md
index 79e9650f348f..2df9364c317f 100644
--- a/data/reusables/package_registry/docker_registry_deprecation_status.md
+++ b/data/reusables/package_registry/docker_registry_deprecation_status.md
@@ -1,5 +1,5 @@
{% warning %}
-**Note:** The {% data variables.product.prodname_registry %} Docker registry will be superseded by {% data variables.product.prodname_github_container_registry %}{% if currentVersion != "free-pro-team@latest" %} in a future {% data variables.product.product_name %} release{% endif %}.{% if currentVersion == "free-pro-team@latest" %} To learn how to migrate your existing Docker images and any workflows using them, see "[Migrating to {% data variables.product.prodname_github_container_registry %} for Docker images](/packages/getting-started-with-github-container-registry/migrating-to-github-container-registry-for-docker-images)" and "[Getting started with {% data variables.product.prodname_github_container_registry %}](/packages/getting-started-with-github-container-registry)."{% endif %}
+**Note:** The {% data variables.product.prodname_registry %} Docker registry will be superseded by {% data variables.product.prodname_github_container_registry %}{% if enterpriseServerVersions contains currentVersion %} in a future {% data variables.product.product_name %} release{% endif %}.{% if currentVersion == "free-pro-team@latest" %} To learn how to migrate your existing Docker images and any workflows using them, see "[Migrating to {% data variables.product.prodname_github_container_registry %} for Docker images](/packages/getting-started-with-github-container-registry/migrating-to-github-container-registry-for-docker-images)" and "[Getting started with {% data variables.product.prodname_github_container_registry %}](/packages/getting-started-with-github-container-registry)."{% endif %}
{% endwarning %}
diff --git a/data/reusables/package_registry/packages-ghes-release-stage.md b/data/reusables/package_registry/packages-ghes-release-stage.md
index 66d73926c699..03d9b25f8416 100644
--- a/data/reusables/package_registry/packages-ghes-release-stage.md
+++ b/data/reusables/package_registry/packages-ghes-release-stage.md
@@ -1,4 +1,4 @@
-{% if currentVersion != "free-pro-team@latest" %}
+{% if enterpriseServerVersions contains currentVersion %}
{% note %}
**Note:** {% data variables.product.prodname_registry %} is currently in beta for {% data variables.product.prodname_ghe_server %} 2.22. To join the beta for your instance, use the [sign-up form](https://resources.github.com/beta-signup/).
diff --git a/data/reusables/pages/build-failure-email-server.md b/data/reusables/pages/build-failure-email-server.md
index d61fac9ecc05..9899c8d6575e 100644
--- a/data/reusables/pages/build-failure-email-server.md
+++ b/data/reusables/pages/build-failure-email-server.md
@@ -1,7 +1,7 @@
-{% if currentVersion != "free-pro-team@latest" %}
+{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
{% tip %}
- You will only receive an email if outbound email support is enabled on {% data variables.product.product_location_enterprise %}. For more information, contact your site administrator.
+ You will only receive an email if outbound email support is enabled on {% data variables.product.product_location %}. For more information, contact your site administrator.
{% endtip %}
{% endif %}
diff --git a/data/reusables/pages/decide-publishing-source.md b/data/reusables/pages/decide-publishing-source.md
index 8e950fc86be7..59211352bc2c 100644
--- a/data/reusables/pages/decide-publishing-source.md
+++ b/data/reusables/pages/decide-publishing-source.md
@@ -1 +1 @@
-1. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}Decide{% else %}If you're creating a project site, decide{% endif %} which publishing source you want to use. {% if currentVersion ver_lt "enterprise-server@2.23" %}If you're creating a user or organization site, you must store your site's source code on the `master` branch.{% endif %} For more information, see "[About {% data variables.product.prodname_pages %}](/articles/about-github-pages#publishing-sources-for-github-pages-sites)."
+1. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}Decide{% else %}If you're creating a project site, decide{% endif %} which publishing source you want to use. {% if currentVersion ver_lt "enterprise-server@2.23" %}If you're creating a user or organization site, you must store your site's source code on the `master` branch.{% endif %} For more information, see "[About {% data variables.product.prodname_pages %}](/articles/about-github-pages#publishing-sources-for-github-pages-sites)."
diff --git a/data/reusables/pages/new-or-existing-repo.md b/data/reusables/pages/new-or-existing-repo.md
index 75a6a0432465..4fdcdaf871e9 100644
--- a/data/reusables/pages/new-or-existing-repo.md
+++ b/data/reusables/pages/new-or-existing-repo.md
@@ -1,3 +1,3 @@
-If your site is an independent project, you can create a new repository to store your site's source code. If your site is associated with an existing project, you can add the source code {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}to that project's repository, in a `/docs` folder on the default branch or on a different branch.{% else %}for your site to a `gh-pages` branch or a `docs` folder on the `master` branch in that project's repository.{% endif %} For example, if you're creating a site to publish documentation for a project that's already on {% data variables.product.product_name %}, you may want to store the source code for the site in the same repository as the project.
+If your site is an independent project, you can create a new repository to store your site's source code. If your site is associated with an existing project, you can add the source code {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}to that project's repository, in a `/docs` folder on the default branch or on a different branch.{% else %}for your site to a `gh-pages` branch or a `docs` folder on the `master` branch in that project's repository.{% endif %} For example, if you're creating a site to publish documentation for a project that's already on {% data variables.product.product_name %}, you may want to store the source code for the site in the same repository as the project.
If you want to create a site in an existing repository, skip to the "[Creating your site](#creating-your-site)" section.
diff --git a/data/reusables/pages/private_pages_are_public_warning.md b/data/reusables/pages/private_pages_are_public_warning.md
index 2579c5d10f51..7620878dbc38 100644
--- a/data/reusables/pages/private_pages_are_public_warning.md
+++ b/data/reusables/pages/private_pages_are_public_warning.md
@@ -1,5 +1,5 @@
{% warning %}
- **Warning**: {% if currentVersion != "free-pro-team@latest" %}If your site administrator has enabled Public Pages, {% endif %}{% data variables.product.prodname_pages %} sites are publicly available on the internet, even if the repository for the site is private{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} or internal{% endif %}. If you have sensitive data in your site's repository, you may want to remove it before publishing. For more information, see{% if currentVersion != "free-pro-team@latest" %} "[Configuring {% data variables.product.prodname_pages %} on your appliance](/enterprise/admin/installation/configuring-github-pages-on-your-appliance#making-github-pages-publicly-accessible)" and{% endif %} "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility)."
+ **Warning**: {% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}If your site administrator has enabled Public Pages, {% endif %}{% data variables.product.prodname_pages %} sites are publicly available on the internet, even if the repository for the site is private{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %} or internal{% endif %}. If you have sensitive data in your site's repository, you may want to remove it before publishing. For more information, see{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} "[Configuring {% data variables.product.prodname_pages %} for your enterprise](/admin/configuration/configuring-github-pages-for-your-enterprise#enabling-public-sites-for-github-pages)" and{% endif %} "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility)."
{% endwarning %}
diff --git a/data/reusables/pre-release-program/expiring-user-access-tokens-beta.md b/data/reusables/pre-release-program/expiring-user-access-tokens-beta.md
index 1594eb596a97..6bf0fb2ed47a 100644
--- a/data/reusables/pre-release-program/expiring-user-access-tokens-beta.md
+++ b/data/reusables/pre-release-program/expiring-user-access-tokens-beta.md
@@ -1,4 +1,4 @@
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}
{% note %}
**Note:** Expiring user tokens are currently part of the user-to-server token expiration beta and subject to change. To opt-in to the user-to-server token expiration beta feature, see "[Activating beta features for apps](/developers/apps/activating-beta-features-for-apps)." For more information, see "[Expiring user-to-server access tokens for GitHub Apps](https://developer.github.com/changes/2020-04-30-expiring-user-to-server-access-tokens-for-github-apps)."
diff --git a/data/reusables/pre-release-program/fury-pre-release.md b/data/reusables/pre-release-program/fury-pre-release.md
index 5e63be71606a..25b74a97ea78 100644
--- a/data/reusables/pre-release-program/fury-pre-release.md
+++ b/data/reusables/pre-release-program/fury-pre-release.md
@@ -1,4 +1,4 @@
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.21" %}
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.21" %}
{% note %}
**Note:** {% data variables.product.prodname_github_app %} Manifests are currently available for developers to preview. To access this API during the preview period, you must provide a custom [media type](/v3/media) in the `Accept` header:
diff --git a/data/reusables/pre-release-program/machine-man-preview.md b/data/reusables/pre-release-program/machine-man-preview.md
index bdcee03dec6f..d18399b6630f 100644
--- a/data/reusables/pre-release-program/machine-man-preview.md
+++ b/data/reusables/pre-release-program/machine-man-preview.md
@@ -1,4 +1,4 @@
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
{% note %}
**Note:** To access the API with your GitHub App, you must provide a custom [media type](/v3/media) in the `Accept` Header for your requests.
diff --git a/data/reusables/pre-release-program/sailor-v-preview.md b/data/reusables/pre-release-program/sailor-v-preview.md
index 271ed23002c8..fcf2e98e68a3 100644
--- a/data/reusables/pre-release-program/sailor-v-preview.md
+++ b/data/reusables/pre-release-program/sailor-v-preview.md
@@ -1,4 +1,4 @@
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
{% note %}
**Note:** You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in `locked` events. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-10-lock-reason-api-preview) for full details. To access this feature, you must provide a custom [media type](/v3/media) in the `Accept` header:
diff --git a/data/reusables/pre-release-program/suspend-installation-beta.md b/data/reusables/pre-release-program/suspend-installation-beta.md
index 3d81271d74ca..42ef3db1bcb4 100644
--- a/data/reusables/pre-release-program/suspend-installation-beta.md
+++ b/data/reusables/pre-release-program/suspend-installation-beta.md
@@ -1,4 +1,4 @@
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}
Suspending a {% data variables.product.prodname_github_app %} installation is currently in beta and subject to change. Before you can suspend a {% data variables.product.prodname_github_app %}, the app owner must enable suspending installations for the app by opting-in to the beta. To opt-in to the suspending installations beta feature, see "[Activating beta features for apps](/developers/apps/activating-beta-features-for-apps)."
{% endif %}
diff --git a/data/reusables/profile/user_profile_page_block_or_report.md b/data/reusables/profile/user_profile_page_block_or_report.md
index 36884a9da111..5cca0046a5af 100644
--- a/data/reusables/profile/user_profile_page_block_or_report.md
+++ b/data/reusables/profile/user_profile_page_block_or_report.md
@@ -1,2 +1,2 @@
-1. In the left sidebar, under the user's profile picture, click **Block or report user**.
+1. In the left sidebar, under the user's profile picture, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}, then click **Block or report user**.
diff --git a/data/reusables/project-management/project-progress-locations.md b/data/reusables/project-management/project-progress-locations.md
index d8863f3c3b77..9ac6c41be933 100644
--- a/data/reusables/project-management/project-progress-locations.md
+++ b/data/reusables/project-management/project-progress-locations.md
@@ -1 +1 @@
-When project board automation is enabled, a progress bar appears above the project board, on the project listing page, in the issue sidebar and in references to the project on other project boards.
+If progress tracking is enabled, a progress bar appears above the project board, on the project listing page, in the issue sidebar, and in references to the project on other project boards.
diff --git a/data/reusables/project-management/resync-automation.md b/data/reusables/project-management/resync-automation.md
index a5281a26ff0d..38b2f7a9e86a 100644
--- a/data/reusables/project-management/resync-automation.md
+++ b/data/reusables/project-management/resync-automation.md
@@ -1 +1 @@
-When you close a project board, any workflow automation configured for the project board will pause. If you reopen a project board, you have the option to sync automation, which updates the positon of the cards on the board according to the automation settings configured for the board. For more information, see "[Reopening a closed project board](/articles/reopening-a-closed-project-board)" or "[Closing a project board](/articles/closing-a-project-board)."
+When you close a project board, any workflow automation configured for the project board will pause. If you reopen a project board, you have the option to sync automation, which updates the position of the cards on the board according to the automation settings configured for the board. For more information, see "[Reopening a closed project board](/articles/reopening-a-closed-project-board)" or "[Closing a project board](/articles/closing-a-project-board)."
diff --git a/data/reusables/pull_requests/close-issues-using-keywords.md b/data/reusables/pull_requests/close-issues-using-keywords.md
index c1012380d94a..041d949ef282 100644
--- a/data/reusables/pull_requests/close-issues-using-keywords.md
+++ b/data/reusables/pull_requests/close-issues-using-keywords.md
@@ -1 +1 @@
-You can link a pull request to an issue to{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %} show that a fix is in progress and to{% endif %} automatically close the issue when someone merges the pull request. For more information, see "[Linking a pull request to an issue](/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue)."
+You can link a pull request to an issue to{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %} show that a fix is in progress and to{% endif %} automatically close the issue when someone merges the pull request. For more information, see "[Linking a pull request to an issue](/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue)."
diff --git a/data/reusables/pull_requests/pull_request_merges_and_contributions.md b/data/reusables/pull_requests/pull_request_merges_and_contributions.md
index 1117b51b1e29..bab06a961ba3 100644
--- a/data/reusables/pull_requests/pull_request_merges_and_contributions.md
+++ b/data/reusables/pull_requests/pull_request_merges_and_contributions.md
@@ -1,6 +1,6 @@
{% note %}
-**Notes:**{% if currentVersion != "free-pro-team@latest" %}
+**Notes:**{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
- To appear on your profile contributions graph, co-authored commits must meet the same criteria as commits with one author.{% endif %}
- When rebasing commits, the original authors of the commit and the person who rebased the commits, whether on the command line or on {% data variables.product.product_location %}, receive contribution credit.
diff --git a/data/reusables/pull_requests/re-request-review.md b/data/reusables/pull_requests/re-request-review.md
new file mode 100644
index 000000000000..5776451f772f
--- /dev/null
+++ b/data/reusables/pull_requests/re-request-review.md
@@ -0,0 +1,2 @@
+You can re-request a review, for example, after you've made substantial changes to your pull request.
+To request a fresh review from a reviewer, in the sidebar of the **Conversation** tab, click the {% octicon "sync" aria-label="The sync icon" %} icon.
diff --git a/data/reusables/repositories/about-internal-repos.md b/data/reusables/repositories/about-internal-repos.md
index d921cfd13384..61358584cde6 100644
--- a/data/reusables/repositories/about-internal-repos.md
+++ b/data/reusables/repositories/about-internal-repos.md
@@ -1 +1 @@
-You can use internal repositories to practice "innersource" within your {% if currentVersion == "free-pro-team@latest" %}enterprise account{% else %}instance{% endif %}. Members of {% if currentVersion == "free-pro-team@latest" %}your enterprise account{% else %}any organization on your instance{% endif %} can collaborate using open source methodologies without sharing proprietary information publicly{% if currentVersion != "free-pro-team@latest" %}, even with private mode disabled{% endif %}.
+You can use internal repositories to practice "innersource" within your enterprise. Members of your enterprise can collaborate using open source methodologies without sharing proprietary information publicly{% if enterpriseServerVersions contains currentVersion %}, even with private mode disabled{% endif %}.
diff --git a/data/reusables/repositories/copy-clone-url.md b/data/reusables/repositories/copy-clone-url.md
index 1eedee08bdee..938c416090c9 100644
--- a/data/reusables/repositories/copy-clone-url.md
+++ b/data/reusables/repositories/copy-clone-url.md
@@ -1,4 +1,4 @@
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
1. Under the repository name, click **Clone or download**.
2. To clone the repository using HTTPS, under "Clone with HTTPS", click {% octicon "clippy" aria-label="The clipboard icon" %}.
@@ -7,8 +7,8 @@ To clone the repository using an SSH key, including a certificate issued by your
{% else %}
1. Above the list of files, click {% octicon "download" aria-label="The download icon" %} **Code**.
-1. To clone the repository using HTTPS, under "Clone with HTTPS", click {% octicon "clippy" aria-label="The clipboard icon" %}. To clone the repository using an SSH key, including a certificate issued by your organization's SSH certificate authority, click **Use SSH**, then click {% octicon "clippy" aria-label="The clipboard icon" %}.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} To clone a repository using {% data variables.product.prodname_cli %}, click **Use {% data variables.product.prodname_cli %}**, then click {% octicon "clippy" aria-label="The clipboard icon" %}.{% endif %}
+1. To clone the repository using HTTPS, under "Clone with HTTPS", click {% octicon "clippy" aria-label="The clipboard icon" %}. To clone the repository using an SSH key, including a certificate issued by your organization's SSH certificate authority, click **Use SSH**, then click {% octicon "clippy" aria-label="The clipboard icon" %}.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} To clone a repository using {% data variables.product.prodname_cli %}, click **Use {% data variables.product.prodname_cli %}**, then click {% octicon "clippy" aria-label="The clipboard icon" %}.{% endif %}
- {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}
+ {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %}
{% endif %}
{% endif %}
diff --git a/data/reusables/repositories/create-repo.md b/data/reusables/repositories/create-repo.md
index 08c93fd7c13c..98222369c45b 100644
--- a/data/reusables/repositories/create-repo.md
+++ b/data/reusables/repositories/create-repo.md
@@ -1,2 +1,2 @@
-1. Click **Create repository**.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
+1. Click **Create repository**.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}
{% endif %}
diff --git a/data/reusables/repositories/default-issue-templates.md b/data/reusables/repositories/default-issue-templates.md
index 9d4e465b3f3b..1908fd5895b5 100644
--- a/data/reusables/repositories/default-issue-templates.md
+++ b/data/reusables/repositories/default-issue-templates.md
@@ -1,2 +1,2 @@
-You can create default issue templates{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} and a default configuration file for issue templates{% endif %} for your organization{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} or user account{% endif %}. For more information, see "[Creating a default community health file](/github/building-a-strong-community/creating-a-default-community-health-file)."
+You can create default issue templates{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %} and a default configuration file for issue templates{% endif %} for your organization{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %} or user account{% endif %}. For more information, see "[Creating a default community health file](/github/building-a-strong-community/creating-a-default-community-health-file)."
diff --git a/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md b/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md
index 9a8ba68745a5..979cf68329cd 100644
--- a/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md
+++ b/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md
@@ -2,10 +2,10 @@
**Warning:**
-- If you remove a person’s access to a private repository, any of their forks of that private repository are deleted. Local clones of the private repository are retained. If a team's access to a private repository is revoked or a team with access to a private repository is deleted, and team members do not have access to the repository through another team, private forks of the repository will be deleted.{% if currentVersion != "free-pro-team@latest" %}
+- If you remove a person’s access to a private repository, any of their forks of that private repository are deleted. Local clones of the private repository are retained. If a team's access to a private repository is revoked or a team with access to a private repository is deleted, and team members do not have access to the repository through another team, private forks of the repository will be deleted.{% if enterpriseServerVersions contains currentVersion %}
- When [LDAP Sync is enabled](/enterprise/admin/authentication/using-ldap#enabling-ldap-sync), if you remove a person from a repository, they will lose access but their forks will not be deleted. If the person is added to a team with access to the original organization repository within three months, their access to the forks will be automatically restored on the next sync.{% endif %}
- You are responsible for ensuring that people who have lost access to a repository delete any confidential information or intellectual property.
-- People with admin permissions to a private{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} or internal{% endif %} repository can disallow forking of that repository, and organization owners can disallow forking of any private{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} or internal{% endif %} repository in an organization. For more information, see "[Managing the forking policy for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-the-forking-policy-for-your-organization)" and "[Managing the forking policy for your repository](/github/administering-a-repository/managing-the-forking-policy-for-your-repository)."
+- People with admin permissions to a private{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %} or internal{% endif %} repository can disallow forking of that repository, and organization owners can disallow forking of any private{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %} or internal{% endif %} repository in an organization. For more information, see "[Managing the forking policy for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-the-forking-policy-for-your-organization)" and "[Managing the forking policy for your repository](/github/administering-a-repository/managing-the-forking-policy-for-your-repository)."
{% endwarning %}
diff --git a/data/reusables/repositories/enable-security-alerts.md b/data/reusables/repositories/enable-security-alerts.md
index 098201013568..1f1c4cd5fce0 100644
--- a/data/reusables/repositories/enable-security-alerts.md
+++ b/data/reusables/repositories/enable-security-alerts.md
@@ -1,3 +1,3 @@
-{% if currentVersion != "free-pro-team@latest" %}
-Your site administrator must enable {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_short %}{% else %}security{% endif %} alerts for vulnerable dependencies for {% data variables.product.product_location_enterprise %} before you can use this feature. For more information, see "[Enabling alerts for vulnerable dependencies on {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server)."
+{% if enterpriseServerVersions contains currentVersion %}
+Your site administrator must enable {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot %}{% else %}security{% endif %} alerts for vulnerable dependencies for {% data variables.product.product_location %} before you can use this feature. For more information, see "[Enabling alerts for vulnerable dependencies on {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server)."
{% endif %}
diff --git a/data/reusables/repositories/new-pull-request.md b/data/reusables/repositories/new-pull-request.md
index 27fdaa3a7ec3..e463aa28b820 100644
--- a/data/reusables/repositories/new-pull-request.md
+++ b/data/reusables/repositories/new-pull-request.md
@@ -1,4 +1,4 @@
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
1. To the right of the Branch menu, click **New pull request**.
{% else %}
diff --git a/data/reusables/repositories/open-with-github-desktop.md b/data/reusables/repositories/open-with-github-desktop.md
index 5c283d7fd7de..e938fb80ae16 100644
--- a/data/reusables/repositories/open-with-github-desktop.md
+++ b/data/reusables/repositories/open-with-github-desktop.md
@@ -1,4 +1,4 @@
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
1. Under your repository name, click **Clone or download**.
1. Click **Open in Desktop** to clone the repository and open it in {% data variables.product.prodname_desktop %}.
diff --git a/data/reusables/repositories/releases.md b/data/reusables/repositories/releases.md
index 3ff9e45c88f8..10d311037f33 100644
--- a/data/reusables/repositories/releases.md
+++ b/data/reusables/repositories/releases.md
@@ -1,4 +1,4 @@
-{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
+{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
1. Under your repository name, click **Releases**.
diff --git a/data/reusables/repositories/security-alert-delivery-options.md b/data/reusables/repositories/security-alert-delivery-options.md
index 6db74f698884..4ead57f69504 100644
--- a/data/reusables/repositories/security-alert-delivery-options.md
+++ b/data/reusables/repositories/security-alert-delivery-options.md
@@ -1 +1,3 @@
+{% if currentVersion != "github-ae@latest" %}
If your repository has a supported dependency manifest{% if currentVersion == "free-pro-team@latest" %} (and if you've set up the dependency graph if it's a private repository){% endif %}, whenever {% data variables.product.product_name %} detects a vulnerable dependency in your repository, you will receive a weekly digest email. You can also configure your security alerts as web notifications, individual email notifications, daily email digests, or alerts in the {% data variables.product.product_name %} interface. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)."
+{% endif %}
\ No newline at end of file
diff --git a/data/reusables/repositories/sidebar-dependabot-alerts.md b/data/reusables/repositories/sidebar-dependabot-alerts.md
index b5e860b43ea2..30ce19c2e00a 100644
--- a/data/reusables/repositories/sidebar-dependabot-alerts.md
+++ b/data/reusables/repositories/sidebar-dependabot-alerts.md
@@ -1,2 +1,2 @@
-1. In the security sidebar, click **{% data variables.product.prodname_dependabot_short %} alerts**.
-
+1. In the security sidebar, click **{% data variables.product.prodname_dependabot_alerts %}**.
+
diff --git a/data/reusables/repositories/squash-and-rebase-linear-commit-hisitory.md b/data/reusables/repositories/squash-and-rebase-linear-commit-hisitory.md
index 966f92ecab5b..b74d5905b1e4 100644
--- a/data/reusables/repositories/squash-and-rebase-linear-commit-hisitory.md
+++ b/data/reusables/repositories/squash-and-rebase-linear-commit-hisitory.md
@@ -1 +1 @@
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}If there is a protected branch rule in your repository that requires a linear commit history, you must allow squash merging, rebase merging, or both. For more information, see "[Requiring a linear commit history](/github/administering-a-repository/requiring-a-linear-commit-history)."{% endif %}
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %}If there is a protected branch rule in your repository that requires a linear commit history, you must allow squash merging, rebase merging, or both. For more information, see "[Requiring a linear commit history](/github/administering-a-repository/requiring-a-linear-commit-history)."{% endif %}
diff --git a/data/reusables/repositories/start-line-comment.md b/data/reusables/repositories/start-line-comment.md
index a4ac3ac6e00d..14fb75a2b33a 100644
--- a/data/reusables/repositories/start-line-comment.md
+++ b/data/reusables/repositories/start-line-comment.md
@@ -1,2 +1,2 @@
-1. Hover over the line of code where you'd like to add a comment, and click the blue comment icon.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} To add a comment on multiple lines, click and drag to select the range of lines, then click the blue comment icon.{% endif %}
+1. Hover over the line of code where you'd like to add a comment, and click the blue comment icon.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %} To add a comment on multiple lines, click and drag to select the range of lines, then click the blue comment icon.{% endif %}
diff --git a/data/reusables/repositories/suggest-changes.md b/data/reusables/repositories/suggest-changes.md
index cf0f27c21fd0..4e7a49c9ed37 100644
--- a/data/reusables/repositories/suggest-changes.md
+++ b/data/reusables/repositories/suggest-changes.md
@@ -1,2 +1,2 @@
-1. Optionally, to suggest a specific change to the line{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %} or lines{% endif %}, click {% octicon "diff" aria-label="The diff symbol" %}, then edit the text within the suggestion block.
+1. Optionally, to suggest a specific change to the line{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %} or lines{% endif %}, click {% octicon "diff" aria-label="The diff symbol" %}, then edit the text within the suggestion block.
diff --git a/data/reusables/repositories/tracks-vulnerabilities.md b/data/reusables/repositories/tracks-vulnerabilities.md
index d2ad199b797f..f0d6decd8fea 100644
--- a/data/reusables/repositories/tracks-vulnerabilities.md
+++ b/data/reusables/repositories/tracks-vulnerabilities.md
@@ -3,4 +3,3 @@ We add vulnerabilities to the {% data variables.product.prodname_advisory_databa
- A combination of machine learning and human review to detect vulnerabilities in public commits on {% data variables.product.prodname_dotcom %}
- Security advisories reported on {% data variables.product.prodname_dotcom %}
- The [npm Security advisories](https://www.npmjs.com/advisories) database
-- [FriendsOfPHP](https://github.com/FriendsOfPHP/security-advisories)
diff --git a/data/reusables/saml/ae-enable-saml-sso-during-bootstrapping.md b/data/reusables/saml/ae-enable-saml-sso-during-bootstrapping.md
new file mode 100644
index 000000000000..e60bce6013ec
--- /dev/null
+++ b/data/reusables/saml/ae-enable-saml-sso-during-bootstrapping.md
@@ -0,0 +1 @@
+You'll configure identity and access management for {% data variables.product.product_name %} by entering the details for your SAML IdP during initialization. For more information, see "[Initializing {% data variables.product.prodname_ghe_managed %}](/admin/configuration/initializing-github-ae#connecting-your-idp-to-your-enterprise)."
diff --git a/data/reusables/saml/ae-uses-saml-sso.md b/data/reusables/saml/ae-uses-saml-sso.md
new file mode 100644
index 000000000000..08c138d1ba7b
--- /dev/null
+++ b/data/reusables/saml/ae-uses-saml-sso.md
@@ -0,0 +1 @@
+{% data variables.product.product_name %} uses SAML SSO for user authentication. You can centrally manage access to {% data variables.product.prodname_ghe_managed %} from an IdP that supports the SAML 2.0 standard.
diff --git a/data/reusables/saml/assert-the-administrator-attribute.md b/data/reusables/saml/assert-the-administrator-attribute.md
new file mode 100644
index 000000000000..ff9e3bc75d7c
--- /dev/null
+++ b/data/reusables/saml/assert-the-administrator-attribute.md
@@ -0,0 +1 @@
+To make a person an enterprise owner, you must delegate ownership permission in your IdP. Include the `administrator` attribute in the SAML assertion for the user account on the IdP, with the value of `true`. For more information about enterprise owners, see "[Roles in an enterprise](/github/setting-up-and-managing-your-enterprise/roles-in-an-enterprise)."
diff --git a/data/reusables/saml/contact-support-if-your-idp-is-unavailable.md b/data/reusables/saml/contact-support-if-your-idp-is-unavailable.md
new file mode 100644
index 000000000000..cadca78570ff
--- /dev/null
+++ b/data/reusables/saml/contact-support-if-your-idp-is-unavailable.md
@@ -0,0 +1 @@
+If you can't sign into your enterprise because {% data variables.product.product_name %} can't communicate with your SAML IdP, you can contact {% data variables.contact.github_support %}, who can help you access {% data variables.product.product_name %} to update the SAML SSO configuration. For more information, see "[Receiving help from {% data variables.contact.github_support %}](/admin/enterprise-support/receiving-help-from-github-support)."
diff --git a/data/reusables/saml/create-a-machine-user.md b/data/reusables/saml/create-a-machine-user.md
new file mode 100644
index 000000000000..0f0bdbf11dd0
--- /dev/null
+++ b/data/reusables/saml/create-a-machine-user.md
@@ -0,0 +1 @@
+Create and use a dedicated machine user account on your IdP to associate with the first enterprise owner account on {% data variables.product.product_name %}. Store the credentials for the user account securely in a password manager.
diff --git a/data/reusables/saml/you-must-periodically-authenticate.md b/data/reusables/saml/you-must-periodically-authenticate.md
new file mode 100644
index 000000000000..f1a2af7d1252
--- /dev/null
+++ b/data/reusables/saml/you-must-periodically-authenticate.md
@@ -0,0 +1 @@
+You must periodically authenticate with your SAML IdP to authenticate and gain access to {% if currentVersion == "free-pro-team@latest" %}the organization's resources on {% data variables.product.prodname_dotcom_the_website %}{% elsif currentVersion == "github-ae@latest" %}{% data variables.product.product_location %}{% endif %}. The duration of this login period is specified by your IdP and is generally 24 hours. This periodic login requirement limits the length of access and requires you to re-identify yourself to continue. {% if currentVersion == "free-pro-team@latest" %}You can view and manage your active SAML sessions in your security settings. For more information, see "[Viewing and managing your active SAML sessions](/articles/viewing-and-managing-your-active-saml-sessions)."{% endif %}
diff --git a/data/reusables/scim/after-you-configure-saml.md b/data/reusables/scim/after-you-configure-saml.md
new file mode 100644
index 000000000000..85246f3cf071
--- /dev/null
+++ b/data/reusables/scim/after-you-configure-saml.md
@@ -0,0 +1 @@
+By default, your IdP does not communicate with {% data variables.product.product_name %} automatically when you assign or unassign the application. {% data variables.product.product_name %} {% if currentVersion == "free-pro-team@latest" %}provisions access to your resources on {% else %}creates a user account {% endif %}using SAML Just-in-Time (JIT) provisioning the first time someone navigates to {% if currentVersion == "free-pro-team@latest" %}your resources on {% endif %} {% data variables.product.product_name %} and signs in by authenticating through your IdP. You may need to manually notify users when you grant access to {% data variables.product.product_name %}, and you must manually {% if currentVersion == "free-pro-team@latest" %}deprovision access {% else %}deactivate the user account on {% endif %}{% data variables.product.product_name %} during offboarding. You can use SCIM to provision and deprovision {% if currentVersion == "free-pro-team@latest" %}access to organizations owned by your enterprise on {% data variables.product.prodname_dotcom_the_website %} {% else %}user accounts and access for {% data variables.product.product_name %} {% endif %}automatically when you assign or unassign the application on your IdP.
\ No newline at end of file
diff --git a/data/reusables/scim/supported-idps.md b/data/reusables/scim/supported-idps.md
new file mode 100644
index 000000000000..84aea5e72421
--- /dev/null
+++ b/data/reusables/scim/supported-idps.md
@@ -0,0 +1,5 @@
+The following IdPs can provision or deprovision user accounts on {% data variables.product.product_location %} using SCIM.
+
+{% if currentVersion == "github-ae@latest" %}
+- Azure AD
+{% endif %}
diff --git a/data/reusables/search/syntax_tips.md b/data/reusables/search/syntax_tips.md
index 6dc749ad9441..9470b7f01a9d 100644
--- a/data/reusables/search/syntax_tips.md
+++ b/data/reusables/search/syntax_tips.md
@@ -1,7 +1,7 @@
{% tip %}
-**Tips:**{% if currentVersion != "free-pro-team@latest" %}
- - This article contains example searches on the {% data variables.product.prodname_dotcom %}.com website, but you can use the same search filters on {% data variables.product.product_location_enterprise %}.{% endif %}
+**Tips:**{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}
+ - This article contains example searches on the {% data variables.product.prodname_dotcom %}.com website, but you can use the same search filters on {% data variables.product.product_location %}.{% endif %}
- For a list of search syntaxes that you can add to any search qualifier to further improve your results, see "[Understanding the search syntax](/articles/understanding-the-search-syntax)".
- Use quotations around multi-word search terms. For example, if you want to search for issues with the label "In progress," you'd search for `label:"in progress"`. Search is not case sensitive.
diff --git a/data/reusables/support/enterprise-resolving-and-closing-tickets.md b/data/reusables/support/enterprise-resolving-and-closing-tickets.md
index 0b92dd76155b..8e7b74cc3cdb 100644
--- a/data/reusables/support/enterprise-resolving-and-closing-tickets.md
+++ b/data/reusables/support/enterprise-resolving-and-closing-tickets.md
@@ -1,5 +1,5 @@
-{% data variables.contact.enterprise_support %} may consider a ticket solved after providing an explanation, recommendation, usage instructions, workaround instructions, or by advising you of an available release that addresses the issue.
+{% data variables.contact.enterprise_support %} may consider a ticket solved after providing an explanation, recommendation, usage instructions, {% if currentVersion == "github-ae@latest" %}or {% endif %} workaround instructions{% if enterpriseServerVersions contains currentVersion %}, or by advising you of an available release that addresses the issue{% endif %}.
If you use a custom or unsupported plug-in, module, or custom code, {% data variables.contact.enterprise_support %} may ask you to remove the unsupported plug-in, module, or code while attempting to resolve the issue. If the problem is fixed when the unsupported plug-in, module, or custom code is removed, {% data variables.contact.enterprise_support %} may consider the ticket solved.
-{% data variables.contact.enterprise_support %} may close tickets if they're outside the scope of support or if multiple attempts to contact you have gone unanswered. If {% data variables.contact.enterprise_support %} closes a ticket due to lack of response, you can request that {% data variables.contact.enterprise_support %} reopen the ticket.
+{% data variables.contact.enterprise_support %} may close a ticket if the ticket is outside the scope of support or if multiple attempts to contact you have gone unanswered. If {% data variables.contact.enterprise_support %} closes a ticket due to lack of response, you can request that {% data variables.contact.enterprise_support %} reopen the ticket.
diff --git a/data/reusables/support/ghae-priorities.md b/data/reusables/support/ghae-priorities.md
new file mode 100644
index 000000000000..028e6d18589b
--- /dev/null
+++ b/data/reusables/support/ghae-priorities.md
@@ -0,0 +1,6 @@
+| Priority | Description | Examples |
+| :---: | --- | --- |
+| {% data variables.product.support_ticket_priority_urgent %} - Sev A | {% data variables.product.product_name %} is inaccessible or failing entirely, and the failure directly impacts the operation of your business.
_After you file a support ticket, reach out to {% data variables.contact.github_support %} via phone._ | - Errors or outages that affect core Git or web application functionality for all users
- Severe network or performance degradation for majority of users
- Full or rapidly filling storage
- Known security incidents or a breach of access
|
+| {% data variables.product.support_ticket_priority_high %} - Sev B | {% data variables.product.product_name %} is failing in a production environment, with limited impact to your business processes, or only affecting certain customers. | - Performance degradation that reduces productivity for many users
- Reduced redundancy concerns from failures or service degradation
- Production-impacting bugs or errors
- {% data variables.product.product_name %} configuraton security concerns
|
+| {% data variables.product.support_ticket_priority_normal %} - Sev C | {% data variables.product.product_name %} is experiencing limited or moderate issues and errors with {% data variables.product.product_name %}, or you have general concerns or questions about the operation of {% data variables.product.product_name %}. | - Advice on using {% data variables.product.prodname_dotcom %} APIs and features, or questions about integrating business workflows
- Issues with user tools and data collection methods
- Upgrades
- Bug reports, general security questions, or other feature related questions
|
+| {% data variables.product.support_ticket_priority_low %} - Sev D| {% data variables.product.product_name %} is functioning as expected, however, you have a question or suggestion about {% data variables.product.product_name %} that is not time-sensitive, or does not otherwise block the productivity of your team. | - Feature requests and product feedback
- General questions on overall configuration or use of {% data variables.product.product_name %}
- Notifying {% data variables.contact.github_support %} of any planned changes
|
diff --git a/data/reusables/support/government-response-times-may-vary.md b/data/reusables/support/government-response-times-may-vary.md
new file mode 100644
index 000000000000..a171b413d848
--- /dev/null
+++ b/data/reusables/support/government-response-times-may-vary.md
@@ -0,0 +1,7 @@
+{% if currentVersion == "github-ae@latest" %}
+{% note %}
+
+**Note:** Response times and hours of operation may differ for {% data variables.product.prodname_ghe_managed %} for Government. Your Technical Support Account Manager (TSAM) will confirm during your onboarding.
+
+{% endnote %}
+{% endif %}
\ No newline at end of file
diff --git a/data/reusables/support/help_resources.md b/data/reusables/support/help_resources.md
index 6e226b167b40..b947358c27b9 100644
--- a/data/reusables/support/help_resources.md
+++ b/data/reusables/support/help_resources.md
@@ -1,4 +1,4 @@
-For questions, bug reports, and discussions about {% data variables.product.prodname_github_app %}s, {% data variables.product.prodname_oauth_app %}s, and API development, explore the {% data variables.product.prodname_support_forum_with_url %}. The forum is moderated and maintained by {% data variables.product.product_name %} staff, but questions posted to the forum are not guaranteed to receive a reply from {% data variables.product.product_name %} staff.
+For questions, bug reports, and discussions about {% data variables.product.prodname_github_app %}s, {% data variables.product.prodname_oauth_app %}s, and API development, explore the {% data variables.product.prodname_support_forum_with_url %}. The forum is moderated and maintained by {% data variables.product.company_short %} staff, but questions posted to the forum are not guaranteed to receive a reply from {% data variables.product.company_short %} staff.
Consider reaching out to [GitHub Support](https://github.com/contact) directly using the contact form for:
- guaranteed response from {% data variables.product.product_name %} staff
diff --git a/data/reusables/support/premium-resolving-and-closing-tickets.md b/data/reusables/support/premium-resolving-and-closing-tickets.md
index fd2b6dab1937..01055b4e78bb 100644
--- a/data/reusables/support/premium-resolving-and-closing-tickets.md
+++ b/data/reusables/support/premium-resolving-and-closing-tickets.md
@@ -2,4 +2,4 @@
If you use a custom or unsupported plug-in, module, or custom code, {% data variables.contact.premium_support %} may ask you to remove the unsupported plug-in, module, or code while attempting to resolve the issue. If the problem is fixed when the unsupported plug-in, module, or custom code is removed, {% data variables.contact.premium_support %} may consider the ticket solved.
-{% data variables.contact.premium_support %} may close tickets if they're outside the scope of support or if multiple attempts to contact you have gone unanswered. If {% data variables.contact.premium_support %} closes a ticket due to lack of response, you can request that {% data variables.contact.premium_support %} reopen the ticket.
+{% data variables.contact.premium_support %} may close a ticket if the ticket is outside the scope of support or if multiple attempts to contact you have gone unanswered. If {% data variables.contact.premium_support %} closes a ticket due to lack of response, you can request that {% data variables.contact.premium_support %} reopen the ticket.
diff --git a/data/reusables/support/scope-of-support.md b/data/reusables/support/scope-of-support.md
index 552a041f9d20..03157892bf89 100644
--- a/data/reusables/support/scope-of-support.md
+++ b/data/reusables/support/scope-of-support.md
@@ -1,7 +1,7 @@
### Scope of support
-If your support request is outside of the scope of what our team can help you with, we may recommend next steps to resolve your issue outside of {% data variables.contact.github_support %}. Your support request is possibly out of {% data variables.contact.github_support %}'s scope if it's primarily about:
+If your support request is outside of the scope of what our team can help you with, we may recommend next steps to resolve your issue outside of {% data variables.contact.github_support %}. Your support request is possibly out of {% data variables.contact.github_support %}'s scope if the request is primarily about:
- Third party integrations
- Hardware setup
- CI/CD, such as Jenkins
diff --git a/data/reusables/two_fa/auth_methods_2fa.md b/data/reusables/two_fa/auth_methods_2fa.md
index 1ee2e5d7ca71..791fb1804cb5 100644
--- a/data/reusables/two_fa/auth_methods_2fa.md
+++ b/data/reusables/two_fa/auth_methods_2fa.md
@@ -1,9 +1,9 @@
-{% if currentVersion != "free-pro-team@latest" %}
+{% if enterpriseServerVersions contains currentVersion %}
### Authentication methods that support 2FA
| Authentication Method | Description | Two-factor authentication support |
|-----------------------|--------------|-----------------------------------|
-| Built-in | Authentication is performed against user accounts that are stored on the {% data variables.product.prodname_ghe_server %} appliance. | Supported and managed on the {% data variables.product.prodname_ghe_server %} appliance. Organization administrators can require 2FA to be enabled for members of the organization. |{% if currentVersion != "free-pro-team@latest" %}
+| Built-in | Authentication is performed against user accounts that are stored on the {% data variables.product.prodname_ghe_server %} appliance. | Supported and managed on the {% data variables.product.prodname_ghe_server %} appliance. Organization administrators can require 2FA to be enabled for members of the organization. |{% if enterpriseServerVersions contains currentVersion %}
| Built-in authentication with an identity provider| Authentication is performed against user accounts that are stored on the identity provider. | Dependant on the identity provider.{% endif %}
| LDAP | Allows integration with your company directory service for authentication. | Supported and managed on the {% data variables.product.prodname_ghe_server %} appliance. Organization administrators can require 2FA to be enabled for members of the organization. |
| SAML | Authentication is performed on an external identity provider. | {% data reusables.two_fa.2fa_not_supported_with_saml_and_cas %} |
diff --git a/data/reusables/user_settings/add_and_verify_email.md b/data/reusables/user_settings/add_and_verify_email.md
index 295cdbf5dc0b..48abb2d08a88 100644
--- a/data/reusables/user_settings/add_and_verify_email.md
+++ b/data/reusables/user_settings/add_and_verify_email.md
@@ -1,3 +1,5 @@
+{% if currentVersion != "github-ae@latest" %}
1. In "Add email address", type your email address and click **Add**.
{% if currentVersion == "free-pro-team@latest" %}
2. [Verify your email address](/articles/verifying-your-email-address).{% endif %}
+{% endif %}
\ No newline at end of file
diff --git a/data/reusables/user_settings/link_email_with_your_account.md b/data/reusables/user_settings/link_email_with_your_account.md
index 76c606dd7c20..0b7e0fcb1b0e 100644
--- a/data/reusables/user_settings/link_email_with_your_account.md
+++ b/data/reusables/user_settings/link_email_with_your_account.md
@@ -1 +1,3 @@
-Add the email address to your {% data variables.product.product_name %} account by [setting your commit email address](/articles/setting-your-commit-email-address), so that your commits are attributed to you and appear in your contributions graph.
+{% if currentVersion != "github-ae@latest" %}
+Add the email address to your account on {% data variables.product.product_name %}, so that your commits are attributed to you and appear in your contributions graph. For more information, see "[Adding an email address to your {% data variables.product.prodname_dotcom %} account](/github/setting-up-and-managing-your-github-user-account/adding-an-email-address-to-your-github-account)."
+{% endif %}
\ No newline at end of file
diff --git a/data/reusables/user_settings/password-authentication-deprecation.md b/data/reusables/user_settings/password-authentication-deprecation.md
index ade0a4e28d59..bd247793cef3 100644
--- a/data/reusables/user_settings/password-authentication-deprecation.md
+++ b/data/reusables/user_settings/password-authentication-deprecation.md
@@ -1 +1 @@
-Password-based authentication for Git is deprecated, and we recommend using a personal access token (PAT) when prompted for a password instead, which is more secure. Treat your token just like a password. For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)."
+When Git prompts you for your password, enter your personal access token (PAT) instead.{% if currentVersion != "github-ae@latest" %} Password-based authentication for Git is deprecated, and using a PAT is more secure.{% endif %} For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)."
diff --git a/data/reusables/user_settings/security.md b/data/reusables/user_settings/security.md
index 8cbb3b36dc7b..182a5688e8a1 100644
--- a/data/reusables/user_settings/security.md
+++ b/data/reusables/user_settings/security.md
@@ -1,4 +1,4 @@
-{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}1. In the left sidebar, click **Account security**.
+{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}1. In the left sidebar, click **Account security**.
{% else %}1. In the left sidebar, click **Security**.
{% endif %}
diff --git a/data/reusables/webhooks/check_run_properties.md b/data/reusables/webhooks/check_run_properties.md
index 84e329d91de7..81dde665b16c 100644
--- a/data/reusables/webhooks/check_run_properties.md
+++ b/data/reusables/webhooks/check_run_properties.md
@@ -3,8 +3,9 @@ Key | Type | Description
`action`|`string` | The action performed. Can be one of: - `created` - A new check run was created.
- `completed` - The `status` of the check run is `completed`.
- `rerequested` - Someone requested to re-run your check run from the pull request UI. See "[About status checks](/articles/about-status-checks#checks)" for more details about the GitHub UI. When you receive a `rerequested` action, you'll need to [create a new check run](/v3/checks/runs/#create-a-check-run). Only the {% data variables.product.prodname_github_app %} that someone requests to re-run the check will receive the `rerequested` payload.
- `requested_action` - Someone requested an action your app provides to be taken. Only the {% data variables.product.prodname_github_app %} someone requests to perform an action will receive the `requested_action` payload. To learn more about check runs and requested actions, see "[Check runs and requested actions](/v3/checks/runs/#check-runs-and-requested-actions)."
`check_run`|`object` | The [check_run](/v3/checks/runs/#get-a-check-run).
`check_run[status]`|`string` | The current status of the check run. Can be `queued`, `in_progress`, or `completed`.
-`check_run[conclusion]`|`string` | The result of the completed check run. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}`action_required` or `stale`{% else %}or `action_required`{% endif %}. This value will be `null` until the check run has `completed`.
+`check_run[conclusion]`|`string` | The result of the completed check run. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %}`action_required` or `stale`{% else %}or `action_required`{% endif %}. This value will be `null` until the check run has `completed`.
`check_run[name]`|`string` | The name of the check run.
`check_run[check_suite][id]`|`integer` | The id of the check suite that this check run is part of.
+`check_run[check_suite][pull_requests]`|`array`| An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.
`requested_action`|`object` | The action requested by the user.
`requested_action[identifier]`|`string` | The integrator reference of the action requested by the user.
diff --git a/data/reusables/webhooks/check_suite_properties.md b/data/reusables/webhooks/check_suite_properties.md
index 28016be651a8..d9aa1e5c5445 100644
--- a/data/reusables/webhooks/check_suite_properties.md
+++ b/data/reusables/webhooks/check_suite_properties.md
@@ -5,6 +5,6 @@ Key | Type | Description
`check_suite[head_branch]`|`string` | The head branch name the changes are on.
`check_suite[head_sha]`|`string` | The SHA of the most recent commit for this check suite.
`check_suite[status]`|`string` | The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.
-`check_suite[conclusion]`|`string`| The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %}`action_required` or `stale`{% else %}or `action_required`{% endif %}. This value will be `null` until the check run has `completed`.
+`check_suite[conclusion]`|`string`| The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %}`action_required` or `stale`{% else %}or `action_required`{% endif %}. This value will be `null` until the check run has `completed`.
`check_suite[url]`|`string` | URL that points to the check suite API resource.
`check_suite[pull_requests]`|`array`| An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.
diff --git a/data/reusables/webhooks/installation_properties.md b/data/reusables/webhooks/installation_properties.md
index aaa057ab6858..8580d9fc2df3 100644
--- a/data/reusables/webhooks/installation_properties.md
+++ b/data/reusables/webhooks/installation_properties.md
@@ -1,4 +1,4 @@
Key | Type | Description
----|------|------------
-`action` | `string` | The action that was performed. Can be one of:- `created` - Someone installs a {% data variables.product.prodname_github_app %}.
- `deleted` - Someone uninstalls a {% data variables.product.prodname_github_app %}
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}- `suspend` - Someone suspends a {% data variables.product.prodname_github_app %} installation.
- `unsuspend` - Someone unsuspends a {% data variables.product.prodname_github_app %} installation.
{% endif %}- `new_permissions_accepted` - Someone accepts new permissions for a {% data variables.product.prodname_github_app %} installation. When a {% data variables.product.prodname_github_app %} owner requests new permissions, the person who installed the {% data variables.product.prodname_github_app %} must accept the new permissions request.
-`repositories` | `array` | An array of repository objects that the insatllation can access.
+`action` | `string` | The action that was performed. Can be one of:- `created` - Someone installs a {% data variables.product.prodname_github_app %}.
- `deleted` - Someone uninstalls a {% data variables.product.prodname_github_app %}
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}- `suspend` - Someone suspends a {% data variables.product.prodname_github_app %} installation.
- `unsuspend` - Someone unsuspends a {% data variables.product.prodname_github_app %} installation.
{% endif %}- `new_permissions_accepted` - Someone accepts new permissions for a {% data variables.product.prodname_github_app %} installation. When a {% data variables.product.prodname_github_app %} owner requests new permissions, the person who installed the {% data variables.product.prodname_github_app %} must accept the new permissions request.
+`repositories` | `array` | An array of repository objects that the installation can access.
diff --git a/data/reusables/webhooks/member_webhook_properties.md b/data/reusables/webhooks/member_webhook_properties.md
index e17e3348b609..7944d1e2863a 100644
--- a/data/reusables/webhooks/member_webhook_properties.md
+++ b/data/reusables/webhooks/member_webhook_properties.md
@@ -1,3 +1,3 @@
Key | Type | Description
----|------|-------------
-`action`|`string` | The action that was performed. Can be one of:- `added` - A user accepts an invitation to a repository.
- `removed` - A user is removed as a collaborator in a repository.
- `edited` - A user's collaborator permissios have changed.
+`action`|`string` | The action that was performed. Can be one of:- `added` - A user accepts an invitation to a repository.
- `removed` - A user is removed as a collaborator in a repository.
- `edited` - A user's collaborator permissions have changed.
diff --git a/data/reusables/webhooks/ping_short_desc.md b/data/reusables/webhooks/ping_short_desc.md
index 139c6735e2fd..4ef916b7b94b 100644
--- a/data/reusables/webhooks/ping_short_desc.md
+++ b/data/reusables/webhooks/ping_short_desc.md
@@ -1 +1 @@
-When you create a new webhook, we'll send you a simple `ping` event to let you know you've set up the webhook correctly. This event isnt stored so it isn't retrievable via the [Events API](/rest/reference/activity#ping-a-repository-webhook) endpoint.
+When you create a new webhook, we'll send you a simple `ping` event to let you know you've set up the webhook correctly. This event isn't stored so it isn't retrievable via the [Events API](/rest/reference/activity#ping-a-repository-webhook) endpoint.
diff --git a/data/reusables/webhooks/repo_desc.md b/data/reusables/webhooks/repo_desc.md
index 27cc4f74c02c..df26fb3e7a4c 100644
--- a/data/reusables/webhooks/repo_desc.md
+++ b/data/reusables/webhooks/repo_desc.md
@@ -1 +1 @@
-`repository` | `object` | The [`repository`](/v3/repos/#get-a-repository) where the event occured.
+`repository` | `object` | The [`repository`](/v3/repos/#get-a-repository) where the event occurred.
diff --git a/data/reusables/webhooks/repository_vulnerability_alert_short_desc.md b/data/reusables/webhooks/repository_vulnerability_alert_short_desc.md
index 635c979d782d..00324e3dc14c 100644
--- a/data/reusables/webhooks/repository_vulnerability_alert_short_desc.md
+++ b/data/reusables/webhooks/repository_vulnerability_alert_short_desc.md
@@ -1 +1 @@
-Activity related to security vulnerability alerts in a repository. {% data reusables.webhooks.action_type_desc %} For more information, see the "[About security alerts for vulerable dependencies](/github/managing-security-vulnerabilities/about-security-alerts-for-vulnerable-dependencies)".
+Activity related to security vulnerability alerts in a repository. {% data reusables.webhooks.action_type_desc %} For more information, see the "[About security alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-security-alerts-for-vulnerable-dependencies)".
diff --git a/data/reusables/webhooks/secret.md b/data/reusables/webhooks/secret.md
index d4d128984aec..a92e5fca87b5 100644
--- a/data/reusables/webhooks/secret.md
+++ b/data/reusables/webhooks/secret.md
@@ -1 +1 @@
-Setting a webhook secret allows you to ensure that `POST` requests sent to the payload URL are from {% data variables.product.product_name %}. When you set a secret, you'll receive the {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}`X-Hub-Signature` and `X-Hub-Signature-256` headers{% else if currentVersion ver_lt "enterprise-server@2.23" %}`X-Hub-Signature` header{% else if currentVersion == "private-instances@latest" %}`X-Hub-Signature-256` header{% endif %} in the webhook `POST` request. For more information on how to use a secret with a signature header to secure your webhook payloads, see "[Securing your webhooks](/webhooks/securing/)."
+Setting a webhook secret allows you to ensure that `POST` requests sent to the payload URL are from {% data variables.product.product_name %}. When you set a secret, you'll receive the {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}`X-Hub-Signature` and `X-Hub-Signature-256` headers{% elsif currentVersion ver_lt "enterprise-server@2.23" %}`X-Hub-Signature` header{% elsif currentVersion == "github-ae@latest" %}`X-Hub-Signature-256` header{% endif %} in the webhook `POST` request. For more information on how to use a secret with a signature header to secure your webhook payloads, see "[Securing your webhooks](/webhooks/securing/)."
diff --git a/data/reusables/webhooks/webhooks-rest-api-links.md b/data/reusables/webhooks/webhooks-rest-api-links.md
new file mode 100644
index 000000000000..3882222b0545
--- /dev/null
+++ b/data/reusables/webhooks/webhooks-rest-api-links.md
@@ -0,0 +1,4 @@
+You can use the repository, organization, and app webhook REST APIs to create, update, delete, and ping webhooks. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}You can also use the REST API to change the configuration of the webhook. For example, you can modify the payload URL, content type, SSL verification, and secret. {% endif %}For more information, see:
+- [Repository Webhooks REST API](/rest/reference/repos#webhooks)
+- [Organization Webhooks REST API](/rest/reference/orgs#webhooks){% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
+- [GitHub App Webhooks REST API](/rest/reference/apps#webhooks){% endif %}
diff --git a/data/ui.yml b/data/ui.yml
index 137d1f392d7e..0fc2ca6e1eb7 100644
--- a/data/ui.yml
+++ b/data/ui.yml
@@ -2,8 +2,8 @@ header:
github_docs: GitHub Docs
contact: Contact
notices:
- ghe_release_candidate:
- GitHub Enterprise Server 2.22 is currently under limited release as a release candidate.
+ ghae_silent_launch:
+ GitHub AE is currently under limited release. Please contact our Sales Team to find out more.
localization_complete:
We publish frequent updates to our documentation, and translation of this page may still be in progress.
For the most current information, please visit the
@@ -26,8 +26,9 @@ homepage:
version_picker: Version
toc:
getting_started: Getting started
- popular_articles: Popular articles
+ popular_articles: Popular
guides: Guides
+ whats_new: What's new
pages:
article_version: "Article version:"
miniToc: In this article
@@ -129,3 +130,6 @@ footer:
careers: Careers
press: Press
shop: Shop
+product_landing:
+ quick_start: Quickstart
+ reference_guides: Reference guides
\ No newline at end of file
diff --git a/data/variables/README.md b/data/variables/README.md
index 9eb6de78d605..7486f637b78e 100644
--- a/data/variables/README.md
+++ b/data/variables/README.md
@@ -18,7 +18,7 @@ nested:
too: Yes!
```
-Its values would be accesible as:
+Its values would be accessible as:
```
{% data foo.bar.meaning_of_life %}
diff --git a/data/variables/contact.yml b/data/variables/contact.yml
index 043c3a3cf1ca..b9cbf4c5d6d6 100644
--- a/data/variables/contact.yml
+++ b/data/variables/contact.yml
@@ -1,7 +1,7 @@
contact_ent_support: '[GitHub Enterprise Support](https://enterprise.githubsupport.com/hc/en-us) or [GitHub Premium Support](https://premium.githubsupport.com)'
contact_support: >-
- {% if currentVersion == "free-pro-team@latest" %}[GitHub Support](https://support.github.com/contact) or [GitHub Premium Support](https://premium.githubsupport.com){% else %}your GitHub Enterprise site administrator{% endif %}
+ {% if currentVersion == "free-pro-team@latest" %}[GitHub Support](https://support.github.com/contact) or [GitHub Premium Support](https://premium.githubsupport.com){% else %}your site administrator{% endif %}
report_abuse: >-
{% if currentVersion == "free-pro-team@latest" %}[Report abuse](https://github.com/contact/report-abuse){% endif %}
@@ -32,6 +32,10 @@ premium_support: 'GitHub Premium Support'
enterprise_portal: 'GitHub Enterprise Support portal'
contact_enterprise_portal: '[GitHub Enterprise Support portal](https://enterprise.githubsupport.com/hc/en-us)'
+# Azure support (GitHub AE) portal
+ae_azure_portal: 'Azure Support portal'
+contact_ae_portal: '[Azure Support portal](https://portal.azure.com/#blade/Microsoft_Azure_Support/HelpAndSupportBlade)'
+
# GitHub Support portal (for dotcom)
support_portal: 'GitHub Support portal'
contact_support_portal: '[GitHub Support portal](https://support.github.com/contact)'
diff --git a/data/variables/product.yml b/data/variables/product.yml
index f8531cf63a1e..1f867437ef65 100644
--- a/data/variables/product.yml
+++ b/data/variables/product.yml
@@ -8,8 +8,7 @@ company_short: 'GitHub'
# GitHub's flagship products
## Until we have versioning to support GitHub Enterprise Cloud content, avoid using this variable if the output should specifically be GitHub Enterprise Cloud or GitHub Enterprise Server
product_name: >-
- {% if currentVersion == "free-pro-team@latest" %}GitHub{% else %}GitHub Enterprise{% endif %}
-
+ {% if enterpriseServerVersions contains currentVersion %}GitHub Enterprise Server{% elsif currentVersion == "github-ae@latest" %}GitHub AE{% else %}GitHub{% endif %}
## Use this variable when the output should always be GitHub, regardless of the product the user is using
prodname_dotcom: 'GitHub'
@@ -22,11 +21,15 @@ prodname_dotcom_the_website: 'GitHub.com'
## Use these variables when the output should reflect one of our two specific GitHub Enterprise offerings
prodname_ghe_server: 'GitHub Enterprise Server'
prodname_ghe_cloud: 'GitHub Enterprise Cloud'
+prodname_ghe_managed: 'GitHub AE'
prodname_ghe_one: 'GitHub One'
## Use these variables when referring specifically to a location within a product
product_location: >-
- {% if currentVersion == "free-pro-team@latest" %}GitHub{% else %}your GitHub Enterprise Server instance{% endif %}
+ {% if enterpriseServerVersions contains currentVersion %}your GitHub Enterprise Server instance{% elsif currentVersion == "github-ae@latest" %}your enterprise{% else %}GitHub{% endif %}
+
+# Used ONLY when you need to refer to a GHES instance in an article that is versioned for non-GHES versions.
+# Do not use in other situations!
product_location_enterprise: 'your GitHub Enterprise Server instance'
prodname_free_user: 'GitHub Free'
@@ -74,10 +77,13 @@ prodname_github_apps: 'GitHub Apps'
prodname_oauth_app: 'OAuth App'
# API and developer docs
-prodname_enterprise_api: 'the GitHub Enterprise Server API'
+prodname_enterprise_api: 'the {% if enterpriseServerVersions contains currentVersion %}GitHub Enterprise Server{% elsif currentVersion == "github-ae@latest" %}GitHub AE{% endif %} APIs'
prodname_support_forum_with_url: '[GitHub API Development and Support Forum](https://github.community/c/github-api-development-and-support/37)'
prodname_unfurls: 'Content Attachments'
+# Azure AD
+ae_azure_ad_app_link: 'the [GitHub AE application](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/aad.githubenterpriseserver)'
+
# GitHub Actions
## Use this variable only when referring to GitHub Actions the product. When referring to the thing that someone creates using the product, call it an action (small a). See the terminology page of the Brand Guide for more.
prodname_actions: 'GitHub Actions'
@@ -144,11 +150,10 @@ prodname_vss_ghe: 'Visual Studio subscription with GitHub Enterprise'
prodname_vss_admin_portal_with_url: 'the [administrator portal for Visual Studio subscriptions](https://visualstudio.microsoft.com/subscriptions-administration/)'
# GitHub Dependabot
-prodname_dependabot: 'GitHub Dependabot'
-prodname_dependabot_short: 'Dependabot'
-prodname_dependabot_alerts: 'GitHub Dependabot alerts'
-prodname_dependabot_security_updates: 'GitHub Dependabot security updates'
-prodname_dependabot_version_updates: 'GitHub Dependabot version updates'
+prodname_dependabot: 'Dependabot'
+prodname_dependabot_alerts: 'Dependabot alerts'
+prodname_dependabot_security_updates: 'Dependabot security updates'
+prodname_dependabot_version_updates: 'Dependabot version updates'
# GitHub Archive Program
prodname_archive: 'GitHub Archive Program'
@@ -164,7 +169,6 @@ signout_link: >-
{% if currentVersion == "free-pro-team@latest" %}[Sign out](https://github.com/logout){% else %}Sign out (`https://[hostname]/logout`){% endif %}
raw_github_com: >-
{% if currentVersion == "free-pro-team@latest" %}raw.githubusercontent.com{% else %}[hostname]/user/repo/raw{% endif %}
-
# GitHub Enterprise Server past versions
current-340-version:
'11.10.354'
@@ -173,27 +177,21 @@ current-340-version:
# Use this inside command-line and other code blocks
doc_url_pre: >-
{% if currentVersion == "free-pro-team@latest" %}https://developer.github.com{% else %}https://developer.github.com/enterprise/{{currentVersion}}{% endif %}
-
# Use this inside command-line code blocks
api_url_pre: >-
{% if currentVersion == "free-pro-team@latest" %}https://api.github.com{% else %}http(s)://[hostname]/api/v3{% endif %}
-
# Use this inside command-line code blocks
# Enterprise OAuth paths that don't include "/graphql" or "/api/v3"
oauth_host_code: >-
{% if currentVersion == "free-pro-team@latest" %}https://github.com{% else %}http(s)://[hostname]{% endif %}
-
device_authorization_url: >-
- {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}[`https://github.com/login/device`](https://github.com/login/device){% else %}`http(s)://[hostname]/login/device`{% endif %}
-
+ {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}[`https://github.com/login/device`](https://github.com/login/device){% else %}`http(s)://[hostname]/login/device`{% endif %}
# Use this all other code blocks
api_url_code: >-
{% if currentVersion == "free-pro-team@latest" %}https://api.github.com{% else %}http(s)://[hostname]/api/v3{% endif %}
-
# Use this inside command-line code blocks
graphql_url_pre: >-
{% if currentVersion == "free-pro-team@latest" %}https://api.github.com/graphql{% else %}http(s)://[hostname]/api/graphql{% endif %}
-
# Use this all other code blocks
graphql_url_code: >-
- {% if currentVersion == "free-pro-team@latest" %}https://api.github.com/graphql{% else %}http(s)://[hostname]/api/graphql{% endif %}
+ {% if currentVersion == "free-pro-team@latest" %}https://api.github.com/graphql{% else %}http(s)://[hostname]/api/graphql{% endif %}
\ No newline at end of file
diff --git a/includes/article.html b/includes/article.html
index 8719e347a972..e448c18d8f71 100644
--- a/includes/article.html
+++ b/includes/article.html
@@ -63,7 +63,7 @@
- {% if gettingStartedLinks and popularLinks %}
+ {% if featuredLinks.gettingStarted and featuredLinks.popular %}
{% include featured-links %}
{% endif %}
{{ renderedPage }}
diff --git a/includes/featured-links.html b/includes/featured-links.html
index acd7c395a7ae..6fdbebc2fb19 100644
--- a/includes/featured-links.html
+++ b/includes/featured-links.html
@@ -7,7 +7,7 @@
{% data ui.toc.getting_started %}
- {% for link in gettingStartedLinks %}
+ {% for link in featuredLinks.gettingStarted %}
{% include featured-link %}
{% endfor %}