diff --git a/.github/actions-scripts/enterprise-server-issue-templates/deprecation-issue.md b/.github/actions-scripts/enterprise-server-issue-templates/deprecation-issue.md index aad15dee98..f5b0151980 100644 --- a/.github/actions-scripts/enterprise-server-issue-templates/deprecation-issue.md +++ b/.github/actions-scripts/enterprise-server-issue-templates/deprecation-issue.md @@ -4,6 +4,13 @@ The day after a GHES version's [deprecation date](https://github.com/github/docs **Note**: Do each step below in a separate PR. Only move on to the next step when the previous PR has been merged. +## Step 0: Remove deprecated version numbers from docs-content issue forms + +**Note**: This step can be performed independently of all other steps, and can be done several days before or along with the other steps. + +- [ ] In the `docs-content` repo, remove the deprecated GHES version number from the "Specific GHES version(s)" section in the following files (in the `.github/ISSUE_TEMPLATE/` directory): [`release-tier-1-or-2-tracking.yml`](https://github.com/github/docs-content/blob/main/.github/ISSUE_TEMPLATE/release-tier-1-or-2-tracking.yml) and [`release-tier-3-or-tier-4.yml`](https://github.com/github/docs-content/blob/main/.github/ISSUE_TEMPLATE/release-tier-3-or-tier-4.yml). +- [ ] When the PR is approved, merge it in. This can be merged independently from all other steps. + ## Step 1: Scrape the docs and archive the files - [ ] In your checkout of the [repo with archived GHES content](https://github.com/github/help-docs-archived-enterprise-versions), create a new branch: `git checkout -b deprecate-` @@ -58,3 +65,4 @@ In your `docs-internal` checkout: - [ ] Open a PR with the results. The diff may be large and complex, so make sure to get a review from `@github/docs-content`. - [ ] Debug any test failures or unexpected results. - [ ] When the PR is approved, merge it in to complete the deprecation. This can be merged independently from step 5. + diff --git a/.github/actions-scripts/enterprise-server-issue-templates/release-issue.md b/.github/actions-scripts/enterprise-server-issue-templates/release-issue.md index 5b34e587fa..8e8616a640 100644 --- a/.github/actions-scripts/enterprise-server-issue-templates/release-issue.md +++ b/.github/actions-scripts/enterprise-server-issue-templates/release-issue.md @@ -107,3 +107,4 @@ This file should be automatically updated, but you can also run `script/update-e - [ ] The `github/docs-internal` repo is frozen, and the `Repo Freeze Check / Prevent merging during deployment freezes (pull_request_target)` test is expected to fail. Use admin permissions to ship the release branch with this failure. - [ ] Do any required smoke tests. - [ ] Once smoke tests have passed, you can [unfreeze the repos](https://github.com/github/docs-content/blob/main/docs-content-docs/docs-content-workflows/freezing.md) and post an announcement in Slack. +- [ ] After the release, in the `docs-content` repo, add the now live version number to the "Specific GHES version(s)" section in the following files: [`.github/ISSUE_TEMPLATE/release-tier-1-or-2-tracking.yml`](https://github.com/github/docs-content/blob/main/.github/ISSUE_TEMPLATE/release-tier-1-or-2-tracking.yml) and [`.github/ISSUE_TEMPLATE/release-tier-3-or-tier-4.yml`](https://github.com/github/docs-content/blob/main/.github/ISSUE_TEMPLATE/release-tier-3-or-tier-4.yml). When the PR is approved, merge it in. \ No newline at end of file diff --git a/.github/actions-scripts/projects.js b/.github/actions-scripts/projects.js index 83d255436a..8c96c6f8c6 100644 --- a/.github/actions-scripts/projects.js +++ b/.github/actions-scripts/projects.js @@ -161,8 +161,10 @@ export function generateUpdateProjectNextItemFieldMutation({ function generateMutationToUpdateField({ item, fieldID, value, literal = false }) { const parsedValue = literal ? `value: "${value}"` : `value: ${value}` + // Strip "=" out of the item ID when creating the mutation ID to avoid a GraphQL parsing error + // (statistically, this should still give us a unique mutation ID) return ` - set_${fieldID.substr(1)}_item_${item}: updateProjectNextItemField(input: { + set_${fieldID.substr(1)}_item_${item.replaceAll('=', '')}: updateProjectNextItemField(input: { projectId: $project itemId: "${item}" fieldId: ${fieldID} diff --git a/.github/workflows/remove-stale-staging-apps.yml b/.github/workflows/remove-stale-staging-apps.yml deleted file mode 100644 index 7f87057932..0000000000 --- a/.github/workflows/remove-stale-staging-apps.yml +++ /dev/null @@ -1,38 +0,0 @@ -name: Remove stale staging apps - -# **What it does**: -# This cleans up any rogue staging applications that outlasted the closure of -# their corresponding pull requests. -# **Why we have it**: -# Staging applications sometimes fail to be destroyed when their corresponding -# pull request is closed or merged. -# **Who does it impact**: -# Anyone with a closed, spammy, or deleted pull request in docs or docs-internal. - -on: - schedule: - - cron: '15,45 * * * *' # every thirty minutes at :15 and :45 - -jobs: - remove_stale_staging_apps: - name: Remove stale staging apps - if: ${{ github.repository == 'github/docs-internal' }} - runs-on: ubuntu-latest - steps: - - name: Check out repo's default branch - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f - - - name: Setup Node - uses: actions/setup-node@38d90ce44d5275ad62cc48384b3d8a58c500bb5f - with: - node-version: 16.8.x - cache: npm - - - name: Install dependencies - run: npm ci - - - name: Run script - run: script/remove-stale-staging-apps.js - env: - HEROKU_API_TOKEN: ${{ secrets.HEROKU_API_TOKEN }} - GITHUB_TOKEN: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }} diff --git a/.github/workflows/remove-stale-staging-resources.yml b/.github/workflows/remove-stale-staging-resources.yml new file mode 100644 index 0000000000..b55a28e9ed --- /dev/null +++ b/.github/workflows/remove-stale-staging-resources.yml @@ -0,0 +1,64 @@ +name: Remove stale staging resources + +# **What it does**: +# This cleans up any rogue staging applications and environments that outlasted +# the closure of their corresponding pull requests. +# **Why we have it**: +# Staging applications and environments sometimes fail to be destroyed when +# their corresponding pull request is closed or merged. +# **Who does it impact**: +# Anyone with a closed, spammy, or deleted pull request in docs or docs-internal. + +on: + schedule: + - cron: '15,45 * * * *' # every thirty minutes at :15 and :45 + +permissions: + contents: read + pull-requests: read + +jobs: + remove_stale_staging_apps: + name: Remove stale staging apps + if: ${{ github.repository == 'github/docs-internal' }} + runs-on: ubuntu-latest + steps: + - name: Check out repo's default branch + uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f + + - name: Setup Node + uses: actions/setup-node@38d90ce44d5275ad62cc48384b3d8a58c500bb5f + with: + node-version: 16.8.x + cache: npm + + - name: Install dependencies + run: npm ci + + - name: Run script + run: script/remove-stale-staging-apps.js + env: + HEROKU_API_TOKEN: ${{ secrets.HEROKU_API_TOKEN }} + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + remove_stale_staging_envs: + name: Remove stale staging environments + runs-on: ubuntu-latest + steps: + - name: Check out repo's default branch + uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f + + - name: Setup Node + uses: actions/setup-node@38d90ce44d5275ad62cc48384b3d8a58c500bb5f + with: + node-version: 16.8.x + cache: npm + + - name: Install dependencies + run: npm ci + + - name: Run script + run: script/remove-stale-staging-envs.js + env: + GITHUB_TOKEN: ${{ secrets.DOCS_BOT }} + REPO: ${{ github.repository }} diff --git a/.github/workflows/staging-build-pr-docker.yml b/.github/workflows/staging-build-pr-docker.yml index 74dfc4dabe..495df5ea23 100644 --- a/.github/workflows/staging-build-pr-docker.yml +++ b/.github/workflows/staging-build-pr-docker.yml @@ -12,6 +12,9 @@ on: - synchronize - unlocked +permissions: + contents: read + jobs: build: if: ${{ github.repository == 'github/docs-internal' || github.repository == 'github/docs' }} @@ -81,12 +84,3 @@ jobs: with: name: pr_build_docker path: app.tar - - - name: Send Slack notification if workflow fails - uses: someimportantcompany/github-actions-slack-message@0b470c14b39da4260ed9e3f9a4f1298a74ccdefd - if: ${{ failure() }} - with: - channel: ${{ secrets.DOCS_STAGING_DEPLOYMENT_FAILURES_SLACK_CHANNEL_ID }} - bot-token: ${{ secrets.SLACK_DOCS_BOT_TOKEN }} - color: failure - text: Staging build (docker) failed for PR ${{ github.event.pull_request.html_url }} at commit ${{ github.sha }}. See https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }} diff --git a/.github/workflows/staging-build-pr.yml b/.github/workflows/staging-build-pr.yml index 4a7b6ac2b0..2d5dbbaa08 100644 --- a/.github/workflows/staging-build-pr.yml +++ b/.github/workflows/staging-build-pr.yml @@ -12,6 +12,9 @@ on: - synchronize - unlocked +permissions: + contents: read + jobs: build: if: ${{ github.repository == 'github/docs-internal' || github.repository == 'github/docs' }} @@ -77,12 +80,3 @@ jobs: with: name: pr_build path: app.tar - - - name: Send Slack notification if workflow fails - uses: someimportantcompany/github-actions-slack-message@0b470c14b39da4260ed9e3f9a4f1298a74ccdefd - if: ${{ failure() }} - with: - channel: ${{ secrets.DOCS_STAGING_DEPLOYMENT_FAILURES_SLACK_CHANNEL_ID }} - bot-token: ${{ secrets.SLACK_DOCS_BOT_TOKEN }} - color: failure - text: Staging build failed for PR ${{ github.event.pull_request.html_url }} at commit ${{ github.sha }}. See https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }} diff --git a/.github/workflows/staging-deploy-pr-docker.yml b/.github/workflows/staging-deploy-pr-docker.yml index c2ea86744e..99dcc55351 100644 --- a/.github/workflows/staging-deploy-pr-docker.yml +++ b/.github/workflows/staging-deploy-pr-docker.yml @@ -11,6 +11,13 @@ on: types: - completed +permissions: + actions: read + contents: read + deployments: write + pull-requests: read + statuses: write + env: # In this specific workflow relationship, the `github.event.workflow_run.pull_requests` # array will always contain only 1 item! Specifically, it will contain the PR associated @@ -19,9 +26,7 @@ env: PR_URL: ${{ github.event.workflow_run.repository.html_url }}/pull/${{ github.event.workflow_run.pull_requests[0].number }} jobs: - prepare: - env: - HEROKU_API_KEY: ${{ secrets.HEROKU_API_TOKEN }} + check-pr-before-prepare: if: >- ${{ github.event.workflow_run.conclusion == 'success' && @@ -29,6 +34,32 @@ jobs: startsWith(github.event.workflow_run.head_branch, 'docker-') }} runs-on: ubuntu-latest + timeout-minutes: 1 + concurrency: + group: staging_docker_${{ github.event.workflow_run.head_branch }} + cancel-in-progress: true + outputs: + pull_request_state: ${{ steps.check-pr.outputs.state }} + steps: + - name: Check pull request state + id: check-pr + uses: actions/github-script@2b34a689ec86a68d8ab9478298f91d5401337b7d + with: + script: | + const { owner, repo } = context.repo + const { data: pullRequest } = await octokit.pulls.get({ + owner, + repo, + pull_number: pullNumber + }) + core.setOutput('state', pullRequest.state) + + prepare: + needs: check-pr-before-prepare + if: ${{ needs.check-pr-before-prepare.outputs.pull_request_state == 'open' }} + env: + HEROKU_API_KEY: ${{ secrets.HEROKU_API_TOKEN }} + runs-on: ubuntu-latest timeout-minutes: 20 concurrency: group: staging_docker_${{ github.event.workflow_run.head_branch }} @@ -95,6 +126,8 @@ jobs: env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} HEROKU_API_TOKEN: ${{ secrets.HEROKU_API_TOKEN }} + HYDRO_ENDPOINT: ${{ secrets.HYDRO_ENDPOINT }} + HYDRO_SECRET: ${{ secrets.HYDRO_SECRET } with: script: | const esm = require('esm') @@ -160,9 +193,33 @@ jobs: color: failure text: Staging preparation (docker) failed for PR ${{ env.PR_URL }} at commit ${{ github.sha }}. See https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }} - deploy: + check-pr-before-deploy: needs: prepare runs-on: ubuntu-latest + timeout-minutes: 1 + concurrency: + group: staging_docker_${{ github.event.workflow_run.head_branch }} + cancel-in-progress: true + outputs: + pull_request_state: ${{ steps.check-pr.outputs.state }} + steps: + - name: Check pull request state + id: check-pr + uses: actions/github-script@2b34a689ec86a68d8ab9478298f91d5401337b7d + with: + script: | + const { owner, repo } = context.repo + const { data: pullRequest } = await octokit.pulls.get({ + owner, + repo, + pull_number: ${{ github.event.workflow_run.pull_requests[0].number }} + }) + core.setOutput('state', pullRequest.state) + + deploy: + needs: [prepare, check-pr-before-deploy] + if: ${{ needs.check-pr-before-deploy.outputs.pull_request_state == 'open' }} + runs-on: ubuntu-latest timeout-minutes: 10 concurrency: group: staging_docker_${{ github.event.workflow_run.head_branch }} diff --git a/.github/workflows/staging-deploy-pr.yml b/.github/workflows/staging-deploy-pr.yml index 6e02c306dd..f74e27971d 100644 --- a/.github/workflows/staging-deploy-pr.yml +++ b/.github/workflows/staging-deploy-pr.yml @@ -11,6 +11,13 @@ on: types: - completed +permissions: + actions: read + contents: read + deployments: write + pull-requests: read + statuses: write + env: EARLY_ACCESS_SCRIPT_PATH: script/early-access/clone-for-build.js EARLY_ACCESS_SUPPORT_FILES: script/package.json @@ -23,13 +30,37 @@ env: ACTIONS_RUN_LOG: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }} jobs: - prepare: + check-pr-before-prepare: if: >- ${{ github.event.workflow_run.conclusion == 'success' && (github.repository == 'github/docs-internal' || github.repository == 'github/docs') }} runs-on: ubuntu-latest + timeout-minutes: 1 + concurrency: + group: staging_${{ github.event.workflow_run.head_branch }} + cancel-in-progress: true + outputs: + pull_request_state: ${{ steps.check-pr.outputs.state }} + steps: + - name: Check pull request state + id: check-pr + uses: actions/github-script@2b34a689ec86a68d8ab9478298f91d5401337b7d + with: + script: | + const { owner, repo } = context.repo + const { data: pullRequest } = await octokit.pulls.get({ + owner, + repo, + pull_number: ${{ github.event.workflow_run.pull_requests[0].number }} + }) + core.setOutput('state', pullRequest.state) + + prepare: + needs: check-pr-before-prepare + if: ${{ needs.check-pr-before-prepare.outputs.pull_request_state == 'open' }} + runs-on: ubuntu-latest timeout-minutes: 5 concurrency: group: staging_${{ github.event.workflow_run.head_branch }} @@ -174,9 +205,33 @@ jobs: color: failure text: Staging preparation failed for PR ${{ env.PR_URL }} at commit ${{ github.event.workflow_run.head_sha }}. See ${{ env.ACTIONS_RUN_LOG }} - deploy: + check-pr-before-deploy: needs: prepare runs-on: ubuntu-latest + timeout-minutes: 1 + concurrency: + group: staging_${{ github.event.workflow_run.head_branch }} + cancel-in-progress: true + outputs: + pull_request_state: ${{ steps.check-pr.outputs.state }} + steps: + - name: Check pull request state + id: check-pr + uses: actions/github-script@2b34a689ec86a68d8ab9478298f91d5401337b7d + with: + script: | + const { owner, repo } = context.repo + const { data: pullRequest } = await octokit.pulls.get({ + owner, + repo, + pull_number: ${{ github.event.workflow_run.pull_requests[0].number }} + }) + core.setOutput('state', pullRequest.state) + + deploy: + needs: [prepare, check-pr-before-deploy] + if: ${{ needs.check-pr-before-deploy.outputs.pull_request_state == 'open' }} + runs-on: ubuntu-latest timeout-minutes: 10 concurrency: group: staging_${{ github.event.workflow_run.head_branch }} diff --git a/.github/workflows/staging-undeploy-pr.yml b/.github/workflows/staging-undeploy-pr.yml index f0edb41130..529d8d2565 100644 --- a/.github/workflows/staging-undeploy-pr.yml +++ b/.github/workflows/staging-undeploy-pr.yml @@ -10,6 +10,10 @@ on: - closed - locked +permissions: + contents: read + deployments: write + jobs: undeploy: if: ${{ github.repository == 'github/docs-internal' || github.repository == 'github/docs' }} diff --git a/components/context/TocLandingContext.tsx b/components/context/TocLandingContext.tsx index 689829a106..b3c1559a36 100644 --- a/components/context/TocLandingContext.tsx +++ b/components/context/TocLandingContext.tsx @@ -33,7 +33,7 @@ export const useTocLandingContext = (): TocLandingContextT => { export const getTocLandingContextFromRequest = (req: any): TocLandingContextT => { const isEarlyAccess = req.context.page?.documentType === 'early-access' return { - title: req.context.page.title, + title: req.context.page.titlePlainText, productCallout: req.context.page.product || '', introPlainText: req.context.page.introPlainText, tocItems: (req.context.genericTocFlat || req.context.genericTocNested || []).map((obj: any) => diff --git a/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md b/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md index beb264a264..494eac3b3f 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md +++ b/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md @@ -48,7 +48,7 @@ The repository owner has full control of the repository. In addition to the acti | Dismiss {% data variables.product.prodname_dependabot_alerts %} in the repository | "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)" | | Manage data use for a private repository | "[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 %} | Define code owners for the repository | "[About code owners](/github/creating-cloning-and-archiving-repositories/about-code-owners)" | -| Archive the repository | "[About archiving repositories](/github/creating-cloning-and-archiving-repositories/about-archiving-repositories)" |{% ifversion fpt %} +| Archive the repository | "[Archiving repositories](/repositories/archiving-a-github-repository/archiving-repositories)" |{% ifversion fpt %} | Create security advisories | "[About {% data variables.product.prodname_security_advisories %}](/github/managing-security-vulnerabilities/about-github-security-advisories)" | | Display a sponsor button | "[Displaying a sponsor button in your repository](/github/administering-a-repository/displaying-a-sponsor-button-in-your-repository)" |{% endif %}{% ifversion fpt or ghae or ghes > 3.0 %} | Allow or disallow auto-merge for pull requests | "[Managing auto-merge for pull requests in your repository](/github/administering-a-repository/managing-auto-merge-for-pull-requests-in-your-repository)" | {% endif %} diff --git a/content/actions/guides/caching-dependencies-to-speed-up-workflows.md b/content/actions/guides/caching-dependencies-to-speed-up-workflows.md index d031f2acc8..802c0784e7 100644 --- a/content/actions/guides/caching-dependencies-to-speed-up-workflows.md +++ b/content/actions/guides/caching-dependencies-to-speed-up-workflows.md @@ -22,9 +22,9 @@ Workflow runs often reuse the same outputs or downloaded dependencies from one r Jobs on {% data variables.product.prodname_dotcom %}-hosted runners start in a clean virtual environment and must download dependencies each time, causing increased network utilization, longer runtime, and increased cost. To help speed up the time it takes to recreate these files, {% data variables.product.prodname_dotcom %} can cache dependencies you frequently use in workflows. -To cache dependencies for a job, you'll need to use {% data variables.product.prodname_dotcom %}'s `cache` action. The action retrieves a cache identified by a unique key. For more information, see [`actions/cache`](https://github.com/actions/cache). +To cache dependencies for a job, you'll need to use {% data variables.product.prodname_dotcom %}'s `cache` action. The action retrieves a cache identified by a unique key. For more information, see [`actions/cache`](https://github.com/actions/cache). -If you are caching Ruby gems, instead consider using the Ruby maintained action, which can cache bundle installs on initiation. For more information, see [`ruby/setup-ruby`](https://github.com/ruby/setup-ruby#caching-bundle-install-automatically). +If you are caching Ruby gems, instead consider using the Ruby maintained action, which can cache bundle installs on initiation. For more information, see [`ruby/setup-ruby`](https://github.com/ruby/setup-ruby#caching-bundle-install-automatically). To cache and restore dependencies for npm, Yarn, or pnpm, you can use the [`actions/setup-node` action](https://github.com/actions/setup-node). @@ -49,7 +49,9 @@ With `v2` of the `cache` action, you can access the cache in workflows triggered A workflow can access and restore a cache created in the current branch, the base branch (including base branches of forked repositories), or the default branch (usually `main`). For example, a cache created on the default branch would be accessible from any pull request. Also, if the branch `feature-b` has the base branch `feature-a`, a workflow triggered on `feature-b` would have access to caches created in the default branch (`main`), `feature-a`, and `feature-b`. -Access restrictions provide cache isolation and security by creating a logical boundary between different workflows and branches. For example, a cache created for the branch `feature-a` (with the base `main`) would not be accessible to a pull request for the branch `feature-b` (with the base `main`). +Access restrictions provide cache isolation and security by creating a logical boundary between different branches. For example, a cache created for the branch `feature-a` (with the base `main`) would not be accessible to a pull request for the branch `feature-b` (with the base `main`). + +Multiple workflows within a repository share cache entries. A cache created for a branch within a workflow can be accessed and restored from another workflow for the same repository and branch. ## Using the `cache` action diff --git a/content/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks.md b/content/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks.md index 28d83bb82f..fcb7ebb0dc 100644 --- a/content/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks.md +++ b/content/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks.md @@ -9,7 +9,7 @@ shortTitle: Approve public fork runs ## About workflow runs from public forks -{% data reusables.actions.workflow-run-approve-public-fork %} However, you can configure this behavior for a [repository](/github/administering-a-repository/managing-repository-settings/disabling-or-limiting-github-actions-for-a-repository#configuring-required-approval-for-workflows-from-public-forks), [organization](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#configuring-required-approval-for-workflows-from-public-forks), or [enterprise](/github/setting-up-and-managing-your-enterprise/setting-policies-for-organizations-in-your-enterprise-account/enforcing-github-actions-policies-in-your-enterprise-account#configuring-required-approval-for-workflows-from-public-forks). +{% data reusables.actions.workflow-run-approve-public-fork %} However, you can configure this behavior for a [repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-required-approval-for-workflows-from-public-forks), [organization](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#configuring-required-approval-for-workflows-from-public-forks), or [enterprise](/github/setting-up-and-managing-your-enterprise/setting-policies-for-organizations-in-your-enterprise-account/enforcing-github-actions-policies-in-your-enterprise-account#configuring-required-approval-for-workflows-from-public-forks). Workflow runs that have been awaiting approval for more than 30 days are automatically deleted. diff --git a/content/actions/managing-workflow-runs/downloading-workflow-artifacts.md b/content/actions/managing-workflow-runs/downloading-workflow-artifacts.md index 5330e6bd3d..fb3accb468 100644 --- a/content/actions/managing-workflow-runs/downloading-workflow-artifacts.md +++ b/content/actions/managing-workflow-runs/downloading-workflow-artifacts.md @@ -13,7 +13,7 @@ shortTitle: Download workflow artifacts {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %} -{% ifversion fpt or ghes > 2.22 or ghae %} By default, {% data variables.product.product_name %} stores build logs and artifacts for 90 days, and you can customize this retention period, depending on the type of repository. For more information, see "[Configuring the retention period for GitHub Actions artifacts and logs in your repository](/github/administering-a-repository/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository)."{% endif %} +{% ifversion fpt or ghes > 2.22 or ghae %} By default, {% data variables.product.product_name %} stores build logs and artifacts for 90 days, and you can customize this retention period, depending on the type of repository. For more information, see "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository)."{% endif %} {% ifversion ghes = 2.22 %} {% data variables.product.product_name %} stores full build logs and artifacts for 90 days.{% endif %} {% data reusables.repositories.permissions-statement-read %} diff --git a/content/actions/reference/authentication-in-a-workflow.md b/content/actions/reference/authentication-in-a-workflow.md index ebaa65a81a..770e1fb7cd 100644 --- a/content/actions/reference/authentication-in-a-workflow.md +++ b/content/actions/reference/authentication-in-a-workflow.md @@ -97,7 +97,7 @@ jobs: For information about the API endpoints {% data variables.product.prodname_github_apps %} can access with each permission, see "[{% data variables.product.prodname_github_app %} Permissions](/rest/reference/permissions-required-for-github-apps)." {% ifversion fpt or ghes > 3.1 or ghae-next %} -The following table shows the permissions granted to the `GITHUB_TOKEN` by default. People with admin permissions to an {% ifversion not ghes %}enterprise, organization, or repository,{% else %}organization or repository{% endif %} can set the default permissions to be either permissive or restricted. For information on how to set the default permissions for the `GITHUB_TOKEN` for your {% ifversion not ghes %}enterprise, organization, or repository,{% else %}organization or repository,{% endif %} see {% ifversion not ghes %}"[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#setting-the-permissions-of-the-github_token-for-your-enterprise)," {% endif %}"[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#setting-the-permissions-of-the-github_token-for-your-organization)," or "[Disabling or limiting {% data variables.product.prodname_actions %} for a repository](/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository#setting-the-permissions-of-the-github_token-for-a-repository)." +The following table shows the permissions granted to the `GITHUB_TOKEN` by default. People with admin permissions to an {% ifversion not ghes %}enterprise, organization, or repository,{% else %}organization or repository{% endif %} can set the default permissions to be either permissive or restricted. For information on how to set the default permissions for the `GITHUB_TOKEN` for your {% ifversion not ghes %}enterprise, organization, or repository,{% else %}organization or repository,{% endif %} see {% ifversion not ghes %}"[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#setting-the-permissions-of-the-github_token-for-your-enterprise)," {% endif %}"[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#setting-the-permissions-of-the-github_token-for-your-organization)," or "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." | Scope | Default access
(permissive) | Default access
(restricted) | Maximum access
by forked repos | |---------------|-----------------------------|-----------------------------|--------------------------------| diff --git a/content/actions/reference/usage-limits-billing-and-administration.md b/content/actions/reference/usage-limits-billing-and-administration.md index 2d62f6b455..c0f7a0439b 100644 --- a/content/actions/reference/usage-limits-billing-and-administration.md +++ b/content/actions/reference/usage-limits-billing-and-administration.md @@ -69,9 +69,9 @@ You can configure the artifact and log retention period for your repository, org For more information, see: -- [Configuring the retention period for {% data variables.product.prodname_actions %} for artifacts and logs in your repository](/github/administering-a-repository/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository) -- [Configuring the retention period for {% data variables.product.prodname_actions %} for artifacts and logs in your organization](/organizations/managing-organization-settings/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization) -- [Configuring the retention period for {% data variables.product.prodname_actions %} for artifacts and logs in your enterprise](/github/setting-up-and-managing-your-enterprise/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-enterprise-account) +- "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository)" +- "[Configuring the retention period for {% data variables.product.prodname_actions %} for artifacts and logs in your organization](/organizations/managing-organization-settings/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization)" +- "[Configuring the retention period for {% data variables.product.prodname_actions %} for artifacts and logs in your enterprise](/github/setting-up-and-managing-your-enterprise/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-enterprise-account)" {% endif %} ## Disabling or limiting {% data variables.product.prodname_actions %} for your repository or organization @@ -79,7 +79,7 @@ For more information, see: {% data reusables.github-actions.disabling-github-actions %} 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)" +- "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository)" - "[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization)"{% ifversion fpt %} - "[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)" for {% data variables.product.prodname_ghe_cloud %}{% endif %} diff --git a/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md b/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md index 8c7f036664..ae11de4494 100644 --- a/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md +++ b/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md @@ -38,7 +38,7 @@ shortTitle: Enforce repository policies --- ## Configuring the default visibility of new repositories in your enterprise -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)." +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 repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." If an enterprise owner 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)." diff --git a/content/admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-script.md b/content/admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-script.md index d4985d4904..9b74d60545 100644 --- a/content/admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-script.md +++ b/content/admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-script.md @@ -83,7 +83,7 @@ The `$GITHUB_VIA` variable is available in the pre-receive hook environment when | Value | Action | More information | | :- | :- | :- | | 
auto-merge deployment api
| Automatic merge of the base branch via a deployment created with the API | "[Repositories](/rest/reference/repos#create-a-deployment)" in the REST API documentation | -| 
blob#save
| Change to a file's contents in the web interface | "[Editing files in your repository](/github/managing-files-in-a-repository/editing-files-in-your-repository)" | +| 
blob#save
| Change to a file's contents in the web interface | "[Editing files](/repositories/working-with-files/managing-files/editing-files)" | | 
branch merge api
| Merge of a branch via the API | "[Repositories](/rest/reference/repos#merge-a-branch)" in the REST API documentation | | 
branches page delete button
| Deletion of a branch in the web interface | "[Creating and deleting branches within your repository](/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository#deleting-a-branch)" | | 
git refs create api
| Creation of a ref via the API | "[Git database](/rest/reference/git#create-a-reference)" in the REST API documentation | diff --git a/content/admin/user-management/managing-repositories-in-your-enterprise/migrating-to-internal-repositories.md b/content/admin/user-management/managing-repositories-in-your-enterprise/migrating-to-internal-repositories.md index ca2768fff6..27d9546f4b 100644 --- a/content/admin/user-management/managing-repositories-in-your-enterprise/migrating-to-internal-repositories.md +++ b/content/admin/user-management/managing-repositories-in-your-enterprise/migrating-to-internal-repositories.md @@ -18,7 +18,7 @@ shortTitle: Internal repository migration --- ## About internal repositories -Internal repositories are available in {% data variables.product.prodname_ghe_server %} 2.20+. {% data reusables.repositories.about-internal-repos %} For more information, see "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)." +Internal repositories are available in {% data variables.product.prodname_ghe_server %} 2.20+. {% data reusables.repositories.about-internal-repos %} For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." In future releases of {% data variables.product.prodname_ghe_server %}, we will adjust how repository visibility works so that the terms public, internal, and private have a uniform meaning for developers on {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %}. diff --git a/content/billing/managing-billing-for-github-actions/managing-your-spending-limit-for-github-actions.md b/content/billing/managing-billing-for-github-actions/managing-your-spending-limit-for-github-actions.md index 00fa4de6b7..b24066e4c3 100644 --- a/content/billing/managing-billing-for-github-actions/managing-your-spending-limit-for-github-actions.md +++ b/content/billing/managing-billing-for-github-actions/managing-your-spending-limit-for-github-actions.md @@ -60,3 +60,7 @@ Enterprise owners and billing managers can manage the spending limit for {% data ![Spending limit tab](/assets/images/help/settings/spending-limit-tab-enterprise.png) {% data reusables.dotcom_billing.monthly-spending-limit %} {% data reusables.dotcom_billing.update-spending-limit %} + + +## Managing usage and spending limit email notifications +{% data reusables.billing.email-notifications %} diff --git a/content/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces.md b/content/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces.md index 47be49a20e..ac3f5700e0 100644 --- a/content/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces.md +++ b/content/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces.md @@ -45,3 +45,6 @@ Enterprise owners and billing managers can manage the spending limit for {% data ![Spending limit tab](/assets/images/help/settings/spending-limit-tab-enterprise.png) {% data reusables.dotcom_billing.monthly-spending-limit %} {% data reusables.dotcom_billing.update-spending-limit %} + +## Managing usage and spending limit email notifications +{% data reusables.billing.email-notifications %} diff --git a/content/billing/managing-billing-for-github-packages/managing-your-spending-limit-for-github-packages.md b/content/billing/managing-billing-for-github-packages/managing-your-spending-limit-for-github-packages.md index 0f81476192..3af7755c86 100644 --- a/content/billing/managing-billing-for-github-packages/managing-your-spending-limit-for-github-packages.md +++ b/content/billing/managing-billing-for-github-packages/managing-your-spending-limit-for-github-packages.md @@ -60,3 +60,6 @@ Enterprise owners and billing managers can manage the spending limit for {% data ![Spending limit tab](/assets/images/help/settings/spending-limit-tab-enterprise.png) {% data reusables.dotcom_billing.monthly-spending-limit %} {% data reusables.dotcom_billing.update-spending-limit %} + +## Managing usage and spending limit email notifications +{% data reusables.billing.email-notifications %} diff --git a/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md b/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md index 58ba599b89..8a9e0a2ee9 100644 --- a/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md +++ b/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md @@ -77,7 +77,7 @@ If you scan on push, then the results appear in the **Security** tab for your re ### Scanning pull requests -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. {% ifversion ghes %}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. {% ifversion ghes %}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 "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-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)." diff --git a/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md b/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md index 5d61fc58e1..0dcd2a9774 100644 --- a/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md +++ b/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md @@ -57,7 +57,8 @@ You decide how to generate {% data variables.product.prodname_code_scanning %} a 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. ## Bulk set up of {% data variables.product.prodname_code_scanning %} -You can set up {% data variables.product.prodname_code_scanning %} in many repositories at once using a script. For an example of a script that raises pull requests to add a {% data variables.product.prodname_actions %} workflow to multiple repositories, see the [`jhutchings1/Create-ActionsPRs`](https://github.com/jhutchings1/Create-ActionsPRs) repository. + +You can set up {% data variables.product.prodname_code_scanning %} in many repositories at once using a script. If you'd like to use a script to raise pull requests that add a {% data variables.product.prodname_actions %} workflow to multiple repositories, see the [`jhutchings1/Create-ActionsPRs`](https://github.com/jhutchings1/Create-ActionsPRs) repository for an example using Powershell, or [`nickliffen/ghas-enablement`](https://github.com/NickLiffen/ghas-enablement) for teams who do not have Powershell and instead would like to use NodeJS. ## Understanding the pull request checks diff --git a/content/code-security/security-advisories/collaborating-in-a-temporary-private-fork-to-resolve-a-security-vulnerability.md b/content/code-security/security-advisories/collaborating-in-a-temporary-private-fork-to-resolve-a-security-vulnerability.md index 968cd042eb..f0d51b2bf8 100644 --- a/content/code-security/security-advisories/collaborating-in-a-temporary-private-fork-to-resolve-a-security-vulnerability.md +++ b/content/code-security/security-advisories/collaborating-in-a-temporary-private-fork-to-resolve-a-security-vulnerability.md @@ -47,7 +47,7 @@ Anyone with write permissions to a security advisory can add changes to a tempor 4. In the "Security Advisories" list, click the security advisory you'd like to add changes to. ![Security advisory in list](/assets/images/help/security/security-advisory-in-list.png) 5. Add your changes on {% data variables.product.product_name %} or locally: - - To add changes on {% data variables.product.product_name %}, under "Add changes to this advisory", click **the temporary private fork**. Then, create a new branch and edit files. For more information, see "[Creating and deleting branches within your repository](/articles/creating-and-deleting-branches-within-your-repository)" and "[Editing files in your repository](/articles/editing-files-in-your-repository)." + - To add changes on {% data variables.product.product_name %}, under "Add changes to this advisory", click **the temporary private fork**. Then, create a new branch and edit files. For more information, see "[Creating and deleting branches within your repository](/articles/creating-and-deleting-branches-within-your-repository)" and "[Editing files](/repositories/working-with-files/managing-files/editing-files)." - To add changes locally, follow the instructions under "Clone and create a new branch" and "Make your changes, then push." ![Add changes to this advisory box](/assets/images/help/security/add-changes-to-this-advisory-box.png) diff --git a/content/codespaces/codespaces-reference/disaster-recovery-for-codespaces.md b/content/codespaces/codespaces-reference/disaster-recovery-for-codespaces.md index 678792dc3f..abf03de104 100644 --- a/content/codespaces/codespaces-reference/disaster-recovery-for-codespaces.md +++ b/content/codespaces/codespaces-reference/disaster-recovery-for-codespaces.md @@ -35,7 +35,7 @@ You can check the current service status on the [Status Dashboard](https://www.g ## Option 3: Clone the repository locally or edit in the browser -While {% data variables.product.prodname_codespaces %} provides the benefit of a pre-configured developer environmnent, your source code should always be accessible through the repository hosted on {% data variables.product.prodname_dotcom_the_website %}. In the event of a {% data variables.product.prodname_codespaces %} outage, you can still clone the repository locally or edit files in the {% data variables.product.company_short %} browser editor. For more information, see [Editing files in your repository](/github/managing-files-in-a-repository/managing-files-on-github/editing-files-in-your-repository). +While {% data variables.product.prodname_codespaces %} provides the benefit of a pre-configured developer environmnent, your source code should always be accessible through the repository hosted on {% data variables.product.prodname_dotcom_the_website %}. In the event of a {% data variables.product.prodname_codespaces %} outage, you can still clone the repository locally or edit files in the {% data variables.product.company_short %} browser editor. For more information, see "[Editing files](/repositories/working-with-files/managing-files/editing-files)." While this option does not configure a development environment for you, it will allow you to make changes to your source code as needed while you wait for the service disruption to resolve. diff --git a/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md b/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md index f26ead15f2..0bde988f1e 100644 --- a/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md +++ b/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md @@ -40,7 +40,7 @@ You can create default contribution guidelines for your organization{% ifversion {% data reusables.repositories.navigate-to-repo %} {% data reusables.files.add-file %} -3. Decide whether to store your contributing guidelines in your repository's root, `docs`, or `.github` directory. Then, in the filename field, type the name and extension for the file. Contributing guidelines filenames are not case sensitive. Files are rendered in rich text format if the file extension is in a supported format. For more information, see "[Rendering differences in prose documents](/github/managing-files-in-a-repository/rendering-differences-in-prose-documents)." +3. Decide whether to store your contributing guidelines in your repository's root, `docs`, or `.github` directory. Then, in the filename field, type the name and extension for the file. Contributing guidelines filenames are not case sensitive. Files are rendered in rich text format if the file extension is in a supported format. For more information, see "[Working with non-code files](/repositories/working-with-files/using-files/working-with-non-code-files#rendering-differences-in-prose-documents)." ![New file name](/assets/images/help/repository/new-file-name.png) - To make your contributing guidelines visible in the repository's root directory, type *CONTRIBUTING*. - To make your contributing guidelines visible in the repository's `docs` directory, type *docs/* to create the new directory, then *CONTRIBUTING*. diff --git a/content/developers/apps/building-github-apps/authenticating-with-github-apps.md b/content/developers/apps/building-github-apps/authenticating-with-github-apps.md index 1958a66ea0..5d454070fe 100644 --- a/content/developers/apps/building-github-apps/authenticating-with-github-apps.md +++ b/content/developers/apps/building-github-apps/authenticating-with-github-apps.md @@ -72,7 +72,7 @@ require 'openssl' require 'jwt' # https://rubygems.org/gems/jwt # Private key contents -private_pem = File.read(YOUR_PATH_TO_PEM) +private_pem = File.read("YOUR_PATH_TO_PEM") private_key = OpenSSL::PKey::RSA.new(private_pem) # Generate the JWT @@ -82,14 +82,14 @@ payload = { # JWT expiration time (10 minute maximum) exp: Time.now.to_i + (10 * 60), # {% data variables.product.prodname_github_app %}'s identifier - iss: YOUR_APP_ID + iss: "YOUR_APP_ID" } jwt = JWT.encode(payload, private_key, "RS256") puts jwt ``` -`YOUR_PATH_TO_PEM` and `YOUR_APP_ID` are the values you must replace. +`YOUR_PATH_TO_PEM` and `YOUR_APP_ID` are the values you must replace. Make sure to enclose the values in double quotes. Use your {% data variables.product.prodname_github_app %}'s identifier (`YOUR_APP_ID`) as the value for the JWT [iss](https://tools.ietf.org/html/rfc7519#section-4.1.1) (issuer) claim. You can obtain the {% data variables.product.prodname_github_app %} identifier via the initial webhook ping after [creating the app](/apps/building-github-apps/creating-a-github-app/), or at any time from the app settings page in the GitHub.com UI. diff --git a/content/developers/overview/secret-scanning-partner-program.md b/content/developers/overview/secret-scanning-partner-program.md index a771fbe662..a509773888 100644 --- a/content/developers/overview/secret-scanning-partner-program.md +++ b/content/developers/overview/secret-scanning-partner-program.md @@ -69,7 +69,7 @@ GITHUB-PUBLIC-KEY-IDENTIFIER: 90a421169f0a406205f1563a953312f0be898d3c7b6c06b681 GITHUB-PUBLIC-KEY-SIGNATURE: MEQCIA6C6L8ZYvZnqgV0zwrrmRab10QmIFV396gsba/WYm9oAiAI6Q+/jNaWqkgG5YhaWshTXbRwIgqIK6Ru7LxVYDbV5Q== Content-Length: 0123 -[{"token":"NMIfyYncKcRALEXAMPLE","type":"mycompany_api_token","url":"https://github.com/octocat/Hello-World/commit/123456718ee16e59dabbacb1b4049abc11abc123"}] +[{"token":"NMIfyYncKcRALEXAMPLE","type":"mycompany_api_token","url":"https://github.com/octocat/Hello-World/blob/12345600b9cbe38a219f39a9941c9319b600c002/foo/bar.txt"}] ``` The message body is a JSON array that contains one or more objects with the following contents. When multiple matches are found, {% data variables.product.prodname_dotcom %} may send a single message with more than one secret match. Your endpoint should be able to handle requests with a large number of matches without timing out. diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md index 4cffb9f65a..0206d63b67 100644 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md @@ -127,7 +127,7 @@ You can see the teams that are working on or have submitted an assignment in the ## Next steps -- After you create the assignment and your students form teams, team members can start work on the assignment using Git and {% data variables.product.product_name %}'s features. Students can clone the repository, push commits, manage branches, create and review pull requests, address merge conflicts, and discuss changes with issues. Both you and the team can review the commit history for the repository. For more information, see "[Getting started with {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github)," "[Creating, cloning, and archiving repositories](/github/creating-cloning-and-archiving-repositories)," "[Using Git](/github/getting-started-with-github/using-git)," and "[Collaborating with issues and pull requests](/github/collaborating-with-issues-and-pull-requests)," and the free course on [managing merge conflicts](https://lab.github.com/githubtraining/managing-merge-conflicts) from {% data variables.product.prodname_learning %}. +- After you create the assignment and your students form teams, team members can start work on the assignment using Git and {% data variables.product.product_name %}'s features. Students can clone the repository, push commits, manage branches, create and review pull requests, address merge conflicts, and discuss changes with issues. Both you and the team can review the commit history for the repository. For more information, see "[Getting started with {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github)," "[Repositories](/repositories)," "[Using Git](/github/getting-started-with-github/using-git)," and "[Collaborating with issues and pull requests](/github/collaborating-with-issues-and-pull-requests)," and the free course on [managing merge conflicts](https://lab.github.com/githubtraining/managing-merge-conflicts) from {% data variables.product.prodname_learning %}. - When a team finishes an assignment, you can review the files in the repository, or you can review the history and visualizations for the repository to better understand how the team collaborated. For more information, see "[Visualizing repository data with graphs](/github/visualizing-repository-data-with-graphs)." diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment.md index 4f0b38850d..de52eecf56 100644 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment.md +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment.md @@ -107,7 +107,7 @@ You can see whether a student has joined the classroom and accepted or submitted ## Next steps -- Once you create the assignment, students can start work on the assignment using Git and {% data variables.product.product_name %}'s features. Students can clone the repository, push commits, manage branches, create and review pull requests, address merge conflicts, and discuss changes with issues. Both you and student can review the commit history for the repository. For more information, see "[Getting started with {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github)," "[Creating, cloning, and archiving repositories](/github/creating-cloning-and-archiving-repositories)," "[Using Git](/github/getting-started-with-github/using-git)," and "[Collaborating with issues and pull requests](/github/collaborating-with-issues-and-pull-requests)." +- Once you create the assignment, students can start work on the assignment using Git and {% data variables.product.product_name %}'s features. Students can clone the repository, push commits, manage branches, create and review pull requests, address merge conflicts, and discuss changes with issues. Both you and student can review the commit history for the repository. For more information, see "[Getting started with {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github)," "[Repositories](/repositories)," and "[Collaborating with issues and pull requests](/github/collaborating-with-issues-and-pull-requests)." - When a student finishes an assignment, you can review the files in the repository, or you can review the history and visualizations for the repository to better understand the student's work. For more information, see "[Visualizing repository data with graphs](/github/visualizing-repository-data-with-graphs)." diff --git a/content/get-started/quickstart/set-up-git.md b/content/get-started/quickstart/set-up-git.md index b71911292d..a984e7652e 100644 --- a/content/get-started/quickstart/set-up-git.md +++ b/content/get-started/quickstart/set-up-git.md @@ -33,7 +33,7 @@ If you don't need to work with files locally, {% data variables.product.product_ - [Creating a repository](/articles/create-a-repo) - [Forking a repository](/articles/fork-a-repo) -- [Managing files](/articles/managing-files-on-github/) +- [Managing files](/repositories/working-with-files/managing-files) - [Being social](/articles/be-social) ## Setting up Git diff --git a/content/get-started/using-github/keyboard-shortcuts.md b/content/get-started/using-github/keyboard-shortcuts.md index 2d0afc97df..b1ff417d28 100644 --- a/content/get-started/using-github/keyboard-shortcuts.md +++ b/content/get-started/using-github/keyboard-shortcuts.md @@ -92,7 +92,7 @@ For more keyboard shortcuts, see the [CodeMirror documentation](https://codemirr | Keyboard shortcut | Description |-----------|------------ |c | Create an issue -| control / or command / | Focus your cursor on the issues or pull requests search bar. For more information, see "[Using search to filter issues and pull requests](/articles/using-search-to-filter-issues-and-pull-requests)."|| +| control / or command / | Focus your cursor on the issues or pull requests search bar. For more information, see "[Filtering and searching issues and pull requests](/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests)."|| |u | Filter by author |l | Filter by or edit labels. For more information, see "[Filtering issues and pull requests by labels](/articles/filtering-issues-and-pull-requests-by-labels)." | alt and click | While filtering by labels, exclude labels. For more information, see "[Filtering issues and pull requests by labels](/articles/filtering-issues-and-pull-requests-by-labels)." diff --git a/content/get-started/using-github/troubleshooting-connectivity-problems.md b/content/get-started/using-github/troubleshooting-connectivity-problems.md index 14f4503358..e625ba58fe 100644 --- a/content/get-started/using-github/troubleshooting-connectivity-problems.md +++ b/content/get-started/using-github/troubleshooting-connectivity-problems.md @@ -29,7 +29,7 @@ If you're unable to verify with the captcha: ## Switching cloning methods -Switching from cloning via SSH to cloning via HTTPS, or vice versa may improve connectivity. For more information, see "[Cloning a repository from {% data variables.product.prodname_dotcom %}](/articles/cloning-a-repository-from-github)." +Switching from cloning via SSH to cloning via HTTPS, or vice versa may improve connectivity. For more information, see "[Troubleshooting cloning errors](/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors)." If you're encountering timeouts with SSH, see "[Error: Bad file number](/articles/error-bad-file-number)." diff --git a/content/github-cli/github-cli/using-github-cli-extensions.md b/content/github-cli/github-cli/using-github-cli-extensions.md index c04aa82d5f..27a2bc54fc 100644 --- a/content/github-cli/github-cli/using-github-cli-extensions.md +++ b/content/github-cli/github-cli/using-github-cli-extensions.md @@ -27,10 +27,14 @@ You can find extensions by browsing [repositories with the `gh-extension` topic] ## Installing extensions -To install an extension, use the `extensions install` subcommand. Replace the `owner/repo` parameter with the name of the extension, such as `octocat/gh-whoami`.{% ifversion ghes %} If the extension is on {% data variables.product.prodname_ghe_server %}, also include the hostname, such as `https://ghe.io/octocat/gh-whoami`.{% endif %} +To install an extension, use the `extensions install` subcommand. Replace the `repo` parameter with the repository of the extension. You can use the full URL, such as `https://github.com/octocat/gh-whoami`, or just the owner and repository, such as `octocat/gh-whoami`. + +If the owner and repository are used, `gh` will install the extension using the hostname to which `gh` is currently authenticated. The full URL format is useful when installing extensions from a different host. For example, users on {% data variables.product.prodname_ghe_server %} should use the full repository URL to install extensions from {% data variables.product.prodname_dotcom_the_website %} or any other host. + +To install an extension in development from the current directory, use `.` as the value for the `repo` parameter. ```shell -gh extension install owner/repo +gh extension install repo ``` If you already have an extension by the same name installed, the command will fail. For example, if you have installed `octocat/gh-whoami`, you must uninstall it before installing `hubot/gh-whoami`. diff --git a/content/github/administering-a-repository/finding-information-in-a-repository/filtering-issues-and-pull-requests-by-assignees.md b/content/github/administering-a-repository/finding-information-in-a-repository/filtering-issues-and-pull-requests-by-assignees.md deleted file mode 100644 index f20d55f775..0000000000 --- a/content/github/administering-a-repository/finding-information-in-a-repository/filtering-issues-and-pull-requests-by-assignees.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Filtering issues and pull requests by assignees -intro: 'Once you''ve [assigned an issue or pull request to someone](/articles/assigning-issues-and-pull-requests-to-other-github-users), you can find items based on who''s working on them.' -redirect_from: - - /github/managing-your-work-on-github/finding-information-in-a-repository/filtering-issues-and-pull-requests-by-assignees - - /articles/filtering-issues-and-pull-requests-by-assignees - - /github/managing-your-work-on-github/filtering-issues-and-pull-requests-by-assignees -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Pull requests -shortTitle: Filter by assignee ---- -{% data reusables.cli.filter-issues-and-pull-requests-tip %} - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-issue-pr %} -3. In the upper-right corner, select the Assignee drop-down menu. -4. The Assignee drop-down menu lists everyone who has write access to your repository. Click the name of the person whose assigned items you want to see, or click **Assigned to nobody** to see which issues are unassigned. -![Using the Assignees drop-down tab](/assets/images/help/issues/issues_assignee_dropdown.png) - -{% tip %} - -To clear your filter selection, click **Clear current search query, filters, and sorts**. - -{% endtip %} - -## Further reading - -- "[Filtering issues and pull requests](/articles/filtering-issues-and-pull-requests)" -- "[Sorting issues and pull requests](/articles/sorting-issues-and-pull-requests)" -- "[Using search to filter issues and pull requests](/articles/using-search-to-filter-issues-and-pull-requests)" -- "[Sharing filters](/articles/sharing-filters)" -- "[Viewing all of your issues and pull requests](/articles/viewing-all-of-your-issues-and-pull-requests)" diff --git a/content/github/administering-a-repository/finding-information-in-a-repository/filtering-issues-and-pull-requests-by-labels.md b/content/github/administering-a-repository/finding-information-in-a-repository/filtering-issues-and-pull-requests-by-labels.md deleted file mode 100644 index 0cadc973c3..0000000000 --- a/content/github/administering-a-repository/finding-information-in-a-repository/filtering-issues-and-pull-requests-by-labels.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Filtering issues and pull requests by labels -intro: 'Once you''ve [applied labels to an issue or pull request](/articles/applying-labels-to-issues-and-pull-requests), you can find items based on their labels.' -redirect_from: - - /github/managing-your-work-on-github/finding-information-in-a-repository/filtering-issues-and-pull-requests-by-labels - - /articles/filtering-issues-and-pull-requests-by-labels - - /github/managing-your-work-on-github/filtering-issues-and-pull-requests-by-labels -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Pull requests -shortTitle: Filter by labels ---- -{% data reusables.cli.filter-issues-and-pull-requests-tip %} - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-issue-pr %} -{% data reusables.project-management.labels %} -4. In the list of labels, click a label to see the issues and pull requests that it's been applied to. - ![List of a repository's labels](/assets/images/help/issues/labels-page.png) - -{% tip %} - -**Tip:** To clear your filter selection, click **Clear current search query, filters, and sorts**. - -{% endtip %} - -## Further reading - -- "[Filtering issues and pull requests](/articles/filtering-issues-and-pull-requests)" -- "[Sorting issues and pull requests](/articles/sorting-issues-and-pull-requests)" -- "[Using search to filter issues and pull requests](/articles/using-search-to-filter-issues-and-pull-requests)" -- "[Sharing filters](/articles/sharing-filters)" diff --git a/content/github/administering-a-repository/finding-information-in-a-repository/filtering-issues-and-pull-requests.md b/content/github/administering-a-repository/finding-information-in-a-repository/filtering-issues-and-pull-requests.md deleted file mode 100644 index de78b2aaf2..0000000000 --- a/content/github/administering-a-repository/finding-information-in-a-repository/filtering-issues-and-pull-requests.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: Filtering issues and pull requests -intro: Issues and pull requests come with a set of default filters you can apply to organize your listings. -redirect_from: - - /github/managing-your-work-on-github/finding-information-in-a-repository/filtering-issues-and-pull-requests - - /articles/filtering-issues-and-pull-requests - - /github/managing-your-work-on-github/filtering-issues-and-pull-requests -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Pull requests -shortTitle: Filter issues & PRs ---- -{% data reusables.search.requested_reviews_search %} - -You can filter issues and pull requests to find: -- All open issues and pull requests -- Issues and pull requests that you've created -- Issues and pull requests that are assigned to you -- Issues and pull requests where you're [**@mentioned**](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams) - -{% data reusables.cli.filter-issues-and-pull-requests-tip %} - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-issue-pr %} -3. Click **Filters** to choose the type of filter you're interested in. - ![Using the Filters drop-down](/assets/images/help/issues/issues_filter_dropdown.png) - -## Further reading - -- "[Filtering issues and pull requests by assignees](/articles/filtering-issues-and-pull-requests-by-assignees)" -- "[Filtering issues and pull requests by milestones](/articles/filtering-issues-and-pull-requests-by-milestone)" -- "[Filtering issues and pull requests by labels](/articles/filtering-issues-and-pull-requests-by-labels)" -- "[Filtering pull requests by review status](/articles/filtering-pull-requests-by-review-status)" -- "[Using search to filter issues and pull requests](/articles/using-search-to-filter-issues-and-pull-requests)" -- "[Sharing filters](/articles/sharing-filters)" -- "[Viewing all of your issues and pull requests](/articles/viewing-all-of-your-issues-and-pull-requests)" diff --git a/content/github/administering-a-repository/finding-information-in-a-repository/filtering-pull-requests-by-review-status.md b/content/github/administering-a-repository/finding-information-in-a-repository/filtering-pull-requests-by-review-status.md deleted file mode 100644 index 5c1ae09636..0000000000 --- a/content/github/administering-a-repository/finding-information-in-a-repository/filtering-pull-requests-by-review-status.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Filtering pull requests by review status -intro: You can use filters to list pull requests by review status and to find pull requests that you've reviewed or other people have asked you to review. -redirect_from: - - /github/managing-your-work-on-github/finding-information-in-a-repository/filtering-pull-requests-by-review-status - - /articles/filtering-pull-requests-by-review-status - - /github/managing-your-work-on-github/filtering-pull-requests-by-review-status -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Pull requests -shortTitle: Filter by review status ---- -You can filter a repository's list of pull requests to find: -- Pull requests that haven't been [reviewed](/articles/about-pull-request-reviews) yet -- Pull requests that [require a review](/github/administering-a-repository/about-protected-branches#require-pull-request-reviews-before-merging) before they can be merged -- Pull requests that a reviewer has approved -- Pull requests in which a reviewer has asked for changes -- Pull requests that you have reviewed -- Pull requests that [someone has asked you, or a team you're a member of, to review](/articles/requesting-a-pull-request-review) - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-pr %} -3. In the upper-right corner, select the Reviews drop-down menu. - ![Reviews drop-down menu in the filter menu above the list of pull requests](/assets/images/help/pull_requests/reviews-filter-dropdown.png) -4. Choose a filter to find all of the pull requests with that filter's status. - ![List of filters in the Reviews drop-down menu](/assets/images/help/pull_requests/pr-review-filters.png) - -## Further reading - -- "[About pull request reviews](/articles/about-pull-request-reviews)" -- "[Using search to filter issues and pull requests](/articles/using-search-to-filter-issues-and-pull-requests)" -- "[Viewing all of your issues and pull requests](/articles/viewing-all-of-your-issues-and-pull-requests)" diff --git a/content/github/administering-a-repository/finding-information-in-a-repository/index.md b/content/github/administering-a-repository/finding-information-in-a-repository/index.md deleted file mode 100644 index 61dce22145..0000000000 --- a/content/github/administering-a-repository/finding-information-in-a-repository/index.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Finding information in a repository -intro: 'To find detailed information about a repository on GitHub, you can filter, sort, and search issues and pull requests that are relevant to the repository.' -redirect_from: - - /github/managing-your-work-on-github/finding-information-in-a-repository/ - - /articles/finding-information-in-a-repository -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Pull requests -children: - - /filtering-issues-and-pull-requests - - /filtering-issues-and-pull-requests-by-assignees - - /filtering-issues-and-pull-requests-by-labels - - /filtering-pull-requests-by-review-status - - /sorting-issues-and-pull-requests - - /using-search-to-filter-issues-and-pull-requests - - /sharing-filters -shortTitle: Find information in a repo ---- - diff --git a/content/github/administering-a-repository/finding-information-in-a-repository/sharing-filters.md b/content/github/administering-a-repository/finding-information-in-a-repository/sharing-filters.md deleted file mode 100644 index e838f4dfe6..0000000000 --- a/content/github/administering-a-repository/finding-information-in-a-repository/sharing-filters.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: Sharing filters -intro: 'When you filter or sort issues and pull requests, your browser''s URL is automatically updated to match the new view.' -redirect_from: - - /github/managing-your-work-on-github/finding-information-in-a-repository/sharing-filters - - /articles/sharing-filters - - /github/managing-your-work-on-github/sharing-filters -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Pull requests ---- -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. - -For example, if you filter on issues assigned to Hubot, and sort on the oldest open issues, your URL would update to something like the following: - -``` -/issues?q=state:open+type:issue+assignee:hubot+sort:created-asc -``` - -## Further reading - -* "[Filtering issues and pull requests](/articles/filtering-issues-and-pull-requests)" -* "[Sorting issues and pull requests](/articles/sorting-issues-and-pull-requests)" -* "[Using search to filter issues and pull requests](/articles/using-search-to-filter-issues-and-pull-requests)" diff --git a/content/github/administering-a-repository/finding-information-in-a-repository/sorting-issues-and-pull-requests.md b/content/github/administering-a-repository/finding-information-in-a-repository/sorting-issues-and-pull-requests.md deleted file mode 100644 index 5174f81923..0000000000 --- a/content/github/administering-a-repository/finding-information-in-a-repository/sorting-issues-and-pull-requests.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Sorting issues and pull requests -intro: Filters can be sorted to provide better information during a specific time period. -redirect_from: - - /github/managing-your-work-on-github/finding-information-in-a-repository/sorting-issues-and-pull-requests - - /articles/sorting-issues-and-pull-requests - - /github/managing-your-work-on-github/sorting-issues-and-pull-requests -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Pull requests -shortTitle: Sort issues & PRs ---- -You can sort any filtered view by: - -* The newest created issues or pull requests -* The oldest created issues or pull requests -* The most commented issues or pull requests -* The least commented issues or pull requests -* The newest updated issues or pull requests -* The oldest updated issues or pull requests -* The most added reaction on issues or pull requests - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-issue-pr %} -1. In the upper-right corner, select the Sort drop-down menu. - ![Using the Sort drop-down tab](/assets/images/help/issues/issues_sort_dropdown.png) - -To clear your sort selection, click **Sort** > **Newest**. - -## Further reading - -* "[Filtering issues and pull requests](/articles/filtering-issues-and-pull-requests)" -* "[Using search to filter issues and pull requests](/articles/using-search-to-filter-issues-and-pull-requests)" -* "[Sharing filters](/articles/sharing-filters)" diff --git a/content/github/administering-a-repository/finding-information-in-a-repository/using-search-to-filter-issues-and-pull-requests.md b/content/github/administering-a-repository/finding-information-in-a-repository/using-search-to-filter-issues-and-pull-requests.md deleted file mode 100644 index f01989b0c9..0000000000 --- a/content/github/administering-a-repository/finding-information-in-a-repository/using-search-to-filter-issues-and-pull-requests.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -title: Using search to filter issues and pull requests -intro: You can use advanced filters to search for issues and pull requests that meet specific criteria. -redirect_from: - - /github/managing-your-work-on-github/finding-information-in-a-repository/using-search-to-filter-issues-and-pull-requests - - /articles/using-search-to-filter-issues-and-pull-requests - - /github/managing-your-work-on-github/using-search-to-filter-issues-and-pull-requests -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Pull requests -shortTitle: Use search to filter ---- - -## Searching for issues and pull requests - -{% include tool-switcher %} - -{% webui %} - -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). - -![The issues and pull requests search bar](/assets/images/help/issues/issues_search_bar.png) - -{% tip %} - -**Tip:** {% data reusables.search.search_issues_and_pull_requests_shortcut %} - -{% endtip %} - -{% endwebui %} - -{% cli %} - -{% data reusables.cli.cli-learn-more %} - -You can use the {% data variables.product.prodname_cli %} to search for issues or pull requests. Use the `gh issue list` or `gh pr list` subcommand along with the `--search` argument and a search query. - -For example, you can list, in order of date created, all issues that have no assignee and that have the label `help wanted` or `bug`. - -```shell -gh issue list --search 'no:assignee label:"help wanted",bug sort:created-asc' -``` - -You can also list all pull requests that mention the `octo-org/octo-team` team. - -```shell -gh pr list --search "team:octo-org/octo-team" -``` - -{% endcli %} - -## About search terms - -With issue and pull request search terms, you can: - -- Filter issues and pull requests by author: `state:open type:issue author:octocat` -- Filter issues and pull requests that involve, but don't necessarily [**@mention**](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams), certain people: `state:open type:issue involves:octocat` -- 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"` -- Filter out search terms by using `-` before the term: `state:open type:issue -author:octocat` - -{% ifversion fpt or ghes > 3.2 or ghae-next %} -{% tip %} - -**Tip:** You can filter issues and pull requests by label using logical OR or using logical AND. -- To filter issues using logical OR, use the comma syntax: `label:"bug","wip"`. -- To filter issues using logical AND, use separate label filters: `label:"bug" label:"wip"`. - -{% endtip %} -{% endif %} - -{% ifversion fpt or ghes or ghae %} -For issues, you can also use search to: - -- Filter for issues that are linked to a pull request by a closing reference: `linked:pr` -{% endif %} - -For pull requests, you can also use search to: -- Filter [draft](/articles/about-pull-requests#draft-pull-requests) pull requests: `is:draft` -- Filter pull requests that haven't been [reviewed](/articles/about-pull-request-reviews) yet: `state:open type:pr review:none` -- Filter pull requests that [require a review](/github/administering-a-repository/about-protected-branches#require-pull-request-reviews-before-merging) before they can be merged: `state:open type:pr review:required` -- Filter pull requests that a reviewer has approved: `state:open type:pr review:approved` -- 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`{% ifversion fpt or ghes or ghae %} -- Filter for pull requests that are linked to an issue that the pull request may close: `linked:issue`{% endif %} - -{% note %} - -**Note:** {% data reusables.pull_requests.large-search-workaround %} You can limit your search with the `org:`, `user:`, or `repo:` qualifiers. For more information, see "[Searching issues and pull requests](/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-within-a-users-or-organizations-repositories)." - -{% endnote %} - - - -## Further reading - -- "[Searching issues and pull requests](/articles/searching-issues)" -- "[Filtering issues and pull requests](/articles/filtering-issues-and-pull-requests)" -- "[Sorting issues and pull requests](/articles/sorting-issues-and-pull-requests)" -- "[Sharing filters](/articles/sharing-filters)" diff --git a/content/github/administering-a-repository/index.md b/content/github/administering-a-repository/index.md deleted file mode 100644 index e8d09a42a4..0000000000 --- a/content/github/administering-a-repository/index.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Administering a repository -redirect_from: - - /categories/administering-a-repository -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -children: - - /managing-repository-settings - - /managing-branches-in-your-repository - - /configuring-pull-request-merges - - /defining-the-mergeability-of-pull-requests - - /releasing-projects-on-github - - /finding-information-in-a-repository -shortTitle: Administer a repo ---- - diff --git a/content/github/administering-a-repository/managing-repository-settings/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository.md b/content/github/administering-a-repository/managing-repository-settings/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository.md deleted file mode 100644 index 4ef4f3f7c7..0000000000 --- a/content/github/administering-a-repository/managing-repository-settings/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Configuring the retention period for GitHub Actions artifacts and logs in your repository -intro: 'You can configure the retention period for {% data variables.product.prodname_actions %} artifacts and logs in your repository.' -versions: - fpt: '*' - ghes: '>=3.0' - ghae: '*' -topics: - - Repositories -redirect_from: - - /github/administering-a-repository/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository -shortTitle: Set log retention for Actions ---- -{% data reusables.actions.about-artifact-log-retention %} - -You can also define a custom retention period for a specific artifact created by a workflow. For more information, see "[Setting the retention period for an artifact](/actions/managing-workflow-runs/removing-workflow-artifacts#setting-the-retention-period-for-an-artifact)." - -## Setting the retention period for a repository - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-settings %} -{% data reusables.repositories.settings-sidebar-actions %} -{% data reusables.github-actions.change-retention-period-for-artifacts-logs %} diff --git a/content/github/administering-a-repository/managing-repository-settings/index.md b/content/github/administering-a-repository/managing-repository-settings/index.md deleted file mode 100644 index c546e59435..0000000000 --- a/content/github/administering-a-repository/managing-repository-settings/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Managing repository settings -intro: 'Repository administrators and organization owners can change settings for a repository, like the name, ownership, and visibility, or delete the repository.' -redirect_from: - - /articles/managing-repository-settings -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -children: - - /setting-repository-visibility - - /managing-teams-and-people-with-access-to-your-repository - - /classifying-your-repository-with-topics - - /customizing-how-changed-files-appear-on-github - - /about-email-notifications-for-pushes-to-your-repository - - /displaying-a-sponsor-button-in-your-repository - - /customizing-your-repositorys-social-media-preview - - /viewing-deployment-activity-for-your-repository - - /managing-the-forking-policy-for-your-repository - - /configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository - - /disabling-or-limiting-github-actions-for-a-repository - - /enabling-or-disabling-github-discussions-for-a-repository - - /disabling-project-boards-in-a-repository - - /disabling-issues - - /managing-git-lfs-objects-in-archives-of-your-repository - - /managing-security-and-analysis-settings-for-your-repository - - /enabling-anonymous-git-read-access-for-a-repository - - /configuring-autolinks-to-reference-external-resources - - /renaming-a-repository - - /transferring-a-repository - - /deleting-a-repository - - /restoring-a-deleted-repository -shortTitle: Manage repository settings ---- - diff --git a/content/github/authenticating-to-github/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md b/content/github/authenticating-to-github/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md index 13039f3b44..3bd7f9aae4 100644 --- a/content/github/authenticating-to-github/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md +++ b/content/github/authenticating-to-github/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md @@ -102,19 +102,17 @@ After adding a new SSH key to your {% data variables.product.product_name %} acc If your SSH public key file has a different name than the example code, modify the filename to match your current setup. When copying your key, don't add any newlines or whitespace. ```shell - $ sudo apt-get update - $ sudo apt-get install xclip - # Downloads and installs xclip. If you don't have `apt-get`, you might need to use another installer (like `yum`) - - $ xclip -selection clipboard < ~/.ssh/id_ed25519.pub - # Copies the contents of the id_ed25519.pub file to your clipboard + $ cat ~/.ssh/id_ed25519.pub + # Then select and copy the contents of the id_ed25519.pub file + # displayed in the terminal to your clipboard ``` + {% tip %} - **Tip:** If `xclip` isn't working, you can locate the hidden `.ssh` folder, open the file in your favorite text editor, and copy it to your clipboard. + **Tip:** Alternatively, you can locate the hidden `.ssh` folder, open the file in your favorite text editor, and copy it to your clipboard. {% endtip %} - + {% data reusables.user_settings.access_settings %} {% data reusables.user_settings.ssh %} 4. Click **New SSH key** or **Add SSH key**. diff --git a/content/github/authenticating-to-github/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md b/content/github/authenticating-to-github/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md index 70bd976b26..2778a7c1a1 100644 --- a/content/github/authenticating-to-github/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md +++ b/content/github/authenticating-to-github/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md @@ -139,7 +139,7 @@ Before adding a new SSH key to the ssh-agent to manage your keys, you should hav ``` {% note %} - **Note:** The `-K` option is 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 chose not to add a passphrase to your key, run the command without the `-K` option. + **Note:** The `-K` option is 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 chose not to add a passphrase to your key, run the command without the `-K` option. If you don't have Apple's standard version installed, you may receive an error. For more information on resolving this error, see "[Error: ssh-add: illegal option -- K](/articles/error-ssh-add-illegal-option-k)." diff --git a/content/github/authenticating-to-github/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md b/content/github/authenticating-to-github/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md index b7098039b2..e2e65ab0a5 100644 --- a/content/github/authenticating-to-github/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md +++ b/content/github/authenticating-to-github/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md @@ -18,7 +18,7 @@ shortTitle: Remove sensitive data --- The `git filter-repo` tool 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. -You can remove the file from the latest commit with `git rm`. For information on removing a file that was added with the latest commit, see "[Removing files from a repository's history](/articles/removing-files-from-a-repository-s-history)." +You can remove the file from the latest commit with `git rm`. For information on removing a file that was added with the latest commit, see "[About large files on {% data variables.product.prodname_dotcom %}](/repositories/working-with-files/managing-large-files/about-large-files-on-github#removing-files-from-a-repositorys-history)." {% warning %} diff --git a/content/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests.md b/content/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests.md index 34af6392e1..ba43e59b93 100644 --- a/content/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests.md +++ b/content/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests.md @@ -63,7 +63,7 @@ If you want to simulate a two-dot diff in a pull request and see a comparison be For more information about Git commands to compare changes, see "[Git diff options](https://git-scm.com/docs/git-diff#git-diff-emgitdiffemltoptionsgtltcommitgtltcommitgt--ltpathgt82308203)" from the _Pro Git_ book site. ## Reasons diffs will not display -- You've exceeded the total limit of files or certain file types. For more information, see "[Limits for viewing content and diffs in a repository](/articles/limits-for-viewing-content-and-diffs-in-a-repository/#diff-limits)." +- You've exceeded the total limit of files or certain file types. For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#limits-for-viewing-content-and-diffs-in-a-repository)." - Your file matches a rule in the repository's *.gitattributes* file to block that file from displaying by default. For more information, see "[Customizing how changed files appear on GitHub](/articles/customizing-how-changed-files-appear-on-github)." ## Further reading diff --git a/content/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md b/content/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md index 69c6d2f307..1db679a4a0 100644 --- a/content/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md +++ b/content/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md @@ -32,7 +32,7 @@ Once you've created a pull request, you can push commits from your topic branch Other contributors can review your proposed changes, add review comments, contribute to the pull request discussion, and even add commits to the pull request. {% ifversion fpt %} -You can see information about the branch's current deployment status and past deployment activity on the "Conversation" tab. For more information, see "[Viewing deployment activity for a repository](/articles/viewing-deployment-activity-for-your-repository)." +You can see information about the branch's current deployment status and past deployment activity on the "Conversation" tab. For more information, see "[Viewing deployment activity for a repository](/repositories/viewing-activity-and-data-for-your-repository/viewing-deployment-activity-for-your-repository)." {% endif %} After you're happy with the proposed changes, you can merge the pull request. If you're working in a shared repository model, you create a pull request and you, or someone else, will merge your changes from your feature branch into the base branch you specify in your pull request. For more information, see "[Merging a pull request](/articles/merging-a-pull-request)." @@ -71,7 +71,4 @@ The compare and pull request pages use different methods to calculate the diff f - "[Pull request](/articles/github-glossary/#pull-request)" in the {% data variables.product.prodname_dotcom %} glossary - "[About branches](/articles/about-branches)" - "[Commenting on a pull request](/articles/commenting-on-a-pull-request)" -- "[Merging a pull request](/articles/merging-a-pull-request)" -- "[Closing a pull request](/articles/closing-a-pull-request)" -- "[Deleting unused branches](/articles/deleting-unused-branches)" -- "[About pull request merges](/articles/about-pull-request-merges)" +- "[Closing a pull request](/articles/closing-a-pull-request)" \ No newline at end of file diff --git a/content/github/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md b/content/github/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md index 49d9f697e9..2303ae033d 100644 --- a/content/github/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md +++ b/content/github/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md @@ -68,6 +68,5 @@ The new commit, message, and badge will appear on {% data variables.product.prod - "[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)" -- "[Viewing a summary of repository activity](/articles/viewing-a-summary-of-repository-activity)" - "[Viewing a project’s contributors](/articles/viewing-a-projects-contributors)" - "[Changing a commit message](/articles/changing-a-commit-message)" diff --git a/content/github/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors.md b/content/github/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors.md index a391933779..58d0c57da6 100644 --- a/content/github/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors.md +++ b/content/github/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors.md @@ -83,7 +83,6 @@ The new commit and message will appear on {% data variables.product.product_loca {% ifversion ghes or ghae %} - "[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)" - "[Viewing a project's contributors](/articles/viewing-a-projects-contributors)" - "[Changing a commit message](/articles/changing-a-commit-message)" - "[Committing and reviewing changes to your project](/desktop/contributing-to-projects/committing-and-reviewing-changes-to-your-project#4-write-a-commit-message-and-push-your-changes)" in the {% data variables.product.prodname_desktop %} documentation diff --git a/content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/archiving-repositories.md b/content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/archiving-repositories.md deleted file mode 100644 index 64b03cc200..0000000000 --- a/content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/archiving-repositories.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: Archiving repositories -intro: You can archive a repository to make it read-only for all users and indicate that it's no longer actively maintained. You can also unarchive repositories that have been archived. -redirect_from: - - /articles/archiving-repositories - - /github/creating-cloning-and-archiving-repositories/archiving-repositories -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories ---- -{% data reusables.repositories.archiving-repositories-recommendation %} - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-settings %} -3. Under "Danger Zone", click **Archive this repository** or **Unarchive this repository**. - ![Archive this repository button](/assets/images/help/repository/archive-repository.png) -4. Read the warnings. -5. Type the name of the repository you want to archive or unarchive. - ![Archive repository warnings](/assets/images/help/repository/archive-repository-warnings.png) -6. Click **I understand the consequences, archive this repository**. - -## Further reading -- "[About archiving repositories](/articles/about-archiving-repositories)" diff --git a/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/error-remote-head-refers-to-nonexistent-ref-unable-to-checkout.md b/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/error-remote-head-refers-to-nonexistent-ref-unable-to-checkout.md deleted file mode 100644 index 6cbf0ff753..0000000000 --- a/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/error-remote-head-refers-to-nonexistent-ref-unable-to-checkout.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: 'Error: Remote HEAD refers to nonexistent ref, unable to checkout' -intro: 'This error occurs if the default branch of a repository has been deleted on {% data variables.product.product_location %}.' -redirect_from: - - /articles/error-remote-head-refers-to-nonexistent-ref-unable-to-checkout - - /github/creating-cloning-and-archiving-repositories/error-remote-head-refers-to-nonexistent-ref-unable-to-checkout -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -shortTitle: Unable to checkout ---- -Detecting this error is simple; Git will warn you when you try to clone the repository: - -```shell -$ git clone https://{% data variables.command_line.codeblock %}/user/repo.git -# Clone a repo -> Cloning into 'repo'... -> remote: Counting objects: 66179, done. -> remote: Compressing objects: 100% (15587/15587), done. -> remote: Total 66179 (delta 46985), reused 65596 (delta 46402) -> Receiving objects: 100% (66179/66179), 51.66 MiB | 667 KiB/s, done. -> Resolving deltas: 100% (46985/46985), done. -> warning: remote HEAD refers to nonexistent ref, unable to checkout. -``` - -To fix the error, you'll need to be an administrator of the repository on {% data variables.product.product_location %}. -You'll want to [change the default branch](/github/administering-a-repository/changing-the-default-branch) of the repository. - -After that, you can get a list of all the available branches from the command line: - -```shell -$ git branch -a -# Lists ALL the branches -> remotes/origin/awesome -> remotes/origin/more-work -> remotes/origin/new-main -``` - -Then, you can just switch to your new branch: - -```shell -$ git checkout new-main -# Create and checkout a tracking branch -> Branch new-main set up to track remote branch new-main from origin. -> Switched to a new branch 'new-main' -``` diff --git a/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/error-repository-not-found.md b/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/error-repository-not-found.md deleted file mode 100644 index 8cac0ea0ec..0000000000 --- a/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/error-repository-not-found.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: 'Error: Repository not found' -intro: '{% ifversion fpt or ghae %}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 - - /github/creating-cloning-and-archiving-repositories/error-repository-not-found -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -shortTitle: Repository not found ---- -## Check your spelling - -Typos happen, and repository names are case-sensitive. If you try to clone `git@{% data variables.command_line.codeblock %}:user/repo.git`, but the repository is really named `User/Repo` you will receive this error. - -To avoid this error, when cloning, always copy and paste the clone URL from the repository's page. For more information, see "[Cloning a repository](/articles/cloning-a-repository)." - -To update the remote on an existing repository, see "[Managing remote repositories](/github/getting-started-with-github/managing-remote-repositories)". - -## Checking your permissions - -If you are trying to clone a private repository but do not have permission to view the repository, you will receive this error. - -Make sure that you have access to the repository in one of these ways: - -* The owner of the repository -* A [collaborator](/articles/inviting-collaborators-to-a-personal-repository) on the repository -* A [member of a team](/articles/adding-organization-members-to-a-team) that has access to the repository (if the repository belongs to an organization) - -## Check your SSH access - -In rare circumstances, you may not have the proper SSH access to a repository. - -You should ensure that the SSH key you are using is attached to your {% data variables.product.product_name %} user account. You can check this by typing -the following into the command line: - -```shell -$ ssh -T git@{% data variables.command_line.codeblock %} -> Hi username! You've successfully authenticated, but GitHub does not -> provide shell access. -``` - -If the repository belongs to an organization and you're using an SSH key generated by an OAuth App, OAuth App access may have been restricted by an organization owner. For more information, see "About OAuth App access restrictions." - -For more information, see [Adding a new SSH key to your GitHub account](/articles/adding-a-new-ssh-key-to-your-github-account). - -{% ifversion ghes %} -## 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 - -If all else fails, make sure that the repository really exists on {% data variables.product.product_location %}! -If you're trying to push to a repository that doesn't exist, you'll get this error. diff --git a/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/https-cloning-errors.md b/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/https-cloning-errors.md deleted file mode 100644 index fa240b6466..0000000000 --- a/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/https-cloning-errors.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: HTTPS cloning errors -intro: 'There are a few common errors when using HTTPS with Git. These errors usually indicate you have an old version of Git, or you don''t have access to the repository.' -redirect_from: - - /articles/error-the-requested-url-returned-error-403/ - - /articles/error-the-requested-url-returned-error-401/ - - /articles/error-did-you-run-git-update-server-info-on-the-server/ - - /articles/error-the-requested-url-returned-error-403-while-accessing-https-github-com-user-repo-git-info-refs/ - - /articles/https-cloning-errors - - /github/creating-cloning-and-archiving-repositories/https-cloning-errors -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories ---- -Here's an example of an HTTPS error you might receive: - -```shell -> error: The requested URL returned error: 401 while accessing -> https://{% data variables.command_line.codeblock %}/user/repo.git/info/refs?service=git-receive-pack -> fatal: HTTP request failed -``` - -```shell -> Error: The requested URL returned error: 403 while accessing -> https://{% data variables.command_line.codeblock %}/user/repo.git/info/refs -> fatal: HTTP request failed -``` - -```shell -> Error: https://{% data variables.command_line.codeblock %}/user/repo.git/info/refs not found: did you run git -> update-server-info on the server? -``` - -## Check your Git version - -There's no minimum Git version necessary to interact with {% data variables.product.product_name %}, but we've found version 1.7.10 to be a comfortable stable version that's available on many platforms. You can always [download the latest version on the Git website](https://git-scm.com/downloads). - -## Ensure the remote is correct - -The repository you're trying to fetch must exist on {% data variables.product.product_location %}, and the URL is case-sensitive. - -You can find the URL of the local repository by opening the command line and -typing `git remote -v`: - -```shell -$ git remote -v -# View existing remotes -> origin https://github.com/ghost/reactivecocoa.git (fetch) -> origin https://github.com/ghost/reactivecocoa.git (push) - -$ git remote set-url origin https://github.com/ghost/ReactiveCocoa.git -# Change the 'origin' remote's URL - -$ git remote -v -# Verify new remote URL -> origin https://github.com/ghost/ReactiveCocoa.git (fetch) -> origin https://github.com/ghost/ReactiveCocoa.git (push) -``` - -Alternatively, you can change the URL through our -[{% data variables.product.prodname_desktop %}](https://desktop.github.com/) application. - -## Provide an access token - -To access {% data variables.product.prodname_dotcom %}, you must authenticate with a personal access token instead of your password. For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." - -{% data reusables.command_line.provide-an-access-token %} - -## Check your permissions - -When prompted for a username and password, make sure you use an account that has access to the repository. - -{% 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/getting-started-with-github/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 %} - -## Use SSH instead - -If you've previously set up SSH keys, you can use the SSH clone URL instead of HTTPS. For more information, see "[About remote repositories](/github/getting-started-with-github/about-remote-repositories)." diff --git a/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/index.md b/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/index.md deleted file mode 100644 index 39eb4819b6..0000000000 --- a/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/index.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Cloning a repository from GitHub -intro: 'You can clone a remote repository to your local machine. If you run into errors, there are some common troubleshooting solutions.' -redirect_from: - - /articles/cloning-a-repository-from-github -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -children: - - /cloning-a-repository - - /https-cloning-errors - - /error-repository-not-found - - /error-remote-head-refers-to-nonexistent-ref-unable-to-checkout -shortTitle: Clone a repository ---- - diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-repositories.md b/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-repositories.md deleted file mode 100644 index 7ff0753c74..0000000000 --- a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-repositories.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: About repositories -intro: A repository contains all of your project's files and each file's revision history. You can discuss and manage your project's work within the repository. -redirect_from: - - /articles/about-repositories - - /github/creating-cloning-and-archiving-repositories/about-repositories -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories ---- -You can own repositories individually, or you can share ownership of repositories with other people in an organization. - -You can restrict who has access to a repository by choosing the repository's visibility. For more information, see "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility)." - -For user-owned repositories, you can give other people collaborator access so that they can collaborate on your project. If a repository is owned by an organization, you can give organization members access permissions to collaborate on your repository. For more information, see "[Permission levels for a user account repository](/articles/permission-levels-for-a-user-account-repository/)" and "[Repository permission levels for an organization](/articles/repository-permission-levels-for-an-organization/)." - -{% ifversion fpt %} -With {% data variables.product.prodname_free_team %} for user accounts and organizations, you can work with unlimited collaborators on unlimited public repositories with a full feature set, or unlimited private repositories with a limited feature set. To get advanced tooling for private repositories, you can upgrade to {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, or {% data variables.product.prodname_ghe_cloud %}. {% data reusables.gated-features.more-info %} -{% else %} -Each person and organization can own unlimited repositories and invite an unlimited number of collaborators to all repositories. -{% endif %} - -You can use repositories to manage your work and collaborate with others. -- You can use issues to collect user feedback, report software bugs, and organize tasks you'd like to accomplish. For more information, see "[About issues](/github/managing-your-work-on-github/about-issues)."{% ifversion fpt %} -- {% data reusables.discussions.you-can-use-discussions %}{% endif %} -- You can use pull requests to propose changes to a repository. For more information, see "[About pull requests](/github/collaborating-with-issues-and-pull-requests/about-pull-requests)." -- You can use project boards to organize and prioritize your issues and pull requests. For more information, see "[About project boards](/github/managing-your-work-on-github/about-project-boards)." - -{% data reusables.repositories.repo-size-limit %} - -## Further reading - -- "[Creating a new repository](/articles/creating-a-new-repository)" -- "[Collaborating with issues and pull requests](/categories/collaborating-with-issues-and-pull-requests)" -- "[Managing your work on {% data variables.product.prodname_dotcom %}](/categories/managing-your-work-on-github/)" -- "[Administering a repository](/categories/administering-a-repository)" -- "[Visualizing repository data with graphs](/categories/visualizing-repository-data-with-graphs/)" -- "[About wikis](/communities/documenting-your-project-with-wikis/about-wikis)" -- "[{% data variables.product.prodname_dotcom %} glossary](/articles/github-glossary)" diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-repository-visibility.md b/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-repository-visibility.md deleted file mode 100644 index 4960077f13..0000000000 --- a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-repository-visibility.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: About repository visibility -intro: 'You can restrict who has access to a repository by choosing a repository''s visibility: {% ifversion fpt or ghes %}public, internal, or private{% elsif ghae %}private or internal{% else %} public or private{% endif %}.' -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -redirect_from: - - /github/creating-cloning-and-archiving-repositories/about-repository-visibility -shortTitle: Repository visibility ---- -## About repository visibility - -{% ifversion ghae %}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.{% ifversion fpt or ghes %} If you're creating the repository in an organization{% ifversion fpt %} that is owned by an enterprise account{% endif %}, you can also choose to make the repository internal.{% endif %}{% endif %} - -{% ifversion ghes %} -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. {% ifversion ghes %} Internal repositories are accessible to enterprise members. For more information, see "[About internal repositories](#about-internal-repositories)."{% endif %} -{% elsif ghae %} -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](/organizations/managing-access-to-your-organizations-repositories/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)." - -{% ifversion fpt or ghae or ghes %} -## About internal repositories - -{% note %} - -**Note:** {% data reusables.gated-features.internal-repos %} - -{% endnote %} - -{% 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 enterprise members have read permissions to the internal repository, but internal repositories are not visible to people {% ifversion fpt %}outside of the enterprise{% else %}who are not members of an organization{% endif %}, including outside collaborators on organization repositories. For more information, see {% ifversion fpt or ghae %}"[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 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/creating-a-repository-on-github/index.md b/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/index.md deleted file mode 100644 index eed653820b..0000000000 --- a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/index.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: Creating a repository on GitHub -intro: 'After you create your repository on {% data variables.product.product_name %}, you can customize its settings and content.' -redirect_from: - - /articles/creating-a-repository-on-github -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -children: - - /about-repositories - - /about-repository-visibility - - /creating-a-new-repository - - /creating-a-repository-from-a-template - - /about-readmes - - /about-code-owners - - /about-repository-languages - - /licensing-a-repository - - /about-citation-files - - /creating-a-template-repository - - /creating-an-issues-only-repository - - /limits-for-viewing-content-and-diffs-in-a-repository - - /duplicating-a-repository -shortTitle: Create a repository ---- - diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/limits-for-viewing-content-and-diffs-in-a-repository.md b/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/limits-for-viewing-content-and-diffs-in-a-repository.md deleted file mode 100644 index a664a323e6..0000000000 --- a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/limits-for-viewing-content-and-diffs-in-a-repository.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Limits for viewing content and diffs in a repository -intro: 'Certain types of resources can be quite large, requiring excessive processing on {% data variables.product.product_name %}. Because of this, limits are set to ensure requests complete in a reasonable amount of time.' -redirect_from: - - /articles/what-are-the-limits-for-viewing-content-and-diffs-in-my-repository/ - - /articles/limits-for-viewing-content-and-diffs-in-a-repository - - /github/creating-cloning-and-archiving-repositories/limits-for-viewing-content-and-diffs-in-a-repository -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -shortTitle: Content & diffs limits ---- -Most of the limits below affect both {% data variables.product.product_name %} and the API. - -## Text limits - -Text files over **1 MB** are always displayed as plain text. Code is not syntax highlighted, and prose files are not converted to HTML (such as Markdown, AsciiDoc, *etc.*). - -Text files over **5 MB** are only available through their raw URLs, which are served through `{% data variables.product.raw_github_com %}`; for example, `https://{% data variables.product.raw_github_com %}/octocat/Spoon-Knife/master/index.html`. Click the **Raw** button to get the raw URL for a file. - -## Diff limits - -Because diffs can become very large, we impose these limits on diffs for commits, pull requests, and compare views: - -- In a pull request, no total diff may exceed *20,000 lines that you can load* or *1 MB* of raw diff data. -- No single file's diff may exceed *3,000 lines that you can load* or *100 KB* of raw diff data. *Four hundred lines* and *20 KB* are automatically loaded for a single file. -- The maximum number of files in a single diff is limited to *300*. -- The maximum number of renderable files (such as images, PDFs, and GeoJSON files) in a single diff is limited to *25*. - -Some portions of a limited diff may be displayed, but anything exceeding the limit is not shown. - -## Commit listings limits - -The compare view and pull requests pages display a list of commits between the `base` and `head` revisions. These lists are limited to **250** commits. If they exceed that limit, a note indicates that additional commits are present (but they're not shown). diff --git a/content/github/creating-cloning-and-archiving-repositories/index.md b/content/github/creating-cloning-and-archiving-repositories/index.md deleted file mode 100644 index cda0ac7951..0000000000 --- a/content/github/creating-cloning-and-archiving-repositories/index.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: 'Creating, cloning, and archiving repositories' -intro: 'You can choose from a variety of configuration options when creating or cloning a repository. You can also use repositories to archive content and data on {% data variables.product.prodname_dotcom %}.' -redirect_from: - - /categories/repositories/ - - /categories/24/articles/ - - /categories/creating-cloning-and-archiving-repositories -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -children: - - /creating-a-repository-on-github - - /cloning-a-repository-from-github - - /archiving-a-github-repository -shortTitle: 'Create, clone & archive' ---- - diff --git a/content/github/importing-your-projects-to-github/importing-source-code-to-github/adding-an-existing-project-to-github-using-the-command-line.md b/content/github/importing-your-projects-to-github/importing-source-code-to-github/adding-an-existing-project-to-github-using-the-command-line.md index 67b222cd57..89eafcc04e 100644 --- a/content/github/importing-your-projects-to-github/importing-source-code-to-github/adding-an-existing-project-to-github-using-the-command-line.md +++ b/content/github/importing-your-projects-to-github/importing-source-code-to-github/adding-an-existing-project-to-github-using-the-command-line.md @@ -58,7 +58,7 @@ shortTitle: Add a project locally {% mac %} -1. [Create a new repository](/articles/creating-a-new-repository) on {% data variables.product.product_location %}. To avoid errors, do not initialize the new repository with *README*, license, or `gitignore` files. You can add these files after your project has been pushed to {% data variables.product.product_name %}. +1. [Create a new repository](/repositories/creating-and-managing-repositories/creating-a-new-repository) on {% data variables.product.product_location %}. To avoid errors, do not initialize the new repository with *README*, license, or `gitignore` files. You can add these files after your project has been pushed to {% data variables.product.product_name %}. ![Create New Repository drop-down](/assets/images/help/repository/repo-create.png) {% data reusables.command_line.open_the_multi_os_terminal %} 3. Change the current working directory to your local project. @@ -169,4 +169,4 @@ shortTitle: Add a project locally ## Further reading -- "[Adding a file to a repository using the command line](/articles/adding-a-file-to-a-repository-using-the-command-line)" +- "[Adding a file to a repository](/repositories/working-with-files/managing-files/adding-a-file-to-a-repository#adding-a-file-to-a-repository-using-the-command-line)" diff --git a/content/github/index.md b/content/github/index.md index 540b50988a..fdfeb64ed6 100644 --- a/content/github/index.md +++ b/content/github/index.md @@ -14,17 +14,12 @@ children: - /copilot - /setting-up-and-managing-your-enterprise - /writing-on-github - - /creating-cloning-and-archiving-repositories - /committing-changes-to-your-project - /collaborating-with-pull-requests - /searching-for-information-on-github - /importing-your-projects-to-github - - /administering-a-repository - - /visualizing-repository-data-with-graphs - /managing-security-vulnerabilities - /finding-security-vulnerabilities-and-errors-in-your-code - - /managing-files-in-a-repository - - /managing-large-files - /customizing-your-github-workflow - /extending-github - /working-with-github-support diff --git a/content/github/managing-files-in-a-repository/index.md b/content/github/managing-files-in-a-repository/index.md deleted file mode 100644 index 85098e1287..0000000000 --- a/content/github/managing-files-in-a-repository/index.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Managing files in a repository -redirect_from: - - /categories/81/articles/ - - /categories/manipulating-files/ - - /categories/managing-files-in-a-repository -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -children: - - /managing-files-on-github - - /managing-files-using-the-command-line - - /working-with-non-code-files -shortTitle: Manage files in a repository ---- - diff --git a/content/github/managing-files-in-a-repository/managing-files-on-github/adding-a-file-to-a-repository.md b/content/github/managing-files-in-a-repository/managing-files-on-github/adding-a-file-to-a-repository.md deleted file mode 100644 index 71cd5f52b8..0000000000 --- a/content/github/managing-files-in-a-repository/managing-files-on-github/adding-a-file-to-a-repository.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Adding a file to a repository -intro: 'You can upload and commit an existing file to a {% data variables.product.product_name %} repository. Drag and drop a file to any directory in the file tree, or upload files from the repository''s main page.' -redirect_from: - - /articles/adding-a-file-to-a-repository - - /github/managing-files-in-a-repository/adding-a-file-to-a-repository -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -shortTitle: Add a file ---- -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)." - -{% tip %} - -**Tips:** -- You can upload multiple files to {% data variables.product.product_name %} at the same time. -- {% data reusables.repositories.protected-branches-block-web-edits-uploads %} - -{% endtip %} - -{% data reusables.repositories.navigate-to-repo %} -2. Above the list of files, using the **Add file** drop-down, click **Upload files**. - !["Upload files" in the "Add file" dropdown](/assets/images/help/repository/upload-files-button.png) -3. Drag and drop the file or folder you'd like to upload to your repository onto the file tree. -![Drag and drop area](/assets/images/help/repository/upload-files-drag-and-drop.png) -{% data reusables.files.write_commit_message %} -{% data reusables.files.choose_commit_branch %} -6. Click **Commit changes**. -![Commit changes button](/assets/images/help/repository/commit-changes-button.png) diff --git a/content/github/managing-files-in-a-repository/managing-files-on-github/editing-files-in-another-users-repository.md b/content/github/managing-files-in-a-repository/managing-files-on-github/editing-files-in-another-users-repository.md deleted file mode 100644 index 8aa97b831a..0000000000 --- a/content/github/managing-files-in-a-repository/managing-files-on-github/editing-files-in-another-users-repository.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Editing files in another user's repository -intro: 'When you edit a file in another user''s repository, we''ll automatically [fork the repository](/articles/fork-a-repo) and [open a pull request](/articles/creating-a-pull-request) for you.' -redirect_from: - - /articles/editing-files-in-another-users-repository/ - - /articles/editing-files-in-another-user-s-repository - - /articles/editing-files-in-another-users-repository - - /github/managing-files-in-a-repository/editing-files-in-another-users-repository -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -shortTitle: Edit another user's files ---- -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. -2. Above the file content, click {% octicon "pencil" aria-label="The edit icon" %}. At this point, GitHub forks the repository for you. -3. Make any changes you need to the file. -![New content in file](/assets/images/help/repository/edit-readme-light.png) -{% data reusables.files.preview_change %} -{% data reusables.files.write_commit_message %} -{% data reusables.files.choose-commit-email %} -6. Click **Propose file change**. -![Commit Changes button](/assets/images/help/repository/propose_file_change_button.png) -7. Type a title and description for your pull request. -![Pull Request description page](/assets/images/help/pull_requests/pullrequest-description.png) -8. Click **Create pull request**. -![Pull Request button](/assets/images/help/pull_requests/pullrequest-send.png) - -## Further reading - -* "[Editing files in your repository](/articles/editing-files-in-your-repository)" diff --git a/content/github/managing-files-in-a-repository/managing-files-on-github/editing-files-in-your-repository.md b/content/github/managing-files-in-a-repository/managing-files-on-github/editing-files-in-your-repository.md deleted file mode 100644 index 220b4f32fd..0000000000 --- a/content/github/managing-files-in-a-repository/managing-files-on-github/editing-files-in-your-repository.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Editing files in your repository -intro: 'You can edit files directly on {% data variables.product.product_name %} in any of your repositories using the file editor.' -redirect_from: - - /articles/editing-files/ - - /articles/editing-files-in-your-repository - - /github/managing-files-in-a-repository/editing-files-in-your-repository -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -shortTitle: Edit your files ---- -{% tip %} - -**Tip**: {% data reusables.repositories.protected-branches-block-web-edits-uploads %} - -{% endtip %} - -{% note %} - -**Note:** {% data variables.product.product_name %}'s file editor uses [CodeMirror](https://codemirror.net/). - -{% endnote %} - -1. In your repository, browse to the file you want to edit. -{% data reusables.repositories.edit-file %} -3. On the **Edit file** tab, make any changes you need to the file. -![New content in file](/assets/images/help/repository/edit-readme-light.png) -{% data reusables.files.preview_change %} -{% data reusables.files.write_commit_message %} -{% data reusables.files.choose-commit-email %} -{% data reusables.files.choose_commit_branch %} -{% data reusables.files.propose_file_change %} - -## Further reading - -* "[Editing files in another user's repository](/articles/editing-files-in-another-user-s-repository)" diff --git a/content/github/managing-files-in-a-repository/managing-files-on-github/index.md b/content/github/managing-files-in-a-repository/managing-files-on-github/index.md deleted file mode 100644 index da8f7e77b7..0000000000 --- a/content/github/managing-files-in-a-repository/managing-files-on-github/index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: Managing files on GitHub -intro: 'On {% data variables.product.product_name %}, you can create, edit, move, and delete files in a repository.' -redirect_from: - - /articles/managing-files-on-github -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -children: - - /navigating-code-on-github - - /creating-new-files - - /adding-a-file-to-a-repository - - /moving-a-file-to-a-new-location - - /editing-files-in-your-repository - - /editing-files-in-another-users-repository - - /tracking-changes-in-a-file - - /deleting-files-in-a-repository - - /renaming-a-file - - /getting-permanent-links-to-files ---- - diff --git a/content/github/managing-files-in-a-repository/managing-files-on-github/moving-a-file-to-a-new-location.md b/content/github/managing-files-in-a-repository/managing-files-on-github/moving-a-file-to-a-new-location.md deleted file mode 100644 index f54fa5ae7d..0000000000 --- a/content/github/managing-files-in-a-repository/managing-files-on-github/moving-a-file-to-a-new-location.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Moving a file to a new location -intro: 'When editing a file, you can choose to move it anywhere within your repository, even if the directory doesn''t exist.' -redirect_from: - - /articles/moving-a-file-to-a-new-location - - /github/managing-files-in-a-repository/moving-a-file-to-a-new-location -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -shortTitle: Move a file ---- -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. - -{% tip %} - -**Tips**: - -- If you try to move a file in a repository that you don’t have access to, we'll fork the project to your user account and help you send [a pull request](/articles/about-pull-requests) to the original repository after you commit your change. -- Some files, such as images, require that you move them from the command line. For more information, see "[Moving a file to a new location using the command line](/articles/moving-a-file-to-a-new-location-using-the-command-line)". -- {% data reusables.repositories.protected-branches-block-web-edits-uploads %} - -{% endtip %} - -1. In your repository, browse to the file you want to move. -2. In the upper right corner of the file view, click {% octicon "pencil" aria-label="The edit icon" %} to open the file editor. -![Edit file icon](/assets/images/help/repository/move-file-edit-file-icon.png) -3. In the filename field, change the name of the file using these guidelines: - ![Editing a file name](/assets/images/help/repository/moving_files.gif) - - To move the file **into a subfolder**, type the name of the folder you want, followed by `/`. Your new folder name becomes a new item in the navigation breadcrumbs. - - To move the file into a directory **above the file's current location**, place your cursor at the beginning of the filename field, then either type `../` to jump up one full directory level, or type the `backspace` key to edit the parent folder's name. -{% data reusables.files.write_commit_message %} -{% data reusables.files.choose_commit_branch %} -{% data reusables.files.propose_file_change %} diff --git a/content/github/managing-files-in-a-repository/managing-files-on-github/renaming-a-file.md b/content/github/managing-files-in-a-repository/managing-files-on-github/renaming-a-file.md deleted file mode 100644 index 46eaa20f6f..0000000000 --- a/content/github/managing-files-in-a-repository/managing-files-on-github/renaming-a-file.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Renaming a file -intro: 'You can rename any file in your repositories directly in {% data variables.product.product_name %}. Renaming a file also gives you the opportunity to [move the file to a new location](/articles/moving-a-file-to-a-new-location).' -redirect_from: - - /articles/renaming-a-file - - /github/managing-files-in-a-repository/renaming-a-file -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories ---- -{% tip %} - -**Tips**: - -- If you try to rename a file in a repository that you don’t have access to, we will fork the project to your user account and help you send [a pull request](/articles/about-pull-requests) to the original repository after you commit your change. -- File names created via the web interface can only contain alphanumeric characters and hyphens (`-`). To use other characters, create and commit the files locally and then push them to the repository. -- Some files, such as images, require that you rename them from the command line. For more information, see "[Renaming a file using the command line](/articles/renaming-a-file-using-the-command-line)." - -{% endtip %} - -1. In your repository, browse to the file you want to rename. -2. In the upper right corner of the file view, click {% octicon "pencil" aria-label="The edit icon" %} to open the file editor. -![Edit file icon](/assets/images/help/repository/edit-file-icon.png) -3. In the filename field, change the name of the file to the new filename you want. You can also update the contents of your file at the same time. -![Editing a file name](/assets/images/help/repository/changing-file-name.png) -{% data reusables.files.write_commit_message %} -{% data reusables.files.choose_commit_branch %} -{% data reusables.files.propose_file_change %} diff --git a/content/github/managing-files-in-a-repository/managing-files-using-the-command-line/adding-a-file-to-a-repository-using-the-command-line.md b/content/github/managing-files-in-a-repository/managing-files-using-the-command-line/adding-a-file-to-a-repository-using-the-command-line.md deleted file mode 100644 index 1461590d0f..0000000000 --- a/content/github/managing-files-in-a-repository/managing-files-using-the-command-line/adding-a-file-to-a-repository-using-the-command-line.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: Adding a file to a repository using the command line -intro: 'You can upload an existing file to a {% data variables.product.product_name %} repository using the command line.' -redirect_from: - - /articles/adding-a-file-to-a-repository-from-the-command-line/ - - /articles/adding-a-file-to-a-repository-using-the-command-line - - /github/managing-files-in-a-repository/adding-a-file-to-a-repository-using-the-command-line -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -shortTitle: Add a file locally ---- -{% tip %} - -**Tip:** You can also [add an existing file to a repository from the {% data variables.product.product_name %} website](/articles/adding-a-file-to-a-repository). - -{% endtip %} - -{% data reusables.command_line.manipulating_file_prereqs %} - -{% data reusables.repositories.sensitive-info-warning %} - -1. On your computer, move the file you'd like to upload to {% data variables.product.product_name %} into the local directory that was created when you cloned the repository. -{% data reusables.command_line.open_the_multi_os_terminal %} -{% data reusables.command_line.switching_directories_procedural %} -{% data reusables.git.stage_for_commit %} - ```shell - $ git add . - # Adds the file to your local repository and stages it for commit. {% data reusables.git.unstage-codeblock %} - ``` -{% data reusables.git.commit-file %} - ```shell - $ git commit -m "Add existing file" - # Commits the tracked changes and prepares them to be pushed to a remote repository. {% data reusables.git.reset-head-to-previous-commit-codeblock %} - ``` -{% data reusables.git.git-push %} - -## Further reading - -- "[Creating new files](/articles/creating-new-files)" -- "[Adding an existing project to GitHub using the command line](/articles/adding-an-existing-project-to-github-using-the-command-line)" diff --git a/content/github/managing-files-in-a-repository/managing-files-using-the-command-line/index.md b/content/github/managing-files-in-a-repository/managing-files-using-the-command-line/index.md deleted file mode 100644 index 5c5b9c30ff..0000000000 --- a/content/github/managing-files-in-a-repository/managing-files-using-the-command-line/index.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Managing files using the command line -intro: 'Using the command line, you can add, rename, and move files in a repository.' -redirect_from: - - /articles/managing-files-using-the-command-line -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -children: - - /adding-a-file-to-a-repository-using-the-command-line - - /renaming-a-file-using-the-command-line - - /moving-a-file-to-a-new-location-using-the-command-line -shortTitle: Manage files locally ---- - diff --git a/content/github/managing-files-in-a-repository/managing-files-using-the-command-line/moving-a-file-to-a-new-location-using-the-command-line.md b/content/github/managing-files-in-a-repository/managing-files-using-the-command-line/moving-a-file-to-a-new-location-using-the-command-line.md deleted file mode 100644 index 99b8ad3efc..0000000000 --- a/content/github/managing-files-in-a-repository/managing-files-using-the-command-line/moving-a-file-to-a-new-location-using-the-command-line.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: Moving a file to a new location using the command line -intro: You can use the command line to move files within a repository by removing the file from the old location and then adding it in the new location. -redirect_from: - - /articles/moving-a-file-to-a-new-location-using-the-command-line - - /github/managing-files-in-a-repository/moving-a-file-to-a-new-location-using-the-command-line -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -shortTitle: Move a file locally ---- -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. - -{% data reusables.command_line.manipulating_file_prereqs %} - -1. On your computer, move the file to a new location within the directory that was created locally on your computer when you cloned the repository. -{% data reusables.command_line.open_the_multi_os_terminal %} -3. Use `git status` to check the old and new file locations. - ```shell - $ git status - > # On branch your-branch - > # Changes not staged for commit: - > # (use "git add/rm ..." to update what will be committed) - > # (use "git checkout -- ..." to discard changes in working directory) - > # - > # deleted: /old-folder/image.png - > # - > # Untracked files: - > # (use "git add ..." to include in what will be committed) - > # - > # /new-folder/image.png - > # - > # no changes added to commit (use "git add" and/or "git commit -a") - ``` -{% data reusables.git.stage_for_commit %} This will delete, or `git rm`, the file from the old location and add, or `git add`, the file to the new location. - ```shell - $ git add . - # Adds the file to your local repository and stages it for commit. - # {% data reusables.git.unstage-codeblock %} - ``` -5. Use `git status` to check the changes staged for commit. - ```shell - $ git status - > # On branch your-branch - > # Changes to be committed: - > # (use "git reset HEAD ..." to unstage) - > # - > # renamed: /old-folder/image.png -> /new-folder/image.png - # Displays the changes staged for commit - ``` -{% data reusables.git.commit-file %} - ```shell - $ git commit -m "Move file to new directory" - # Commits the tracked changes and prepares them to be pushed to a remote repository. - # {% data reusables.git.reset-head-to-previous-commit-codeblock %} - ``` -{% data reusables.git.git-push %} - -## Further reading - -- "[Renaming a file using the command line](/articles/renaming-a-file-using-the-command-line)" -- "[Adding a file to a repository using the command line](/articles/adding-a-file-to-a-repository-using-the-command-line)" diff --git a/content/github/managing-files-in-a-repository/managing-files-using-the-command-line/renaming-a-file-using-the-command-line.md b/content/github/managing-files-in-a-repository/managing-files-using-the-command-line/renaming-a-file-using-the-command-line.md deleted file mode 100644 index a3cda1ad40..0000000000 --- a/content/github/managing-files-in-a-repository/managing-files-using-the-command-line/renaming-a-file-using-the-command-line.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Renaming a file using the command line -intro: You can use the command line to rename any file in your repository. -redirect_from: - - /articles/renaming-a-file-using-the-command-line - - /github/managing-files-in-a-repository/renaming-a-file-using-the-command-line -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -shortTitle: Rename a file locally ---- -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. - -{% data reusables.command_line.manipulating_file_prereqs %} - -{% data reusables.command_line.open_the_multi_os_terminal %} -{% data reusables.command_line.switching_directories_procedural %} -3. Rename the file, specifying the old file name and the new name you'd like to give the file. This will stage your change for commit. - ```shell - $ git mv old_filename new_filename - ``` -4. Use `git status` to check the old and new file names. - ```shell - $ git status - > # On branch your-branch - > # Changes to be committed: - > # (use "git reset HEAD ..." to unstage) - > # - > # renamed: old_filename -> new_filename - > # - ``` -{% data reusables.git.commit-file %} - ```shell - $ git commit -m "Rename file" - # Commits the tracked changes and prepares them to be pushed to a remote repository. - # {% data reusables.git.reset-head-to-previous-commit-codeblock %} - ``` -{% data reusables.git.git-push %} - -## Further reading -- "[Moving a file to a new location using the command line](/articles/moving-a-file-to-a-new-location-using-the-command-line)" -- "[Adding a file to a repository using the command line](/articles/adding-a-file-to-a-repository-using-the-command-line)" diff --git a/content/github/managing-files-in-a-repository/working-with-non-code-files/3d-file-viewer.md b/content/github/managing-files-in-a-repository/working-with-non-code-files/3d-file-viewer.md deleted file mode 100644 index f9571f4b47..0000000000 --- a/content/github/managing-files-in-a-repository/working-with-non-code-files/3d-file-viewer.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: 3D File Viewer -redirect_from: - - /articles/stl-file-viewer/ - - /articles/3d-file-viewer - - /github/managing-files-in-a-repository/3d-file-viewer -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories ---- -{% data variables.product.product_name %} can host and render 3D files with the *.stl* extension. - -When looking directly at an STL file on {% data variables.product.product_name %} you can: - -* Click and drag to spin the model. -* Right click and drag to translate the view. -* Scroll to zoom in and out. -* Click the different view modes to change the view. - -## Diffs - -When looking at a commit or set of changes which includes an STL file, you'll be able to see a before and after diff of the file. - -By default, you'll get a view where everything unchanged is in wireframe. Additions are colored in green, and removed parts are colored in red. - -![wireframe](/assets/images/help/repository/stl_wireframe.png) - -You can also select the **Revision Slider** option, which lets you use a slider at the top of the file to transition between the current and previous revisions. - -## Fixing slow performance - -If you see this icon in the corner of the viewer, then the WebGL technology is not available on your browser: - -![WebGL pop error](/assets/images/help/repository/render_webgl_error.png) - -WebGL is necessary to take advantage of your computer's hardware to its fullest. We recommend you try browsers like [Chrome](https://www.google.com/intl/en/chrome/browser/) or [Firefox](https://www.mozilla.org/en-US/firefox/new/), which ship with WebGL enabled. - -## Error: "Unable to display" - -If your model is invalid, GitHub may not be able to display the file. In addition, files that are larger than 10 MB are too big for GitHub to display. - -## Embedding your model elsewhere - -To display your 3D file elsewhere on the internet, modify this template and place it on any HTML page that supports JavaScript: - -```html - -``` - -For example, if your model's URL is [github.com/skalnik/secret-bear-clip/blob/master/stl/clip.stl](https://github.com/skalnik/secret-bear-clip/blob/master/stl/clip.stl), your embed code would be: - -```html - -``` - -By default, the embedded renderer is 420 pixels wide by 620 pixels high, but you can customize the output by passing height and width variables as parameters at the end of the URL, such as `?height=300&width=500`. - -{% tip %} - -**Note**: `ref` can be a branch or the hash to an individual commit (like `2391ae`). - -{% endtip %} diff --git a/content/github/managing-files-in-a-repository/working-with-non-code-files/index.md b/content/github/managing-files-in-a-repository/working-with-non-code-files/index.md deleted file mode 100644 index 960d2d455d..0000000000 --- a/content/github/managing-files-in-a-repository/working-with-non-code-files/index.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Working with non-code files -intro: '' -redirect_from: - - /categories/89/articles/ - - /articles/working-with-non-code-files -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -children: - - /rendering-and-diffing-images - - /3d-file-viewer - - /rendering-csv-and-tsv-data - - /rendering-pdf-documents - - /rendering-differences-in-prose-documents - - /mapping-geojson-files-on-github - - /working-with-jupyter-notebook-files-on-github -shortTitle: Work with non-code files ---- - diff --git a/content/github/managing-files-in-a-repository/working-with-non-code-files/mapping-geojson-files-on-github.md b/content/github/managing-files-in-a-repository/working-with-non-code-files/mapping-geojson-files-on-github.md deleted file mode 100644 index ee0277edaa..0000000000 --- a/content/github/managing-files-in-a-repository/working-with-non-code-files/mapping-geojson-files-on-github.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: Mapping geoJSON files on GitHub -redirect_from: - - /articles/mapping-geojson-files-on-github - - /github/managing-files-in-a-repository/mapping-geojson-files-on-github -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -shortTitle: Mapping geoJSON files ---- -{% 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. - -When you click the paper icon on the right, you'll also see the changes made to that file as part of a commit. - -![Source Render toggle screenshot](/assets/images/help/repository/source-render-toggle-geojson.png) - -## Geometry Types - -Maps on {% data variables.product.product_name %} use [Leaflet.js](http://leafletjs.com) and support all the geometry types outlined in [the geoJSON spec](http://www.geojson.org/geojson-spec.html) (Point, LineString, Polygon, MultiPoint, MultiLineString, MultiPolygon, and GeometryCollection). TopoJSON files should be type "Topology" and adhere to the [topoJSON spec](https://github.com/mbostock/topojson/wiki/Specification). - -## Styling features - -You can customize the way features are displayed, such as specifying a particular color or adding a descriptive icon, by passing additional metadata within the geoJSON object's properties. The options are: - -* `marker-size` - `small`, `medium`, or `large` -* `marker-color` - valid RGB hex color -* `marker-symbol` - an icon ID from [the Maki project](http://mapbox.com/maki/) or a single alphanumeric character (a-z or 0-9). -* `stroke` - color of a polygon edge or line (RGB) -* `stroke-opacity` - opacity of a polygon edge or line (0.0 - 1.0) -* `stroke-width` - width of a polygon edge or line -* `fill` - the color of the interior of a polygon (GRB) -* `fill-opacity` - the opacity of the interior of a polygon (0.0-1.0) - -See [version 1.1.0 of the open simplestyle spec](https://github.com/mapbox/simplestyle-spec/tree/master/1.1.0) for more information. - -## Embedding your map elsewhere - -Want to make your geoJSON map available someplace other than {% data variables.product.product_name %}? Simply modify this template, and place it in any HTML page that supports javascript (e.g., [{% data variables.product.prodname_pages %}](http://pages.github.com)): - -```html - -``` - -For example, if your map's URL is [github.com/benbalter/dc-wifi-social/blob/master/bars.geojson](https://github.com/benbalter/dc-wifi-social/blob/master/bars.geojson), your embed code would be: - -```html - -``` - -By default, the embedded map 420px x 620px, but you can customize the output by passing height and width variables as parameters at the end, such as `?height=300&width=500`. - -{% tip %} - -**Note**: `ref` can be a branch or the hash to an individual commit (like `2391ae`). - -{% endtip %} - -## Clustering - -If your map contains a large number of markers (roughly over 750), GitHub will automatically cluster nearby markers at higher zoom levels. Simply click the cluster or zoom in to see individual markers. - -## Something's up with the underlying map - -The underlying map data (street names, roads, etc.) are driven by [OpenStreetMap](http://www.openstreetmap.org/), a collaborative project to create a free editable map of the world. If you notice something's not quite right, since it's open source, simply [sign up](https://www.openstreetmap.org/user/new) and submit a fix. - -## Troubleshooting - -If you're having trouble rendering geoJSON files, ensure you have a valid geoJSON file by running it through a [geoJSON linter](http://geojsonlint.com/). If your points aren't appearing where you'd expect (e.g., in the middle of the ocean), it's likely that the data is in a projection which is currently unsupported. Currently, {% data variables.product.product_name %} only supports the `urn:ogc:def:crs:OGC:1.3:CRS84` projection. - -Additionally, if your `.geojson` file is especially large (over 10 MB), it is not possible to render within the browser. If that's the case, you'll generally see a message that looks something like this: - -![Large file](/assets/images/help/repository/view_raw.png) - -It may still be possible to render the data by converting the `.geojson` file to [TopoJSON](https://github.com/mbostock/topojson), a compression format that, in some cases, can reduce filesize by up to 80%. Of course, you can always break the file into smaller chunks (such as by state or by year), and store the data as multiple files within the repository. - -## Additional Resources - -* [Leaflet.js geojson documentation](http://leafletjs.com/examples/geojson.html) -* [MapBox marker-styling documentation](http://www.mapbox.com/developers/simplestyle/) -* [TopoJSON Wiki](https://github.com/mbostock/topojson/wiki) diff --git a/content/github/managing-files-in-a-repository/working-with-non-code-files/rendering-and-diffing-images.md b/content/github/managing-files-in-a-repository/working-with-non-code-files/rendering-and-diffing-images.md deleted file mode 100644 index b50620b6c8..0000000000 --- a/content/github/managing-files-in-a-repository/working-with-non-code-files/rendering-and-diffing-images.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: Rendering and diffing images -intro: '{% data variables.product.product_name %} can display several common image formats, including PNG, JPG, GIF, PSD, and SVG. In addition to simply displaying them, there are several ways to compare differences between versions of those image formats.' -redirect_from: - - /articles/rendering-and-diffing-images - - /github/managing-files-in-a-repository/rendering-and-diffing-images -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -shortTitle: Render & diff images ---- -{% note %} - -**Note:** If you are using the Firefox browser, SVGs on {% data variables.product.prodname_dotcom %} may not render. - -{% endnote %} - -## Viewing images - -You can directly browse and view images in your {% data variables.product.product_name %} repository: - -![inline image](/assets/images/help/images/view.png) - -SVGs don't currently support inline scripting or animation. - -## Viewing differences - -You can visually compare images in three different modes: [2-up](#2-up), [swipe](#swipe), and [onion skin](#onion-skin). - -### 2-up - -**2-up** is the default mode; it gives you a quick glimpse of both images. In addition, if the image has changed size between versions, the actual dimension change is displayed. This should make it very apparent when things are resized, such as when assets are upgraded to higher resolutions. - -![2-up](/assets/images/help/repository/images-2up-view.png) - -### Swipe - -**Swipe** lets you view portions of your image side by side. Not sure if colors shifted between different versions? Drag the swipe slider over the area in question and compare the pixels for yourself. - -![Swipe](/assets/images/help/repository/images-swipe-view.png) - -### Onion skin - -**Onion Skin** really comes in handy when elements move around by small, hard to notice amounts. Did an icon shift two pixels to the left? Drag the opacity slider back a bit and notice if things move around. - -![Onion skin](/assets/images/help/repository/images-onion-view.gif) diff --git a/content/github/managing-files-in-a-repository/working-with-non-code-files/rendering-csv-and-tsv-data.md b/content/github/managing-files-in-a-repository/working-with-non-code-files/rendering-csv-and-tsv-data.md deleted file mode 100644 index 6558cd2824..0000000000 --- a/content/github/managing-files-in-a-repository/working-with-non-code-files/rendering-csv-and-tsv-data.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Rendering CSV and TSV data -redirect_from: - - /articles/rendering-csv-and-tsv-data - - /github/managing-files-in-a-repository/rendering-csv-and-tsv-data -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -shortTitle: Render CSV & TSV data ---- -GitHub supports rendering tabular data in the form of *.csv* (comma-separated) and .*tsv* (tab-separated) files. - -![Rendered CSV sample](/assets/images/help/repository/rendered_csv.png) - -When viewed, any _.csv_ or _.tsv_ file committed to a {% data variables.product.product_name %} repository automatically renders as an interactive table, complete with headers and row numbering. By default, we'll always assume the first row is your header row. - -You can link to a particular row by clicking the row number, or select multiple rows by holding down the shift key. Just copy the URL and send it to a friend. - -## Searching data - -If you want to find a certain value in your dataset, you can start typing in the search bar directly above the file. The rows will filter automatically: - -![Searching for values](/assets/images/help/repository/searching_csvs.gif) - -## Handling errors - -Occasionally, you may discover that your CSV or TSV file isn't rendering. In those instances, an error box appears at the bottom of your raw text, suggesting what the error may be. - -![CSV render error message](/assets/images/help/repository/csv_render_error.png) - -Common errors include: - -* Mismatched column counts. You must have the same number of separators in each row, even if the cell is blank -* Exceeding the file size. Our rendering only works for files up to 512KB. Anything bigger than that slows down the browser. diff --git a/content/github/managing-files-in-a-repository/working-with-non-code-files/rendering-differences-in-prose-documents.md b/content/github/managing-files-in-a-repository/working-with-non-code-files/rendering-differences-in-prose-documents.md deleted file mode 100644 index be519a9f91..0000000000 --- a/content/github/managing-files-in-a-repository/working-with-non-code-files/rendering-differences-in-prose-documents.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: Rendering differences in prose documents -redirect_from: - - /articles/rendering-differences-in-prose-documents - - /github/managing-files-in-a-repository/rendering-differences-in-prose-documents -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -shortTitle: Differences in prose ---- -Commits and pull requests that include prose documents have the ability to represent those documents with *source* and *rendered* views. - -The source view shows the raw text that has been typed, while the rendered -view shows how that text would look once it's rendered on {% data variables.product.product_name %}. For example, -this might be the difference between showing `**bold**` in Markdown, and **bold** in the rendered view. - -Prose rendering is supported for rendered documents supported by [github/markup](https://github.com/github/markup): - -* Markdown -* AsciiDoc -* Textile -* ReStructuredText -* Rdoc -* Org -* Creole -* MediaWiki -* Pod - -![Paper icon to view rendered prose document](/assets/images/help/repository/rendered_prose_diff.png) - -You can click {% octicon "file" aria-label="The paper icon" %} to see the changes made to the document as part of a commit. - -![Rendered Prose changes](/assets/images/help/repository/rendered_prose_changes.png) - -## Visualizing attribute changes - -We provide a tooltip -describing changes to attributes that, unlike words, would not otherwise be visible in the rendered document. For example, if a link URL changes from one website to -another, we'd show a tooltip like this: - -![Rendered Prose attribute changes](/assets/images/help/repository/prose_diff_attributes.png) - -## Commenting on changes - -[Commit comments](/articles/commenting-on-differences-between-files) can only -be added to files within the *source* view, on a line-by-line basis. - -## Linking to headers - -As with [other rendered prose documents](/articles/about-readmes), -hovering over a header in your document creates a link icon. You can link readers -of your rendered prose diff to specific sections. - -## Viewing complex diffs - -Some pull requests involve a large number of changes with large, complex documents. When the changes take too long to analyze, {% data variables.product.product_name %} can't always produce a rendered view of the changes. If this happens, you'll see an error message when you click the rendered button. - -![Message when view can't be rendered](/assets/images/help/repository/prose_diff_rendering.png) - -You can still use the source view to analyze and comment on changes. - -## Viewing HTML elements - -We don't directly support rendered views of commits to HTML documents. Some formats, such as Markdown, let you embed arbitrary HTML in a document. When these documents are shown on {% data variables.product.product_name %}, some of that embedded HTML can be shown in a preview, while some (like an embedded YouTube video) cannot. - -In general, rendered views of changes to a document containing embedded HTML will show changes to the elements that are supported in {% data variables.product.product_name %}'s view of the document. Changes to documents containing embedded HTML should always be reviewed in both the rendered and source views for completeness. diff --git a/content/github/managing-files-in-a-repository/working-with-non-code-files/rendering-pdf-documents.md b/content/github/managing-files-in-a-repository/working-with-non-code-files/rendering-pdf-documents.md deleted file mode 100644 index 338a1a68ad..0000000000 --- a/content/github/managing-files-in-a-repository/working-with-non-code-files/rendering-pdf-documents.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Rendering PDF documents -redirect_from: - - /articles/rendering-pdf-documents - - /github/managing-files-in-a-repository/rendering-pdf-documents -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories ---- -GitHub supports rendering of PDF documents. - -![Rendered PDF Document](/assets/images/help/repository/rendered-pdf.png) - -Currently, links within PDFs are ignored. diff --git a/content/github/managing-files-in-a-repository/working-with-non-code-files/working-with-jupyter-notebook-files-on-github.md b/content/github/managing-files-in-a-repository/working-with-non-code-files/working-with-jupyter-notebook-files-on-github.md deleted file mode 100644 index ed946a9201..0000000000 --- a/content/github/managing-files-in-a-repository/working-with-non-code-files/working-with-jupyter-notebook-files-on-github.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: Working with Jupyter Notebook files on GitHub -intro: 'When you add Jupyter Notebook or IPython Notebook files with a *.ipynb* extension on {% data variables.product.product_location %}, they will render as static HTML files in your repository.' -redirect_from: - - /articles/working-with-jupyter-notebook-files-on-github - - /github/managing-files-in-a-repository/working-with-jupyter-notebook-files-on-github -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -shortTitle: Jupyter Notebook files ---- -The interactive features of the notebook, such as custom JavaScript plots, will not work in your repository on {% data variables.product.product_location %}. For an example, see [*Linking and Interactions.ipynb*](https://github.com/bokeh/bokeh-notebooks/blob/main/tutorial/06%20-%20Linking%20and%20Interactions.ipynb). - -To view your Jupyter notebook with JavaScript content rendered or to share your notebook files with others you can use [nbviewer](https://nbviewer.jupyter.org/). For an example, see [*Linking and Interactions.ipynb*](https://nbviewer.jupyter.org/github/bokeh/bokeh-notebooks/blob/main/tutorial/06%20-%20Linking%20and%20Interactions.ipynb) rendered on nbviewer. - -To view a fully interactive version of your Jupyter Notebook, you can set up a notebook server locally. For more information, see [Jupyter's official documentation](http://jupyter.readthedocs.io/en/latest/index.html). - -## Troubleshooting - -If you're having trouble rendering Jupyter Notebook files in static HTML, you can convert the file locally on the command line by using the [`nbconvert` command](https://github.com/jupyter/nbconvert): - -```shell -$ jupyter nbconvert --to html NOTEBOOK-NAME.ipynb -``` - -## Further reading - -- [Jupyter Notebook's GitHub repository](https://github.com/jupyter/jupyter_notebook) -- [Gallery of Jupyter Notebooks](https://github.com/jupyter/jupyter/wiki/A-gallery-of-interesting-Jupyter-Notebooks) diff --git a/content/github/managing-large-files/index.md b/content/github/managing-large-files/index.md deleted file mode 100644 index d34d067182..0000000000 --- a/content/github/managing-large-files/index.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: Managing large files -intro: You can manage large files with Git Large File Storage. -redirect_from: - - /categories/managing-large-files -versions: - fpt: '*' - ghes: '*' - ghae: '*' -children: - - /working-with-large-files - - /versioning-large-files ---- - diff --git a/content/github/managing-large-files/working-with-large-files/conditions-for-large-files.md b/content/github/managing-large-files/working-with-large-files/conditions-for-large-files.md deleted file mode 100644 index 396999d4f5..0000000000 --- a/content/github/managing-large-files/working-with-large-files/conditions-for-large-files.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Conditions for large files -intro: '{% data variables.product.product_name %} limits the size of files allowed in repositories, and will block a push to a repository if the files are larger than the maximum file limit.' -redirect_from: - - /articles/conditions-for-large-files - - /github/managing-large-files/conditions-for-large-files -versions: - fpt: '*' - ghes: '*' - ghae: '*' -shortTitle: Large file conditions ---- -{% data reusables.large_files.use_lfs_tip %} - -## Warning for files larger than {% data variables.large_files.warning_size %} - -If you attempt to add or update a file that is larger than {% data variables.large_files.warning_size %}, you will receive a warning from Git. The changes will still successfully push to your repository, but you can consider removing the commit to minimize performance impact. For more information, see "[Removing files from a repository's history](/github/managing-large-files/removing-files-from-a-repositorys-history)." - -## Blocked pushes for large files - -{% ifversion ghes %}By default, {% endif %}{% data variables.product.product_name %} blocks pushes that exceed {% data variables.large_files.max_github_size %}. {% ifversion ghes %}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/working-with-large-files/distributing-large-binaries.md b/content/github/managing-large-files/working-with-large-files/distributing-large-binaries.md deleted file mode 100644 index 93774177f5..0000000000 --- a/content/github/managing-large-files/working-with-large-files/distributing-large-binaries.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Distributing large binaries -intro: 'Some projects require distributing large files, such as binaries or installers, in addition to distributing source code.' -redirect_from: - - /articles/distributing-large-binaries - - /github/managing-large-files/distributing-large-binaries -versions: - fpt: '*' - ghes: '*' - ghae: '*' -shortTitle: Distribute large binaries ---- -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)." - -{% ifversion fpt %} - -We don't limit the total size of the binary files in the release or the bandwidth used to deliver them. However, each individual file must be smaller than {% data variables.large_files.max_lfs_size %}. - -{% endif %} - -{% data reusables.large_files.use_lfs_tip %} diff --git a/content/github/managing-large-files/working-with-large-files/index.md b/content/github/managing-large-files/working-with-large-files/index.md deleted file mode 100644 index 582965cf86..0000000000 --- a/content/github/managing-large-files/working-with-large-files/index.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Working with large files -intro: 'A Git repository contains every version of every file. But for some file types, this is not practical. Multiple revisions of large files increase the clone and fetch times for other users of a repository.' -redirect_from: - - /articles/working-with-large-files -versions: - fpt: '*' - ghes: '*' - ghae: '*' -children: - - /conditions-for-large-files - - /removing-files-from-a-repositorys-history - - /distributing-large-binaries - - /what-is-my-disk-quota ---- - diff --git a/content/github/managing-large-files/working-with-large-files/removing-files-from-a-repositorys-history.md b/content/github/managing-large-files/working-with-large-files/removing-files-from-a-repositorys-history.md deleted file mode 100644 index 7e15f7b7c5..0000000000 --- a/content/github/managing-large-files/working-with-large-files/removing-files-from-a-repositorys-history.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: Removing files from a repository's history -intro: 'To remove a large file from your repository, you must completely remove it from your local repository and from {% data variables.product.product_location %}.' -redirect_from: - - /articles/removing-files-from-a-repository-s-history - - /articles/removing-files-from-a-repositorys-history - - /github/managing-large-files/removing-files-from-a-repositorys-history -versions: - fpt: '*' - ghes: '*' - ghae: '*' -shortTitle: Remove repository history ---- -{% warning %} - -**Warning**: These procedures will permanently remove files from the repository on your computer and {% data variables.product.product_location %}. If the file is important, make a local backup copy in a directory outside of the repository. - -{% endwarning %} - -## 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: - -{% data reusables.command_line.open_the_multi_os_terminal %} -{% data reusables.command_line.switching_directories_procedural %} -3. To remove the file, enter `git rm --cached`: - ```shell - $ git rm --cached giant_file - # Stage our giant file for removal, but leave it on disk - ``` -4. Commit this change using `--amend -CHEAD`: - ```shell - $ git commit --amend -CHEAD - # Amend the previous commit with your change - # Simply making a new commit won't work, as you need - # to remove the file from the unpushed history as well - ``` -5. Push your commits to {% data variables.product.product_location %}: - ```shell - $ 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/working-with-large-files/what-is-my-disk-quota.md b/content/github/managing-large-files/working-with-large-files/what-is-my-disk-quota.md deleted file mode 100644 index af7258a763..0000000000 --- a/content/github/managing-large-files/working-with-large-files/what-is-my-disk-quota.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: What is my disk quota? -redirect_from: - - /articles/what-is-the-size-limit-for-a-repository/ - - /articles/what-is-my-disk-quota - - /github/managing-large-files/what-is-my-disk-quota -intro: '{% data variables.product.product_name %} tries to provide abundant storage for all Git repositories, although there are hard limits for file and repository sizes.' -versions: - fpt: '*' ---- -{% data reusables.large_files.use_lfs_tip %} - -## File and repository size limitations - -To ensure performance and reliability for our users, we actively monitor signals of overall repository health. Repository health is a function of various interacting factors, including size, commit frequency, contents, and structure. - -We recommend repositories remain small, ideally less than 1 GB, and less than 5 GB is strongly recommended. Smaller repositories are faster to clone and easier to work with and maintain. Individual files in a repository are strictly limited to a {% data variables.large_files.max_github_size %} maximum size limit. For more information, see "[Working with large files](/github/managing-large-files/working-with-large-files)." - -If your repository excessively impacts our infrastructure, you might receive an email from {% data variables.contact.github_support %} asking you to take corrective action. We try to be flexible, especially with large projects that have many collaborators, and will work with you to find a resolution whenever possible. You can prevent your repository from impacting our infrastructure by effectively managing your repository's size and overall health. You can find advice and a tool for repository analysis in the [`github/git-sizer`](https://github.com/github/git-sizer) repository. - -{% note %} - -**Note:** If you add a file to a repository via a browser, the file can be no larger than {% data variables.large_files.max_github_browser_size %}. For more information, see "[Adding a file to a repository](/github/managing-files-in-a-repository/adding-a-file-to-a-repository)." - -{% endnote %} - -## Backups - -Git is not designed to serve as a backup tool. However, there are many solutions specifically designed for performing backups, such as [Arq](https://www.arqbackup.com/), [Carbonite](http://www.carbonite.com/), and [CrashPlan](https://www.crashplan.com/en-us/). - -## Database dumps - -Version control systems, such as Git, are not designed to handle large SQL files. To share large databases with other developers, we recommend using [Dropbox](https://www.dropbox.com/). - -Git shouldn't be used to backup your production servers. For more information, see "[Backups](/github/managing-large-files/what-is-my-disk-quota#backups)." - -## External dependencies - -External dependencies can cause Git repositories to become very large. To avoid filling a repository with external dependencies, we recommend you use a package manager. Popular package managers for common languages include [Bundler](http://bundler.io/), [Node's Package Manager](http://npmjs.org/), and [Maven](http://maven.apache.org/). These package managers support using Git repositories directly, so you don't need pre-packaged sources. - -## Packaged release versions - -We don't recommend distributing compiled code and pre-packaged releases within your repository. For more information, see "[Distributing large binaries](/github/managing-large-files/distributing-large-binaries)." - -## Changing history of an existing repository - -If you already have a repository that's quite large, you can reduce the size of a repository by removing large files from the repository's history. For more information, see "[Removing files from a repository's history](/github/managing-large-files/removing-files-from-a-repositorys-history)." diff --git a/content/github/searching-for-information-on-github/getting-started-with-searching-on-github/sorting-search-results.md b/content/github/searching-for-information-on-github/getting-started-with-searching-on-github/sorting-search-results.md index 267689b2e4..b6e2d4c2ce 100644 --- a/content/github/searching-for-information-on-github/getting-started-with-searching-on-github/sorting-search-results.md +++ b/content/github/searching-for-information-on-github/getting-started-with-searching-on-github/sorting-search-results.md @@ -69,5 +69,5 @@ The `sort:updated` qualifier sorts by how recently the items were updated. ## Further reading -- [About searching on GitHub](/articles/about-searching-on-github) -- [Sorting issues and pull requests](/articles/sorting-issues-and-pull-requests/) +- "[About searching on {% data variables.product.prodname_dotcom %}](/articles/about-searching-on-github)" +- "[Filtering and searching issues and pull requests](/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests)" diff --git a/content/github/searching-for-information-on-github/searching-on-github/searching-commits.md b/content/github/searching-for-information-on-github/searching-on-github/searching-commits.md index 96c3cbf8c8..46bc8fae9b 100644 --- a/content/github/searching-for-information-on-github/searching-on-github/searching-commits.md +++ b/content/github/searching-for-information-on-github/searching-on-github/searching-commits.md @@ -100,7 +100,7 @@ To search commits in all repositories owned by a certain user or organization, u ## Filter by repository visibility -The `is` qualifier matches commits from repositories with the specified visibility. For more information, see "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility). +The `is` qualifier matches commits from repositories with the specified visibility. For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." | Qualifier | Example | ------------- | ------------- |{% ifversion fpt or ghes %} diff --git a/content/github/searching-for-information-on-github/searching-on-github/searching-discussions.md b/content/github/searching-for-information-on-github/searching-on-github/searching-discussions.md index 92eae969d6..0e8580d970 100644 --- a/content/github/searching-for-information-on-github/searching-on-github/searching-discussions.md +++ b/content/github/searching-for-information-on-github/searching-on-github/searching-discussions.md @@ -37,7 +37,7 @@ To search discussions in all repositories owned by a certain user or organizatio ## Filter by repository visibility -You can filter by the visibility of the repository containing the discussions using the `is` qualifier. For more information, see "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility)." +You can filter by the visibility of the repository containing the discussions using the `is` qualifier. For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." | Qualifier | Example | :- | :- |{% ifversion fpt or ghes %} diff --git a/content/github/searching-for-information-on-github/searching-on-github/searching-for-repositories.md b/content/github/searching-for-information-on-github/searching-on-github/searching-for-repositories.md index e73fbb7b30..475deae14d 100644 --- a/content/github/searching-for-information-on-github/searching-on-github/searching-for-repositories.md +++ b/content/github/searching-for-information-on-github/searching-on-github/searching-for-repositories.md @@ -143,7 +143,7 @@ You can search repositories by the type of license in the repositories. You must ## Search by repository visibility -You can filter your search based on the visibility of the repositories. For more information, see "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility)." +You can filter your search based on the visibility of the repositories. For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." | Qualifier | Example | ------------- | ------------- |{% ifversion fpt or ghes %} @@ -166,7 +166,7 @@ You can search repositories based on whether the repositories are mirrors and ho ## Search based on whether a repository is archived -You can search repositories based on whether or not the repositories are archived. For more information, see "[About archiving repositories](/github/creating-cloning-and-archiving-repositories/about-archiving-repositories)." +You can search repositories based on whether or not the repositories are archived. For more information, see "[Archiving repositories](/repositories/archiving-a-github-repository/archiving-repositories)." | Qualifier | Example | ------------- | ------------- diff --git a/content/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests.md b/content/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests.md index 77f2e8acd6..5104494e41 100644 --- a/content/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests.md +++ b/content/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests.md @@ -74,7 +74,7 @@ You can filter issues and pull requests based on whether they're open or closed ## Filter by repository visibility -You can filter by the visibility of the repository containing the issues and pull requests using the `is` qualifier. For more information, see "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility)." +You can filter by the visibility of the repository containing the issues and pull requests using the `is` qualifier. For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." | Qualifier | Example | ------------- | ------------- |{% ifversion fpt or ghes %} diff --git a/content/github/visualizing-repository-data-with-graphs/accessing-basic-repository-data/index.md b/content/github/visualizing-repository-data-with-graphs/accessing-basic-repository-data/index.md deleted file mode 100644 index 8ffa36311c..0000000000 --- a/content/github/visualizing-repository-data-with-graphs/accessing-basic-repository-data/index.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Accessing basic repository data -intro: 'You can view basic information about a repository, such as the repository''s activity{% ifversion fpt %}, traffic,{% endif %} and contribution activity.' -redirect_from: - - /articles/accessing-basic-repository-data -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -children: - - /about-repository-graphs - - /viewing-a-summary-of-repository-activity - - /viewing-a-projects-contributors - - /viewing-traffic-to-a-repository -shortTitle: Access basic repository data ---- - diff --git a/content/github/visualizing-repository-data-with-graphs/analyzing-changes-to-a-repositorys-content/index.md b/content/github/visualizing-repository-data-with-graphs/analyzing-changes-to-a-repositorys-content/index.md deleted file mode 100644 index f9a8d0f1fd..0000000000 --- a/content/github/visualizing-repository-data-with-graphs/analyzing-changes-to-a-repositorys-content/index.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Analyzing changes to a repository's content -intro: 'You can see the changes to the content of a repository by analyzing the repository''s commits, commit frequency, and content additions and deletions.' -redirect_from: - - /articles/viewing-commit-frequency-in-a-repository/ - - /articles/analyzing-changes-to-a-repository-s-content - - /articles/analyzing-changes-to-a-repositorys-content -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -children: - - /visualizing-commits-in-a-repository - - /visualizing-additions-and-deletions-to-content-in-a-repository -shortTitle: Analyze changes to repository ---- - diff --git a/content/github/visualizing-repository-data-with-graphs/analyzing-changes-to-a-repositorys-content/visualizing-additions-and-deletions-to-content-in-a-repository.md b/content/github/visualizing-repository-data-with-graphs/analyzing-changes-to-a-repositorys-content/visualizing-additions-and-deletions-to-content-in-a-repository.md deleted file mode 100644 index 9d262527a2..0000000000 --- a/content/github/visualizing-repository-data-with-graphs/analyzing-changes-to-a-repositorys-content/visualizing-additions-and-deletions-to-content-in-a-repository.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: Visualizing additions and deletions to content in a repository -intro: The code frequency graph displays the content additions and deletions for each week in a repository's history. -product: '{% data reusables.gated-features.repository-insights %}' -redirect_from: - - /articles/visualizing-additions-and-deletions-to-content-in-a-repository - - /github/visualizing-repository-data-with-graphs/visualizing-additions-and-deletions-to-content-in-a-repository -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -shortTitle: View changes to content ---- -{% ifversion fpt %} - -![Code frequency graph](/assets/images/help/graphs/repo_code_frequency_graph_dotcom.png) - -{% endif %} - -## Accessing the code frequency graph - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.accessing-repository-graphs %} -3. In the left sidebar, click **Code frequency**. -![Code frequency tab](/assets/images/help/graphs/code_frequency_tab.png) diff --git a/content/github/visualizing-repository-data-with-graphs/analyzing-changes-to-a-repositorys-content/visualizing-commits-in-a-repository.md b/content/github/visualizing-repository-data-with-graphs/analyzing-changes-to-a-repositorys-content/visualizing-commits-in-a-repository.md deleted file mode 100644 index 301e26849d..0000000000 --- a/content/github/visualizing-repository-data-with-graphs/analyzing-changes-to-a-repositorys-content/visualizing-commits-in-a-repository.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Visualizing commits in a repository -intro: You can see all commits made to a repository in the past year (excluding merge commits) in the Commit graph. -product: '{% data reusables.gated-features.repository-insights %}' -redirect_from: - - /articles/visualizing-commits-in-a-repository - - /github/visualizing-repository-data-with-graphs/visualizing-commits-in-a-repository -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -shortTitle: View commits in repository ---- -The top graph shows commits for the entire year by week. - -![Repository commit year graph](/assets/images/help/graphs/repo_commit_activity_year_graph.png) - -The bottom graph shows the average number of commits by day of the week for the selected week. - -![Repository commit week graph](/assets/images/help/graphs/repo_commit_activity_week_graph.png) - -## Accessing the commits graph - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.accessing-repository-graphs %} -3. In the left sidebar, click **Commits**. -![Commits tab](/assets/images/help/graphs/commits_tab.png) diff --git a/content/github/visualizing-repository-data-with-graphs/index.md b/content/github/visualizing-repository-data-with-graphs/index.md deleted file mode 100644 index a0e7cbc7d1..0000000000 --- a/content/github/visualizing-repository-data-with-graphs/index.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Visualizing repository data with graphs -intro: You can use a variety of graphs to gain a better understanding of your repositories. -redirect_from: - - /categories/44/articles/ - - /categories/graphs-and-contributions/ - - /categories/graphs/ - - /categories/visualizing-repository-data-with-graphs -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -children: - - /accessing-basic-repository-data - - /analyzing-changes-to-a-repositorys-content - - /understanding-connections-between-repositories -shortTitle: View repository graphs ---- - diff --git a/content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/index.md b/content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/index.md deleted file mode 100644 index 02ee01bbde..0000000000 --- a/content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/index.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Understanding connections between repositories -intro: 'You can better understand the connections that exist between repositories by viewing a repository''s network{% ifversion fpt %}, projects that depend on the repository,{% endif %} and its forks.' -redirect_from: - - /articles/understanding-connections-between-repositories -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -children: - - /viewing-a-repositorys-network - - /listing-the-forks-of-a-repository - - /viewing-the-dependencies-of-a-repository - - /about-the-dependency-graph - - /exploring-the-dependencies-of-a-repository -shortTitle: Connections between repos ---- - diff --git a/content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/listing-the-forks-of-a-repository.md b/content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/listing-the-forks-of-a-repository.md deleted file mode 100644 index 58f7f742a6..0000000000 --- a/content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/listing-the-forks-of-a-repository.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: Listing the forks of a repository -intro: The Members graph displays all the forks of a repository. -redirect_from: - - /articles/listing-the-forks-of-a-repository - - /github/visualizing-repository-data-with-graphs/listing-the-forks-of-a-repository -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -shortTitle: List repository forks ---- -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. - -{% ifversion fpt %} - -![Repository members graph](/assets/images/help/graphs/repo_forks_graph_dotcom.png) - -{% else %} - -![Repository members graph](/assets/images/help/graphs/repo_members_graph.png) - -{% endif %} - -## Accessing the Members graph - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.accessing-repository-graphs %} -3. In the left sidebar, click **Forks**. -![Forks tab](/assets/images/help/graphs/graphs-sidebar-forks-tab.png) diff --git a/content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/viewing-a-repositorys-network.md b/content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/viewing-a-repositorys-network.md deleted file mode 100644 index 38aa295acc..0000000000 --- a/content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/viewing-a-repositorys-network.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Viewing a repository's network -intro: 'The network graph displays the branch history of the entire repository network, including branches of the root repository and branches of forks that contain commits unique to the network.' -product: '{% data reusables.gated-features.repository-insights %}' -redirect_from: - - /articles/viewing-a-repository-s-network - - /articles/viewing-a-repositorys-network - - /github/visualizing-repository-data-with-graphs/viewing-a-repositorys-network -versions: - fpt: '*' - ghes: '*' - ghae: '*' -topics: - - Repositories -shortTitle: View repository network ---- -![Repository network graph](/assets/images/help/graphs/repo_network_graph.png) - -{% tip %} - -**Tip:** To see older branches, click and drag within the graph. - -{% endtip %} - -## Accessing the network graph - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.accessing-repository-graphs %} -3. In the left sidebar, click **Network**. -![Network tab](/assets/images/help/graphs/network_tab.png) diff --git a/content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/viewing-the-dependencies-of-a-repository.md b/content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/viewing-the-dependencies-of-a-repository.md deleted file mode 100644 index 4624fd890c..0000000000 --- a/content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/viewing-the-dependencies-of-a-repository.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Viewing the dependencies of a repository -intro: You can use the dependency graph to explore the code your repository depends on. -versions: - fpt: '*' - ghes: '>=3.0' -redirect_from: - - /github/visualizing-repository-data-with-graphs/viewing-the-dependencies-of-a-repository -shortTitle: View dependencies ---- -Almost all software relies on code developed and maintained by other developers, often known as a supply chain. For example, utilities, libraries, and frameworks. These dependencies are an integral part of your code and any bugs or vulnerabilities in them may affect your code. It's important to review and maintain these dependencies. - -The dependency graph provides a great way to visualize and explore the dependencies for a repository. For more information, see "[About the dependency graph](/code-security/supply-chain-security/about-the-dependency-graph)" and "[Exploring the dependencies of a repository](/code-security/supply-chain-security/exploring-the-dependencies-of-a-repository)." - -You can also set up your repository so that {% data variables.product.company_short %} alerts you automatically whenever a security vulnerability is found in one of your dependencies. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." diff --git a/content/github/writing-on-github/editing-and-sharing-content-with-gists/creating-gists.md b/content/github/writing-on-github/editing-and-sharing-content-with-gists/creating-gists.md index dd07de9cb9..12f263d29c 100644 --- a/content/github/writing-on-github/editing-and-sharing-content-with-gists/creating-gists.md +++ b/content/github/writing-on-github/editing-and-sharing-content-with-gists/creating-gists.md @@ -49,7 +49,7 @@ You can download a ZIP file of a gist by clicking the **Download ZIP** button at {% ifversion fpt %} -Gist supports mapping GeoJSON files. These maps are displayed in embedded gists, so you can easily share and embed maps. For more information, see "[Mapping GeoJSON files on {% data variables.product.product_name %}](/articles/mapping-geojson-files-on-github)." +Gist supports mapping GeoJSON files. These maps are displayed in embedded gists, so you can easily share and embed maps. For more information, see "[Working with non-code files](/repositories/working-with-files/using-files/working-with-non-code-files#mapping-geojson-files-on-github)." {% endif %} diff --git a/content/index.md b/content/index.md index b9fbae52a9..53e57e2b80 100644 --- a/content/index.md +++ b/content/index.md @@ -4,7 +4,7 @@ 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 + - /repositories/creating-and-managing-repositories - /github/writing-on-github/basic-writing-and-formatting-syntax popular: - /github/collaborating-with-issues-and-pull-requests/about-pull-requests @@ -16,6 +16,7 @@ versions: '*' children: - get-started - account-and-profile + - repositories - github - admin - billing diff --git a/content/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests.md b/content/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests.md new file mode 100644 index 0000000000..c4ba4fb634 --- /dev/null +++ b/content/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests.md @@ -0,0 +1,233 @@ +--- +title: Filtering and searching issues and pull requests +intro: 'To find detailed information about a repository on {% data variables.product.product_name %}, you can filter, sort, and search issues and pull requests that are relevant to the repository.' +redirect_from: + - /github/managing-your-work-on-github/finding-information-in-a-repository/filtering-issues-and-pull-requests-by-assignees + - /articles/filtering-issues-and-pull-requests-by-assignees + - /github/managing-your-work-on-github/filtering-issues-and-pull-requests-by-assignees + - /github/managing-your-work-on-github/finding-information-in-a-repository/filtering-issues-and-pull-requests-by-labels + - /articles/filtering-issues-and-pull-requests-by-labels + - /github/managing-your-work-on-github/filtering-issues-and-pull-requests-by-labels + - /github/managing-your-work-on-github/finding-information-in-a-repository/filtering-issues-and-pull-requests + - /articles/filtering-issues-and-pull-requests + - /github/managing-your-work-on-github/filtering-issues-and-pull-requests + - /github/managing-your-work-on-github/finding-information-in-a-repository/filtering-pull-requests-by-review-status + - /articles/filtering-pull-requests-by-review-status + - /github/managing-your-work-on-github/filtering-pull-requests-by-review-status + - /github/managing-your-work-on-github/finding-information-in-a-repository + - /articles/finding-information-in-a-repository + - /github/managing-your-work-on-github/finding-information-in-a-repository/sharing-filters + - /articles/sharing-filters + - /github/managing-your-work-on-github/sharing-filters + - /github/managing-your-work-on-github/finding-information-in-a-repository/using-search-to-filter-issues-and-pull-requests + - /articles/using-search-to-filter-issues-and-pull-requests + - /github/managing-your-work-on-github/using-search-to-filter-issues-and-pull-requests + - /github/managing-your-work-on-github/finding-information-in-a-repository/sorting-issues-and-pull-requests + - /articles/sorting-issues-and-pull-requests + - /github/managing-your-work-on-github/sorting-issues-and-pull-requests + - /github/administering-a-repository/finding-information-in-a-repository + - /github/administering-a-repository/finding-information-in-a-repository/filtering-issues-and-pull-requests + - /github/administering-a-repository/finding-information-in-a-repository/filtering-issues-and-pull-requests-by-assignees + - /github/administering-a-repository/finding-information-in-a-repository/filtering-issues-and-pull-requests-by-labels + - /github/administering-a-repository/finding-information-in-a-repository/filtering-pull-requests-by-review-status + - /github/administering-a-repository/finding-information-in-a-repository/sorting-issues-and-pull-requests + - /github/administering-a-repository/finding-information-in-a-repository/using-search-to-filter-issues-and-pull-requests + - /github/administering-a-repository/finding-information-in-a-repository/sharing-filters +versions: + fpt: '*' + ghes: '*' + ghae: '*' +topics: + - Issues + - Pull requests +shortTitle: Filter and search +--- + +{% data reusables.cli.filter-issues-and-pull-requests-tip %} + +## Filtering issues and pull requests + +Issues and pull requests come with a set of default filters you can apply to organize your listings. + +{% data reusables.search.requested_reviews_search %} + +You can filter issues and pull requests to find: +- All open issues and pull requests +- Issues and pull requests that you've created +- Issues and pull requests that are assigned to you +- Issues and pull requests where you're [**@mentioned**](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams) + +{% data reusables.cli.filter-issues-and-pull-requests-tip %} + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-issue-pr %} +3. Click **Filters** to choose the type of filter you're interested in. + ![Using the Filters drop-down](/assets/images/help/issues/issues_filter_dropdown.png) + +## Filtering issues and pull requests by assignees + +Once you've [assigned an issue or pull request to someone](/articles/assigning-issues-and-pull-requests-to-other-github-users), you can find items based on who's working on them. + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-issue-pr %} +3. In the upper-right corner, select the Assignee drop-down menu. +4. The Assignee drop-down menu lists everyone who has write access to your repository. Click the name of the person whose assigned items you want to see, or click **Assigned to nobody** to see which issues are unassigned. +![Using the Assignees drop-down tab](/assets/images/help/issues/issues_assignee_dropdown.png) + +{% tip %} + +To clear your filter selection, click **Clear current search query, filters, and sorts**. + +{% endtip %} + +## Filtering issues and pull requests by labels + +Once you've [applied labels to an issue or pull request](/articles/applying-labels-to-issues-and-pull-requests), you can find items based on their labels. + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-issue-pr %} +{% data reusables.project-management.labels %} +4. In the list of labels, click a label to see the issues and pull requests that it's been applied to. + ![List of a repository's labels](/assets/images/help/issues/labels-page.png) + +{% tip %} + +**Tip:** To clear your filter selection, click **Clear current search query, filters, and sorts**. + +{% endtip %} + +## Filtering pull requests by review status + +You can use filters to list pull requests by review status and to find pull requests that you've reviewed or other people have asked you to review. + +You can filter a repository's list of pull requests to find: +- Pull requests that haven't been [reviewed](/articles/about-pull-request-reviews) yet +- Pull requests that [require a review](/github/administering-a-repository/about-protected-branches#require-pull-request-reviews-before-merging) before they can be merged +- Pull requests that a reviewer has approved +- Pull requests in which a reviewer has asked for changes +- Pull requests that you have reviewed +- Pull requests that [someone has asked you, or a team you're a member of, to review](/articles/requesting-a-pull-request-review) + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-pr %} +3. In the upper-right corner, select the Reviews drop-down menu. + ![Reviews drop-down menu in the filter menu above the list of pull requests](/assets/images/help/pull_requests/reviews-filter-dropdown.png) +4. Choose a filter to find all of the pull requests with that filter's status. + ![List of filters in the Reviews drop-down menu](/assets/images/help/pull_requests/pr-review-filters.png) + +## Using search to filter issues and pull requests + +You can use advanced filters to search for issues and pull requests that meet specific criteria. + +### Searching for issues and pull requests + +{% include tool-switcher %} + +{% webui %} + +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). + +![The issues and pull requests search bar](/assets/images/help/issues/issues_search_bar.png) + +{% tip %} + +**Tip:** {% data reusables.search.search_issues_and_pull_requests_shortcut %} + +{% endtip %} + +{% endwebui %} + +{% cli %} + +{% data reusables.cli.cli-learn-more %} + +You can use the {% data variables.product.prodname_cli %} to search for issues or pull requests. Use the `gh issue list` or `gh pr list` subcommand along with the `--search` argument and a search query. + +For example, you can list, in order of date created, all issues that have no assignee and that have the label `help wanted` or `bug`. + +```shell +gh issue list --search 'no:assignee label:"help wanted",bug sort:created-asc' +``` + +You can also list all pull requests that mention the `octo-org/octo-team` team. + +```shell +gh pr list --search "team:octo-org/octo-team" +``` + +{% endcli %} + +### About search terms + +With issue and pull request search terms, you can: + +- Filter issues and pull requests by author: `state:open type:issue author:octocat` +- Filter issues and pull requests that involve, but don't necessarily [**@mention**](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams), certain people: `state:open type:issue involves:octocat` +- 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"` +- Filter out search terms by using `-` before the term: `state:open type:issue -author:octocat` + +{% ifversion fpt or ghes > 3.2 or ghae-next %} +{% tip %} + +**Tip:** You can filter issues and pull requests by label using logical OR or using logical AND. +- To filter issues using logical OR, use the comma syntax: `label:"bug","wip"`. +- To filter issues using logical AND, use separate label filters: `label:"bug" label:"wip"`. + +{% endtip %} +{% endif %} + +{% ifversion fpt or ghes or ghae %} +For issues, you can also use search to: + +- Filter for issues that are linked to a pull request by a closing reference: `linked:pr` +{% endif %} + +For pull requests, you can also use search to: +- Filter [draft](/articles/about-pull-requests#draft-pull-requests) pull requests: `is:draft` +- Filter pull requests that haven't been [reviewed](/articles/about-pull-request-reviews) yet: `state:open type:pr review:none` +- Filter pull requests that [require a review](/github/administering-a-repository/about-protected-branches#require-pull-request-reviews-before-merging) before they can be merged: `state:open type:pr review:required` +- Filter pull requests that a reviewer has approved: `state:open type:pr review:approved` +- 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`{% ifversion fpt or ghes or ghae %} +- Filter for pull requests that are linked to an issue that the pull request may close: `linked:issue`{% endif %} + +## Sorting issues and pull requests + +Filters can be sorted to provide better information during a specific time period. + +You can sort any filtered view by: + +* The newest created issues or pull requests +* The oldest created issues or pull requests +* The most commented issues or pull requests +* The least commented issues or pull requests +* The newest updated issues or pull requests +* The oldest updated issues or pull requests +* The most added reaction on issues or pull requests + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-issue-pr %} +1. In the upper-right corner, select the Sort drop-down menu. + ![Using the Sort drop-down tab](/assets/images/help/issues/issues_sort_dropdown.png) + +To clear your sort selection, click **Sort** > **Newest**. + + +## Sharing filters + +When you filter or sort issues and pull requests, your browser's URL is automatically updated to match the new view. + +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. + +For example, if you filter on issues assigned to Hubot, and sort on the oldest open issues, your URL would update to something like the following: + +``` +/issues?q=state:open+type:issue+assignee:hubot+sort:created-asc +``` + +## Further reading + +- "[Searching issues and pull requests](/articles/searching-issues)"" diff --git a/content/issues/tracking-your-work-with-issues/index.md b/content/issues/tracking-your-work-with-issues/index.md index c42359a616..c8f3b877b3 100644 --- a/content/issues/tracking-your-work-with-issues/index.md +++ b/content/issues/tracking-your-work-with-issues/index.md @@ -16,6 +16,7 @@ children: - /linking-a-pull-request-to-an-issue - /assigning-issues-and-pull-requests-to-other-github-users - /viewing-all-of-your-issues-and-pull-requests + - /filtering-and-searching-issues-and-pull-requests - /marking-issues-or-pull-requests-as-a-duplicate - /pinning-an-issue-to-your-repository - /transferring-an-issue-to-another-repository diff --git a/content/issues/tracking-your-work-with-issues/planning-and-tracking-work-for-your-team-or-project.md b/content/issues/tracking-your-work-with-issues/planning-and-tracking-work-for-your-team-or-project.md index 32a218e350..c111ea0f00 100644 --- a/content/issues/tracking-your-work-with-issues/planning-and-tracking-work-for-your-team-or-project.md +++ b/content/issues/tracking-your-work-with-issues/planning-and-tracking-work-for-your-team-or-project.md @@ -79,7 +79,7 @@ You can create labels for a repository to categorize issues, pull requests, and For more information, see "[Creating a label](/issues/using-labels-and-milestones-to-track-work/managing-labels#creating-a-label)." -Once you have created a label in a repository, you can apply it on any issue, pull request or discussion in the repository. You can then filter issues and pull requests by label to find all associated work. For example, find all the front end bugs in your project by filtering for issues with the `front-end` and `bug` labels. For more information, see "[Filtering issues and pull requests by labels](/github/administering-a-repository/finding-information-in-a-repository/filtering-issues-and-pull-requests-by-labels)." +Once you have created a label in a repository, you can apply it on any issue, pull request or discussion in the repository. You can then filter issues and pull requests by label to find all associated work. For example, find all the front end bugs in your project by filtering for issues with the `front-end` and `bug` labels. For more information, see "[Filtering and searching issues and pull requests](/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests)." ### Label example Below is an example of a `front-end` label that we created and added to the issue. diff --git a/content/issues/using-labels-and-milestones-to-track-work/filtering-issues-and-pull-requests-by-milestone.md b/content/issues/using-labels-and-milestones-to-track-work/filtering-issues-and-pull-requests-by-milestone.md index 09c885ce70..9bbabbc723 100644 --- a/content/issues/using-labels-and-milestones-to-track-work/filtering-issues-and-pull-requests-by-milestone.md +++ b/content/issues/using-labels-and-milestones-to-track-work/filtering-issues-and-pull-requests-by-milestone.md @@ -31,8 +31,5 @@ shortTitle: Filter by milestone ## Further reading -- "[Filtering issues and pull requests](/articles/filtering-issues-and-pull-requests)" -- "[Sorting issues and pull requests](/articles/sorting-issues-and-pull-requests)" -- "[Using search to filter issues and pull requests](/articles/using-search-to-filter-issues-and-pull-requests)" -- "[Sharing filters](/articles/sharing-filters)" +- "[Filtering and searching issues and pull requests](/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests)" - "[Filtering cards on a project board](/articles/filtering-cards-on-a-project-board)" diff --git a/content/issues/using-labels-and-milestones-to-track-work/managing-labels.md b/content/issues/using-labels-and-milestones-to-track-work/managing-labels.md index 14c007907c..fb39d840bf 100644 --- a/content/issues/using-labels-and-milestones-to-track-work/managing-labels.md +++ b/content/issues/using-labels-and-milestones-to-track-work/managing-labels.md @@ -94,6 +94,6 @@ Deleting a label will remove the label from issues and pull requests. {% data reusables.project-management.delete-label %} ## Further reading -- "[Filtering issues and pull requests by labels](/articles/filtering-issues-and-pull-requests-by-labels)"{% ifversion fpt or ghes %} +- "[Filtering and searching issues and pull requests](/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests)"{% ifversion fpt or ghes %} - "[Managing default labels for repositories in your organization](/articles/managing-default-labels-for-repositories-in-your-organization)"{% endif %}{% ifversion fpt %} - "[Encouraging helpful contributions to your project with labels](/communities/setting-up-your-project-for-healthy-contributions/encouraging-helpful-contributions-to-your-project-with-labels)"{% endif %} diff --git a/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md b/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md index f1f628511c..dc490fdbb9 100644 --- a/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md +++ b/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md @@ -587,9 +587,9 @@ For more information, see "[Managing the publication of {% data variables.produc | `self_hosted_runner_online` | Triggered when the runner application is started. Can only be viewed using the REST API; not visible in the UI or JSON/CSV export. For more information, see "[Checking the status of a self-hosted runner](/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners#checking-the-status-of-a-self-hosted-runner)." | `self_hosted_runner_offline` | Triggered when the runner application is stopped. Can only be viewed using the REST API; not visible in the UI or JSON/CSV export. For more information, see "[Checking the status of a self-hosted runner](/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners#checking-the-status-of-a-self-hosted-runner)."{% endif %}{% ifversion fpt or ghes %} | `self_hosted_runner_updated` | Triggered when the runner application is updated. Can be viewed using the REST API and the UI; not visible in the JSON/CSV export. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#about-self-hosted-runners)."{% endif %}{% ifversion fpt %} -| `set_actions_fork_pr_approvals_policy` | Triggered when the setting for requiring approvals for workflows from public forks is changed. For more information, see "[Requiring approval for workflows from public forks](/github/administering-a-repository/managing-repository-settings/disabling-or-limiting-github-actions-for-a-repository#requiring-approval-for-workflows-from-public-forks)."{% endif %}{% ifversion fpt or ghes > 2.22 or ghae %} -| `set_actions_retention_limit` | Triggered when the retention period for {% data variables.product.prodname_actions %} artifacts and logs is changed. For more information, see "[Configuring the retention period for {% data variables.product.prodname_actions %} artifacts and logs in your repository](/github/administering-a-repository/managing-repository-settings/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository)."{% endif %}{% ifversion fpt or ghes > 2.22 %} -| `set_fork_pr_workflows_policy` | Triggered when the policy for workflows on private repository forks is changed. For more information, see "[Enabling workflows for private repository forks](/github/administering-a-repository/managing-repository-settings/disabling-or-limiting-github-actions-for-a-repository#enabling-workflows-for-private-repository-forks)."{% endif %} +| `set_actions_fork_pr_approvals_policy` | Triggered when the setting for requiring approvals for workflows from public forks is changed. For more information, see "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-required-approval-for-workflows-from-public-forks)."{% endif %}{% ifversion fpt or ghes > 2.22 or ghae %} +| `set_actions_retention_limit` | Triggered when the retention period for {% data variables.product.prodname_actions %} artifacts and logs is changed. For more information, see "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository)."{% endif %}{% ifversion fpt or ghes > 2.22 %} +| `set_fork_pr_workflows_policy` | Triggered when the policy for workflows on private repository forks is changed. For more information, see "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#enabling-workflows-for-private-repository-forks)."{% endif %} | `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.{% ifversion fpt or ghes %} diff --git a/content/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization.md b/content/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization.md index 5a6a4890a1..41580aa8ea 100644 --- a/content/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization.md +++ b/content/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization.md @@ -23,6 +23,7 @@ Only organization owners can remove members from an organization. **Warning:** When you remove members from an organization: - The paid license count does not automatically downgrade. To pay for fewer licenses after removing users from your organization, follow the steps in "[Downgrading your organization's paid seats](/articles/downgrading-your-organization-s-paid-seats)." - Removed members will lose access to private forks of your organization's private repositories, but they may still have local copies. However, they cannot sync local copies with your organization's repositories. Their private forks can be restored if the user is [reinstated as an organization member](/articles/reinstating-a-former-member-of-your-organization) within three months of being removed from the organization. Ultimately, you are responsible for ensuring that people who have lost access to a repository delete any confidential information or intellectual property. +- If your organization is owned by an enterprise account, removed members will also lose access to private forks of your organization's internal repositories, if the removed member is not a member of any other organization owned by the same enterprise account. For more information, see "[About enterprise accounts](/github/setting-up-and-managing-your-enterprise/managing-your-enterprise-account/about-enterprise-accounts)." - Any organization invitations sent by a removed member, that have not been accepted, are cancelled and will not be accessible. {% endwarning %} @@ -33,6 +34,7 @@ Only organization owners can remove members from an organization. **Warning:** When you remove members from an organization: - Removed members will lose access to private forks of your organization's private repositories, but may still have local copies. However, they cannot sync local copies with your organization's repositories. Their private forks can be restored if the user is [reinstated as an organization member](/articles/reinstating-a-former-member-of-your-organization) within three months of being removed from the organization. Ultimately, you are responsible for ensuring that people who have lost access to a repository delete any confidential information or intellectual property. +- Removed members will also lose access to private forks of your organization's internal repositories, if the removed member is not a member of any other organization in your enterprise. - Any organization invitations sent by the removed user, that have not been accepted, are cancelled and will not be accessible. {% endwarning %} diff --git a/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md b/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md index 83e5cd894d..10b9fe29ef 100644 --- a/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md +++ b/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md @@ -14,7 +14,7 @@ topics: shortTitle: Restrict repository creation --- -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.{% ifversion fpt %} 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)." +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.{% ifversion fpt %} To allow members to create private repositories only, your organization must use {% data variables.product.prodname_ghe_cloud %}.{% endif %} For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." Organization owners can always create any type of repository. diff --git a/content/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization.md b/content/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization.md index df4f7ddd42..f694ec10bf 100644 --- a/content/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization.md +++ b/content/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization.md @@ -32,4 +32,4 @@ You can restrict the ability to change repository visibility to organization own ## Further reading -- "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility)" +- "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)" diff --git a/content/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on.md b/content/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on.md index 330f913e71..05c49faf04 100644 --- a/content/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on.md +++ b/content/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on.md @@ -35,7 +35,7 @@ To access the organization's protected resources using the API and Git on the co 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](/organizations/granting-access-to-your-organization-with-saml-single-sign-on/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)." +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 repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." Organization members must also have an active SAML session to authorize an {% data variables.product.prodname_oauth_app %}. You can opt out of this requirement by contacting {% data variables.contact.contact_support %}. {% data variables.product.product_name %} does not recommend opting out of this requirement, which will expose your organization to a higher risk of account takeovers and potential data loss. diff --git a/content/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md b/content/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md index 5aefe71a70..cc70e384bf 100644 --- a/content/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md +++ b/content/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md @@ -41,7 +41,7 @@ If you manually added a Jekyll theme to your repository in the past, those files 5. You may be prompted to edit your site's *README.md* file. - To edit the file later, click **Cancel**. ![Cancel link when editing a file](/assets/images/help/pages/cancel-edit.png) - - To edit the file now, see "[Editing files in your repository](/articles/editing-files-in-your-repository/)." + - To edit the file now, see "[Editing files](/repositories/working-with-files/managing-files/editing-files)." Your chosen theme will automatically apply to markdown files in your repository. To apply your theme to HTML files in your repository, you need to add YAML front matter that specifies a layout to each file. For more information, see "[Front Matter](https://jekyllrb.com/docs/front-matter/)" on the Jekyll site. diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md index ff8b1ad00c..e4b10d85be 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md @@ -157,7 +157,7 @@ This errors means that you have relative permalinks, which are not supported by Permalinks are permanent URLs that reference a particular page on your site. Absolute permalinks begin with the root of the site, while relative permalinks begin with the folder containing the referenced page. {% data variables.product.prodname_pages %} and Jekyll no longer support relative permalinks. For more information about permalinks, see "[Permalinks](https://jekyllrb.com/docs/permalinks/)" in the Jekyll documentation. -To troubleshoot, remove the `relative_permalinks` line from your *_config.yml* file and reformat any relative permalinks in your site with absolute permalinks. For more information, see "[Editing files in your repository](/articles/editing-files-in-your-repository)." +To troubleshoot, remove the `relative_permalinks` line from your *_config.yml* file and reformat any relative permalinks in your site with absolute permalinks. For more information, see "[Editing files](/repositories/working-with-files/managing-files/editing-files)." ## Symlink does not exist within your site's repository diff --git a/content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/about-archiving-content-and-data-on-github.md b/content/repositories/archiving-a-github-repository/about-archiving-content-and-data-on-github.md similarity index 95% rename from content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/about-archiving-content-and-data-on-github.md rename to content/repositories/archiving-a-github-repository/about-archiving-content-and-data-on-github.md index 24aa8ffeb3..288a4f81a0 100644 --- a/content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/about-archiving-content-and-data-on-github.md +++ b/content/repositories/archiving-a-github-repository/about-archiving-content-and-data-on-github.md @@ -4,6 +4,7 @@ intro: 'You can archive content and data on {% data variables.product.product_na redirect_from: - /articles/about-archiving-content-and-data-on-github - /github/creating-cloning-and-archiving-repositories/about-archiving-content-and-data-on-github + - /github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/about-archiving-content-and-data-on-github versions: fpt: '*' topics: diff --git a/content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/about-archiving-repositories.md b/content/repositories/archiving-a-github-repository/archiving-repositories.md similarity index 55% rename from content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/about-archiving-repositories.md rename to content/repositories/archiving-a-github-repository/archiving-repositories.md index aba8a2c047..4e35b266c3 100644 --- a/content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/about-archiving-repositories.md +++ b/content/repositories/archiving-a-github-repository/archiving-repositories.md @@ -1,17 +1,23 @@ --- -title: About archiving repositories -intro: 'When you archive a repository, you are letting people know that a project is no longer actively maintained.' +title: Archiving repositories +intro: You can archive a repository to make it read-only for all users and indicate that it's no longer actively maintained. You can also unarchive repositories that have been archived. redirect_from: + - /articles/archiving-repositories + - /github/creating-cloning-and-archiving-repositories/archiving-repositories - /articles/about-archiving-repositories - /github/creating-cloning-and-archiving-repositories/about-archiving-repositories + - /github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/about-archiving-repositories + - /github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/archiving-repositories versions: fpt: '*' ghes: '*' ghae: '*' topics: - Repositories -shortTitle: Repositories --- + +## About repository archival + {% ifversion fpt %} {% note %} @@ -28,5 +34,15 @@ When a repository is archived, its issues, pull requests, code, labels, mileston You can search for archived repositories. For more information, see "[Searching for repositories](/articles/searching-for-repositories/#search-based-on-whether-a-repository-is-archived)." You can also search for issues and pull requests within archived repositories. For more information, see "[Searching issues and pull requests](/articles/searching-issues-and-pull-requests/#search-based-on-whether-a-repository-is-archived)." -## Further reading -- "[Archiving repositories](/articles/archiving-repositories)" +## Archiving a repository + +{% data reusables.repositories.archiving-repositories-recommendation %} + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-settings %} +3. Under "Danger Zone", click **Archive this repository** or **Unarchive this repository**. + ![Archive this repository button](/assets/images/help/repository/archive-repository.png) +4. Read the warnings. +5. Type the name of the repository you want to archive or unarchive. + ![Archive repository warnings](/assets/images/help/repository/archive-repository-warnings.png) +6. Click **I understand the consequences, archive this repository**. \ No newline at end of file diff --git a/content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/backing-up-a-repository.md b/content/repositories/archiving-a-github-repository/backing-up-a-repository.md similarity index 96% rename from content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/backing-up-a-repository.md rename to content/repositories/archiving-a-github-repository/backing-up-a-repository.md index 8621fbe109..8346b22105 100644 --- a/content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/backing-up-a-repository.md +++ b/content/repositories/archiving-a-github-repository/backing-up-a-repository.md @@ -4,6 +4,7 @@ intro: 'You can use{% ifversion ghes or ghae %} Git and{% endif %} the API {% if redirect_from: - /articles/backing-up-a-repository - /github/creating-cloning-and-archiving-repositories/backing-up-a-repository + - /github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/backing-up-a-repository versions: fpt: '*' ghes: '*' diff --git a/content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/index.md b/content/repositories/archiving-a-github-repository/index.md similarity index 87% rename from content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/index.md rename to content/repositories/archiving-a-github-repository/index.md index 86018534e0..0731ab1aab 100644 --- a/content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/index.md +++ b/content/repositories/archiving-a-github-repository/index.md @@ -5,6 +5,7 @@ redirect_from: - /articles/can-i-archive-a-repository/ - /articles/archiving-a-github-repository - /enterprise/admin/user-management/archiving-and-unarchiving-repositories + - /github/creating-cloning-and-archiving-repositories/archiving-a-github-repository versions: fpt: '*' ghes: '*' @@ -12,7 +13,6 @@ versions: topics: - Repositories children: - - /about-archiving-repositories - /archiving-repositories - /about-archiving-content-and-data-on-github - /referencing-and-citing-content diff --git a/content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/referencing-and-citing-content.md b/content/repositories/archiving-a-github-repository/referencing-and-citing-content.md similarity index 95% rename from content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/referencing-and-citing-content.md rename to content/repositories/archiving-a-github-repository/referencing-and-citing-content.md index 67489b43e6..3a45d2a74a 100644 --- a/content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/referencing-and-citing-content.md +++ b/content/repositories/archiving-a-github-repository/referencing-and-citing-content.md @@ -4,6 +4,7 @@ intro: You can use third-party tools to cite and reference content on GitHub. redirect_from: - /articles/referencing-and-citing-content - /github/creating-cloning-and-archiving-repositories/referencing-and-citing-content + - /github/creating-cloning-and-archiving-repositories/archiving-a-github-repository/referencing-and-citing-content versions: fpt: '*' topics: diff --git a/content/github/administering-a-repository/configuring-pull-request-merges/about-merge-methods-on-github.md b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/about-merge-methods-on-github.md similarity index 96% rename from content/github/administering-a-repository/configuring-pull-request-merges/about-merge-methods-on-github.md rename to content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/about-merge-methods-on-github.md index 9344e720bf..ef056afbd4 100644 --- a/content/github/administering-a-repository/configuring-pull-request-merges/about-merge-methods-on-github.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/about-merge-methods-on-github.md @@ -4,13 +4,14 @@ intro: 'You can allow contributors with push access to your repository to merge redirect_from: - /articles/about-merge-methods-on-github - /github/administering-a-repository/about-merge-methods-on-github + - /github/administering-a-repository/configuring-pull-request-merges/about-merge-methods-on-github versions: fpt: '*' ghes: '*' ghae: '*' topics: - Repositories -shortTitle: Merge methods +shortTitle: About merge methods --- {% 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. diff --git a/content/github/administering-a-repository/configuring-pull-request-merges/configuring-commit-rebasing-for-pull-requests.md b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-rebasing-for-pull-requests.md similarity index 90% rename from content/github/administering-a-repository/configuring-pull-request-merges/configuring-commit-rebasing-for-pull-requests.md rename to content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-rebasing-for-pull-requests.md index 29fa0c22f2..4f6145d541 100644 --- a/content/github/administering-a-repository/configuring-pull-request-merges/configuring-commit-rebasing-for-pull-requests.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-rebasing-for-pull-requests.md @@ -4,6 +4,7 @@ intro: 'You can enforce, allow, or disable commit rebasing for all pull request redirect_from: - /articles/configuring-commit-rebasing-for-pull-requests - /github/administering-a-repository/configuring-commit-rebasing-for-pull-requests + - /github/administering-a-repository/configuring-pull-request-merges/configuring-commit-rebasing-for-pull-requests versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests.md b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests.md similarity index 93% rename from content/github/administering-a-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests.md rename to content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests.md index a9ec3138f1..5fb84a3881 100644 --- a/content/github/administering-a-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests.md @@ -4,6 +4,7 @@ intro: 'You can enforce, allow, or disable commit squashing for all pull request redirect_from: - /articles/configuring-commit-squashing-for-pull-requests - /github/administering-a-repository/configuring-commit-squashing-for-pull-requests + - /github/administering-a-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/configuring-pull-request-merges/index.md b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/index.md similarity index 89% rename from content/github/administering-a-repository/configuring-pull-request-merges/index.md rename to content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/index.md index a1dfb48cc2..a91abcbaf1 100644 --- a/content/github/administering-a-repository/configuring-pull-request-merges/index.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/index.md @@ -3,6 +3,7 @@ title: Configuring pull request merges intro: 'You can configure pull request merges on {% data variables.product.product_location %} to match your workflow and preferences for managing Git history.' redirect_from: - /articles/configuring-pull-request-merges + - /github/administering-a-repository/configuring-pull-request-merges versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/configuring-pull-request-merges/managing-auto-merge-for-pull-requests-in-your-repository.md b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-auto-merge-for-pull-requests-in-your-repository.md similarity index 92% rename from content/github/administering-a-repository/configuring-pull-request-merges/managing-auto-merge-for-pull-requests-in-your-repository.md rename to content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-auto-merge-for-pull-requests-in-your-repository.md index ead2beacd7..56560741c6 100644 --- a/content/github/administering-a-repository/configuring-pull-request-merges/managing-auto-merge-for-pull-requests-in-your-repository.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-auto-merge-for-pull-requests-in-your-repository.md @@ -11,6 +11,7 @@ topics: - Repositories redirect_from: - /github/administering-a-repository/managing-auto-merge-for-pull-requests-in-your-repository + - /github/administering-a-repository/configuring-pull-request-merges/managing-auto-merge-for-pull-requests-in-your-repository shortTitle: Manage auto merge --- ## About auto-merge diff --git a/content/github/administering-a-repository/configuring-pull-request-merges/managing-the-automatic-deletion-of-branches.md b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-the-automatic-deletion-of-branches.md similarity index 90% rename from content/github/administering-a-repository/configuring-pull-request-merges/managing-the-automatic-deletion-of-branches.md rename to content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-the-automatic-deletion-of-branches.md index 1a50625872..07111367a9 100644 --- a/content/github/administering-a-repository/configuring-pull-request-merges/managing-the-automatic-deletion-of-branches.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-the-automatic-deletion-of-branches.md @@ -4,6 +4,7 @@ intro: You can have head branches automatically deleted after pull requests are redirect_from: - /articles/managing-the-automatic-deletion-of-branches - /github/administering-a-repository/managing-the-automatic-deletion-of-branches + - /github/administering-a-repository/configuring-pull-request-merges/managing-the-automatic-deletion-of-branches versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md b/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md similarity index 99% rename from content/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md rename to content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md index 3f39c2d03a..1015a4cb4f 100644 --- a/content/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md @@ -16,6 +16,7 @@ redirect_from: - /articles/about-required-reviews-for-pull-requests - /github/administering-a-repository/about-required-reviews-for-pull-requests - /github/administering-a-repository/about-protected-branches + - /github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/defining-the-mergeability-of-pull-requests/index.md b/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/index.md similarity index 90% rename from content/github/administering-a-repository/defining-the-mergeability-of-pull-requests/index.md rename to content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/index.md index dd7feff6e8..05214ed1ac 100644 --- a/content/github/administering-a-repository/defining-the-mergeability-of-pull-requests/index.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/index.md @@ -5,6 +5,7 @@ redirect_from: - /articles/defining-the-mergeability-of-a-pull-request/ - /articles/defining-the-mergeability-of-pull-requests - /enterprise/admin/developer-workflow/establishing-pull-request-merge-conditions + - /github/administering-a-repository/defining-the-mergeability-of-pull-requests product: '{% data reusables.gated-features.protected-branches %}' versions: fpt: '*' diff --git a/content/github/administering-a-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md b/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md similarity index 98% rename from content/github/administering-a-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md rename to content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md index 3063d729e3..36b9d5b9d4 100644 --- a/content/github/administering-a-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md @@ -17,6 +17,7 @@ redirect_from: - /github/administering-a-repository/enabling-force-pushes-to-a-protected-branch - /github/administering-a-repository/enabling-deletion-of-a-protected-branch - /github/administering-a-repository/managing-a-branch-protection-rule + - /github/administering-a-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/defining-the-mergeability-of-pull-requests/troubleshooting-required-status-checks.md b/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/troubleshooting-required-status-checks.md similarity index 95% rename from content/github/administering-a-repository/defining-the-mergeability-of-pull-requests/troubleshooting-required-status-checks.md rename to content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/troubleshooting-required-status-checks.md index 5bfc3b29b5..c4e85e1f9b 100644 --- a/content/github/administering-a-repository/defining-the-mergeability-of-pull-requests/troubleshooting-required-status-checks.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/troubleshooting-required-status-checks.md @@ -10,6 +10,7 @@ topics: - Repositories redirect_from: - /github/administering-a-repository/troubleshooting-required-status-checks + - /github/administering-a-repository/defining-the-mergeability-of-pull-requests/troubleshooting-required-status-checks shortTitle: Required status checks --- If you have a check and a status with the same name, and you select that name as a required status check, both the check and the status are required. For more information, see "[Checks](/rest/reference/checks)." diff --git a/content/repositories/configuring-branches-and-merges-in-your-repository/index.md b/content/repositories/configuring-branches-and-merges-in-your-repository/index.md new file mode 100644 index 0000000000..dc41e62225 --- /dev/null +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/index.md @@ -0,0 +1,16 @@ +--- +title: Configuring branches and merges in your repository +intro: 'You can manage branches in your repository, configure the way branches are merged in your repository, and protect important branches by definining the mergeability of pull requests.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' +topics: + - Repositories +children: + - /managing-branches-in-your-repository + - /configuring-pull-request-merges + - /defining-the-mergeability-of-pull-requests +shortTitle: Branches and merges +--- + diff --git a/content/github/administering-a-repository/managing-branches-in-your-repository/changing-the-default-branch.md b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/changing-the-default-branch.md similarity index 97% rename from content/github/administering-a-repository/managing-branches-in-your-repository/changing-the-default-branch.md rename to content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/changing-the-default-branch.md index 980d6377d2..2cc3646d51 100644 --- a/content/github/administering-a-repository/managing-branches-in-your-repository/changing-the-default-branch.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/changing-the-default-branch.md @@ -10,6 +10,7 @@ redirect_from: - /github/administering-a-repository/setting-the-default-branch - /articles/setting-the-default-branch - /github/administering-a-repository/changing-the-default-branch + - /github/administering-a-repository/managing-branches-in-your-repository/changing-the-default-branch topics: - Repositories shortTitle: Change the default branch diff --git a/content/github/administering-a-repository/managing-branches-in-your-repository/deleting-and-restoring-branches-in-a-pull-request.md b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/deleting-and-restoring-branches-in-a-pull-request.md similarity index 93% rename from content/github/administering-a-repository/managing-branches-in-your-repository/deleting-and-restoring-branches-in-a-pull-request.md rename to content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/deleting-and-restoring-branches-in-a-pull-request.md index 0fedcc959c..76797d7123 100644 --- a/content/github/administering-a-repository/managing-branches-in-your-repository/deleting-and-restoring-branches-in-a-pull-request.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/deleting-and-restoring-branches-in-a-pull-request.md @@ -7,13 +7,14 @@ redirect_from: - /articles/deleting-unused-branches/ - /articles/deleting-and-restoring-branches-in-a-pull-request - /github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request + - /github/administering-a-repository/managing-branches-in-your-repository/deleting-and-restoring-branches-in-a-pull-request versions: fpt: '*' ghes: '*' ghae: '*' topics: - Repositories -shortTitle: Delete & restore +shortTitle: Delete & restore branches --- ## Deleting a branch used for a pull request diff --git a/content/github/administering-a-repository/managing-branches-in-your-repository/index.md b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/index.md similarity index 90% rename from content/github/administering-a-repository/managing-branches-in-your-repository/index.md rename to content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/index.md index b1df7012fc..03d16a668c 100644 --- a/content/github/administering-a-repository/managing-branches-in-your-repository/index.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/index.md @@ -3,6 +3,7 @@ title: Managing branches in your repository intro: 'Whenever you propose a change in Git, you [create a new branch](/articles/creating-and-deleting-branches-within-your-repository/). Branch management is an important part of the Git workflow. After some time, your list of branches may grow, so it''s a good idea to delete merged or stale branches.' redirect_from: - /articles/managing-branches-in-your-repository + - /github/administering-a-repository/managing-branches-in-your-repository versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/managing-branches-in-your-repository/renaming-a-branch.md b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/renaming-a-branch.md similarity index 97% rename from content/github/administering-a-repository/managing-branches-in-your-repository/renaming-a-branch.md rename to content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/renaming-a-branch.md index ade2a1c72a..bff251c5f1 100644 --- a/content/github/administering-a-repository/managing-branches-in-your-repository/renaming-a-branch.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/renaming-a-branch.md @@ -9,6 +9,7 @@ topics: - Repositories redirect_from: - /github/administering-a-repository/renaming-a-branch + - /github/administering-a-repository/managing-branches-in-your-repository/renaming-a-branch --- ## About renaming branches diff --git a/content/github/administering-a-repository/managing-branches-in-your-repository/viewing-branches-in-your-repository.md b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/viewing-branches-in-your-repository.md similarity index 94% rename from content/github/administering-a-repository/managing-branches-in-your-repository/viewing-branches-in-your-repository.md rename to content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/viewing-branches-in-your-repository.md index 35db51c0e8..02e9e94b9f 100644 --- a/content/github/administering-a-repository/managing-branches-in-your-repository/viewing-branches-in-your-repository.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/viewing-branches-in-your-repository.md @@ -4,6 +4,7 @@ intro: 'Branches are central to collaboration on {% data variables.product.produ redirect_from: - /articles/viewing-branches-in-your-repository - /github/administering-a-repository/viewing-branches-in-your-repository + - /github/administering-a-repository/managing-branches-in-your-repository/viewing-branches-in-your-repository versions: fpt: '*' ghes: '*' diff --git a/content/repositories/creating-and-managing-repositories/about-repositories.md b/content/repositories/creating-and-managing-repositories/about-repositories.md new file mode 100644 index 0000000000..4f79cbdf96 --- /dev/null +++ b/content/repositories/creating-and-managing-repositories/about-repositories.md @@ -0,0 +1,115 @@ +--- +title: About repositories +intro: A repository contains all of your project's files and each file's revision history. You can discuss and manage your project's work within the repository. +redirect_from: + - /articles/about-repositories + - /github/creating-cloning-and-archiving-repositories/about-repositories + - /github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-repositories + - /github/creating-cloning-and-archiving-repositories/about-repository-visibility + - /github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-repository-visibility + - /articles/what-are-the-limits-for-viewing-content-and-diffs-in-my-repository + - /articles/limits-for-viewing-content-and-diffs-in-a-repository + - /github/creating-cloning-and-archiving-repositories/limits-for-viewing-content-and-diffs-in-a-repository + - /github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/limits-for-viewing-content-and-diffs-in-a-repository +versions: + fpt: '*' + ghes: '*' + ghae: '*' +topics: + - Repositories +--- + +## About repositories + +You can own repositories individually, or you can share ownership of repositories with other people in an organization. + +You can restrict who has access to a repository by choosing the repository's visibility. For more information, see "[About repository visibility](#about-repository-visibility)." + +For user-owned repositories, you can give other people collaborator access so that they can collaborate on your project. If a repository is owned by an organization, you can give organization members access permissions to collaborate on your repository. For more information, see "[Permission levels for a user account repository](/articles/permission-levels-for-a-user-account-repository/)" and "[Repository permission levels for an organization](/articles/repository-permission-levels-for-an-organization/)." + +{% ifversion fpt %} +With {% data variables.product.prodname_free_team %} for user accounts and organizations, you can work with unlimited collaborators on unlimited public repositories with a full feature set, or unlimited private repositories with a limited feature set. To get advanced tooling for private repositories, you can upgrade to {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, or {% data variables.product.prodname_ghe_cloud %}. {% data reusables.gated-features.more-info %} +{% else %} +Each person and organization can own unlimited repositories and invite an unlimited number of collaborators to all repositories. +{% endif %} + +You can use repositories to manage your work and collaborate with others. +- You can use issues to collect user feedback, report software bugs, and organize tasks you'd like to accomplish. For more information, see "[About issues](/github/managing-your-work-on-github/about-issues)."{% ifversion fpt %} +- {% data reusables.discussions.you-can-use-discussions %}{% endif %} +- You can use pull requests to propose changes to a repository. For more information, see "[About pull requests](/github/collaborating-with-issues-and-pull-requests/about-pull-requests)." +- You can use project boards to organize and prioritize your issues and pull requests. For more information, see "[About project boards](/github/managing-your-work-on-github/about-project-boards)." + +{% data reusables.repositories.repo-size-limit %} + +## About repository visibility + +You can restrict who has access to a repository by choosing a repository's visibility: {% ifversion fpt or ghes %}public, internal, or private{% elsif ghae %}private or internal{% else %} public or private{% endif %}. + +{% ifversion ghae %}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.{% ifversion fpt or ghes %} If you're creating the repository in an organization{% ifversion fpt %} that is owned by an enterprise account{% endif %}, you can also choose to make the repository internal.{% endif %}{% endif %} + +{% ifversion ghes %} +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. {% ifversion ghes %} Internal repositories are accessible to enterprise members. For more information, see "[About internal repositories](#about-internal-repositories)."{% endif %} +{% elsif ghae %} +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](/organizations/managing-access-to-your-organizations-repositories/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)." + +{% ifversion fpt or ghae or ghes %} +## About internal repositories + +{% note %} + +**Note:** {% data reusables.gated-features.internal-repos %} + +{% endnote %} + +{% 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 enterprise members have read permissions to the internal repository, but internal repositories are not visible to people {% ifversion fpt %}outside of the enterprise{% else %}who are not members of an organization{% endif %}, including outside collaborators on organization repositories. For more information, see {% ifversion fpt or ghae %}"[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 all organizations owned by the enterprise, that user's forks of internal repositories are removed automatically. +{% endif %} + +## Limits for viewing content and diffs in a repository + +Certain types of resources can be quite large, requiring excessive processing on {% data variables.product.product_name %}. Because of this, limits are set to ensure requests complete in a reasonable amount of time. + +Most of the limits below affect both {% data variables.product.product_name %} and the API. + +### Text limits + +Text files over **1 MB** are always displayed as plain text. Code is not syntax highlighted, and prose files are not converted to HTML (such as Markdown, AsciiDoc, *etc.*). + +Text files over **5 MB** are only available through their raw URLs, which are served through `{% data variables.product.raw_github_com %}`; for example, `https://{% data variables.product.raw_github_com %}/octocat/Spoon-Knife/master/index.html`. Click the **Raw** button to get the raw URL for a file. + +### Diff limits + +Because diffs can become very large, we impose these limits on diffs for commits, pull requests, and compare views: + +- In a pull request, no total diff may exceed *20,000 lines that you can load* or *1 MB* of raw diff data. +- No single file's diff may exceed *20,000 lines that you can load* or *500 KB* of raw diff data. *Four hundred lines* and *20 KB* are automatically loaded for a single file. +- The maximum number of files in a single diff is limited to *300*. +- The maximum number of renderable files (such as images, PDFs, and GeoJSON files) in a single diff is limited to *25*. + +Some portions of a limited diff may be displayed, but anything exceeding the limit is not shown. + +### Commit listings limits + +The compare view and pull requests pages display a list of commits between the `base` and `head` revisions. These lists are limited to **250** commits. If they exceed that limit, a note indicates that additional commits are present (but they're not shown). + +## Further reading + +- "[Creating a new repository](/articles/creating-a-new-repository)" +- "[Collaborating with issues and pull requests](/categories/collaborating-with-issues-and-pull-requests)" +- "[Managing your work on {% data variables.product.prodname_dotcom %}](/categories/managing-your-work-on-github/)" +- "[Administering a repository](/categories/administering-a-repository)" +- "[Visualizing repository data with graphs](/categories/visualizing-repository-data-with-graphs/)" +- "[About wikis](/communities/documenting-your-project-with-wikis/about-wikis)" +- "[{% data variables.product.prodname_dotcom %} glossary](/articles/github-glossary)" diff --git a/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository.md b/content/repositories/creating-and-managing-repositories/cloning-a-repository.md similarity index 96% rename from content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository.md rename to content/repositories/creating-and-managing-repositories/cloning-a-repository.md index 394b57158d..a800e35239 100644 --- a/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository.md +++ b/content/repositories/creating-and-managing-repositories/cloning-a-repository.md @@ -3,7 +3,9 @@ title: Cloning a repository intro: 'When you create a repository on {% data variables.product.product_location %}, it exists as a remote repository. You can clone your repository to create a local copy on your computer and sync between the two locations.' redirect_from: - /articles/cloning-a-repository + - /articles/cloning-a-repository-from-github - /github/creating-cloning-and-archiving-repositories/cloning-a-repository + - /github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository versions: fpt: '*' ghes: '*' @@ -93,4 +95,4 @@ If you're unable to clone a repository, check that: ## Further reading - "[Troubleshooting connectivity problems](/articles/troubleshooting-connectivity-problems)" -{% endif %} +{% endif %} \ No newline at end of file diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-new-repository.md b/content/repositories/creating-and-managing-repositories/creating-a-new-repository.md similarity index 91% rename from content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-new-repository.md rename to content/repositories/creating-and-managing-repositories/creating-a-new-repository.md index e83d96e92e..3763a7926b 100644 --- a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-new-repository.md +++ b/content/repositories/creating-and-managing-repositories/creating-a-new-repository.md @@ -10,6 +10,7 @@ redirect_from: - /github/setting-up-and-managing-your-enterprise-account/creating-an-internal-repository - /github/creating-cloning-and-archiving-repositories/creating-an-internal-repository - /github/creating-cloning-and-archiving-repositories/creating-a-new-repository + - /github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-new-repository versions: fpt: '*' ghes: '*' @@ -40,7 +41,7 @@ topics: ![Owner drop-down menu](/assets/images/help/repository/create-repository-owner.png) {% data reusables.repositories.repo-name %} {% data reusables.repositories.choose-repo-visibility %} -6. If you're not using a template, there are a number of optional items you can pre-populate your repository with. If you're importing an existing repository to {% data variables.product.product_name %}, don't choose any of these options, as you may introduce a merge conflict. You can add or create new files using the user interface or choose to add new files using the command line later. For more information, see "[Importing a Git repository using the command line](/articles/importing-a-git-repository-using-the-command-line/)," "[Adding a file to a repository using the command line](/articles/adding-a-file-to-a-repository-using-the-command-line)," and "[Addressing merge conflicts](/articles/addressing-merge-conflicts/)." +6. If you're not using a template, there are a number of optional items you can pre-populate your repository with. If you're importing an existing repository to {% data variables.product.product_name %}, don't choose any of these options, as you may introduce a merge conflict. You can add or create new files using the user interface or choose to add new files using the command line later. For more information, see "[Importing a Git repository using the command line](/articles/importing-a-git-repository-using-the-command-line/)," "[Adding a file to a repository](/repositories/working-with-files/managing-files/adding-a-file-to-a-repository#adding-a-file-to-a-repository-using-the-command-line)," and "[Addressing merge conflicts](/articles/addressing-merge-conflicts/)." - You can create a README, which is a document describing your project. For more information, see "[About READMEs](/articles/about-readmes/)." - You can create a *.gitignore* file, which is a set of ignore rules. For more information, see "[Ignoring files](/github/getting-started-with-github/ignoring-files)."{% ifversion fpt %} - You can choose to add a software license for your project. For more information, see "[Licensing a repository](/articles/licensing-a-repository)."{% endif %} diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-repository-from-a-template.md b/content/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template.md similarity index 95% rename from content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-repository-from-a-template.md rename to content/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template.md index cade17c7b0..d39d5de825 100644 --- a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-repository-from-a-template.md +++ b/content/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template.md @@ -4,6 +4,7 @@ intro: You can generate a new repository with the same directory structure and f redirect_from: - /articles/creating-a-repository-from-a-template - /github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template + - /github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-repository-from-a-template versions: fpt: '*' ghes: '*' diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-template-repository.md b/content/repositories/creating-and-managing-repositories/creating-a-template-repository.md similarity index 93% rename from content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-template-repository.md rename to content/repositories/creating-and-managing-repositories/creating-a-template-repository.md index ac6b9880c2..48e2733234 100644 --- a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-template-repository.md +++ b/content/repositories/creating-and-managing-repositories/creating-a-template-repository.md @@ -5,6 +5,7 @@ permissions: Anyone with admin permissions to a repository can make the reposito redirect_from: - /articles/creating-a-template-repository - /github/creating-cloning-and-archiving-repositories/creating-a-template-repository + - /github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-template-repository versions: fpt: '*' ghes: '*' diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-an-issues-only-repository.md b/content/repositories/creating-and-managing-repositories/creating-an-issues-only-repository.md similarity index 92% rename from content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-an-issues-only-repository.md rename to content/repositories/creating-and-managing-repositories/creating-an-issues-only-repository.md index 44a65c5ad6..165de7dad3 100644 --- a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-an-issues-only-repository.md +++ b/content/repositories/creating-and-managing-repositories/creating-an-issues-only-repository.md @@ -6,6 +6,7 @@ redirect_from: - /articles/is-there-issues-only-access-to-organization-repositories/ - /articles/creating-an-issues-only-repository - /github/creating-cloning-and-archiving-repositories/creating-an-issues-only-repository + - /github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-an-issues-only-repository versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/managing-repository-settings/deleting-a-repository.md b/content/repositories/creating-and-managing-repositories/deleting-a-repository.md similarity index 95% rename from content/github/administering-a-repository/managing-repository-settings/deleting-a-repository.md rename to content/repositories/creating-and-managing-repositories/deleting-a-repository.md index a05a574a4b..d4530795c6 100644 --- a/content/github/administering-a-repository/managing-repository-settings/deleting-a-repository.md +++ b/content/repositories/creating-and-managing-repositories/deleting-a-repository.md @@ -6,6 +6,7 @@ redirect_from: - /deleting-a-repo/ - /articles/deleting-a-repository - /github/administering-a-repository/deleting-a-repository + - /github/administering-a-repository/managing-repository-settings/deleting-a-repository versions: fpt: '*' ghes: '*' diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/duplicating-a-repository.md b/content/repositories/creating-and-managing-repositories/duplicating-a-repository.md similarity index 97% rename from content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/duplicating-a-repository.md rename to content/repositories/creating-and-managing-repositories/duplicating-a-repository.md index 2199a6bc0b..ac5642672d 100644 --- a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/duplicating-a-repository.md +++ b/content/repositories/creating-and-managing-repositories/duplicating-a-repository.md @@ -5,6 +5,7 @@ redirect_from: - /articles/duplicating-a-repo/ - /articles/duplicating-a-repository - /github/creating-cloning-and-archiving-repositories/duplicating-a-repository + - /github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/duplicating-a-repository versions: fpt: '*' ghes: '*' diff --git a/content/repositories/creating-and-managing-repositories/index.md b/content/repositories/creating-and-managing-repositories/index.md new file mode 100644 index 0000000000..a26450047d --- /dev/null +++ b/content/repositories/creating-and-managing-repositories/index.md @@ -0,0 +1,28 @@ +--- +title: Creating and managing repositories +intro: "You can create a repository on {% data variables.product.product_name %} to store and collaborate on your project's files, then manage the repository's name and location." +redirect_from: + - /articles/creating-a-repository-on-github + - /github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github +versions: + fpt: '*' + ghes: '*' + ghae: '*' +topics: + - Repositories +children: + - /about-repositories + - /creating-a-new-repository + - /creating-a-repository-from-a-template + - /creating-a-template-repository + - /creating-an-issues-only-repository + - /duplicating-a-repository + - /cloning-a-repository + - /troubleshooting-cloning-errors + - /renaming-a-repository + - /transferring-a-repository + - /deleting-a-repository + - /restoring-a-deleted-repository +shortTitle: Create & manage repositories +--- + diff --git a/content/github/administering-a-repository/managing-repository-settings/renaming-a-repository.md b/content/repositories/creating-and-managing-repositories/renaming-a-repository.md similarity index 96% rename from content/github/administering-a-repository/managing-repository-settings/renaming-a-repository.md rename to content/repositories/creating-and-managing-repositories/renaming-a-repository.md index f56a1d5810..9eecf0d258 100644 --- a/content/github/administering-a-repository/managing-repository-settings/renaming-a-repository.md +++ b/content/repositories/creating-and-managing-repositories/renaming-a-repository.md @@ -4,6 +4,7 @@ intro: You can rename a repository if you're either an organization owner or hav redirect_from: - /articles/renaming-a-repository - /github/administering-a-repository/renaming-a-repository + - /github/administering-a-repository/managing-repository-settings/renaming-a-repository versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/managing-repository-settings/restoring-a-deleted-repository.md b/content/repositories/creating-and-managing-repositories/restoring-a-deleted-repository.md similarity index 95% rename from content/github/administering-a-repository/managing-repository-settings/restoring-a-deleted-repository.md rename to content/repositories/creating-and-managing-repositories/restoring-a-deleted-repository.md index 80fee61625..01dafcadee 100644 --- a/content/github/administering-a-repository/managing-repository-settings/restoring-a-deleted-repository.md +++ b/content/repositories/creating-and-managing-repositories/restoring-a-deleted-repository.md @@ -4,6 +4,7 @@ intro: You can restore some deleted repositories to recover their contents. redirect_from: - /articles/restoring-a-deleted-repository - /github/administering-a-repository/restoring-a-deleted-repository + - /github/administering-a-repository/managing-repository-settings/restoring-a-deleted-repository versions: fpt: '*' topics: diff --git a/content/github/administering-a-repository/managing-repository-settings/transferring-a-repository.md b/content/repositories/creating-and-managing-repositories/transferring-a-repository.md similarity index 98% rename from content/github/administering-a-repository/managing-repository-settings/transferring-a-repository.md rename to content/repositories/creating-and-managing-repositories/transferring-a-repository.md index 7b6dc7ff31..031bbb7c85 100644 --- a/content/github/administering-a-repository/managing-repository-settings/transferring-a-repository.md +++ b/content/repositories/creating-and-managing-repositories/transferring-a-repository.md @@ -13,6 +13,7 @@ redirect_from: - /articles/transferring-a-repository-owned-by-your-organization/ - /articles/transferring-a-repository - /github/administering-a-repository/transferring-a-repository + - /github/administering-a-repository/managing-repository-settings/transferring-a-repository versions: fpt: '*' ghes: '*' diff --git a/content/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors.md b/content/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors.md new file mode 100644 index 0000000000..b37af1b131 --- /dev/null +++ b/content/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors.md @@ -0,0 +1,183 @@ +--- +title: Troubleshooting cloning errors +intro: "If you're having trouble cloning a repository, check these common errors." +redirect_from: + - /articles/error-the-requested-url-returned-error-403 + - /articles/error-the-requested-url-returned-error-401 + - /articles/error-did-you-run-git-update-server-info-on-the-server + - /articles/error-the-requested-url-returned-error-403-while-accessing-https-github-com-user-repo-git-info-refs + - /articles/https-cloning-errors + - /github/creating-cloning-and-archiving-repositories/https-cloning-errors + - /articles/error-repository-not-found + - /github/creating-cloning-and-archiving-repositories/error-repository-not-found + - /articles/error-remote-head-refers-to-nonexistent-ref-unable-to-checkout + - /github/creating-cloning-and-archiving-repositories/error-remote-head-refers-to-nonexistent-ref-unable-to-checkout +versions: + fpt: '*' + ghes: '*' + ghae: '*' +topics: + - Repositories +--- + +## HTTPS cloning errors + +There are a few common errors when using HTTPS with Git. These errors usually indicate you have an old version of Git, or you don't have access to the repository. + +Here's an example of an HTTPS error you might receive: + +```shell +> error: The requested URL returned error: 401 while accessing +> https://{% data variables.command_line.codeblock %}/user/repo.git/info/refs?service=git-receive-pack +> fatal: HTTP request failed +``` + +```shell +> Error: The requested URL returned error: 403 while accessing +> https://{% data variables.command_line.codeblock %}/user/repo.git/info/refs +> fatal: HTTP request failed +``` + +```shell +> Error: https://{% data variables.command_line.codeblock %}/user/repo.git/info/refs not found: did you run git +> update-server-info on the server? +``` + +### Check your Git version + +There's no minimum Git version necessary to interact with {% data variables.product.product_name %}, but we've found version 1.7.10 to be a comfortable stable version that's available on many platforms. You can always [download the latest version on the Git website](https://git-scm.com/downloads). + +### Ensure the remote is correct + +The repository you're trying to fetch must exist on {% data variables.product.product_location %}, and the URL is case-sensitive. + +You can find the URL of the local repository by opening the command line and +typing `git remote -v`: + +```shell +$ git remote -v +# View existing remotes +> origin https://github.com/ghost/reactivecocoa.git (fetch) +> origin https://github.com/ghost/reactivecocoa.git (push) + +$ git remote set-url origin https://github.com/ghost/ReactiveCocoa.git +# Change the 'origin' remote's URL + +$ git remote -v +# Verify new remote URL +> origin https://github.com/ghost/ReactiveCocoa.git (fetch) +> origin https://github.com/ghost/ReactiveCocoa.git (push) +``` + +Alternatively, you can change the URL through our +[{% data variables.product.prodname_desktop %}](https://desktop.github.com/) application. + +### Provide an access token + +To access {% data variables.product.prodname_dotcom %}, you must authenticate with a personal access token instead of your password. For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." + +{% data reusables.command_line.provide-an-access-token %} + +### Check your permissions + +When prompted for a username and password, make sure you use an account that has access to the repository. + +{% 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/getting-started-with-github/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 %} + +### Use SSH instead + +If you've previously set up SSH keys, you can use the SSH clone URL instead of HTTPS. For more information, see "[About remote repositories](/github/getting-started-with-github/about-remote-repositories)." + +## Error: Repository not found + +{% ifversion fpt or ghae %}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. + +### Check your spelling + +Typos happen, and repository names are case-sensitive. If you try to clone `git@{% data variables.command_line.codeblock %}:user/repo.git`, but the repository is really named `User/Repo` you will receive this error. + +To avoid this error, when cloning, always copy and paste the clone URL from the repository's page. For more information, see "[Cloning a repository](/articles/cloning-a-repository)." + +To update the remote on an existing repository, see "[Managing remote repositories](/github/getting-started-with-github/managing-remote-repositories)". + +### Checking your permissions + +If you are trying to clone a private repository but do not have permission to view the repository, you will receive this error. + +Make sure that you have access to the repository in one of these ways: + +* The owner of the repository +* A [collaborator](/articles/inviting-collaborators-to-a-personal-repository) on the repository +* A [member of a team](/articles/adding-organization-members-to-a-team) that has access to the repository (if the repository belongs to an organization) + +### Check your SSH access + +In rare circumstances, you may not have the proper SSH access to a repository. + +You should ensure that the SSH key you are using is attached to your {% data variables.product.product_name %} user account. You can check this by typing +the following into the command line: + +```shell +$ ssh -T git@{% data variables.command_line.codeblock %} +> Hi username! You've successfully authenticated, but GitHub does not +> provide shell access. +``` + +If the repository belongs to an organization and you're using an SSH key generated by an OAuth App, OAuth App access may have been restricted by an organization owner. For more information, see "About OAuth App access restrictions." + +For more information, see [Adding a new SSH key to your GitHub account](/articles/adding-a-new-ssh-key-to-your-github-account). + +{% ifversion ghes %} +### 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 + +If all else fails, make sure that the repository really exists on {% data variables.product.product_location %}! +If you're trying to push to a repository that doesn't exist, you'll get this error. + +## Error: Remote HEAD refers to nonexistent ref, unable to checkout + +This error occurs if the default branch of a repository has been deleted on {% data variables.product.product_location %}. + +Detecting this error is simple; Git will warn you when you try to clone the repository: + +```shell +$ git clone https://{% data variables.command_line.codeblock %}/user/repo.git +# Clone a repo +> Cloning into 'repo'... +> remote: Counting objects: 66179, done. +> remote: Compressing objects: 100% (15587/15587), done. +> remote: Total 66179 (delta 46985), reused 65596 (delta 46402) +> Receiving objects: 100% (66179/66179), 51.66 MiB | 667 KiB/s, done. +> Resolving deltas: 100% (46985/46985), done. +> warning: remote HEAD refers to nonexistent ref, unable to checkout. +``` + +To fix the error, you'll need to be an administrator of the repository on {% data variables.product.product_location %}. +You'll want to [change the default branch](/github/administering-a-repository/changing-the-default-branch) of the repository. + +After that, you can get a list of all the available branches from the command line: + +```shell +$ git branch -a +# Lists ALL the branches +> remotes/origin/awesome +> remotes/origin/more-work +> remotes/origin/new-main +``` + +Then, you can just switch to your new branch: + +```shell +$ git checkout new-main +# Create and checkout a tracking branch +> Branch new-main set up to track remote branch new-main from origin. +> Switched to a new branch 'new-main' +``` \ No newline at end of file diff --git a/content/repositories/index.md b/content/repositories/index.md new file mode 100644 index 0000000000..af493c0c64 --- /dev/null +++ b/content/repositories/index.md @@ -0,0 +1,19 @@ +--- +title: Repositories +intro: "Learn to use and manage the repositories that allow you to store and collaborate on your project's code." +versions: + fpt: '*' + ghes: '*' + ghae: '*' +topics: + - Repositories +children: + - /creating-and-managing-repositories + - /managing-your-repositorys-settings-and-features + - /configuring-branches-and-merges-in-your-repository + - /working-with-files + - /releasing-projects-on-github + - /viewing-activity-and-data-for-your-repository + - /archiving-a-github-repository +--- + diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-citation-files.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files.md similarity index 97% rename from content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-citation-files.md rename to content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files.md index 4cc5a8f7dd..e2368c2e8d 100644 --- a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-citation-files.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files.md @@ -1,6 +1,8 @@ --- title: About CITATION files intro: You can add a CITATION file to your repository to help users correctly cite your software. +redirect_from: + - /github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-citation-files versions: fpt: '*' ghes: '>=3.3' diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-code-owners.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md similarity index 98% rename from content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-code-owners.md rename to content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md index 434033d128..fbdbfe5546 100644 --- a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-code-owners.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md @@ -5,6 +5,7 @@ redirect_from: - /articles/about-codeowners/ - /articles/about-code-owners - /github/creating-cloning-and-archiving-repositories/about-code-owners + - /github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-code-owners product: '{% data reusables.gated-features.code-owners %}' versions: fpt: '*' diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-readmes.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes.md similarity index 97% rename from content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-readmes.md rename to content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes.md index 29444823a4..53e463b5f2 100644 --- a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-readmes.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes.md @@ -6,6 +6,7 @@ redirect_from: - /articles/relative-links-in-readmes/ - /articles/about-readmes - /github/creating-cloning-and-archiving-repositories/about-readmes + - /github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-readmes versions: fpt: '*' ghes: '*' diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-repository-languages.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-repository-languages.md similarity index 93% rename from content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-repository-languages.md rename to content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-repository-languages.md index 9bf74a5607..7e4feab23f 100644 --- a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-repository-languages.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-repository-languages.md @@ -9,6 +9,7 @@ redirect_from: - /articles/why-isn-t-my-favorite-language-recognized-by-github/ - /articles/about-repository-languages - /github/creating-cloning-and-archiving-repositories/about-repository-languages + - /github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-repository-languages versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/managing-repository-settings/classifying-your-repository-with-topics.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md similarity index 96% rename from content/github/administering-a-repository/managing-repository-settings/classifying-your-repository-with-topics.md rename to content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md index d9c824488d..676e63f892 100644 --- a/content/github/administering-a-repository/managing-repository-settings/classifying-your-repository-with-topics.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md @@ -5,6 +5,7 @@ redirect_from: - /articles/about-topics/ - /articles/classifying-your-repository-with-topics - /github/administering-a-repository/classifying-your-repository-with-topics + - /github/administering-a-repository/managing-repository-settings/classifying-your-repository-with-topics versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/managing-repository-settings/customizing-your-repositorys-social-media-preview.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/customizing-your-repositorys-social-media-preview.md similarity index 91% rename from content/github/administering-a-repository/managing-repository-settings/customizing-your-repositorys-social-media-preview.md rename to content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/customizing-your-repositorys-social-media-preview.md index ef6570cb7f..ea4a96c1db 100644 --- a/content/github/administering-a-repository/managing-repository-settings/customizing-your-repositorys-social-media-preview.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/customizing-your-repositorys-social-media-preview.md @@ -4,6 +4,7 @@ intro: You can customize the image displayed on social media platforms when some redirect_from: - /articles/customizing-your-repositorys-social-media-preview - /github/administering-a-repository/customizing-your-repositorys-social-media-preview + - /github/administering-a-repository/managing-repository-settings/customizing-your-repositorys-social-media-preview versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/managing-repository-settings/displaying-a-sponsor-button-in-your-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository.md similarity index 97% rename from content/github/administering-a-repository/managing-repository-settings/displaying-a-sponsor-button-in-your-repository.md rename to content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository.md index 2c1da6922e..27c000d7c6 100644 --- a/content/github/administering-a-repository/managing-repository-settings/displaying-a-sponsor-button-in-your-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository.md @@ -5,6 +5,7 @@ redirect_from: - /github/building-a-strong-community/displaying-a-sponsor-button-in-your-repository - /articles/displaying-a-sponsor-button-in-your-repository - /github/administering-a-repository/displaying-a-sponsor-button-in-your-repository + - /github/administering-a-repository/managing-repository-settings/displaying-a-sponsor-button-in-your-repository versions: fpt: '*' topics: diff --git a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/index.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/index.md new file mode 100644 index 0000000000..0ce1d90b9b --- /dev/null +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/index.md @@ -0,0 +1,21 @@ +--- +title: Customizing your repository +intro: 'You can choose the way your repository appears by customizing your repository.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' +topics: + - Repositories +children: + - /about-readmes + - /licensing-a-repository + - /displaying-a-sponsor-button-in-your-repository + - /customizing-your-repositorys-social-media-preview + - /classifying-your-repository-with-topics + - /about-code-owners + - /about-repository-languages + - /about-citation-files +shortTitle: Customize your repository +--- + diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/licensing-a-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository.md similarity index 98% rename from content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/licensing-a-repository.md rename to content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository.md index 5e0688fcda..e60ae9919c 100644 --- a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/licensing-a-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository.md @@ -5,6 +5,7 @@ redirect_from: - /articles/open-source-licensing/ - /articles/licensing-a-repository - /github/creating-cloning-and-archiving-repositories/licensing-a-repository + - /github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/licensing-a-repository versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/managing-repository-settings/disabling-issues.md b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-issues.md similarity index 92% rename from content/github/administering-a-repository/managing-repository-settings/disabling-issues.md rename to content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-issues.md index da7deb38d0..4f6b9cc926 100644 --- a/content/github/administering-a-repository/managing-repository-settings/disabling-issues.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-issues.md @@ -5,6 +5,7 @@ redirect_from: - /github/managing-your-work-on-github/managing-your-work-with-issues-and-pull-requests/disabling-issues - /articles/disabling-issues - /github/managing-your-work-on-github/disabling-issues + - /github/administering-a-repository/managing-repository-settings/disabling-issues versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/managing-repository-settings/disabling-project-boards-in-a-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-project-boards-in-a-repository.md similarity index 91% rename from content/github/administering-a-repository/managing-repository-settings/disabling-project-boards-in-a-repository.md rename to content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-project-boards-in-a-repository.md index 3d4b5f445a..97c1635490 100644 --- a/content/github/administering-a-repository/managing-repository-settings/disabling-project-boards-in-a-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-project-boards-in-a-repository.md @@ -5,6 +5,7 @@ redirect_from: - /github/managing-your-work-on-github/managing-project-boards/disabling-project-boards-in-a-repository - /articles/disabling-project-boards-in-a-repository - /github/managing-your-work-on-github/disabling-project-boards-in-a-repository + - /github/administering-a-repository/managing-repository-settings/disabling-project-boards-in-a-repository versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/managing-repository-settings/enabling-or-disabling-github-discussions-for-a-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/enabling-or-disabling-github-discussions-for-a-repository.md similarity index 90% rename from content/github/administering-a-repository/managing-repository-settings/enabling-or-disabling-github-discussions-for-a-repository.md rename to content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/enabling-or-disabling-github-discussions-for-a-repository.md index ad389dc1e9..f8bba603f4 100644 --- a/content/github/administering-a-repository/managing-repository-settings/enabling-or-disabling-github-discussions-for-a-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/enabling-or-disabling-github-discussions-for-a-repository.md @@ -9,6 +9,7 @@ topics: - Repositories redirect_from: - /github/administering-a-repository/enabling-or-disabling-github-discussions-for-a-repository + - /github/administering-a-repository/managing-repository-settings/enabling-or-disabling-github-discussions-for-a-repository shortTitle: Discussions --- diff --git a/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/index.md b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/index.md new file mode 100644 index 0000000000..9ad3dc1f15 --- /dev/null +++ b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/index.md @@ -0,0 +1,18 @@ +--- +title: Enabling features for your repository +intro: 'You can enable, configure, and disable optional features for your repository.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' +topics: + - Repositories +children: + - /disabling-issues + - /disabling-project-boards-in-a-repository + - /managing-github-actions-settings-for-a-repository + - /enabling-or-disabling-github-discussions-for-a-repository + - /managing-security-and-analysis-settings-for-your-repository +shortTitle: Enable features +--- + diff --git a/content/github/administering-a-repository/managing-repository-settings/disabling-or-limiting-github-actions-for-a-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.md similarity index 80% rename from content/github/administering-a-repository/managing-repository-settings/disabling-or-limiting-github-actions-for-a-repository.md rename to content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.md index 9847112fb8..04adf61378 100644 --- a/content/github/administering-a-repository/managing-repository-settings/disabling-or-limiting-github-actions-for-a-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.md @@ -1,16 +1,20 @@ --- -title: Disabling or limiting GitHub Actions for a repository -intro: 'Repository owners can disable, enable, and limit {% data variables.product.prodname_actions %} for a specific repository.' +title: Managing GitHub Actions settings for a repository +intro: 'You can disable or configure {% data variables.product.prodname_actions %} for a specific repository.' +redirect_from: + - /github/administering-a-repository/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository + - /github/administering-a-repository/managing-repository-settings/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository + - /github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository + - /github/administering-a-repository/managing-repository-settings/disabling-or-limiting-github-actions-for-a-repository versions: fpt: '*' ghes: '*' ghae: '*' topics: - - Repositories -redirect_from: - - /github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository -shortTitle: GitHub Actions + - Pull requests +shortTitle: Manage GitHub Actions settings --- + {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} @@ -119,3 +123,20 @@ The default permissions can also be configured in the organization settings. If ![Set GITHUB_TOKEN permissions for this repository](/assets/images/help/settings/actions-workflow-permissions-repository.png) 1. Click **Save** to apply the settings. {% endif %} + +{% ifversion fpt or ghes > 2.22 or ghae %} +## Configuring the retention period for {% data variables.product.prodname_actions %} artifacts and logs in your repository + +You can configure the retention period for {% data variables.product.prodname_actions %} artifacts and logs in your repository. + +{% data reusables.actions.about-artifact-log-retention %} + +You can also define a custom retention period for a specific artifact created by a workflow. For more information, see "[Setting the retention period for an artifact](/actions/managing-workflow-runs/removing-workflow-artifacts#setting-the-retention-period-for-an-artifact)." + +## Setting the retention period for a repository + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-settings %} +{% data reusables.repositories.settings-sidebar-actions %} +{% data reusables.github-actions.change-retention-period-for-artifacts-logs %} +{% endif %} \ No newline at end of file diff --git a/content/github/administering-a-repository/managing-repository-settings/managing-security-and-analysis-settings-for-your-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository.md similarity index 98% rename from content/github/administering-a-repository/managing-repository-settings/managing-security-and-analysis-settings-for-your-repository.md rename to content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository.md index b56b1d9a33..e188911b9a 100644 --- a/content/github/administering-a-repository/managing-repository-settings/managing-security-and-analysis-settings-for-your-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository.md @@ -8,6 +8,7 @@ redirect_from: - /articles/managing-alerts-for-vulnerable-dependencies-in-your-organization - /github/managing-security-vulnerabilities/managing-alerts-for-vulnerable-dependencies-in-your-organization - /github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository + - /github/administering-a-repository/managing-repository-settings/managing-security-and-analysis-settings-for-your-repository versions: fpt: '*' ghes: '>=3.0' diff --git a/content/repositories/managing-your-repositorys-settings-and-features/index.md b/content/repositories/managing-your-repositorys-settings-and-features/index.md new file mode 100644 index 0000000000..ad219941a2 --- /dev/null +++ b/content/repositories/managing-your-repositorys-settings-and-features/index.md @@ -0,0 +1,20 @@ +--- +title: Managing your repository’s settings and features +intro: "You can customize your repository, enable or disable optional features for your repository, and manage your repository’s settings." +redirect_from: + - /categories/administering-a-repository + - /articles/managing-repository-settings + - /github/administering-a-repository/managing-repository-settings +versions: + fpt: '*' + ghes: '*' + ghae: '*' +topics: + - Repositories +children: + - /customizing-your-repository + - /enabling-features-for-your-repository + - /managing-repository-settings +shortTitle: Manage repository settings +--- + diff --git a/content/github/administering-a-repository/managing-repository-settings/about-email-notifications-for-pushes-to-your-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/about-email-notifications-for-pushes-to-your-repository.md similarity index 97% rename from content/github/administering-a-repository/managing-repository-settings/about-email-notifications-for-pushes-to-your-repository.md rename to content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/about-email-notifications-for-pushes-to-your-repository.md index ae16032718..807b349dc8 100644 --- a/content/github/administering-a-repository/managing-repository-settings/about-email-notifications-for-pushes-to-your-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/about-email-notifications-for-pushes-to-your-repository.md @@ -8,6 +8,7 @@ redirect_from: - /articles/about-email-notifications-for-pushes-to-your-repository/ - /github/receiving-notifications-about-activity-on-github/about-email-notifications-for-pushes-to-your-repository - /github/administering-a-repository/about-email-notifications-for-pushes-to-your-repository + - /github/administering-a-repository/managing-repository-settings/about-email-notifications-for-pushes-to-your-repository versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/managing-repository-settings/configuring-autolinks-to-reference-external-resources.md b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-autolinks-to-reference-external-resources.md similarity index 94% rename from content/github/administering-a-repository/managing-repository-settings/configuring-autolinks-to-reference-external-resources.md rename to content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-autolinks-to-reference-external-resources.md index df168f0590..2070d9a169 100644 --- a/content/github/administering-a-repository/managing-repository-settings/configuring-autolinks-to-reference-external-resources.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-autolinks-to-reference-external-resources.md @@ -5,6 +5,7 @@ product: '{% data reusables.gated-features.autolinks %}' redirect_from: - /articles/configuring-autolinks-to-reference-external-resources - /github/administering-a-repository/configuring-autolinks-to-reference-external-resources + - /github/administering-a-repository/managing-repository-settings/configuring-autolinks-to-reference-external-resources versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository.md similarity index 91% rename from content/github/administering-a-repository/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository.md rename to content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository.md index e7cbeb2dcb..b53513d3a4 100644 --- a/content/github/administering-a-repository/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository.md @@ -4,6 +4,7 @@ intro: 'As a repository administrator, you can enable or disable anonymous Git r redirect_from: - /articles/enabling-anonymous-git-read-access-for-a-repository - /github/administering-a-repository/enabling-anonymous-git-read-access-for-a-repository + - /github/administering-a-repository/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository versions: ghes: '*' shortTitle: Anonymous Git read access diff --git a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/index.md b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/index.md new file mode 100644 index 0000000000..aba77f6401 --- /dev/null +++ b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/index.md @@ -0,0 +1,20 @@ +--- +title: Managing repository settings +intro: 'You can choose the way your repository functions by managing repository settings.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' +topics: + - Repositories +children: + - /setting-repository-visibility + - /managing-teams-and-people-with-access-to-your-repository + - /managing-the-forking-policy-for-your-repository + - /managing-git-lfs-objects-in-archives-of-your-repository + - /enabling-anonymous-git-read-access-for-a-repository + - /about-email-notifications-for-pushes-to-your-repository + - /configuring-autolinks-to-reference-external-resources +shortTitle: Manage repository settings +--- + diff --git a/content/github/administering-a-repository/managing-repository-settings/managing-git-lfs-objects-in-archives-of-your-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-git-lfs-objects-in-archives-of-your-repository.md similarity index 95% rename from content/github/administering-a-repository/managing-repository-settings/managing-git-lfs-objects-in-archives-of-your-repository.md rename to content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-git-lfs-objects-in-archives-of-your-repository.md index 5f644fe356..26a22595b8 100644 --- a/content/github/administering-a-repository/managing-repository-settings/managing-git-lfs-objects-in-archives-of-your-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-git-lfs-objects-in-archives-of-your-repository.md @@ -9,6 +9,7 @@ topics: - Repositories redirect_from: - /github/administering-a-repository/managing-git-lfs-objects-in-archives-of-your-repository + - /github/administering-a-repository/managing-repository-settings/managing-git-lfs-objects-in-archives-of-your-repository --- ## About {% data variables.large_files.product_name_short %} objects in archives diff --git a/content/github/administering-a-repository/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository.md similarity index 96% rename from content/github/administering-a-repository/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository.md rename to content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository.md index dcbf6d42e9..8cdb30c226 100644 --- a/content/github/administering-a-repository/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository.md @@ -5,6 +5,7 @@ permissions: Repository administrators can manage teams and people with access t redirect_from: - /github/administering-a-repository/managing-people-and-teams-with-access-to-your-repository - /github/administering-a-repository/managing-teams-and-people-with-access-to-your-repository + - /github/administering-a-repository/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository versions: fpt: '*' topics: diff --git a/content/github/administering-a-repository/managing-repository-settings/managing-the-forking-policy-for-your-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository.md similarity index 93% rename from content/github/administering-a-repository/managing-repository-settings/managing-the-forking-policy-for-your-repository.md rename to content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository.md index 4c2d133427..54bbe04e21 100644 --- a/content/github/administering-a-repository/managing-repository-settings/managing-the-forking-policy-for-your-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository.md @@ -5,6 +5,7 @@ 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 - /github/administering-a-repository/managing-the-forking-policy-for-your-repository + - /github/administering-a-repository/managing-repository-settings/managing-the-forking-policy-for-your-repository permissions: People with admin permissions for a repository can manage the forking policy for the repository. versions: fpt: '*' diff --git a/content/github/administering-a-repository/managing-repository-settings/setting-repository-visibility.md b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md similarity index 97% rename from content/github/administering-a-repository/managing-repository-settings/setting-repository-visibility.md rename to content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md index 28652861bd..2d96b81446 100644 --- a/content/github/administering-a-repository/managing-repository-settings/setting-repository-visibility.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md @@ -7,6 +7,7 @@ redirect_from: - /articles/converting-a-public-repo-to-a-private-repo/ - /articles/setting-repository-visibility - /github/administering-a-repository/setting-repository-visibility + - /github/administering-a-repository/managing-repository-settings/setting-repository-visibility versions: fpt: '*' ghes: '*' @@ -89,4 +90,4 @@ For information about improving repository security, see "[Securing your reposit ## Further reading -- "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility)" +- "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)" diff --git a/content/github/administering-a-repository/releasing-projects-on-github/about-releases.md b/content/repositories/releasing-projects-on-github/about-releases.md similarity index 97% rename from content/github/administering-a-repository/releasing-projects-on-github/about-releases.md rename to content/repositories/releasing-projects-on-github/about-releases.md index e9586e5adc..dc014f7585 100644 --- a/content/github/administering-a-repository/releasing-projects-on-github/about-releases.md +++ b/content/repositories/releasing-projects-on-github/about-releases.md @@ -8,6 +8,7 @@ redirect_from: - /articles/getting-the-download-count-for-your-releases - /github/administering-a-repository/getting-the-download-count-for-your-releases - /github/administering-a-repository/about-releases + - /github/administering-a-repository/releasing-projects-on-github/about-releases versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/releasing-projects-on-github/automation-for-release-forms-with-query-parameters.md b/content/repositories/releasing-projects-on-github/automation-for-release-forms-with-query-parameters.md similarity index 95% rename from content/github/administering-a-repository/releasing-projects-on-github/automation-for-release-forms-with-query-parameters.md rename to content/repositories/releasing-projects-on-github/automation-for-release-forms-with-query-parameters.md index 687002fe25..c82db87424 100644 --- a/content/github/administering-a-repository/releasing-projects-on-github/automation-for-release-forms-with-query-parameters.md +++ b/content/repositories/releasing-projects-on-github/automation-for-release-forms-with-query-parameters.md @@ -4,6 +4,7 @@ intro: 'To quickly create releases by auto-populating the new release form with redirect_from: - /articles/automation-for-release-forms-with-query-parameters - /github/administering-a-repository/automation-for-release-forms-with-query-parameters + - /github/administering-a-repository/releasing-projects-on-github/automation-for-release-forms-with-query-parameters versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/releasing-projects-on-github/comparing-releases.md b/content/repositories/releasing-projects-on-github/comparing-releases.md similarity index 90% rename from content/github/administering-a-repository/releasing-projects-on-github/comparing-releases.md rename to content/repositories/releasing-projects-on-github/comparing-releases.md index dcf989a79d..5f3e0b5373 100644 --- a/content/github/administering-a-repository/releasing-projects-on-github/comparing-releases.md +++ b/content/repositories/releasing-projects-on-github/comparing-releases.md @@ -10,6 +10,7 @@ topics: - Repositories redirect_from: - /github/administering-a-repository/comparing-releases + - /github/administering-a-repository/releasing-projects-on-github/comparing-releases --- {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.releases %} diff --git a/content/github/administering-a-repository/releasing-projects-on-github/index.md b/content/repositories/releasing-projects-on-github/index.md similarity index 89% rename from content/github/administering-a-repository/releasing-projects-on-github/index.md rename to content/repositories/releasing-projects-on-github/index.md index 4839987267..14d8bc84fc 100644 --- a/content/github/administering-a-repository/releasing-projects-on-github/index.md +++ b/content/repositories/releasing-projects-on-github/index.md @@ -4,6 +4,7 @@ intro: 'You can create a release to package software, release notes, and binary redirect_from: - /categories/85/articles/ - /categories/releases/ + - /github/administering-a-repository/releasing-projects-on-github versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/releasing-projects-on-github/linking-to-releases.md b/content/repositories/releasing-projects-on-github/linking-to-releases.md similarity index 90% rename from content/github/administering-a-repository/releasing-projects-on-github/linking-to-releases.md rename to content/repositories/releasing-projects-on-github/linking-to-releases.md index f7165ea51b..dccbafff7d 100644 --- a/content/github/administering-a-repository/releasing-projects-on-github/linking-to-releases.md +++ b/content/repositories/releasing-projects-on-github/linking-to-releases.md @@ -4,6 +4,7 @@ intro: You can share every release you create on GitHub with a unique URL. redirect_from: - /articles/linking-to-releases - /github/administering-a-repository/linking-to-releases + - /github/administering-a-repository/releasing-projects-on-github/linking-to-releases versions: fpt: '*' ghes: '*' diff --git a/content/github/administering-a-repository/releasing-projects-on-github/managing-releases-in-a-repository.md b/content/repositories/releasing-projects-on-github/managing-releases-in-a-repository.md similarity index 98% rename from content/github/administering-a-repository/releasing-projects-on-github/managing-releases-in-a-repository.md rename to content/repositories/releasing-projects-on-github/managing-releases-in-a-repository.md index df2db8dd36..cc2628e23d 100644 --- a/content/github/administering-a-repository/releasing-projects-on-github/managing-releases-in-a-repository.md +++ b/content/repositories/releasing-projects-on-github/managing-releases-in-a-repository.md @@ -9,6 +9,7 @@ redirect_from: - /github/administering-a-repository/creating-releases - /github/administering-a-repository/editing-and-deleting-releases - /github/administering-a-repository/managing-releases-in-a-repository + - /github/administering-a-repository/releasing-projects-on-github/managing-releases-in-a-repository permissions: 'Repository collaborators and people with write access to a repository can create, edit, and delete a release.' versions: fpt: '*' diff --git a/content/github/administering-a-repository/releasing-projects-on-github/viewing-your-repositorys-releases-and-tags.md b/content/repositories/releasing-projects-on-github/viewing-your-repositorys-releases-and-tags.md similarity index 92% rename from content/github/administering-a-repository/releasing-projects-on-github/viewing-your-repositorys-releases-and-tags.md rename to content/repositories/releasing-projects-on-github/viewing-your-repositorys-releases-and-tags.md index d15f57e53e..0ecb8b806e 100644 --- a/content/github/administering-a-repository/releasing-projects-on-github/viewing-your-repositorys-releases-and-tags.md +++ b/content/repositories/releasing-projects-on-github/viewing-your-repositorys-releases-and-tags.md @@ -6,6 +6,7 @@ redirect_from: - /articles/viewing-your-repositorys-tags - /github/administering-a-repository/viewing-your-repositorys-tags - /github/administering-a-repository/viewing-your-repositorys-releases-and-tags + - /github/administering-a-repository/releasing-projects-on-github/viewing-your-repositorys-releases-and-tags versions: fpt: '*' ghes: '*' diff --git a/content/github/visualizing-repository-data-with-graphs/accessing-basic-repository-data/about-repository-graphs.md b/content/repositories/viewing-activity-and-data-for-your-repository/about-repository-graphs.md similarity index 78% rename from content/github/visualizing-repository-data-with-graphs/accessing-basic-repository-data/about-repository-graphs.md rename to content/repositories/viewing-activity-and-data-for-your-repository/about-repository-graphs.md index 84028f731b..1337718b2d 100644 --- a/content/github/visualizing-repository-data-with-graphs/accessing-basic-repository-data/about-repository-graphs.md +++ b/content/repositories/viewing-activity-and-data-for-your-repository/about-repository-graphs.md @@ -5,6 +5,7 @@ redirect_from: - /articles/using-graphs/ - /articles/about-repository-graphs - /github/visualizing-repository-data-with-graphs/about-repository-graphs + - /github/visualizing-repository-data-with-graphs/accessing-basic-repository-data/about-repository-graphs versions: fpt: '*' ghes: '*' @@ -26,10 +27,4 @@ Some repository graphs are available only in public repositories with {% data va All other repository graphs are available in all repositories. Every repository graph is available in public and private repositories with {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, and {% data variables.product.prodname_ghe_cloud %}. {% data reusables.gated-features.more-info %} -{% endif %} - -## Further reading - -- "[Accessing basic repository data](/articles/accessing-basic-repository-data)" -- "[Analyzing changes to a repository's content](/articles/analyzing-changes-to-a-repository-s-content)" -- "[Understanding connections between repositories](/articles/understanding-connections-between-repositories)" +{% endif %} \ No newline at end of file diff --git a/content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/about-the-dependency-graph.md b/content/repositories/viewing-activity-and-data-for-your-repository/about-the-dependency-graph.md similarity index 97% rename from content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/about-the-dependency-graph.md rename to content/repositories/viewing-activity-and-data-for-your-repository/about-the-dependency-graph.md index 5d263c17f8..27ede81180 100644 --- a/content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/about-the-dependency-graph.md +++ b/content/repositories/viewing-activity-and-data-for-your-repository/about-the-dependency-graph.md @@ -7,6 +7,7 @@ topics: - Repositories redirect_from: - /github/visualizing-repository-data-with-graphs/about-the-dependency-graph + - /github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/about-the-dependency-graph shortTitle: Dependency graph --- diff --git a/content/repositories/viewing-activity-and-data-for-your-repository/analyzing-changes-to-a-repositorys-content.md b/content/repositories/viewing-activity-and-data-for-your-repository/analyzing-changes-to-a-repositorys-content.md new file mode 100644 index 0000000000..753d86afb7 --- /dev/null +++ b/content/repositories/viewing-activity-and-data-for-your-repository/analyzing-changes-to-a-repositorys-content.md @@ -0,0 +1,59 @@ +--- +title: Analyzing changes to a repository's content +intro: "You can see the changes to the content of a repository by analyzing the repository's commits, commit frequency, and content additions and deletions." +product: '{% data reusables.gated-features.repository-insights %}' +redirect_from: + - /articles/visualizing-additions-and-deletions-to-content-in-a-repository + - /github/visualizing-repository-data-with-graphs/visualizing-additions-and-deletions-to-content-in-a-repository + - /articles/viewing-commit-frequency-in-a-repository + - /articles/analyzing-changes-to-a-repository-s-content + - /articles/analyzing-changes-to-a-repositorys-content + - /articles/visualizing-commits-in-a-repository + - /github/visualizing-repository-data-with-graphs/visualizing-commits-in-a-repository + - /github/visualizing-repository-data-with-graphs/analyzing-changes-to-a-repositorys-content + - /github/visualizing-repository-data-with-graphs/analyzing-changes-to-a-repositorys-content/visualizing-commits-in-a-repository + - /github/visualizing-repository-data-with-graphs/analyzing-changes-to-a-repositorys-content/visualizing-additions-and-deletions-to-content-in-a-repository +versions: + fpt: '*' + ghes: '*' + ghae: '*' +topics: + - Repositories +shortTitle: Analyze changes +--- + +## Visualizing commits in a repository + +You can see all commits made to a repository in the past year (excluding merge commits) in the Commit graph. + +The top graph shows commits for the entire year by week. + +![Repository commit year graph](/assets/images/help/graphs/repo_commit_activity_year_graph.png) + +The bottom graph shows the average number of commits by day of the week for the selected week. + +![Repository commit week graph](/assets/images/help/graphs/repo_commit_activity_week_graph.png) + +### Accessing the commits graph + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.accessing-repository-graphs %} +3. In the left sidebar, click **Commits**. +![Commits tab](/assets/images/help/graphs/commits_tab.png) + +## Visualizing additions and deletion to content in a repository + +The code frequency graph displays the content additions and deletions for each week in a repository's history. + +{% ifversion fpt %} + +![Code frequency graph](/assets/images/help/graphs/repo_code_frequency_graph_dotcom.png) + +{% endif %} + +### Accessing the code frequency graph + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.accessing-repository-graphs %} +3. In the left sidebar, click **Code frequency**. +![Code frequency tab](/assets/images/help/graphs/code_frequency_tab.png) diff --git a/content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/exploring-the-dependencies-of-a-repository.md b/content/repositories/viewing-activity-and-data-for-your-repository/exploring-the-dependencies-of-a-repository.md similarity index 93% rename from content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/exploring-the-dependencies-of-a-repository.md rename to content/repositories/viewing-activity-and-data-for-your-repository/exploring-the-dependencies-of-a-repository.md index 97e99aea6b..c5dd50c20a 100644 --- a/content/github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/exploring-the-dependencies-of-a-repository.md +++ b/content/repositories/viewing-activity-and-data-for-your-repository/exploring-the-dependencies-of-a-repository.md @@ -7,6 +7,7 @@ topics: - Repositories redirect_from: - /github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository + - /github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/exploring-the-dependencies-of-a-repository shortTitle: Explore dependencies --- diff --git a/content/repositories/viewing-activity-and-data-for-your-repository/index.md b/content/repositories/viewing-activity-and-data-for-your-repository/index.md new file mode 100644 index 0000000000..79ba712829 --- /dev/null +++ b/content/repositories/viewing-activity-and-data-for-your-repository/index.md @@ -0,0 +1,28 @@ +--- +title: Viewing activity and data for your repository +intro: 'Gain insight into your repository by viewing activity and data.' +redirect_from: + - /categories/44/articles + - /categories/graphs-and-contributions + - /categories/graphs + - /categories/visualizing-repository-data-with-graphs + - /github/visualizing-repository-data-with-graphs +versions: + fpt: '*' + ghes: '*' + ghae: '*' +topics: + - Repositories +children: + - /viewing-deployment-activity-for-your-repository + - /about-repository-graphs + - /viewing-a-summary-of-repository-activity + - /viewing-traffic-to-a-repository + - /viewing-a-projects-contributors + - /analyzing-changes-to-a-repositorys-content + - /understanding-connections-between-repositories + - /about-the-dependency-graph + - /exploring-the-dependencies-of-a-repository +shortTitle: View activity and data +--- + diff --git a/content/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories.md b/content/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories.md new file mode 100644 index 0000000000..018935cbc7 --- /dev/null +++ b/content/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories.md @@ -0,0 +1,78 @@ +--- +title: Understanding connections between repositories +intro: "You can better understand the connections that exist between repositories by viewing a repository's network and forks and the projects that depend on the repository." +redirect_from: + - /articles/viewing-a-repository-s-network + - /articles/viewing-a-repositorys-network + - /github/visualizing-repository-data-with-graphs/viewing-a-repositorys-network + - /articles/understanding-connections-between-repositories + - /articles/listing-the-forks-of-a-repository + - /github/visualizing-repository-data-with-graphs/listing-the-forks-of-a-repository + - /github/visualizing-repository-data-with-graphs/viewing-the-dependencies-of-a-repository + - /github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories + - /github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/viewing-a-repositorys-network + - /github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/listing-the-forks-of-a-repository + - /github/visualizing-repository-data-with-graphs/understanding-connections-between-repositories/viewing-the-dependencies-of-a-repository +versions: + fpt: '*' + ghes: '*' + ghae: '*' +topics: + - Repositories +shortTitle: Connections between repositories +--- + +## Viewing a repository's network + +'The network graph displays the branch history of the entire repository network, including branches of the root repository and branches of forks that contain commits unique to the network.' +product: '{% data reusables.gated-features.repository-insights %}' + +![Repository network graph](/assets/images/help/graphs/repo_network_graph.png) + +{% tip %} + +**Tip:** To see older branches, click and drag within the graph. + +{% endtip %} + +## Accessing the network graph + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.accessing-repository-graphs %} +3. In the left sidebar, click **Network**. +![Network tab](/assets/images/help/graphs/network_tab.png) + +## Listing the forks of a repository + +The Members graph displays all the forks of a repository. + +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. + +{% ifversion fpt %} + +![Repository members graph](/assets/images/help/graphs/repo_forks_graph_dotcom.png) + +{% else %} + +![Repository members graph](/assets/images/help/graphs/repo_members_graph.png) + +{% endif %} + +### Accessing the Members graph + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.accessing-repository-graphs %} +3. In the left sidebar, click **Forks**. +![Forks tab](/assets/images/help/graphs/graphs-sidebar-forks-tab.png) + +{% ifversion fpt or ghes > 2.22 %} +## Viewing the dependencies of a repository + +You can use the dependency graph to explore the code your repository depends on. + +Almost all software relies on code developed and maintained by other developers, often known as a supply chain. For example, utilities, libraries, and frameworks. These dependencies are an integral part of your code and any bugs or vulnerabilities in them may affect your code. It's important to review and maintain these dependencies. + +The dependency graph provides a great way to visualize and explore the dependencies for a repository. For more information, see "[About the dependency graph](/code-security/supply-chain-security/about-the-dependency-graph)" and "[Exploring the dependencies of a repository](/code-security/supply-chain-security/exploring-the-dependencies-of-a-repository)." + +You can also set up your repository so that {% data variables.product.company_short %} alerts you automatically whenever a security vulnerability is found in one of your dependencies. 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/content/github/visualizing-repository-data-with-graphs/accessing-basic-repository-data/viewing-a-projects-contributors.md b/content/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors.md similarity index 96% rename from content/github/visualizing-repository-data-with-graphs/accessing-basic-repository-data/viewing-a-projects-contributors.md rename to content/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors.md index 69f974751d..8966d5e672 100644 --- a/content/github/visualizing-repository-data-with-graphs/accessing-basic-repository-data/viewing-a-projects-contributors.md +++ b/content/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors.md @@ -6,6 +6,7 @@ redirect_from: - /articles/viewing-contribution-activity-in-a-repository/ - /articles/viewing-a-projects-contributors - /github/visualizing-repository-data-with-graphs/viewing-a-projects-contributors + - /github/visualizing-repository-data-with-graphs/accessing-basic-repository-data/viewing-a-projects-contributors product: '{% data reusables.gated-features.repository-insights %}' versions: fpt: '*' diff --git a/content/github/visualizing-repository-data-with-graphs/accessing-basic-repository-data/viewing-a-summary-of-repository-activity.md b/content/repositories/viewing-activity-and-data-for-your-repository/viewing-a-summary-of-repository-activity.md similarity index 60% rename from content/github/visualizing-repository-data-with-graphs/accessing-basic-repository-data/viewing-a-summary-of-repository-activity.md rename to content/repositories/viewing-activity-and-data-for-your-repository/viewing-a-summary-of-repository-activity.md index f56e9edc9d..27fb1688d2 100644 --- a/content/github/visualizing-repository-data-with-graphs/accessing-basic-repository-data/viewing-a-summary-of-repository-activity.md +++ b/content/repositories/viewing-activity-and-data-for-your-repository/viewing-a-summary-of-repository-activity.md @@ -1,10 +1,11 @@ --- title: Viewing a summary of repository activity -intro: 'You can view an overview of a repository''s activity through Pulse. Pulse includes a list of open and merged pull requests, open and closed issues, and a graph showing the commit activity for the top 15 users who committed to the default branch of the project in the selected [time period](/articles/viewing-a-summary-of-repository-activity#filtering-by-time).' +intro: "You can view an overview of a repository's pull request, issue, and commit activity." product: '{% data reusables.gated-features.repository-insights %}' redirect_from: - /articles/viewing-a-summary-of-repository-activity - /github/visualizing-repository-data-with-graphs/viewing-a-summary-of-repository-activity + - /github/visualizing-repository-data-with-graphs/accessing-basic-repository-data/viewing-a-summary-of-repository-activity versions: fpt: '*' ghes: '*' @@ -13,9 +14,14 @@ topics: - Repositories shortTitle: View repository activity --- + +## About Pulse + +You can view an overview of a repository's activity through Pulse. Pulse includes a list of open and merged pull requests, open and closed issues, and a graph showing the commit activity for the top 15 users who committed to the default branch of the project in the selected [time period](/articles/viewing-a-summary-of-repository-activity#filtering-by-time). + 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. -## Accessing pulse +## Accessing Pulse {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.accessing-repository-graphs %} @@ -24,4 +30,4 @@ Commit co-authors are included in the commit activity summary if their commits w By default, Pulse shows the last seven days of repository activity. To choose a different time period, click the **Period** dropdown in the upper-right corner of the Pulse overview. -![Filtering Pulse activity by time](/assets/images/help/pulse/pulse_time_filter_dropdown.png) +![Filtering Pulse activity by time](/assets/images/help/pulse/pulse_time_filter_dropdown.png) \ No newline at end of file diff --git a/content/github/administering-a-repository/managing-repository-settings/viewing-deployment-activity-for-your-repository.md b/content/repositories/viewing-activity-and-data-for-your-repository/viewing-deployment-activity-for-your-repository.md similarity index 92% rename from content/github/administering-a-repository/managing-repository-settings/viewing-deployment-activity-for-your-repository.md rename to content/repositories/viewing-activity-and-data-for-your-repository/viewing-deployment-activity-for-your-repository.md index f1da1d62fa..3ddfeff71c 100644 --- a/content/github/administering-a-repository/managing-repository-settings/viewing-deployment-activity-for-your-repository.md +++ b/content/repositories/viewing-activity-and-data-for-your-repository/viewing-deployment-activity-for-your-repository.md @@ -4,6 +4,7 @@ intro: You can view information about deployments for your entire repository or redirect_from: - /articles/viewing-deployment-activity-for-your-repository - /github/administering-a-repository/viewing-deployment-activity-for-your-repository + - /github/administering-a-repository/managing-repository-settings/viewing-deployment-activity-for-your-repository versions: fpt: '*' ghes: '*' diff --git a/content/github/visualizing-repository-data-with-graphs/accessing-basic-repository-data/viewing-traffic-to-a-repository.md b/content/repositories/viewing-activity-and-data-for-your-repository/viewing-traffic-to-a-repository.md similarity index 93% rename from content/github/visualizing-repository-data-with-graphs/accessing-basic-repository-data/viewing-traffic-to-a-repository.md rename to content/repositories/viewing-activity-and-data-for-your-repository/viewing-traffic-to-a-repository.md index e30f0a1c35..692f781636 100644 --- a/content/github/visualizing-repository-data-with-graphs/accessing-basic-repository-data/viewing-traffic-to-a-repository.md +++ b/content/repositories/viewing-activity-and-data-for-your-repository/viewing-traffic-to-a-repository.md @@ -5,12 +5,14 @@ product: 'This repository insights graph is available in public repositories wit redirect_from: - /articles/viewing-traffic-to-a-repository - /github/visualizing-repository-data-with-graphs/viewing-traffic-to-a-repository + - /github/visualizing-repository-data-with-graphs/accessing-basic-repository-data/viewing-traffic-to-a-repository versions: fpt: '*' topics: - Repositories -shortTitle: View traffic to a repository +shortTitle: View repository traffic --- + You can navigate to referring sites, excluding search engines and {% data variables.product.product_name %} itself, from the links the specific paths were referred from. The popular content links to the specific content that generated traffic. Referring sites and popular content are ordered by views and unique visitors. Full clones and visitor information update hourly, while referring sites and popular content sections update daily. All data in the traffic graph uses the UTC+0 timezone, regardless of your location. diff --git a/content/repositories/working-with-files/index.md b/content/repositories/working-with-files/index.md new file mode 100644 index 0000000000..d5e323b6ea --- /dev/null +++ b/content/repositories/working-with-files/index.md @@ -0,0 +1,21 @@ +--- +title: Working with files +intro: 'Learn how to manage and use files in repositories.' +redirect_from: + - /categories/81/articles/ + - /categories/manipulating-files/ + - /categories/managing-files-in-a-repository + - /github/managing-files-in-a-repository +versions: + fpt: '*' + ghes: '*' + ghae: '*' +topics: + - Repositories +children: + - /managing-files + - /using-files + - /managing-large-files +shortTitle: Work with files +--- + diff --git a/content/repositories/working-with-files/managing-files/adding-a-file-to-a-repository.md b/content/repositories/working-with-files/managing-files/adding-a-file-to-a-repository.md new file mode 100644 index 0000000000..2c1635a128 --- /dev/null +++ b/content/repositories/working-with-files/managing-files/adding-a-file-to-a-repository.md @@ -0,0 +1,74 @@ +--- +title: Adding a file to a repository +intro: 'You can upload and commit an existing file to a repository on {% data variables.product.product_name %} or by using the command line.' +redirect_from: + - /articles/adding-a-file-to-a-repository + - /github/managing-files-in-a-repository/adding-a-file-to-a-repository + - /articles/adding-a-file-to-a-repository-from-the-command-line + - /articles/adding-a-file-to-a-repository-using-the-command-line + - /github/managing-files-in-a-repository/adding-a-file-to-a-repository-using-the-command-line + - /github/managing-files-in-a-repository/managing-files-on-github/adding-a-file-to-a-repository + - /github/managing-files-in-a-repository/managing-files-using-the-command-line/adding-a-file-to-a-repository-using-the-command-line +versions: + fpt: '*' + ghes: '*' + ghae: '*' +topics: + - Repositories +shortTitle: Add a file +--- + +## Adding a file to a repository on {% data variables.product.product_name %} + +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](#adding-a-file-to-a-repository-using-the-command-line)." + +{% tip %} + +**Tips:** +- You can upload multiple files to {% data variables.product.product_name %} at the same time. +- {% data reusables.repositories.protected-branches-block-web-edits-uploads %} + +{% endtip %} + +{% data reusables.repositories.navigate-to-repo %} +2. Above the list of files, using the **Add file** drop-down, click **Upload files**. + !["Upload files" in the "Add file" dropdown](/assets/images/help/repository/upload-files-button.png) +3. Drag and drop the file or folder you'd like to upload to your repository onto the file tree. +![Drag and drop area](/assets/images/help/repository/upload-files-drag-and-drop.png) +{% data reusables.files.write_commit_message %} +{% data reusables.files.choose_commit_branch %} +6. Click **Commit changes**. +![Commit changes button](/assets/images/help/repository/commit-changes-button.png) + +## Adding a file to a repository using the command line + +You can upload an existing file to a {% data variables.product.product_name %} repository using the command line. + +{% tip %} + +**Tip:** You can also [add an existing file to a repository from the {% data variables.product.product_name %} website](/articles/adding-a-file-to-a-repository). + +{% endtip %} + +{% data reusables.command_line.manipulating_file_prereqs %} + +{% data reusables.repositories.sensitive-info-warning %} + +1. On your computer, move the file you'd like to upload to {% data variables.product.product_name %} into the local directory that was created when you cloned the repository. +{% data reusables.command_line.open_the_multi_os_terminal %} +{% data reusables.command_line.switching_directories_procedural %} +{% data reusables.git.stage_for_commit %} + ```shell + $ git add . + # Adds the file to your local repository and stages it for commit. {% data reusables.git.unstage-codeblock %} + ``` +{% data reusables.git.commit-file %} + ```shell + $ git commit -m "Add existing file" + # Commits the tracked changes and prepares them to be pushed to a remote repository. {% data reusables.git.reset-head-to-previous-commit-codeblock %} + ``` +{% data reusables.git.git-push %} + +## Further reading + +- "[Adding an existing project to GitHub using the command line](/articles/adding-an-existing-project-to-github-using-the-command-line)" diff --git a/content/github/managing-files-in-a-repository/managing-files-on-github/creating-new-files.md b/content/repositories/working-with-files/managing-files/creating-new-files.md similarity index 87% rename from content/github/managing-files-in-a-repository/managing-files-on-github/creating-new-files.md rename to content/repositories/working-with-files/managing-files/creating-new-files.md index 987b2e5544..ecca7cca08 100644 --- a/content/github/managing-files-in-a-repository/managing-files-on-github/creating-new-files.md +++ b/content/repositories/working-with-files/managing-files/creating-new-files.md @@ -4,6 +4,7 @@ intro: 'You can create new files directly on {% data variables.product.product_n redirect_from: - /articles/creating-new-files - /github/managing-files-in-a-repository/creating-new-files + - /github/managing-files-in-a-repository/managing-files-on-github/creating-new-files versions: fpt: '*' ghes: '*' @@ -30,9 +31,4 @@ When creating a file on {% data variables.product.product_name %}, consider the {% data reusables.files.write_commit_message %} {% data reusables.files.choose-commit-email %} {% data reusables.files.choose_commit_branch %} -{% data reusables.files.propose_new_file %} - -## Further reading - -- "[Adding a file to a repository](/articles/adding-a-file-to-a-repository)" -- "[Adding a file to a repository using the command line](/articles/adding-a-file-to-a-repository-using-the-command-line)" +{% data reusables.files.propose_new_file %} \ No newline at end of file diff --git a/content/github/administering-a-repository/managing-repository-settings/customizing-how-changed-files-appear-on-github.md b/content/repositories/working-with-files/managing-files/customizing-how-changed-files-appear-on-github.md similarity index 92% rename from content/github/administering-a-repository/managing-repository-settings/customizing-how-changed-files-appear-on-github.md rename to content/repositories/working-with-files/managing-files/customizing-how-changed-files-appear-on-github.md index b0411f6e79..59375927d5 100644 --- a/content/github/administering-a-repository/managing-repository-settings/customizing-how-changed-files-appear-on-github.md +++ b/content/repositories/working-with-files/managing-files/customizing-how-changed-files-appear-on-github.md @@ -4,6 +4,7 @@ intro: 'To keep certain files from displaying in diffs by default, or counting t redirect_from: - /articles/customizing-how-changed-files-appear-on-github - /github/administering-a-repository/customizing-how-changed-files-appear-on-github + - /github/administering-a-repository/managing-repository-settings/customizing-how-changed-files-appear-on-github versions: fpt: '*' ghes: '*' diff --git a/content/github/managing-files-in-a-repository/managing-files-on-github/deleting-files-in-a-repository.md b/content/repositories/working-with-files/managing-files/deleting-files-in-a-repository.md similarity index 96% rename from content/github/managing-files-in-a-repository/managing-files-on-github/deleting-files-in-a-repository.md rename to content/repositories/working-with-files/managing-files/deleting-files-in-a-repository.md index 8daacce7a6..194d4dfdb2 100644 --- a/content/github/managing-files-in-a-repository/managing-files-on-github/deleting-files-in-a-repository.md +++ b/content/repositories/working-with-files/managing-files/deleting-files-in-a-repository.md @@ -6,6 +6,7 @@ redirect_from: - /github/managing-files-in-a-repository/deleting-files - /github/managing-files-in-a-repository/deleting-a-file-or-directory - /github/managing-files-in-a-repository/deleting-files-in-a-repository + - /github/managing-files-in-a-repository/managing-files-on-github/deleting-files-in-a-repository versions: fpt: '*' ghes: '*' diff --git a/content/repositories/working-with-files/managing-files/editing-files.md b/content/repositories/working-with-files/managing-files/editing-files.md new file mode 100644 index 0000000000..087dcc1eca --- /dev/null +++ b/content/repositories/working-with-files/managing-files/editing-files.md @@ -0,0 +1,61 @@ +--- +title: Editing files +intro: 'You can edit files directly on {% data variables.product.product_name %} in any of your repositories using the file editor.' +redirect_from: + - /articles/editing-files/ + - /articles/editing-files-in-your-repository + - /github/managing-files-in-a-repository/editing-files-in-your-repository + - /articles/editing-files-in-another-user-s-repository + - /github/managing-files-in-a-repository/editing-files-in-another-users-repository + - /github/managing-files-in-a-repository/managing-files-on-github/editing-files-in-your-repository + - /github/managing-files-in-a-repository/managing-files-on-github/editing-files-in-another-users-repository +versions: + fpt: '*' + ghes: '*' + ghae: '*' +topics: + - Repositories +shortTitle: Edit files +--- + +## Editing files in your repository + +{% tip %} + +**Tip**: {% data reusables.repositories.protected-branches-block-web-edits-uploads %} + +{% endtip %} + +{% note %} + +**Note:** {% data variables.product.product_name %}'s file editor uses [CodeMirror](https://codemirror.net/). + +{% endnote %} + +1. In your repository, browse to the file you want to edit. +{% data reusables.repositories.edit-file %} +3. On the **Edit file** tab, make any changes you need to the file. +![New content in file](/assets/images/help/repository/edit-readme-light.png) +{% data reusables.files.preview_change %} +{% data reusables.files.write_commit_message %} +{% data reusables.files.choose-commit-email %} +{% data reusables.files.choose_commit_branch %} +{% data reusables.files.propose_file_change %} + +## Editing files in another user's repository + +When you edit a file in another user's repository, we'll automatically [fork the repository](/articles/fork-a-repo) and [open a pull request](/articles/creating-a-pull-request) for you. + +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. +2. Above the file content, click {% octicon "pencil" aria-label="The edit icon" %}. At this point, GitHub forks the repository for you. +3. Make any changes you need to the file. +![New content in file](/assets/images/help/repository/edit-readme-light.png) +{% data reusables.files.preview_change %} +{% data reusables.files.write_commit_message %} +{% data reusables.files.choose-commit-email %} +6. Click **Propose file change**. +![Commit Changes button](/assets/images/help/repository/propose_file_change_button.png) +7. Type a title and description for your pull request. +![Pull Request description page](/assets/images/help/pull_requests/pullrequest-description.png) +8. Click **Create pull request**. +![Pull Request button](/assets/images/help/pull_requests/pullrequest-send.png) \ No newline at end of file diff --git a/content/repositories/working-with-files/managing-files/index.md b/content/repositories/working-with-files/managing-files/index.md new file mode 100644 index 0000000000..c904a83ac7 --- /dev/null +++ b/content/repositories/working-with-files/managing-files/index.md @@ -0,0 +1,23 @@ +--- +title: Managing files +intro: 'You can create, edit, move, and delete files in a repository, directly on {% data variables.product.product_name %} or on the command line.' +redirect_from: + - /articles/managing-files-on-github + - /github/managing-files-in-a-repository/managing-files-on-github + - /github/managing-files-in-a-repository/managing-files-using-the-command-line +versions: + fpt: '*' + ghes: '*' + ghae: '*' +topics: + - Repositories +children: + - /creating-new-files + - /adding-a-file-to-a-repository + - /moving-a-file-to-a-new-location + - /editing-files + - /renaming-a-file + - /deleting-files-in-a-repository + - /customizing-how-changed-files-appear-on-github +--- + diff --git a/content/repositories/working-with-files/managing-files/moving-a-file-to-a-new-location.md b/content/repositories/working-with-files/managing-files/moving-a-file-to-a-new-location.md new file mode 100644 index 0000000000..6addae1bef --- /dev/null +++ b/content/repositories/working-with-files/managing-files/moving-a-file-to-a-new-location.md @@ -0,0 +1,93 @@ +--- +title: Moving a file to a new location +intro: 'You can move a file to a different directory on {% data variables.product.product_name %} or by using the command line.' +redirect_from: + - /articles/moving-a-file-to-a-new-location + - /github/managing-files-in-a-repository/moving-a-file-to-a-new-location + - /articles/moving-a-file-to-a-new-location-using-the-command-line + - /github/managing-files-in-a-repository/moving-a-file-to-a-new-location-using-the-command-line + - /github/managing-files-in-a-repository/managing-files-on-github/moving-a-file-to-a-new-location + - /github/managing-files-in-a-repository/managing-files-using-the-command-line/moving-a-file-to-a-new-location-using-the-command-line +versions: + fpt: '*' + ghes: '*' + ghae: '*' +topics: + - Repositories +shortTitle: Move a file +--- +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. + +## Moving a file to a new location on {% data variables.product.product_name %} + +{% tip %} + +**Tips**: + +- If you try to move a file in a repository that you don’t have access to, we'll fork the project to your user account and help you send [a pull request](/articles/about-pull-requests) to the original repository after you commit your change. +- Some files, such as images, require that you move them from the command line. For more information, see "[Moving a file to a new location using the command line](/articles/moving-a-file-to-a-new-location-using-the-command-line)". +- {% data reusables.repositories.protected-branches-block-web-edits-uploads %} + +{% endtip %} + +1. In your repository, browse to the file you want to move. +2. In the upper right corner of the file view, click {% octicon "pencil" aria-label="The edit icon" %} to open the file editor. +![Edit file icon](/assets/images/help/repository/move-file-edit-file-icon.png) +3. In the filename field, change the name of the file using these guidelines: + ![Editing a file name](/assets/images/help/repository/moving_files.gif) + - To move the file **into a subfolder**, type the name of the folder you want, followed by `/`. Your new folder name becomes a new item in the navigation breadcrumbs. + - To move the file into a directory **above the file's current location**, place your cursor at the beginning of the filename field, then either type `../` to jump up one full directory level, or type the `backspace` key to edit the parent folder's name. +{% data reusables.files.write_commit_message %} +{% data reusables.files.choose_commit_branch %} +{% data reusables.files.propose_file_change %} + +## Moving a file to a new location using the command line + +You can use the command line to move files within a repository by removing the file from the old location and then adding it in the new location. + +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. + +{% data reusables.command_line.manipulating_file_prereqs %} + +1. On your computer, move the file to a new location within the directory that was created locally on your computer when you cloned the repository. +{% data reusables.command_line.open_the_multi_os_terminal %} +3. Use `git status` to check the old and new file locations. + ```shell + $ git status + > # On branch your-branch + > # Changes not staged for commit: + > # (use "git add/rm ..." to update what will be committed) + > # (use "git checkout -- ..." to discard changes in working directory) + > # + > # deleted: /old-folder/image.png + > # + > # Untracked files: + > # (use "git add ..." to include in what will be committed) + > # + > # /new-folder/image.png + > # + > # no changes added to commit (use "git add" and/or "git commit -a") + ``` +{% data reusables.git.stage_for_commit %} This will delete, or `git rm`, the file from the old location and add, or `git add`, the file to the new location. + ```shell + $ git add . + # Adds the file to your local repository and stages it for commit. + # {% data reusables.git.unstage-codeblock %} + ``` +5. Use `git status` to check the changes staged for commit. + ```shell + $ git status + > # On branch your-branch + > # Changes to be committed: + > # (use "git reset HEAD ..." to unstage) + > # + > # renamed: /old-folder/image.png -> /new-folder/image.png + # Displays the changes staged for commit + ``` +{% data reusables.git.commit-file %} + ```shell + $ git commit -m "Move file to new directory" + # Commits the tracked changes and prepares them to be pushed to a remote repository. + # {% data reusables.git.reset-head-to-previous-commit-codeblock %} + ``` +{% data reusables.git.git-push %} diff --git a/content/repositories/working-with-files/managing-files/renaming-a-file.md b/content/repositories/working-with-files/managing-files/renaming-a-file.md new file mode 100644 index 0000000000..1188d84ece --- /dev/null +++ b/content/repositories/working-with-files/managing-files/renaming-a-file.md @@ -0,0 +1,73 @@ +--- +title: Renaming a file +intro: 'You can rename any file in your repository directly in {% data variables.product.product_name %} or by using the command line.' +redirect_from: + - /articles/renaming-a-file + - /github/managing-files-in-a-repository/renaming-a-file + - /articles/renaming-a-file-using-the-command-line + - /github/managing-files-in-a-repository/renaming-a-file-using-the-command-line + - /github/managing-files-in-a-repository/managing-files-on-github/renaming-a-file + - /github/managing-files-in-a-repository/managing-files-using-the-command-line/renaming-a-file-using-the-command-line +versions: + fpt: '*' + ghes: '*' + ghae: '*' +topics: + - Repositories +--- + +## Renaming a file on {% data variables.product.product_name %} + +Renaming a file also gives you the opportunity to [move the file to a new location](/articles/moving-a-file-to-a-new-location) + +{% tip %} + +**Tips**: + +- If you try to rename a file in a repository that you don’t have access to, we will fork the project to your user account and help you send [a pull request](/articles/about-pull-requests) to the original repository after you commit your change. +- File names created via the web interface can only contain alphanumeric characters and hyphens (`-`). To use other characters, create and commit the files locally and then push them to the repository. +- Some files, such as images, require that you rename them from the command line. For more information, see "[Renaming a file using the command line](/articles/renaming-a-file-using-the-command-line)." + +{% endtip %} + +1. In your repository, browse to the file you want to rename. +2. In the upper right corner of the file view, click {% octicon "pencil" aria-label="The edit icon" %} to open the file editor. +![Edit file icon](/assets/images/help/repository/edit-file-icon.png) +3. In the filename field, change the name of the file to the new filename you want. You can also update the contents of your file at the same time. +![Editing a file name](/assets/images/help/repository/changing-file-name.png) +{% data reusables.files.write_commit_message %} +{% data reusables.files.choose_commit_branch %} +{% data reusables.files.propose_file_change %} + +## Renaming a file using the command line + +You can use the command line to rename any file in your repository. + +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. + +{% data reusables.command_line.manipulating_file_prereqs %} + +{% data reusables.command_line.open_the_multi_os_terminal %} +{% data reusables.command_line.switching_directories_procedural %} +3. Rename the file, specifying the old file name and the new name you'd like to give the file. This will stage your change for commit. + ```shell + $ git mv old_filename new_filename + ``` +4. Use `git status` to check the old and new file names. + ```shell + $ git status + > # On branch your-branch + > # Changes to be committed: + > # (use "git reset HEAD ..." to unstage) + > # + > # renamed: old_filename -> new_filename + > # + ``` +{% data reusables.git.commit-file %} + ```shell + $ git commit -m "Rename file" + # Commits the tracked changes and prepares them to be pushed to a remote repository. + # {% data reusables.git.reset-head-to-previous-commit-codeblock %} + ``` +{% data reusables.git.git-push %} + diff --git a/content/github/managing-large-files/versioning-large-files/about-git-large-file-storage.md b/content/repositories/working-with-files/managing-large-files/about-git-large-file-storage.md similarity index 88% rename from content/github/managing-large-files/versioning-large-files/about-git-large-file-storage.md rename to content/repositories/working-with-files/managing-large-files/about-git-large-file-storage.md index a3d3fa1f49..91bafc7d23 100644 --- a/content/github/managing-large-files/versioning-large-files/about-git-large-file-storage.md +++ b/content/repositories/working-with-files/managing-large-files/about-git-large-file-storage.md @@ -1,16 +1,20 @@ --- title: About Git Large File Storage -intro: '{% data variables.large_files.product_name_short %} lets you push files to {% data variables.product.product_name %} that are larger than the Git push limit.' +intro: '{% data variables.product.product_name %} limits the size of files allowed in repositories. To track files beyond this limit, you can use {% data variables.large_files.product_name_long %}.' redirect_from: - /articles/about-large-file-storage/ - /articles/about-git-large-file-storage - /github/managing-large-files/about-git-large-file-storage + - /github/managing-large-files/versioning-large-files/about-git-large-file-storage versions: fpt: '*' ghes: '*' ghae: '*' shortTitle: Git Large File Storage --- + +## About {% data variables.large_files.product_name_long %} + {% 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. {% ifversion fpt %} diff --git a/content/repositories/working-with-files/managing-large-files/about-large-files-on-github.md b/content/repositories/working-with-files/managing-large-files/about-large-files-on-github.md new file mode 100644 index 0000000000..ef5b48cc28 --- /dev/null +++ b/content/repositories/working-with-files/managing-large-files/about-large-files-on-github.md @@ -0,0 +1,105 @@ +--- +title: About large files on GitHub +intro: '{% data variables.product.product_name %} limits the size of files you can track in regular Git repositories. Learn how to track or remove files that are beyond the limit.' +redirect_from: + - /articles/distributing-large-binaries + - /github/managing-large-files/distributing-large-binaries + - /github/managing-large-files/working-with-large-files/distributing-large-binaries + - /articles/removing-files-from-a-repository-s-history + - /articles/removing-files-from-a-repositorys-history + - /github/managing-large-files/removing-files-from-a-repositorys-history + - /github/managing-large-files/working-with-large-files/removing-files-from-a-repositorys-history + - /articles/conditions-for-large-files + - /github/managing-large-files/conditions-for-large-files + - /github/managing-large-files/working-with-large-files/conditions-for-large-files + - /articles/what-is-the-size-limit-for-a-repository/ + - /articles/what-is-my-disk-quota + - /github/managing-large-files/what-is-my-disk-quota + - /github/managing-large-files/working-with-large-files/what-is-my-disk-quota +versions: + fpt: '*' + ghes: '*' + ghae: '*' +shortTitle: Large files +--- + +## About size limits on {% data variables.product.product_name %} + +{% ifversion fpt %} +{% data variables.product.product_name %} tries to provide abundant storage for all Git repositories, although there are hard limits for file and repository sizes. To ensure performance and reliability for our users, we actively monitor signals of overall repository health. Repository health is a function of various interacting factors, including size, commit frequency, contents, and structure. + +### File size limits +{% endif %} + +{% data variables.product.product_name %} limits the size of files allowed in repositories. If you attempt to add or update a file that is larger than {% data variables.large_files.warning_size %}, you will receive a warning from Git. The changes will still successfully push to your repository, but you can consider removing the commit to minimize performance impact. For more information, see "[Removing files from a repository's history](#removing-files-from-a-repositorys-history)." + +{% note %} + +**Note:** If you add a file to a repository via a browser, the file can be no larger than {% data variables.large_files.max_github_browser_size %}. For more information, see "[Adding a file to a repository](/repositories/working-with-files/managing-files/adding-a-file-to-a-repository)." + +{% endnote %} + +{% ifversion ghes %}By default, {% endif %}{% data variables.product.product_name %} blocks pushes that exceed {% data variables.large_files.max_github_size %}. {% ifversion ghes %}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 %} + +To track files beyond this limit, you must use {% data variables.large_files.product_name_long %} ({% data variables.large_files.product_name_short %}). For more information, see "[About {% data variables.large_files.product_name_long %}](/repositories/working-with-files/managing-large-files/about-git-large-file-storage)." + +If you need to distribute large files within your repository, you can create releases on {% data variables.product.product_location %} instead of tracking the files. For more information, see "[Distributing large binaries](#distributing-large-binaries)." + +Git is not designed to handle large SQL files. To share large databases with other developers, we recommend using [Dropbox](https://www.dropbox.com/). + +{% ifversion fpt %} +### Repository size limits + +We recommend repositories remain small, ideally less than 1 GB, and less than 5 GB is strongly recommended. Smaller repositories are faster to clone and easier to work with and maintain. If your repository excessively impacts our infrastructure, you might receive an email from {% data variables.contact.github_support %} asking you to take corrective action. We try to be flexible, especially with large projects that have many collaborators, and will work with you to find a resolution whenever possible. You can prevent your repository from impacting our infrastructure by effectively managing your repository's size and overall health. You can find advice and a tool for repository analysis in the [`github/git-sizer`](https://github.com/github/git-sizer) repository. + +External dependencies can cause Git repositories to become very large. To avoid filling a repository with external dependencies, we recommend you use a package manager. Popular package managers for common languages include [Bundler](http://bundler.io/), [Node's Package Manager](http://npmjs.org/), and [Maven](http://maven.apache.org/). These package managers support using Git repositories directly, so you don't need pre-packaged sources. + +Git is not designed to serve as a backup tool. However, there are many solutions specifically designed for performing backups, such as [Arq](https://www.arqbackup.com/), [Carbonite](http://www.carbonite.com/), and [CrashPlan](https://www.crashplan.com/en-us/). +{% endif %} + +## Removing files from a repository's history + +{% warning %} + +**Warning**: These procedures will permanently remove files from the repository on your computer and {% data variables.product.product_location %}. If the file is important, make a local backup copy in a directory outside of the repository. + +{% endwarning %} + +### 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: + +{% data reusables.command_line.open_the_multi_os_terminal %} +{% data reusables.command_line.switching_directories_procedural %} +3. To remove the file, enter `git rm --cached`: + ```shell + $ git rm --cached giant_file + # Stage our giant file for removal, but leave it on disk + ``` +4. Commit this change using `--amend -CHEAD`: + ```shell + $ git commit --amend -CHEAD + # Amend the previous commit with your change + # Simply making a new commit won't work, as you need + # to remove the file from the unpushed history as well + ``` +5. Push your commits to {% data variables.product.product_location %}: + ```shell + $ 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)." + +## Distributing large binaries + +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)." + +{% ifversion fpt %} + +We don't limit the total size of the binary files in the release or the bandwidth used to deliver them. However, each individual file must be smaller than {% data variables.large_files.max_lfs_size %}. + +{% endif %} + diff --git a/content/github/managing-large-files/versioning-large-files/about-storage-and-bandwidth-usage.md b/content/repositories/working-with-files/managing-large-files/about-storage-and-bandwidth-usage.md similarity index 97% rename from content/github/managing-large-files/versioning-large-files/about-storage-and-bandwidth-usage.md rename to content/repositories/working-with-files/managing-large-files/about-storage-and-bandwidth-usage.md index 8ed3d6c19d..afc63d8584 100644 --- a/content/github/managing-large-files/versioning-large-files/about-storage-and-bandwidth-usage.md +++ b/content/repositories/working-with-files/managing-large-files/about-storage-and-bandwidth-usage.md @@ -6,6 +6,7 @@ redirect_from: - /articles/billing-plans-for-git-large-file-storage/ - /articles/about-storage-and-bandwidth-usage - /github/managing-large-files/about-storage-and-bandwidth-usage + - /github/managing-large-files/versioning-large-files/about-storage-and-bandwidth-usage versions: fpt: '*' shortTitle: Storage & bandwidth diff --git a/content/github/managing-large-files/versioning-large-files/collaboration-with-git-large-file-storage.md b/content/repositories/working-with-files/managing-large-files/collaboration-with-git-large-file-storage.md similarity index 96% rename from content/github/managing-large-files/versioning-large-files/collaboration-with-git-large-file-storage.md rename to content/repositories/working-with-files/managing-large-files/collaboration-with-git-large-file-storage.md index af6170b9cb..ac3c34c65c 100644 --- a/content/github/managing-large-files/versioning-large-files/collaboration-with-git-large-file-storage.md +++ b/content/repositories/working-with-files/managing-large-files/collaboration-with-git-large-file-storage.md @@ -5,6 +5,7 @@ redirect_from: - /articles/collaboration-with-large-file-storage/ - /articles/collaboration-with-git-large-file-storage - /github/managing-large-files/collaboration-with-git-large-file-storage + - /github/managing-large-files/versioning-large-files/collaboration-with-git-large-file-storage versions: fpt: '*' ghes: '*' diff --git a/content/github/managing-large-files/versioning-large-files/configuring-git-large-file-storage.md b/content/repositories/working-with-files/managing-large-files/configuring-git-large-file-storage.md similarity index 97% rename from content/github/managing-large-files/versioning-large-files/configuring-git-large-file-storage.md rename to content/repositories/working-with-files/managing-large-files/configuring-git-large-file-storage.md index 69ed09e4cc..a707424d0d 100644 --- a/content/github/managing-large-files/versioning-large-files/configuring-git-large-file-storage.md +++ b/content/repositories/working-with-files/managing-large-files/configuring-git-large-file-storage.md @@ -5,6 +5,7 @@ redirect_from: - /articles/configuring-large-file-storage/ - /articles/configuring-git-large-file-storage - /github/managing-large-files/configuring-git-large-file-storage + - /github/managing-large-files/versioning-large-files/configuring-git-large-file-storage versions: fpt: '*' ghes: '*' diff --git a/content/github/managing-large-files/versioning-large-files/index.md b/content/repositories/working-with-files/managing-large-files/index.md similarity index 58% rename from content/github/managing-large-files/versioning-large-files/index.md rename to content/repositories/working-with-files/managing-large-files/index.md index 04fcefad9c..f69698f46d 100644 --- a/content/github/managing-large-files/versioning-large-files/index.md +++ b/content/repositories/working-with-files/managing-large-files/index.md @@ -1,13 +1,19 @@ --- -title: Versioning large files -intro: '{% data reusables.enterprise_site_admin_settings.configuring-large-file-storage-short-description %}' +title: Managing large files +intro: You can manage large files with Git Large File Storage. redirect_from: + - /categories/managing-large-files + - /github/managing-large-files - /articles/versioning-large-files + - /github/managing-large-files/versioning-large-files + - /articles/working-with-large-files + - /github/managing-large-files/working-with-large-files versions: fpt: '*' ghes: '*' ghae: '*' children: + - /about-large-files-on-github - /about-git-large-file-storage - /installing-git-large-file-storage - /configuring-git-large-file-storage diff --git a/content/github/managing-large-files/versioning-large-files/installing-git-large-file-storage.md b/content/repositories/working-with-files/managing-large-files/installing-git-large-file-storage.md similarity index 98% rename from content/github/managing-large-files/versioning-large-files/installing-git-large-file-storage.md rename to content/repositories/working-with-files/managing-large-files/installing-git-large-file-storage.md index ec4387650c..4a2a42e486 100644 --- a/content/github/managing-large-files/versioning-large-files/installing-git-large-file-storage.md +++ b/content/repositories/working-with-files/managing-large-files/installing-git-large-file-storage.md @@ -5,6 +5,7 @@ redirect_from: - /articles/installing-large-file-storage/ - /articles/installing-git-large-file-storage - /github/managing-large-files/installing-git-large-file-storage + - /github/managing-large-files/versioning-large-files/installing-git-large-file-storage versions: fpt: '*' ghes: '*' diff --git a/content/github/managing-large-files/versioning-large-files/moving-a-file-in-your-repository-to-git-large-file-storage.md b/content/repositories/working-with-files/managing-large-files/moving-a-file-in-your-repository-to-git-large-file-storage.md similarity index 95% rename from content/github/managing-large-files/versioning-large-files/moving-a-file-in-your-repository-to-git-large-file-storage.md rename to content/repositories/working-with-files/managing-large-files/moving-a-file-in-your-repository-to-git-large-file-storage.md index 61272a0a86..208fb7b8d7 100644 --- a/content/github/managing-large-files/versioning-large-files/moving-a-file-in-your-repository-to-git-large-file-storage.md +++ b/content/repositories/working-with-files/managing-large-files/moving-a-file-in-your-repository-to-git-large-file-storage.md @@ -4,6 +4,7 @@ intro: 'If you''ve set up {% data variables.large_files.product_name_short %}, a redirect_from: - /articles/moving-a-file-in-your-repository-to-git-large-file-storage - /github/managing-large-files/moving-a-file-in-your-repository-to-git-large-file-storage + - /github/managing-large-files/versioning-large-files/moving-a-file-in-your-repository-to-git-large-file-storage versions: fpt: '*' ghes: '*' diff --git a/content/github/managing-large-files/versioning-large-files/removing-files-from-git-large-file-storage.md b/content/repositories/working-with-files/managing-large-files/removing-files-from-git-large-file-storage.md similarity index 97% rename from content/github/managing-large-files/versioning-large-files/removing-files-from-git-large-file-storage.md rename to content/repositories/working-with-files/managing-large-files/removing-files-from-git-large-file-storage.md index acc4030658..0988bb52cf 100644 --- a/content/github/managing-large-files/versioning-large-files/removing-files-from-git-large-file-storage.md +++ b/content/repositories/working-with-files/managing-large-files/removing-files-from-git-large-file-storage.md @@ -4,6 +4,7 @@ intro: 'If you''ve set up {% data variables.large_files.product_name_short %} fo redirect_from: - /articles/removing-files-from-git-large-file-storage - /github/managing-large-files/removing-files-from-git-large-file-storage + - /github/managing-large-files/versioning-large-files/removing-files-from-git-large-file-storage versions: fpt: '*' ghes: '*' diff --git a/content/github/managing-large-files/versioning-large-files/resolving-git-large-file-storage-upload-failures.md b/content/repositories/working-with-files/managing-large-files/resolving-git-large-file-storage-upload-failures.md similarity index 92% rename from content/github/managing-large-files/versioning-large-files/resolving-git-large-file-storage-upload-failures.md rename to content/repositories/working-with-files/managing-large-files/resolving-git-large-file-storage-upload-failures.md index 68a77bef8e..88a9424667 100644 --- a/content/github/managing-large-files/versioning-large-files/resolving-git-large-file-storage-upload-failures.md +++ b/content/repositories/working-with-files/managing-large-files/resolving-git-large-file-storage-upload-failures.md @@ -4,6 +4,7 @@ intro: 'If your {% data variables.large_files.product_name_short %} files didn'' redirect_from: - /articles/resolving-git-large-file-storage-upload-failures - /github/managing-large-files/resolving-git-large-file-storage-upload-failures + - /github/managing-large-files/versioning-large-files/resolving-git-large-file-storage-upload-failures versions: fpt: '*' ghes: '*' diff --git a/content/github/managing-files-in-a-repository/managing-files-on-github/getting-permanent-links-to-files.md b/content/repositories/working-with-files/using-files/getting-permanent-links-to-files.md similarity index 96% rename from content/github/managing-files-in-a-repository/managing-files-on-github/getting-permanent-links-to-files.md rename to content/repositories/working-with-files/using-files/getting-permanent-links-to-files.md index 6678a753ff..fddb90da2b 100644 --- a/content/github/managing-files-in-a-repository/managing-files-on-github/getting-permanent-links-to-files.md +++ b/content/repositories/working-with-files/using-files/getting-permanent-links-to-files.md @@ -6,6 +6,7 @@ redirect_from: - /articles/how-do-i-get-a-permanent-link-from-file-view-to-permanent-blob-url/ - /articles/getting-permanent-links-to-files - /github/managing-files-in-a-repository/getting-permanent-links-to-files + - /github/managing-files-in-a-repository/managing-files-on-github/getting-permanent-links-to-files versions: fpt: '*' ghes: '*' diff --git a/content/repositories/working-with-files/using-files/index.md b/content/repositories/working-with-files/using-files/index.md new file mode 100644 index 0000000000..896fefe26c --- /dev/null +++ b/content/repositories/working-with-files/using-files/index.md @@ -0,0 +1,14 @@ +--- +title: Using files +intro: 'You can navigate and track changes in the code in your files.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' +children: + - /navigating-code-on-github + - /tracking-changes-in-a-file + - /getting-permanent-links-to-files + - /working-with-non-code-files +--- + diff --git a/content/github/managing-files-in-a-repository/managing-files-on-github/navigating-code-on-github.md b/content/repositories/working-with-files/using-files/navigating-code-on-github.md similarity index 94% rename from content/github/managing-files-in-a-repository/managing-files-on-github/navigating-code-on-github.md rename to content/repositories/working-with-files/using-files/navigating-code-on-github.md index b07569d022..0e323ed39a 100644 --- a/content/github/managing-files-in-a-repository/managing-files-on-github/navigating-code-on-github.md +++ b/content/repositories/working-with-files/using-files/navigating-code-on-github.md @@ -4,6 +4,7 @@ intro: 'You can understand the relationships within and across repositories by n redirect_from: - /articles/navigating-code-on-github - /github/managing-files-in-a-repository/navigating-code-on-github + - /github/managing-files-in-a-repository/managing-files-on-github/navigating-code-on-github versions: fpt: '*' topics: diff --git a/content/github/managing-files-in-a-repository/managing-files-on-github/tracking-changes-in-a-file.md b/content/repositories/working-with-files/using-files/tracking-changes-in-a-file.md similarity index 95% rename from content/github/managing-files-in-a-repository/managing-files-on-github/tracking-changes-in-a-file.md rename to content/repositories/working-with-files/using-files/tracking-changes-in-a-file.md index b6f48c504e..19fc9542ef 100644 --- a/content/github/managing-files-in-a-repository/managing-files-on-github/tracking-changes-in-a-file.md +++ b/content/repositories/working-with-files/using-files/tracking-changes-in-a-file.md @@ -6,6 +6,7 @@ redirect_from: - /articles/tracing-changes-in-a-file/ - /articles/tracking-changes-in-a-file - /github/managing-files-in-a-repository/tracking-changes-in-a-file + - /github/managing-files-in-a-repository/managing-files-on-github/tracking-changes-in-a-file versions: fpt: '*' ghes: '*' diff --git a/content/repositories/working-with-files/using-files/working-with-non-code-files.md b/content/repositories/working-with-files/using-files/working-with-non-code-files.md new file mode 100644 index 0000000000..c669e2349a --- /dev/null +++ b/content/repositories/working-with-files/using-files/working-with-non-code-files.md @@ -0,0 +1,320 @@ +--- +title: Working with non-code files +intro: "{% data variables.product.product_name %} supports rendering and diffing in a number of non-code file formats." +redirect_from: + - /articles/rendering-and-diffing-images + - /github/managing-files-in-a-repository/rendering-and-diffing-images + - /github/managing-files-in-a-repository/working-with-non-code-files/rendering-and-diffing-images + - /articles/stl-file-viewer + - /articles/3d-file-viewer + - /github/managing-files-in-a-repository/3d-file-viewer + - /github/managing-files-in-a-repository/working-with-non-code-files/3d-file-viewer + - /articles/rendering-csv-and-tsv-data + - /github/managing-files-in-a-repository/rendering-csv-and-tsv-data + - /github/managing-files-in-a-repository/working-with-non-code-files/rendering-csv-and-tsv-data + - /articles/rendering-pdf-documents + - /github/managing-files-in-a-repository/rendering-pdf-documents + - /github/managing-files-in-a-repository/working-with-non-code-files/rendering-pdf-documents + - /articles/rendering-differences-in-prose-documents + - /github/managing-files-in-a-repository/rendering-differences-in-prose-documents + - /github/managing-files-in-a-repository/working-with-non-code-files/rendering-differences-in-prose-documents + - /articles/mapping-geojson-files-on-github + - /github/managing-files-in-a-repository/mapping-geojson-files-on-github + - /github/managing-files-in-a-repository/working-with-non-code-files/mapping-geojson-files-on-github + - /articles/working-with-jupyter-notebook-files-on-github + - /github/managing-files-in-a-repository/working-with-jupyter-notebook-files-on-github + - /github/managing-files-in-a-repository/working-with-non-code-files/working-with-jupyter-notebook-files-on-github + - /github/managing-files-in-a-repository/working-with-non-code-files +versions: + fpt: '*' + ghes: '*' + ghae: '*' +topics: + - Repositories +shortTitle: Working with non-code files +--- + +## Rendering and diffing images + +{% data variables.product.product_name %} can display several common image formats, including PNG, JPG, GIF, PSD, and SVG. In addition to simply displaying them, there are several ways to compare differences between versions of those image formats.' + +{% note %} + +**Note:** If you are using the Firefox browser, SVGs on {% data variables.product.prodname_dotcom %} may not render. + +{% endnote %} + +### Viewing images + +You can directly browse and view images in your {% data variables.product.product_name %} repository: + +![inline image](/assets/images/help/images/view.png) + +SVGs don't currently support inline scripting or animation. + +### Viewing differences + +You can visually compare images in three different modes: [2-up](#2-up), [swipe](#swipe), and [onion skin](#onion-skin). + +#### 2-up + +**2-up** is the default mode; it gives you a quick glimpse of both images. In addition, if the image has changed size between versions, the actual dimension change is displayed. This should make it very apparent when things are resized, such as when assets are upgraded to higher resolutions. + +![2-up](/assets/images/help/repository/images-2up-view.png) + +#### Swipe + +**Swipe** lets you view portions of your image side by side. Not sure if colors shifted between different versions? Drag the swipe slider over the area in question and compare the pixels for yourself. + +![Swipe](/assets/images/help/repository/images-swipe-view.png) + +#### Onion skin + +**Onion Skin** really comes in handy when elements move around by small, hard to notice amounts. Did an icon shift two pixels to the left? Drag the opacity slider back a bit and notice if things move around. + +![Onion skin](/assets/images/help/repository/images-onion-view.gif) + +## 3D File Viewer + +{% data variables.product.product_name %} can host and render 3D files with the *.stl* extension. + +When looking directly at an STL file on {% data variables.product.product_name %} you can: + +* Click and drag to spin the model. +* Right click and drag to translate the view. +* Scroll to zoom in and out. +* Click the different view modes to change the view. + +### Diffs + +When looking at a commit or set of changes which includes an STL file, you'll be able to see a before and after diff of the file. + +By default, you'll get a view where everything unchanged is in wireframe. Additions are colored in green, and removed parts are colored in red. + +![wireframe](/assets/images/help/repository/stl_wireframe.png) + +You can also select the **Revision Slider** option, which lets you use a slider at the top of the file to transition between the current and previous revisions. + +### Fixing slow performance + +If you see this icon in the corner of the viewer, then the WebGL technology is not available on your browser: + +![WebGL pop error](/assets/images/help/repository/render_webgl_error.png) + +WebGL is necessary to take advantage of your computer's hardware to its fullest. We recommend you try browsers like [Chrome](https://www.google.com/intl/en/chrome/browser/) or [Firefox](https://www.mozilla.org/en-US/firefox/new/), which ship with WebGL enabled. + +### Error: "Unable to display" + +If your model is invalid, GitHub may not be able to display the file. In addition, files that are larger than 10 MB are too big for GitHub to display. + +### Embedding your model elsewhere + +To display your 3D file elsewhere on the internet, modify this template and place it on any HTML page that supports JavaScript: + +```html + +``` + +For example, if your model's URL is [github.com/skalnik/secret-bear-clip/blob/master/stl/clip.stl](https://github.com/skalnik/secret-bear-clip/blob/master/stl/clip.stl), your embed code would be: + +```html + +``` + +By default, the embedded renderer is 420 pixels wide by 620 pixels high, but you can customize the output by passing height and width variables as parameters at the end of the URL, such as `?height=300&width=500`. + +{% tip %} + +**Note**: `ref` can be a branch or the hash to an individual commit (like `2391ae`). + +{% endtip %} + +## Rendering CSV and TSV data + +GitHub supports rendering tabular data in the form of *.csv* (comma-separated) and .*tsv* (tab-separated) files. + +![Rendered CSV sample](/assets/images/help/repository/rendered_csv.png) + +When viewed, any _.csv_ or _.tsv_ file committed to a {% data variables.product.product_name %} repository automatically renders as an interactive table, complete with headers and row numbering. By default, we'll always assume the first row is your header row. + +You can link to a particular row by clicking the row number, or select multiple rows by holding down the shift key. Just copy the URL and send it to a friend. + +### Searching data + +If you want to find a certain value in your dataset, you can start typing in the search bar directly above the file. The rows will filter automatically: + +![Searching for values](/assets/images/help/repository/searching_csvs.gif) + +### Handling errors + +Occasionally, you may discover that your CSV or TSV file isn't rendering. In those instances, an error box appears at the bottom of your raw text, suggesting what the error may be. + +![CSV render error message](/assets/images/help/repository/csv_render_error.png) + +Common errors include: + +* Mismatched column counts. You must have the same number of separators in each row, even if the cell is blank +* Exceeding the file size. Our rendering only works for files up to 512KB. Anything bigger than that slows down the browser. + +## Rendering PDF documents + +GitHub supports rendering of PDF documents. + +![Rendered PDF Document](/assets/images/help/repository/rendered-pdf.png) + +Currently, links within PDFs are ignored. + +## Rendering differences in prose documents + +Commits and pull requests that include prose documents have the ability to represent those documents with *source* and *rendered* views. + +The source view shows the raw text that has been typed, while the rendered +view shows how that text would look once it's rendered on {% data variables.product.product_name %}. For example, +this might be the difference between showing `**bold**` in Markdown, and **bold** in the rendered view. + +Prose rendering is supported for rendered documents supported by [github/markup](https://github.com/github/markup): + +* Markdown +* AsciiDoc +* Textile +* ReStructuredText +* Rdoc +* Org +* Creole +* MediaWiki +* Pod + +![Paper icon to view rendered prose document](/assets/images/help/repository/rendered_prose_diff.png) + +You can click {% octicon "file" aria-label="The paper icon" %} to see the changes made to the document as part of a commit. + +![Rendered Prose changes](/assets/images/help/repository/rendered_prose_changes.png) + +### Visualizing attribute changes + +We provide a tooltip +describing changes to attributes that, unlike words, would not otherwise be visible in the rendered document. For example, if a link URL changes from one website to +another, we'd show a tooltip like this: + +![Rendered Prose attribute changes](/assets/images/help/repository/prose_diff_attributes.png) + +### Commenting on changes + +[Commit comments](/articles/commenting-on-differences-between-files) can only +be added to files within the *source* view, on a line-by-line basis. + +### Linking to headers + +As with [other rendered prose documents](/articles/about-readmes), +hovering over a header in your document creates a link icon. You can link readers +of your rendered prose diff to specific sections. + +### Viewing complex diffs + +Some pull requests involve a large number of changes with large, complex documents. When the changes take too long to analyze, {% data variables.product.product_name %} can't always produce a rendered view of the changes. If this happens, you'll see an error message when you click the rendered button. + +![Message when view can't be rendered](/assets/images/help/repository/prose_diff_rendering.png) + +You can still use the source view to analyze and comment on changes. + +### Viewing HTML elements + +We don't directly support rendered views of commits to HTML documents. Some formats, such as Markdown, let you embed arbitrary HTML in a document. When these documents are shown on {% data variables.product.product_name %}, some of that embedded HTML can be shown in a preview, while some (like an embedded YouTube video) cannot. + +In general, rendered views of changes to a document containing embedded HTML will show changes to the elements that are supported in {% data variables.product.product_name %}'s view of the document. Changes to documents containing embedded HTML should always be reviewed in both the rendered and source views for completeness. + +## Mapping geoJSON files on {% data variables.product.prodname_dotcom %} + +{% 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. + +When you click the paper icon on the right, you'll also see the changes made to that file as part of a commit. + +![Source Render toggle screenshot](/assets/images/help/repository/source-render-toggle-geojson.png) + +### Geometry Types + +Maps on {% data variables.product.product_name %} use [Leaflet.js](http://leafletjs.com) and support all the geometry types outlined in [the geoJSON spec](http://www.geojson.org/geojson-spec.html) (Point, LineString, Polygon, MultiPoint, MultiLineString, MultiPolygon, and GeometryCollection). TopoJSON files should be type "Topology" and adhere to the [topoJSON spec](https://github.com/mbostock/topojson/wiki/Specification). + +### Styling features + +You can customize the way features are displayed, such as specifying a particular color or adding a descriptive icon, by passing additional metadata within the geoJSON object's properties. The options are: + +* `marker-size` - `small`, `medium`, or `large` +* `marker-color` - valid RGB hex color +* `marker-symbol` - an icon ID from [the Maki project](http://mapbox.com/maki/) or a single alphanumeric character (a-z or 0-9). +* `stroke` - color of a polygon edge or line (RGB) +* `stroke-opacity` - opacity of a polygon edge or line (0.0 - 1.0) +* `stroke-width` - width of a polygon edge or line +* `fill` - the color of the interior of a polygon (GRB) +* `fill-opacity` - the opacity of the interior of a polygon (0.0-1.0) + +See [version 1.1.0 of the open simplestyle spec](https://github.com/mapbox/simplestyle-spec/tree/master/1.1.0) for more information. + +### Embedding your map elsewhere + +Want to make your geoJSON map available someplace other than {% data variables.product.product_name %}? Simply modify this template, and place it in any HTML page that supports javascript (e.g., [{% data variables.product.prodname_pages %}](http://pages.github.com)): + +```html + +``` + +For example, if your map's URL is [github.com/benbalter/dc-wifi-social/blob/master/bars.geojson](https://github.com/benbalter/dc-wifi-social/blob/master/bars.geojson), your embed code would be: + +```html + +``` + +By default, the embedded map 420px x 620px, but you can customize the output by passing height and width variables as parameters at the end, such as `?height=300&width=500`. + +{% tip %} + +**Note**: `ref` can be a branch or the hash to an individual commit (like `2391ae`). + +{% endtip %} + +### Clustering + +If your map contains a large number of markers (roughly over 750), GitHub will automatically cluster nearby markers at higher zoom levels. Simply click the cluster or zoom in to see individual markers. + +### Something's up with the underlying map + +The underlying map data (street names, roads, etc.) are driven by [OpenStreetMap](http://www.openstreetmap.org/), a collaborative project to create a free editable map of the world. If you notice something's not quite right, since it's open source, simply [sign up](https://www.openstreetmap.org/user/new) and submit a fix. + +### Troubleshooting + +If you're having trouble rendering geoJSON files, ensure you have a valid geoJSON file by running it through a [geoJSON linter](http://geojsonlint.com/). If your points aren't appearing where you'd expect (e.g., in the middle of the ocean), it's likely that the data is in a projection which is currently unsupported. Currently, {% data variables.product.product_name %} only supports the `urn:ogc:def:crs:OGC:1.3:CRS84` projection. + +Additionally, if your `.geojson` file is especially large (over 10 MB), it is not possible to render within the browser. If that's the case, you'll generally see a message that looks something like this: + +![Large file](/assets/images/help/repository/view_raw.png) + +It may still be possible to render the data by converting the `.geojson` file to [TopoJSON](https://github.com/mbostock/topojson), a compression format that, in some cases, can reduce filesize by up to 80%. Of course, you can always break the file into smaller chunks (such as by state or by year), and store the data as multiple files within the repository. + +### Additional Resources + +* [Leaflet.js geojson documentation](http://leafletjs.com/examples/geojson.html) +* [MapBox marker-styling documentation](http://www.mapbox.com/developers/simplestyle/) +* [TopoJSON Wiki](https://github.com/mbostock/topojson/wiki) + +## Working with Jupyter Notebook files on {% data variables.product.prodname_dotcom %} + +When you add Jupyter Notebook or IPython Notebook files with a *.ipynb* extension on {% data variables.product.product_location %}, they will render as static HTML files in your repository. + +The interactive features of the notebook, such as custom JavaScript plots, will not work in your repository on {% data variables.product.product_location %}. For an example, see [*Linking and Interactions.ipynb*](https://github.com/bokeh/bokeh-notebooks/blob/main/tutorial/06%20-%20Linking%20and%20Interactions.ipynb). + +To view your Jupyter notebook with JavaScript content rendered or to share your notebook files with others you can use [nbviewer](https://nbviewer.jupyter.org/). For an example, see [*Linking and Interactions.ipynb*](https://nbviewer.jupyter.org/github/bokeh/bokeh-notebooks/blob/main/tutorial/06%20-%20Linking%20and%20Interactions.ipynb) rendered on nbviewer. + +To view a fully interactive version of your Jupyter Notebook, you can set up a notebook server locally. For more information, see [Jupyter's official documentation](http://jupyter.readthedocs.io/en/latest/index.html). + +### Troubleshooting + +If you're having trouble rendering Jupyter Notebook files in static HTML, you can convert the file locally on the command line by using the [`nbconvert` command](https://github.com/jupyter/nbconvert): + +```shell +$ jupyter nbconvert --to html NOTEBOOK-NAME.ipynb +``` + +### Further reading + +- [Jupyter Notebook's GitHub repository](https://github.com/jupyter/jupyter_notebook) +- [Gallery of Jupyter Notebooks](https://github.com/jupyter/jupyter/wiki/A-gallery-of-interesting-Jupyter-Notebooks) diff --git a/content/rest/reference/repos.md b/content/rest/reference/repos.md index e18f1dc9e6..7ecb7153f8 100644 --- a/content/rest/reference/repos.md +++ b/content/rest/reference/repos.md @@ -313,7 +313,7 @@ If you are developing a GitHub App and want to provide more detailed information ## Traffic For repositories that you have push access to, the traffic API provides access -to the information provided in your repository graph. For more information, see "Viewing traffic to a repository." +to the information provided in your repository graph. For more information, see "Viewing traffic to a repository." {% for operation in currentRestOperations %} {% if operation.subcategory == 'traffic' %}{% include rest_operation %}{% endif %} diff --git a/data/graphql/ghae/schema.docs-ghae.graphql b/data/graphql/ghae/schema.docs-ghae.graphql index 3dde655576..3a1d9183ef 100644 --- a/data/graphql/ghae/schema.docs-ghae.graphql +++ b/data/graphql/ghae/schema.docs-ghae.graphql @@ -4270,6 +4270,19 @@ qualified). The Ref may be specified by its global node ID or by the repository nameWithOwner and branch name. + +### Examples + +Specify a branch using a global node ID: + + { "id": "MDM6UmVmMTpyZWZzL2hlYWRzL21haW4=" } + +Specify a branch using nameWithOwner and branch name: + + { + "nameWithOwner": "github/graphql-client", + "branchName": "main" + } """ input CommittableBranch { """ @@ -11758,7 +11771,7 @@ slash-prefixed. `path` values must be unique across all `additions` and `deletions` provided. Any duplication will result in a validation error. -## Encoding +### Encoding File contents must be provided in full for each `FileAddition`. @@ -11778,7 +11791,7 @@ and ensuring that all files in a repository use a consistent line-ending convention (`\n` or `\r\n`), and that all files end with a newline. -## Modeling file changes +### Modeling file changes Each of the the five types of conceptual changes that can be made in a git commit can be described using the `FileChanges` type as follows: @@ -16537,7 +16550,7 @@ type Mutation { branch and also updates that branch to point to the new commit. It can be thought of as similar to `git commit`. - ## Locating a Branch + ### Locating a Branch Commits are appended to a `branch` of type `Ref`. This must refer to a git branch (i.e. the fully qualified path must @@ -16547,7 +16560,7 @@ type Mutation { ID or by passing both of `repositoryNameWithOwner` and `refName`. For more details see the documentation for `CommittableBranch`. - ## Describing Changes + ### Describing Changes `fileChanges` are specified as a `FilesChanges` object describing `FileAdditions` and `FileDeletions`. @@ -16555,7 +16568,7 @@ type Mutation { Please see the documentation for `FileChanges` for more information on how to use this argument to describe any set of file changes. - ## Authorship + ### Authorship Similar to the web commit interface, this mutation does not support specifying the author or committer of the commit and will not add @@ -16569,7 +16582,7 @@ type Mutation { If you need full control over author and committer information, please use the Git Database REST API instead. - ## Commit Signing + ### Commit Signing Commits made using this mutation are automatically signed by GitHub if supported and will be marked as verified in the user interface. diff --git a/data/graphql/schema.docs.graphql b/data/graphql/schema.docs.graphql index bd000bc184..28f4deea8d 100644 --- a/data/graphql/schema.docs.graphql +++ b/data/graphql/schema.docs.graphql @@ -4472,6 +4472,19 @@ qualified). The Ref may be specified by its global node ID or by the repository nameWithOwner and branch name. + +### Examples + +Specify a branch using a global node ID: + + { "id": "MDM6UmVmMTpyZWZzL2hlYWRzL21haW4=" } + +Specify a branch using nameWithOwner and branch name: + + { + "nameWithOwner": "github/graphql-client", + "branchName": "main" + } """ input CommittableBranch { """ @@ -12496,7 +12509,7 @@ slash-prefixed. `path` values must be unique across all `additions` and `deletions` provided. Any duplication will result in a validation error. -## Encoding +### Encoding File contents must be provided in full for each `FileAddition`. @@ -12516,7 +12529,7 @@ and ensuring that all files in a repository use a consistent line-ending convention (`\n` or `\r\n`), and that all files end with a newline. -## Modeling file changes +### Modeling file changes Each of the the five types of conceptual changes that can be made in a git commit can be described using the `FileChanges` type as follows: @@ -17854,7 +17867,7 @@ type Mutation { branch and also updates that branch to point to the new commit. It can be thought of as similar to `git commit`. - ## Locating a Branch + ### Locating a Branch Commits are appended to a `branch` of type `Ref`. This must refer to a git branch (i.e. the fully qualified path must @@ -17864,7 +17877,7 @@ type Mutation { ID or by passing both of `repositoryNameWithOwner` and `refName`. For more details see the documentation for `CommittableBranch`. - ## Describing Changes + ### Describing Changes `fileChanges` are specified as a `FilesChanges` object describing `FileAdditions` and `FileDeletions`. @@ -17872,7 +17885,7 @@ type Mutation { Please see the documentation for `FileChanges` for more information on how to use this argument to describe any set of file changes. - ## Authorship + ### Authorship Similar to the web commit interface, this mutation does not support specifying the author or committer of the commit and will not add @@ -17886,7 +17899,7 @@ type Mutation { If you need full control over author and committer information, please use the Git Database REST API instead. - ## Commit Signing + ### Commit Signing Commits made using this mutation are automatically signed by GitHub if supported and will be marked as verified in the user interface. diff --git a/data/release-notes/enterprise-server/3-1/1.yml b/data/release-notes/enterprise-server/3-1/1.yml index 535b626252..bc93c80f84 100644 --- a/data/release-notes/enterprise-server/3-1/1.yml +++ b/data/release-notes/enterprise-server/3-1/1.yml @@ -26,3 +26,4 @@ sections: ghe-actions-console -s actions -c "Queue-ServiceJob -JobId 4DB1F4CF-19FD-40E0-A253-91288813DE8B" ``` - When a replica node is offline in a high availability configuration, {% data variables.product.product_name %} may still route {% data variables.product.prodname_pages %} requests to the offline node, reducing the availability of {% data variables.product.prodname_pages %} for users. + - If {% data variables.product.prodname_actions %} is enabled for {% data variables.product.prodname_ghe_server %}, teardown of a replica node with `ghe-repl-teardown` will succeed, but may return `ERROR:Running migrations`. diff --git a/data/release-notes/enterprise-server/3-1/2.yml b/data/release-notes/enterprise-server/3-1/2.yml index 895b2510ee..ee0466586d 100644 --- a/data/release-notes/enterprise-server/3-1/2.yml +++ b/data/release-notes/enterprise-server/3-1/2.yml @@ -22,3 +22,4 @@ sections: ``` ghe-actions-console -s actions -c "Queue-ServiceJob -JobId 4DB1F4CF-19FD-40E0-A253-91288813DE8B" ``` + - If {% data variables.product.prodname_actions %} is enabled for {% data variables.product.prodname_ghe_server %}, teardown of a replica node with `ghe-repl-teardown` will succeed, but may return `ERROR:Running migrations`. diff --git a/data/release-notes/enterprise-server/3-1/3.yml b/data/release-notes/enterprise-server/3-1/3.yml index 8f0f5295fd..a634acf378 100644 --- a/data/release-notes/enterprise-server/3-1/3.yml +++ b/data/release-notes/enterprise-server/3-1/3.yml @@ -23,3 +23,4 @@ sections: - Git LFS tracked files [uploaded through the web interface](https://github.com/blog/2105-upload-files-to-your-repositories) are incorrectly added directly to the repository. - Issues cannot be closed if they contain a permalink to a blob in the same repository, where the blob's file path is longer than 255 characters. - When "Users can search GitHub.com" is enabled with GitHub Connect, issues in private and internal repositories are not included in GitHub.com search results. + - If {% data variables.product.prodname_actions %} is enabled for {% data variables.product.prodname_ghe_server %}, teardown of a replica node with `ghe-repl-teardown` will succeed, but may return `ERROR:Running migrations`. diff --git a/data/release-notes/enterprise-server/3-1/4.yml b/data/release-notes/enterprise-server/3-1/4.yml index 1fe8680015..d4e1eae5ab 100644 --- a/data/release-notes/enterprise-server/3-1/4.yml +++ b/data/release-notes/enterprise-server/3-1/4.yml @@ -32,3 +32,4 @@ sections: - Git LFS tracked files [uploaded through the web interface](https://github.com/blog/2105-upload-files-to-your-repositories) are incorrectly added directly to the repository. - Issues cannot be closed if they contain a permalink to a blob in the same repository, where the blob's file path is longer than 255 characters. - When "Users can search GitHub.com" is enabled with GitHub Connect, issues in private and internal repositories are not included in GitHub.com search results. + - If {% data variables.product.prodname_actions %} is enabled for {% data variables.product.prodname_ghe_server %}, teardown of a replica node with `ghe-repl-teardown` will succeed, but may return `ERROR:Running migrations`. diff --git a/data/release-notes/enterprise-server/3-1/5.yml b/data/release-notes/enterprise-server/3-1/5.yml index a804f716a6..03d3144eee 100644 --- a/data/release-notes/enterprise-server/3-1/5.yml +++ b/data/release-notes/enterprise-server/3-1/5.yml @@ -16,3 +16,4 @@ sections: - Git LFS tracked files [uploaded through the web interface](https://github.com/blog/2105-upload-files-to-your-repositories) are incorrectly added directly to the repository. - Issues cannot be closed if they contain a permalink to a blob in the same repository, where the blob's file path is longer than 255 characters. - When "Users can search GitHub.com" is enabled with GitHub Connect, issues in private and internal repositories are not included in GitHub.com search results. + - If {% data variables.product.prodname_actions %} is enabled for {% data variables.product.prodname_ghe_server %}, teardown of a replica node with `ghe-repl-teardown` will succeed, but may return `ERROR:Running migrations`. diff --git a/data/release-notes/enterprise-server/3-1/6.yml b/data/release-notes/enterprise-server/3-1/6.yml index ba90b977e7..45e2b737a4 100644 --- a/data/release-notes/enterprise-server/3-1/6.yml +++ b/data/release-notes/enterprise-server/3-1/6.yml @@ -19,3 +19,4 @@ sections: - Git LFS tracked files [uploaded through the web interface](https://github.com/blog/2105-upload-files-to-your-repositories) are incorrectly added directly to the repository. - Issues cannot be closed if they contain a permalink to a blob in the same repository, where the blob's file path is longer than 255 characters. - When "Users can search GitHub.com" is enabled with GitHub Connect, issues in private and internal repositories are not included in GitHub.com search results. + - If {% data variables.product.prodname_actions %} is enabled for {% data variables.product.prodname_ghe_server %}, teardown of a replica node with `ghe-repl-teardown` will succeed, but may return `ERROR:Running migrations`. diff --git a/data/release-notes/enterprise-server/3-1/7.yml b/data/release-notes/enterprise-server/3-1/7.yml index aca5152e4e..16a0314e8d 100644 --- a/data/release-notes/enterprise-server/3-1/7.yml +++ b/data/release-notes/enterprise-server/3-1/7.yml @@ -14,3 +14,4 @@ sections: - Git LFS tracked files [uploaded through the web interface](https://github.com/blog/2105-upload-files-to-your-repositories) are incorrectly added directly to the repository. - Issues cannot be closed if they contain a permalink to a blob in the same repository, where the blob's file path is longer than 255 characters. - When "Users can search GitHub.com" is enabled with GitHub Connect, issues in private and internal repositories are not included in GitHub.com search results. + - If {% data variables.product.prodname_actions %} is enabled for {% data variables.product.prodname_ghe_server %}, teardown of a replica node with `ghe-repl-teardown` will succeed, but may return `ERROR:Running migrations`. diff --git a/data/reusables/billing/email-notifications.md b/data/reusables/billing/email-notifications.md new file mode 100644 index 0000000000..003ecb42fe --- /dev/null +++ b/data/reusables/billing/email-notifications.md @@ -0,0 +1,3 @@ +Email notifications are sent to account owners and billing managers when spending reaches 50%, 75%, and 90% of your account's included usage and when spending reaches 50%, 75%, and 90% of your account's spending limit. + +You can disable these notifications anytime by navigating to the bottom of the **Spending Limit** page. \ No newline at end of file diff --git a/data/reusables/classroom/assignments-guide-choose-visibility.md b/data/reusables/classroom/assignments-guide-choose-visibility.md index 303bb3669b..bed99de7e8 100644 --- a/data/reusables/classroom/assignments-guide-choose-visibility.md +++ b/data/reusables/classroom/assignments-guide-choose-visibility.md @@ -1,6 +1,6 @@ The repositories for an assignment can be public or private. If you use private repositories, only the student or team can see the feedback you provide. -You can also decide whether to grant students admin permissions to the repository for an assignment. Grant admin permissions if the student should be able to perform administrative tasks for the assignment repository. For more information, see "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility)" and "[Repository permission levels for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization)." +You can also decide whether to grant students admin permissions to the repository for an assignment. Grant admin permissions if the student should be able to perform administrative tasks for the assignment repository. For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)" and "[Repository permission levels for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization)." Under "Repository visibility", select a visibility. Optionally, select **Grant students admin access to their repository**. diff --git a/data/reusables/github-actions/forked-write-permission.md b/data/reusables/github-actions/forked-write-permission.md index ecf77e3a35..d5300baa21 100644 --- a/data/reusables/github-actions/forked-write-permission.md +++ b/data/reusables/github-actions/forked-write-permission.md @@ -1 +1 @@ -You can use the `permissions` key to add and remove read permissions for forked repositories, but typically you can't grant write access. The exception to this behavior is where an admin user has selected the **Send write tokens to workflows from pull requests** option in the {% data variables.product.prodname_actions %} 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)." +You can use the `permissions` key to add and remove read permissions for forked repositories, but typically you can't grant write access. The exception to this behavior is where an admin user has selected the **Send write tokens to workflows from pull requests** option in the {% data variables.product.prodname_actions %} settings. For more information, see "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#enabling-workflows-for-private-repository-forks)." diff --git a/data/reusables/github-actions/self-hosted-runner-labels-runs-on.md b/data/reusables/github-actions/self-hosted-runner-labels-runs-on.md index 76374311c4..670cda5b20 100644 --- a/data/reusables/github-actions/self-hosted-runner-labels-runs-on.md +++ b/data/reusables/github-actions/self-hosted-runner-labels-runs-on.md @@ -1,3 +1,3 @@ To specify a self-hosted runner for your job, configure `runs-on` in your workflow file with self-hosted runner labels. -All self-hosted runners have the `self-hosted` label, and you can select any self-hosted runner by providing only the `self-hosted` label. Alternatively, you can use `self-hosted` in an array with additional labels, such as labels for a specific operating system or system architecture, to select only the runner types you specify. +All self-hosted runners have the `self-hosted` label. Using only this label will select any self-hosted runner. To select runners that meet certain criteria, such as operating system or architecture, provide an array of labels that begins with `self-hosted` (this must be listed first) and then includes additional labels as needed. diff --git a/data/reusables/organizations/internal-repos-enterprise.md b/data/reusables/organizations/internal-repos-enterprise.md index 56325061ae..26dcecf629 100644 --- a/data/reusables/organizations/internal-repos-enterprise.md +++ b/data/reusables/organizations/internal-repos-enterprise.md @@ -1,7 +1,7 @@ {% ifversion fpt %} {% note %} -**Note:** Internal repositories are available for organizations that are part of an enterprise account. For more information, see "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility)." +**Note:** Internal repositories are available for organizations that are part of an enterprise account. For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." {% endnote %} {% endif %} diff --git a/data/reusables/organizations/repo-creation-constants.md b/data/reusables/organizations/repo-creation-constants.md index d32cded961..ee82635758 100644 --- a/data/reusables/organizations/repo-creation-constants.md +++ b/data/reusables/organizations/repo-creation-constants.md @@ -1 +1 @@ -Organization owners can always create any type of repository, and outside collaborators can never create any type of repository. 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, and outside collaborators can never create any type of repository. For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." diff --git a/data/reusables/package_registry/add-npmrc-to-repo-step.md b/data/reusables/package_registry/add-npmrc-to-repo-step.md index 751ad03fd5..8f94253e18 100644 --- a/data/reusables/package_registry/add-npmrc-to-repo-step.md +++ b/data/reusables/package_registry/add-npmrc-to-repo-step.md @@ -1 +1 @@ -3. Add the *.npmrc* file to the repository where {% data variables.product.prodname_registry %} can find your project. For more information, see "[Adding a file to a repository using the command line](/github/managing-files-in-a-repository/adding-a-file-to-a-repository-using-the-command-line)." +3. Add the *.npmrc* file to the repository where {% data variables.product.prodname_registry %} can find your project. For more information, see "[Adding a file to a repository](/repositories/working-with-files/managing-files/adding-a-file-to-a-repository)." diff --git a/data/reusables/pages/private_pages_are_public_warning.md b/data/reusables/pages/private_pages_are_public_warning.md index 2e8d568bd6..0203c5447c 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**: {% ifversion ghes or ghae %}If your site administrator has enabled Public Pages, {% endif %}{% data variables.product.prodname_pages %} sites are publicly available on the internet{% ifversion fpt %} by default{% endif %}, even if the repository for the site is private or internal.{% ifversion fpt %} {% data reusables.pages.about-private-publishing %} Otherwise, if{% else %} If{% endif %} you have sensitive data in your site's repository, you may want to remove the data before publishing. For more information, see{% ifversion ghes or ghae %} "[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){% ifversion fpt %}" and "[Changing the visibility of your {% data variables.product.prodname_pages %} site](/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site)."{% else %}."{% endif %} +**Warning**: {% ifversion ghes or ghae %}If your site administrator has enabled Public Pages, {% endif %}{% data variables.product.prodname_pages %} sites are publicly available on the internet{% ifversion fpt %} by default{% endif %}, even if the repository for the site is private or internal.{% ifversion fpt %} {% data reusables.pages.about-private-publishing %} Otherwise, if{% else %} If{% endif %} you have sensitive data in your site's repository, you may want to remove the data before publishing. For more information, see{% ifversion ghes or ghae %} "[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 repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility){% ifversion fpt %}" and "[Changing the visibility of your {% data variables.product.prodname_pages %} site](/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site)."{% else %}."{% endif %} {% endwarning %} diff --git a/data/reusables/pull_requests/required-checks-must-pass-to-merge.md b/data/reusables/pull_requests/required-checks-must-pass-to-merge.md index 345f7941ee..0eab90a8be 100644 --- a/data/reusables/pull_requests/required-checks-must-pass-to-merge.md +++ b/data/reusables/pull_requests/required-checks-must-pass-to-merge.md @@ -1 +1 @@ -If status checks are required for a repository, the required status checks must pass before you can merge your branch into the protected branch. For more information, see "[About protected branches](/github/administering-a-repository/about-protected-branches#require-status-checks-before-merging)." +If status checks are required for a repository, the required status checks must pass before you can merge your branch into the protected branch. For more information, see "[About protected branches](/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#require-status-checks-before-merging)." diff --git a/data/reusables/repositories/autolink-references.md b/data/reusables/repositories/autolink-references.md index 70c67c9b29..bad4c31b94 100644 --- a/data/reusables/repositories/autolink-references.md +++ b/data/reusables/repositories/autolink-references.md @@ -1 +1 @@ -If custom autolink references are configured for a repository, then references to external resources, like a JIRA issue or Zendesk ticket, convert into shortened links. To know which autolinks are available in your repository, contact someone with admin permissions to the repository. For more information, see "[Configuring autolinks to reference external resources](/articles/configuring-autolinks-to-reference-external-resources)." +If custom autolink references are configured for a repository, then references to external resources, like a JIRA issue or Zendesk ticket, convert into shortened links. To know which autolinks are available in your repository, contact someone with admin permissions to the repository. For more information, see "[Configuring autolinks to reference external resources](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-autolinks-to-reference-external-resources)." diff --git a/data/reusables/repositories/choose-repo-visibility.md b/data/reusables/repositories/choose-repo-visibility.md index b3f4a2324f..fff8a68aa9 100644 --- a/data/reusables/repositories/choose-repo-visibility.md +++ b/data/reusables/repositories/choose-repo-visibility.md @@ -1,2 +1,2 @@ -1. Choose a repository visibility. For more information, see "[About repository visibility](/github/creating-cloning-and-archiving-repositories/about-repository-visibility)." +1. Choose a repository visibility. For more information, see "[About repositories](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." ![Radio buttons to select repository visibility](/assets/images/help/repository/create-repository-public-private.png) diff --git a/data/reusables/secret-scanning/partner-secret-list-private-repo.md b/data/reusables/secret-scanning/partner-secret-list-private-repo.md index f5e2be8f52..189bab8bd0 100644 --- a/data/reusables/secret-scanning/partner-secret-list-private-repo.md +++ b/data/reusables/secret-scanning/partner-secret-list-private-repo.md @@ -170,6 +170,10 @@ PlanetScale | PlanetScale Database Password | planetscale_database_password{% en PlanetScale | PlanetScale OAuth Token | planetscale_oauth_token{% endif %} {%- ifversion fpt or ghes > 3.2 or ghae-next %} PlanetScale | PlanetScale Service Token | planetscale_service_token{% endif %} +{%- ifversion fpt or ghes > 3.2 or ghae-next %} +Plivo | Plivo Auth ID | plivo_auth_id{% endif %} +{%- ifversion fpt or ghes > 3.2 or ghae-next %} +Plivo | Plivo Auth Token | plivo_auth_token{% endif %} {%- ifversion fpt or ghes > 2.22 or ghae-next %} Postman | Postman API Key | postman_api_key{% endif %} {%- ifversion fpt or ghes > 2.22 or ghae-next %} @@ -192,6 +196,10 @@ Samsara | Samsara API Token | samsara_api_token{% endif %} Samsara | Samsara OAuth Access Token | samsara_oauth_access_token{% endif %} {%- ifversion fpt or ghes > 3.1 or ghae-next %} SendGrid | SendGrid API Key | sendgrid_api_key{% endif %} +{%- ifversion fpt or ghes > 3.2 or ghae-next %} +Sendinblue | Sendinblue API Key | sendinblue_api_key{% endif %} +{%- ifversion fpt or ghes > 3.2 or ghae-next %} +Sendinblue | Sendinblue SMTP Key | sendinblue_smtp_key{% endif %} {%- ifversion fpt or ghes > 3.1 or ghae-next %} Shippo | Shippo Live API Token | shippo_live_api_token{% endif %} {%- ifversion fpt or ghes > 3.1 or ghae-next %} diff --git a/data/reusables/secret-scanning/partner-secret-list-public-repo.md b/data/reusables/secret-scanning/partner-secret-list-public-repo.md index e17ca24636..465e8b3f3b 100644 --- a/data/reusables/secret-scanning/partner-secret-list-public-repo.md +++ b/data/reusables/secret-scanning/partner-secret-list-public-repo.md @@ -19,6 +19,7 @@ Checkout.com | Checkout.com Production Secret Key Checkout.com | Checkout.com Test Secret Key Clojars | Clojars Deploy Token CloudBees CodeShip | CloudBees CodeShip Credential +Contributed Systems | Contributed Systems Credentials Databricks | Databricks Access Token Datadog | Datadog API Key Discord | Discord Bot Token @@ -60,7 +61,7 @@ Palantir | Palantir JSON Web Token PlanetScale | PlanetScale Database Password PlanetScale | PlanetScale OAuth Token PlanetScale | PlanetScale Service Token -Plivo | Plivo Auth Token +Plivo | Plivo Auth ID and Token Postman | Postman API Key Proctorio | Proctorio Consumer Key Proctorio | Proctorio Linkage Key diff --git a/data/reusables/sponsors/stripe-supported-regions.md b/data/reusables/sponsors/stripe-supported-regions.md index e89949ce86..93471b027e 100644 --- a/data/reusables/sponsors/stripe-supported-regions.md +++ b/data/reusables/sponsors/stripe-supported-regions.md @@ -1 +1 @@ -For a list of supported regions, see [{% data variables.product.prodname_sponsors %}](https://github.com/sponsors#countries). +For a list of supported regions, see [{% data variables.product.prodname_sponsors %}](https://github.com/sponsors#regions). diff --git a/lib/graphql/static/prerendered-input-objects.json b/lib/graphql/static/prerendered-input-objects.json index 7b2340574b..b792d3723f 100644 --- a/lib/graphql/static/prerendered-input-objects.json +++ b/lib/graphql/static/prerendered-input-objects.json @@ -1,6 +1,6 @@ { "dotcom": { - "html": "
\n
\n

\n AcceptEnterpriseAdministratorInvitationInput\n

\n

Autogenerated input type of AcceptEnterpriseAdministratorInvitation.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

invitationId (ID!)

The id of the invitation being accepted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AcceptTopicSuggestionInput\n

\n

Autogenerated input type of AcceptTopicSuggestion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the suggested topic.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddAssigneesToAssignableInput\n

\n

Autogenerated input type of AddAssigneesToAssignable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assignableId (ID!)

The id of the assignable object to add assignees to.

\n\n\n\n\n\n\n\n\n\n\n\n

assigneeIds ([ID!]!)

The id of users to add as assignees.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddCommentInput\n

\n

Autogenerated input type of AddComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The contents of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddDiscussionCommentInput\n

\n

Autogenerated input type of AddDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The contents of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

discussionId (ID!)

The Node ID of the discussion to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

replyToId (ID)

The Node ID of the discussion comment within this discussion to reply to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddEnterpriseSupportEntitlementInput\n

\n

Autogenerated input type of AddEnterpriseSupportEntitlement.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the Enterprise which the admin belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of a member who will receive the support entitlement.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddLabelsToLabelableInput\n

\n

Autogenerated input type of AddLabelsToLabelable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!]!)

The ids of the labels to add.

\n\n\n\n\n\n\n\n\n\n\n\n

labelableId (ID!)

The id of the labelable object to add labels to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddProjectCardInput\n

\n

Autogenerated input type of AddProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

contentId (ID)

The content of the card. Must be a member of the ProjectCardItem union.

\n\n\n\n\n\n\n\n\n\n\n\n

note (String)

The note on the card.

\n\n\n\n\n\n\n\n\n\n\n\n

projectColumnId (ID!)

The Node ID of the ProjectColumn.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddProjectColumnInput\n

\n

Autogenerated input type of AddProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the column.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The Node ID of the project.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddPullRequestReviewCommentInput\n

\n

Autogenerated input type of AddPullRequestReviewComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitOID (GitObjectID)

The SHA of the commit to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

inReplyTo (ID)

The comment id to reply to.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String)

The relative path of the file to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int)

The line index in the diff to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID)

The node ID of the pull request reviewing.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID)

The Node ID of the review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddPullRequestReviewInput\n

\n

Autogenerated input type of AddPullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The contents of the review body comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

comments ([DraftPullRequestReviewComment])

The review line comments.

\n\n\n\n\n\n\n\n\n\n\n\n

commitOID (GitObjectID)

The commit OID the review pertains to.

\n\n\n\n\n\n\n\n\n\n\n\n

event (PullRequestReviewEvent)

The event to perform on the pull request review.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

threads ([DraftPullRequestReviewThread])

The review line comment threads.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddPullRequestReviewThreadInput\n

\n

Autogenerated input type of AddPullRequestReviewThread.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

Body of the thread's first comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

line (Int!)

The line of the blob to which the thread refers. The end of the line range for multi-line comments.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

Path to the file being commented on.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID)

The node ID of the pull request reviewing.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID)

The Node ID of the review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

side (DiffSide)

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.

\n\n\n\n\n\n\n\n\n\n\n\n

startLine (Int)

The first line of the range to which the comment refers.

\n\n\n\n\n\n\n\n\n\n\n\n

startSide (DiffSide)

The side of the diff on which the start line resides.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddReactionInput\n

\n

Autogenerated input type of AddReaction.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

content (ReactionContent!)

The name of the emoji to react with.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddStarInput\n

\n

Autogenerated input type of AddStar.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

starrableId (ID!)

The Starrable ID to star.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddUpvoteInput\n

\n

Autogenerated input type of AddUpvote.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the discussion or comment to upvote.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddVerifiableDomainInput\n

\n

Autogenerated input type of AddVerifiableDomain.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

domain (URI!)

The URL of the domain.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner to add the domain to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ApproveDeploymentsInput\n

\n

Autogenerated input type of ApproveDeployments.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

comment (String)

Optional comment for approving deployments.

\n\n\n\n\n\n\n\n\n\n\n\n

environmentIds ([ID!]!)

The ids of environments to reject deployments.

\n\n\n\n\n\n\n\n\n\n\n\n

workflowRunId (ID!)

The node ID of the workflow run containing the pending deployments.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ApproveVerifiableDomainInput\n

\n

Autogenerated input type of ApproveVerifiableDomain.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the verifiable domain to approve.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ArchiveRepositoryInput\n

\n

Autogenerated input type of ArchiveRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to mark as archived.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AuditLogOrder\n

\n

Ordering options for Audit Log connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (AuditLogOrderField)

The field to order Audit Logs by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CancelEnterpriseAdminInvitationInput\n

\n

Autogenerated input type of CancelEnterpriseAdminInvitation.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

invitationId (ID!)

The Node ID of the pending enterprise administrator invitation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CancelSponsorshipInput\n

\n

Autogenerated input type of CancelSponsorship.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorId (ID)

The ID of the user or organization who is acting as the sponsor, paying for\nthe sponsorship. Required if sponsorLogin is not given.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorLogin (String)

The username of the user or organization who is acting as the sponsor, paying\nfor the sponsorship. Required if sponsorId is not given.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorableId (ID)

The ID of the user or organization who is receiving the sponsorship. Required if sponsorableLogin is not given.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorableLogin (String)

The username of the user or organization who is receiving the sponsorship. Required if sponsorableId is not given.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ChangeUserStatusInput\n

\n

Autogenerated input type of ChangeUserStatus.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

emoji (String)

The emoji to represent your status. Can either be a native Unicode emoji or an emoji name with colons, e.g., 😀.

\n\n\n\n\n\n\n\n\n\n\n\n

expiresAt (DateTime)

If set, the user status will not be shown after this date.

\n\n\n\n\n\n\n\n\n\n\n\n

limitedAvailability (Boolean)

Whether this status should indicate you are not fully available on GitHub, e.g., you are away.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String)

A short description of your current status.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationId (ID)

The ID of the organization whose members will be allowed to see the status. If\nomitted, the status will be publicly visible.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckAnnotationData\n

\n

Information from a check run analysis to specific lines of code.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

annotationLevel (CheckAnnotationLevel!)

Represents an annotation's information level.

\n\n\n\n\n\n\n\n\n\n\n\n

location (CheckAnnotationRange!)

The location of the annotation.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String!)

A short description of the feedback for these lines of code.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path of the file to add an annotation to.

\n\n\n\n\n\n\n\n\n\n\n\n

rawDetails (String)

Details about this annotation.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title that represents the annotation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckAnnotationRange\n

\n

Information from a check run analysis to specific lines of code.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

endColumn (Int)

The ending column of the range.

\n\n\n\n\n\n\n\n\n\n\n\n

endLine (Int!)

The ending line of the range.

\n\n\n\n\n\n\n\n\n\n\n\n

startColumn (Int)

The starting column of the range.

\n\n\n\n\n\n\n\n\n\n\n\n

startLine (Int!)

The starting line of the range.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunAction\n

\n

Possible further actions the integrator can perform.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

description (String!)

A short explanation of what this action would do.

\n\n\n\n\n\n\n\n\n\n\n\n

identifier (String!)

A reference for the action on the integrator's system.

\n\n\n\n\n\n\n\n\n\n\n\n

label (String!)

The text to be displayed on a button in the web UI.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunFilter\n

\n

The filters that are available when fetching check runs.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

appId (Int)

Filters the check runs created by this application ID.

\n\n\n\n\n\n\n\n\n\n\n\n

checkName (String)

Filters the check runs by this name.

\n\n\n\n\n\n\n\n\n\n\n\n

checkType (CheckRunType)

Filters the check runs by this type.

\n\n\n\n\n\n\n\n\n\n\n\n

status (CheckStatusState)

Filters the check runs by this status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunOutput\n

\n

Descriptive details about the check run.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

annotations ([CheckAnnotationData!])

The annotations that are made as part of the check run.

\n\n\n\n\n\n\n\n\n\n\n\n

images ([CheckRunOutputImage!])

Images attached to the check run output displayed in the GitHub pull request UI.

\n\n\n\n\n\n\n\n\n\n\n\n

summary (String!)

The summary of the check run (supports Commonmark).

\n\n\n\n\n\n\n\n\n\n\n\n

text (String)

The details of the check run (supports Commonmark).

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

A title to provide for this check run.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunOutputImage\n

\n

Images attached to the check run output displayed in the GitHub pull request UI.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

alt (String!)

The alternative text for the image.

\n\n\n\n\n\n\n\n\n\n\n\n

caption (String)

A short image description.

\n\n\n\n\n\n\n\n\n\n\n\n

imageUrl (URI!)

The full URL of the image.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckSuiteAutoTriggerPreference\n

\n

The auto-trigger preferences that are available for check suites.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

appId (ID!)

The node ID of the application that owns the check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

setting (Boolean!)

Set to true to enable automatic creation of CheckSuite events upon pushes to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckSuiteFilter\n

\n

The filters that are available when fetching check suites.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

appId (Int)

Filters the check suites created by this application ID.

\n\n\n\n\n\n\n\n\n\n\n\n

checkName (String)

Filters the check suites by this name.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ClearLabelsFromLabelableInput\n

\n

Autogenerated input type of ClearLabelsFromLabelable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelableId (ID!)

The id of the labelable object to clear the labels from.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CloneProjectInput\n

\n

Autogenerated input type of CloneProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of the project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

includeWorkflows (Boolean!)

Whether or not to clone the source project's workflows.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the project.

\n\n\n\n\n\n\n\n\n\n\n\n

public (Boolean)

The visibility of the project, defaults to false (private).

\n\n\n\n\n\n\n\n\n\n\n\n

sourceId (ID!)

The source project to clone.

\n\n\n\n\n\n\n\n\n\n\n\n

targetOwnerId (ID!)

The owner ID to create the project under.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CloneTemplateRepositoryInput\n

\n

Autogenerated input type of CloneTemplateRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A short description of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

includeAllBranches (Boolean)

Whether to copy all branches from the template to the new repository. Defaults\nto copying only the default branch of the template.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner for the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the template repository.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepositoryVisibility!)

Indicates the repository's visibility level.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CloseIssueInput\n

\n

Autogenerated input type of CloseIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

ID of the issue to be closed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ClosePullRequestInput\n

\n

Autogenerated input type of ClosePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be closed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CommitAuthor\n

\n

Specifies an author for filtering Git commits.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

emails ([String!])

Email addresses to filter by. Commits authored by any of the specified email addresses will be returned.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID)

ID of a User to filter by. If non-null, only commits authored by this user\nwill be returned. This field takes precedence over emails.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CommitContributionOrder\n

\n

Ordering options for commit contribution connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (CommitContributionOrderField!)

The field by which to order commit contributions.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CommitMessage\n

\n

A message to include with a new commit.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The body of the message.

\n\n\n\n\n\n\n\n\n\n\n\n

headline (String!)

The headline of the message.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CommittableBranch\n

\n

A git ref for a commit to be appended to.

\n

The ref must be a branch, i.e. its fully qualified name must start\nwith refs/heads/ (although the input is not required to be fully\nqualified).

\n

The Ref may be specified by its global node ID or by the\nrepository nameWithOwner and branch name.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

branchName (String)

The unqualified name of the branch to append the commit to.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID)

The Node ID of the Ref to be updated.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryNameWithOwner (String)

The nameWithOwner of the repository to commit to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ContributionOrder\n

\n

Ordering options for contribution connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ConvertProjectCardNoteToIssueInput\n

\n

Autogenerated input type of ConvertProjectCardNoteToIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The body of the newly created issue.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectCardId (ID!)

The ProjectCard ID to convert.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to create the issue in.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title of the newly created issue. Defaults to the card's note text.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ConvertPullRequestToDraftInput\n

\n

Autogenerated input type of ConvertPullRequestToDraft.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to convert to draft.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateBranchProtectionRuleInput\n

\n

Autogenerated input type of CreateBranchProtectionRule.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowsDeletions (Boolean)

Can this branch be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

allowsForcePushes (Boolean)

Are force pushes allowed on this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissesStaleReviews (Boolean)

Will new commits pushed to matching branches dismiss pull request review approvals.

\n\n\n\n\n\n\n\n\n\n\n\n

isAdminEnforced (Boolean)

Can admins overwrite branch protection.

\n\n\n\n\n\n\n\n\n\n\n\n

pattern (String!)

The glob-like pattern used to determine matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

pushActorIds ([ID!])

A list of User, Team or App IDs allowed to push to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The global relay id of the repository in which a new branch protection rule should be created in.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredStatusCheckContexts ([String!])

List of required status check contexts that must pass for commits to be accepted to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresApprovingReviews (Boolean)

Are approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCodeOwnerReviews (Boolean)

Are reviews from code owners required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCommitSignatures (Boolean)

Are commits required to be signed.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresConversationResolution (Boolean)

Are conversations required to be resolved before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresLinearHistory (Boolean)

Are merge commits prohibited from being pushed to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStatusChecks (Boolean)

Are status checks required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStrictStatusChecks (Boolean)

Are branches required to be up to date before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsPushes (Boolean)

Is pushing to matching branches restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsReviewDismissals (Boolean)

Is dismissal of pull request reviews restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDismissalActorIds ([ID!])

A list of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateCheckRunInput\n

\n

Autogenerated input type of CreateCheckRun.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actions ([CheckRunAction!])

Possible further actions the integrator can perform, which a user may trigger.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

completedAt (DateTime)

The time that the check run finished.

\n\n\n\n\n\n\n\n\n\n\n\n

conclusion (CheckConclusionState)

The final conclusion of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

detailsUrl (URI)

The URL of the integrator's site that has the full details of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

externalId (String)

A reference for the run on the integrator's system.

\n\n\n\n\n\n\n\n\n\n\n\n

headSha (GitObjectID!)

The SHA of the head commit.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

output (CheckRunOutput)

Descriptive details about the run.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

startedAt (DateTime)

The time that the check run began.

\n\n\n\n\n\n\n\n\n\n\n\n

status (RequestableCheckStatusState)

The current status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateCheckSuiteInput\n

\n

Autogenerated input type of CreateCheckSuite.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

headSha (GitObjectID!)

The SHA of the head commit.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateCommitOnBranchInput\n

\n

Autogenerated input type of CreateCommitOnBranch.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

branch (CommittableBranch!)

The Ref to be updated. Must be a branch.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

expectedHeadOid (GitObjectID!)

The git commit oid expected at the head of the branch prior to the commit.

\n\n\n\n\n\n\n\n\n\n\n\n

fileChanges (FileChanges)

A description of changes to files in this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

message (CommitMessage!)

The commit message the be included with the commit.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateContentAttachmentInput\n

\n

Autogenerated input type of CreateContentAttachment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The body of the content attachment, which may contain markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

contentReferenceId (ID!)

The node ID of the content_reference.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the content attachment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateDeploymentInput\n

\n

Autogenerated input type of CreateDeployment.

\n
\n\n
\n \n
\n

Preview notice

\n

CreateDeploymentInput is available under the Deployments preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

autoMerge (Boolean)

Attempt to automatically merge the default branch into the requested ref, defaults to true.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

Short description of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

environment (String)

Name for the target deployment environment.

\n\n\n\n\n\n\n\n\n\n\n\n

payload (String)

JSON payload with extra information about the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

refId (ID!)

The node ID of the ref to be deployed.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredContexts ([String!])

The status contexts to verify against commit status checks. To bypass required\ncontexts, pass an empty array. Defaults to all unique contexts.

\n\n\n\n\n\n\n\n\n\n\n\n

task (String)

Specifies a task to execute.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateDeploymentStatusInput\n

\n

Autogenerated input type of CreateDeploymentStatus.

\n
\n\n
\n \n
\n

Preview notice

\n

CreateDeploymentStatusInput is available under the Deployments preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

autoInactive (Boolean)

Adds a new inactive status to all non-transient, non-production environment\ndeployments with the same repository and environment name as the created\nstatus's deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

deploymentId (ID!)

The node ID of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A short description of the status. Maximum length of 140 characters.

\n\n\n\n\n\n\n\n\n\n\n\n

environment (String)

If provided, updates the environment of the deploy. Otherwise, does not modify the environment.

\n\n\n\n\n\n\n\n\n\n\n\n

environmentUrl (String)

Sets the URL for accessing your environment.

\n\n\n\n\n\n\n\n\n\n\n\n

logUrl (String)

The log URL to associate with this status. This URL should contain\noutput to keep the user updated while the task is running or serve as\nhistorical information for what happened in the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

state (DeploymentStatusState!)

The state of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateDiscussionInput\n

\n

Autogenerated input type of CreateDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The body of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

categoryId (ID!)

The id of the discussion category to associate with this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The id of the repository on which to create the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateEnterpriseOrganizationInput\n

\n

Autogenerated input type of CreateEnterpriseOrganization.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

adminLogins ([String!]!)

The logins for the administrators of the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n

billingEmail (String!)

The email used for sending billing receipts.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise owning the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n

profileName (String!)

The profile name of the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateEnvironmentInput\n

\n

Autogenerated input type of CreateEnvironment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the environment.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateIpAllowListEntryInput\n

\n

Autogenerated input type of CreateIpAllowListEntry.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowListValue (String!)

An IP address or range of addresses in CIDR notation.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

isActive (Boolean!)

Whether the IP allow list entry is active when an IP allow list is enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

An optional name for the IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner for which to create the new IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateIssueInput\n

\n

Autogenerated input type of CreateIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assigneeIds ([ID!])

The Node ID for the user assignee for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The body for the issue description.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueTemplate (String)

The name of an issue template in the repository, assigns labels and assignees from the template to the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!])

An array of Node IDs of labels for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneId (ID)

The Node ID of the milestone for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

projectIds ([ID!])

An array of Node IDs for projects associated with this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title for the issue.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateLabelInput\n

\n

Autogenerated input type of CreateLabel.

\n
\n\n
\n \n
\n

Preview notice

\n

CreateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

color (String!)

A 6 character hex code, without the leading #, identifying the color of the label.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A brief description of the label, such as its purpose.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the label.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateProjectInput\n

\n

Autogenerated input type of CreateProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of project.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The owner ID to create the project under.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryIds ([ID!])

A list of repository IDs to create as linked repositories for the project.

\n\n\n\n\n\n\n\n\n\n\n\n

template (ProjectTemplate)

The name of the GitHub-provided template.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreatePullRequestInput\n

\n

Autogenerated input type of CreatePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

baseRefName (String!)

The name of the branch you want your changes pulled into. This should be an existing branch\non the current repository. You cannot update the base branch on a pull request to point\nto another repository.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The contents of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

draft (Boolean)

Indicates whether this pull request should be a draft.

\n\n\n\n\n\n\n\n\n\n\n\n

headRefName (String!)

The name of the branch where your changes are implemented. For cross-repository pull requests\nin the same network, namespace head_ref_name with a user like this: username:branch.

\n\n\n\n\n\n\n\n\n\n\n\n

maintainerCanModify (Boolean)

Indicates whether maintainers can modify the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateRefInput\n

\n

Autogenerated input type of CreateRef.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The fully qualified name of the new Ref (ie: refs/heads/my_new_branch).

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The GitObjectID that the new Ref shall target. Must point to a commit.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the Repository to create the Ref in.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateRepositoryInput\n

\n

Autogenerated input type of CreateRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A short description of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

hasIssuesEnabled (Boolean)

Indicates if the repository should have the issues feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasWikiEnabled (Boolean)

Indicates if the repository should have the wiki feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

homepageUrl (URI)

The URL for a web page about this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID)

The ID of the owner for the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

teamId (ID)

When an organization is specified as the owner, this ID identifies the team\nthat should be granted access to the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

template (Boolean)

Whether this repository should be marked as a template such that anyone who\ncan access it can create new repositories with the same files and directory structure.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepositoryVisibility!)

Indicates the repository's visibility level.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateSponsorshipInput\n

\n

Autogenerated input type of CreateSponsorship.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

amount (Int)

The amount to pay to the sponsorable in US dollars. Required if a tierId is not specified. Valid values: 1-12000.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

isRecurring (Boolean)

Whether the sponsorship should happen monthly/yearly or just this one time. Required if a tierId is not specified.

\n\n\n\n\n\n\n\n\n\n\n\n

privacyLevel (SponsorshipPrivacy)

Specify whether others should be able to see that the sponsor is sponsoring\nthe sponsorable. Public visibility still does not reveal which tier is used.

\n\n\n\n\n\n\n\n\n\n\n\n

receiveEmails (Boolean)

Whether the sponsor should receive email updates from the sponsorable.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorId (ID)

The ID of the user or organization who is acting as the sponsor, paying for\nthe sponsorship. Required if sponsorLogin is not given.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorLogin (String)

The username of the user or organization who is acting as the sponsor, paying\nfor the sponsorship. Required if sponsorId is not given.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorableId (ID)

The ID of the user or organization who is receiving the sponsorship. Required if sponsorableLogin is not given.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorableLogin (String)

The username of the user or organization who is receiving the sponsorship. Required if sponsorableId is not given.

\n\n\n\n\n\n\n\n\n\n\n\n

tierId (ID)

The ID of one of sponsorable's existing tiers to sponsor at. Required if amount is not specified.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateTeamDiscussionCommentInput\n

\n

Autogenerated input type of CreateTeamDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The content of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

discussionId (ID!)

The ID of the discussion to which the comment belongs.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateTeamDiscussionInput\n

\n

Autogenerated input type of CreateTeamDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The content of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

private (Boolean)

If true, restricts the visibility of this discussion to team members and\norganization admins. If false or not specified, allows any organization member\nto view this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

teamId (ID!)

The ID of the team to which the discussion belongs.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeclineTopicSuggestionInput\n

\n

Autogenerated input type of DeclineTopicSuggestion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the suggested topic.

\n\n\n\n\n\n\n\n\n\n\n\n

reason (TopicSuggestionDeclineReason!)

The reason why the suggested topic is declined.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteBranchProtectionRuleInput\n

\n

Autogenerated input type of DeleteBranchProtectionRule.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

branchProtectionRuleId (ID!)

The global relay id of the branch protection rule to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteDeploymentInput\n

\n

Autogenerated input type of DeleteDeployment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the deployment to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteDiscussionCommentInput\n

\n

Autogenerated input type of DeleteDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node id of the discussion comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteDiscussionInput\n

\n

Autogenerated input type of DeleteDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The id of the discussion to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteEnvironmentInput\n

\n

Autogenerated input type of DeleteEnvironment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the environment to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteIpAllowListEntryInput\n

\n

Autogenerated input type of DeleteIpAllowListEntry.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEntryId (ID!)

The ID of the IP allow list entry to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteIssueCommentInput\n

\n

Autogenerated input type of DeleteIssueComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteIssueInput\n

\n

Autogenerated input type of DeleteIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The ID of the issue to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteLabelInput\n

\n

Autogenerated input type of DeleteLabel.

\n
\n\n
\n \n
\n

Preview notice

\n

DeleteLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the label to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeletePackageVersionInput\n

\n

Autogenerated input type of DeletePackageVersion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

packageVersionId (ID!)

The ID of the package version to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteProjectCardInput\n

\n

Autogenerated input type of DeleteProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cardId (ID!)

The id of the card to delete.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteProjectColumnInput\n

\n

Autogenerated input type of DeleteProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnId (ID!)

The id of the column to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteProjectInput\n

\n

Autogenerated input type of DeleteProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The Project ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeletePullRequestReviewCommentInput\n

\n

Autogenerated input type of DeletePullRequestReviewComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeletePullRequestReviewInput\n

\n

Autogenerated input type of DeletePullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID!)

The Node ID of the pull request review to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteRefInput\n

\n

Autogenerated input type of DeleteRef.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

refId (ID!)

The Node ID of the Ref to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteTeamDiscussionCommentInput\n

\n

Autogenerated input type of DeleteTeamDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteTeamDiscussionInput\n

\n

Autogenerated input type of DeleteTeamDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The discussion ID to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteVerifiableDomainInput\n

\n

Autogenerated input type of DeleteVerifiableDomain.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the verifiable domain to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeploymentOrder\n

\n

Ordering options for deployment connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (DeploymentOrderField!)

The field to order deployments by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DisablePullRequestAutoMergeInput\n

\n

Autogenerated input type of DisablePullRequestAutoMerge.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to disable auto merge on.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DiscussionOrder\n

\n

Ways in which lists of discussions can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order discussions by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (DiscussionOrderField!)

The field by which to order discussions.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DismissPullRequestReviewInput\n

\n

Autogenerated input type of DismissPullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String!)

The contents of the pull request review dismissal message.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID!)

The Node ID of the pull request review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DraftPullRequestReviewComment\n

\n

Specifies a review comment to be left with a Pull Request Review.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

Body of the comment to leave.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

Path to the file being commented on.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int!)

Position in the file to leave a comment on.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DraftPullRequestReviewThread\n

\n

Specifies a review comment thread to be left with a Pull Request Review.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

Body of the comment to leave.

\n\n\n\n\n\n\n\n\n\n\n\n

line (Int!)

The line of the blob to which the thread refers. The end of the line range for multi-line comments.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

Path to the file being commented on.

\n\n\n\n\n\n\n\n\n\n\n\n

side (DiffSide)

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.

\n\n\n\n\n\n\n\n\n\n\n\n

startLine (Int)

The first line of the range to which the comment refers.

\n\n\n\n\n\n\n\n\n\n\n\n

startSide (DiffSide)

The side of the diff on which the start line resides.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnablePullRequestAutoMergeInput\n

\n

Autogenerated input type of EnablePullRequestAutoMerge.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

authorEmail (String)

The email address to associate with this merge.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitBody (String)

Commit body to use for the commit when the PR is mergable; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

commitHeadline (String)

Commit headline to use for the commit when the PR is mergable; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeMethod (PullRequestMergeMethod)

The merge method to use. If omitted, defaults to 'MERGE'.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to enable auto-merge on.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorInvitationOrder\n

\n

Ordering options for enterprise administrator invitation connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseAdministratorInvitationOrderField!)

The field to order enterprise administrator invitations by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseMemberOrder\n

\n

Ordering options for enterprise member connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseMemberOrderField!)

The field to order enterprise members by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseServerInstallationOrder\n

\n

Ordering options for Enterprise Server installation connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseServerInstallationOrderField!)

The field to order Enterprise Server installations by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountEmailOrder\n

\n

Ordering options for Enterprise Server user account email connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseServerUserAccountEmailOrderField!)

The field to order emails by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountOrder\n

\n

Ordering options for Enterprise Server user account connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseServerUserAccountOrderField!)

The field to order user accounts by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountsUploadOrder\n

\n

Ordering options for Enterprise Server user accounts upload connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseServerUserAccountsUploadOrderField!)

The field to order user accounts uploads by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n FileAddition\n

\n

A command to add a file at the given path with the given contents as part of a\ncommit. Any existing file at that that path will be replaced.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contents (Base64String!)

The base64 encoded contents of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path in the repository where the file will be located.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n FileChanges\n

\n

A description of a set of changes to a file tree to be made as part of\na git commit, modeled as zero or more file additions and zero or more\nfile deletions.

\n

Both fields are optional; omitting both will produce a commit with no\nfile changes.

\n

deletions and additions describe changes to files identified\nby their path in the git tree using unix-style path separators, i.e.\n/. The root of a git tree is an empty string, so paths are not\nslash-prefixed.

\n

path values must be unique across all additions and deletions\nprovided. Any duplication will result in a validation error.

\n

Encoding

\n

File contents must be provided in full for each FileAddition.

\n

The contents of a FileAddition must be encoded using RFC 4648\ncompliant base64, i.e. correct padding is required and no characters\noutside the standard alphabet may be used. Invalid base64\nencoding will be rejected with a validation error.

\n

The encoded contents may be binary.

\n

For text files, no assumptions are made about the character encoding of\nthe file contents (after base64 decoding). No charset transcoding or\nline-ending normalization will be performed; it is the client's\nresponsibility to manage the character encoding of files they provide.\nHowever, for maximum compatibility we recommend using UTF-8 encoding\nand ensuring that all files in a repository use a consistent\nline-ending convention (\\n or \\r\\n), and that all files end\nwith a newline.

\n

Modeling file changes

\n

Each of the the five types of conceptual changes that can be made in a\ngit commit can be described using the FileChanges type as follows:

\n
    \n
  1. \n

    New file addition: create file hello world\\n at path docs/README.txt:

    \n

    {\n"additions" [\n{\n"path": "docs/README.txt",\n"contents": base64encode("hello world\\n")\n}\n]\n}

    \n
    2. \n
  2. \n

    Existing file modification: change existing docs/README.txt to have new\ncontent new content here\\n:

    \n
    {\n  "additions" [\n    {\n      "path": "docs/README.txt",\n      "contents": base64encode("new content here\\n")\n    }\n  ]\n}\n
    \n
    3. \n
  3. \n

    Existing file deletion: remove existing file docs/README.txt.\nNote that the path is required to exist -- specifying a\npath that does not exist on the given branch will abort the\ncommit and return an error.

    \n
    {\n  "deletions" [\n    {\n      "path": "docs/README.txt"\n    }\n  ]\n}\n
    \n
    4. \n
  4. \n

    File rename with no changes: rename docs/README.txt with\nprevious content hello world\\n to the same content at\nnewdocs/README.txt:

    \n
    {\n  "deletions" [\n    {\n      "path": "docs/README.txt",\n    }\n  ],\n  "additions" [\n    {\n      "path": "newdocs/README.txt",\n      "contents": base64encode("hello world\\n")\n    }\n  ]\n}\n
    \n
    5. \n
  5. \n

    File rename with changes: rename docs/README.txt with\nprevious content hello world\\n to a file at path\nnewdocs/README.txt with content new contents\\n:

    \n
    {\n  "deletions" [\n    {\n      "path": "docs/README.txt",\n    }\n  ],\n  "additions" [\n    {\n      "path": "newdocs/README.txt",\n      "contents": base64encode("new contents\\n")\n    }\n  ]\n}.\n
    \n
    6. \n
\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

additions ([FileAddition!])

File to add or change.

\n\n\n\n\n\n\n\n\n\n\n\n

deletions ([FileDeletion!])

Files to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n FileDeletion\n

\n

A command to delete the file at the given path as part of a commit.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

path (String!)

The path to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n FollowUserInput\n

\n

Autogenerated input type of FollowUser.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

userId (ID!)

ID of the user to follow.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n GistOrder\n

\n

Ordering options for gist connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (GistOrderField!)

The field to order repositories by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ImportProjectInput\n

\n

Autogenerated input type of ImportProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of Project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnImports ([ProjectColumnImport!]!)

A list of columns containing issues and pull requests.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of Project.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerName (String!)

The name of the Organization or User to create the Project under.

\n\n\n\n\n\n\n\n\n\n\n\n

public (Boolean)

Whether the Project is public or not.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n InviteEnterpriseAdminInput\n

\n

Autogenerated input type of InviteEnterpriseAdmin.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The email of the person to invite as an administrator.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise to which you want to invite an administrator.

\n\n\n\n\n\n\n\n\n\n\n\n

invitee (String)

The login of a user to invite as an administrator.

\n\n\n\n\n\n\n\n\n\n\n\n

role (EnterpriseAdministratorRole)

The role of the administrator.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IpAllowListEntryOrder\n

\n

Ordering options for IP allow list entry connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (IpAllowListEntryOrderField!)

The field to order IP allow list entries by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IssueCommentOrder\n

\n

Ways in which lists of issue comments can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order issue comments by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (IssueCommentOrderField!)

The field in which to order issue comments by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IssueFilters\n

\n

Ways in which to filter lists of issues.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assignee (String)

List issues assigned to given name. Pass in null for issues with no assigned\nuser, and * for issues assigned to any user.

\n\n\n\n\n\n\n\n\n\n\n\n

createdBy (String)

List issues created by given name.

\n\n\n\n\n\n\n\n\n\n\n\n

labels ([String!])

List issues where the list of label names exist on the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

mentioned (String)

List issues where the given name is mentioned in the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

milestone (String)

List issues by given milestone argument. If an string representation of an\ninteger is passed, it should refer to a milestone by its number field. Pass in\nnull for issues with no milestone, and * for issues that are assigned to any milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

since (DateTime)

List issues that have been updated at or after the given date.

\n\n\n\n\n\n\n\n\n\n\n\n

states ([IssueState!])

List issues filtered by the list of states given.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscribed (Boolean)

List issues subscribed to by viewer.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IssueOrder\n

\n

Ways in which lists of issues can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order issues by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (IssueOrderField!)

The field in which to order issues by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LabelOrder\n

\n

Ways in which lists of labels can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order labels by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (LabelOrderField!)

The field in which to order labels by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LanguageOrder\n

\n

Ordering options for language connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (LanguageOrderField!)

The field to order languages by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LinkRepositoryToProjectInput\n

\n

Autogenerated input type of LinkRepositoryToProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The ID of the Project to link to a Repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the Repository to link to a Project.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LockLockableInput\n

\n

Autogenerated input type of LockLockable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

lockReason (LockReason)

A reason for why the item will be locked.

\n\n\n\n\n\n\n\n\n\n\n\n

lockableId (ID!)

ID of the item to be locked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MarkDiscussionCommentAsAnswerInput\n

\n

Autogenerated input type of MarkDiscussionCommentAsAnswer.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the discussion comment to mark as an answer.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MarkFileAsViewedInput\n

\n

Autogenerated input type of MarkFileAsViewed.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path of the file to mark as viewed.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MarkPullRequestReadyForReviewInput\n

\n

Autogenerated input type of MarkPullRequestReadyForReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be marked as ready for review.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MergeBranchInput\n

\n

Autogenerated input type of MergeBranch.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

authorEmail (String)

The email address to associate with this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

base (String!)

The name of the base branch that the provided head will be merged into.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitMessage (String)

Message to use for the merge commit. If omitted, a default will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

head (String!)

The head to merge into the base branch. This can be a branch name or a commit GitObjectID.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the Repository containing the base branch that will be modified.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MergePullRequestInput\n

\n

Autogenerated input type of MergePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

authorEmail (String)

The email address to associate with this merge.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitBody (String)

Commit body to use for the merge commit; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

commitHeadline (String)

Commit headline to use for the merge commit; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

expectedHeadOid (GitObjectID)

OID that the pull request head ref must match to allow merge; if omitted, no check is performed.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeMethod (PullRequestMergeMethod)

The merge method to use. If omitted, defaults to 'MERGE'.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be merged.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MilestoneOrder\n

\n

Ordering options for milestone connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (MilestoneOrderField!)

The field to order milestones by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MinimizeCommentInput\n

\n

Autogenerated input type of MinimizeComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

classifier (ReportedContentClassifiers!)

The classification of comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MoveProjectCardInput\n

\n

Autogenerated input type of MoveProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

afterCardId (ID)

Place the new card after the card with this id. Pass null to place it at the top.

\n\n\n\n\n\n\n\n\n\n\n\n

cardId (ID!)

The id of the card to move.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnId (ID!)

The id of the column to move it into.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MoveProjectColumnInput\n

\n

Autogenerated input type of MoveProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

afterColumnId (ID)

Place the new column after the column with this id. Pass null to place it at the front.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnId (ID!)

The id of the column to move.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n OrganizationOrder\n

\n

Ordering options for organization connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (OrganizationOrderField!)

The field to order organizations by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PackageFileOrder\n

\n

Ways in which lists of package files can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection)

The direction in which to order package files by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (PackageFileOrderField)

The field in which to order package files by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PackageOrder\n

\n

Ways in which lists of packages can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection)

The direction in which to order packages by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (PackageOrderField)

The field in which to order packages by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PackageVersionOrder\n

\n

Ways in which lists of package versions can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection)

The direction in which to order package versions by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (PackageVersionOrderField)

The field in which to order package versions by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PinIssueInput\n

\n

Autogenerated input type of PinIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The ID of the issue to be pinned.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ProjectCardImport\n

\n

An issue or PR and its owning repository to be used in a project card.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

number (Int!)

The issue or pull request number.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (String!)

Repository name with owner (owner/repository).

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ProjectColumnImport\n

\n

A project column and a list of its issues and PRs.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

columnName (String!)

The name of the column.

\n\n\n\n\n\n\n\n\n\n\n\n

issues ([ProjectCardImport!])

A list of issues and pull requests in the column.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int!)

The position of the column, starting from 0.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ProjectOrder\n

\n

Ways in which lists of projects can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order projects by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (ProjectOrderField!)

The field in which to order projects by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PullRequestOrder\n

\n

Ways in which lists of issues can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order pull requests by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (PullRequestOrderField!)

The field in which to order pull requests by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReactionOrder\n

\n

Ways in which lists of reactions can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order reactions by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (ReactionOrderField!)

The field in which to order reactions by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RefOrder\n

\n

Ways in which lists of git refs can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order refs by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (RefOrderField!)

The field in which to order refs by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RefUpdate\n

\n

A ref update.

\n
\n\n
\n \n
\n

Preview notice

\n

RefUpdate is available under the Update refs preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

afterOid (GitObjectID!)

The value this ref should be updated to.

\n\n\n\n\n\n\n\n\n\n\n\n

beforeOid (GitObjectID)

The value this ref needs to point to before the update.

\n\n\n\n\n\n\n\n\n\n\n\n

force (Boolean)

Force a non fast-forward update.

\n\n\n\n\n\n\n\n\n\n\n\n

name (GitRefname!)

The fully qualified name of the ref to be update. For example refs/heads/branch-name.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RegenerateEnterpriseIdentityProviderRecoveryCodesInput\n

\n

Autogenerated input type of RegenerateEnterpriseIdentityProviderRecoveryCodes.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set an identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RegenerateVerifiableDomainTokenInput\n

\n

Autogenerated input type of RegenerateVerifiableDomainToken.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the verifiable domain to regenerate the verification token of.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RejectDeploymentsInput\n

\n

Autogenerated input type of RejectDeployments.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

comment (String)

Optional comment for rejecting deployments.

\n\n\n\n\n\n\n\n\n\n\n\n

environmentIds ([ID!]!)

The ids of environments to reject deployments.

\n\n\n\n\n\n\n\n\n\n\n\n

workflowRunId (ID!)

The node ID of the workflow run containing the pending deployments.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReleaseOrder\n

\n

Ways in which lists of releases can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order releases by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (ReleaseOrderField!)

The field in which to order releases by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveAssigneesFromAssignableInput\n

\n

Autogenerated input type of RemoveAssigneesFromAssignable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assignableId (ID!)

The id of the assignable object to remove assignees from.

\n\n\n\n\n\n\n\n\n\n\n\n

assigneeIds ([ID!]!)

The id of users to remove as assignees.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveEnterpriseAdminInput\n

\n

Autogenerated input type of RemoveEnterpriseAdmin.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The Enterprise ID from which to remove the administrator.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of the user to remove as an administrator.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveEnterpriseIdentityProviderInput\n

\n

Autogenerated input type of RemoveEnterpriseIdentityProvider.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise from which to remove the identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveEnterpriseOrganizationInput\n

\n

Autogenerated input type of RemoveEnterpriseOrganization.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise from which the organization should be removed.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationId (ID!)

The ID of the organization to remove from the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveEnterpriseSupportEntitlementInput\n

\n

Autogenerated input type of RemoveEnterpriseSupportEntitlement.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the Enterprise which the admin belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of a member who will lose the support entitlement.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveLabelsFromLabelableInput\n

\n

Autogenerated input type of RemoveLabelsFromLabelable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!]!)

The ids of labels to remove.

\n\n\n\n\n\n\n\n\n\n\n\n

labelableId (ID!)

The id of the Labelable to remove labels from.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveOutsideCollaboratorInput\n

\n

Autogenerated input type of RemoveOutsideCollaborator.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationId (ID!)

The ID of the organization to remove the outside collaborator from.

\n\n\n\n\n\n\n\n\n\n\n\n

userId (ID!)

The ID of the outside collaborator to remove.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveReactionInput\n

\n

Autogenerated input type of RemoveReaction.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

content (ReactionContent!)

The name of the emoji reaction to remove.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveStarInput\n

\n

Autogenerated input type of RemoveStar.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

starrableId (ID!)

The Starrable ID to unstar.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveUpvoteInput\n

\n

Autogenerated input type of RemoveUpvote.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the discussion or comment to remove upvote.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReopenIssueInput\n

\n

Autogenerated input type of ReopenIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

ID of the issue to be opened.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReopenPullRequestInput\n

\n

Autogenerated input type of ReopenPullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be reopened.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RepositoryInvitationOrder\n

\n

Ordering options for repository invitation connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (RepositoryInvitationOrderField!)

The field to order repository invitations by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RepositoryOrder\n

\n

Ordering options for repository connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (RepositoryOrderField!)

The field to order repositories by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RequestReviewsInput\n

\n

Autogenerated input type of RequestReviews.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

teamIds ([ID!])

The Node IDs of the team to request.

\n\n\n\n\n\n\n\n\n\n\n\n

union (Boolean)

Add users to the set rather than replace.

\n\n\n\n\n\n\n\n\n\n\n\n

userIds ([ID!])

The Node IDs of the user to request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RerequestCheckSuiteInput\n

\n

Autogenerated input type of RerequestCheckSuite.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

checkSuiteId (ID!)

The Node ID of the check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ResolveReviewThreadInput\n

\n

Autogenerated input type of ResolveReviewThread.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

threadId (ID!)

The ID of the thread to resolve.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SavedReplyOrder\n

\n

Ordering options for saved reply connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SavedReplyOrderField!)

The field to order saved replies by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryIdentifierFilter\n

\n

An advisory identifier to filter results on.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

type (SecurityAdvisoryIdentifierType!)

The identifier type.

\n\n\n\n\n\n\n\n\n\n\n\n

value (String!)

The identifier string. Supports exact or partial matching.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryOrder\n

\n

Ordering options for security advisory connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SecurityAdvisoryOrderField!)

The field to order security advisories by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SecurityVulnerabilityOrder\n

\n

Ordering options for security vulnerability connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SecurityVulnerabilityOrderField!)

The field to order security vulnerabilities by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SetEnterpriseIdentityProviderInput\n

\n

Autogenerated input type of SetEnterpriseIdentityProvider.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

digestMethod (SamlDigestAlgorithm!)

The digest algorithm used to sign SAML requests for the identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set an identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n

idpCertificate (String!)

The x509 certificate used by the identity provider to sign assertions and responses.

\n\n\n\n\n\n\n\n\n\n\n\n

issuer (String)

The Issuer Entity ID for the SAML identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n

signatureMethod (SamlSignatureAlgorithm!)

The signature algorithm used to sign SAML requests for the identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n

ssoUrl (URI!)

The URL endpoint for the identity provider's SAML SSO.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SetOrganizationInteractionLimitInput\n

\n

Autogenerated input type of SetOrganizationInteractionLimit.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

expiry (RepositoryInteractionLimitExpiry)

When this limit should expire.

\n\n\n\n\n\n\n\n\n\n\n\n

limit (RepositoryInteractionLimit!)

The limit to set.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationId (ID!)

The ID of the organization to set a limit for.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SetRepositoryInteractionLimitInput\n

\n

Autogenerated input type of SetRepositoryInteractionLimit.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

expiry (RepositoryInteractionLimitExpiry)

When this limit should expire.

\n\n\n\n\n\n\n\n\n\n\n\n

limit (RepositoryInteractionLimit!)

The limit to set.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to set a limit for.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SetUserInteractionLimitInput\n

\n

Autogenerated input type of SetUserInteractionLimit.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

expiry (RepositoryInteractionLimitExpiry)

When this limit should expire.

\n\n\n\n\n\n\n\n\n\n\n\n

limit (RepositoryInteractionLimit!)

The limit to set.

\n\n\n\n\n\n\n\n\n\n\n\n

userId (ID!)

The ID of the user to set a limit for.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SponsorOrder\n

\n

Ordering options for connections to get sponsor entities for GitHub Sponsors.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SponsorOrderField!)

The field to order sponsor entities by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SponsorableOrder\n

\n

Ordering options for connections to get sponsorable entities for GitHub Sponsors.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SponsorableOrderField!)

The field to order sponsorable entities by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SponsorsActivityOrder\n

\n

Ordering options for GitHub Sponsors activity connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SponsorsActivityOrderField!)

The field to order activity by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SponsorsTierOrder\n

\n

Ordering options for Sponsors tiers connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SponsorsTierOrderField!)

The field to order tiers by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SponsorshipNewsletterOrder\n

\n

Ordering options for sponsorship newsletter connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SponsorshipNewsletterOrderField!)

The field to order sponsorship newsletters by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SponsorshipOrder\n

\n

Ordering options for sponsorship connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SponsorshipOrderField!)

The field to order sponsorship by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n StarOrder\n

\n

Ways in which star connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (StarOrderField!)

The field in which to order nodes by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SubmitPullRequestReviewInput\n

\n

Autogenerated input type of SubmitPullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The text field to set on the Pull Request Review.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

event (PullRequestReviewEvent!)

The event to send to the Pull Request Review.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID)

The Pull Request ID to submit any pending reviews.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID)

The Pull Request Review ID to submit.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamDiscussionCommentOrder\n

\n

Ways in which team discussion comment connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamDiscussionCommentOrderField!)

The field by which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamDiscussionOrder\n

\n

Ways in which team discussion connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamDiscussionOrderField!)

The field by which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamMemberOrder\n

\n

Ordering options for team member connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamMemberOrderField!)

The field to order team members by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamOrder\n

\n

Ways in which team connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamOrderField!)

The field in which to order nodes by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamRepositoryOrder\n

\n

Ordering options for team repository connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamRepositoryOrderField!)

The field to order repositories by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TransferIssueInput\n

\n

Autogenerated input type of TransferIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The Node ID of the issue to be transferred.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository the issue should be transferred to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnarchiveRepositoryInput\n

\n

Autogenerated input type of UnarchiveRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to unarchive.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnfollowUserInput\n

\n

Autogenerated input type of UnfollowUser.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

userId (ID!)

ID of the user to unfollow.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnlinkRepositoryFromProjectInput\n

\n

Autogenerated input type of UnlinkRepositoryFromProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The ID of the Project linked to the Repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the Repository linked to the Project.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnlockLockableInput\n

\n

Autogenerated input type of UnlockLockable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

lockableId (ID!)

ID of the item to be unlocked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnmarkDiscussionCommentAsAnswerInput\n

\n

Autogenerated input type of UnmarkDiscussionCommentAsAnswer.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the discussion comment to unmark as an answer.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnmarkFileAsViewedInput\n

\n

Autogenerated input type of UnmarkFileAsViewed.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path of the file to mark as unviewed.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnmarkIssueAsDuplicateInput\n

\n

Autogenerated input type of UnmarkIssueAsDuplicate.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

canonicalId (ID!)

ID of the issue or pull request currently considered canonical/authoritative/original.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

duplicateId (ID!)

ID of the issue or pull request currently marked as a duplicate.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnminimizeCommentInput\n

\n

Autogenerated input type of UnminimizeComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnpinIssueInput\n

\n

Autogenerated input type of UnpinIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The ID of the issue to be unpinned.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnresolveReviewThreadInput\n

\n

Autogenerated input type of UnresolveReviewThread.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

threadId (ID!)

The ID of the thread to unresolve.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateBranchProtectionRuleInput\n

\n

Autogenerated input type of UpdateBranchProtectionRule.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowsDeletions (Boolean)

Can this branch be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

allowsForcePushes (Boolean)

Are force pushes allowed on this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

branchProtectionRuleId (ID!)

The global relay id of the branch protection rule to be updated.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissesStaleReviews (Boolean)

Will new commits pushed to matching branches dismiss pull request review approvals.

\n\n\n\n\n\n\n\n\n\n\n\n

isAdminEnforced (Boolean)

Can admins overwrite branch protection.

\n\n\n\n\n\n\n\n\n\n\n\n

pattern (String)

The glob-like pattern used to determine matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

pushActorIds ([ID!])

A list of User, Team or App IDs allowed to push to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredStatusCheckContexts ([String!])

List of required status check contexts that must pass for commits to be accepted to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresApprovingReviews (Boolean)

Are approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCodeOwnerReviews (Boolean)

Are reviews from code owners required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCommitSignatures (Boolean)

Are commits required to be signed.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresConversationResolution (Boolean)

Are conversations required to be resolved before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresLinearHistory (Boolean)

Are merge commits prohibited from being pushed to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStatusChecks (Boolean)

Are status checks required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStrictStatusChecks (Boolean)

Are branches required to be up to date before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsPushes (Boolean)

Is pushing to matching branches restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsReviewDismissals (Boolean)

Is dismissal of pull request reviews restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDismissalActorIds ([ID!])

A list of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateCheckRunInput\n

\n

Autogenerated input type of UpdateCheckRun.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actions ([CheckRunAction!])

Possible further actions the integrator can perform, which a user may trigger.

\n\n\n\n\n\n\n\n\n\n\n\n

checkRunId (ID!)

The node of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

completedAt (DateTime)

The time that the check run finished.

\n\n\n\n\n\n\n\n\n\n\n\n

conclusion (CheckConclusionState)

The final conclusion of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

detailsUrl (URI)

The URL of the integrator's site that has the full details of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

externalId (String)

A reference for the run on the integrator's system.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

output (CheckRunOutput)

Descriptive details about the run.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

startedAt (DateTime)

The time that the check run began.

\n\n\n\n\n\n\n\n\n\n\n\n

status (RequestableCheckStatusState)

The current status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateCheckSuitePreferencesInput\n

\n

Autogenerated input type of UpdateCheckSuitePreferences.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

autoTriggerPreferences ([CheckSuiteAutoTriggerPreference!]!)

The check suite preferences to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateDiscussionCommentInput\n

\n

Autogenerated input type of UpdateDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The new contents of the comment body.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commentId (ID!)

The Node ID of the discussion comment to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateDiscussionInput\n

\n

Autogenerated input type of UpdateDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The new contents of the discussion body.

\n\n\n\n\n\n\n\n\n\n\n\n

categoryId (ID)

The Node ID of a discussion category within the same repository to change this discussion to.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

discussionId (ID!)

The Node ID of the discussion to update.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The new discussion title.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseAdministratorRoleInput\n

\n

Autogenerated input type of UpdateEnterpriseAdministratorRole.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the Enterprise which the admin belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of a administrator whose role is being changed.

\n\n\n\n\n\n\n\n\n\n\n\n

role (EnterpriseAdministratorRole!)

The new role for the Enterprise administrator.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseAllowPrivateRepositoryForkingSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the allow private repository forking setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the allow private repository forking setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseDefaultRepositoryPermissionSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseDefaultRepositoryPermissionSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the base repository permission setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseDefaultRepositoryPermissionSettingValue!)

The value for the base repository permission setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanChangeRepositoryVisibilitySetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can change repository visibility setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can change repository visibility setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanCreateRepositoriesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanCreateRepositoriesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can create repositories setting.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreateInternalRepositories (Boolean)

Allow members to create internal repositories. Defaults to current value.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreatePrivateRepositories (Boolean)

Allow members to create private repositories. Defaults to current value.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreatePublicRepositories (Boolean)

Allow members to create public repositories. Defaults to current value.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreateRepositoriesPolicyEnabled (Boolean)

When false, allow member organizations to set their own repository creation member privileges.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseMembersCanCreateRepositoriesSettingValue)

Value for the members can create repositories setting on the enterprise. This\nor the granular public/private/internal allowed fields (but not both) must be provided.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanDeleteIssuesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanDeleteIssuesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can delete issues setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can delete issues setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanDeleteRepositoriesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can delete repositories setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can delete repositories setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanInviteCollaboratorsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can invite collaborators setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can invite collaborators setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanMakePurchasesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanMakePurchasesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can make purchases setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseMembersCanMakePurchasesSettingValue!)

The value for the members can make purchases setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanUpdateProtectedBranchesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can update protected branches setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can update protected branches setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanViewDependencyInsightsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can view dependency insights setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can view dependency insights setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseOrganizationProjectsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseOrganizationProjectsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the organization projects setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the organization projects setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseProfileInput\n

\n

Autogenerated input type of UpdateEnterpriseProfile.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The Enterprise ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n

location (String)

The location of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

websiteUrl (String)

The URL of the enterprise's website.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseRepositoryProjectsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseRepositoryProjectsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the repository projects setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the repository projects setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseTeamDiscussionsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseTeamDiscussionsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the team discussions setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the team discussions setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseTwoFactorAuthenticationRequiredSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the two factor authentication required setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledSettingValue!)

The value for the two factor authentication required setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnvironmentInput\n

\n

Autogenerated input type of UpdateEnvironment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

environmentId (ID!)

The node ID of the environment.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewers ([ID!])

The ids of users or teams that can approve deployments to this environment.

\n\n\n\n\n\n\n\n\n\n\n\n

waitTimer (Int)

The wait timer in minutes.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIpAllowListEnabledSettingInput\n

\n

Autogenerated input type of UpdateIpAllowListEnabledSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner on which to set the IP allow list enabled setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (IpAllowListEnabledSettingValue!)

The value for the IP allow list enabled setting.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIpAllowListEntryInput\n

\n

Autogenerated input type of UpdateIpAllowListEntry.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowListValue (String!)

An IP address or range of addresses in CIDR notation.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEntryId (ID!)

The ID of the IP allow list entry to update.

\n\n\n\n\n\n\n\n\n\n\n\n

isActive (Boolean!)

Whether the IP allow list entry is active when an IP allow list is enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

An optional name for the IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIpAllowListForInstalledAppsEnabledSettingInput\n

\n

Autogenerated input type of UpdateIpAllowListForInstalledAppsEnabledSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (IpAllowListForInstalledAppsEnabledSettingValue!)

The value for the IP allow list configuration for installed GitHub Apps setting.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIssueCommentInput\n

\n

Autogenerated input type of UpdateIssueComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The updated text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the IssueComment to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIssueInput\n

\n

Autogenerated input type of UpdateIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assigneeIds ([ID!])

An array of Node IDs of users for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The body for the issue description.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the Issue to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!])

An array of Node IDs of labels for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneId (ID)

The Node ID of the milestone for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

projectIds ([ID!])

An array of Node IDs for projects associated with this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

state (IssueState)

The desired issue state.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title for the issue.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateLabelInput\n

\n

Autogenerated input type of UpdateLabel.

\n
\n\n
\n \n
\n

Preview notice

\n

UpdateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

color (String)

A 6 character hex code, without the leading #, identifying the updated color of the label.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A brief description of the label, such as its purpose.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the label to be updated.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The updated name of the label.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateNotificationRestrictionSettingInput\n

\n

Autogenerated input type of UpdateNotificationRestrictionSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner on which to set the restrict notifications setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (NotificationRestrictionSettingValue!)

The value for the restrict notifications setting.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateProjectCardInput\n

\n

Autogenerated input type of UpdateProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

isArchived (Boolean)

Whether or not the ProjectCard should be archived.

\n\n\n\n\n\n\n\n\n\n\n\n

note (String)

The note of ProjectCard.

\n\n\n\n\n\n\n\n\n\n\n\n

projectCardId (ID!)

The ProjectCard ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateProjectColumnInput\n

\n

Autogenerated input type of UpdateProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of project column.

\n\n\n\n\n\n\n\n\n\n\n\n

projectColumnId (ID!)

The ProjectColumn ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateProjectInput\n

\n

Autogenerated input type of UpdateProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of project.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The Project ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n

public (Boolean)

Whether the project is public or not.

\n\n\n\n\n\n\n\n\n\n\n\n

state (ProjectState)

Whether the project is open or closed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdatePullRequestInput\n

\n

Autogenerated input type of UpdatePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assigneeIds ([ID!])

An array of Node IDs of users for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRefName (String)

The name of the branch you want your changes pulled into. This should be an existing branch\non the current repository.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The contents of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!])

An array of Node IDs of labels for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

maintainerCanModify (Boolean)

Indicates whether maintainers can modify the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneId (ID)

The Node ID of the milestone for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

projectIds ([ID!])

An array of Node IDs for projects associated with this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

state (PullRequestUpdateState)

The target state of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdatePullRequestReviewCommentInput\n

\n

Autogenerated input type of UpdatePullRequestReviewComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewCommentId (ID!)

The Node ID of the comment to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdatePullRequestReviewInput\n

\n

Autogenerated input type of UpdatePullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The contents of the pull request review body.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID!)

The Node ID of the pull request review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateRefInput\n

\n

Autogenerated input type of UpdateRef.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

force (Boolean)

Permit updates of branch Refs that are not fast-forwards?.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The GitObjectID that the Ref shall be updated to target.

\n\n\n\n\n\n\n\n\n\n\n\n

refId (ID!)

The Node ID of the Ref to be updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateRefsInput\n

\n

Autogenerated input type of UpdateRefs.

\n
\n\n
\n \n
\n

Preview notice

\n

UpdateRefsInput is available under the Update refs preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

refUpdates ([RefUpdate!]!)

A list of ref updates.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateRepositoryInput\n

\n

Autogenerated input type of UpdateRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A new description for the repository. Pass an empty string to erase the existing description.

\n\n\n\n\n\n\n\n\n\n\n\n

hasIssuesEnabled (Boolean)

Indicates if the repository should have the issues feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasProjectsEnabled (Boolean)

Indicates if the repository should have the project boards feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasWikiEnabled (Boolean)

Indicates if the repository should have the wiki feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

homepageUrl (URI)

The URL for a web page about this repository. Pass an empty string to erase the existing URL.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The new name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to update.

\n\n\n\n\n\n\n\n\n\n\n\n

template (Boolean)

Whether this repository should be marked as a template such that anyone who\ncan access it can create new repositories with the same files and directory structure.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateSubscriptionInput\n

\n

Autogenerated input type of UpdateSubscription.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

state (SubscriptionState!)

The new state of the subscription.

\n\n\n\n\n\n\n\n\n\n\n\n

subscribableId (ID!)

The Node ID of the subscribable object to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTeamDiscussionCommentInput\n

\n

Autogenerated input type of UpdateTeamDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The updated text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyVersion (String)

The current version of the body content.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTeamDiscussionInput\n

\n

Autogenerated input type of UpdateTeamDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The updated text of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyVersion (String)

The current version of the body content. If provided, this update operation\nwill be rejected if the given version does not match the latest version on the server.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the discussion to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

pinned (Boolean)

If provided, sets the pinned state of the updated discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The updated title of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTeamReviewAssignmentInput\n

\n

Autogenerated input type of UpdateTeamReviewAssignment.

\n
\n\n
\n \n
\n

Preview notice

\n

UpdateTeamReviewAssignmentInput is available under the Team review assignments preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

algorithm (TeamReviewAssignmentAlgorithm)

The algorithm to use for review assignment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enabled (Boolean!)

Turn on or off review assignment.

\n\n\n\n\n\n\n\n\n\n\n\n

excludedTeamMemberIds ([ID!])

An array of team member IDs to exclude.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the team to update review assignments of.

\n\n\n\n\n\n\n\n\n\n\n\n

notifyTeam (Boolean)

Notify the entire team of the PR if it is delegated.

\n\n\n\n\n\n\n\n\n\n\n\n

teamMemberCount (Int)

The number of team members to assign.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTopicsInput\n

\n

Autogenerated input type of UpdateTopics.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

topicNames ([String!]!)

An array of topic names.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UserStatusOrder\n

\n

Ordering options for user status connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (UserStatusOrderField!)

The field to order user statuses by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n VerifiableDomainOrder\n

\n

Ordering options for verifiable domain connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (VerifiableDomainOrderField!)

The field to order verifiable domains by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n VerifyVerifiableDomainInput\n

\n

Autogenerated input type of VerifyVerifiableDomain.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the verifiable domain to verify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n", + "html": "
\n
\n

\n AcceptEnterpriseAdministratorInvitationInput\n

\n

Autogenerated input type of AcceptEnterpriseAdministratorInvitation.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

invitationId (ID!)

The id of the invitation being accepted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AcceptTopicSuggestionInput\n

\n

Autogenerated input type of AcceptTopicSuggestion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the suggested topic.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddAssigneesToAssignableInput\n

\n

Autogenerated input type of AddAssigneesToAssignable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assignableId (ID!)

The id of the assignable object to add assignees to.

\n\n\n\n\n\n\n\n\n\n\n\n

assigneeIds ([ID!]!)

The id of users to add as assignees.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddCommentInput\n

\n

Autogenerated input type of AddComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The contents of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddDiscussionCommentInput\n

\n

Autogenerated input type of AddDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The contents of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

discussionId (ID!)

The Node ID of the discussion to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

replyToId (ID)

The Node ID of the discussion comment within this discussion to reply to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddEnterpriseSupportEntitlementInput\n

\n

Autogenerated input type of AddEnterpriseSupportEntitlement.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the Enterprise which the admin belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of a member who will receive the support entitlement.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddLabelsToLabelableInput\n

\n

Autogenerated input type of AddLabelsToLabelable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!]!)

The ids of the labels to add.

\n\n\n\n\n\n\n\n\n\n\n\n

labelableId (ID!)

The id of the labelable object to add labels to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddProjectCardInput\n

\n

Autogenerated input type of AddProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

contentId (ID)

The content of the card. Must be a member of the ProjectCardItem union.

\n\n\n\n\n\n\n\n\n\n\n\n

note (String)

The note on the card.

\n\n\n\n\n\n\n\n\n\n\n\n

projectColumnId (ID!)

The Node ID of the ProjectColumn.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddProjectColumnInput\n

\n

Autogenerated input type of AddProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the column.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The Node ID of the project.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddPullRequestReviewCommentInput\n

\n

Autogenerated input type of AddPullRequestReviewComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitOID (GitObjectID)

The SHA of the commit to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

inReplyTo (ID)

The comment id to reply to.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String)

The relative path of the file to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int)

The line index in the diff to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID)

The node ID of the pull request reviewing.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID)

The Node ID of the review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddPullRequestReviewInput\n

\n

Autogenerated input type of AddPullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The contents of the review body comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

comments ([DraftPullRequestReviewComment])

The review line comments.

\n\n\n\n\n\n\n\n\n\n\n\n

commitOID (GitObjectID)

The commit OID the review pertains to.

\n\n\n\n\n\n\n\n\n\n\n\n

event (PullRequestReviewEvent)

The event to perform on the pull request review.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

threads ([DraftPullRequestReviewThread])

The review line comment threads.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddPullRequestReviewThreadInput\n

\n

Autogenerated input type of AddPullRequestReviewThread.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

Body of the thread's first comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

line (Int!)

The line of the blob to which the thread refers. The end of the line range for multi-line comments.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

Path to the file being commented on.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID)

The node ID of the pull request reviewing.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID)

The Node ID of the review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

side (DiffSide)

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.

\n\n\n\n\n\n\n\n\n\n\n\n

startLine (Int)

The first line of the range to which the comment refers.

\n\n\n\n\n\n\n\n\n\n\n\n

startSide (DiffSide)

The side of the diff on which the start line resides.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddReactionInput\n

\n

Autogenerated input type of AddReaction.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

content (ReactionContent!)

The name of the emoji to react with.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddStarInput\n

\n

Autogenerated input type of AddStar.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

starrableId (ID!)

The Starrable ID to star.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddUpvoteInput\n

\n

Autogenerated input type of AddUpvote.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the discussion or comment to upvote.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddVerifiableDomainInput\n

\n

Autogenerated input type of AddVerifiableDomain.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

domain (URI!)

The URL of the domain.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner to add the domain to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ApproveDeploymentsInput\n

\n

Autogenerated input type of ApproveDeployments.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

comment (String)

Optional comment for approving deployments.

\n\n\n\n\n\n\n\n\n\n\n\n

environmentIds ([ID!]!)

The ids of environments to reject deployments.

\n\n\n\n\n\n\n\n\n\n\n\n

workflowRunId (ID!)

The node ID of the workflow run containing the pending deployments.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ApproveVerifiableDomainInput\n

\n

Autogenerated input type of ApproveVerifiableDomain.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the verifiable domain to approve.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ArchiveRepositoryInput\n

\n

Autogenerated input type of ArchiveRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to mark as archived.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AuditLogOrder\n

\n

Ordering options for Audit Log connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (AuditLogOrderField)

The field to order Audit Logs by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CancelEnterpriseAdminInvitationInput\n

\n

Autogenerated input type of CancelEnterpriseAdminInvitation.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

invitationId (ID!)

The Node ID of the pending enterprise administrator invitation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CancelSponsorshipInput\n

\n

Autogenerated input type of CancelSponsorship.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorId (ID)

The ID of the user or organization who is acting as the sponsor, paying for\nthe sponsorship. Required if sponsorLogin is not given.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorLogin (String)

The username of the user or organization who is acting as the sponsor, paying\nfor the sponsorship. Required if sponsorId is not given.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorableId (ID)

The ID of the user or organization who is receiving the sponsorship. Required if sponsorableLogin is not given.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorableLogin (String)

The username of the user or organization who is receiving the sponsorship. Required if sponsorableId is not given.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ChangeUserStatusInput\n

\n

Autogenerated input type of ChangeUserStatus.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

emoji (String)

The emoji to represent your status. Can either be a native Unicode emoji or an emoji name with colons, e.g., 😀.

\n\n\n\n\n\n\n\n\n\n\n\n

expiresAt (DateTime)

If set, the user status will not be shown after this date.

\n\n\n\n\n\n\n\n\n\n\n\n

limitedAvailability (Boolean)

Whether this status should indicate you are not fully available on GitHub, e.g., you are away.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String)

A short description of your current status.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationId (ID)

The ID of the organization whose members will be allowed to see the status. If\nomitted, the status will be publicly visible.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckAnnotationData\n

\n

Information from a check run analysis to specific lines of code.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

annotationLevel (CheckAnnotationLevel!)

Represents an annotation's information level.

\n\n\n\n\n\n\n\n\n\n\n\n

location (CheckAnnotationRange!)

The location of the annotation.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String!)

A short description of the feedback for these lines of code.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path of the file to add an annotation to.

\n\n\n\n\n\n\n\n\n\n\n\n

rawDetails (String)

Details about this annotation.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title that represents the annotation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckAnnotationRange\n

\n

Information from a check run analysis to specific lines of code.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

endColumn (Int)

The ending column of the range.

\n\n\n\n\n\n\n\n\n\n\n\n

endLine (Int!)

The ending line of the range.

\n\n\n\n\n\n\n\n\n\n\n\n

startColumn (Int)

The starting column of the range.

\n\n\n\n\n\n\n\n\n\n\n\n

startLine (Int!)

The starting line of the range.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunAction\n

\n

Possible further actions the integrator can perform.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

description (String!)

A short explanation of what this action would do.

\n\n\n\n\n\n\n\n\n\n\n\n

identifier (String!)

A reference for the action on the integrator's system.

\n\n\n\n\n\n\n\n\n\n\n\n

label (String!)

The text to be displayed on a button in the web UI.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunFilter\n

\n

The filters that are available when fetching check runs.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

appId (Int)

Filters the check runs created by this application ID.

\n\n\n\n\n\n\n\n\n\n\n\n

checkName (String)

Filters the check runs by this name.

\n\n\n\n\n\n\n\n\n\n\n\n

checkType (CheckRunType)

Filters the check runs by this type.

\n\n\n\n\n\n\n\n\n\n\n\n

status (CheckStatusState)

Filters the check runs by this status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunOutput\n

\n

Descriptive details about the check run.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

annotations ([CheckAnnotationData!])

The annotations that are made as part of the check run.

\n\n\n\n\n\n\n\n\n\n\n\n

images ([CheckRunOutputImage!])

Images attached to the check run output displayed in the GitHub pull request UI.

\n\n\n\n\n\n\n\n\n\n\n\n

summary (String!)

The summary of the check run (supports Commonmark).

\n\n\n\n\n\n\n\n\n\n\n\n

text (String)

The details of the check run (supports Commonmark).

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

A title to provide for this check run.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunOutputImage\n

\n

Images attached to the check run output displayed in the GitHub pull request UI.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

alt (String!)

The alternative text for the image.

\n\n\n\n\n\n\n\n\n\n\n\n

caption (String)

A short image description.

\n\n\n\n\n\n\n\n\n\n\n\n

imageUrl (URI!)

The full URL of the image.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckSuiteAutoTriggerPreference\n

\n

The auto-trigger preferences that are available for check suites.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

appId (ID!)

The node ID of the application that owns the check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

setting (Boolean!)

Set to true to enable automatic creation of CheckSuite events upon pushes to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckSuiteFilter\n

\n

The filters that are available when fetching check suites.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

appId (Int)

Filters the check suites created by this application ID.

\n\n\n\n\n\n\n\n\n\n\n\n

checkName (String)

Filters the check suites by this name.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ClearLabelsFromLabelableInput\n

\n

Autogenerated input type of ClearLabelsFromLabelable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelableId (ID!)

The id of the labelable object to clear the labels from.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CloneProjectInput\n

\n

Autogenerated input type of CloneProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of the project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

includeWorkflows (Boolean!)

Whether or not to clone the source project's workflows.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the project.

\n\n\n\n\n\n\n\n\n\n\n\n

public (Boolean)

The visibility of the project, defaults to false (private).

\n\n\n\n\n\n\n\n\n\n\n\n

sourceId (ID!)

The source project to clone.

\n\n\n\n\n\n\n\n\n\n\n\n

targetOwnerId (ID!)

The owner ID to create the project under.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CloneTemplateRepositoryInput\n

\n

Autogenerated input type of CloneTemplateRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A short description of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

includeAllBranches (Boolean)

Whether to copy all branches from the template to the new repository. Defaults\nto copying only the default branch of the template.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner for the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the template repository.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepositoryVisibility!)

Indicates the repository's visibility level.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CloseIssueInput\n

\n

Autogenerated input type of CloseIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

ID of the issue to be closed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ClosePullRequestInput\n

\n

Autogenerated input type of ClosePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be closed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CommitAuthor\n

\n

Specifies an author for filtering Git commits.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

emails ([String!])

Email addresses to filter by. Commits authored by any of the specified email addresses will be returned.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID)

ID of a User to filter by. If non-null, only commits authored by this user\nwill be returned. This field takes precedence over emails.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CommitContributionOrder\n

\n

Ordering options for commit contribution connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (CommitContributionOrderField!)

The field by which to order commit contributions.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CommitMessage\n

\n

A message to include with a new commit.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The body of the message.

\n\n\n\n\n\n\n\n\n\n\n\n

headline (String!)

The headline of the message.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CommittableBranch\n

\n

A git ref for a commit to be appended to.

\n

The ref must be a branch, i.e. its fully qualified name must start\nwith refs/heads/ (although the input is not required to be fully\nqualified).

\n

The Ref may be specified by its global node ID or by the\nrepository nameWithOwner and branch name.

\n

Examples

\n

Specify a branch using a global node ID:

\n
{ "id": "MDM6UmVmMTpyZWZzL2hlYWRzL21haW4=" }\n
\n

Specify a branch using nameWithOwner and branch name:

\n
{\n  "nameWithOwner": "github/graphql-client",\n  "branchName": "main"\n}.\n
\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

branchName (String)

The unqualified name of the branch to append the commit to.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID)

The Node ID of the Ref to be updated.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryNameWithOwner (String)

The nameWithOwner of the repository to commit to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ContributionOrder\n

\n

Ordering options for contribution connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ConvertProjectCardNoteToIssueInput\n

\n

Autogenerated input type of ConvertProjectCardNoteToIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The body of the newly created issue.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectCardId (ID!)

The ProjectCard ID to convert.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to create the issue in.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title of the newly created issue. Defaults to the card's note text.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ConvertPullRequestToDraftInput\n

\n

Autogenerated input type of ConvertPullRequestToDraft.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to convert to draft.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateBranchProtectionRuleInput\n

\n

Autogenerated input type of CreateBranchProtectionRule.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowsDeletions (Boolean)

Can this branch be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

allowsForcePushes (Boolean)

Are force pushes allowed on this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissesStaleReviews (Boolean)

Will new commits pushed to matching branches dismiss pull request review approvals.

\n\n\n\n\n\n\n\n\n\n\n\n

isAdminEnforced (Boolean)

Can admins overwrite branch protection.

\n\n\n\n\n\n\n\n\n\n\n\n

pattern (String!)

The glob-like pattern used to determine matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

pushActorIds ([ID!])

A list of User, Team or App IDs allowed to push to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The global relay id of the repository in which a new branch protection rule should be created in.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredStatusCheckContexts ([String!])

List of required status check contexts that must pass for commits to be accepted to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresApprovingReviews (Boolean)

Are approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCodeOwnerReviews (Boolean)

Are reviews from code owners required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCommitSignatures (Boolean)

Are commits required to be signed.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresConversationResolution (Boolean)

Are conversations required to be resolved before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresLinearHistory (Boolean)

Are merge commits prohibited from being pushed to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStatusChecks (Boolean)

Are status checks required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStrictStatusChecks (Boolean)

Are branches required to be up to date before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsPushes (Boolean)

Is pushing to matching branches restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsReviewDismissals (Boolean)

Is dismissal of pull request reviews restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDismissalActorIds ([ID!])

A list of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateCheckRunInput\n

\n

Autogenerated input type of CreateCheckRun.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actions ([CheckRunAction!])

Possible further actions the integrator can perform, which a user may trigger.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

completedAt (DateTime)

The time that the check run finished.

\n\n\n\n\n\n\n\n\n\n\n\n

conclusion (CheckConclusionState)

The final conclusion of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

detailsUrl (URI)

The URL of the integrator's site that has the full details of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

externalId (String)

A reference for the run on the integrator's system.

\n\n\n\n\n\n\n\n\n\n\n\n

headSha (GitObjectID!)

The SHA of the head commit.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

output (CheckRunOutput)

Descriptive details about the run.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

startedAt (DateTime)

The time that the check run began.

\n\n\n\n\n\n\n\n\n\n\n\n

status (RequestableCheckStatusState)

The current status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateCheckSuiteInput\n

\n

Autogenerated input type of CreateCheckSuite.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

headSha (GitObjectID!)

The SHA of the head commit.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateCommitOnBranchInput\n

\n

Autogenerated input type of CreateCommitOnBranch.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

branch (CommittableBranch!)

The Ref to be updated. Must be a branch.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

expectedHeadOid (GitObjectID!)

The git commit oid expected at the head of the branch prior to the commit.

\n\n\n\n\n\n\n\n\n\n\n\n

fileChanges (FileChanges)

A description of changes to files in this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

message (CommitMessage!)

The commit message the be included with the commit.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateContentAttachmentInput\n

\n

Autogenerated input type of CreateContentAttachment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The body of the content attachment, which may contain markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

contentReferenceId (ID!)

The node ID of the content_reference.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the content attachment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateDeploymentInput\n

\n

Autogenerated input type of CreateDeployment.

\n
\n\n
\n \n
\n

Preview notice

\n

CreateDeploymentInput is available under the Deployments preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

autoMerge (Boolean)

Attempt to automatically merge the default branch into the requested ref, defaults to true.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

Short description of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

environment (String)

Name for the target deployment environment.

\n\n\n\n\n\n\n\n\n\n\n\n

payload (String)

JSON payload with extra information about the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

refId (ID!)

The node ID of the ref to be deployed.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredContexts ([String!])

The status contexts to verify against commit status checks. To bypass required\ncontexts, pass an empty array. Defaults to all unique contexts.

\n\n\n\n\n\n\n\n\n\n\n\n

task (String)

Specifies a task to execute.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateDeploymentStatusInput\n

\n

Autogenerated input type of CreateDeploymentStatus.

\n
\n\n
\n \n
\n

Preview notice

\n

CreateDeploymentStatusInput is available under the Deployments preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

autoInactive (Boolean)

Adds a new inactive status to all non-transient, non-production environment\ndeployments with the same repository and environment name as the created\nstatus's deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

deploymentId (ID!)

The node ID of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A short description of the status. Maximum length of 140 characters.

\n\n\n\n\n\n\n\n\n\n\n\n

environment (String)

If provided, updates the environment of the deploy. Otherwise, does not modify the environment.

\n\n\n\n\n\n\n\n\n\n\n\n

environmentUrl (String)

Sets the URL for accessing your environment.

\n\n\n\n\n\n\n\n\n\n\n\n

logUrl (String)

The log URL to associate with this status. This URL should contain\noutput to keep the user updated while the task is running or serve as\nhistorical information for what happened in the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

state (DeploymentStatusState!)

The state of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateDiscussionInput\n

\n

Autogenerated input type of CreateDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The body of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

categoryId (ID!)

The id of the discussion category to associate with this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The id of the repository on which to create the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateEnterpriseOrganizationInput\n

\n

Autogenerated input type of CreateEnterpriseOrganization.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

adminLogins ([String!]!)

The logins for the administrators of the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n

billingEmail (String!)

The email used for sending billing receipts.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise owning the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n

profileName (String!)

The profile name of the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateEnvironmentInput\n

\n

Autogenerated input type of CreateEnvironment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the environment.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateIpAllowListEntryInput\n

\n

Autogenerated input type of CreateIpAllowListEntry.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowListValue (String!)

An IP address or range of addresses in CIDR notation.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

isActive (Boolean!)

Whether the IP allow list entry is active when an IP allow list is enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

An optional name for the IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner for which to create the new IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateIssueInput\n

\n

Autogenerated input type of CreateIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assigneeIds ([ID!])

The Node ID for the user assignee for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The body for the issue description.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueTemplate (String)

The name of an issue template in the repository, assigns labels and assignees from the template to the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!])

An array of Node IDs of labels for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneId (ID)

The Node ID of the milestone for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

projectIds ([ID!])

An array of Node IDs for projects associated with this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title for the issue.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateLabelInput\n

\n

Autogenerated input type of CreateLabel.

\n
\n\n
\n \n
\n

Preview notice

\n

CreateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

color (String!)

A 6 character hex code, without the leading #, identifying the color of the label.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A brief description of the label, such as its purpose.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the label.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateProjectInput\n

\n

Autogenerated input type of CreateProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of project.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The owner ID to create the project under.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryIds ([ID!])

A list of repository IDs to create as linked repositories for the project.

\n\n\n\n\n\n\n\n\n\n\n\n

template (ProjectTemplate)

The name of the GitHub-provided template.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreatePullRequestInput\n

\n

Autogenerated input type of CreatePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

baseRefName (String!)

The name of the branch you want your changes pulled into. This should be an existing branch\non the current repository. You cannot update the base branch on a pull request to point\nto another repository.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The contents of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

draft (Boolean)

Indicates whether this pull request should be a draft.

\n\n\n\n\n\n\n\n\n\n\n\n

headRefName (String!)

The name of the branch where your changes are implemented. For cross-repository pull requests\nin the same network, namespace head_ref_name with a user like this: username:branch.

\n\n\n\n\n\n\n\n\n\n\n\n

maintainerCanModify (Boolean)

Indicates whether maintainers can modify the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateRefInput\n

\n

Autogenerated input type of CreateRef.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The fully qualified name of the new Ref (ie: refs/heads/my_new_branch).

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The GitObjectID that the new Ref shall target. Must point to a commit.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the Repository to create the Ref in.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateRepositoryInput\n

\n

Autogenerated input type of CreateRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A short description of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

hasIssuesEnabled (Boolean)

Indicates if the repository should have the issues feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasWikiEnabled (Boolean)

Indicates if the repository should have the wiki feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

homepageUrl (URI)

The URL for a web page about this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID)

The ID of the owner for the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

teamId (ID)

When an organization is specified as the owner, this ID identifies the team\nthat should be granted access to the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

template (Boolean)

Whether this repository should be marked as a template such that anyone who\ncan access it can create new repositories with the same files and directory structure.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepositoryVisibility!)

Indicates the repository's visibility level.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateSponsorshipInput\n

\n

Autogenerated input type of CreateSponsorship.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

amount (Int)

The amount to pay to the sponsorable in US dollars. Required if a tierId is not specified. Valid values: 1-12000.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

isRecurring (Boolean)

Whether the sponsorship should happen monthly/yearly or just this one time. Required if a tierId is not specified.

\n\n\n\n\n\n\n\n\n\n\n\n

privacyLevel (SponsorshipPrivacy)

Specify whether others should be able to see that the sponsor is sponsoring\nthe sponsorable. Public visibility still does not reveal which tier is used.

\n\n\n\n\n\n\n\n\n\n\n\n

receiveEmails (Boolean)

Whether the sponsor should receive email updates from the sponsorable.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorId (ID)

The ID of the user or organization who is acting as the sponsor, paying for\nthe sponsorship. Required if sponsorLogin is not given.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorLogin (String)

The username of the user or organization who is acting as the sponsor, paying\nfor the sponsorship. Required if sponsorId is not given.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorableId (ID)

The ID of the user or organization who is receiving the sponsorship. Required if sponsorableLogin is not given.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorableLogin (String)

The username of the user or organization who is receiving the sponsorship. Required if sponsorableId is not given.

\n\n\n\n\n\n\n\n\n\n\n\n

tierId (ID)

The ID of one of sponsorable's existing tiers to sponsor at. Required if amount is not specified.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateTeamDiscussionCommentInput\n

\n

Autogenerated input type of CreateTeamDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The content of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

discussionId (ID!)

The ID of the discussion to which the comment belongs.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateTeamDiscussionInput\n

\n

Autogenerated input type of CreateTeamDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The content of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

private (Boolean)

If true, restricts the visibility of this discussion to team members and\norganization admins. If false or not specified, allows any organization member\nto view this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

teamId (ID!)

The ID of the team to which the discussion belongs.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeclineTopicSuggestionInput\n

\n

Autogenerated input type of DeclineTopicSuggestion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the suggested topic.

\n\n\n\n\n\n\n\n\n\n\n\n

reason (TopicSuggestionDeclineReason!)

The reason why the suggested topic is declined.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteBranchProtectionRuleInput\n

\n

Autogenerated input type of DeleteBranchProtectionRule.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

branchProtectionRuleId (ID!)

The global relay id of the branch protection rule to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteDeploymentInput\n

\n

Autogenerated input type of DeleteDeployment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the deployment to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteDiscussionCommentInput\n

\n

Autogenerated input type of DeleteDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node id of the discussion comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteDiscussionInput\n

\n

Autogenerated input type of DeleteDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The id of the discussion to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteEnvironmentInput\n

\n

Autogenerated input type of DeleteEnvironment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the environment to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteIpAllowListEntryInput\n

\n

Autogenerated input type of DeleteIpAllowListEntry.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEntryId (ID!)

The ID of the IP allow list entry to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteIssueCommentInput\n

\n

Autogenerated input type of DeleteIssueComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteIssueInput\n

\n

Autogenerated input type of DeleteIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The ID of the issue to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteLabelInput\n

\n

Autogenerated input type of DeleteLabel.

\n
\n\n
\n \n
\n

Preview notice

\n

DeleteLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the label to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeletePackageVersionInput\n

\n

Autogenerated input type of DeletePackageVersion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

packageVersionId (ID!)

The ID of the package version to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteProjectCardInput\n

\n

Autogenerated input type of DeleteProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cardId (ID!)

The id of the card to delete.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteProjectColumnInput\n

\n

Autogenerated input type of DeleteProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnId (ID!)

The id of the column to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteProjectInput\n

\n

Autogenerated input type of DeleteProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The Project ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeletePullRequestReviewCommentInput\n

\n

Autogenerated input type of DeletePullRequestReviewComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeletePullRequestReviewInput\n

\n

Autogenerated input type of DeletePullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID!)

The Node ID of the pull request review to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteRefInput\n

\n

Autogenerated input type of DeleteRef.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

refId (ID!)

The Node ID of the Ref to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteTeamDiscussionCommentInput\n

\n

Autogenerated input type of DeleteTeamDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteTeamDiscussionInput\n

\n

Autogenerated input type of DeleteTeamDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The discussion ID to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteVerifiableDomainInput\n

\n

Autogenerated input type of DeleteVerifiableDomain.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the verifiable domain to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeploymentOrder\n

\n

Ordering options for deployment connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (DeploymentOrderField!)

The field to order deployments by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DisablePullRequestAutoMergeInput\n

\n

Autogenerated input type of DisablePullRequestAutoMerge.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to disable auto merge on.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DiscussionOrder\n

\n

Ways in which lists of discussions can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order discussions by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (DiscussionOrderField!)

The field by which to order discussions.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DismissPullRequestReviewInput\n

\n

Autogenerated input type of DismissPullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String!)

The contents of the pull request review dismissal message.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID!)

The Node ID of the pull request review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DraftPullRequestReviewComment\n

\n

Specifies a review comment to be left with a Pull Request Review.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

Body of the comment to leave.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

Path to the file being commented on.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int!)

Position in the file to leave a comment on.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DraftPullRequestReviewThread\n

\n

Specifies a review comment thread to be left with a Pull Request Review.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

Body of the comment to leave.

\n\n\n\n\n\n\n\n\n\n\n\n

line (Int!)

The line of the blob to which the thread refers. The end of the line range for multi-line comments.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

Path to the file being commented on.

\n\n\n\n\n\n\n\n\n\n\n\n

side (DiffSide)

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.

\n\n\n\n\n\n\n\n\n\n\n\n

startLine (Int)

The first line of the range to which the comment refers.

\n\n\n\n\n\n\n\n\n\n\n\n

startSide (DiffSide)

The side of the diff on which the start line resides.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnablePullRequestAutoMergeInput\n

\n

Autogenerated input type of EnablePullRequestAutoMerge.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

authorEmail (String)

The email address to associate with this merge.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitBody (String)

Commit body to use for the commit when the PR is mergable; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

commitHeadline (String)

Commit headline to use for the commit when the PR is mergable; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeMethod (PullRequestMergeMethod)

The merge method to use. If omitted, defaults to 'MERGE'.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to enable auto-merge on.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorInvitationOrder\n

\n

Ordering options for enterprise administrator invitation connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseAdministratorInvitationOrderField!)

The field to order enterprise administrator invitations by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseMemberOrder\n

\n

Ordering options for enterprise member connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseMemberOrderField!)

The field to order enterprise members by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseServerInstallationOrder\n

\n

Ordering options for Enterprise Server installation connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseServerInstallationOrderField!)

The field to order Enterprise Server installations by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountEmailOrder\n

\n

Ordering options for Enterprise Server user account email connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseServerUserAccountEmailOrderField!)

The field to order emails by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountOrder\n

\n

Ordering options for Enterprise Server user account connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseServerUserAccountOrderField!)

The field to order user accounts by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountsUploadOrder\n

\n

Ordering options for Enterprise Server user accounts upload connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseServerUserAccountsUploadOrderField!)

The field to order user accounts uploads by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n FileAddition\n

\n

A command to add a file at the given path with the given contents as part of a\ncommit. Any existing file at that that path will be replaced.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contents (Base64String!)

The base64 encoded contents of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path in the repository where the file will be located.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n FileChanges\n

\n

A description of a set of changes to a file tree to be made as part of\na git commit, modeled as zero or more file additions and zero or more\nfile deletions.

\n

Both fields are optional; omitting both will produce a commit with no\nfile changes.

\n

deletions and additions describe changes to files identified\nby their path in the git tree using unix-style path separators, i.e.\n/. The root of a git tree is an empty string, so paths are not\nslash-prefixed.

\n

path values must be unique across all additions and deletions\nprovided. Any duplication will result in a validation error.

\n

Encoding

\n

File contents must be provided in full for each FileAddition.

\n

The contents of a FileAddition must be encoded using RFC 4648\ncompliant base64, i.e. correct padding is required and no characters\noutside the standard alphabet may be used. Invalid base64\nencoding will be rejected with a validation error.

\n

The encoded contents may be binary.

\n

For text files, no assumptions are made about the character encoding of\nthe file contents (after base64 decoding). No charset transcoding or\nline-ending normalization will be performed; it is the client's\nresponsibility to manage the character encoding of files they provide.\nHowever, for maximum compatibility we recommend using UTF-8 encoding\nand ensuring that all files in a repository use a consistent\nline-ending convention (\\n or \\r\\n), and that all files end\nwith a newline.

\n

Modeling file changes

\n

Each of the the five types of conceptual changes that can be made in a\ngit commit can be described using the FileChanges type as follows:

\n
    \n
  1. \n

    New file addition: create file hello world\\n at path docs/README.txt:

    \n

    {\n"additions" [\n{\n"path": "docs/README.txt",\n"contents": base64encode("hello world\\n")\n}\n]\n}

    \n
    2. \n
  2. \n

    Existing file modification: change existing docs/README.txt to have new\ncontent new content here\\n:

    \n
    {\n  "additions" [\n    {\n      "path": "docs/README.txt",\n      "contents": base64encode("new content here\\n")\n    }\n  ]\n}\n
    \n
    3. \n
  3. \n

    Existing file deletion: remove existing file docs/README.txt.\nNote that the path is required to exist -- specifying a\npath that does not exist on the given branch will abort the\ncommit and return an error.

    \n
    {\n  "deletions" [\n    {\n      "path": "docs/README.txt"\n    }\n  ]\n}\n
    \n
    4. \n
  4. \n

    File rename with no changes: rename docs/README.txt with\nprevious content hello world\\n to the same content at\nnewdocs/README.txt:

    \n
    {\n  "deletions" [\n    {\n      "path": "docs/README.txt",\n    }\n  ],\n  "additions" [\n    {\n      "path": "newdocs/README.txt",\n      "contents": base64encode("hello world\\n")\n    }\n  ]\n}\n
    \n
    5. \n
  5. \n

    File rename with changes: rename docs/README.txt with\nprevious content hello world\\n to a file at path\nnewdocs/README.txt with content new contents\\n:

    \n
    {\n  "deletions" [\n    {\n      "path": "docs/README.txt",\n    }\n  ],\n  "additions" [\n    {\n      "path": "newdocs/README.txt",\n      "contents": base64encode("new contents\\n")\n    }\n  ]\n}.\n
    \n
    6. \n
\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

additions ([FileAddition!])

File to add or change.

\n\n\n\n\n\n\n\n\n\n\n\n

deletions ([FileDeletion!])

Files to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n FileDeletion\n

\n

A command to delete the file at the given path as part of a commit.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

path (String!)

The path to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n FollowUserInput\n

\n

Autogenerated input type of FollowUser.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

userId (ID!)

ID of the user to follow.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n GistOrder\n

\n

Ordering options for gist connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (GistOrderField!)

The field to order repositories by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ImportProjectInput\n

\n

Autogenerated input type of ImportProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of Project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnImports ([ProjectColumnImport!]!)

A list of columns containing issues and pull requests.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of Project.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerName (String!)

The name of the Organization or User to create the Project under.

\n\n\n\n\n\n\n\n\n\n\n\n

public (Boolean)

Whether the Project is public or not.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n InviteEnterpriseAdminInput\n

\n

Autogenerated input type of InviteEnterpriseAdmin.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The email of the person to invite as an administrator.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise to which you want to invite an administrator.

\n\n\n\n\n\n\n\n\n\n\n\n

invitee (String)

The login of a user to invite as an administrator.

\n\n\n\n\n\n\n\n\n\n\n\n

role (EnterpriseAdministratorRole)

The role of the administrator.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IpAllowListEntryOrder\n

\n

Ordering options for IP allow list entry connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (IpAllowListEntryOrderField!)

The field to order IP allow list entries by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IssueCommentOrder\n

\n

Ways in which lists of issue comments can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order issue comments by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (IssueCommentOrderField!)

The field in which to order issue comments by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IssueFilters\n

\n

Ways in which to filter lists of issues.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assignee (String)

List issues assigned to given name. Pass in null for issues with no assigned\nuser, and * for issues assigned to any user.

\n\n\n\n\n\n\n\n\n\n\n\n

createdBy (String)

List issues created by given name.

\n\n\n\n\n\n\n\n\n\n\n\n

labels ([String!])

List issues where the list of label names exist on the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

mentioned (String)

List issues where the given name is mentioned in the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

milestone (String)

List issues by given milestone argument. If an string representation of an\ninteger is passed, it should refer to a milestone by its number field. Pass in\nnull for issues with no milestone, and * for issues that are assigned to any milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

since (DateTime)

List issues that have been updated at or after the given date.

\n\n\n\n\n\n\n\n\n\n\n\n

states ([IssueState!])

List issues filtered by the list of states given.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscribed (Boolean)

List issues subscribed to by viewer.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IssueOrder\n

\n

Ways in which lists of issues can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order issues by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (IssueOrderField!)

The field in which to order issues by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LabelOrder\n

\n

Ways in which lists of labels can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order labels by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (LabelOrderField!)

The field in which to order labels by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LanguageOrder\n

\n

Ordering options for language connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (LanguageOrderField!)

The field to order languages by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LinkRepositoryToProjectInput\n

\n

Autogenerated input type of LinkRepositoryToProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The ID of the Project to link to a Repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the Repository to link to a Project.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LockLockableInput\n

\n

Autogenerated input type of LockLockable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

lockReason (LockReason)

A reason for why the item will be locked.

\n\n\n\n\n\n\n\n\n\n\n\n

lockableId (ID!)

ID of the item to be locked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MarkDiscussionCommentAsAnswerInput\n

\n

Autogenerated input type of MarkDiscussionCommentAsAnswer.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the discussion comment to mark as an answer.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MarkFileAsViewedInput\n

\n

Autogenerated input type of MarkFileAsViewed.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path of the file to mark as viewed.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MarkPullRequestReadyForReviewInput\n

\n

Autogenerated input type of MarkPullRequestReadyForReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be marked as ready for review.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MergeBranchInput\n

\n

Autogenerated input type of MergeBranch.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

authorEmail (String)

The email address to associate with this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

base (String!)

The name of the base branch that the provided head will be merged into.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitMessage (String)

Message to use for the merge commit. If omitted, a default will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

head (String!)

The head to merge into the base branch. This can be a branch name or a commit GitObjectID.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the Repository containing the base branch that will be modified.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MergePullRequestInput\n

\n

Autogenerated input type of MergePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

authorEmail (String)

The email address to associate with this merge.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitBody (String)

Commit body to use for the merge commit; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

commitHeadline (String)

Commit headline to use for the merge commit; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

expectedHeadOid (GitObjectID)

OID that the pull request head ref must match to allow merge; if omitted, no check is performed.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeMethod (PullRequestMergeMethod)

The merge method to use. If omitted, defaults to 'MERGE'.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be merged.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MilestoneOrder\n

\n

Ordering options for milestone connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (MilestoneOrderField!)

The field to order milestones by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MinimizeCommentInput\n

\n

Autogenerated input type of MinimizeComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

classifier (ReportedContentClassifiers!)

The classification of comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MoveProjectCardInput\n

\n

Autogenerated input type of MoveProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

afterCardId (ID)

Place the new card after the card with this id. Pass null to place it at the top.

\n\n\n\n\n\n\n\n\n\n\n\n

cardId (ID!)

The id of the card to move.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnId (ID!)

The id of the column to move it into.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MoveProjectColumnInput\n

\n

Autogenerated input type of MoveProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

afterColumnId (ID)

Place the new column after the column with this id. Pass null to place it at the front.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnId (ID!)

The id of the column to move.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n OrganizationOrder\n

\n

Ordering options for organization connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (OrganizationOrderField!)

The field to order organizations by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PackageFileOrder\n

\n

Ways in which lists of package files can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection)

The direction in which to order package files by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (PackageFileOrderField)

The field in which to order package files by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PackageOrder\n

\n

Ways in which lists of packages can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection)

The direction in which to order packages by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (PackageOrderField)

The field in which to order packages by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PackageVersionOrder\n

\n

Ways in which lists of package versions can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection)

The direction in which to order package versions by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (PackageVersionOrderField)

The field in which to order package versions by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PinIssueInput\n

\n

Autogenerated input type of PinIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The ID of the issue to be pinned.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ProjectCardImport\n

\n

An issue or PR and its owning repository to be used in a project card.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

number (Int!)

The issue or pull request number.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (String!)

Repository name with owner (owner/repository).

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ProjectColumnImport\n

\n

A project column and a list of its issues and PRs.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

columnName (String!)

The name of the column.

\n\n\n\n\n\n\n\n\n\n\n\n

issues ([ProjectCardImport!])

A list of issues and pull requests in the column.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int!)

The position of the column, starting from 0.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ProjectOrder\n

\n

Ways in which lists of projects can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order projects by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (ProjectOrderField!)

The field in which to order projects by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PullRequestOrder\n

\n

Ways in which lists of issues can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order pull requests by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (PullRequestOrderField!)

The field in which to order pull requests by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReactionOrder\n

\n

Ways in which lists of reactions can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order reactions by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (ReactionOrderField!)

The field in which to order reactions by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RefOrder\n

\n

Ways in which lists of git refs can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order refs by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (RefOrderField!)

The field in which to order refs by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RefUpdate\n

\n

A ref update.

\n
\n\n
\n \n
\n

Preview notice

\n

RefUpdate is available under the Update refs preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

afterOid (GitObjectID!)

The value this ref should be updated to.

\n\n\n\n\n\n\n\n\n\n\n\n

beforeOid (GitObjectID)

The value this ref needs to point to before the update.

\n\n\n\n\n\n\n\n\n\n\n\n

force (Boolean)

Force a non fast-forward update.

\n\n\n\n\n\n\n\n\n\n\n\n

name (GitRefname!)

The fully qualified name of the ref to be update. For example refs/heads/branch-name.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RegenerateEnterpriseIdentityProviderRecoveryCodesInput\n

\n

Autogenerated input type of RegenerateEnterpriseIdentityProviderRecoveryCodes.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set an identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RegenerateVerifiableDomainTokenInput\n

\n

Autogenerated input type of RegenerateVerifiableDomainToken.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the verifiable domain to regenerate the verification token of.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RejectDeploymentsInput\n

\n

Autogenerated input type of RejectDeployments.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

comment (String)

Optional comment for rejecting deployments.

\n\n\n\n\n\n\n\n\n\n\n\n

environmentIds ([ID!]!)

The ids of environments to reject deployments.

\n\n\n\n\n\n\n\n\n\n\n\n

workflowRunId (ID!)

The node ID of the workflow run containing the pending deployments.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReleaseOrder\n

\n

Ways in which lists of releases can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order releases by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (ReleaseOrderField!)

The field in which to order releases by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveAssigneesFromAssignableInput\n

\n

Autogenerated input type of RemoveAssigneesFromAssignable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assignableId (ID!)

The id of the assignable object to remove assignees from.

\n\n\n\n\n\n\n\n\n\n\n\n

assigneeIds ([ID!]!)

The id of users to remove as assignees.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveEnterpriseAdminInput\n

\n

Autogenerated input type of RemoveEnterpriseAdmin.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The Enterprise ID from which to remove the administrator.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of the user to remove as an administrator.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveEnterpriseIdentityProviderInput\n

\n

Autogenerated input type of RemoveEnterpriseIdentityProvider.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise from which to remove the identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveEnterpriseOrganizationInput\n

\n

Autogenerated input type of RemoveEnterpriseOrganization.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise from which the organization should be removed.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationId (ID!)

The ID of the organization to remove from the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveEnterpriseSupportEntitlementInput\n

\n

Autogenerated input type of RemoveEnterpriseSupportEntitlement.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the Enterprise which the admin belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of a member who will lose the support entitlement.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveLabelsFromLabelableInput\n

\n

Autogenerated input type of RemoveLabelsFromLabelable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!]!)

The ids of labels to remove.

\n\n\n\n\n\n\n\n\n\n\n\n

labelableId (ID!)

The id of the Labelable to remove labels from.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveOutsideCollaboratorInput\n

\n

Autogenerated input type of RemoveOutsideCollaborator.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationId (ID!)

The ID of the organization to remove the outside collaborator from.

\n\n\n\n\n\n\n\n\n\n\n\n

userId (ID!)

The ID of the outside collaborator to remove.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveReactionInput\n

\n

Autogenerated input type of RemoveReaction.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

content (ReactionContent!)

The name of the emoji reaction to remove.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveStarInput\n

\n

Autogenerated input type of RemoveStar.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

starrableId (ID!)

The Starrable ID to unstar.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveUpvoteInput\n

\n

Autogenerated input type of RemoveUpvote.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the discussion or comment to remove upvote.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReopenIssueInput\n

\n

Autogenerated input type of ReopenIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

ID of the issue to be opened.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReopenPullRequestInput\n

\n

Autogenerated input type of ReopenPullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be reopened.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RepositoryInvitationOrder\n

\n

Ordering options for repository invitation connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (RepositoryInvitationOrderField!)

The field to order repository invitations by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RepositoryOrder\n

\n

Ordering options for repository connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (RepositoryOrderField!)

The field to order repositories by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RequestReviewsInput\n

\n

Autogenerated input type of RequestReviews.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

teamIds ([ID!])

The Node IDs of the team to request.

\n\n\n\n\n\n\n\n\n\n\n\n

union (Boolean)

Add users to the set rather than replace.

\n\n\n\n\n\n\n\n\n\n\n\n

userIds ([ID!])

The Node IDs of the user to request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RerequestCheckSuiteInput\n

\n

Autogenerated input type of RerequestCheckSuite.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

checkSuiteId (ID!)

The Node ID of the check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ResolveReviewThreadInput\n

\n

Autogenerated input type of ResolveReviewThread.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

threadId (ID!)

The ID of the thread to resolve.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SavedReplyOrder\n

\n

Ordering options for saved reply connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SavedReplyOrderField!)

The field to order saved replies by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryIdentifierFilter\n

\n

An advisory identifier to filter results on.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

type (SecurityAdvisoryIdentifierType!)

The identifier type.

\n\n\n\n\n\n\n\n\n\n\n\n

value (String!)

The identifier string. Supports exact or partial matching.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryOrder\n

\n

Ordering options for security advisory connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SecurityAdvisoryOrderField!)

The field to order security advisories by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SecurityVulnerabilityOrder\n

\n

Ordering options for security vulnerability connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SecurityVulnerabilityOrderField!)

The field to order security vulnerabilities by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SetEnterpriseIdentityProviderInput\n

\n

Autogenerated input type of SetEnterpriseIdentityProvider.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

digestMethod (SamlDigestAlgorithm!)

The digest algorithm used to sign SAML requests for the identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set an identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n

idpCertificate (String!)

The x509 certificate used by the identity provider to sign assertions and responses.

\n\n\n\n\n\n\n\n\n\n\n\n

issuer (String)

The Issuer Entity ID for the SAML identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n

signatureMethod (SamlSignatureAlgorithm!)

The signature algorithm used to sign SAML requests for the identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n

ssoUrl (URI!)

The URL endpoint for the identity provider's SAML SSO.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SetOrganizationInteractionLimitInput\n

\n

Autogenerated input type of SetOrganizationInteractionLimit.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

expiry (RepositoryInteractionLimitExpiry)

When this limit should expire.

\n\n\n\n\n\n\n\n\n\n\n\n

limit (RepositoryInteractionLimit!)

The limit to set.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationId (ID!)

The ID of the organization to set a limit for.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SetRepositoryInteractionLimitInput\n

\n

Autogenerated input type of SetRepositoryInteractionLimit.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

expiry (RepositoryInteractionLimitExpiry)

When this limit should expire.

\n\n\n\n\n\n\n\n\n\n\n\n

limit (RepositoryInteractionLimit!)

The limit to set.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to set a limit for.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SetUserInteractionLimitInput\n

\n

Autogenerated input type of SetUserInteractionLimit.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

expiry (RepositoryInteractionLimitExpiry)

When this limit should expire.

\n\n\n\n\n\n\n\n\n\n\n\n

limit (RepositoryInteractionLimit!)

The limit to set.

\n\n\n\n\n\n\n\n\n\n\n\n

userId (ID!)

The ID of the user to set a limit for.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SponsorOrder\n

\n

Ordering options for connections to get sponsor entities for GitHub Sponsors.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SponsorOrderField!)

The field to order sponsor entities by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SponsorableOrder\n

\n

Ordering options for connections to get sponsorable entities for GitHub Sponsors.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SponsorableOrderField!)

The field to order sponsorable entities by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SponsorsActivityOrder\n

\n

Ordering options for GitHub Sponsors activity connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SponsorsActivityOrderField!)

The field to order activity by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SponsorsTierOrder\n

\n

Ordering options for Sponsors tiers connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SponsorsTierOrderField!)

The field to order tiers by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SponsorshipNewsletterOrder\n

\n

Ordering options for sponsorship newsletter connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SponsorshipNewsletterOrderField!)

The field to order sponsorship newsletters by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SponsorshipOrder\n

\n

Ordering options for sponsorship connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SponsorshipOrderField!)

The field to order sponsorship by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n StarOrder\n

\n

Ways in which star connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (StarOrderField!)

The field in which to order nodes by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SubmitPullRequestReviewInput\n

\n

Autogenerated input type of SubmitPullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The text field to set on the Pull Request Review.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

event (PullRequestReviewEvent!)

The event to send to the Pull Request Review.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID)

The Pull Request ID to submit any pending reviews.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID)

The Pull Request Review ID to submit.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamDiscussionCommentOrder\n

\n

Ways in which team discussion comment connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamDiscussionCommentOrderField!)

The field by which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamDiscussionOrder\n

\n

Ways in which team discussion connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamDiscussionOrderField!)

The field by which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamMemberOrder\n

\n

Ordering options for team member connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamMemberOrderField!)

The field to order team members by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamOrder\n

\n

Ways in which team connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamOrderField!)

The field in which to order nodes by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamRepositoryOrder\n

\n

Ordering options for team repository connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamRepositoryOrderField!)

The field to order repositories by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TransferIssueInput\n

\n

Autogenerated input type of TransferIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The Node ID of the issue to be transferred.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository the issue should be transferred to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnarchiveRepositoryInput\n

\n

Autogenerated input type of UnarchiveRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to unarchive.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnfollowUserInput\n

\n

Autogenerated input type of UnfollowUser.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

userId (ID!)

ID of the user to unfollow.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnlinkRepositoryFromProjectInput\n

\n

Autogenerated input type of UnlinkRepositoryFromProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The ID of the Project linked to the Repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the Repository linked to the Project.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnlockLockableInput\n

\n

Autogenerated input type of UnlockLockable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

lockableId (ID!)

ID of the item to be unlocked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnmarkDiscussionCommentAsAnswerInput\n

\n

Autogenerated input type of UnmarkDiscussionCommentAsAnswer.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the discussion comment to unmark as an answer.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnmarkFileAsViewedInput\n

\n

Autogenerated input type of UnmarkFileAsViewed.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path of the file to mark as unviewed.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnmarkIssueAsDuplicateInput\n

\n

Autogenerated input type of UnmarkIssueAsDuplicate.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

canonicalId (ID!)

ID of the issue or pull request currently considered canonical/authoritative/original.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

duplicateId (ID!)

ID of the issue or pull request currently marked as a duplicate.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnminimizeCommentInput\n

\n

Autogenerated input type of UnminimizeComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnpinIssueInput\n

\n

Autogenerated input type of UnpinIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The ID of the issue to be unpinned.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnresolveReviewThreadInput\n

\n

Autogenerated input type of UnresolveReviewThread.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

threadId (ID!)

The ID of the thread to unresolve.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateBranchProtectionRuleInput\n

\n

Autogenerated input type of UpdateBranchProtectionRule.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowsDeletions (Boolean)

Can this branch be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

allowsForcePushes (Boolean)

Are force pushes allowed on this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

branchProtectionRuleId (ID!)

The global relay id of the branch protection rule to be updated.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissesStaleReviews (Boolean)

Will new commits pushed to matching branches dismiss pull request review approvals.

\n\n\n\n\n\n\n\n\n\n\n\n

isAdminEnforced (Boolean)

Can admins overwrite branch protection.

\n\n\n\n\n\n\n\n\n\n\n\n

pattern (String)

The glob-like pattern used to determine matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

pushActorIds ([ID!])

A list of User, Team or App IDs allowed to push to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredStatusCheckContexts ([String!])

List of required status check contexts that must pass for commits to be accepted to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresApprovingReviews (Boolean)

Are approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCodeOwnerReviews (Boolean)

Are reviews from code owners required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCommitSignatures (Boolean)

Are commits required to be signed.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresConversationResolution (Boolean)

Are conversations required to be resolved before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresLinearHistory (Boolean)

Are merge commits prohibited from being pushed to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStatusChecks (Boolean)

Are status checks required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStrictStatusChecks (Boolean)

Are branches required to be up to date before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsPushes (Boolean)

Is pushing to matching branches restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsReviewDismissals (Boolean)

Is dismissal of pull request reviews restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDismissalActorIds ([ID!])

A list of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateCheckRunInput\n

\n

Autogenerated input type of UpdateCheckRun.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actions ([CheckRunAction!])

Possible further actions the integrator can perform, which a user may trigger.

\n\n\n\n\n\n\n\n\n\n\n\n

checkRunId (ID!)

The node of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

completedAt (DateTime)

The time that the check run finished.

\n\n\n\n\n\n\n\n\n\n\n\n

conclusion (CheckConclusionState)

The final conclusion of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

detailsUrl (URI)

The URL of the integrator's site that has the full details of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

externalId (String)

A reference for the run on the integrator's system.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

output (CheckRunOutput)

Descriptive details about the run.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

startedAt (DateTime)

The time that the check run began.

\n\n\n\n\n\n\n\n\n\n\n\n

status (RequestableCheckStatusState)

The current status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateCheckSuitePreferencesInput\n

\n

Autogenerated input type of UpdateCheckSuitePreferences.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

autoTriggerPreferences ([CheckSuiteAutoTriggerPreference!]!)

The check suite preferences to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateDiscussionCommentInput\n

\n

Autogenerated input type of UpdateDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The new contents of the comment body.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commentId (ID!)

The Node ID of the discussion comment to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateDiscussionInput\n

\n

Autogenerated input type of UpdateDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The new contents of the discussion body.

\n\n\n\n\n\n\n\n\n\n\n\n

categoryId (ID)

The Node ID of a discussion category within the same repository to change this discussion to.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

discussionId (ID!)

The Node ID of the discussion to update.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The new discussion title.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseAdministratorRoleInput\n

\n

Autogenerated input type of UpdateEnterpriseAdministratorRole.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the Enterprise which the admin belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of a administrator whose role is being changed.

\n\n\n\n\n\n\n\n\n\n\n\n

role (EnterpriseAdministratorRole!)

The new role for the Enterprise administrator.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseAllowPrivateRepositoryForkingSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the allow private repository forking setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the allow private repository forking setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseDefaultRepositoryPermissionSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseDefaultRepositoryPermissionSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the base repository permission setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseDefaultRepositoryPermissionSettingValue!)

The value for the base repository permission setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanChangeRepositoryVisibilitySetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can change repository visibility setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can change repository visibility setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanCreateRepositoriesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanCreateRepositoriesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can create repositories setting.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreateInternalRepositories (Boolean)

Allow members to create internal repositories. Defaults to current value.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreatePrivateRepositories (Boolean)

Allow members to create private repositories. Defaults to current value.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreatePublicRepositories (Boolean)

Allow members to create public repositories. Defaults to current value.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreateRepositoriesPolicyEnabled (Boolean)

When false, allow member organizations to set their own repository creation member privileges.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseMembersCanCreateRepositoriesSettingValue)

Value for the members can create repositories setting on the enterprise. This\nor the granular public/private/internal allowed fields (but not both) must be provided.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanDeleteIssuesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanDeleteIssuesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can delete issues setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can delete issues setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanDeleteRepositoriesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can delete repositories setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can delete repositories setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanInviteCollaboratorsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can invite collaborators setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can invite collaborators setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanMakePurchasesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanMakePurchasesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can make purchases setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseMembersCanMakePurchasesSettingValue!)

The value for the members can make purchases setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanUpdateProtectedBranchesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can update protected branches setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can update protected branches setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanViewDependencyInsightsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can view dependency insights setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can view dependency insights setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseOrganizationProjectsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseOrganizationProjectsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the organization projects setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the organization projects setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseProfileInput\n

\n

Autogenerated input type of UpdateEnterpriseProfile.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The Enterprise ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n

location (String)

The location of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

websiteUrl (String)

The URL of the enterprise's website.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseRepositoryProjectsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseRepositoryProjectsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the repository projects setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the repository projects setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseTeamDiscussionsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseTeamDiscussionsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the team discussions setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the team discussions setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseTwoFactorAuthenticationRequiredSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the two factor authentication required setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledSettingValue!)

The value for the two factor authentication required setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnvironmentInput\n

\n

Autogenerated input type of UpdateEnvironment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

environmentId (ID!)

The node ID of the environment.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewers ([ID!])

The ids of users or teams that can approve deployments to this environment.

\n\n\n\n\n\n\n\n\n\n\n\n

waitTimer (Int)

The wait timer in minutes.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIpAllowListEnabledSettingInput\n

\n

Autogenerated input type of UpdateIpAllowListEnabledSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner on which to set the IP allow list enabled setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (IpAllowListEnabledSettingValue!)

The value for the IP allow list enabled setting.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIpAllowListEntryInput\n

\n

Autogenerated input type of UpdateIpAllowListEntry.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowListValue (String!)

An IP address or range of addresses in CIDR notation.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEntryId (ID!)

The ID of the IP allow list entry to update.

\n\n\n\n\n\n\n\n\n\n\n\n

isActive (Boolean!)

Whether the IP allow list entry is active when an IP allow list is enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

An optional name for the IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIpAllowListForInstalledAppsEnabledSettingInput\n

\n

Autogenerated input type of UpdateIpAllowListForInstalledAppsEnabledSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (IpAllowListForInstalledAppsEnabledSettingValue!)

The value for the IP allow list configuration for installed GitHub Apps setting.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIssueCommentInput\n

\n

Autogenerated input type of UpdateIssueComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The updated text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the IssueComment to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIssueInput\n

\n

Autogenerated input type of UpdateIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assigneeIds ([ID!])

An array of Node IDs of users for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The body for the issue description.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the Issue to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!])

An array of Node IDs of labels for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneId (ID)

The Node ID of the milestone for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

projectIds ([ID!])

An array of Node IDs for projects associated with this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

state (IssueState)

The desired issue state.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title for the issue.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateLabelInput\n

\n

Autogenerated input type of UpdateLabel.

\n
\n\n
\n \n
\n

Preview notice

\n

UpdateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

color (String)

A 6 character hex code, without the leading #, identifying the updated color of the label.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A brief description of the label, such as its purpose.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the label to be updated.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The updated name of the label.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateNotificationRestrictionSettingInput\n

\n

Autogenerated input type of UpdateNotificationRestrictionSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner on which to set the restrict notifications setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (NotificationRestrictionSettingValue!)

The value for the restrict notifications setting.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateProjectCardInput\n

\n

Autogenerated input type of UpdateProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

isArchived (Boolean)

Whether or not the ProjectCard should be archived.

\n\n\n\n\n\n\n\n\n\n\n\n

note (String)

The note of ProjectCard.

\n\n\n\n\n\n\n\n\n\n\n\n

projectCardId (ID!)

The ProjectCard ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateProjectColumnInput\n

\n

Autogenerated input type of UpdateProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of project column.

\n\n\n\n\n\n\n\n\n\n\n\n

projectColumnId (ID!)

The ProjectColumn ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateProjectInput\n

\n

Autogenerated input type of UpdateProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of project.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The Project ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n

public (Boolean)

Whether the project is public or not.

\n\n\n\n\n\n\n\n\n\n\n\n

state (ProjectState)

Whether the project is open or closed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdatePullRequestInput\n

\n

Autogenerated input type of UpdatePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assigneeIds ([ID!])

An array of Node IDs of users for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRefName (String)

The name of the branch you want your changes pulled into. This should be an existing branch\non the current repository.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The contents of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!])

An array of Node IDs of labels for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

maintainerCanModify (Boolean)

Indicates whether maintainers can modify the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneId (ID)

The Node ID of the milestone for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

projectIds ([ID!])

An array of Node IDs for projects associated with this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

state (PullRequestUpdateState)

The target state of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdatePullRequestReviewCommentInput\n

\n

Autogenerated input type of UpdatePullRequestReviewComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewCommentId (ID!)

The Node ID of the comment to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdatePullRequestReviewInput\n

\n

Autogenerated input type of UpdatePullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The contents of the pull request review body.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID!)

The Node ID of the pull request review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateRefInput\n

\n

Autogenerated input type of UpdateRef.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

force (Boolean)

Permit updates of branch Refs that are not fast-forwards?.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The GitObjectID that the Ref shall be updated to target.

\n\n\n\n\n\n\n\n\n\n\n\n

refId (ID!)

The Node ID of the Ref to be updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateRefsInput\n

\n

Autogenerated input type of UpdateRefs.

\n
\n\n
\n \n
\n

Preview notice

\n

UpdateRefsInput is available under the Update refs preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

refUpdates ([RefUpdate!]!)

A list of ref updates.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateRepositoryInput\n

\n

Autogenerated input type of UpdateRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A new description for the repository. Pass an empty string to erase the existing description.

\n\n\n\n\n\n\n\n\n\n\n\n

hasIssuesEnabled (Boolean)

Indicates if the repository should have the issues feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasProjectsEnabled (Boolean)

Indicates if the repository should have the project boards feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasWikiEnabled (Boolean)

Indicates if the repository should have the wiki feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

homepageUrl (URI)

The URL for a web page about this repository. Pass an empty string to erase the existing URL.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The new name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to update.

\n\n\n\n\n\n\n\n\n\n\n\n

template (Boolean)

Whether this repository should be marked as a template such that anyone who\ncan access it can create new repositories with the same files and directory structure.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateSubscriptionInput\n

\n

Autogenerated input type of UpdateSubscription.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

state (SubscriptionState!)

The new state of the subscription.

\n\n\n\n\n\n\n\n\n\n\n\n

subscribableId (ID!)

The Node ID of the subscribable object to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTeamDiscussionCommentInput\n

\n

Autogenerated input type of UpdateTeamDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The updated text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyVersion (String)

The current version of the body content.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTeamDiscussionInput\n

\n

Autogenerated input type of UpdateTeamDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The updated text of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyVersion (String)

The current version of the body content. If provided, this update operation\nwill be rejected if the given version does not match the latest version on the server.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the discussion to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

pinned (Boolean)

If provided, sets the pinned state of the updated discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The updated title of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTeamReviewAssignmentInput\n

\n

Autogenerated input type of UpdateTeamReviewAssignment.

\n
\n\n
\n \n
\n

Preview notice

\n

UpdateTeamReviewAssignmentInput is available under the Team review assignments preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

algorithm (TeamReviewAssignmentAlgorithm)

The algorithm to use for review assignment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enabled (Boolean!)

Turn on or off review assignment.

\n\n\n\n\n\n\n\n\n\n\n\n

excludedTeamMemberIds ([ID!])

An array of team member IDs to exclude.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the team to update review assignments of.

\n\n\n\n\n\n\n\n\n\n\n\n

notifyTeam (Boolean)

Notify the entire team of the PR if it is delegated.

\n\n\n\n\n\n\n\n\n\n\n\n

teamMemberCount (Int)

The number of team members to assign.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTopicsInput\n

\n

Autogenerated input type of UpdateTopics.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

topicNames ([String!]!)

An array of topic names.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UserStatusOrder\n

\n

Ordering options for user status connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (UserStatusOrderField!)

The field to order user statuses by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n VerifiableDomainOrder\n

\n

Ordering options for verifiable domain connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (VerifiableDomainOrderField!)

The field to order verifiable domains by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n VerifyVerifiableDomainInput\n

\n

Autogenerated input type of VerifyVerifiableDomain.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the verifiable domain to verify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n", "miniToc": [ { "contents": "\n AcceptEnterpriseAdministratorInvitationInput\n ", @@ -492,16 +492,6 @@ "headingLevel": 2, "indentationLevel": 0 }, - { - "contents": "Encoding", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "Modeling file changes", - "headingLevel": 2, - "indentationLevel": 0 - }, { "contents": "\n FileDeletion\n ", "headingLevel": 2, @@ -4770,7 +4760,7 @@ ] }, "ghae": { - "html": "
\n
\n

\n AddAssigneesToAssignableInput\n

\n

Autogenerated input type of AddAssigneesToAssignable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assignableId (ID!)

The id of the assignable object to add assignees to.

\n\n\n\n\n\n\n\n\n\n\n\n

assigneeIds ([ID!]!)

The id of users to add as assignees.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddCommentInput\n

\n

Autogenerated input type of AddComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The contents of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddDiscussionCommentInput\n

\n

Autogenerated input type of AddDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The contents of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

discussionId (ID!)

The Node ID of the discussion to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

replyToId (ID)

The Node ID of the discussion comment within this discussion to reply to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddEnterpriseAdminInput\n

\n

Autogenerated input type of AddEnterpriseAdmin.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise account to which the administrator should be added.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of the user to add as an administrator.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddLabelsToLabelableInput\n

\n

Autogenerated input type of AddLabelsToLabelable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!]!)

The ids of the labels to add.

\n\n\n\n\n\n\n\n\n\n\n\n

labelableId (ID!)

The id of the labelable object to add labels to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddProjectCardInput\n

\n

Autogenerated input type of AddProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

contentId (ID)

The content of the card. Must be a member of the ProjectCardItem union.

\n\n\n\n\n\n\n\n\n\n\n\n

note (String)

The note on the card.

\n\n\n\n\n\n\n\n\n\n\n\n

projectColumnId (ID!)

The Node ID of the ProjectColumn.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddProjectColumnInput\n

\n

Autogenerated input type of AddProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the column.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The Node ID of the project.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddPullRequestReviewCommentInput\n

\n

Autogenerated input type of AddPullRequestReviewComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitOID (GitObjectID)

The SHA of the commit to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

inReplyTo (ID)

The comment id to reply to.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String)

The relative path of the file to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int)

The line index in the diff to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID)

The node ID of the pull request reviewing.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID)

The Node ID of the review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddPullRequestReviewInput\n

\n

Autogenerated input type of AddPullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The contents of the review body comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

comments ([DraftPullRequestReviewComment])

The review line comments.

\n\n\n\n\n\n\n\n\n\n\n\n

commitOID (GitObjectID)

The commit OID the review pertains to.

\n\n\n\n\n\n\n\n\n\n\n\n

event (PullRequestReviewEvent)

The event to perform on the pull request review.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

threads ([DraftPullRequestReviewThread])

The review line comment threads.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddPullRequestReviewThreadInput\n

\n

Autogenerated input type of AddPullRequestReviewThread.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

Body of the thread's first comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

line (Int!)

The line of the blob to which the thread refers. The end of the line range for multi-line comments.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

Path to the file being commented on.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID)

The node ID of the pull request reviewing.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID)

The Node ID of the review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

side (DiffSide)

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.

\n\n\n\n\n\n\n\n\n\n\n\n

startLine (Int)

The first line of the range to which the comment refers.

\n\n\n\n\n\n\n\n\n\n\n\n

startSide (DiffSide)

The side of the diff on which the start line resides.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddReactionInput\n

\n

Autogenerated input type of AddReaction.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

content (ReactionContent!)

The name of the emoji to react with.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddStarInput\n

\n

Autogenerated input type of AddStar.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

starrableId (ID!)

The Starrable ID to star.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddUpvoteInput\n

\n

Autogenerated input type of AddUpvote.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the discussion or comment to upvote.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ApproveDeploymentsInput\n

\n

Autogenerated input type of ApproveDeployments.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

comment (String)

Optional comment for approving deployments.

\n\n\n\n\n\n\n\n\n\n\n\n

environmentIds ([ID!]!)

The ids of environments to reject deployments.

\n\n\n\n\n\n\n\n\n\n\n\n

workflowRunId (ID!)

The node ID of the workflow run containing the pending deployments.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ArchiveRepositoryInput\n

\n

Autogenerated input type of ArchiveRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to mark as archived.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AuditLogOrder\n

\n

Ordering options for Audit Log connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (AuditLogOrderField)

The field to order Audit Logs by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ChangeUserStatusInput\n

\n

Autogenerated input type of ChangeUserStatus.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

emoji (String)

The emoji to represent your status. Can either be a native Unicode emoji or an emoji name with colons, e.g., 😀.

\n\n\n\n\n\n\n\n\n\n\n\n

expiresAt (DateTime)

If set, the user status will not be shown after this date.

\n\n\n\n\n\n\n\n\n\n\n\n

limitedAvailability (Boolean)

Whether this status should indicate you are not fully available on GitHub, e.g., you are away.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String)

A short description of your current status.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationId (ID)

The ID of the organization whose members will be allowed to see the status. If\nomitted, the status will be publicly visible.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckAnnotationData\n

\n

Information from a check run analysis to specific lines of code.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

annotationLevel (CheckAnnotationLevel!)

Represents an annotation's information level.

\n\n\n\n\n\n\n\n\n\n\n\n

location (CheckAnnotationRange!)

The location of the annotation.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String!)

A short description of the feedback for these lines of code.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path of the file to add an annotation to.

\n\n\n\n\n\n\n\n\n\n\n\n

rawDetails (String)

Details about this annotation.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title that represents the annotation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckAnnotationRange\n

\n

Information from a check run analysis to specific lines of code.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

endColumn (Int)

The ending column of the range.

\n\n\n\n\n\n\n\n\n\n\n\n

endLine (Int!)

The ending line of the range.

\n\n\n\n\n\n\n\n\n\n\n\n

startColumn (Int)

The starting column of the range.

\n\n\n\n\n\n\n\n\n\n\n\n

startLine (Int!)

The starting line of the range.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunAction\n

\n

Possible further actions the integrator can perform.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

description (String!)

A short explanation of what this action would do.

\n\n\n\n\n\n\n\n\n\n\n\n

identifier (String!)

A reference for the action on the integrator's system.

\n\n\n\n\n\n\n\n\n\n\n\n

label (String!)

The text to be displayed on a button in the web UI.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunFilter\n

\n

The filters that are available when fetching check runs.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

appId (Int)

Filters the check runs created by this application ID.

\n\n\n\n\n\n\n\n\n\n\n\n

checkName (String)

Filters the check runs by this name.

\n\n\n\n\n\n\n\n\n\n\n\n

checkType (CheckRunType)

Filters the check runs by this type.

\n\n\n\n\n\n\n\n\n\n\n\n

status (CheckStatusState)

Filters the check runs by this status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunOutput\n

\n

Descriptive details about the check run.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

annotations ([CheckAnnotationData!])

The annotations that are made as part of the check run.

\n\n\n\n\n\n\n\n\n\n\n\n

images ([CheckRunOutputImage!])

Images attached to the check run output displayed in the GitHub pull request UI.

\n\n\n\n\n\n\n\n\n\n\n\n

summary (String!)

The summary of the check run (supports Commonmark).

\n\n\n\n\n\n\n\n\n\n\n\n

text (String)

The details of the check run (supports Commonmark).

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

A title to provide for this check run.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunOutputImage\n

\n

Images attached to the check run output displayed in the GitHub pull request UI.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

alt (String!)

The alternative text for the image.

\n\n\n\n\n\n\n\n\n\n\n\n

caption (String)

A short image description.

\n\n\n\n\n\n\n\n\n\n\n\n

imageUrl (URI!)

The full URL of the image.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckSuiteAutoTriggerPreference\n

\n

The auto-trigger preferences that are available for check suites.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

appId (ID!)

The node ID of the application that owns the check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

setting (Boolean!)

Set to true to enable automatic creation of CheckSuite events upon pushes to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckSuiteFilter\n

\n

The filters that are available when fetching check suites.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

appId (Int)

Filters the check suites created by this application ID.

\n\n\n\n\n\n\n\n\n\n\n\n

checkName (String)

Filters the check suites by this name.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ClearLabelsFromLabelableInput\n

\n

Autogenerated input type of ClearLabelsFromLabelable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelableId (ID!)

The id of the labelable object to clear the labels from.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CloneProjectInput\n

\n

Autogenerated input type of CloneProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of the project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

includeWorkflows (Boolean!)

Whether or not to clone the source project's workflows.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the project.

\n\n\n\n\n\n\n\n\n\n\n\n

public (Boolean)

The visibility of the project, defaults to false (private).

\n\n\n\n\n\n\n\n\n\n\n\n

sourceId (ID!)

The source project to clone.

\n\n\n\n\n\n\n\n\n\n\n\n

targetOwnerId (ID!)

The owner ID to create the project under.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CloneTemplateRepositoryInput\n

\n

Autogenerated input type of CloneTemplateRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A short description of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

includeAllBranches (Boolean)

Whether to copy all branches from the template to the new repository. Defaults\nto copying only the default branch of the template.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner for the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the template repository.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepositoryVisibility!)

Indicates the repository's visibility level.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CloseIssueInput\n

\n

Autogenerated input type of CloseIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

ID of the issue to be closed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ClosePullRequestInput\n

\n

Autogenerated input type of ClosePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be closed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CommitAuthor\n

\n

Specifies an author for filtering Git commits.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

emails ([String!])

Email addresses to filter by. Commits authored by any of the specified email addresses will be returned.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID)

ID of a User to filter by. If non-null, only commits authored by this user\nwill be returned. This field takes precedence over emails.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CommitContributionOrder\n

\n

Ordering options for commit contribution connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (CommitContributionOrderField!)

The field by which to order commit contributions.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CommitMessage\n

\n

A message to include with a new commit.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The body of the message.

\n\n\n\n\n\n\n\n\n\n\n\n

headline (String!)

The headline of the message.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CommittableBranch\n

\n

A git ref for a commit to be appended to.

\n

The ref must be a branch, i.e. its fully qualified name must start\nwith refs/heads/ (although the input is not required to be fully\nqualified).

\n

The Ref may be specified by its global node ID or by the\nrepository nameWithOwner and branch name.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

branchName (String)

The unqualified name of the branch to append the commit to.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID)

The Node ID of the Ref to be updated.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryNameWithOwner (String)

The nameWithOwner of the repository to commit to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ContributionOrder\n

\n

Ordering options for contribution connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ConvertProjectCardNoteToIssueInput\n

\n

Autogenerated input type of ConvertProjectCardNoteToIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The body of the newly created issue.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectCardId (ID!)

The ProjectCard ID to convert.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to create the issue in.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title of the newly created issue. Defaults to the card's note text.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ConvertPullRequestToDraftInput\n

\n

Autogenerated input type of ConvertPullRequestToDraft.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to convert to draft.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateBranchProtectionRuleInput\n

\n

Autogenerated input type of CreateBranchProtectionRule.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowsDeletions (Boolean)

Can this branch be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

allowsForcePushes (Boolean)

Are force pushes allowed on this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissesStaleReviews (Boolean)

Will new commits pushed to matching branches dismiss pull request review approvals.

\n\n\n\n\n\n\n\n\n\n\n\n

isAdminEnforced (Boolean)

Can admins overwrite branch protection.

\n\n\n\n\n\n\n\n\n\n\n\n

pattern (String!)

The glob-like pattern used to determine matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

pushActorIds ([ID!])

A list of User, Team or App IDs allowed to push to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The global relay id of the repository in which a new branch protection rule should be created in.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredStatusCheckContexts ([String!])

List of required status check contexts that must pass for commits to be accepted to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresApprovingReviews (Boolean)

Are approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCodeOwnerReviews (Boolean)

Are reviews from code owners required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCommitSignatures (Boolean)

Are commits required to be signed.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresConversationResolution (Boolean)

Are conversations required to be resolved before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresLinearHistory (Boolean)

Are merge commits prohibited from being pushed to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStatusChecks (Boolean)

Are status checks required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStrictStatusChecks (Boolean)

Are branches required to be up to date before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsPushes (Boolean)

Is pushing to matching branches restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsReviewDismissals (Boolean)

Is dismissal of pull request reviews restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDismissalActorIds ([ID!])

A list of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateCheckRunInput\n

\n

Autogenerated input type of CreateCheckRun.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actions ([CheckRunAction!])

Possible further actions the integrator can perform, which a user may trigger.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

completedAt (DateTime)

The time that the check run finished.

\n\n\n\n\n\n\n\n\n\n\n\n

conclusion (CheckConclusionState)

The final conclusion of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

detailsUrl (URI)

The URL of the integrator's site that has the full details of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

externalId (String)

A reference for the run on the integrator's system.

\n\n\n\n\n\n\n\n\n\n\n\n

headSha (GitObjectID!)

The SHA of the head commit.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

output (CheckRunOutput)

Descriptive details about the run.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

startedAt (DateTime)

The time that the check run began.

\n\n\n\n\n\n\n\n\n\n\n\n

status (RequestableCheckStatusState)

The current status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateCheckSuiteInput\n

\n

Autogenerated input type of CreateCheckSuite.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

headSha (GitObjectID!)

The SHA of the head commit.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateCommitOnBranchInput\n

\n

Autogenerated input type of CreateCommitOnBranch.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

branch (CommittableBranch!)

The Ref to be updated. Must be a branch.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

expectedHeadOid (GitObjectID!)

The git commit oid expected at the head of the branch prior to the commit.

\n\n\n\n\n\n\n\n\n\n\n\n

fileChanges (FileChanges)

A description of changes to files in this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

message (CommitMessage!)

The commit message the be included with the commit.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateContentAttachmentInput\n

\n

Autogenerated input type of CreateContentAttachment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The body of the content attachment, which may contain markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

contentReferenceId (ID!)

The node ID of the content_reference.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the content attachment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateDeploymentInput\n

\n

Autogenerated input type of CreateDeployment.

\n
\n\n
\n \n
\n

Preview notice

\n

CreateDeploymentInput is available under the Deployments preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

autoMerge (Boolean)

Attempt to automatically merge the default branch into the requested ref, defaults to true.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

Short description of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

environment (String)

Name for the target deployment environment.

\n\n\n\n\n\n\n\n\n\n\n\n

payload (String)

JSON payload with extra information about the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

refId (ID!)

The node ID of the ref to be deployed.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredContexts ([String!])

The status contexts to verify against commit status checks. To bypass required\ncontexts, pass an empty array. Defaults to all unique contexts.

\n\n\n\n\n\n\n\n\n\n\n\n

task (String)

Specifies a task to execute.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateDeploymentStatusInput\n

\n

Autogenerated input type of CreateDeploymentStatus.

\n
\n\n
\n \n
\n

Preview notice

\n

CreateDeploymentStatusInput is available under the Deployments preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

autoInactive (Boolean)

Adds a new inactive status to all non-transient, non-production environment\ndeployments with the same repository and environment name as the created\nstatus's deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

deploymentId (ID!)

The node ID of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A short description of the status. Maximum length of 140 characters.

\n\n\n\n\n\n\n\n\n\n\n\n

environment (String)

If provided, updates the environment of the deploy. Otherwise, does not modify the environment.

\n\n\n\n\n\n\n\n\n\n\n\n

environmentUrl (String)

Sets the URL for accessing your environment.

\n\n\n\n\n\n\n\n\n\n\n\n

logUrl (String)

The log URL to associate with this status. This URL should contain\noutput to keep the user updated while the task is running or serve as\nhistorical information for what happened in the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

state (DeploymentStatusState!)

The state of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateDiscussionInput\n

\n

Autogenerated input type of CreateDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The body of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

categoryId (ID!)

The id of the discussion category to associate with this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The id of the repository on which to create the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateEnterpriseOrganizationInput\n

\n

Autogenerated input type of CreateEnterpriseOrganization.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

adminLogins ([String!]!)

The logins for the administrators of the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n

billingEmail (String!)

The email used for sending billing receipts.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise owning the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n

profileName (String!)

The profile name of the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateEnvironmentInput\n

\n

Autogenerated input type of CreateEnvironment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the environment.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateIpAllowListEntryInput\n

\n

Autogenerated input type of CreateIpAllowListEntry.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowListValue (String!)

An IP address or range of addresses in CIDR notation.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

isActive (Boolean!)

Whether the IP allow list entry is active when an IP allow list is enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

An optional name for the IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner for which to create the new IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateIssueInput\n

\n

Autogenerated input type of CreateIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assigneeIds ([ID!])

The Node ID for the user assignee for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The body for the issue description.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueTemplate (String)

The name of an issue template in the repository, assigns labels and assignees from the template to the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!])

An array of Node IDs of labels for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneId (ID)

The Node ID of the milestone for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

projectIds ([ID!])

An array of Node IDs for projects associated with this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title for the issue.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateLabelInput\n

\n

Autogenerated input type of CreateLabel.

\n
\n\n
\n \n
\n

Preview notice

\n

CreateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

color (String!)

A 6 character hex code, without the leading #, identifying the color of the label.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A brief description of the label, such as its purpose.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the label.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateProjectInput\n

\n

Autogenerated input type of CreateProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of project.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The owner ID to create the project under.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryIds ([ID!])

A list of repository IDs to create as linked repositories for the project.

\n\n\n\n\n\n\n\n\n\n\n\n

template (ProjectTemplate)

The name of the GitHub-provided template.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreatePullRequestInput\n

\n

Autogenerated input type of CreatePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

baseRefName (String!)

The name of the branch you want your changes pulled into. This should be an existing branch\non the current repository. You cannot update the base branch on a pull request to point\nto another repository.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The contents of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

draft (Boolean)

Indicates whether this pull request should be a draft.

\n\n\n\n\n\n\n\n\n\n\n\n

headRefName (String!)

The name of the branch where your changes are implemented. For cross-repository pull requests\nin the same network, namespace head_ref_name with a user like this: username:branch.

\n\n\n\n\n\n\n\n\n\n\n\n

maintainerCanModify (Boolean)

Indicates whether maintainers can modify the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateRefInput\n

\n

Autogenerated input type of CreateRef.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The fully qualified name of the new Ref (ie: refs/heads/my_new_branch).

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The GitObjectID that the new Ref shall target. Must point to a commit.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the Repository to create the Ref in.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateRepositoryInput\n

\n

Autogenerated input type of CreateRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A short description of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

hasIssuesEnabled (Boolean)

Indicates if the repository should have the issues feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasWikiEnabled (Boolean)

Indicates if the repository should have the wiki feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

homepageUrl (URI)

The URL for a web page about this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID)

The ID of the owner for the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

teamId (ID)

When an organization is specified as the owner, this ID identifies the team\nthat should be granted access to the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

template (Boolean)

Whether this repository should be marked as a template such that anyone who\ncan access it can create new repositories with the same files and directory structure.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepositoryVisibility!)

Indicates the repository's visibility level.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateTeamDiscussionCommentInput\n

\n

Autogenerated input type of CreateTeamDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The content of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

discussionId (ID!)

The ID of the discussion to which the comment belongs.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateTeamDiscussionInput\n

\n

Autogenerated input type of CreateTeamDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The content of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

private (Boolean)

If true, restricts the visibility of this discussion to team members and\norganization admins. If false or not specified, allows any organization member\nto view this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

teamId (ID!)

The ID of the team to which the discussion belongs.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteBranchProtectionRuleInput\n

\n

Autogenerated input type of DeleteBranchProtectionRule.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

branchProtectionRuleId (ID!)

The global relay id of the branch protection rule to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteDeploymentInput\n

\n

Autogenerated input type of DeleteDeployment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the deployment to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteDiscussionCommentInput\n

\n

Autogenerated input type of DeleteDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node id of the discussion comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteDiscussionInput\n

\n

Autogenerated input type of DeleteDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The id of the discussion to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteEnvironmentInput\n

\n

Autogenerated input type of DeleteEnvironment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the environment to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteIpAllowListEntryInput\n

\n

Autogenerated input type of DeleteIpAllowListEntry.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEntryId (ID!)

The ID of the IP allow list entry to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteIssueCommentInput\n

\n

Autogenerated input type of DeleteIssueComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteIssueInput\n

\n

Autogenerated input type of DeleteIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The ID of the issue to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteLabelInput\n

\n

Autogenerated input type of DeleteLabel.

\n
\n\n
\n \n
\n

Preview notice

\n

DeleteLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the label to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteProjectCardInput\n

\n

Autogenerated input type of DeleteProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cardId (ID!)

The id of the card to delete.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteProjectColumnInput\n

\n

Autogenerated input type of DeleteProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnId (ID!)

The id of the column to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteProjectInput\n

\n

Autogenerated input type of DeleteProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The Project ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeletePullRequestReviewCommentInput\n

\n

Autogenerated input type of DeletePullRequestReviewComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeletePullRequestReviewInput\n

\n

Autogenerated input type of DeletePullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID!)

The Node ID of the pull request review to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteRefInput\n

\n

Autogenerated input type of DeleteRef.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

refId (ID!)

The Node ID of the Ref to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteTeamDiscussionCommentInput\n

\n

Autogenerated input type of DeleteTeamDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteTeamDiscussionInput\n

\n

Autogenerated input type of DeleteTeamDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The discussion ID to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeploymentOrder\n

\n

Ordering options for deployment connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (DeploymentOrderField!)

The field to order deployments by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DisablePullRequestAutoMergeInput\n

\n

Autogenerated input type of DisablePullRequestAutoMerge.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to disable auto merge on.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DiscussionOrder\n

\n

Ways in which lists of discussions can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order discussions by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (DiscussionOrderField!)

The field by which to order discussions.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DismissPullRequestReviewInput\n

\n

Autogenerated input type of DismissPullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String!)

The contents of the pull request review dismissal message.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID!)

The Node ID of the pull request review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DraftPullRequestReviewComment\n

\n

Specifies a review comment to be left with a Pull Request Review.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

Body of the comment to leave.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

Path to the file being commented on.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int!)

Position in the file to leave a comment on.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DraftPullRequestReviewThread\n

\n

Specifies a review comment thread to be left with a Pull Request Review.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

Body of the comment to leave.

\n\n\n\n\n\n\n\n\n\n\n\n

line (Int!)

The line of the blob to which the thread refers. The end of the line range for multi-line comments.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

Path to the file being commented on.

\n\n\n\n\n\n\n\n\n\n\n\n

side (DiffSide)

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.

\n\n\n\n\n\n\n\n\n\n\n\n

startLine (Int)

The first line of the range to which the comment refers.

\n\n\n\n\n\n\n\n\n\n\n\n

startSide (DiffSide)

The side of the diff on which the start line resides.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnablePullRequestAutoMergeInput\n

\n

Autogenerated input type of EnablePullRequestAutoMerge.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

authorEmail (String)

The email address to associate with this merge.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitBody (String)

Commit body to use for the commit when the PR is mergable; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

commitHeadline (String)

Commit headline to use for the commit when the PR is mergable; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeMethod (PullRequestMergeMethod)

The merge method to use. If omitted, defaults to 'MERGE'.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to enable auto-merge on.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorInvitationOrder\n

\n

Ordering options for enterprise administrator invitation connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseAdministratorInvitationOrderField!)

The field to order enterprise administrator invitations by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseMemberOrder\n

\n

Ordering options for enterprise member connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseMemberOrderField!)

The field to order enterprise members by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountEmailOrder\n

\n

Ordering options for Enterprise Server user account email connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseServerUserAccountEmailOrderField!)

The field to order emails by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountOrder\n

\n

Ordering options for Enterprise Server user account connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseServerUserAccountOrderField!)

The field to order user accounts by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountsUploadOrder\n

\n

Ordering options for Enterprise Server user accounts upload connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseServerUserAccountsUploadOrderField!)

The field to order user accounts uploads by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n FileAddition\n

\n

A command to add a file at the given path with the given contents as part of a\ncommit. Any existing file at that that path will be replaced.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contents (Base64String!)

The base64 encoded contents of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path in the repository where the file will be located.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n FileChanges\n

\n

A description of a set of changes to a file tree to be made as part of\na git commit, modeled as zero or more file additions and zero or more\nfile deletions.

\n

Both fields are optional; omitting both will produce a commit with no\nfile changes.

\n

deletions and additions describe changes to files identified\nby their path in the git tree using unix-style path separators, i.e.\n/. The root of a git tree is an empty string, so paths are not\nslash-prefixed.

\n

path values must be unique across all additions and deletions\nprovided. Any duplication will result in a validation error.

\n

Encoding

\n

File contents must be provided in full for each FileAddition.

\n

The contents of a FileAddition must be encoded using RFC 4648\ncompliant base64, i.e. correct padding is required and no characters\noutside the standard alphabet may be used. Invalid base64\nencoding will be rejected with a validation error.

\n

The encoded contents may be binary.

\n

For text files, no assumptions are made about the character encoding of\nthe file contents (after base64 decoding). No charset transcoding or\nline-ending normalization will be performed; it is the client's\nresponsibility to manage the character encoding of files they provide.\nHowever, for maximum compatibility we recommend using UTF-8 encoding\nand ensuring that all files in a repository use a consistent\nline-ending convention (\\n or \\r\\n), and that all files end\nwith a newline.

\n

Modeling file changes

\n

Each of the the five types of conceptual changes that can be made in a\ngit commit can be described using the FileChanges type as follows:

\n
    \n
  1. \n

    New file addition: create file hello world\\n at path docs/README.txt:

    \n

    {\n"additions" [\n{\n"path": "docs/README.txt",\n"contents": base64encode("hello world\\n")\n}\n]\n}

    \n
    2. \n
  2. \n

    Existing file modification: change existing docs/README.txt to have new\ncontent new content here\\n:

    \n
    {\n  "additions" [\n    {\n      "path": "docs/README.txt",\n      "contents": base64encode("new content here\\n")\n    }\n  ]\n}\n
    \n
    3. \n
  3. \n

    Existing file deletion: remove existing file docs/README.txt.\nNote that the path is required to exist -- specifying a\npath that does not exist on the given branch will abort the\ncommit and return an error.

    \n
    {\n  "deletions" [\n    {\n      "path": "docs/README.txt"\n    }\n  ]\n}\n
    \n
    4. \n
  4. \n

    File rename with no changes: rename docs/README.txt with\nprevious content hello world\\n to the same content at\nnewdocs/README.txt:

    \n
    {\n  "deletions" [\n    {\n      "path": "docs/README.txt",\n    }\n  ],\n  "additions" [\n    {\n      "path": "newdocs/README.txt",\n      "contents": base64encode("hello world\\n")\n    }\n  ]\n}\n
    \n
    5. \n
  5. \n

    File rename with changes: rename docs/README.txt with\nprevious content hello world\\n to a file at path\nnewdocs/README.txt with content new contents\\n:

    \n
    {\n  "deletions" [\n    {\n      "path": "docs/README.txt",\n    }\n  ],\n  "additions" [\n    {\n      "path": "newdocs/README.txt",\n      "contents": base64encode("new contents\\n")\n    }\n  ]\n}.\n
    \n
    6. \n
\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

additions ([FileAddition!])

File to add or change.

\n\n\n\n\n\n\n\n\n\n\n\n

deletions ([FileDeletion!])

Files to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n FileDeletion\n

\n

A command to delete the file at the given path as part of a commit.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

path (String!)

The path to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n FollowUserInput\n

\n

Autogenerated input type of FollowUser.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

userId (ID!)

ID of the user to follow.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n GistOrder\n

\n

Ordering options for gist connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (GistOrderField!)

The field to order repositories by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ImportProjectInput\n

\n

Autogenerated input type of ImportProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of Project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnImports ([ProjectColumnImport!]!)

A list of columns containing issues and pull requests.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of Project.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerName (String!)

The name of the Organization or User to create the Project under.

\n\n\n\n\n\n\n\n\n\n\n\n

public (Boolean)

Whether the Project is public or not.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IpAllowListEntryOrder\n

\n

Ordering options for IP allow list entry connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (IpAllowListEntryOrderField!)

The field to order IP allow list entries by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IssueCommentOrder\n

\n

Ways in which lists of issue comments can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order issue comments by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (IssueCommentOrderField!)

The field in which to order issue comments by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IssueFilters\n

\n

Ways in which to filter lists of issues.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assignee (String)

List issues assigned to given name. Pass in null for issues with no assigned\nuser, and * for issues assigned to any user.

\n\n\n\n\n\n\n\n\n\n\n\n

createdBy (String)

List issues created by given name.

\n\n\n\n\n\n\n\n\n\n\n\n

labels ([String!])

List issues where the list of label names exist on the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

mentioned (String)

List issues where the given name is mentioned in the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

milestone (String)

List issues by given milestone argument. If an string representation of an\ninteger is passed, it should refer to a milestone by its number field. Pass in\nnull for issues with no milestone, and * for issues that are assigned to any milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

since (DateTime)

List issues that have been updated at or after the given date.

\n\n\n\n\n\n\n\n\n\n\n\n

states ([IssueState!])

List issues filtered by the list of states given.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscribed (Boolean)

List issues subscribed to by viewer.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IssueOrder\n

\n

Ways in which lists of issues can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order issues by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (IssueOrderField!)

The field in which to order issues by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LabelOrder\n

\n

Ways in which lists of labels can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order labels by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (LabelOrderField!)

The field in which to order labels by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LanguageOrder\n

\n

Ordering options for language connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (LanguageOrderField!)

The field to order languages by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LinkRepositoryToProjectInput\n

\n

Autogenerated input type of LinkRepositoryToProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The ID of the Project to link to a Repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the Repository to link to a Project.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LockLockableInput\n

\n

Autogenerated input type of LockLockable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

lockReason (LockReason)

A reason for why the item will be locked.

\n\n\n\n\n\n\n\n\n\n\n\n

lockableId (ID!)

ID of the item to be locked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MarkDiscussionCommentAsAnswerInput\n

\n

Autogenerated input type of MarkDiscussionCommentAsAnswer.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the discussion comment to mark as an answer.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MarkFileAsViewedInput\n

\n

Autogenerated input type of MarkFileAsViewed.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path of the file to mark as viewed.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MarkPullRequestReadyForReviewInput\n

\n

Autogenerated input type of MarkPullRequestReadyForReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be marked as ready for review.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MergeBranchInput\n

\n

Autogenerated input type of MergeBranch.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

base (String!)

The name of the base branch that the provided head will be merged into.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitMessage (String)

Message to use for the merge commit. If omitted, a default will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

head (String!)

The head to merge into the base branch. This can be a branch name or a commit GitObjectID.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the Repository containing the base branch that will be modified.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MergePullRequestInput\n

\n

Autogenerated input type of MergePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

authorEmail (String)

The email address to associate with this merge.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitBody (String)

Commit body to use for the merge commit; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

commitHeadline (String)

Commit headline to use for the merge commit; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

expectedHeadOid (GitObjectID)

OID that the pull request head ref must match to allow merge; if omitted, no check is performed.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeMethod (PullRequestMergeMethod)

The merge method to use. If omitted, defaults to 'MERGE'.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be merged.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MilestoneOrder\n

\n

Ordering options for milestone connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (MilestoneOrderField!)

The field to order milestones by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MinimizeCommentInput\n

\n

Autogenerated input type of MinimizeComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

classifier (ReportedContentClassifiers!)

The classification of comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MoveProjectCardInput\n

\n

Autogenerated input type of MoveProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

afterCardId (ID)

Place the new card after the card with this id. Pass null to place it at the top.

\n\n\n\n\n\n\n\n\n\n\n\n

cardId (ID!)

The id of the card to move.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnId (ID!)

The id of the column to move it into.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MoveProjectColumnInput\n

\n

Autogenerated input type of MoveProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

afterColumnId (ID)

Place the new column after the column with this id. Pass null to place it at the front.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnId (ID!)

The id of the column to move.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n OrganizationOrder\n

\n

Ordering options for organization connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (OrganizationOrderField!)

The field to order organizations by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PinIssueInput\n

\n

Autogenerated input type of PinIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The ID of the issue to be pinned.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ProjectCardImport\n

\n

An issue or PR and its owning repository to be used in a project card.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

number (Int!)

The issue or pull request number.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (String!)

Repository name with owner (owner/repository).

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ProjectColumnImport\n

\n

A project column and a list of its issues and PRs.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

columnName (String!)

The name of the column.

\n\n\n\n\n\n\n\n\n\n\n\n

issues ([ProjectCardImport!])

A list of issues and pull requests in the column.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int!)

The position of the column, starting from 0.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ProjectOrder\n

\n

Ways in which lists of projects can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order projects by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (ProjectOrderField!)

The field in which to order projects by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PullRequestOrder\n

\n

Ways in which lists of issues can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order pull requests by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (PullRequestOrderField!)

The field in which to order pull requests by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReactionOrder\n

\n

Ways in which lists of reactions can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order reactions by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (ReactionOrderField!)

The field in which to order reactions by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RefOrder\n

\n

Ways in which lists of git refs can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order refs by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (RefOrderField!)

The field in which to order refs by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RefUpdate\n

\n

A ref update.

\n
\n\n
\n \n
\n

Preview notice

\n

RefUpdate is available under the Update refs preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

afterOid (GitObjectID!)

The value this ref should be updated to.

\n\n\n\n\n\n\n\n\n\n\n\n

beforeOid (GitObjectID)

The value this ref needs to point to before the update.

\n\n\n\n\n\n\n\n\n\n\n\n

force (Boolean)

Force a non fast-forward update.

\n\n\n\n\n\n\n\n\n\n\n\n

name (GitRefname!)

The fully qualified name of the ref to be update. For example refs/heads/branch-name.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RejectDeploymentsInput\n

\n

Autogenerated input type of RejectDeployments.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

comment (String)

Optional comment for rejecting deployments.

\n\n\n\n\n\n\n\n\n\n\n\n

environmentIds ([ID!]!)

The ids of environments to reject deployments.

\n\n\n\n\n\n\n\n\n\n\n\n

workflowRunId (ID!)

The node ID of the workflow run containing the pending deployments.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReleaseOrder\n

\n

Ways in which lists of releases can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order releases by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (ReleaseOrderField!)

The field in which to order releases by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveAssigneesFromAssignableInput\n

\n

Autogenerated input type of RemoveAssigneesFromAssignable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assignableId (ID!)

The id of the assignable object to remove assignees from.

\n\n\n\n\n\n\n\n\n\n\n\n

assigneeIds ([ID!]!)

The id of users to remove as assignees.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveEnterpriseAdminInput\n

\n

Autogenerated input type of RemoveEnterpriseAdmin.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The Enterprise ID from which to remove the administrator.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of the user to remove as an administrator.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveLabelsFromLabelableInput\n

\n

Autogenerated input type of RemoveLabelsFromLabelable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!]!)

The ids of labels to remove.

\n\n\n\n\n\n\n\n\n\n\n\n

labelableId (ID!)

The id of the Labelable to remove labels from.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveOutsideCollaboratorInput\n

\n

Autogenerated input type of RemoveOutsideCollaborator.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationId (ID!)

The ID of the organization to remove the outside collaborator from.

\n\n\n\n\n\n\n\n\n\n\n\n

userId (ID!)

The ID of the outside collaborator to remove.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveReactionInput\n

\n

Autogenerated input type of RemoveReaction.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

content (ReactionContent!)

The name of the emoji reaction to remove.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveStarInput\n

\n

Autogenerated input type of RemoveStar.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

starrableId (ID!)

The Starrable ID to unstar.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveUpvoteInput\n

\n

Autogenerated input type of RemoveUpvote.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the discussion or comment to remove upvote.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReopenIssueInput\n

\n

Autogenerated input type of ReopenIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

ID of the issue to be opened.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReopenPullRequestInput\n

\n

Autogenerated input type of ReopenPullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be reopened.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RepositoryInvitationOrder\n

\n

Ordering options for repository invitation connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (RepositoryInvitationOrderField!)

The field to order repository invitations by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RepositoryOrder\n

\n

Ordering options for repository connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (RepositoryOrderField!)

The field to order repositories by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RequestReviewsInput\n

\n

Autogenerated input type of RequestReviews.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

teamIds ([ID!])

The Node IDs of the team to request.

\n\n\n\n\n\n\n\n\n\n\n\n

union (Boolean)

Add users to the set rather than replace.

\n\n\n\n\n\n\n\n\n\n\n\n

userIds ([ID!])

The Node IDs of the user to request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RerequestCheckSuiteInput\n

\n

Autogenerated input type of RerequestCheckSuite.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

checkSuiteId (ID!)

The Node ID of the check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ResolveReviewThreadInput\n

\n

Autogenerated input type of ResolveReviewThread.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

threadId (ID!)

The ID of the thread to resolve.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SavedReplyOrder\n

\n

Ordering options for saved reply connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SavedReplyOrderField!)

The field to order saved replies by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n StarOrder\n

\n

Ways in which star connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (StarOrderField!)

The field in which to order nodes by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SubmitPullRequestReviewInput\n

\n

Autogenerated input type of SubmitPullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The text field to set on the Pull Request Review.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

event (PullRequestReviewEvent!)

The event to send to the Pull Request Review.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID)

The Pull Request ID to submit any pending reviews.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID)

The Pull Request Review ID to submit.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamDiscussionCommentOrder\n

\n

Ways in which team discussion comment connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamDiscussionCommentOrderField!)

The field by which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamDiscussionOrder\n

\n

Ways in which team discussion connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamDiscussionOrderField!)

The field by which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamMemberOrder\n

\n

Ordering options for team member connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamMemberOrderField!)

The field to order team members by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamOrder\n

\n

Ways in which team connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamOrderField!)

The field in which to order nodes by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamRepositoryOrder\n

\n

Ordering options for team repository connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamRepositoryOrderField!)

The field to order repositories by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TransferIssueInput\n

\n

Autogenerated input type of TransferIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The Node ID of the issue to be transferred.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository the issue should be transferred to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnarchiveRepositoryInput\n

\n

Autogenerated input type of UnarchiveRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to unarchive.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnfollowUserInput\n

\n

Autogenerated input type of UnfollowUser.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

userId (ID!)

ID of the user to unfollow.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnlinkRepositoryFromProjectInput\n

\n

Autogenerated input type of UnlinkRepositoryFromProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The ID of the Project linked to the Repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the Repository linked to the Project.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnlockLockableInput\n

\n

Autogenerated input type of UnlockLockable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

lockableId (ID!)

ID of the item to be unlocked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnmarkDiscussionCommentAsAnswerInput\n

\n

Autogenerated input type of UnmarkDiscussionCommentAsAnswer.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the discussion comment to unmark as an answer.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnmarkFileAsViewedInput\n

\n

Autogenerated input type of UnmarkFileAsViewed.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path of the file to mark as unviewed.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnmarkIssueAsDuplicateInput\n

\n

Autogenerated input type of UnmarkIssueAsDuplicate.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

canonicalId (ID!)

ID of the issue or pull request currently considered canonical/authoritative/original.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

duplicateId (ID!)

ID of the issue or pull request currently marked as a duplicate.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnminimizeCommentInput\n

\n

Autogenerated input type of UnminimizeComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnpinIssueInput\n

\n

Autogenerated input type of UnpinIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The ID of the issue to be unpinned.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnresolveReviewThreadInput\n

\n

Autogenerated input type of UnresolveReviewThread.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

threadId (ID!)

The ID of the thread to unresolve.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateBranchProtectionRuleInput\n

\n

Autogenerated input type of UpdateBranchProtectionRule.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowsDeletions (Boolean)

Can this branch be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

allowsForcePushes (Boolean)

Are force pushes allowed on this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

branchProtectionRuleId (ID!)

The global relay id of the branch protection rule to be updated.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissesStaleReviews (Boolean)

Will new commits pushed to matching branches dismiss pull request review approvals.

\n\n\n\n\n\n\n\n\n\n\n\n

isAdminEnforced (Boolean)

Can admins overwrite branch protection.

\n\n\n\n\n\n\n\n\n\n\n\n

pattern (String)

The glob-like pattern used to determine matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

pushActorIds ([ID!])

A list of User, Team or App IDs allowed to push to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredStatusCheckContexts ([String!])

List of required status check contexts that must pass for commits to be accepted to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresApprovingReviews (Boolean)

Are approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCodeOwnerReviews (Boolean)

Are reviews from code owners required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCommitSignatures (Boolean)

Are commits required to be signed.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresConversationResolution (Boolean)

Are conversations required to be resolved before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresLinearHistory (Boolean)

Are merge commits prohibited from being pushed to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStatusChecks (Boolean)

Are status checks required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStrictStatusChecks (Boolean)

Are branches required to be up to date before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsPushes (Boolean)

Is pushing to matching branches restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsReviewDismissals (Boolean)

Is dismissal of pull request reviews restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDismissalActorIds ([ID!])

A list of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateCheckRunInput\n

\n

Autogenerated input type of UpdateCheckRun.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actions ([CheckRunAction!])

Possible further actions the integrator can perform, which a user may trigger.

\n\n\n\n\n\n\n\n\n\n\n\n

checkRunId (ID!)

The node of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

completedAt (DateTime)

The time that the check run finished.

\n\n\n\n\n\n\n\n\n\n\n\n

conclusion (CheckConclusionState)

The final conclusion of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

detailsUrl (URI)

The URL of the integrator's site that has the full details of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

externalId (String)

A reference for the run on the integrator's system.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

output (CheckRunOutput)

Descriptive details about the run.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

startedAt (DateTime)

The time that the check run began.

\n\n\n\n\n\n\n\n\n\n\n\n

status (RequestableCheckStatusState)

The current status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateCheckSuitePreferencesInput\n

\n

Autogenerated input type of UpdateCheckSuitePreferences.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

autoTriggerPreferences ([CheckSuiteAutoTriggerPreference!]!)

The check suite preferences to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateDiscussionCommentInput\n

\n

Autogenerated input type of UpdateDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The new contents of the comment body.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commentId (ID!)

The Node ID of the discussion comment to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateDiscussionInput\n

\n

Autogenerated input type of UpdateDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The new contents of the discussion body.

\n\n\n\n\n\n\n\n\n\n\n\n

categoryId (ID)

The Node ID of a discussion category within the same repository to change this discussion to.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

discussionId (ID!)

The Node ID of the discussion to update.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The new discussion title.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseAllowPrivateRepositoryForkingSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the allow private repository forking setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the allow private repository forking setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseDefaultRepositoryPermissionSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseDefaultRepositoryPermissionSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the base repository permission setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseDefaultRepositoryPermissionSettingValue!)

The value for the base repository permission setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanChangeRepositoryVisibilitySetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can change repository visibility setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can change repository visibility setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanCreateRepositoriesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanCreateRepositoriesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can create repositories setting.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreateInternalRepositories (Boolean)

Allow members to create internal repositories. Defaults to current value.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreatePrivateRepositories (Boolean)

Allow members to create private repositories. Defaults to current value.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreatePublicRepositories (Boolean)

Allow members to create public repositories. Defaults to current value.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreateRepositoriesPolicyEnabled (Boolean)

When false, allow member organizations to set their own repository creation member privileges.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseMembersCanCreateRepositoriesSettingValue)

Value for the members can create repositories setting on the enterprise. This\nor the granular public/private/internal allowed fields (but not both) must be provided.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanDeleteIssuesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanDeleteIssuesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can delete issues setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can delete issues setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanDeleteRepositoriesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can delete repositories setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can delete repositories setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanInviteCollaboratorsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can invite collaborators setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can invite collaborators setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanMakePurchasesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanMakePurchasesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can make purchases setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseMembersCanMakePurchasesSettingValue!)

The value for the members can make purchases setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanUpdateProtectedBranchesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can update protected branches setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can update protected branches setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanViewDependencyInsightsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can view dependency insights setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can view dependency insights setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseOrganizationProjectsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseOrganizationProjectsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the organization projects setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the organization projects setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseProfileInput\n

\n

Autogenerated input type of UpdateEnterpriseProfile.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The Enterprise ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n

location (String)

The location of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

websiteUrl (String)

The URL of the enterprise's website.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseRepositoryProjectsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseRepositoryProjectsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the repository projects setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the repository projects setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseTeamDiscussionsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseTeamDiscussionsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the team discussions setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the team discussions setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseTwoFactorAuthenticationRequiredSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the two factor authentication required setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledSettingValue!)

The value for the two factor authentication required setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnvironmentInput\n

\n

Autogenerated input type of UpdateEnvironment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

environmentId (ID!)

The node ID of the environment.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewers ([ID!])

The ids of users or teams that can approve deployments to this environment.

\n\n\n\n\n\n\n\n\n\n\n\n

waitTimer (Int)

The wait timer in minutes.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIpAllowListEnabledSettingInput\n

\n

Autogenerated input type of UpdateIpAllowListEnabledSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner on which to set the IP allow list enabled setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (IpAllowListEnabledSettingValue!)

The value for the IP allow list enabled setting.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIpAllowListEntryInput\n

\n

Autogenerated input type of UpdateIpAllowListEntry.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowListValue (String!)

An IP address or range of addresses in CIDR notation.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEntryId (ID!)

The ID of the IP allow list entry to update.

\n\n\n\n\n\n\n\n\n\n\n\n

isActive (Boolean!)

Whether the IP allow list entry is active when an IP allow list is enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

An optional name for the IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIpAllowListForInstalledAppsEnabledSettingInput\n

\n

Autogenerated input type of UpdateIpAllowListForInstalledAppsEnabledSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (IpAllowListForInstalledAppsEnabledSettingValue!)

The value for the IP allow list configuration for installed GitHub Apps setting.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIssueCommentInput\n

\n

Autogenerated input type of UpdateIssueComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The updated text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the IssueComment to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIssueInput\n

\n

Autogenerated input type of UpdateIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assigneeIds ([ID!])

An array of Node IDs of users for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The body for the issue description.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the Issue to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!])

An array of Node IDs of labels for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneId (ID)

The Node ID of the milestone for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

projectIds ([ID!])

An array of Node IDs for projects associated with this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

state (IssueState)

The desired issue state.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title for the issue.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateLabelInput\n

\n

Autogenerated input type of UpdateLabel.

\n
\n\n
\n \n
\n

Preview notice

\n

UpdateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

color (String)

A 6 character hex code, without the leading #, identifying the updated color of the label.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A brief description of the label, such as its purpose.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the label to be updated.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The updated name of the label.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateProjectCardInput\n

\n

Autogenerated input type of UpdateProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

isArchived (Boolean)

Whether or not the ProjectCard should be archived.

\n\n\n\n\n\n\n\n\n\n\n\n

note (String)

The note of ProjectCard.

\n\n\n\n\n\n\n\n\n\n\n\n

projectCardId (ID!)

The ProjectCard ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateProjectColumnInput\n

\n

Autogenerated input type of UpdateProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of project column.

\n\n\n\n\n\n\n\n\n\n\n\n

projectColumnId (ID!)

The ProjectColumn ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateProjectInput\n

\n

Autogenerated input type of UpdateProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of project.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The Project ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n

public (Boolean)

Whether the project is public or not.

\n\n\n\n\n\n\n\n\n\n\n\n

state (ProjectState)

Whether the project is open or closed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdatePullRequestInput\n

\n

Autogenerated input type of UpdatePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assigneeIds ([ID!])

An array of Node IDs of users for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRefName (String)

The name of the branch you want your changes pulled into. This should be an existing branch\non the current repository.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The contents of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!])

An array of Node IDs of labels for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

maintainerCanModify (Boolean)

Indicates whether maintainers can modify the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneId (ID)

The Node ID of the milestone for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

projectIds ([ID!])

An array of Node IDs for projects associated with this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

state (PullRequestUpdateState)

The target state of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdatePullRequestReviewCommentInput\n

\n

Autogenerated input type of UpdatePullRequestReviewComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewCommentId (ID!)

The Node ID of the comment to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdatePullRequestReviewInput\n

\n

Autogenerated input type of UpdatePullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The contents of the pull request review body.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID!)

The Node ID of the pull request review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateRefInput\n

\n

Autogenerated input type of UpdateRef.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

force (Boolean)

Permit updates of branch Refs that are not fast-forwards?.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The GitObjectID that the Ref shall be updated to target.

\n\n\n\n\n\n\n\n\n\n\n\n

refId (ID!)

The Node ID of the Ref to be updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateRefsInput\n

\n

Autogenerated input type of UpdateRefs.

\n
\n\n
\n \n
\n

Preview notice

\n

UpdateRefsInput is available under the Update refs preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

refUpdates ([RefUpdate!]!)

A list of ref updates.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateRepositoryInput\n

\n

Autogenerated input type of UpdateRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A new description for the repository. Pass an empty string to erase the existing description.

\n\n\n\n\n\n\n\n\n\n\n\n

hasIssuesEnabled (Boolean)

Indicates if the repository should have the issues feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasProjectsEnabled (Boolean)

Indicates if the repository should have the project boards feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasWikiEnabled (Boolean)

Indicates if the repository should have the wiki feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

homepageUrl (URI)

The URL for a web page about this repository. Pass an empty string to erase the existing URL.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The new name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to update.

\n\n\n\n\n\n\n\n\n\n\n\n

template (Boolean)

Whether this repository should be marked as a template such that anyone who\ncan access it can create new repositories with the same files and directory structure.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateSubscriptionInput\n

\n

Autogenerated input type of UpdateSubscription.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

state (SubscriptionState!)

The new state of the subscription.

\n\n\n\n\n\n\n\n\n\n\n\n

subscribableId (ID!)

The Node ID of the subscribable object to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTeamDiscussionCommentInput\n

\n

Autogenerated input type of UpdateTeamDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The updated text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyVersion (String)

The current version of the body content.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTeamDiscussionInput\n

\n

Autogenerated input type of UpdateTeamDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The updated text of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyVersion (String)

The current version of the body content. If provided, this update operation\nwill be rejected if the given version does not match the latest version on the server.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the discussion to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

pinned (Boolean)

If provided, sets the pinned state of the updated discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The updated title of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTeamReviewAssignmentInput\n

\n

Autogenerated input type of UpdateTeamReviewAssignment.

\n
\n\n
\n \n
\n

Preview notice

\n

UpdateTeamReviewAssignmentInput is available under the Team review assignments preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

algorithm (TeamReviewAssignmentAlgorithm)

The algorithm to use for review assignment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enabled (Boolean!)

Turn on or off review assignment.

\n\n\n\n\n\n\n\n\n\n\n\n

excludedTeamMemberIds ([ID!])

An array of team member IDs to exclude.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the team to update review assignments of.

\n\n\n\n\n\n\n\n\n\n\n\n

notifyTeam (Boolean)

Notify the entire team of the PR if it is delegated.

\n\n\n\n\n\n\n\n\n\n\n\n

teamMemberCount (Int)

The number of team members to assign.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTopicsInput\n

\n

Autogenerated input type of UpdateTopics.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

topicNames ([String!]!)

An array of topic names.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UserStatusOrder\n

\n

Ordering options for user status connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (UserStatusOrderField!)

The field to order user statuses by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n", + "html": "
\n
\n

\n AddAssigneesToAssignableInput\n

\n

Autogenerated input type of AddAssigneesToAssignable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assignableId (ID!)

The id of the assignable object to add assignees to.

\n\n\n\n\n\n\n\n\n\n\n\n

assigneeIds ([ID!]!)

The id of users to add as assignees.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddCommentInput\n

\n

Autogenerated input type of AddComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The contents of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddDiscussionCommentInput\n

\n

Autogenerated input type of AddDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The contents of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

discussionId (ID!)

The Node ID of the discussion to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

replyToId (ID)

The Node ID of the discussion comment within this discussion to reply to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddEnterpriseAdminInput\n

\n

Autogenerated input type of AddEnterpriseAdmin.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise account to which the administrator should be added.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of the user to add as an administrator.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddLabelsToLabelableInput\n

\n

Autogenerated input type of AddLabelsToLabelable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!]!)

The ids of the labels to add.

\n\n\n\n\n\n\n\n\n\n\n\n

labelableId (ID!)

The id of the labelable object to add labels to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddProjectCardInput\n

\n

Autogenerated input type of AddProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

contentId (ID)

The content of the card. Must be a member of the ProjectCardItem union.

\n\n\n\n\n\n\n\n\n\n\n\n

note (String)

The note on the card.

\n\n\n\n\n\n\n\n\n\n\n\n

projectColumnId (ID!)

The Node ID of the ProjectColumn.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddProjectColumnInput\n

\n

Autogenerated input type of AddProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the column.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The Node ID of the project.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddPullRequestReviewCommentInput\n

\n

Autogenerated input type of AddPullRequestReviewComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitOID (GitObjectID)

The SHA of the commit to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

inReplyTo (ID)

The comment id to reply to.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String)

The relative path of the file to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int)

The line index in the diff to comment on.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID)

The node ID of the pull request reviewing.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID)

The Node ID of the review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddPullRequestReviewInput\n

\n

Autogenerated input type of AddPullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The contents of the review body comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

comments ([DraftPullRequestReviewComment])

The review line comments.

\n\n\n\n\n\n\n\n\n\n\n\n

commitOID (GitObjectID)

The commit OID the review pertains to.

\n\n\n\n\n\n\n\n\n\n\n\n

event (PullRequestReviewEvent)

The event to perform on the pull request review.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

threads ([DraftPullRequestReviewThread])

The review line comment threads.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddPullRequestReviewThreadInput\n

\n

Autogenerated input type of AddPullRequestReviewThread.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

Body of the thread's first comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

line (Int!)

The line of the blob to which the thread refers. The end of the line range for multi-line comments.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

Path to the file being commented on.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID)

The node ID of the pull request reviewing.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID)

The Node ID of the review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

side (DiffSide)

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.

\n\n\n\n\n\n\n\n\n\n\n\n

startLine (Int)

The first line of the range to which the comment refers.

\n\n\n\n\n\n\n\n\n\n\n\n

startSide (DiffSide)

The side of the diff on which the start line resides.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddReactionInput\n

\n

Autogenerated input type of AddReaction.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

content (ReactionContent!)

The name of the emoji to react with.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddStarInput\n

\n

Autogenerated input type of AddStar.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

starrableId (ID!)

The Starrable ID to star.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AddUpvoteInput\n

\n

Autogenerated input type of AddUpvote.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the discussion or comment to upvote.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ApproveDeploymentsInput\n

\n

Autogenerated input type of ApproveDeployments.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

comment (String)

Optional comment for approving deployments.

\n\n\n\n\n\n\n\n\n\n\n\n

environmentIds ([ID!]!)

The ids of environments to reject deployments.

\n\n\n\n\n\n\n\n\n\n\n\n

workflowRunId (ID!)

The node ID of the workflow run containing the pending deployments.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ArchiveRepositoryInput\n

\n

Autogenerated input type of ArchiveRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to mark as archived.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n AuditLogOrder\n

\n

Ordering options for Audit Log connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (AuditLogOrderField)

The field to order Audit Logs by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ChangeUserStatusInput\n

\n

Autogenerated input type of ChangeUserStatus.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

emoji (String)

The emoji to represent your status. Can either be a native Unicode emoji or an emoji name with colons, e.g., 😀.

\n\n\n\n\n\n\n\n\n\n\n\n

expiresAt (DateTime)

If set, the user status will not be shown after this date.

\n\n\n\n\n\n\n\n\n\n\n\n

limitedAvailability (Boolean)

Whether this status should indicate you are not fully available on GitHub, e.g., you are away.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String)

A short description of your current status.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationId (ID)

The ID of the organization whose members will be allowed to see the status. If\nomitted, the status will be publicly visible.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckAnnotationData\n

\n

Information from a check run analysis to specific lines of code.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

annotationLevel (CheckAnnotationLevel!)

Represents an annotation's information level.

\n\n\n\n\n\n\n\n\n\n\n\n

location (CheckAnnotationRange!)

The location of the annotation.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String!)

A short description of the feedback for these lines of code.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path of the file to add an annotation to.

\n\n\n\n\n\n\n\n\n\n\n\n

rawDetails (String)

Details about this annotation.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title that represents the annotation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckAnnotationRange\n

\n

Information from a check run analysis to specific lines of code.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

endColumn (Int)

The ending column of the range.

\n\n\n\n\n\n\n\n\n\n\n\n

endLine (Int!)

The ending line of the range.

\n\n\n\n\n\n\n\n\n\n\n\n

startColumn (Int)

The starting column of the range.

\n\n\n\n\n\n\n\n\n\n\n\n

startLine (Int!)

The starting line of the range.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunAction\n

\n

Possible further actions the integrator can perform.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

description (String!)

A short explanation of what this action would do.

\n\n\n\n\n\n\n\n\n\n\n\n

identifier (String!)

A reference for the action on the integrator's system.

\n\n\n\n\n\n\n\n\n\n\n\n

label (String!)

The text to be displayed on a button in the web UI.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunFilter\n

\n

The filters that are available when fetching check runs.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

appId (Int)

Filters the check runs created by this application ID.

\n\n\n\n\n\n\n\n\n\n\n\n

checkName (String)

Filters the check runs by this name.

\n\n\n\n\n\n\n\n\n\n\n\n

checkType (CheckRunType)

Filters the check runs by this type.

\n\n\n\n\n\n\n\n\n\n\n\n

status (CheckStatusState)

Filters the check runs by this status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunOutput\n

\n

Descriptive details about the check run.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

annotations ([CheckAnnotationData!])

The annotations that are made as part of the check run.

\n\n\n\n\n\n\n\n\n\n\n\n

images ([CheckRunOutputImage!])

Images attached to the check run output displayed in the GitHub pull request UI.

\n\n\n\n\n\n\n\n\n\n\n\n

summary (String!)

The summary of the check run (supports Commonmark).

\n\n\n\n\n\n\n\n\n\n\n\n

text (String)

The details of the check run (supports Commonmark).

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

A title to provide for this check run.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckRunOutputImage\n

\n

Images attached to the check run output displayed in the GitHub pull request UI.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

alt (String!)

The alternative text for the image.

\n\n\n\n\n\n\n\n\n\n\n\n

caption (String)

A short image description.

\n\n\n\n\n\n\n\n\n\n\n\n

imageUrl (URI!)

The full URL of the image.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckSuiteAutoTriggerPreference\n

\n

The auto-trigger preferences that are available for check suites.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

appId (ID!)

The node ID of the application that owns the check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

setting (Boolean!)

Set to true to enable automatic creation of CheckSuite events upon pushes to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CheckSuiteFilter\n

\n

The filters that are available when fetching check suites.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

appId (Int)

Filters the check suites created by this application ID.

\n\n\n\n\n\n\n\n\n\n\n\n

checkName (String)

Filters the check suites by this name.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ClearLabelsFromLabelableInput\n

\n

Autogenerated input type of ClearLabelsFromLabelable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelableId (ID!)

The id of the labelable object to clear the labels from.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CloneProjectInput\n

\n

Autogenerated input type of CloneProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of the project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

includeWorkflows (Boolean!)

Whether or not to clone the source project's workflows.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the project.

\n\n\n\n\n\n\n\n\n\n\n\n

public (Boolean)

The visibility of the project, defaults to false (private).

\n\n\n\n\n\n\n\n\n\n\n\n

sourceId (ID!)

The source project to clone.

\n\n\n\n\n\n\n\n\n\n\n\n

targetOwnerId (ID!)

The owner ID to create the project under.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CloneTemplateRepositoryInput\n

\n

Autogenerated input type of CloneTemplateRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A short description of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

includeAllBranches (Boolean)

Whether to copy all branches from the template to the new repository. Defaults\nto copying only the default branch of the template.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner for the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the template repository.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepositoryVisibility!)

Indicates the repository's visibility level.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CloseIssueInput\n

\n

Autogenerated input type of CloseIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

ID of the issue to be closed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ClosePullRequestInput\n

\n

Autogenerated input type of ClosePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be closed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CommitAuthor\n

\n

Specifies an author for filtering Git commits.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

emails ([String!])

Email addresses to filter by. Commits authored by any of the specified email addresses will be returned.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID)

ID of a User to filter by. If non-null, only commits authored by this user\nwill be returned. This field takes precedence over emails.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CommitContributionOrder\n

\n

Ordering options for commit contribution connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (CommitContributionOrderField!)

The field by which to order commit contributions.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CommitMessage\n

\n

A message to include with a new commit.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The body of the message.

\n\n\n\n\n\n\n\n\n\n\n\n

headline (String!)

The headline of the message.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CommittableBranch\n

\n

A git ref for a commit to be appended to.

\n

The ref must be a branch, i.e. its fully qualified name must start\nwith refs/heads/ (although the input is not required to be fully\nqualified).

\n

The Ref may be specified by its global node ID or by the\nrepository nameWithOwner and branch name.

\n

Examples

\n

Specify a branch using a global node ID:

\n
{ "id": "MDM6UmVmMTpyZWZzL2hlYWRzL21haW4=" }\n
\n

Specify a branch using nameWithOwner and branch name:

\n
{\n  "nameWithOwner": "github/graphql-client",\n  "branchName": "main"\n}.\n
\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

branchName (String)

The unqualified name of the branch to append the commit to.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID)

The Node ID of the Ref to be updated.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryNameWithOwner (String)

The nameWithOwner of the repository to commit to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ContributionOrder\n

\n

Ordering options for contribution connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ConvertProjectCardNoteToIssueInput\n

\n

Autogenerated input type of ConvertProjectCardNoteToIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The body of the newly created issue.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectCardId (ID!)

The ProjectCard ID to convert.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to create the issue in.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title of the newly created issue. Defaults to the card's note text.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ConvertPullRequestToDraftInput\n

\n

Autogenerated input type of ConvertPullRequestToDraft.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to convert to draft.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateBranchProtectionRuleInput\n

\n

Autogenerated input type of CreateBranchProtectionRule.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowsDeletions (Boolean)

Can this branch be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

allowsForcePushes (Boolean)

Are force pushes allowed on this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissesStaleReviews (Boolean)

Will new commits pushed to matching branches dismiss pull request review approvals.

\n\n\n\n\n\n\n\n\n\n\n\n

isAdminEnforced (Boolean)

Can admins overwrite branch protection.

\n\n\n\n\n\n\n\n\n\n\n\n

pattern (String!)

The glob-like pattern used to determine matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

pushActorIds ([ID!])

A list of User, Team or App IDs allowed to push to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The global relay id of the repository in which a new branch protection rule should be created in.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredStatusCheckContexts ([String!])

List of required status check contexts that must pass for commits to be accepted to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresApprovingReviews (Boolean)

Are approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCodeOwnerReviews (Boolean)

Are reviews from code owners required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCommitSignatures (Boolean)

Are commits required to be signed.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresConversationResolution (Boolean)

Are conversations required to be resolved before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresLinearHistory (Boolean)

Are merge commits prohibited from being pushed to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStatusChecks (Boolean)

Are status checks required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStrictStatusChecks (Boolean)

Are branches required to be up to date before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsPushes (Boolean)

Is pushing to matching branches restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsReviewDismissals (Boolean)

Is dismissal of pull request reviews restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDismissalActorIds ([ID!])

A list of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateCheckRunInput\n

\n

Autogenerated input type of CreateCheckRun.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actions ([CheckRunAction!])

Possible further actions the integrator can perform, which a user may trigger.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

completedAt (DateTime)

The time that the check run finished.

\n\n\n\n\n\n\n\n\n\n\n\n

conclusion (CheckConclusionState)

The final conclusion of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

detailsUrl (URI)

The URL of the integrator's site that has the full details of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

externalId (String)

A reference for the run on the integrator's system.

\n\n\n\n\n\n\n\n\n\n\n\n

headSha (GitObjectID!)

The SHA of the head commit.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

output (CheckRunOutput)

Descriptive details about the run.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

startedAt (DateTime)

The time that the check run began.

\n\n\n\n\n\n\n\n\n\n\n\n

status (RequestableCheckStatusState)

The current status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateCheckSuiteInput\n

\n

Autogenerated input type of CreateCheckSuite.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

headSha (GitObjectID!)

The SHA of the head commit.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateCommitOnBranchInput\n

\n

Autogenerated input type of CreateCommitOnBranch.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

branch (CommittableBranch!)

The Ref to be updated. Must be a branch.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

expectedHeadOid (GitObjectID!)

The git commit oid expected at the head of the branch prior to the commit.

\n\n\n\n\n\n\n\n\n\n\n\n

fileChanges (FileChanges)

A description of changes to files in this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

message (CommitMessage!)

The commit message the be included with the commit.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateContentAttachmentInput\n

\n

Autogenerated input type of CreateContentAttachment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The body of the content attachment, which may contain markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

contentReferenceId (ID!)

The node ID of the content_reference.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the content attachment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateDeploymentInput\n

\n

Autogenerated input type of CreateDeployment.

\n
\n\n
\n \n
\n

Preview notice

\n

CreateDeploymentInput is available under the Deployments preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

autoMerge (Boolean)

Attempt to automatically merge the default branch into the requested ref, defaults to true.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

Short description of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

environment (String)

Name for the target deployment environment.

\n\n\n\n\n\n\n\n\n\n\n\n

payload (String)

JSON payload with extra information about the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

refId (ID!)

The node ID of the ref to be deployed.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredContexts ([String!])

The status contexts to verify against commit status checks. To bypass required\ncontexts, pass an empty array. Defaults to all unique contexts.

\n\n\n\n\n\n\n\n\n\n\n\n

task (String)

Specifies a task to execute.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateDeploymentStatusInput\n

\n

Autogenerated input type of CreateDeploymentStatus.

\n
\n\n
\n \n
\n

Preview notice

\n

CreateDeploymentStatusInput is available under the Deployments preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

autoInactive (Boolean)

Adds a new inactive status to all non-transient, non-production environment\ndeployments with the same repository and environment name as the created\nstatus's deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

deploymentId (ID!)

The node ID of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A short description of the status. Maximum length of 140 characters.

\n\n\n\n\n\n\n\n\n\n\n\n

environment (String)

If provided, updates the environment of the deploy. Otherwise, does not modify the environment.

\n\n\n\n\n\n\n\n\n\n\n\n

environmentUrl (String)

Sets the URL for accessing your environment.

\n\n\n\n\n\n\n\n\n\n\n\n

logUrl (String)

The log URL to associate with this status. This URL should contain\noutput to keep the user updated while the task is running or serve as\nhistorical information for what happened in the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

state (DeploymentStatusState!)

The state of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateDiscussionInput\n

\n

Autogenerated input type of CreateDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The body of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

categoryId (ID!)

The id of the discussion category to associate with this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The id of the repository on which to create the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateEnterpriseOrganizationInput\n

\n

Autogenerated input type of CreateEnterpriseOrganization.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

adminLogins ([String!]!)

The logins for the administrators of the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n

billingEmail (String!)

The email used for sending billing receipts.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise owning the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n

profileName (String!)

The profile name of the new organization.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateEnvironmentInput\n

\n

Autogenerated input type of CreateEnvironment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the environment.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateIpAllowListEntryInput\n

\n

Autogenerated input type of CreateIpAllowListEntry.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowListValue (String!)

An IP address or range of addresses in CIDR notation.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

isActive (Boolean!)

Whether the IP allow list entry is active when an IP allow list is enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

An optional name for the IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner for which to create the new IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateIssueInput\n

\n

Autogenerated input type of CreateIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assigneeIds ([ID!])

The Node ID for the user assignee for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The body for the issue description.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueTemplate (String)

The name of an issue template in the repository, assigns labels and assignees from the template to the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!])

An array of Node IDs of labels for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneId (ID)

The Node ID of the milestone for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

projectIds ([ID!])

An array of Node IDs for projects associated with this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title for the issue.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateLabelInput\n

\n

Autogenerated input type of CreateLabel.

\n
\n\n
\n \n
\n

Preview notice

\n

CreateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

color (String!)

A 6 character hex code, without the leading #, identifying the color of the label.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A brief description of the label, such as its purpose.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the label.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateProjectInput\n

\n

Autogenerated input type of CreateProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of project.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The owner ID to create the project under.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryIds ([ID!])

A list of repository IDs to create as linked repositories for the project.

\n\n\n\n\n\n\n\n\n\n\n\n

template (ProjectTemplate)

The name of the GitHub-provided template.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreatePullRequestInput\n

\n

Autogenerated input type of CreatePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

baseRefName (String!)

The name of the branch you want your changes pulled into. This should be an existing branch\non the current repository. You cannot update the base branch on a pull request to point\nto another repository.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The contents of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

draft (Boolean)

Indicates whether this pull request should be a draft.

\n\n\n\n\n\n\n\n\n\n\n\n

headRefName (String!)

The name of the branch where your changes are implemented. For cross-repository pull requests\nin the same network, namespace head_ref_name with a user like this: username:branch.

\n\n\n\n\n\n\n\n\n\n\n\n

maintainerCanModify (Boolean)

Indicates whether maintainers can modify the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateRefInput\n

\n

Autogenerated input type of CreateRef.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The fully qualified name of the new Ref (ie: refs/heads/my_new_branch).

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The GitObjectID that the new Ref shall target. Must point to a commit.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the Repository to create the Ref in.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateRepositoryInput\n

\n

Autogenerated input type of CreateRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A short description of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

hasIssuesEnabled (Boolean)

Indicates if the repository should have the issues feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasWikiEnabled (Boolean)

Indicates if the repository should have the wiki feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

homepageUrl (URI)

The URL for a web page about this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID)

The ID of the owner for the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

teamId (ID)

When an organization is specified as the owner, this ID identifies the team\nthat should be granted access to the new repository.

\n\n\n\n\n\n\n\n\n\n\n\n

template (Boolean)

Whether this repository should be marked as a template such that anyone who\ncan access it can create new repositories with the same files and directory structure.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepositoryVisibility!)

Indicates the repository's visibility level.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateTeamDiscussionCommentInput\n

\n

Autogenerated input type of CreateTeamDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The content of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

discussionId (ID!)

The ID of the discussion to which the comment belongs.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n CreateTeamDiscussionInput\n

\n

Autogenerated input type of CreateTeamDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The content of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

private (Boolean)

If true, restricts the visibility of this discussion to team members and\norganization admins. If false or not specified, allows any organization member\nto view this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

teamId (ID!)

The ID of the team to which the discussion belongs.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteBranchProtectionRuleInput\n

\n

Autogenerated input type of DeleteBranchProtectionRule.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

branchProtectionRuleId (ID!)

The global relay id of the branch protection rule to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteDeploymentInput\n

\n

Autogenerated input type of DeleteDeployment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the deployment to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteDiscussionCommentInput\n

\n

Autogenerated input type of DeleteDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node id of the discussion comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteDiscussionInput\n

\n

Autogenerated input type of DeleteDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The id of the discussion to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteEnvironmentInput\n

\n

Autogenerated input type of DeleteEnvironment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the environment to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteIpAllowListEntryInput\n

\n

Autogenerated input type of DeleteIpAllowListEntry.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEntryId (ID!)

The ID of the IP allow list entry to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteIssueCommentInput\n

\n

Autogenerated input type of DeleteIssueComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteIssueInput\n

\n

Autogenerated input type of DeleteIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The ID of the issue to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteLabelInput\n

\n

Autogenerated input type of DeleteLabel.

\n
\n\n
\n \n
\n

Preview notice

\n

DeleteLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the label to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteProjectCardInput\n

\n

Autogenerated input type of DeleteProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cardId (ID!)

The id of the card to delete.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteProjectColumnInput\n

\n

Autogenerated input type of DeleteProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnId (ID!)

The id of the column to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteProjectInput\n

\n

Autogenerated input type of DeleteProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The Project ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeletePullRequestReviewCommentInput\n

\n

Autogenerated input type of DeletePullRequestReviewComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeletePullRequestReviewInput\n

\n

Autogenerated input type of DeletePullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID!)

The Node ID of the pull request review to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteRefInput\n

\n

Autogenerated input type of DeleteRef.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

refId (ID!)

The Node ID of the Ref to be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteTeamDiscussionCommentInput\n

\n

Autogenerated input type of DeleteTeamDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeleteTeamDiscussionInput\n

\n

Autogenerated input type of DeleteTeamDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The discussion ID to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DeploymentOrder\n

\n

Ordering options for deployment connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (DeploymentOrderField!)

The field to order deployments by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DisablePullRequestAutoMergeInput\n

\n

Autogenerated input type of DisablePullRequestAutoMerge.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to disable auto merge on.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DiscussionOrder\n

\n

Ways in which lists of discussions can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order discussions by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (DiscussionOrderField!)

The field by which to order discussions.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DismissPullRequestReviewInput\n

\n

Autogenerated input type of DismissPullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String!)

The contents of the pull request review dismissal message.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID!)

The Node ID of the pull request review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DraftPullRequestReviewComment\n

\n

Specifies a review comment to be left with a Pull Request Review.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

Body of the comment to leave.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

Path to the file being commented on.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int!)

Position in the file to leave a comment on.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n DraftPullRequestReviewThread\n

\n

Specifies a review comment thread to be left with a Pull Request Review.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

Body of the comment to leave.

\n\n\n\n\n\n\n\n\n\n\n\n

line (Int!)

The line of the blob to which the thread refers. The end of the line range for multi-line comments.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

Path to the file being commented on.

\n\n\n\n\n\n\n\n\n\n\n\n

side (DiffSide)

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.

\n\n\n\n\n\n\n\n\n\n\n\n

startLine (Int)

The first line of the range to which the comment refers.

\n\n\n\n\n\n\n\n\n\n\n\n

startSide (DiffSide)

The side of the diff on which the start line resides.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnablePullRequestAutoMergeInput\n

\n

Autogenerated input type of EnablePullRequestAutoMerge.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

authorEmail (String)

The email address to associate with this merge.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitBody (String)

Commit body to use for the commit when the PR is mergable; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

commitHeadline (String)

Commit headline to use for the commit when the PR is mergable; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeMethod (PullRequestMergeMethod)

The merge method to use. If omitted, defaults to 'MERGE'.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to enable auto-merge on.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorInvitationOrder\n

\n

Ordering options for enterprise administrator invitation connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseAdministratorInvitationOrderField!)

The field to order enterprise administrator invitations by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseMemberOrder\n

\n

Ordering options for enterprise member connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseMemberOrderField!)

The field to order enterprise members by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountEmailOrder\n

\n

Ordering options for Enterprise Server user account email connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseServerUserAccountEmailOrderField!)

The field to order emails by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountOrder\n

\n

Ordering options for Enterprise Server user account connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseServerUserAccountOrderField!)

The field to order user accounts by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountsUploadOrder\n

\n

Ordering options for Enterprise Server user accounts upload connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (EnterpriseServerUserAccountsUploadOrderField!)

The field to order user accounts uploads by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n FileAddition\n

\n

A command to add a file at the given path with the given contents as part of a\ncommit. Any existing file at that that path will be replaced.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contents (Base64String!)

The base64 encoded contents of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path in the repository where the file will be located.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n FileChanges\n

\n

A description of a set of changes to a file tree to be made as part of\na git commit, modeled as zero or more file additions and zero or more\nfile deletions.

\n

Both fields are optional; omitting both will produce a commit with no\nfile changes.

\n

deletions and additions describe changes to files identified\nby their path in the git tree using unix-style path separators, i.e.\n/. The root of a git tree is an empty string, so paths are not\nslash-prefixed.

\n

path values must be unique across all additions and deletions\nprovided. Any duplication will result in a validation error.

\n

Encoding

\n

File contents must be provided in full for each FileAddition.

\n

The contents of a FileAddition must be encoded using RFC 4648\ncompliant base64, i.e. correct padding is required and no characters\noutside the standard alphabet may be used. Invalid base64\nencoding will be rejected with a validation error.

\n

The encoded contents may be binary.

\n

For text files, no assumptions are made about the character encoding of\nthe file contents (after base64 decoding). No charset transcoding or\nline-ending normalization will be performed; it is the client's\nresponsibility to manage the character encoding of files they provide.\nHowever, for maximum compatibility we recommend using UTF-8 encoding\nand ensuring that all files in a repository use a consistent\nline-ending convention (\\n or \\r\\n), and that all files end\nwith a newline.

\n

Modeling file changes

\n

Each of the the five types of conceptual changes that can be made in a\ngit commit can be described using the FileChanges type as follows:

\n
    \n
  1. \n

    New file addition: create file hello world\\n at path docs/README.txt:

    \n

    {\n"additions" [\n{\n"path": "docs/README.txt",\n"contents": base64encode("hello world\\n")\n}\n]\n}

    \n
    2. \n
  2. \n

    Existing file modification: change existing docs/README.txt to have new\ncontent new content here\\n:

    \n
    {\n  "additions" [\n    {\n      "path": "docs/README.txt",\n      "contents": base64encode("new content here\\n")\n    }\n  ]\n}\n
    \n
    3. \n
  3. \n

    Existing file deletion: remove existing file docs/README.txt.\nNote that the path is required to exist -- specifying a\npath that does not exist on the given branch will abort the\ncommit and return an error.

    \n
    {\n  "deletions" [\n    {\n      "path": "docs/README.txt"\n    }\n  ]\n}\n
    \n
    4. \n
  4. \n

    File rename with no changes: rename docs/README.txt with\nprevious content hello world\\n to the same content at\nnewdocs/README.txt:

    \n
    {\n  "deletions" [\n    {\n      "path": "docs/README.txt",\n    }\n  ],\n  "additions" [\n    {\n      "path": "newdocs/README.txt",\n      "contents": base64encode("hello world\\n")\n    }\n  ]\n}\n
    \n
    5. \n
  5. \n

    File rename with changes: rename docs/README.txt with\nprevious content hello world\\n to a file at path\nnewdocs/README.txt with content new contents\\n:

    \n
    {\n  "deletions" [\n    {\n      "path": "docs/README.txt",\n    }\n  ],\n  "additions" [\n    {\n      "path": "newdocs/README.txt",\n      "contents": base64encode("new contents\\n")\n    }\n  ]\n}.\n
    \n
    6. \n
\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

additions ([FileAddition!])

File to add or change.

\n\n\n\n\n\n\n\n\n\n\n\n

deletions ([FileDeletion!])

Files to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n FileDeletion\n

\n

A command to delete the file at the given path as part of a commit.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

path (String!)

The path to delete.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n FollowUserInput\n

\n

Autogenerated input type of FollowUser.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

userId (ID!)

ID of the user to follow.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n GistOrder\n

\n

Ordering options for gist connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (GistOrderField!)

The field to order repositories by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ImportProjectInput\n

\n

Autogenerated input type of ImportProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of Project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnImports ([ProjectColumnImport!]!)

A list of columns containing issues and pull requests.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of Project.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerName (String!)

The name of the Organization or User to create the Project under.

\n\n\n\n\n\n\n\n\n\n\n\n

public (Boolean)

Whether the Project is public or not.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IpAllowListEntryOrder\n

\n

Ordering options for IP allow list entry connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (IpAllowListEntryOrderField!)

The field to order IP allow list entries by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IssueCommentOrder\n

\n

Ways in which lists of issue comments can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order issue comments by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (IssueCommentOrderField!)

The field in which to order issue comments by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IssueFilters\n

\n

Ways in which to filter lists of issues.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assignee (String)

List issues assigned to given name. Pass in null for issues with no assigned\nuser, and * for issues assigned to any user.

\n\n\n\n\n\n\n\n\n\n\n\n

createdBy (String)

List issues created by given name.

\n\n\n\n\n\n\n\n\n\n\n\n

labels ([String!])

List issues where the list of label names exist on the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

mentioned (String)

List issues where the given name is mentioned in the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

milestone (String)

List issues by given milestone argument. If an string representation of an\ninteger is passed, it should refer to a milestone by its number field. Pass in\nnull for issues with no milestone, and * for issues that are assigned to any milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

since (DateTime)

List issues that have been updated at or after the given date.

\n\n\n\n\n\n\n\n\n\n\n\n

states ([IssueState!])

List issues filtered by the list of states given.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscribed (Boolean)

List issues subscribed to by viewer.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n IssueOrder\n

\n

Ways in which lists of issues can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order issues by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (IssueOrderField!)

The field in which to order issues by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LabelOrder\n

\n

Ways in which lists of labels can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order labels by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (LabelOrderField!)

The field in which to order labels by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LanguageOrder\n

\n

Ordering options for language connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (LanguageOrderField!)

The field to order languages by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LinkRepositoryToProjectInput\n

\n

Autogenerated input type of LinkRepositoryToProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The ID of the Project to link to a Repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the Repository to link to a Project.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n LockLockableInput\n

\n

Autogenerated input type of LockLockable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

lockReason (LockReason)

A reason for why the item will be locked.

\n\n\n\n\n\n\n\n\n\n\n\n

lockableId (ID!)

ID of the item to be locked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MarkDiscussionCommentAsAnswerInput\n

\n

Autogenerated input type of MarkDiscussionCommentAsAnswer.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the discussion comment to mark as an answer.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MarkFileAsViewedInput\n

\n

Autogenerated input type of MarkFileAsViewed.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path of the file to mark as viewed.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MarkPullRequestReadyForReviewInput\n

\n

Autogenerated input type of MarkPullRequestReadyForReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be marked as ready for review.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MergeBranchInput\n

\n

Autogenerated input type of MergeBranch.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

base (String!)

The name of the base branch that the provided head will be merged into.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitMessage (String)

Message to use for the merge commit. If omitted, a default will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

head (String!)

The head to merge into the base branch. This can be a branch name or a commit GitObjectID.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the Repository containing the base branch that will be modified.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MergePullRequestInput\n

\n

Autogenerated input type of MergePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

authorEmail (String)

The email address to associate with this merge.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commitBody (String)

Commit body to use for the merge commit; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

commitHeadline (String)

Commit headline to use for the merge commit; if omitted, a default message will be used.

\n\n\n\n\n\n\n\n\n\n\n\n

expectedHeadOid (GitObjectID)

OID that the pull request head ref must match to allow merge; if omitted, no check is performed.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeMethod (PullRequestMergeMethod)

The merge method to use. If omitted, defaults to 'MERGE'.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be merged.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MilestoneOrder\n

\n

Ordering options for milestone connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (MilestoneOrderField!)

The field to order milestones by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MinimizeCommentInput\n

\n

Autogenerated input type of MinimizeComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

classifier (ReportedContentClassifiers!)

The classification of comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MoveProjectCardInput\n

\n

Autogenerated input type of MoveProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

afterCardId (ID)

Place the new card after the card with this id. Pass null to place it at the top.

\n\n\n\n\n\n\n\n\n\n\n\n

cardId (ID!)

The id of the card to move.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnId (ID!)

The id of the column to move it into.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n MoveProjectColumnInput\n

\n

Autogenerated input type of MoveProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

afterColumnId (ID)

Place the new column after the column with this id. Pass null to place it at the front.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

columnId (ID!)

The id of the column to move.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n OrganizationOrder\n

\n

Ordering options for organization connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (OrganizationOrderField!)

The field to order organizations by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PinIssueInput\n

\n

Autogenerated input type of PinIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The ID of the issue to be pinned.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ProjectCardImport\n

\n

An issue or PR and its owning repository to be used in a project card.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

number (Int!)

The issue or pull request number.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (String!)

Repository name with owner (owner/repository).

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ProjectColumnImport\n

\n

A project column and a list of its issues and PRs.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

columnName (String!)

The name of the column.

\n\n\n\n\n\n\n\n\n\n\n\n

issues ([ProjectCardImport!])

A list of issues and pull requests in the column.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int!)

The position of the column, starting from 0.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ProjectOrder\n

\n

Ways in which lists of projects can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order projects by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (ProjectOrderField!)

The field in which to order projects by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n PullRequestOrder\n

\n

Ways in which lists of issues can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order pull requests by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (PullRequestOrderField!)

The field in which to order pull requests by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReactionOrder\n

\n

Ways in which lists of reactions can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order reactions by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (ReactionOrderField!)

The field in which to order reactions by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RefOrder\n

\n

Ways in which lists of git refs can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order refs by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (RefOrderField!)

The field in which to order refs by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RefUpdate\n

\n

A ref update.

\n
\n\n
\n \n
\n

Preview notice

\n

RefUpdate is available under the Update refs preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

afterOid (GitObjectID!)

The value this ref should be updated to.

\n\n\n\n\n\n\n\n\n\n\n\n

beforeOid (GitObjectID)

The value this ref needs to point to before the update.

\n\n\n\n\n\n\n\n\n\n\n\n

force (Boolean)

Force a non fast-forward update.

\n\n\n\n\n\n\n\n\n\n\n\n

name (GitRefname!)

The fully qualified name of the ref to be update. For example refs/heads/branch-name.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RejectDeploymentsInput\n

\n

Autogenerated input type of RejectDeployments.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

comment (String)

Optional comment for rejecting deployments.

\n\n\n\n\n\n\n\n\n\n\n\n

environmentIds ([ID!]!)

The ids of environments to reject deployments.

\n\n\n\n\n\n\n\n\n\n\n\n

workflowRunId (ID!)

The node ID of the workflow run containing the pending deployments.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReleaseOrder\n

\n

Ways in which lists of releases can be ordered upon return.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order releases by the specified field.

\n\n\n\n\n\n\n\n\n\n\n\n

field (ReleaseOrderField!)

The field in which to order releases by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveAssigneesFromAssignableInput\n

\n

Autogenerated input type of RemoveAssigneesFromAssignable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assignableId (ID!)

The id of the assignable object to remove assignees from.

\n\n\n\n\n\n\n\n\n\n\n\n

assigneeIds ([ID!]!)

The id of users to remove as assignees.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveEnterpriseAdminInput\n

\n

Autogenerated input type of RemoveEnterpriseAdmin.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The Enterprise ID from which to remove the administrator.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of the user to remove as an administrator.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveLabelsFromLabelableInput\n

\n

Autogenerated input type of RemoveLabelsFromLabelable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!]!)

The ids of labels to remove.

\n\n\n\n\n\n\n\n\n\n\n\n

labelableId (ID!)

The id of the Labelable to remove labels from.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveOutsideCollaboratorInput\n

\n

Autogenerated input type of RemoveOutsideCollaborator.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationId (ID!)

The ID of the organization to remove the outside collaborator from.

\n\n\n\n\n\n\n\n\n\n\n\n

userId (ID!)

The ID of the outside collaborator to remove.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveReactionInput\n

\n

Autogenerated input type of RemoveReaction.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

content (ReactionContent!)

The name of the emoji reaction to remove.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveStarInput\n

\n

Autogenerated input type of RemoveStar.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

starrableId (ID!)

The Starrable ID to unstar.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RemoveUpvoteInput\n

\n

Autogenerated input type of RemoveUpvote.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the discussion or comment to remove upvote.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReopenIssueInput\n

\n

Autogenerated input type of ReopenIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

ID of the issue to be opened.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ReopenPullRequestInput\n

\n

Autogenerated input type of ReopenPullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

ID of the pull request to be reopened.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RepositoryInvitationOrder\n

\n

Ordering options for repository invitation connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (RepositoryInvitationOrderField!)

The field to order repository invitations by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RepositoryOrder\n

\n

Ordering options for repository connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (RepositoryOrderField!)

The field to order repositories by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RequestReviewsInput\n

\n

Autogenerated input type of RequestReviews.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

teamIds ([ID!])

The Node IDs of the team to request.

\n\n\n\n\n\n\n\n\n\n\n\n

union (Boolean)

Add users to the set rather than replace.

\n\n\n\n\n\n\n\n\n\n\n\n

userIds ([ID!])

The Node IDs of the user to request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n RerequestCheckSuiteInput\n

\n

Autogenerated input type of RerequestCheckSuite.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

checkSuiteId (ID!)

The Node ID of the check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n ResolveReviewThreadInput\n

\n

Autogenerated input type of ResolveReviewThread.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

threadId (ID!)

The ID of the thread to resolve.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SavedReplyOrder\n

\n

Ordering options for saved reply connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (SavedReplyOrderField!)

The field to order saved replies by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n StarOrder\n

\n

Ways in which star connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (StarOrderField!)

The field in which to order nodes by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n SubmitPullRequestReviewInput\n

\n

Autogenerated input type of SubmitPullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The text field to set on the Pull Request Review.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

event (PullRequestReviewEvent!)

The event to send to the Pull Request Review.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID)

The Pull Request ID to submit any pending reviews.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID)

The Pull Request Review ID to submit.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamDiscussionCommentOrder\n

\n

Ways in which team discussion comment connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamDiscussionCommentOrderField!)

The field by which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamDiscussionOrder\n

\n

Ways in which team discussion connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamDiscussionOrderField!)

The field by which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamMemberOrder\n

\n

Ordering options for team member connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamMemberOrderField!)

The field to order team members by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamOrder\n

\n

Ways in which team connections can be ordered.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The direction in which to order nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamOrderField!)

The field in which to order nodes by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TeamRepositoryOrder\n

\n

Ordering options for team repository connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (TeamRepositoryOrderField!)

The field to order repositories by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n TransferIssueInput\n

\n

Autogenerated input type of TransferIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The Node ID of the issue to be transferred.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository the issue should be transferred to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnarchiveRepositoryInput\n

\n

Autogenerated input type of UnarchiveRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to unarchive.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnfollowUserInput\n

\n

Autogenerated input type of UnfollowUser.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

userId (ID!)

ID of the user to unfollow.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnlinkRepositoryFromProjectInput\n

\n

Autogenerated input type of UnlinkRepositoryFromProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The ID of the Project linked to the Repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the Repository linked to the Project.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnlockLockableInput\n

\n

Autogenerated input type of UnlockLockable.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

lockableId (ID!)

ID of the item to be unlocked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnmarkDiscussionCommentAsAnswerInput\n

\n

Autogenerated input type of UnmarkDiscussionCommentAsAnswer.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the discussion comment to unmark as an answer.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnmarkFileAsViewedInput\n

\n

Autogenerated input type of UnmarkFileAsViewed.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path of the file to mark as unviewed.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnmarkIssueAsDuplicateInput\n

\n

Autogenerated input type of UnmarkIssueAsDuplicate.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

canonicalId (ID!)

ID of the issue or pull request currently considered canonical/authoritative/original.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

duplicateId (ID!)

ID of the issue or pull request currently marked as a duplicate.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnminimizeCommentInput\n

\n

Autogenerated input type of UnminimizeComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

subjectId (ID!)

The Node ID of the subject to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnpinIssueInput\n

\n

Autogenerated input type of UnpinIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

issueId (ID!)

The ID of the issue to be unpinned.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UnresolveReviewThreadInput\n

\n

Autogenerated input type of UnresolveReviewThread.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

threadId (ID!)

The ID of the thread to unresolve.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateBranchProtectionRuleInput\n

\n

Autogenerated input type of UpdateBranchProtectionRule.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowsDeletions (Boolean)

Can this branch be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

allowsForcePushes (Boolean)

Are force pushes allowed on this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

branchProtectionRuleId (ID!)

The global relay id of the branch protection rule to be updated.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissesStaleReviews (Boolean)

Will new commits pushed to matching branches dismiss pull request review approvals.

\n\n\n\n\n\n\n\n\n\n\n\n

isAdminEnforced (Boolean)

Can admins overwrite branch protection.

\n\n\n\n\n\n\n\n\n\n\n\n

pattern (String)

The glob-like pattern used to determine matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

pushActorIds ([ID!])

A list of User, Team or App IDs allowed to push to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredStatusCheckContexts ([String!])

List of required status check contexts that must pass for commits to be accepted to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresApprovingReviews (Boolean)

Are approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCodeOwnerReviews (Boolean)

Are reviews from code owners required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCommitSignatures (Boolean)

Are commits required to be signed.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresConversationResolution (Boolean)

Are conversations required to be resolved before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresLinearHistory (Boolean)

Are merge commits prohibited from being pushed to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStatusChecks (Boolean)

Are status checks required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStrictStatusChecks (Boolean)

Are branches required to be up to date before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsPushes (Boolean)

Is pushing to matching branches restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsReviewDismissals (Boolean)

Is dismissal of pull request reviews restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDismissalActorIds ([ID!])

A list of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateCheckRunInput\n

\n

Autogenerated input type of UpdateCheckRun.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actions ([CheckRunAction!])

Possible further actions the integrator can perform, which a user may trigger.

\n\n\n\n\n\n\n\n\n\n\n\n

checkRunId (ID!)

The node of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

completedAt (DateTime)

The time that the check run finished.

\n\n\n\n\n\n\n\n\n\n\n\n

conclusion (CheckConclusionState)

The final conclusion of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

detailsUrl (URI)

The URL of the integrator's site that has the full details of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

externalId (String)

A reference for the run on the integrator's system.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of the check.

\n\n\n\n\n\n\n\n\n\n\n\n

output (CheckRunOutput)

Descriptive details about the run.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

startedAt (DateTime)

The time that the check run began.

\n\n\n\n\n\n\n\n\n\n\n\n

status (RequestableCheckStatusState)

The current status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateCheckSuitePreferencesInput\n

\n

Autogenerated input type of UpdateCheckSuitePreferences.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

autoTriggerPreferences ([CheckSuiteAutoTriggerPreference!]!)

The check suite preferences to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateDiscussionCommentInput\n

\n

Autogenerated input type of UpdateDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The new contents of the comment body.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

commentId (ID!)

The Node ID of the discussion comment to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateDiscussionInput\n

\n

Autogenerated input type of UpdateDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The new contents of the discussion body.

\n\n\n\n\n\n\n\n\n\n\n\n

categoryId (ID)

The Node ID of a discussion category within the same repository to change this discussion to.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

discussionId (ID!)

The Node ID of the discussion to update.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The new discussion title.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseAllowPrivateRepositoryForkingSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the allow private repository forking setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the allow private repository forking setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseDefaultRepositoryPermissionSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseDefaultRepositoryPermissionSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the base repository permission setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseDefaultRepositoryPermissionSettingValue!)

The value for the base repository permission setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanChangeRepositoryVisibilitySetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can change repository visibility setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can change repository visibility setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanCreateRepositoriesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanCreateRepositoriesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can create repositories setting.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreateInternalRepositories (Boolean)

Allow members to create internal repositories. Defaults to current value.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreatePrivateRepositories (Boolean)

Allow members to create private repositories. Defaults to current value.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreatePublicRepositories (Boolean)

Allow members to create public repositories. Defaults to current value.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreateRepositoriesPolicyEnabled (Boolean)

When false, allow member organizations to set their own repository creation member privileges.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseMembersCanCreateRepositoriesSettingValue)

Value for the members can create repositories setting on the enterprise. This\nor the granular public/private/internal allowed fields (but not both) must be provided.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanDeleteIssuesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanDeleteIssuesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can delete issues setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can delete issues setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanDeleteRepositoriesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can delete repositories setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can delete repositories setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanInviteCollaboratorsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can invite collaborators setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can invite collaborators setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanMakePurchasesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanMakePurchasesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can make purchases setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseMembersCanMakePurchasesSettingValue!)

The value for the members can make purchases setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanUpdateProtectedBranchesSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can update protected branches setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can update protected branches setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseMembersCanViewDependencyInsightsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the members can view dependency insights setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the members can view dependency insights setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseOrganizationProjectsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseOrganizationProjectsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the organization projects setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the organization projects setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseProfileInput\n

\n

Autogenerated input type of UpdateEnterpriseProfile.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The Enterprise ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n

location (String)

The location of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

websiteUrl (String)

The URL of the enterprise's website.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseRepositoryProjectsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseRepositoryProjectsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the repository projects setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the repository projects setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseTeamDiscussionsSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseTeamDiscussionsSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the team discussions setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledDisabledSettingValue!)

The value for the team discussions setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput\n

\n

Autogenerated input type of UpdateEnterpriseTwoFactorAuthenticationRequiredSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseId (ID!)

The ID of the enterprise on which to set the two factor authentication required setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (EnterpriseEnabledSettingValue!)

The value for the two factor authentication required setting on the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateEnvironmentInput\n

\n

Autogenerated input type of UpdateEnvironment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

environmentId (ID!)

The node ID of the environment.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewers ([ID!])

The ids of users or teams that can approve deployments to this environment.

\n\n\n\n\n\n\n\n\n\n\n\n

waitTimer (Int)

The wait timer in minutes.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIpAllowListEnabledSettingInput\n

\n

Autogenerated input type of UpdateIpAllowListEnabledSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner on which to set the IP allow list enabled setting.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (IpAllowListEnabledSettingValue!)

The value for the IP allow list enabled setting.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIpAllowListEntryInput\n

\n

Autogenerated input type of UpdateIpAllowListEntry.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowListValue (String!)

An IP address or range of addresses in CIDR notation.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEntryId (ID!)

The ID of the IP allow list entry to update.

\n\n\n\n\n\n\n\n\n\n\n\n

isActive (Boolean!)

Whether the IP allow list entry is active when an IP allow list is enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

An optional name for the IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIpAllowListForInstalledAppsEnabledSettingInput\n

\n

Autogenerated input type of UpdateIpAllowListForInstalledAppsEnabledSetting.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

ownerId (ID!)

The ID of the owner.

\n\n\n\n\n\n\n\n\n\n\n\n

settingValue (IpAllowListForInstalledAppsEnabledSettingValue!)

The value for the IP allow list configuration for installed GitHub Apps setting.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIssueCommentInput\n

\n

Autogenerated input type of UpdateIssueComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The updated text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the IssueComment to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateIssueInput\n

\n

Autogenerated input type of UpdateIssue.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assigneeIds ([ID!])

An array of Node IDs of users for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The body for the issue description.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the Issue to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!])

An array of Node IDs of labels for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneId (ID)

The Node ID of the milestone for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

projectIds ([ID!])

An array of Node IDs for projects associated with this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

state (IssueState)

The desired issue state.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title for the issue.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateLabelInput\n

\n

Autogenerated input type of UpdateLabel.

\n
\n\n
\n \n
\n

Preview notice

\n

UpdateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

color (String)

A 6 character hex code, without the leading #, identifying the updated color of the label.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A brief description of the label, such as its purpose.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the label to be updated.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The updated name of the label.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateProjectCardInput\n

\n

Autogenerated input type of UpdateProjectCard.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

isArchived (Boolean)

Whether or not the ProjectCard should be archived.

\n\n\n\n\n\n\n\n\n\n\n\n

note (String)

The note of ProjectCard.

\n\n\n\n\n\n\n\n\n\n\n\n

projectCardId (ID!)

The ProjectCard ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateProjectColumnInput\n

\n

Autogenerated input type of UpdateProjectColumn.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of project column.

\n\n\n\n\n\n\n\n\n\n\n\n

projectColumnId (ID!)

The ProjectColumn ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateProjectInput\n

\n

Autogenerated input type of UpdateProject.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The description of project.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of project.

\n\n\n\n\n\n\n\n\n\n\n\n

projectId (ID!)

The Project ID to update.

\n\n\n\n\n\n\n\n\n\n\n\n

public (Boolean)

Whether the project is public or not.

\n\n\n\n\n\n\n\n\n\n\n\n

state (ProjectState)

Whether the project is open or closed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdatePullRequestInput\n

\n

Autogenerated input type of UpdatePullRequest.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assigneeIds ([ID!])

An array of Node IDs of users for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRefName (String)

The name of the branch you want your changes pulled into. This should be an existing branch\non the current repository.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The contents of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

labelIds ([ID!])

An array of Node IDs of labels for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

maintainerCanModify (Boolean)

Indicates whether maintainers can modify the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneId (ID)

The Node ID of the milestone for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

projectIds ([ID!])

An array of Node IDs for projects associated with this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestId (ID!)

The Node ID of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

state (PullRequestUpdateState)

The target state of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The title of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdatePullRequestReviewCommentInput\n

\n

Autogenerated input type of UpdatePullRequestReviewComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewCommentId (ID!)

The Node ID of the comment to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdatePullRequestReviewInput\n

\n

Autogenerated input type of UpdatePullRequestReview.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The contents of the pull request review body.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReviewId (ID!)

The Node ID of the pull request review to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateRefInput\n

\n

Autogenerated input type of UpdateRef.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

force (Boolean)

Permit updates of branch Refs that are not fast-forwards?.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The GitObjectID that the Ref shall be updated to target.

\n\n\n\n\n\n\n\n\n\n\n\n

refId (ID!)

The Node ID of the Ref to be updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateRefsInput\n

\n

Autogenerated input type of UpdateRefs.

\n
\n\n
\n \n
\n

Preview notice

\n

UpdateRefsInput is available under the Update refs preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

refUpdates ([RefUpdate!]!)

A list of ref updates.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateRepositoryInput\n

\n

Autogenerated input type of UpdateRepository.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A new description for the repository. Pass an empty string to erase the existing description.

\n\n\n\n\n\n\n\n\n\n\n\n

hasIssuesEnabled (Boolean)

Indicates if the repository should have the issues feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasProjectsEnabled (Boolean)

Indicates if the repository should have the project boards feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasWikiEnabled (Boolean)

Indicates if the repository should have the wiki feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

homepageUrl (URI)

The URL for a web page about this repository. Pass an empty string to erase the existing URL.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The new name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The ID of the repository to update.

\n\n\n\n\n\n\n\n\n\n\n\n

template (Boolean)

Whether this repository should be marked as a template such that anyone who\ncan access it can create new repositories with the same files and directory structure.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateSubscriptionInput\n

\n

Autogenerated input type of UpdateSubscription.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

state (SubscriptionState!)

The new state of the subscription.

\n\n\n\n\n\n\n\n\n\n\n\n

subscribableId (ID!)

The Node ID of the subscribable object to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTeamDiscussionCommentInput\n

\n

Autogenerated input type of UpdateTeamDiscussionComment.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The updated text of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyVersion (String)

The current version of the body content.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The ID of the comment to modify.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTeamDiscussionInput\n

\n

Autogenerated input type of UpdateTeamDiscussion.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The updated text of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyVersion (String)

The current version of the body content. If provided, this update operation\nwill be rejected if the given version does not match the latest version on the server.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the discussion to modify.

\n\n\n\n\n\n\n\n\n\n\n\n

pinned (Boolean)

If provided, sets the pinned state of the updated discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The updated title of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTeamReviewAssignmentInput\n

\n

Autogenerated input type of UpdateTeamReviewAssignment.

\n
\n\n
\n \n
\n

Preview notice

\n

UpdateTeamReviewAssignmentInput is available under the Team review assignments preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

algorithm (TeamReviewAssignmentAlgorithm)

The algorithm to use for review assignment.

\n\n\n\n\n\n\n\n\n\n\n\n

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

enabled (Boolean!)

Turn on or off review assignment.

\n\n\n\n\n\n\n\n\n\n\n\n

excludedTeamMemberIds ([ID!])

An array of team member IDs to exclude.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

The Node ID of the team to update review assignments of.

\n\n\n\n\n\n\n\n\n\n\n\n

notifyTeam (Boolean)

Notify the entire team of the PR if it is delegated.

\n\n\n\n\n\n\n\n\n\n\n\n

teamMemberCount (Int)

The number of team members to assign.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UpdateTopicsInput\n

\n

Autogenerated input type of UpdateTopics.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryId (ID!)

The Node ID of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

topicNames ([String!]!)

An array of topic names.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n\n
\n
\n

\n UserStatusOrder\n

\n

Ordering options for user status connections.

\n
\n\n
\n \n\n \n\n\n

Input fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

direction (OrderDirection!)

The ordering direction.

\n\n\n\n\n\n\n\n\n\n\n\n

field (UserStatusOrderField!)

The field to order user statuses by.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n
\n
\n
\n", "miniToc": [ { "contents": "\n AddAssigneesToAssignableInput\n ", @@ -5207,16 +5197,6 @@ "headingLevel": 2, "indentationLevel": 0 }, - { - "contents": "Encoding", - "headingLevel": 2, - "indentationLevel": 0 - }, - { - "contents": "Modeling file changes", - "headingLevel": 2, - "indentationLevel": 0 - }, { "contents": "\n FileDeletion\n ", "headingLevel": 2, diff --git a/lib/graphql/static/schema-dotcom.json b/lib/graphql/static/schema-dotcom.json index c2ef9b1183..e6700408e1 100644 --- a/lib/graphql/static/schema-dotcom.json +++ b/lib/graphql/static/schema-dotcom.json @@ -2002,7 +2002,7 @@ "kind": "mutations", "id": "createcommitonbranch", "href": "/graphql/reference/mutations#createcommitonbranch", - "description": "

Appends a commit to the given branch as the authenticated user.

\n

This mutation creates a commit whose parent is the HEAD of the provided\nbranch and also updates that branch to point to the new commit.\nIt can be thought of as similar to git commit.

\n

Locating a Branch

\n

Commits are appended to a branch of type Ref.\nThis must refer to a git branch (i.e. the fully qualified path must\nbegin with refs/heads/, although including this prefix is optional.

\n

Callers may specify the branch to commit to either by its global node\nID or by passing both of repositoryNameWithOwner and refName. For\nmore details see the documentation for CommittableBranch.

\n

Describing Changes

\n

fileChanges are specified as a FilesChanges object describing\nFileAdditions and FileDeletions.

\n

Please see the documentation for FileChanges for more information on\nhow to use this argument to describe any set of file changes.

\n

Authorship

\n

Similar to the web commit interface, this mutation does not support\nspecifying the author or committer of the commit and will not add\nsupport for this in the future.

\n

A commit created by a successful execution of this mutation will be\nauthored by the owner of the credential which authenticates the API\nrequest. The committer will be identical to that of commits authored\nusing the web interface.

\n

If you need full control over author and committer information, please\nuse the Git Database REST API instead.

\n

Commit Signing

\n

Commits made using this mutation are automatically signed by GitHub if\nsupported and will be marked as verified in the user interface.

", + "description": "

Appends a commit to the given branch as the authenticated user.

\n

This mutation creates a commit whose parent is the HEAD of the provided\nbranch and also updates that branch to point to the new commit.\nIt can be thought of as similar to git commit.

\n

Locating a Branch

\n

Commits are appended to a branch of type Ref.\nThis must refer to a git branch (i.e. the fully qualified path must\nbegin with refs/heads/, although including this prefix is optional.

\n

Callers may specify the branch to commit to either by its global node\nID or by passing both of repositoryNameWithOwner and refName. For\nmore details see the documentation for CommittableBranch.

\n

Describing Changes

\n

fileChanges are specified as a FilesChanges object describing\nFileAdditions and FileDeletions.

\n

Please see the documentation for FileChanges for more information on\nhow to use this argument to describe any set of file changes.

\n

Authorship

\n

Similar to the web commit interface, this mutation does not support\nspecifying the author or committer of the commit and will not add\nsupport for this in the future.

\n

A commit created by a successful execution of this mutation will be\nauthored by the owner of the credential which authenticates the API\nrequest. The committer will be identical to that of commits authored\nusing the web interface.

\n

If you need full control over author and committer information, please\nuse the Git Database REST API instead.

\n

Commit Signing

\n

Commits made using this mutation are automatically signed by GitHub if\nsupported and will be marked as verified in the user interface.

", "inputFields": [ { "name": "input", @@ -71467,7 +71467,7 @@ "kind": "inputObjects", "id": "committablebranch", "href": "/graphql/reference/input-objects#committablebranch", - "description": "

A git ref for a commit to be appended to.

\n

The ref must be a branch, i.e. its fully qualified name must start\nwith refs/heads/ (although the input is not required to be fully\nqualified).

\n

The Ref may be specified by its global node ID or by the\nrepository nameWithOwner and branch name.

", + "description": "

A git ref for a commit to be appended to.

\n

The ref must be a branch, i.e. its fully qualified name must start\nwith refs/heads/ (although the input is not required to be fully\nqualified).

\n

The Ref may be specified by its global node ID or by the\nrepository nameWithOwner and branch name.

\n

Examples

\n

Specify a branch using a global node ID:

\n
{ \"id\": \"MDM6UmVmMTpyZWZzL2hlYWRzL21haW4=\" }\n
\n

Specify a branch using nameWithOwner and branch name:

\n
{\n  \"nameWithOwner\": \"github/graphql-client\",\n  \"branchName\": \"main\"\n}.\n
", "inputFields": [ { "name": "branchName", @@ -73956,7 +73956,7 @@ "kind": "inputObjects", "id": "filechanges", "href": "/graphql/reference/input-objects#filechanges", - "description": "

A description of a set of changes to a file tree to be made as part of\na git commit, modeled as zero or more file additions and zero or more\nfile deletions.

\n

Both fields are optional; omitting both will produce a commit with no\nfile changes.

\n

deletions and additions describe changes to files identified\nby their path in the git tree using unix-style path separators, i.e.\n/. The root of a git tree is an empty string, so paths are not\nslash-prefixed.

\n

path values must be unique across all additions and deletions\nprovided. Any duplication will result in a validation error.

\n

Encoding

\n

File contents must be provided in full for each FileAddition.

\n

The contents of a FileAddition must be encoded using RFC 4648\ncompliant base64, i.e. correct padding is required and no characters\noutside the standard alphabet may be used. Invalid base64\nencoding will be rejected with a validation error.

\n

The encoded contents may be binary.

\n

For text files, no assumptions are made about the character encoding of\nthe file contents (after base64 decoding). No charset transcoding or\nline-ending normalization will be performed; it is the client's\nresponsibility to manage the character encoding of files they provide.\nHowever, for maximum compatibility we recommend using UTF-8 encoding\nand ensuring that all files in a repository use a consistent\nline-ending convention (\\n or \\r\\n), and that all files end\nwith a newline.

\n

Modeling file changes

\n

Each of the the five types of conceptual changes that can be made in a\ngit commit can be described using the FileChanges type as follows:

\n
    \n
  1. \n

    New file addition: create file hello world\\n at path docs/README.txt:

    \n

    {\n\"additions\" [\n{\n\"path\": \"docs/README.txt\",\n\"contents\": base64encode(\"hello world\\n\")\n}\n]\n}

    \n
    2. \n
  2. \n

    Existing file modification: change existing docs/README.txt to have new\ncontent new content here\\n:

    \n
    {\n  \"additions\" [\n    {\n      \"path\": \"docs/README.txt\",\n      \"contents\": base64encode(\"new content here\\n\")\n    }\n  ]\n}\n
    \n
    3. \n
  3. \n

    Existing file deletion: remove existing file docs/README.txt.\nNote that the path is required to exist -- specifying a\npath that does not exist on the given branch will abort the\ncommit and return an error.

    \n
    {\n  \"deletions\" [\n    {\n      \"path\": \"docs/README.txt\"\n    }\n  ]\n}\n
    \n
    4. \n
  4. \n

    File rename with no changes: rename docs/README.txt with\nprevious content hello world\\n to the same content at\nnewdocs/README.txt:

    \n
    {\n  \"deletions\" [\n    {\n      \"path\": \"docs/README.txt\",\n    }\n  ],\n  \"additions\" [\n    {\n      \"path\": \"newdocs/README.txt\",\n      \"contents\": base64encode(\"hello world\\n\")\n    }\n  ]\n}\n
    \n
    5. \n
  5. \n

    File rename with changes: rename docs/README.txt with\nprevious content hello world\\n to a file at path\nnewdocs/README.txt with content new contents\\n:

    \n
    {\n  \"deletions\" [\n    {\n      \"path\": \"docs/README.txt\",\n    }\n  ],\n  \"additions\" [\n    {\n      \"path\": \"newdocs/README.txt\",\n      \"contents\": base64encode(\"new contents\\n\")\n    }\n  ]\n}.\n
    \n
    6. \n
", + "description": "

A description of a set of changes to a file tree to be made as part of\na git commit, modeled as zero or more file additions and zero or more\nfile deletions.

\n

Both fields are optional; omitting both will produce a commit with no\nfile changes.

\n

deletions and additions describe changes to files identified\nby their path in the git tree using unix-style path separators, i.e.\n/. The root of a git tree is an empty string, so paths are not\nslash-prefixed.

\n

path values must be unique across all additions and deletions\nprovided. Any duplication will result in a validation error.

\n

Encoding

\n

File contents must be provided in full for each FileAddition.

\n

The contents of a FileAddition must be encoded using RFC 4648\ncompliant base64, i.e. correct padding is required and no characters\noutside the standard alphabet may be used. Invalid base64\nencoding will be rejected with a validation error.

\n

The encoded contents may be binary.

\n

For text files, no assumptions are made about the character encoding of\nthe file contents (after base64 decoding). No charset transcoding or\nline-ending normalization will be performed; it is the client's\nresponsibility to manage the character encoding of files they provide.\nHowever, for maximum compatibility we recommend using UTF-8 encoding\nand ensuring that all files in a repository use a consistent\nline-ending convention (\\n or \\r\\n), and that all files end\nwith a newline.

\n

Modeling file changes

\n

Each of the the five types of conceptual changes that can be made in a\ngit commit can be described using the FileChanges type as follows:

\n
    \n
  1. \n

    New file addition: create file hello world\\n at path docs/README.txt:

    \n

    {\n\"additions\" [\n{\n\"path\": \"docs/README.txt\",\n\"contents\": base64encode(\"hello world\\n\")\n}\n]\n}

    \n
    2. \n
  2. \n

    Existing file modification: change existing docs/README.txt to have new\ncontent new content here\\n:

    \n
    {\n  \"additions\" [\n    {\n      \"path\": \"docs/README.txt\",\n      \"contents\": base64encode(\"new content here\\n\")\n    }\n  ]\n}\n
    \n
    3. \n
  3. \n

    Existing file deletion: remove existing file docs/README.txt.\nNote that the path is required to exist -- specifying a\npath that does not exist on the given branch will abort the\ncommit and return an error.

    \n
    {\n  \"deletions\" [\n    {\n      \"path\": \"docs/README.txt\"\n    }\n  ]\n}\n
    \n
    4. \n
  4. \n

    File rename with no changes: rename docs/README.txt with\nprevious content hello world\\n to the same content at\nnewdocs/README.txt:

    \n
    {\n  \"deletions\" [\n    {\n      \"path\": \"docs/README.txt\",\n    }\n  ],\n  \"additions\" [\n    {\n      \"path\": \"newdocs/README.txt\",\n      \"contents\": base64encode(\"hello world\\n\")\n    }\n  ]\n}\n
    \n
    5. \n
  5. \n

    File rename with changes: rename docs/README.txt with\nprevious content hello world\\n to a file at path\nnewdocs/README.txt with content new contents\\n:

    \n
    {\n  \"deletions\" [\n    {\n      \"path\": \"docs/README.txt\",\n    }\n  ],\n  \"additions\" [\n    {\n      \"path\": \"newdocs/README.txt\",\n      \"contents\": base64encode(\"new contents\\n\")\n    }\n  ]\n}.\n
    \n
    6. \n
", "inputFields": [ { "name": "additions", diff --git a/lib/graphql/static/schema-ghae.json b/lib/graphql/static/schema-ghae.json index 5ce9ea40cc..f00a15ffdc 100644 --- a/lib/graphql/static/schema-ghae.json +++ b/lib/graphql/static/schema-ghae.json @@ -1545,7 +1545,7 @@ "kind": "mutations", "id": "createcommitonbranch", "href": "/graphql/reference/mutations#createcommitonbranch", - "description": "

Appends a commit to the given branch as the authenticated user.

\n

This mutation creates a commit whose parent is the HEAD of the provided\nbranch and also updates that branch to point to the new commit.\nIt can be thought of as similar to git commit.

\n

Locating a Branch

\n

Commits are appended to a branch of type Ref.\nThis must refer to a git branch (i.e. the fully qualified path must\nbegin with refs/heads/, although including this prefix is optional.

\n

Callers may specify the branch to commit to either by its global node\nID or by passing both of repositoryNameWithOwner and refName. For\nmore details see the documentation for CommittableBranch.

\n

Describing Changes

\n

fileChanges are specified as a FilesChanges object describing\nFileAdditions and FileDeletions.

\n

Please see the documentation for FileChanges for more information on\nhow to use this argument to describe any set of file changes.

\n

Authorship

\n

Similar to the web commit interface, this mutation does not support\nspecifying the author or committer of the commit and will not add\nsupport for this in the future.

\n

A commit created by a successful execution of this mutation will be\nauthored by the owner of the credential which authenticates the API\nrequest. The committer will be identical to that of commits authored\nusing the web interface.

\n

If you need full control over author and committer information, please\nuse the Git Database REST API instead.

\n

Commit Signing

\n

Commits made using this mutation are automatically signed by GitHub if\nsupported and will be marked as verified in the user interface.

", + "description": "

Appends a commit to the given branch as the authenticated user.

\n

This mutation creates a commit whose parent is the HEAD of the provided\nbranch and also updates that branch to point to the new commit.\nIt can be thought of as similar to git commit.

\n

Locating a Branch

\n

Commits are appended to a branch of type Ref.\nThis must refer to a git branch (i.e. the fully qualified path must\nbegin with refs/heads/, although including this prefix is optional.

\n

Callers may specify the branch to commit to either by its global node\nID or by passing both of repositoryNameWithOwner and refName. For\nmore details see the documentation for CommittableBranch.

\n

Describing Changes

\n

fileChanges are specified as a FilesChanges object describing\nFileAdditions and FileDeletions.

\n

Please see the documentation for FileChanges for more information on\nhow to use this argument to describe any set of file changes.

\n

Authorship

\n

Similar to the web commit interface, this mutation does not support\nspecifying the author or committer of the commit and will not add\nsupport for this in the future.

\n

A commit created by a successful execution of this mutation will be\nauthored by the owner of the credential which authenticates the API\nrequest. The committer will be identical to that of commits authored\nusing the web interface.

\n

If you need full control over author and committer information, please\nuse the Git Database REST API instead.

\n

Commit Signing

\n

Commits made using this mutation are automatically signed by GitHub if\nsupported and will be marked as verified in the user interface.

", "inputFields": [ { "name": "input", @@ -64290,7 +64290,7 @@ "kind": "inputObjects", "id": "committablebranch", "href": "/graphql/reference/input-objects#committablebranch", - "description": "

A git ref for a commit to be appended to.

\n

The ref must be a branch, i.e. its fully qualified name must start\nwith refs/heads/ (although the input is not required to be fully\nqualified).

\n

The Ref may be specified by its global node ID or by the\nrepository nameWithOwner and branch name.

", + "description": "

A git ref for a commit to be appended to.

\n

The ref must be a branch, i.e. its fully qualified name must start\nwith refs/heads/ (although the input is not required to be fully\nqualified).

\n

The Ref may be specified by its global node ID or by the\nrepository nameWithOwner and branch name.

\n

Examples

\n

Specify a branch using a global node ID:

\n
{ \"id\": \"MDM6UmVmMTpyZWZzL2hlYWRzL21haW4=\" }\n
\n

Specify a branch using nameWithOwner and branch name:

\n
{\n  \"nameWithOwner\": \"github/graphql-client\",\n  \"branchName\": \"main\"\n}.\n
", "inputFields": [ { "name": "branchName", @@ -66568,7 +66568,7 @@ "kind": "inputObjects", "id": "filechanges", "href": "/graphql/reference/input-objects#filechanges", - "description": "

A description of a set of changes to a file tree to be made as part of\na git commit, modeled as zero or more file additions and zero or more\nfile deletions.

\n

Both fields are optional; omitting both will produce a commit with no\nfile changes.

\n

deletions and additions describe changes to files identified\nby their path in the git tree using unix-style path separators, i.e.\n/. The root of a git tree is an empty string, so paths are not\nslash-prefixed.

\n

path values must be unique across all additions and deletions\nprovided. Any duplication will result in a validation error.

\n

Encoding

\n

File contents must be provided in full for each FileAddition.

\n

The contents of a FileAddition must be encoded using RFC 4648\ncompliant base64, i.e. correct padding is required and no characters\noutside the standard alphabet may be used. Invalid base64\nencoding will be rejected with a validation error.

\n

The encoded contents may be binary.

\n

For text files, no assumptions are made about the character encoding of\nthe file contents (after base64 decoding). No charset transcoding or\nline-ending normalization will be performed; it is the client's\nresponsibility to manage the character encoding of files they provide.\nHowever, for maximum compatibility we recommend using UTF-8 encoding\nand ensuring that all files in a repository use a consistent\nline-ending convention (\\n or \\r\\n), and that all files end\nwith a newline.

\n

Modeling file changes

\n

Each of the the five types of conceptual changes that can be made in a\ngit commit can be described using the FileChanges type as follows:

\n
    \n
  1. \n

    New file addition: create file hello world\\n at path docs/README.txt:

    \n

    {\n\"additions\" [\n{\n\"path\": \"docs/README.txt\",\n\"contents\": base64encode(\"hello world\\n\")\n}\n]\n}

    \n
    2. \n
  2. \n

    Existing file modification: change existing docs/README.txt to have new\ncontent new content here\\n:

    \n
    {\n  \"additions\" [\n    {\n      \"path\": \"docs/README.txt\",\n      \"contents\": base64encode(\"new content here\\n\")\n    }\n  ]\n}\n
    \n
    3. \n
  3. \n

    Existing file deletion: remove existing file docs/README.txt.\nNote that the path is required to exist -- specifying a\npath that does not exist on the given branch will abort the\ncommit and return an error.

    \n
    {\n  \"deletions\" [\n    {\n      \"path\": \"docs/README.txt\"\n    }\n  ]\n}\n
    \n
    4. \n
  4. \n

    File rename with no changes: rename docs/README.txt with\nprevious content hello world\\n to the same content at\nnewdocs/README.txt:

    \n
    {\n  \"deletions\" [\n    {\n      \"path\": \"docs/README.txt\",\n    }\n  ],\n  \"additions\" [\n    {\n      \"path\": \"newdocs/README.txt\",\n      \"contents\": base64encode(\"hello world\\n\")\n    }\n  ]\n}\n
    \n
    5. \n
  5. \n

    File rename with changes: rename docs/README.txt with\nprevious content hello world\\n to a file at path\nnewdocs/README.txt with content new contents\\n:

    \n
    {\n  \"deletions\" [\n    {\n      \"path\": \"docs/README.txt\",\n    }\n  ],\n  \"additions\" [\n    {\n      \"path\": \"newdocs/README.txt\",\n      \"contents\": base64encode(\"new contents\\n\")\n    }\n  ]\n}.\n
    \n
    6. \n
", + "description": "

A description of a set of changes to a file tree to be made as part of\na git commit, modeled as zero or more file additions and zero or more\nfile deletions.

\n

Both fields are optional; omitting both will produce a commit with no\nfile changes.

\n

deletions and additions describe changes to files identified\nby their path in the git tree using unix-style path separators, i.e.\n/. The root of a git tree is an empty string, so paths are not\nslash-prefixed.

\n

path values must be unique across all additions and deletions\nprovided. Any duplication will result in a validation error.

\n

Encoding

\n

File contents must be provided in full for each FileAddition.

\n

The contents of a FileAddition must be encoded using RFC 4648\ncompliant base64, i.e. correct padding is required and no characters\noutside the standard alphabet may be used. Invalid base64\nencoding will be rejected with a validation error.

\n

The encoded contents may be binary.

\n

For text files, no assumptions are made about the character encoding of\nthe file contents (after base64 decoding). No charset transcoding or\nline-ending normalization will be performed; it is the client's\nresponsibility to manage the character encoding of files they provide.\nHowever, for maximum compatibility we recommend using UTF-8 encoding\nand ensuring that all files in a repository use a consistent\nline-ending convention (\\n or \\r\\n), and that all files end\nwith a newline.

\n

Modeling file changes

\n

Each of the the five types of conceptual changes that can be made in a\ngit commit can be described using the FileChanges type as follows:

\n
    \n
  1. \n

    New file addition: create file hello world\\n at path docs/README.txt:

    \n

    {\n\"additions\" [\n{\n\"path\": \"docs/README.txt\",\n\"contents\": base64encode(\"hello world\\n\")\n}\n]\n}

    \n
    2. \n
  2. \n

    Existing file modification: change existing docs/README.txt to have new\ncontent new content here\\n:

    \n
    {\n  \"additions\" [\n    {\n      \"path\": \"docs/README.txt\",\n      \"contents\": base64encode(\"new content here\\n\")\n    }\n  ]\n}\n
    \n
    3. \n
  3. \n

    Existing file deletion: remove existing file docs/README.txt.\nNote that the path is required to exist -- specifying a\npath that does not exist on the given branch will abort the\ncommit and return an error.

    \n
    {\n  \"deletions\" [\n    {\n      \"path\": \"docs/README.txt\"\n    }\n  ]\n}\n
    \n
    4. \n
  4. \n

    File rename with no changes: rename docs/README.txt with\nprevious content hello world\\n to the same content at\nnewdocs/README.txt:

    \n
    {\n  \"deletions\" [\n    {\n      \"path\": \"docs/README.txt\",\n    }\n  ],\n  \"additions\" [\n    {\n      \"path\": \"newdocs/README.txt\",\n      \"contents\": base64encode(\"hello world\\n\")\n    }\n  ]\n}\n
    \n
    5. \n
  5. \n

    File rename with changes: rename docs/README.txt with\nprevious content hello world\\n to a file at path\nnewdocs/README.txt with content new contents\\n:

    \n
    {\n  \"deletions\" [\n    {\n      \"path\": \"docs/README.txt\",\n    }\n  ],\n  \"additions\" [\n    {\n      \"path\": \"newdocs/README.txt\",\n      \"contents\": base64encode(\"new contents\\n\")\n    }\n  ]\n}.\n
    \n
    6. \n
", "inputFields": [ { "name": "additions", diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json index 38f707de61..7c62861305 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -21811,7 +21811,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Response", - "payload": "
[\n  {\n    \"id\": 79,\n    \"owner\": {\n      \"login\": \"github\",\n      \"id\": 1,\n      \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n      \"url\": \"https://api.github.com/orgs/github\",\n      \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n      \"events_url\": \"https://api.github.com/orgs/github/events\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": true\n    },\n    \"guid\": \"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\n    \"state\": \"pending\",\n    \"lock_repositories\": true,\n    \"exclude_attachments\": false,\n    \"repositories\": [\n      {\n        \"id\": 1296269,\n        \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n        \"name\": \"Hello-World\",\n        \"full_name\": \"octocat/Hello-World\",\n        \"owner\": {\n          \"login\": \"octocat\",\n          \"id\": 1,\n          \"node_id\": \"MDQ6VXNlcjE=\",\n          \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n          \"gravatar_id\": \"\",\n          \"url\": \"https://api.github.com/users/octocat\",\n          \"html_url\": \"https://github.com/octocat\",\n          \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n          \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n          \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n          \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n          \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n          \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n          \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n          \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n          \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n          \"type\": \"User\",\n          \"site_admin\": false\n        },\n        \"private\": false,\n        \"html_url\": \"https://github.com/octocat/Hello-World\",\n        \"description\": \"This your first repo!\",\n        \"fork\": false,\n        \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n        \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n        \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n        \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n        \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n        \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n        \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n        \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n        \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n        \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n        \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n        \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n        \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n        \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n        \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n        \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n        \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n        \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n        \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n        \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n        \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n        \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n        \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n        \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n        \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n        \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n        \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n        \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n        \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n        \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n        \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n        \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n        \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n        \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n        \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n        \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n        \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n        \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n        \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n        \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n        \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n        \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n        \"homepage\": \"https://github.com\",\n        \"language\": null,\n        \"forks_count\": 9,\n        \"stargazers_count\": 80,\n        \"watchers_count\": 80,\n        \"size\": 108,\n        \"default_branch\": \"master\",\n        \"open_issues_count\": 0,\n        \"is_template\": true,\n        \"topics\": [\n          \"octocat\",\n          \"atom\",\n          \"electron\",\n          \"api\"\n        ],\n        \"has_issues\": true,\n        \"has_projects\": true,\n        \"has_wiki\": true,\n        \"has_pages\": false,\n        \"has_downloads\": true,\n        \"archived\": false,\n        \"disabled\": false,\n        \"visibility\": \"public\",\n        \"pushed_at\": \"2011-01-26T19:06:43Z\",\n        \"created_at\": \"2011-01-26T19:01:12Z\",\n        \"updated_at\": \"2011-01-26T19:14:43Z\",\n        \"permissions\": {\n          \"admin\": false,\n          \"push\": false,\n          \"pull\": true\n        },\n        \"allow_rebase_merge\": true,\n        \"template_repository\": null,\n        \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n        \"allow_squash_merge\": true,\n        \"allow_auto_merge\": false,\n        \"delete_branch_on_merge\": true,\n        \"allow_merge_commit\": true,\n        \"subscribers_count\": 42,\n        \"network_count\": 0,\n        \"license\": {\n          \"key\": \"mit\",\n          \"name\": \"MIT License\",\n          \"url\": \"https://api.github.com/licenses/mit\",\n          \"spdx_id\": \"MIT\",\n          \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n          \"html_url\": \"https://api.github.com/licenses/mit\"\n        },\n        \"forks\": 1,\n        \"open_issues\": 1,\n        \"watchers\": 1\n      }\n    ],\n    \"url\": \"https://api.github.com/orgs/octo-org/migrations/79\",\n    \"created_at\": \"2015-07-06T15:33:38-07:00\",\n    \"updated_at\": \"2015-07-06T15:33:38-07:00\",\n    \"node_id\": \"MDQ6VXNlcjE=\"\n  }\n]\n
" + "payload": "
[\n  {\n    \"id\": 79,\n    \"owner\": {\n      \"login\": \"github\",\n      \"id\": 1,\n      \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n      \"url\": \"https://api.github.com/orgs/github\",\n      \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n      \"events_url\": \"https://api.github.com/orgs/github/events\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": true\n    },\n    \"guid\": \"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\n    \"state\": \"pending\",\n    \"lock_repositories\": true,\n    \"exclude_attachments\": false,\n    \"exclude_releases\": false,\n    \"exclude_owner_projects\": false,\n    \"repositories\": [\n      {\n        \"id\": 1296269,\n        \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n        \"name\": \"Hello-World\",\n        \"full_name\": \"octocat/Hello-World\",\n        \"owner\": {\n          \"login\": \"octocat\",\n          \"id\": 1,\n          \"node_id\": \"MDQ6VXNlcjE=\",\n          \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n          \"gravatar_id\": \"\",\n          \"url\": \"https://api.github.com/users/octocat\",\n          \"html_url\": \"https://github.com/octocat\",\n          \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n          \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n          \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n          \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n          \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n          \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n          \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n          \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n          \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n          \"type\": \"User\",\n          \"site_admin\": false\n        },\n        \"private\": false,\n        \"html_url\": \"https://github.com/octocat/Hello-World\",\n        \"description\": \"This your first repo!\",\n        \"fork\": false,\n        \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n        \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n        \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n        \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n        \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n        \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n        \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n        \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n        \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n        \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n        \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n        \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n        \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n        \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n        \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n        \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n        \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n        \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n        \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n        \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n        \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n        \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n        \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n        \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n        \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n        \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n        \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n        \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n        \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n        \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n        \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n        \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n        \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n        \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n        \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n        \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n        \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n        \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n        \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n        \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n        \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n        \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n        \"homepage\": \"https://github.com\",\n        \"language\": null,\n        \"forks_count\": 9,\n        \"stargazers_count\": 80,\n        \"watchers_count\": 80,\n        \"size\": 108,\n        \"default_branch\": \"master\",\n        \"open_issues_count\": 0,\n        \"is_template\": true,\n        \"topics\": [\n          \"octocat\",\n          \"atom\",\n          \"electron\",\n          \"api\"\n        ],\n        \"has_issues\": true,\n        \"has_projects\": true,\n        \"has_wiki\": true,\n        \"has_pages\": false,\n        \"has_downloads\": true,\n        \"archived\": false,\n        \"disabled\": false,\n        \"visibility\": \"public\",\n        \"pushed_at\": \"2011-01-26T19:06:43Z\",\n        \"created_at\": \"2011-01-26T19:01:12Z\",\n        \"updated_at\": \"2011-01-26T19:14:43Z\",\n        \"permissions\": {\n          \"admin\": false,\n          \"push\": false,\n          \"pull\": true\n        },\n        \"allow_rebase_merge\": true,\n        \"template_repository\": null,\n        \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n        \"allow_squash_merge\": true,\n        \"allow_auto_merge\": false,\n        \"delete_branch_on_merge\": true,\n        \"allow_merge_commit\": true,\n        \"subscribers_count\": 42,\n        \"network_count\": 0,\n        \"license\": {\n          \"key\": \"mit\",\n          \"name\": \"MIT License\",\n          \"url\": \"https://api.github.com/licenses/mit\",\n          \"spdx_id\": \"MIT\",\n          \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n          \"html_url\": \"https://api.github.com/licenses/mit\"\n        },\n        \"forks\": 1,\n        \"open_issues\": 1,\n        \"watchers\": 1\n      }\n    ],\n    \"url\": \"https://api.github.com/orgs/octo-org/migrations/79\",\n    \"created_at\": \"2015-07-06T15:33:38-07:00\",\n    \"updated_at\": \"2015-07-06T15:33:38-07:00\",\n    \"node_id\": \"MDQ6VXNlcjE=\"\n  }\n]\n
" } ] }, @@ -21873,6 +21873,7 @@ }, "lock_repositories": { "type": "boolean", + "example": true, "description": "

Indicates whether repositories should be locked (to prevent manipulation) while migrating data.

", "default": false, "name": "lock_repositories", @@ -21883,6 +21884,7 @@ }, "exclude_attachments": { "type": "boolean", + "example": true, "description": "

Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).

", "default": false, "name": "exclude_attachments", @@ -21891,6 +21893,28 @@ "rawDescription": "Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).", "childParamsGroups": [] }, + "exclude_releases": { + "type": "boolean", + "example": true, + "description": "

Indicates whether releases should be excluded from the migration (to reduce migration archive file size).

", + "default": false, + "name": "exclude_releases", + "in": "body", + "rawType": "boolean", + "rawDescription": "Indicates whether releases should be excluded from the migration (to reduce migration archive file size).", + "childParamsGroups": [] + }, + "exclude_owner_projects": { + "type": "boolean", + "example": true, + "description": "

Indicates whether projects owned by the organization or users should be excluded. from the migration.

", + "default": false, + "name": "exclude_owner_projects", + "in": "body", + "rawType": "boolean", + "rawDescription": "Indicates whether projects owned by the organization or users should be excluded. from the migration.", + "childParamsGroups": [] + }, "exclude": { "type": "array of strings", "items": { @@ -21949,6 +21973,7 @@ }, { "type": "boolean", + "example": true, "description": "

Indicates whether repositories should be locked (to prevent manipulation) while migrating data.

", "default": false, "name": "lock_repositories", @@ -21959,6 +21984,7 @@ }, { "type": "boolean", + "example": true, "description": "

Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).

", "default": false, "name": "exclude_attachments", @@ -21967,6 +21993,28 @@ "rawDescription": "Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).", "childParamsGroups": [] }, + { + "type": "boolean", + "example": true, + "description": "

Indicates whether releases should be excluded from the migration (to reduce migration archive file size).

", + "default": false, + "name": "exclude_releases", + "in": "body", + "rawType": "boolean", + "rawDescription": "Indicates whether releases should be excluded from the migration (to reduce migration archive file size).", + "childParamsGroups": [] + }, + { + "type": "boolean", + "example": true, + "description": "

Indicates whether projects owned by the organization or users should be excluded. from the migration.

", + "default": false, + "name": "exclude_owner_projects", + "in": "body", + "rawType": "boolean", + "rawDescription": "Indicates whether projects owned by the organization or users should be excluded. from the migration.", + "childParamsGroups": [] + }, { "type": "array of strings", "items": { @@ -21987,7 +22035,7 @@ "httpStatusCode": "201", "httpStatusMessage": "Created", "description": "Response", - "payload": "
{\n  \"id\": 79,\n  \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n  \"owner\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": true\n  },\n  \"guid\": \"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\n  \"state\": \"pending\",\n  \"lock_repositories\": true,\n  \"exclude_attachments\": false,\n  \"repositories\": [\n    {\n      \"id\": 1296269,\n      \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n      \"name\": \"Hello-World\",\n      \"full_name\": \"octocat/Hello-World\",\n      \"owner\": {\n        \"login\": \"octocat\",\n        \"id\": 1,\n        \"node_id\": \"MDQ6VXNlcjE=\",\n        \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n        \"gravatar_id\": \"\",\n        \"url\": \"https://api.github.com/users/octocat\",\n        \"html_url\": \"https://github.com/octocat\",\n        \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n        \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n        \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n        \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n        \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n        \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n        \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n        \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n        \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n        \"type\": \"User\",\n        \"site_admin\": false\n      },\n      \"private\": false,\n      \"html_url\": \"https://github.com/octocat/Hello-World\",\n      \"description\": \"This your first repo!\",\n      \"fork\": false,\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n      \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n      \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n      \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n      \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n      \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n      \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n      \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n      \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n      \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n      \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n      \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n      \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n      \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n      \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n      \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n      \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n      \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n      \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n      \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n      \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n      \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n      \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n      \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n      \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n      \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n      \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n      \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n      \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n      \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n      \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n      \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n      \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n      \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n      \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n      \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n      \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n      \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n      \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n      \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n      \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n      \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n      \"homepage\": \"https://github.com\",\n      \"language\": null,\n      \"forks_count\": 9,\n      \"stargazers_count\": 80,\n      \"watchers_count\": 80,\n      \"size\": 108,\n      \"default_branch\": \"master\",\n      \"open_issues_count\": 0,\n      \"is_template\": true,\n      \"topics\": [\n        \"octocat\",\n        \"atom\",\n        \"electron\",\n        \"api\"\n      ],\n      \"has_issues\": true,\n      \"has_projects\": true,\n      \"has_wiki\": true,\n      \"has_pages\": false,\n      \"has_downloads\": true,\n      \"archived\": false,\n      \"disabled\": false,\n      \"visibility\": \"public\",\n      \"pushed_at\": \"2011-01-26T19:06:43Z\",\n      \"created_at\": \"2011-01-26T19:01:12Z\",\n      \"updated_at\": \"2011-01-26T19:14:43Z\",\n      \"permissions\": {\n        \"admin\": false,\n        \"push\": false,\n        \"pull\": true\n      },\n      \"allow_rebase_merge\": true,\n      \"template_repository\": null,\n      \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n      \"allow_squash_merge\": true,\n      \"allow_auto_merge\": false,\n      \"delete_branch_on_merge\": true,\n      \"allow_merge_commit\": true,\n      \"subscribers_count\": 42,\n      \"network_count\": 0,\n      \"license\": {\n        \"key\": \"mit\",\n        \"name\": \"MIT License\",\n        \"url\": \"https://api.github.com/licenses/mit\",\n        \"spdx_id\": \"MIT\",\n        \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n        \"html_url\": \"https://api.github.com/licenses/mit\"\n      },\n      \"forks\": 1,\n      \"open_issues\": 1,\n      \"watchers\": 1\n    }\n  ],\n  \"url\": \"https://api.github.com/orgs/octo-org/migrations/79\",\n  \"created_at\": \"2015-07-06T15:33:38-07:00\",\n  \"updated_at\": \"2015-07-06T15:33:38-07:00\"\n}\n
" + "payload": "
{\n  \"id\": 79,\n  \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n  \"owner\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": true\n  },\n  \"guid\": \"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\n  \"state\": \"pending\",\n  \"lock_repositories\": true,\n  \"exclude_attachments\": false,\n  \"exclude_releases\": false,\n  \"exclude_owner_projects\": false,\n  \"repositories\": [\n    {\n      \"id\": 1296269,\n      \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n      \"name\": \"Hello-World\",\n      \"full_name\": \"octocat/Hello-World\",\n      \"owner\": {\n        \"login\": \"octocat\",\n        \"id\": 1,\n        \"node_id\": \"MDQ6VXNlcjE=\",\n        \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n        \"gravatar_id\": \"\",\n        \"url\": \"https://api.github.com/users/octocat\",\n        \"html_url\": \"https://github.com/octocat\",\n        \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n        \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n        \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n        \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n        \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n        \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n        \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n        \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n        \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n        \"type\": \"User\",\n        \"site_admin\": false\n      },\n      \"private\": false,\n      \"html_url\": \"https://github.com/octocat/Hello-World\",\n      \"description\": \"This your first repo!\",\n      \"fork\": false,\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n      \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n      \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n      \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n      \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n      \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n      \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n      \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n      \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n      \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n      \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n      \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n      \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n      \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n      \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n      \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n      \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n      \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n      \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n      \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n      \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n      \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n      \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n      \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n      \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n      \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n      \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n      \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n      \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n      \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n      \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n      \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n      \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n      \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n      \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n      \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n      \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n      \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n      \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n      \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n      \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n      \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n      \"homepage\": \"https://github.com\",\n      \"language\": null,\n      \"forks_count\": 9,\n      \"stargazers_count\": 80,\n      \"watchers_count\": 80,\n      \"size\": 108,\n      \"default_branch\": \"master\",\n      \"open_issues_count\": 0,\n      \"is_template\": true,\n      \"topics\": [\n        \"octocat\",\n        \"atom\",\n        \"electron\",\n        \"api\"\n      ],\n      \"has_issues\": true,\n      \"has_projects\": true,\n      \"has_wiki\": true,\n      \"has_pages\": false,\n      \"has_downloads\": true,\n      \"archived\": false,\n      \"disabled\": false,\n      \"visibility\": \"public\",\n      \"pushed_at\": \"2011-01-26T19:06:43Z\",\n      \"created_at\": \"2011-01-26T19:01:12Z\",\n      \"updated_at\": \"2011-01-26T19:14:43Z\",\n      \"permissions\": {\n        \"admin\": false,\n        \"push\": false,\n        \"pull\": true\n      },\n      \"allow_rebase_merge\": true,\n      \"template_repository\": null,\n      \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n      \"allow_squash_merge\": true,\n      \"allow_auto_merge\": false,\n      \"delete_branch_on_merge\": true,\n      \"allow_merge_commit\": true,\n      \"subscribers_count\": 42,\n      \"network_count\": 0,\n      \"license\": {\n        \"key\": \"mit\",\n        \"name\": \"MIT License\",\n        \"url\": \"https://api.github.com/licenses/mit\",\n        \"spdx_id\": \"MIT\",\n        \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n        \"html_url\": \"https://api.github.com/licenses/mit\"\n      },\n      \"forks\": 1,\n      \"open_issues\": 1,\n      \"watchers\": 1\n    }\n  ],\n  \"url\": \"https://api.github.com/orgs/octo-org/migrations/79\",\n  \"created_at\": \"2015-07-06T15:33:38-07:00\",\n  \"updated_at\": \"2015-07-06T15:33:38-07:00\"\n}\n
" }, { "httpStatusCode": "404", @@ -22092,7 +22140,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "* `pending`, which means the migration hasn't started yet.\n* `exporting`, which means the migration is in progress.\n* `exported`, which means the migration finished successfully.\n* `failed`, which means the migration failed.", - "payload": "
{\n  \"id\": 79,\n  \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n  \"owner\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": true\n  },\n  \"guid\": \"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\n  \"state\": \"exported\",\n  \"lock_repositories\": true,\n  \"exclude_attachments\": false,\n  \"repositories\": [\n    {\n      \"id\": 1296269,\n      \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n      \"name\": \"Hello-World\",\n      \"full_name\": \"octocat/Hello-World\",\n      \"owner\": {\n        \"login\": \"octocat\",\n        \"id\": 1,\n        \"node_id\": \"MDQ6VXNlcjE=\",\n        \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n        \"gravatar_id\": \"\",\n        \"url\": \"https://api.github.com/users/octocat\",\n        \"html_url\": \"https://github.com/octocat\",\n        \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n        \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n        \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n        \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n        \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n        \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n        \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n        \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n        \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n        \"type\": \"User\",\n        \"site_admin\": false\n      },\n      \"private\": false,\n      \"html_url\": \"https://github.com/octocat/Hello-World\",\n      \"description\": \"This your first repo!\",\n      \"fork\": false,\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n      \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n      \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n      \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n      \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n      \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n      \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n      \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n      \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n      \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n      \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n      \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n      \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n      \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n      \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n      \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n      \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n      \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n      \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n      \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n      \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n      \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n      \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n      \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n      \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n      \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n      \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n      \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n      \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n      \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n      \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n      \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n      \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n      \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n      \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n      \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n      \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n      \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n      \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n      \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n      \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n      \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n      \"homepage\": \"https://github.com\",\n      \"language\": null,\n      \"forks_count\": 9,\n      \"stargazers_count\": 80,\n      \"watchers_count\": 80,\n      \"size\": 108,\n      \"default_branch\": \"master\",\n      \"open_issues_count\": 0,\n      \"is_template\": true,\n      \"topics\": [\n        \"octocat\",\n        \"atom\",\n        \"electron\",\n        \"api\"\n      ],\n      \"has_issues\": true,\n      \"has_projects\": true,\n      \"has_wiki\": true,\n      \"has_pages\": false,\n      \"has_downloads\": true,\n      \"archived\": false,\n      \"disabled\": false,\n      \"visibility\": \"public\",\n      \"pushed_at\": \"2011-01-26T19:06:43Z\",\n      \"created_at\": \"2011-01-26T19:01:12Z\",\n      \"updated_at\": \"2011-01-26T19:14:43Z\",\n      \"permissions\": {\n        \"admin\": false,\n        \"push\": false,\n        \"pull\": true\n      },\n      \"allow_rebase_merge\": true,\n      \"template_repository\": null,\n      \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n      \"allow_squash_merge\": true,\n      \"allow_auto_merge\": false,\n      \"delete_branch_on_merge\": true,\n      \"allow_merge_commit\": true,\n      \"subscribers_count\": 42,\n      \"network_count\": 0,\n      \"license\": {\n        \"key\": \"mit\",\n        \"name\": \"MIT License\",\n        \"url\": \"https://api.github.com/licenses/mit\",\n        \"spdx_id\": \"MIT\",\n        \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n        \"html_url\": \"https://api.github.com/licenses/mit\"\n      },\n      \"forks\": 1,\n      \"open_issues\": 1,\n      \"watchers\": 1\n    }\n  ],\n  \"url\": \"https://api.github.com/orgs/octo-org/migrations/79\",\n  \"created_at\": \"2015-07-06T15:33:38-07:00\",\n  \"updated_at\": \"2015-07-06T15:33:38-07:00\"\n}\n
" + "payload": "
{\n  \"id\": 79,\n  \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n  \"owner\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": true\n  },\n  \"guid\": \"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\n  \"state\": \"exported\",\n  \"lock_repositories\": true,\n  \"exclude_attachments\": false,\n  \"exclude_releases\": false,\n  \"exclude_owner_projects\": false,\n  \"repositories\": [\n    {\n      \"id\": 1296269,\n      \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n      \"name\": \"Hello-World\",\n      \"full_name\": \"octocat/Hello-World\",\n      \"owner\": {\n        \"login\": \"octocat\",\n        \"id\": 1,\n        \"node_id\": \"MDQ6VXNlcjE=\",\n        \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n        \"gravatar_id\": \"\",\n        \"url\": \"https://api.github.com/users/octocat\",\n        \"html_url\": \"https://github.com/octocat\",\n        \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n        \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n        \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n        \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n        \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n        \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n        \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n        \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n        \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n        \"type\": \"User\",\n        \"site_admin\": false\n      },\n      \"private\": false,\n      \"html_url\": \"https://github.com/octocat/Hello-World\",\n      \"description\": \"This your first repo!\",\n      \"fork\": false,\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n      \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n      \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n      \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n      \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n      \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n      \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n      \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n      \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n      \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n      \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n      \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n      \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n      \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n      \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n      \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n      \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n      \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n      \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n      \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n      \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n      \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n      \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n      \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n      \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n      \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n      \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n      \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n      \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n      \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n      \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n      \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n      \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n      \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n      \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n      \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n      \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n      \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n      \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n      \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n      \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n      \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n      \"homepage\": \"https://github.com\",\n      \"language\": null,\n      \"forks_count\": 9,\n      \"stargazers_count\": 80,\n      \"watchers_count\": 80,\n      \"size\": 108,\n      \"default_branch\": \"master\",\n      \"open_issues_count\": 0,\n      \"is_template\": true,\n      \"topics\": [\n        \"octocat\",\n        \"atom\",\n        \"electron\",\n        \"api\"\n      ],\n      \"has_issues\": true,\n      \"has_projects\": true,\n      \"has_wiki\": true,\n      \"has_pages\": false,\n      \"has_downloads\": true,\n      \"archived\": false,\n      \"disabled\": false,\n      \"visibility\": \"public\",\n      \"pushed_at\": \"2011-01-26T19:06:43Z\",\n      \"created_at\": \"2011-01-26T19:01:12Z\",\n      \"updated_at\": \"2011-01-26T19:14:43Z\",\n      \"permissions\": {\n        \"admin\": false,\n        \"push\": false,\n        \"pull\": true\n      },\n      \"allow_rebase_merge\": true,\n      \"template_repository\": null,\n      \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n      \"allow_squash_merge\": true,\n      \"allow_auto_merge\": false,\n      \"delete_branch_on_merge\": true,\n      \"allow_merge_commit\": true,\n      \"subscribers_count\": 42,\n      \"network_count\": 0,\n      \"license\": {\n        \"key\": \"mit\",\n        \"name\": \"MIT License\",\n        \"url\": \"https://api.github.com/licenses/mit\",\n        \"spdx_id\": \"MIT\",\n        \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n        \"html_url\": \"https://api.github.com/licenses/mit\"\n      },\n      \"forks\": 1,\n      \"open_issues\": 1,\n      \"watchers\": 1\n    }\n  ],\n  \"url\": \"https://api.github.com/orgs/octo-org/migrations/79\",\n  \"created_at\": \"2015-07-06T15:33:38-07:00\",\n  \"updated_at\": \"2015-07-06T15:33:38-07:00\"\n}\n
" }, { "httpStatusCode": "404", @@ -91638,7 +91686,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Response", - "payload": "
[\n  {\n    \"id\": 79,\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"guid\": \"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\n    \"state\": \"pending\",\n    \"lock_repositories\": true,\n    \"exclude_attachments\": false,\n    \"repositories\": [\n      {\n        \"id\": 1296269,\n        \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n        \"name\": \"Hello-World\",\n        \"full_name\": \"octocat/Hello-World\",\n        \"owner\": {\n          \"login\": \"octocat\",\n          \"id\": 1,\n          \"node_id\": \"MDQ6VXNlcjE=\",\n          \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n          \"gravatar_id\": \"\",\n          \"url\": \"https://api.github.com/users/octocat\",\n          \"html_url\": \"https://github.com/octocat\",\n          \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n          \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n          \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n          \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n          \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n          \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n          \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n          \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n          \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n          \"type\": \"User\",\n          \"site_admin\": false\n        },\n        \"private\": false,\n        \"html_url\": \"https://github.com/octocat/Hello-World\",\n        \"description\": \"This your first repo!\",\n        \"fork\": false,\n        \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n        \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n        \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n        \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n        \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n        \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n        \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n        \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n        \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n        \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n        \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n        \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n        \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n        \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n        \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n        \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n        \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n        \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n        \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n        \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n        \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n        \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n        \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n        \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n        \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n        \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n        \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n        \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n        \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n        \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n        \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n        \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n        \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n        \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n        \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n        \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n        \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n        \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n        \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n        \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n        \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n        \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n        \"homepage\": \"https://github.com\",\n        \"language\": null,\n        \"forks_count\": 9,\n        \"stargazers_count\": 80,\n        \"watchers_count\": 80,\n        \"size\": 108,\n        \"default_branch\": \"master\",\n        \"open_issues_count\": 0,\n        \"is_template\": true,\n        \"topics\": [\n          \"octocat\",\n          \"atom\",\n          \"electron\",\n          \"api\"\n        ],\n        \"has_issues\": true,\n        \"has_projects\": true,\n        \"has_wiki\": true,\n        \"has_pages\": false,\n        \"has_downloads\": true,\n        \"archived\": false,\n        \"disabled\": false,\n        \"visibility\": \"public\",\n        \"pushed_at\": \"2011-01-26T19:06:43Z\",\n        \"created_at\": \"2011-01-26T19:01:12Z\",\n        \"updated_at\": \"2011-01-26T19:14:43Z\",\n        \"permissions\": {\n          \"admin\": false,\n          \"push\": false,\n          \"pull\": true\n        },\n        \"allow_rebase_merge\": true,\n        \"template_repository\": null,\n        \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n        \"allow_squash_merge\": true,\n        \"allow_auto_merge\": false,\n        \"delete_branch_on_merge\": true,\n        \"allow_merge_commit\": true,\n        \"subscribers_count\": 42,\n        \"network_count\": 0,\n        \"license\": {\n          \"key\": \"mit\",\n          \"name\": \"MIT License\",\n          \"url\": \"https://api.github.com/licenses/mit\",\n          \"spdx_id\": \"MIT\",\n          \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n          \"html_url\": \"https://api.github.com/licenses/mit\"\n        },\n        \"forks\": 1,\n        \"open_issues\": 1,\n        \"watchers\": 1\n      }\n    ],\n    \"url\": \"https://api.github.com/orgs/octo-org/migrations/79\",\n    \"created_at\": \"2015-07-06T15:33:38-07:00\",\n    \"updated_at\": \"2015-07-06T15:33:38-07:00\",\n    \"node_id\": \"MDQ6VXNlcjE=\"\n  }\n]\n
" + "payload": "
[\n  {\n    \"id\": 79,\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"guid\": \"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\n    \"state\": \"pending\",\n    \"lock_repositories\": true,\n    \"exclude_attachments\": false,\n    \"exclude_releases\": false,\n    \"exclude_owner_projects\": false,\n    \"repositories\": [\n      {\n        \"id\": 1296269,\n        \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n        \"name\": \"Hello-World\",\n        \"full_name\": \"octocat/Hello-World\",\n        \"owner\": {\n          \"login\": \"octocat\",\n          \"id\": 1,\n          \"node_id\": \"MDQ6VXNlcjE=\",\n          \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n          \"gravatar_id\": \"\",\n          \"url\": \"https://api.github.com/users/octocat\",\n          \"html_url\": \"https://github.com/octocat\",\n          \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n          \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n          \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n          \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n          \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n          \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n          \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n          \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n          \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n          \"type\": \"User\",\n          \"site_admin\": false\n        },\n        \"private\": false,\n        \"html_url\": \"https://github.com/octocat/Hello-World\",\n        \"description\": \"This your first repo!\",\n        \"fork\": false,\n        \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n        \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n        \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n        \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n        \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n        \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n        \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n        \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n        \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n        \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n        \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n        \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n        \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n        \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n        \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n        \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n        \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n        \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n        \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n        \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n        \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n        \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n        \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n        \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n        \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n        \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n        \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n        \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n        \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n        \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n        \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n        \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n        \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n        \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n        \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n        \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n        \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n        \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n        \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n        \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n        \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n        \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n        \"homepage\": \"https://github.com\",\n        \"language\": null,\n        \"forks_count\": 9,\n        \"stargazers_count\": 80,\n        \"watchers_count\": 80,\n        \"size\": 108,\n        \"default_branch\": \"master\",\n        \"open_issues_count\": 0,\n        \"is_template\": true,\n        \"topics\": [\n          \"octocat\",\n          \"atom\",\n          \"electron\",\n          \"api\"\n        ],\n        \"has_issues\": true,\n        \"has_projects\": true,\n        \"has_wiki\": true,\n        \"has_pages\": false,\n        \"has_downloads\": true,\n        \"archived\": false,\n        \"disabled\": false,\n        \"visibility\": \"public\",\n        \"pushed_at\": \"2011-01-26T19:06:43Z\",\n        \"created_at\": \"2011-01-26T19:01:12Z\",\n        \"updated_at\": \"2011-01-26T19:14:43Z\",\n        \"permissions\": {\n          \"admin\": false,\n          \"push\": false,\n          \"pull\": true\n        },\n        \"allow_rebase_merge\": true,\n        \"template_repository\": null,\n        \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n        \"allow_squash_merge\": true,\n        \"allow_auto_merge\": false,\n        \"delete_branch_on_merge\": true,\n        \"allow_merge_commit\": true,\n        \"subscribers_count\": 42,\n        \"network_count\": 0,\n        \"license\": {\n          \"key\": \"mit\",\n          \"name\": \"MIT License\",\n          \"url\": \"https://api.github.com/licenses/mit\",\n          \"spdx_id\": \"MIT\",\n          \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n          \"html_url\": \"https://api.github.com/licenses/mit\"\n        },\n        \"forks\": 1,\n        \"open_issues\": 1,\n        \"watchers\": 1\n      }\n    ],\n    \"url\": \"https://api.github.com/orgs/octo-org/migrations/79\",\n    \"created_at\": \"2015-07-06T15:33:38-07:00\",\n    \"updated_at\": \"2015-07-06T15:33:38-07:00\",\n    \"node_id\": \"MDQ6VXNlcjE=\"\n  }\n]\n
" }, { "httpStatusCode": "304", @@ -91712,6 +91760,28 @@ "rawDescription": "Do not include attachments in the migration", "childParamsGroups": [] }, + "exclude_releases": { + "description": "

Do not include releases in the migration

", + "example": true, + "readOnly": false, + "type": "boolean", + "name": "exclude_releases", + "in": "body", + "rawType": "boolean", + "rawDescription": "Do not include releases in the migration", + "childParamsGroups": [] + }, + "exclude_owner_projects": { + "description": "

Indicates whether projects owned by the organization or users should be excluded.

", + "example": true, + "readOnly": false, + "type": "boolean", + "name": "exclude_owner_projects", + "in": "body", + "rawType": "boolean", + "rawDescription": "Indicates whether projects owned by the organization or users should be excluded.", + "childParamsGroups": [] + }, "exclude": { "description": "

Exclude attributes from the API response to improve performance

", "example": [ @@ -91793,6 +91863,28 @@ "rawDescription": "Do not include attachments in the migration", "childParamsGroups": [] }, + { + "description": "

Do not include releases in the migration

", + "example": true, + "readOnly": false, + "type": "boolean", + "name": "exclude_releases", + "in": "body", + "rawType": "boolean", + "rawDescription": "Do not include releases in the migration", + "childParamsGroups": [] + }, + { + "description": "

Indicates whether projects owned by the organization or users should be excluded.

", + "example": true, + "readOnly": false, + "type": "boolean", + "name": "exclude_owner_projects", + "in": "body", + "rawType": "boolean", + "rawDescription": "Indicates whether projects owned by the organization or users should be excluded.", + "childParamsGroups": [] + }, { "description": "

Exclude attributes from the API response to improve performance

", "example": [ @@ -91833,7 +91925,7 @@ "httpStatusCode": "201", "httpStatusMessage": "Created", "description": "Response", - "payload": "
{\n  \"id\": 79,\n  \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n  \"owner\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"guid\": \"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\n  \"state\": \"pending\",\n  \"lock_repositories\": true,\n  \"exclude_attachments\": false,\n  \"repositories\": [\n    {\n      \"id\": 1296269,\n      \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n      \"name\": \"Hello-World\",\n      \"full_name\": \"octocat/Hello-World\",\n      \"owner\": {\n        \"login\": \"octocat\",\n        \"id\": 1,\n        \"node_id\": \"MDQ6VXNlcjE=\",\n        \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n        \"gravatar_id\": \"\",\n        \"url\": \"https://api.github.com/users/octocat\",\n        \"html_url\": \"https://github.com/octocat\",\n        \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n        \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n        \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n        \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n        \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n        \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n        \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n        \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n        \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n        \"type\": \"User\",\n        \"site_admin\": false\n      },\n      \"private\": false,\n      \"html_url\": \"https://github.com/octocat/Hello-World\",\n      \"description\": \"This your first repo!\",\n      \"fork\": false,\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n      \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n      \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n      \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n      \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n      \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n      \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n      \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n      \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n      \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n      \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n      \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n      \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n      \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n      \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n      \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n      \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n      \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n      \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n      \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n      \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n      \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n      \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n      \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n      \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n      \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n      \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n      \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n      \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n      \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n      \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n      \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n      \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n      \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n      \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n      \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n      \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n      \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n      \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n      \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n      \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n      \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n      \"homepage\": \"https://github.com\",\n      \"language\": null,\n      \"forks_count\": 9,\n      \"stargazers_count\": 80,\n      \"watchers_count\": 80,\n      \"size\": 108,\n      \"default_branch\": \"master\",\n      \"open_issues_count\": 0,\n      \"is_template\": true,\n      \"topics\": [\n        \"octocat\",\n        \"atom\",\n        \"electron\",\n        \"api\"\n      ],\n      \"has_issues\": true,\n      \"has_projects\": true,\n      \"has_wiki\": true,\n      \"has_pages\": false,\n      \"has_downloads\": true,\n      \"archived\": false,\n      \"disabled\": false,\n      \"visibility\": \"public\",\n      \"pushed_at\": \"2011-01-26T19:06:43Z\",\n      \"created_at\": \"2011-01-26T19:01:12Z\",\n      \"updated_at\": \"2011-01-26T19:14:43Z\",\n      \"permissions\": {\n        \"admin\": false,\n        \"push\": false,\n        \"pull\": true\n      },\n      \"allow_rebase_merge\": true,\n      \"template_repository\": null,\n      \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n      \"allow_squash_merge\": true,\n      \"allow_auto_merge\": false,\n      \"delete_branch_on_merge\": true,\n      \"allow_merge_commit\": true,\n      \"subscribers_count\": 42,\n      \"network_count\": 0,\n      \"license\": {\n        \"key\": \"mit\",\n        \"name\": \"MIT License\",\n        \"url\": \"https://api.github.com/licenses/mit\",\n        \"spdx_id\": \"MIT\",\n        \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n        \"html_url\": \"https://api.github.com/licenses/mit\"\n      },\n      \"forks\": 1,\n      \"open_issues\": 1,\n      \"watchers\": 1\n    }\n  ],\n  \"url\": \"https://api.github.com/orgs/octo-org/migrations/79\",\n  \"created_at\": \"2015-07-06T15:33:38-07:00\",\n  \"updated_at\": \"2015-07-06T15:33:38-07:00\"\n}\n
" + "payload": "
{\n  \"id\": 79,\n  \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n  \"owner\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"guid\": \"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\n  \"state\": \"pending\",\n  \"lock_repositories\": true,\n  \"exclude_attachments\": false,\n  \"exclude_releases\": false,\n  \"exclude_owner_projects\": false,\n  \"repositories\": [\n    {\n      \"id\": 1296269,\n      \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n      \"name\": \"Hello-World\",\n      \"full_name\": \"octocat/Hello-World\",\n      \"owner\": {\n        \"login\": \"octocat\",\n        \"id\": 1,\n        \"node_id\": \"MDQ6VXNlcjE=\",\n        \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n        \"gravatar_id\": \"\",\n        \"url\": \"https://api.github.com/users/octocat\",\n        \"html_url\": \"https://github.com/octocat\",\n        \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n        \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n        \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n        \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n        \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n        \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n        \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n        \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n        \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n        \"type\": \"User\",\n        \"site_admin\": false\n      },\n      \"private\": false,\n      \"html_url\": \"https://github.com/octocat/Hello-World\",\n      \"description\": \"This your first repo!\",\n      \"fork\": false,\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n      \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n      \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n      \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n      \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n      \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n      \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n      \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n      \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n      \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n      \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n      \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n      \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n      \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n      \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n      \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n      \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n      \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n      \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n      \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n      \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n      \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n      \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n      \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n      \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n      \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n      \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n      \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n      \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n      \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n      \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n      \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n      \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n      \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n      \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n      \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n      \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n      \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n      \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n      \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n      \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n      \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n      \"homepage\": \"https://github.com\",\n      \"language\": null,\n      \"forks_count\": 9,\n      \"stargazers_count\": 80,\n      \"watchers_count\": 80,\n      \"size\": 108,\n      \"default_branch\": \"master\",\n      \"open_issues_count\": 0,\n      \"is_template\": true,\n      \"topics\": [\n        \"octocat\",\n        \"atom\",\n        \"electron\",\n        \"api\"\n      ],\n      \"has_issues\": true,\n      \"has_projects\": true,\n      \"has_wiki\": true,\n      \"has_pages\": false,\n      \"has_downloads\": true,\n      \"archived\": false,\n      \"disabled\": false,\n      \"visibility\": \"public\",\n      \"pushed_at\": \"2011-01-26T19:06:43Z\",\n      \"created_at\": \"2011-01-26T19:01:12Z\",\n      \"updated_at\": \"2011-01-26T19:14:43Z\",\n      \"permissions\": {\n        \"admin\": false,\n        \"push\": false,\n        \"pull\": true\n      },\n      \"allow_rebase_merge\": true,\n      \"template_repository\": null,\n      \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n      \"allow_squash_merge\": true,\n      \"allow_auto_merge\": false,\n      \"delete_branch_on_merge\": true,\n      \"allow_merge_commit\": true,\n      \"subscribers_count\": 42,\n      \"network_count\": 0,\n      \"license\": {\n        \"key\": \"mit\",\n        \"name\": \"MIT License\",\n        \"url\": \"https://api.github.com/licenses/mit\",\n        \"spdx_id\": \"MIT\",\n        \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n        \"html_url\": \"https://api.github.com/licenses/mit\"\n      },\n      \"forks\": 1,\n      \"open_issues\": 1,\n      \"watchers\": 1\n    }\n  ],\n  \"url\": \"https://api.github.com/orgs/octo-org/migrations/79\",\n  \"created_at\": \"2015-07-06T15:33:38-07:00\",\n  \"updated_at\": \"2015-07-06T15:33:38-07:00\"\n}\n
" }, { "httpStatusCode": "304", @@ -91934,7 +92026,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Response", - "payload": "
{\n  \"id\": 79,\n  \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n  \"owner\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"guid\": \"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\n  \"state\": \"exported\",\n  \"lock_repositories\": true,\n  \"exclude_attachments\": false,\n  \"repositories\": [\n    {\n      \"id\": 1296269,\n      \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n      \"name\": \"Hello-World\",\n      \"full_name\": \"octocat/Hello-World\",\n      \"owner\": {\n        \"login\": \"octocat\",\n        \"id\": 1,\n        \"node_id\": \"MDQ6VXNlcjE=\",\n        \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n        \"gravatar_id\": \"\",\n        \"url\": \"https://api.github.com/users/octocat\",\n        \"html_url\": \"https://github.com/octocat\",\n        \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n        \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n        \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n        \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n        \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n        \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n        \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n        \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n        \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n        \"type\": \"User\",\n        \"site_admin\": false\n      },\n      \"private\": false,\n      \"html_url\": \"https://github.com/octocat/Hello-World\",\n      \"description\": \"This your first repo!\",\n      \"fork\": false,\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n      \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n      \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n      \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n      \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n      \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n      \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n      \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n      \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n      \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n      \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n      \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n      \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n      \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n      \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n      \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n      \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n      \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n      \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n      \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n      \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n      \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n      \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n      \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n      \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n      \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n      \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n      \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n      \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n      \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n      \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n      \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n      \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n      \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n      \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n      \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n      \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n      \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n      \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n      \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n      \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n      \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n      \"homepage\": \"https://github.com\",\n      \"language\": null,\n      \"forks_count\": 9,\n      \"stargazers_count\": 80,\n      \"watchers_count\": 80,\n      \"size\": 108,\n      \"default_branch\": \"master\",\n      \"open_issues_count\": 0,\n      \"is_template\": true,\n      \"topics\": [\n        \"octocat\",\n        \"atom\",\n        \"electron\",\n        \"api\"\n      ],\n      \"has_issues\": true,\n      \"has_projects\": true,\n      \"has_wiki\": true,\n      \"has_pages\": false,\n      \"has_downloads\": true,\n      \"archived\": false,\n      \"disabled\": false,\n      \"visibility\": \"public\",\n      \"pushed_at\": \"2011-01-26T19:06:43Z\",\n      \"created_at\": \"2011-01-26T19:01:12Z\",\n      \"updated_at\": \"2011-01-26T19:14:43Z\",\n      \"permissions\": {\n        \"admin\": false,\n        \"push\": false,\n        \"pull\": true\n      },\n      \"allow_rebase_merge\": true,\n      \"template_repository\": null,\n      \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n      \"allow_squash_merge\": true,\n      \"allow_auto_merge\": false,\n      \"delete_branch_on_merge\": true,\n      \"allow_merge_commit\": true,\n      \"subscribers_count\": 42,\n      \"network_count\": 0,\n      \"license\": {\n        \"key\": \"mit\",\n        \"name\": \"MIT License\",\n        \"url\": \"https://api.github.com/licenses/mit\",\n        \"spdx_id\": \"MIT\",\n        \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n        \"html_url\": \"https://api.github.com/licenses/mit\"\n      },\n      \"forks\": 1,\n      \"open_issues\": 1,\n      \"watchers\": 1\n    }\n  ],\n  \"url\": \"https://api.github.com/orgs/octo-org/migrations/79\",\n  \"created_at\": \"2015-07-06T15:33:38-07:00\",\n  \"updated_at\": \"2015-07-06T15:33:38-07:00\"\n}\n
" + "payload": "
{\n  \"id\": 79,\n  \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n  \"owner\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"guid\": \"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\n  \"state\": \"exported\",\n  \"lock_repositories\": true,\n  \"exclude_attachments\": false,\n  \"exclude_releases\": false,\n  \"exclude_owner_projects\": false,\n  \"repositories\": [\n    {\n      \"id\": 1296269,\n      \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n      \"name\": \"Hello-World\",\n      \"full_name\": \"octocat/Hello-World\",\n      \"owner\": {\n        \"login\": \"octocat\",\n        \"id\": 1,\n        \"node_id\": \"MDQ6VXNlcjE=\",\n        \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n        \"gravatar_id\": \"\",\n        \"url\": \"https://api.github.com/users/octocat\",\n        \"html_url\": \"https://github.com/octocat\",\n        \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n        \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n        \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n        \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n        \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n        \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n        \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n        \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n        \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n        \"type\": \"User\",\n        \"site_admin\": false\n      },\n      \"private\": false,\n      \"html_url\": \"https://github.com/octocat/Hello-World\",\n      \"description\": \"This your first repo!\",\n      \"fork\": false,\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n      \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n      \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n      \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n      \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n      \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n      \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n      \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n      \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n      \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n      \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n      \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n      \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n      \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n      \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n      \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n      \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n      \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n      \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n      \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n      \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n      \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n      \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n      \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n      \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n      \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n      \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n      \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n      \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n      \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n      \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n      \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n      \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n      \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n      \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n      \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n      \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n      \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n      \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n      \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n      \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n      \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n      \"homepage\": \"https://github.com\",\n      \"language\": null,\n      \"forks_count\": 9,\n      \"stargazers_count\": 80,\n      \"watchers_count\": 80,\n      \"size\": 108,\n      \"default_branch\": \"master\",\n      \"open_issues_count\": 0,\n      \"is_template\": true,\n      \"topics\": [\n        \"octocat\",\n        \"atom\",\n        \"electron\",\n        \"api\"\n      ],\n      \"has_issues\": true,\n      \"has_projects\": true,\n      \"has_wiki\": true,\n      \"has_pages\": false,\n      \"has_downloads\": true,\n      \"archived\": false,\n      \"disabled\": false,\n      \"visibility\": \"public\",\n      \"pushed_at\": \"2011-01-26T19:06:43Z\",\n      \"created_at\": \"2011-01-26T19:01:12Z\",\n      \"updated_at\": \"2011-01-26T19:14:43Z\",\n      \"permissions\": {\n        \"admin\": false,\n        \"push\": false,\n        \"pull\": true\n      },\n      \"allow_rebase_merge\": true,\n      \"template_repository\": null,\n      \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n      \"allow_squash_merge\": true,\n      \"allow_auto_merge\": false,\n      \"delete_branch_on_merge\": true,\n      \"allow_merge_commit\": true,\n      \"subscribers_count\": 42,\n      \"network_count\": 0,\n      \"license\": {\n        \"key\": \"mit\",\n        \"name\": \"MIT License\",\n        \"url\": \"https://api.github.com/licenses/mit\",\n        \"spdx_id\": \"MIT\",\n        \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n        \"html_url\": \"https://api.github.com/licenses/mit\"\n      },\n      \"forks\": 1,\n      \"open_issues\": 1,\n      \"watchers\": 1\n    }\n  ],\n  \"url\": \"https://api.github.com/orgs/octo-org/migrations/79\",\n  \"created_at\": \"2015-07-06T15:33:38-07:00\",\n  \"updated_at\": \"2015-07-06T15:33:38-07:00\"\n}\n
" }, { "httpStatusCode": "304", diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json index a3665cb81d..f0e74a4821 100644 --- a/lib/rest/static/dereferenced/api.github.com.deref.json +++ b/lib/rest/static/dereferenced/api.github.com.deref.json @@ -75767,9 +75767,21 @@ "type": "boolean", "example": true }, + "exclude_metadata": { + "type": "boolean" + }, + "exclude_git_data": { + "type": "boolean" + }, "exclude_attachments": { "type": "boolean" }, + "exclude_releases": { + "type": "boolean" + }, + "exclude_owner_projects": { + "type": "boolean" + }, "repositories": { "type": "array", "items": { @@ -76903,7 +76915,11 @@ "guid", "state", "lock_repositories", + "exclude_metadata", + "exclude_git_data", "exclude_attachments", + "exclude_releases", + "exclude_owner_projects", "repositories", "url", "created_at", @@ -76940,6 +76956,8 @@ "state": "pending", "lock_repositories": true, "exclude_attachments": false, + "exclude_releases": false, + "exclude_owner_projects": false, "repositories": [ { "id": 1296269, @@ -77136,14 +77154,28 @@ }, "lock_repositories": { "type": "boolean", + "example": true, "description": "Indicates whether repositories should be locked (to prevent manipulation) while migrating data.", "default": false }, "exclude_attachments": { "type": "boolean", + "example": true, "description": "Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).", "default": false }, + "exclude_releases": { + "type": "boolean", + "example": true, + "description": "Indicates whether releases should be excluded from the migration (to reduce migration archive file size).", + "default": false + }, + "exclude_owner_projects": { + "type": "boolean", + "example": true, + "description": "Indicates whether projects owned by the organization or users should be excluded. from the migration.", + "default": false + }, "exclude": { "type": "array", "items": { @@ -77313,9 +77345,21 @@ "type": "boolean", "example": true }, + "exclude_metadata": { + "type": "boolean" + }, + "exclude_git_data": { + "type": "boolean" + }, "exclude_attachments": { "type": "boolean" }, + "exclude_releases": { + "type": "boolean" + }, + "exclude_owner_projects": { + "type": "boolean" + }, "repositories": { "type": "array", "items": { @@ -78449,7 +78493,11 @@ "guid", "state", "lock_repositories", + "exclude_metadata", + "exclude_git_data", "exclude_attachments", + "exclude_releases", + "exclude_owner_projects", "repositories", "url", "created_at", @@ -78485,6 +78533,8 @@ "state": "pending", "lock_repositories": true, "exclude_attachments": false, + "exclude_releases": false, + "exclude_owner_projects": false, "repositories": [ { "id": 1296269, @@ -78919,9 +78969,21 @@ "type": "boolean", "example": true }, + "exclude_metadata": { + "type": "boolean" + }, + "exclude_git_data": { + "type": "boolean" + }, "exclude_attachments": { "type": "boolean" }, + "exclude_releases": { + "type": "boolean" + }, + "exclude_owner_projects": { + "type": "boolean" + }, "repositories": { "type": "array", "items": { @@ -80055,7 +80117,11 @@ "guid", "state", "lock_repositories", + "exclude_metadata", + "exclude_git_data", "exclude_attachments", + "exclude_releases", + "exclude_owner_projects", "repositories", "url", "created_at", @@ -80091,6 +80157,8 @@ "state": "exported", "lock_repositories": true, "exclude_attachments": false, + "exclude_releases": false, + "exclude_owner_projects": false, "repositories": [ { "id": 1296269, @@ -378757,9 +378825,21 @@ "type": "boolean", "example": true }, + "exclude_metadata": { + "type": "boolean" + }, + "exclude_git_data": { + "type": "boolean" + }, "exclude_attachments": { "type": "boolean" }, + "exclude_releases": { + "type": "boolean" + }, + "exclude_owner_projects": { + "type": "boolean" + }, "repositories": { "type": "array", "items": { @@ -379893,7 +379973,11 @@ "guid", "state", "lock_repositories", + "exclude_metadata", + "exclude_git_data", "exclude_attachments", + "exclude_releases", + "exclude_owner_projects", "repositories", "url", "created_at", @@ -379930,6 +380014,8 @@ "state": "pending", "lock_repositories": true, "exclude_attachments": false, + "exclude_releases": false, + "exclude_owner_projects": false, "repositories": [ { "id": 1296269, @@ -380176,6 +380262,18 @@ "readOnly": false, "type": "boolean" }, + "exclude_releases": { + "description": "Do not include releases in the migration", + "example": true, + "readOnly": false, + "type": "boolean" + }, + "exclude_owner_projects": { + "description": "Indicates whether projects owned by the organization or users should be excluded.", + "example": true, + "readOnly": false, + "type": "boolean" + }, "exclude": { "description": "Exclude attributes from the API response to improve performance", "example": [ @@ -380355,9 +380453,21 @@ "type": "boolean", "example": true }, + "exclude_metadata": { + "type": "boolean" + }, + "exclude_git_data": { + "type": "boolean" + }, "exclude_attachments": { "type": "boolean" }, + "exclude_releases": { + "type": "boolean" + }, + "exclude_owner_projects": { + "type": "boolean" + }, "repositories": { "type": "array", "items": { @@ -381491,7 +381601,11 @@ "guid", "state", "lock_repositories", + "exclude_metadata", + "exclude_git_data", "exclude_attachments", + "exclude_releases", + "exclude_owner_projects", "repositories", "url", "created_at", @@ -381527,6 +381641,8 @@ "state": "pending", "lock_repositories": true, "exclude_attachments": false, + "exclude_releases": false, + "exclude_owner_projects": false, "repositories": [ { "id": 1296269, @@ -381977,9 +382093,21 @@ "type": "boolean", "example": true }, + "exclude_metadata": { + "type": "boolean" + }, + "exclude_git_data": { + "type": "boolean" + }, "exclude_attachments": { "type": "boolean" }, + "exclude_releases": { + "type": "boolean" + }, + "exclude_owner_projects": { + "type": "boolean" + }, "repositories": { "type": "array", "items": { @@ -383113,7 +383241,11 @@ "guid", "state", "lock_repositories", + "exclude_metadata", + "exclude_git_data", "exclude_attachments", + "exclude_releases", + "exclude_owner_projects", "repositories", "url", "created_at", @@ -383149,6 +383281,8 @@ "state": "exported", "lock_repositories": true, "exclude_attachments": false, + "exclude_releases": false, + "exclude_owner_projects": false, "repositories": [ { "id": 1296269, diff --git a/lib/search/indexes/github-docs-2.22-cn-records.json.br b/lib/search/indexes/github-docs-2.22-cn-records.json.br index c0445aef5f..2b4a062c99 100644 --- a/lib/search/indexes/github-docs-2.22-cn-records.json.br +++ b/lib/search/indexes/github-docs-2.22-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:900e225ccdbc985df1399f10ef88d3c784e81f67f744c038d65c4e018ecd26d8 -size 506558 +oid sha256:1b44e868c3663aacc735e803b3dc5772363ce15c180733182caa31618ff3a517 +size 506924 diff --git a/lib/search/indexes/github-docs-2.22-cn.json.br b/lib/search/indexes/github-docs-2.22-cn.json.br index b0e24e8f9e..7071c9a2a2 100644 --- a/lib/search/indexes/github-docs-2.22-cn.json.br +++ b/lib/search/indexes/github-docs-2.22-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:d9e447d373636f7df9ea02716c62f2053cc1603f27d7056a97bd02b8c7054192 -size 802450 +oid sha256:f1ab2a68ef1ea612629b9954cddff3aaaf8b7c6d2cf9720223f26c87bb257895 +size 802608 diff --git a/lib/search/indexes/github-docs-2.22-de-records.json.br b/lib/search/indexes/github-docs-2.22-de-records.json.br index ab9d8f12ab..876ba5fb92 100644 --- a/lib/search/indexes/github-docs-2.22-de-records.json.br +++ b/lib/search/indexes/github-docs-2.22-de-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:c5e0766a29184ca881fedd305e863e90708929b6df7da166a5627282b80114b6 -size 469543 +oid sha256:dd64d0ac6df223b0cef1e0bf32ee0c04edd1a533149ad952f9c32910d8f3f2a6 +size 469945 diff --git a/lib/search/indexes/github-docs-2.22-de.json.br b/lib/search/indexes/github-docs-2.22-de.json.br index d8444daa85..f7ade0ce71 100644 --- a/lib/search/indexes/github-docs-2.22-de.json.br +++ b/lib/search/indexes/github-docs-2.22-de.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:eb8db3e390b968ec69698a930454a05570c094929283f1290fab8f271132db91 -size 2078212 +oid sha256:bb99a3e2681a022474c7f7bf17965d7e61e22b1e57327ff572cfca5b7b695016 +size 2078752 diff --git a/lib/search/indexes/github-docs-2.22-en-records.json.br b/lib/search/indexes/github-docs-2.22-en-records.json.br index 05170abbba..8da740a1dc 100644 --- a/lib/search/indexes/github-docs-2.22-en-records.json.br +++ b/lib/search/indexes/github-docs-2.22-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:a7875d5165d3d774790f32736ca76dd86ce07d5a50c4f7489bef31278e9d68cb -size 432928 +oid sha256:d3b7125b1f7b9f581367920df0c60a11d58b28745e0d7fcef2a7d81d92cf9495 +size 430097 diff --git a/lib/search/indexes/github-docs-2.22-en.json.br b/lib/search/indexes/github-docs-2.22-en.json.br index 34b9b5b5f2..be3619c68c 100644 --- a/lib/search/indexes/github-docs-2.22-en.json.br +++ b/lib/search/indexes/github-docs-2.22-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:ed96b511c8c49ad25a4813905ea38e018d20060a91273595f908567dff847078 -size 1698589 +oid sha256:9128471f2efb16f5e9158ed77f6a99849b11c3c8e111561416ad22eda7f7d10d +size 1680475 diff --git a/lib/search/indexes/github-docs-2.22-es-records.json.br b/lib/search/indexes/github-docs-2.22-es-records.json.br index 16a540b00b..70ec498931 100644 --- a/lib/search/indexes/github-docs-2.22-es-records.json.br +++ b/lib/search/indexes/github-docs-2.22-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:a88a0ab389f1bb736c662823a707c0e34f8c2f6878efa4052d8f0a30ade8feb8 -size 279907 +oid sha256:ee31cfd2eeab6fb852b9417041652acf06ee4d1a33211afcc8f633a475b217d0 +size 279971 diff --git a/lib/search/indexes/github-docs-2.22-es.json.br b/lib/search/indexes/github-docs-2.22-es.json.br index bc057ff925..3cf5d8f96a 100644 --- a/lib/search/indexes/github-docs-2.22-es.json.br +++ b/lib/search/indexes/github-docs-2.22-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:03ca3e9f9e97f0ce57f3cc3a01986d255be826cae50551187be82ff768c19338 -size 1066857 +oid sha256:b1210c63130a1ece2ac6b07450d98f81e73cdbe1a83bf9d1b27d9b294c3f7b98 +size 1067469 diff --git a/lib/search/indexes/github-docs-2.22-ja-records.json.br b/lib/search/indexes/github-docs-2.22-ja-records.json.br index e7f5353868..a97851b82a 100644 --- a/lib/search/indexes/github-docs-2.22-ja-records.json.br +++ b/lib/search/indexes/github-docs-2.22-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:b198bf1f8bfed2972ad7e785ca3f39fe309a244dbb19de4e7096447e23385e90 -size 528686 +oid sha256:a66e29ad39ffc8d904dcd3b9f223cd7e9faf7050faf2a19e4bf88daa0ea24110 +size 528812 diff --git a/lib/search/indexes/github-docs-2.22-ja.json.br b/lib/search/indexes/github-docs-2.22-ja.json.br index 72c048285a..0934c30b26 100644 --- a/lib/search/indexes/github-docs-2.22-ja.json.br +++ b/lib/search/indexes/github-docs-2.22-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:bee494039ea2414e76ef965b77beb75808f1eb6f090614d48fdc0eaec6fb3a9c -size 2796328 +oid sha256:eab3fac6ea7719fb16996c3505bf55bb2f6bcd9ebc6356a764a06c1d01f8a286 +size 2796447 diff --git a/lib/search/indexes/github-docs-2.22-pt-records.json.br b/lib/search/indexes/github-docs-2.22-pt-records.json.br index 703cd5724b..6f9cc0500e 100644 --- a/lib/search/indexes/github-docs-2.22-pt-records.json.br +++ b/lib/search/indexes/github-docs-2.22-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:6e5192892c1cb664db04f37942f99f3abfd8bb787a8b63b798d83e16df3f24f8 -size 443524 +oid sha256:a66f0ea1992397644131f8109eba5c74144a1e6aa8002623dd9bd0da4187e627 +size 443449 diff --git a/lib/search/indexes/github-docs-2.22-pt.json.br b/lib/search/indexes/github-docs-2.22-pt.json.br index 44c3942711..09fcaaea13 100644 --- a/lib/search/indexes/github-docs-2.22-pt.json.br +++ b/lib/search/indexes/github-docs-2.22-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:2b19be487223254af8deeb5db544420147a4f684da2c5d86b14aff599e54d835 -size 1852740 +oid sha256:867e3a92a81157c66fd6d519b88ddf02c4af1c9ce158c96182ed1c09e52dddcd +size 1850733 diff --git a/lib/search/indexes/github-docs-3.0-cn-records.json.br b/lib/search/indexes/github-docs-3.0-cn-records.json.br index 19505856c6..d48f03609a 100644 --- a/lib/search/indexes/github-docs-3.0-cn-records.json.br +++ b/lib/search/indexes/github-docs-3.0-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:9c0eddc8dac916e0ca7b4f996fcfc07dae31dd2975970543d6ece7673afef401 -size 524645 +oid sha256:c54f3a0efbace9180e5f7115257c17d2f5359d910a547e5d8c754e1deabf9b81 +size 524643 diff --git a/lib/search/indexes/github-docs-3.0-cn.json.br b/lib/search/indexes/github-docs-3.0-cn.json.br index a178989074..87ae24c9d6 100644 --- a/lib/search/indexes/github-docs-3.0-cn.json.br +++ b/lib/search/indexes/github-docs-3.0-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:701ef459697ab66997b1175fc1c93424c8d00d98b7548087b000e1f3c5d06a16 -size 834095 +oid sha256:3f90afc34397f3838fe86af021e4c1d1db9a55f2b4224bb8df953eedafaee4e1 +size 833783 diff --git a/lib/search/indexes/github-docs-3.0-de-records.json.br b/lib/search/indexes/github-docs-3.0-de-records.json.br index a24bc8c91d..b37f357740 100644 --- a/lib/search/indexes/github-docs-3.0-de-records.json.br +++ b/lib/search/indexes/github-docs-3.0-de-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:530e94e05aac5a970ccf27b5d68f70980f8bc9883afe53f34e2c115f2ddeac88 -size 490167 +oid sha256:c59bc0b9c7c2e40ff0af3bd67048407f025d6c4670811fca90eeafbbb6669f21 +size 490170 diff --git a/lib/search/indexes/github-docs-3.0-de.json.br b/lib/search/indexes/github-docs-3.0-de.json.br index bf6bba1296..2d42731629 100644 --- a/lib/search/indexes/github-docs-3.0-de.json.br +++ b/lib/search/indexes/github-docs-3.0-de.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:5712cbf7cbfae99ca1e88e1322536df21d760d08e71864c5211375b2a94418e6 -size 2179478 +oid sha256:77411c5a995f27c642f14a4335eb08e3b395577e8459fb7c2f52628c89cb55fd +size 2179605 diff --git a/lib/search/indexes/github-docs-3.0-en-records.json.br b/lib/search/indexes/github-docs-3.0-en-records.json.br index 6896beca94..8795572c2d 100644 --- a/lib/search/indexes/github-docs-3.0-en-records.json.br +++ b/lib/search/indexes/github-docs-3.0-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:84e3471ab39e048861839b4e455feb01ec2728ff790c3943ca3797fa076b2380 -size 452915 +oid sha256:1cbe385b0dd32e3038ded77609e178bb6bbebd7f8ce4f518d85fe8c97c995ab7 +size 450465 diff --git a/lib/search/indexes/github-docs-3.0-en.json.br b/lib/search/indexes/github-docs-3.0-en.json.br index 998d99d73c..409c638e74 100644 --- a/lib/search/indexes/github-docs-3.0-en.json.br +++ b/lib/search/indexes/github-docs-3.0-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:b4c243c7614e4b8133ae769b6c533061c81f77c06c69ce13c1f98c2c8601e1e4 -size 1771611 +oid sha256:10bca82dc575076ef3e2facac01720c9793c5db9e847b169ced2aabfcd54ef11 +size 1753339 diff --git a/lib/search/indexes/github-docs-3.0-es-records.json.br b/lib/search/indexes/github-docs-3.0-es-records.json.br index 25c70720dd..c8a73f70ad 100644 --- a/lib/search/indexes/github-docs-3.0-es-records.json.br +++ b/lib/search/indexes/github-docs-3.0-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:4dde80dbb4e91344f9f02ce20097c4a704f740e94e27cef80c0371bec4e2aa3b -size 278305 +oid sha256:891766fb76e13bd1ab51d9c5f2da111f279ecb2afba9f79f5cf87d12a53dfaec +size 278067 diff --git a/lib/search/indexes/github-docs-3.0-es.json.br b/lib/search/indexes/github-docs-3.0-es.json.br index 5d2e04aaaa..48dcc47769 100644 --- a/lib/search/indexes/github-docs-3.0-es.json.br +++ b/lib/search/indexes/github-docs-3.0-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:780d84efbcd768dbfa8c12f0d449c8504c5ada23c10d7c8b681da9941da935a3 -size 1055590 +oid sha256:6a0805a972017cfbfdecc8ba65ee0cbb3ceacd8812a896e56021668c43103517 +size 1055602 diff --git a/lib/search/indexes/github-docs-3.0-ja-records.json.br b/lib/search/indexes/github-docs-3.0-ja-records.json.br index 133f3e459e..37e943a88d 100644 --- a/lib/search/indexes/github-docs-3.0-ja-records.json.br +++ b/lib/search/indexes/github-docs-3.0-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:b23b22b080c4f5a47d66143cea5b70eafc6ceb506b1cafc7aa8ac96dcc870595 -size 550555 +oid sha256:b08e0c057378c30c628eaef80a52ca1ba25ff70ca3e026dbbd786c89818973e7 +size 550430 diff --git a/lib/search/indexes/github-docs-3.0-ja.json.br b/lib/search/indexes/github-docs-3.0-ja.json.br index 71306a254a..207fda33ae 100644 --- a/lib/search/indexes/github-docs-3.0-ja.json.br +++ b/lib/search/indexes/github-docs-3.0-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:cc5e326fa69cc8042eef6375de83e8d202e2e1027927a718b1adcf7a5d27415f -size 2912395 +oid sha256:f0d42a5d19b8908dc9128819e69c7af76fe590ff168feb414adab2471869f4b6 +size 2911557 diff --git a/lib/search/indexes/github-docs-3.0-pt-records.json.br b/lib/search/indexes/github-docs-3.0-pt-records.json.br index ec7c5406aa..c6e4dab85a 100644 --- a/lib/search/indexes/github-docs-3.0-pt-records.json.br +++ b/lib/search/indexes/github-docs-3.0-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:be0d768509cada34e921f5952be360614b6889eb529a2516f857b8d00d481e91 -size 464691 +oid sha256:bde36dd1cbb1d4f0608b9c91af50cc6a8f61053685fc914cad07e64f67cc4947 +size 465138 diff --git a/lib/search/indexes/github-docs-3.0-pt.json.br b/lib/search/indexes/github-docs-3.0-pt.json.br index f6f4df9198..038e78597c 100644 --- a/lib/search/indexes/github-docs-3.0-pt.json.br +++ b/lib/search/indexes/github-docs-3.0-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:24333571c619355438a9374576bab25a098057c43756d4cfceb3bec43d4e0035 -size 1937314 +oid sha256:905da4fd7da7ace8380b2817baa150083f2e377d5982941b6fe1df5ce5b346b3 +size 1938872 diff --git a/lib/search/indexes/github-docs-3.1-cn-records.json.br b/lib/search/indexes/github-docs-3.1-cn-records.json.br index be5dc6ab04..6ad7174d51 100644 --- a/lib/search/indexes/github-docs-3.1-cn-records.json.br +++ b/lib/search/indexes/github-docs-3.1-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:c6767750ed46a38ef4ed2729f639c763e19c919d0f040790cfcf466695d9ca45 -size 534045 +oid sha256:1e6f2554236188b1ad0b464ed67c8b37aa812046728a628c0dc1518fed9acade +size 534022 diff --git a/lib/search/indexes/github-docs-3.1-cn.json.br b/lib/search/indexes/github-docs-3.1-cn.json.br index 1bebd6b2de..0c1137b089 100644 --- a/lib/search/indexes/github-docs-3.1-cn.json.br +++ b/lib/search/indexes/github-docs-3.1-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:1bfe35b3d0590cb1ca43466f9ff830f79756d7c182c20adcad44cbd1625654fd -size 846317 +oid sha256:7245b8142520afb439d70a05bed0ac9c00fb4855224bfe2f5698b8e3432d5720 +size 846470 diff --git a/lib/search/indexes/github-docs-3.1-de-records.json.br b/lib/search/indexes/github-docs-3.1-de-records.json.br index 632eb2e387..fdc29f8d22 100644 --- a/lib/search/indexes/github-docs-3.1-de-records.json.br +++ b/lib/search/indexes/github-docs-3.1-de-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:4f60c5dfd4182ebd967320a380c02e3e4cbe61a00709063d0b9bcc7ed8bec4fd -size 497244 +oid sha256:525dcd964b4f78e8836ae988ed941829775d3772d7aaa411c34a9e90b839f06b +size 497382 diff --git a/lib/search/indexes/github-docs-3.1-de.json.br b/lib/search/indexes/github-docs-3.1-de.json.br index 60c5826b19..965d0235ee 100644 --- a/lib/search/indexes/github-docs-3.1-de.json.br +++ b/lib/search/indexes/github-docs-3.1-de.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:ad0e2da95a0782b82f7169a03787baa5ade24ce83ce25360e26a9193c2ccc8e8 -size 2220686 +oid sha256:38217ab77e2c5affa2c556fc8f761f5478956e3a0ba52ba94fbd17b276f1dc16 +size 2221104 diff --git a/lib/search/indexes/github-docs-3.1-en-records.json.br b/lib/search/indexes/github-docs-3.1-en-records.json.br index 546f56159e..e3cff438ca 100644 --- a/lib/search/indexes/github-docs-3.1-en-records.json.br +++ b/lib/search/indexes/github-docs-3.1-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:b25993f7eeb4f63e2b00eaaacf824b4b4838c06b4b1ed5cf8ab2d6d3e9bc93b7 -size 461101 +oid sha256:470f1bf8b18dd8a0793e86094e9ceb3e8998278d8dc305d0c1fa032ccabe6d97 +size 457974 diff --git a/lib/search/indexes/github-docs-3.1-en.json.br b/lib/search/indexes/github-docs-3.1-en.json.br index 3ebb33eed1..396cc775f8 100644 --- a/lib/search/indexes/github-docs-3.1-en.json.br +++ b/lib/search/indexes/github-docs-3.1-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:02a572d43fb3755b64e8cba9d319081b975fea9448168c1a81cacdf5b848132b -size 1807831 +oid sha256:dc13e93ca327319bb14eddc3f6a4cc4cd99c694f4ae8308666627047c952bd93 +size 1790177 diff --git a/lib/search/indexes/github-docs-3.1-es-records.json.br b/lib/search/indexes/github-docs-3.1-es-records.json.br index 80909b8b49..8cb7832ab6 100644 --- a/lib/search/indexes/github-docs-3.1-es-records.json.br +++ b/lib/search/indexes/github-docs-3.1-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:7bc202a4e0ee4b99e34ab457591fd1f09332ac707a44dc98d3b7488b8c2d8eb3 -size 279027 +oid sha256:fa4df20362d65d9b914f4528bd3819ae2447ea68ab8e19ee355421d4d4d5130c +size 278474 diff --git a/lib/search/indexes/github-docs-3.1-es.json.br b/lib/search/indexes/github-docs-3.1-es.json.br index d19f6ccb8a..87141273b1 100644 --- a/lib/search/indexes/github-docs-3.1-es.json.br +++ b/lib/search/indexes/github-docs-3.1-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:fca07ea0a68dfc4ba31846ae694ce9ed4f11071c1fc76a67b2753b96de9da988 -size 1058903 +oid sha256:171dfeedbe76a19fe8149aba5255ae5f5ffa4213d6bb4a4a9b40cae8501f967d +size 1058018 diff --git a/lib/search/indexes/github-docs-3.1-ja-records.json.br b/lib/search/indexes/github-docs-3.1-ja-records.json.br index 68a1fe934b..2976d6823b 100644 --- a/lib/search/indexes/github-docs-3.1-ja-records.json.br +++ b/lib/search/indexes/github-docs-3.1-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:70fc0c1a94863a41ef763fdf6cd9cf285ffc43ce26f8cb942afc6f01497b7ad1 -size 558756 +oid sha256:f4e2cf4304ca83394b8bdc96d4072fabc88df588658686b2ce99b24620961c33 +size 558912 diff --git a/lib/search/indexes/github-docs-3.1-ja.json.br b/lib/search/indexes/github-docs-3.1-ja.json.br index 3195c3b37f..0313d40212 100644 --- a/lib/search/indexes/github-docs-3.1-ja.json.br +++ b/lib/search/indexes/github-docs-3.1-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:04a69a38c6922f822c0aeec1159b06c45ef005e72cd713006ef1a56e01ef4820 -size 2964921 +oid sha256:fb8e1d8d95707112892ca98f1d07234fe4ae849c968945154db35c936a6f43cf +size 2964925 diff --git a/lib/search/indexes/github-docs-3.1-pt-records.json.br b/lib/search/indexes/github-docs-3.1-pt-records.json.br index 1c022d9769..261fc3e4c6 100644 --- a/lib/search/indexes/github-docs-3.1-pt-records.json.br +++ b/lib/search/indexes/github-docs-3.1-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:e65a2c596db2358af50eed6568585118b23102570a7d9444221fbfa1284c22c8 -size 472197 +oid sha256:f0248591b2d6d5e3f1267427a55e4d69ade392e44e9dedc60666974692a4c306 +size 472434 diff --git a/lib/search/indexes/github-docs-3.1-pt.json.br b/lib/search/indexes/github-docs-3.1-pt.json.br index a199999b3e..ae717aa05a 100644 --- a/lib/search/indexes/github-docs-3.1-pt.json.br +++ b/lib/search/indexes/github-docs-3.1-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:bc23691de5da8857fb0d1a7e933599356b085b45c84677cfc52aa195d7bf0ab8 -size 1972384 +oid sha256:22a2193887b30ded903da7c460e35659af5698505f4cdc986e613d1ebd49d91c +size 1973011 diff --git a/lib/search/indexes/github-docs-3.2-cn-records.json.br b/lib/search/indexes/github-docs-3.2-cn-records.json.br index 84b5bb0b7e..597e4f8eef 100644 --- a/lib/search/indexes/github-docs-3.2-cn-records.json.br +++ b/lib/search/indexes/github-docs-3.2-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:1b87a0876ddd5ea44c51fb6ecdd3d30db3bd4e998a14ad6001b9d3a04d6e895f -size 539765 +oid sha256:b7751d5da581e44b327f9541dfdda0ad77fcd833cc4c5da784d3acb8c79bcfcf +size 539867 diff --git a/lib/search/indexes/github-docs-3.2-cn.json.br b/lib/search/indexes/github-docs-3.2-cn.json.br index 3188d1c1de..80aaf8787b 100644 --- a/lib/search/indexes/github-docs-3.2-cn.json.br +++ b/lib/search/indexes/github-docs-3.2-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:49ad83d255d2f43f545bc63494d289c7296d292e03fe3f0345781a5553fa3644 -size 853676 +oid sha256:cdd1c3a1cca23dd48000892f0d7fa86a798b47b2d1d44caa865694f80e43fdb6 +size 853712 diff --git a/lib/search/indexes/github-docs-3.2-de-records.json.br b/lib/search/indexes/github-docs-3.2-de-records.json.br index d50ac1dffd..760eb025e2 100644 --- a/lib/search/indexes/github-docs-3.2-de-records.json.br +++ b/lib/search/indexes/github-docs-3.2-de-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:ab96684e9258b9e959d7086d48bb4e45409536d2e8353fcf31f8aa042af2ff72 -size 501949 +oid sha256:0637c587b11f540d91db69cd96c819e4d908c41497877c61d8b891596804d4ae +size 501588 diff --git a/lib/search/indexes/github-docs-3.2-de.json.br b/lib/search/indexes/github-docs-3.2-de.json.br index 221290cd98..64ed96d7ab 100644 --- a/lib/search/indexes/github-docs-3.2-de.json.br +++ b/lib/search/indexes/github-docs-3.2-de.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:976d0292f977214113a2d3ccadd218da35542ee08bcba83291a0acf4caf78f90 -size 2245175 +oid sha256:9c7188e02c0fdfc82a4c9c1a4587c91e9c7e4ba032a90d87d078bbab660d9953 +size 2244973 diff --git a/lib/search/indexes/github-docs-3.2-en-records.json.br b/lib/search/indexes/github-docs-3.2-en-records.json.br index 0a8530bd40..58ffa14de1 100644 --- a/lib/search/indexes/github-docs-3.2-en-records.json.br +++ b/lib/search/indexes/github-docs-3.2-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:3a9ddfdf9a3e0d3995f32a0773b7931e87aacf0639559d465923f43b653a1c1f -size 470173 +oid sha256:757072c609cfc2dd212cfe25d1a4baf9d4de96444e1ef8f56c647f6b0ac7a413 +size 467619 diff --git a/lib/search/indexes/github-docs-3.2-en.json.br b/lib/search/indexes/github-docs-3.2-en.json.br index e8ace72fac..86729b2dbd 100644 --- a/lib/search/indexes/github-docs-3.2-en.json.br +++ b/lib/search/indexes/github-docs-3.2-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:442f3c62143fd7fa43048f31b281967586e7d09309a824951eedc4616aa8cca4 -size 1839818 +oid sha256:c4d4530d074d40d72680db45ad942a01ef6982186ceec78cafee65cc8921bcad +size 1822146 diff --git a/lib/search/indexes/github-docs-3.2-es-records.json.br b/lib/search/indexes/github-docs-3.2-es-records.json.br index 71cf46b200..bf079b56a0 100644 --- a/lib/search/indexes/github-docs-3.2-es-records.json.br +++ b/lib/search/indexes/github-docs-3.2-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:8d24f954a866429a5047c1e2679865120b678513235e2a6aaa06147cc910cc85 -size 278264 +oid sha256:8aaf55502562b0d0f6db1694150b221dcbc1e945e712033bdaa95abeb39cc704 +size 278416 diff --git a/lib/search/indexes/github-docs-3.2-es.json.br b/lib/search/indexes/github-docs-3.2-es.json.br index 01ffe30aa3..8f47868986 100644 --- a/lib/search/indexes/github-docs-3.2-es.json.br +++ b/lib/search/indexes/github-docs-3.2-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:416db2267bcf73740f493c148a50caef53987c6449cb8539692c4545baad4fd5 -size 1056838 +oid sha256:6534d5cde9c92ac5eb83eec98612914d87dfe0686f20716fa72408a3b30c30a0 +size 1057328 diff --git a/lib/search/indexes/github-docs-3.2-ja-records.json.br b/lib/search/indexes/github-docs-3.2-ja-records.json.br index ec46358c08..57636fc669 100644 --- a/lib/search/indexes/github-docs-3.2-ja-records.json.br +++ b/lib/search/indexes/github-docs-3.2-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:576b3f08f1290e545bd82065765c01e7938d9f148d6486220b589df3abfcb006 -size 564783 +oid sha256:757f1e3f57b426c360d22e8b2f0f93d76d929672b574f5122ddc80360fd5d420 +size 564816 diff --git a/lib/search/indexes/github-docs-3.2-ja.json.br b/lib/search/indexes/github-docs-3.2-ja.json.br index 0256e9028a..bb9a874b5e 100644 --- a/lib/search/indexes/github-docs-3.2-ja.json.br +++ b/lib/search/indexes/github-docs-3.2-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:52fa8f0a9c0b44bb228e25bb56978733a79fcdc12d6a834146b4a0fce06d963d -size 2998316 +oid sha256:4b08dd0d62359690bbf92261d820f77e4ce8ef65c7363ca34ebaa7f163f3883a +size 2997197 diff --git a/lib/search/indexes/github-docs-3.2-pt-records.json.br b/lib/search/indexes/github-docs-3.2-pt-records.json.br index a973bdc3e2..0416c14059 100644 --- a/lib/search/indexes/github-docs-3.2-pt-records.json.br +++ b/lib/search/indexes/github-docs-3.2-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:ad03e0ef3208dc8e2b68b30c2276879a62de16097e90da0676411daf9e8e2bc7 -size 477161 +oid sha256:ba11b3a753d5ad72b941618c29256483fe1d90c4611dfa0b2f2aae71d092b78b +size 476867 diff --git a/lib/search/indexes/github-docs-3.2-pt.json.br b/lib/search/indexes/github-docs-3.2-pt.json.br index 54d08fe50d..eb08414690 100644 --- a/lib/search/indexes/github-docs-3.2-pt.json.br +++ b/lib/search/indexes/github-docs-3.2-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:9a74b8a1555cb72016c9031d73809c50951a77a7874ffed84f95fe988cd8bbaf -size 1996991 +oid sha256:c061ef8fc4b499f8f52ad8367cc3aee53bce3554331c0d9ee5ea3a3e6a6e320a +size 1995061 diff --git a/lib/search/indexes/github-docs-dotcom-cn-records.json.br b/lib/search/indexes/github-docs-dotcom-cn-records.json.br index 0d0c5d95f9..7ffb0f8896 100644 --- a/lib/search/indexes/github-docs-dotcom-cn-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:360889f10f4a4ff31b9842dab09e0defce21ed6b55ab8fc3089aad82dfde52fc -size 695805 +oid sha256:d992082947eb2d378e268605fb4f957d1096909d93382817f741ded7c23ea63a +size 695852 diff --git a/lib/search/indexes/github-docs-dotcom-cn.json.br b/lib/search/indexes/github-docs-dotcom-cn.json.br index c9f0150bf8..08c2fdc96b 100644 --- a/lib/search/indexes/github-docs-dotcom-cn.json.br +++ b/lib/search/indexes/github-docs-dotcom-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:c39acc84340b8b3abffd30bfd3554e51a78acc0198eafdce8848a17af0eaf820 -size 947342 +oid sha256:b7662f6931eff1714b082ad1b7934bf91508fc1fbf803e8ee41b0d9fec4fc839 +size 947171 diff --git a/lib/search/indexes/github-docs-dotcom-de-records.json.br b/lib/search/indexes/github-docs-dotcom-de-records.json.br index c5749e86ee..cd407d4f64 100644 --- a/lib/search/indexes/github-docs-dotcom-de-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-de-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:893e0ae78389905cab1bc41c0543cf1350e9383a0f4aadea736695d64e611a4d -size 634035 +oid sha256:a66cfb228bbaf87ec18d5a6c9aa1cd0c6f05e024af65ad9453e2d40b0efe9972 +size 633933 diff --git a/lib/search/indexes/github-docs-dotcom-de.json.br b/lib/search/indexes/github-docs-dotcom-de.json.br index 5e9ce82f2c..c689421fc9 100644 --- a/lib/search/indexes/github-docs-dotcom-de.json.br +++ b/lib/search/indexes/github-docs-dotcom-de.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:9060d29d5927436064381a99bacbf3b7378ba9ca6d084a0aa3490de2a80b44f6 -size 2819933 +oid sha256:1539d12aa73db3ae92ddfca0fdc581ea1eb7405dc894cd99bb9b1c39d08d6447 +size 2821423 diff --git a/lib/search/indexes/github-docs-dotcom-en-records.json.br b/lib/search/indexes/github-docs-dotcom-en-records.json.br index 3541c0e186..ac9f6885c4 100644 --- a/lib/search/indexes/github-docs-dotcom-en-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:fd81ed5d96104b14564f586451019d60d107d0f212c4f8a19d02dc754e8fb7c5 -size 626089 +oid sha256:252cf70f1b2b9116f82b9aa8d206a8fc6c8e8e57f3891b104979e1323a441250 +size 623296 diff --git a/lib/search/indexes/github-docs-dotcom-en.json.br b/lib/search/indexes/github-docs-dotcom-en.json.br index 65e143dc7e..73d500d93e 100644 --- a/lib/search/indexes/github-docs-dotcom-en.json.br +++ b/lib/search/indexes/github-docs-dotcom-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:9b31f595a2d447038481634f0f3a4d5a3479ea074b85cee489f231bed402faae -size 2385594 +oid sha256:4f43f48a321a70cc4fb0c0aee1c4eab595c8e0353c5a1c9e92703fabb9406c94 +size 2367282 diff --git a/lib/search/indexes/github-docs-dotcom-es-records.json.br b/lib/search/indexes/github-docs-dotcom-es-records.json.br index 9862c314cb..c2675320c0 100644 --- a/lib/search/indexes/github-docs-dotcom-es-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:3b421b24f92f50abf3668a5b983a276d7de3c7dca1435ba55b6901b9271e9803 -size 307199 +oid sha256:f6aa26306cb4ce332fc59ce406c1e011ae94c78b267aa6622f7b9d852d279c39 +size 306777 diff --git a/lib/search/indexes/github-docs-dotcom-es.json.br b/lib/search/indexes/github-docs-dotcom-es.json.br index 9610dca79a..8e1c87da72 100644 --- a/lib/search/indexes/github-docs-dotcom-es.json.br +++ b/lib/search/indexes/github-docs-dotcom-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:6a2633959ca32d28f40e897041ac9b184afc1033cfab2e2f7fc9ffbf389d9a47 -size 1090519 +oid sha256:e806e75e0514840f6d270c0743d23a7d176c189502bf6fb39ce00aef7a73a15d +size 1088707 diff --git a/lib/search/indexes/github-docs-dotcom-ja-records.json.br b/lib/search/indexes/github-docs-dotcom-ja-records.json.br index acf1a152fa..7a510862b4 100644 --- a/lib/search/indexes/github-docs-dotcom-ja-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:546729472f730dc856a72aaa968d0051eea0e41fce78eb1fa8d51d01fc58d8cb -size 723488 +oid sha256:30229d5675abb0931a78dfbd8eaf98cdc2ddbea5f2238fd2b7d183418a27d4f9 +size 724204 diff --git a/lib/search/indexes/github-docs-dotcom-ja.json.br b/lib/search/indexes/github-docs-dotcom-ja.json.br index 7cce2806e2..8d3894a082 100644 --- a/lib/search/indexes/github-docs-dotcom-ja.json.br +++ b/lib/search/indexes/github-docs-dotcom-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:9b181f2085fb01c0e78139f7ed337cc37ef1e2220034a89f00a588b229c9db2e -size 3756880 +oid sha256:e17a8e2a9acb187da6625f0d00edb76c04116505afd21dd0965cd4bc90a773b9 +size 3757076 diff --git a/lib/search/indexes/github-docs-dotcom-pt-records.json.br b/lib/search/indexes/github-docs-dotcom-pt-records.json.br index 7db34af320..8c5c9e2b8d 100644 --- a/lib/search/indexes/github-docs-dotcom-pt-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:74e48571215e35b5b61b31e81ff35683984c196fb4207ee7de9731bbe8010119 -size 608040 +oid sha256:e14ba9d03c5cc142d8ef25cf8af30007e48bda837f2b6bb398a275c819ed3bbd +size 607422 diff --git a/lib/search/indexes/github-docs-dotcom-pt.json.br b/lib/search/indexes/github-docs-dotcom-pt.json.br index 8daae2ad2a..5611765558 100644 --- a/lib/search/indexes/github-docs-dotcom-pt.json.br +++ b/lib/search/indexes/github-docs-dotcom-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:2909390b5e678c86a04f936fd81ddaa040d354999cbe27942c7420f11633899d -size 2489714 +oid sha256:494f1a6a72eed1d90bdb9a0e762eb229ae880fe03ac4df53725987e5cd2e3875 +size 2489475 diff --git a/lib/search/indexes/github-docs-ghae-cn-records.json.br b/lib/search/indexes/github-docs-ghae-cn-records.json.br index 2d0efa21b4..1c13e4e564 100644 --- a/lib/search/indexes/github-docs-ghae-cn-records.json.br +++ b/lib/search/indexes/github-docs-ghae-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:42a14ef9f56c3d07c6b6f384f69a85bd3d24ccb78bfebfd3076b90df2046f53d -size 414650 +oid sha256:6fb9694e4828537cb882f9743053fc63e5d03234be0e2419e9ee4bcb225f7ab4 +size 414200 diff --git a/lib/search/indexes/github-docs-ghae-cn.json.br b/lib/search/indexes/github-docs-ghae-cn.json.br index fb2ee6448f..ed674a0ec0 100644 --- a/lib/search/indexes/github-docs-ghae-cn.json.br +++ b/lib/search/indexes/github-docs-ghae-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:197fe8c661d858e9008749af9885cdcd8c9d8c03b8d77a6dd0c85d9aa9c308aa -size 631854 +oid sha256:8ec31c544ed988b3f04e39060997c5eccbb48284040a6643d36ebc170c54e581 +size 630440 diff --git a/lib/search/indexes/github-docs-ghae-de-records.json.br b/lib/search/indexes/github-docs-ghae-de-records.json.br index f933b09a2b..fa00ec88c1 100644 --- a/lib/search/indexes/github-docs-ghae-de-records.json.br +++ b/lib/search/indexes/github-docs-ghae-de-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:556469b7a73e52272446d56e3e5f3244704f7eb58ee917072c31d17376a56c25 -size 391137 +oid sha256:aeffbdd6c27373217db3fffdc51868871eaa8f0afac832541e42e586ed1120e7 +size 390817 diff --git a/lib/search/indexes/github-docs-ghae-de.json.br b/lib/search/indexes/github-docs-ghae-de.json.br index c4073dcb6b..3cae34f083 100644 --- a/lib/search/indexes/github-docs-ghae-de.json.br +++ b/lib/search/indexes/github-docs-ghae-de.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:fb99a42a883709d122f46a2aed99f6e41b902df4abeeb7a4f1067a46bae712c3 -size 1700292 +oid sha256:f238f801d68a49b89ec520680c96d35fedd227c11f1b2e1ea34a42b255a33193 +size 1698828 diff --git a/lib/search/indexes/github-docs-ghae-en-records.json.br b/lib/search/indexes/github-docs-ghae-en-records.json.br index 6fb5ae5257..5253c7d36a 100644 --- a/lib/search/indexes/github-docs-ghae-en-records.json.br +++ b/lib/search/indexes/github-docs-ghae-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:498fbdcb4e0c4ecc413de5b97f3cdab92a80b7f54df424d3fcf48bfe4c289d67 -size 361653 +oid sha256:37c76cf94eccb2f38694b23fc9507ba2b014153978d3087a0c9158628967cfc5 +size 359158 diff --git a/lib/search/indexes/github-docs-ghae-en.json.br b/lib/search/indexes/github-docs-ghae-en.json.br index 885a80a826..b12da0b346 100644 --- a/lib/search/indexes/github-docs-ghae-en.json.br +++ b/lib/search/indexes/github-docs-ghae-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:3c071bc70f2bcfccc034e495a5601ad460a4428febfc707e232669360aa40516 -size 1355790 +oid sha256:290be5d8543994de39e41aa70f2b6d46483a67d5690c02549c946f258e7e9a5e +size 1339021 diff --git a/lib/search/indexes/github-docs-ghae-es-records.json.br b/lib/search/indexes/github-docs-ghae-es-records.json.br index 995867db82..421dc0c4da 100644 --- a/lib/search/indexes/github-docs-ghae-es-records.json.br +++ b/lib/search/indexes/github-docs-ghae-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:c689457c2e7bdd4a83eb198d730c87d3209bae14175e810d1da70e01b3ece582 -size 201017 +oid sha256:ae693a3a2d5b0ac0f63203e080595c44e18a534218e449461cd00aba2d9965fe +size 200653 diff --git a/lib/search/indexes/github-docs-ghae-es.json.br b/lib/search/indexes/github-docs-ghae-es.json.br index a103976f41..0c29e6f81c 100644 --- a/lib/search/indexes/github-docs-ghae-es.json.br +++ b/lib/search/indexes/github-docs-ghae-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:6a929afbd00c65b25f5488d8e3a8c13c3c604395cd77b9675b4d3cbdcd03d315 -size 718717 +oid sha256:8088afc9f8d176551204256cde6ff939bd80cd261e7d5eff9d66a97ecde8660c +size 718269 diff --git a/lib/search/indexes/github-docs-ghae-ja-records.json.br b/lib/search/indexes/github-docs-ghae-ja-records.json.br index cad30595d2..e987209149 100644 --- a/lib/search/indexes/github-docs-ghae-ja-records.json.br +++ b/lib/search/indexes/github-docs-ghae-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:974f09881ceeb896ea2ffe3b00a4bbd5d73cc0fcca291810cd3b816de607df2b -size 435203 +oid sha256:3ba2f6c2892769ddeb6b366ee1c58bad50f7a3649cc13f2cf3abef108815432e +size 435317 diff --git a/lib/search/indexes/github-docs-ghae-ja.json.br b/lib/search/indexes/github-docs-ghae-ja.json.br index d8ceda17d2..1733cfaca7 100644 --- a/lib/search/indexes/github-docs-ghae-ja.json.br +++ b/lib/search/indexes/github-docs-ghae-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:4f54eaa82e92ccc69e07343dc61c3b796115649a84c28beaff26b9d414933fc8 -size 2215357 +oid sha256:cdcc7ca23803b7c7634129fd01d01be7dc413fce0cc4de849c38196fba0863a9 +size 2216972 diff --git a/lib/search/indexes/github-docs-ghae-pt-records.json.br b/lib/search/indexes/github-docs-ghae-pt-records.json.br index f2242bc74b..08169ec258 100644 --- a/lib/search/indexes/github-docs-ghae-pt-records.json.br +++ b/lib/search/indexes/github-docs-ghae-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:a421e496dda05d60e5637ddd0ec416257195b94081fb0d6008dd73fed8a0032d -size 371680 +oid sha256:353a34ddb0ec17d6eb72494dfb1be866a703d24716736fffd7ea47ad08674901 +size 371692 diff --git a/lib/search/indexes/github-docs-ghae-pt.json.br b/lib/search/indexes/github-docs-ghae-pt.json.br index d49c75299d..95777085c9 100644 --- a/lib/search/indexes/github-docs-ghae-pt.json.br +++ b/lib/search/indexes/github-docs-ghae-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:50209fd796fdb5cab033ba3b3e7e500fef4db3c88c47ae1b69c9b90344cff247 -size 1496665 +oid sha256:69d6ada6f6acef53417433194091b517a80ca1236c41af3f2354f625767c6065 +size 1496787 diff --git a/script/deployment/create-app.js b/script/deployment/create-app.js index 3b01b6ab0c..ce5fc7bef0 100644 --- a/script/deployment/create-app.js +++ b/script/deployment/create-app.js @@ -7,7 +7,10 @@ export default async function createApp(pullRequest) { const { number: pullNumber, base: { - repo: { name: repo }, + repo: { + name: repo, + owner: { login: owner }, + }, }, head: { ref: branch }, user: author, @@ -15,6 +18,20 @@ export default async function createApp(pullRequest) { const appName = createAppName({ prefix: 'ghd', repo, pullNumber, branch }) + // Put together application configuration variables + const isPrivateRepo = owner === 'github' && repo === 'docs-internal' + const { HYDRO_ENDPOINT, HYDRO_SECRET } = process.env + const appConfigVars = { + // These values are usually set in app.json but we need to set them + // ourselves for Docker image deployment. + NODE_ENV: 'production', + ENABLED_LANGUAGES: 'en', + WEB_CONCURRENCY: '1', + // IMPORTANT: These secrets should only be set in the private repo! + // These are required for Hydro event tracking + ...(isPrivateRepo && HYDRO_ENDPOINT && HYDRO_SECRET && { HYDRO_ENDPOINT, HYDRO_SECRET }), + } + // Check if there's already a Heroku App for this PR, if not create one let appExists = true const heroku = new Heroku({ token: process.env.HEROKU_API_TOKEN }) @@ -58,5 +75,15 @@ export default async function createApp(pullRequest) { console.log(`Heroku App ${appName} already exists.`) } + // Set/reconfigure environment variables + // https://devcenter.heroku.com/articles/platform-api-reference#config-vars-update + try { + await heroku.patch(`/apps/${appName}/config-vars`, { + body: appConfigVars, + }) + } catch (error) { + throw new Error(`Failed to update Heroku app configuration variables. Error: ${error}`) + } + return appName } diff --git a/script/deployment/deploy-to-staging-docker.js b/script/deployment/deploy-to-staging-docker.js index 507ee3f69b..447ed410c9 100644 --- a/script/deployment/deploy-to-staging-docker.js +++ b/script/deployment/deploy-to-staging-docker.js @@ -89,9 +89,6 @@ export default async function deployToStaging({ // For our many staging apps, we must use the unique appName as the environment. environment: appName, - // Indicate this environment will no longer exist at some point in the future. - transient_environment: true, - // The status contexts to verify against commit status checks. If you omit // this parameter, GitHub verifies all unique contexts before creating a // deployment. To bypass checking entirely, pass an empty array. Defaults @@ -504,7 +501,10 @@ export default async function deployToStaging({ try { await got(homepageUrl, { timeout: 10000, // Maximum 10 second timeout per request - retry: 7, // About 2 minutes 7 seconds of delay, plus active request time for 8 requests + retry: { + limit: 7, // About 2 minutes 7 seconds of delay, plus active request time for 8 requests + statusCodes: [404].concat(got.defaults.options.retry.statusCodes), // 404 is extra + }, hooks: { beforeRetry: [ (options, error = {}, retryCount = '?') => { diff --git a/script/deployment/deploy-to-staging.js b/script/deployment/deploy-to-staging.js index 58c2337971..91e11352ea 100644 --- a/script/deployment/deploy-to-staging.js +++ b/script/deployment/deploy-to-staging.js @@ -90,9 +90,6 @@ export default async function deployToStaging({ // For our many staging apps, we must use the unique appName as the environment. environment: appName, - // Indicate this environment will no longer exist at some point in the future. - transient_environment: true, - // The status contexts to verify against commit status checks. If you omit // this parameter, GitHub verifies all unique contexts before creating a // deployment. To bypass checking entirely, pass an empty array. Defaults @@ -511,7 +508,10 @@ export default async function deployToStaging({ try { await got(homepageUrl, { timeout: 10000, // Maximum 10 second timeout per request - retry: 7, // About 2 minutes 7 seconds of delay, plus active request time for 8 requests + retry: { + limit: 7, // About 2 minutes 7 seconds of delay, plus active request time for 8 requests + statusCodes: [404].concat(got.defaults.options.retry.statusCodes), // 404 is extra + }, hooks: { beforeRetry: [ (options, error = {}, retryCount = '?') => { diff --git a/script/deployment/undeploy-from-staging.js b/script/deployment/undeploy-from-staging.js index 3fa614550c..6241115c22 100644 --- a/script/deployment/undeploy-from-staging.js +++ b/script/deployment/undeploy-from-staging.js @@ -21,6 +21,7 @@ export default async function undeployFromStaging({ }, }, head: { ref: branch }, + merged: wasMerged, } = pullRequest const workflowRunLog = runId ? `https://github.com/${owner}/${repo}/actions/runs/${runId}` : null @@ -55,45 +56,71 @@ export default async function undeployFromStaging({ } } - // Get the latest deployment environment to signal its deactivation - const { data: deployments } = await octokit.repos.listDeployments({ - owner, - repo, - - // In the GitHub API, there can only be one active deployment per environment. - // For our many staging apps, we must use the unique appName as the environment. - environment: appName, - }) - - if (deployments.length === 0) { - console.log('🚀 No deployments to deactivate!') - console.log( - `Finished undeploying after ${Math.round((Date.now() - startTime) / 1000)} seconds` - ) - return - } - - console.log(`Found ${deployments.length} GitHub Deployments`, deployments) - - // Deactivate ALL of the deployments - for (const deployment of deployments) { - const { data: deploymentStatus } = await octokit.repos.createDeploymentStatus({ + // If not merged, we'll leave it to be cleaned up later by the workflow + // that checks for stale PRs. This way, we aren't doing more cleaning than + // necessary if someone intends to reopen the PR momentarily. + if (wasMerged) { + // Get the latest deployment environment to signal its deactivation + const { data: deployments } = await octokit.repos.listDeployments({ owner, repo, - deployment_id: deployment.id, - state: 'inactive', - description: 'The app was undeployed', - ...(logUrl && { log_url: logUrl }), - // The 'ant-man' preview is required for `state` values of 'inactive', as well as - // the use of the `log_url`, `environment_url`, and `auto_inactive` parameters. - // The 'flash' preview is required for `state` values of 'in_progress' and 'queued'. - mediaType: { - previews: ['ant-man', 'flash'], - }, + + // In the GitHub API, there can only be one active deployment per environment. + // For our many staging apps, we must use the unique appName as the environment. + environment: appName, }) - console.log( - `🚀 Deployment status (ID: ${deployment.id}): ${deploymentStatus.state} - ${deploymentStatus.description}` - ) + + if (deployments.length === 0) { + console.log('🚀 No deployments to deactivate!') + } else { + console.log(`Found ${deployments.length} GitHub Deployments`, deployments) + + // Deactivate ALL of the deployments + for (const deployment of deployments) { + // Deactivate this Deployment with an 'inactive' DeploymentStatus + const { data: deploymentStatus } = await octokit.repos.createDeploymentStatus({ + owner, + repo, + deployment_id: deployment.id, + state: 'inactive', + description: 'The app was undeployed', + ...(logUrl && { log_url: logUrl }), + // The 'ant-man' preview is required for `state` values of 'inactive', as well as + // the use of the `log_url`, `environment_url`, and `auto_inactive` parameters. + // The 'flash' preview is required for `state` values of 'in_progress' and 'queued'. + mediaType: { + previews: ['ant-man', 'flash'], + }, + }) + console.log( + `🚀 Deployment status (ID: ${deployment.id}): ${deploymentStatus.state} - ${deploymentStatus.description}` + ) + + // Delete this Deployment + await octokit.repos.deleteDeployment({ + owner, + repo, + deployment_id: deployment.id, + }) + console.log(`🚀 Deployment (ID: ${deployment.id}): deleted`) + } + } + + // Delete this Environment + try { + await octokit.repos.deleteAnEnvironment({ + owner, + repo, + environment_name: appName, + }) + console.log(`🚀 Environment (${appName}): deleted`) + } catch (error) { + if (error.status === 404) { + console.log(`🚀 Environment (${appName}): already deleted`) + } else { + throw error + } + } } console.log(`Finished undeploying after ${Math.round((Date.now() - startTime) / 1000)} seconds`) diff --git a/script/remove-stale-staging-envs.js b/script/remove-stale-staging-envs.js new file mode 100755 index 0000000000..1d40f98972 --- /dev/null +++ b/script/remove-stale-staging-envs.js @@ -0,0 +1,245 @@ +#!/usr/bin/env node + +// [start-readme] +// +// This script removes all stale GitHub deployment environments that outlasted +// the closure of their corresponding pull requests, or correspond to spammy +// pull requests. +// +// [end-readme] + +import dotenv from 'dotenv' +import chalk from 'chalk' +import getOctokit from './helpers/github.js' + +dotenv.config() + +// Check for required GitHub PAT +if (!process.env.GITHUB_TOKEN) { + console.error('Error! You must have a GITHUB_TOKEN environment variable for repo access.') + process.exit(1) +} + +if (!process.env.REPO) { + console.error('Error! You must have a REPO environment variable.') + process.exit(1) +} + +// This helper uses the `GITHUB_TOKEN` implicitly +const octokit = getOctokit() + +const protectedEnvNames = ['production'] +const maxEnvironmentsToProcess = 50 + +// How long must a PR be closed without being merged to be considered stale? +const ONE_HOUR = 60 * 60 * 1000 +const prClosureStaleTime = 2 * ONE_HOUR + +main() + +async function main() { + const owner = 'github' + const [repoOwner, repo] = (process.env.REPO || '').split('/') + + if (repoOwner !== owner) { + console.error(`Error! The repository owner must be "${owner}" but was "${repoOwner}".`) + process.exit(1) + } + + const prInfoMatch = /^(?:gha-|ghd-)?(?docs(?:-internal)?)-(?\d+)--.*$/ + const legacyPrInfoMatch = /^help-docs-pr-(?\d+)$/ + + let exceededLimit = false + let matchingCount = 0 + let staleCount = 0 + let spammyCount = 0 + const nonMatchingEnvNames = [] + + for await (const response of octokit.paginate.iterator(octokit.repos.getAllEnvironments, { + owner, + repo, + })) { + const { data: environments } = response + + const envsPlusPullIds = environments.map((env) => { + let match = prInfoMatch.exec(env.name) + let { repo: repoName, pullNumber } = (match || {}).groups || {} + + if (!match) { + match = legacyPrInfoMatch.exec(env.name) + if (match) { + repoName = repo + pullNumber = ((match || {}).groups || {}).pullNumber + } + } + + return { + env, + repo: repoName, + pullNumber: parseInt(pullNumber, 10) || null, + } + }) + + const envsWithPullIds = envsPlusPullIds.filter( + (eppi) => eppi.repo === repo && eppi.pullNumber > 0 + ) + matchingCount += envsWithPullIds.length + + nonMatchingEnvNames.push( + ...envsPlusPullIds + .filter((eppi) => !(eppi.repo && eppi.pullNumber > 0)) + .map((eppi) => eppi.env.name) + .filter((name) => !protectedEnvNames.includes(name)) + ) + + for (const ewpi of envsWithPullIds) { + const { isStale, isSpammy } = await assessPullRequest(ewpi.pullNumber) + + if (isSpammy) spammyCount++ + if (isStale) staleCount++ + + if (isSpammy || isStale) { + await deleteEnvironment(ewpi.env.name) + } + + if (spammyCount + staleCount >= maxEnvironmentsToProcess) { + exceededLimit = true + break + } + } + + if (exceededLimit) { + console.log( + '🛑', + chalk.bgRed(`STOP! Exceeded limit, halting after ${maxEnvironmentsToProcess}.`) + ) + break + } + } + + const counts = { + total: matchingCount, + alive: matchingCount - staleCount, + stale: { + total: staleCount, + spammy: spammyCount, + closed: staleCount - spammyCount, + }, + } + console.log(`🧮 COUNTS!\n${JSON.stringify(counts, null, 2)}`) + + const nonMatchingCount = nonMatchingEnvNames.length + if (nonMatchingCount > 0) { + console.log( + '⚠️ 👀', + chalk.yellow( + `Non-matching env names (${nonMatchingCount}):\n - ${nonMatchingEnvNames.join('\n - ')}` + ) + ) + } + + function displayParams(params) { + const { owner, repo, pull_number: pullNumber } = params + return `${owner}/${repo}#${pullNumber}` + } + + async function assessPullRequest(pullNumber) { + const params = { + owner, + repo, + pull_number: pullNumber, + } + + let isStale = false + let isSpammy = false + try { + const { data: pullRequest } = await octokit.pulls.get(params) + + if (pullRequest && pullRequest.state === 'closed') { + const isMerged = pullRequest.merged === true + const closureAge = Date.now() - Date.parse(pullRequest.closed_at) + isStale = isMerged || closureAge >= prClosureStaleTime + + if (isStale) { + console.debug(chalk.green(`STALE: ${displayParams(params)} is closed`)) + } else { + console.debug( + chalk.blue(`NOT STALE: ${displayParams(params)} is closed but not yet stale`) + ) + } + } + } catch (error) { + // Using a standard GitHub PAT, PRs from spammy users will respond as 404 + if (error.status === 404) { + isStale = true + isSpammy = true + console.debug(chalk.yellow(`STALE: ${displayParams(params)} is spammy or deleted`)) + } else { + console.debug(chalk.red(`ERROR: ${displayParams(params)} - ${error.message}`)) + } + } + + return { isStale, isSpammy } + } + + async function deleteEnvironment(envName) { + try { + // Get the latest deployment environment to signal its deactivation + const { data: deployments } = await octokit.repos.listDeployments({ + owner, + repo, + + // In the GitHub API, there can only be one active deployment per environment. + // For our many staging apps, we must use the unique appName as the environment. + environment: envName, + }) + + // Deactivate ALL of the deployments + for (const deployment of deployments) { + // Deactivate this Deployment with an 'inactive' DeploymentStatus + await octokit.repos.createDeploymentStatus({ + owner, + repo, + deployment_id: deployment.id, + state: 'inactive', + description: 'The app was undeployed', + // The 'ant-man' preview is required for `state` values of 'inactive', as well as + // the use of the `log_url`, `environment_url`, and `auto_inactive` parameters. + // The 'flash' preview is required for `state` values of 'in_progress' and 'queued'. + mediaType: { + previews: ['ant-man', 'flash'], + }, + }) + + // Delete this Deployment + await octokit.repos.deleteDeployment({ + owner, + repo, + deployment_id: deployment.id, + }) + } + + // Delete this Environment + try { + await octokit.repos.deleteAnEnvironment({ + owner, + repo, + environment_name: envName, + }) + } catch (error) { + if (error.status !== 404) { + throw error + } + } + + console.log('✅', chalk.green(`Removed stale deployment environment "${envName}"`)) + } catch (error) { + console.log( + '❌', + chalk.red( + `ERROR: Failed to remove stale deployment environment "${envName}" - ${error.message}` + ) + ) + } + } +} diff --git a/tests/rendering/header.js b/tests/rendering/header.js index 4eae1bbdec..bf2ec5dfdb 100644 --- a/tests/rendering/header.js +++ b/tests/rendering/header.js @@ -21,10 +21,12 @@ describe('header', () => { describe('language links', () => { test('lead to the same page in a different language', async () => { - const $ = await getDOM('/github/administering-a-repository/managing-a-branch-protection-rule') + const $ = await getDOM( + '/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule' + ) expect( $( - '[data-testid=language-picker] a[href="/ja/github/administering-a-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule"]' + '[data-testid=language-picker] a[href="/ja/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule"]' ).length ).toBe(1) }) @@ -131,7 +133,9 @@ describe('header', () => { describe('mobile-only product dropdown links', () => { test('include github and admin, and emphasize the current product', async () => { - const $ = await getDOM('/en/articles/enabling-required-status-checks') + const $ = await getDOM( + '/en/github/importing-your-projects-to-github/importing-source-code-to-github/about-github-importer' + ) const github = $('#homepages a.active[href="/en/github"]') expect(github.length).toBe(1) expect(github.text().trim()).toBe('GitHub') diff --git a/tests/rendering/server.js b/tests/rendering/server.js index 341b51e8a5..605f764845 100644 --- a/tests/rendering/server.js +++ b/tests/rendering/server.js @@ -461,7 +461,7 @@ describe('server', () => { test('dotcom articles on dotcom have links that include "en"', async () => { const $ = await getDOM('/en/articles/set-up-git') - expect($('a[href="/en/articles/managing-files-on-github"]').length).toBe(1) + expect($('a[href="/en/repositories/working-with-files/managing-files"]').length).toBe(1) }) test('dotcom articles on dotcom have Enterprise Admin links with latest GHE version', async () => { @@ -477,16 +477,16 @@ describe('server', () => { const $ = await getDOM( `${latestEnterprisePath}/github/getting-started-with-github/set-up-git` ) - expect($(`a[href="${latestEnterprisePath}/articles/managing-files-on-github"]`).length).toBe( - 1 - ) + expect( + $(`a[href="${latestEnterprisePath}/repositories/working-with-files/managing-files"]`).length + ).toBe(1) }) test('dotcom categories on GHE have Enterprise user links', async () => { - const $ = await getDOM(`${latestEnterprisePath}/github/managing-large-files`) + const $ = await getDOM(`${latestEnterprisePath}/github/writing-on-github`) expect( $( - `ul.list-style-circle li a[href="${latestEnterprisePath}/github/managing-large-files/working-with-large-files/conditions-for-large-files"]` + `ul.list-style-circle li a[href="${latestEnterprisePath}/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github"]` ).length ).toBe(1) }) @@ -511,7 +511,7 @@ describe('server', () => { ) expect( $( - `a[href="${latestEnterprisePath}/github/creating-cloning-and-archiving-repositories/about-repository-visibility"]` + `a[href="${latestEnterprisePath}/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility"]` ).length ).toBeGreaterThan(0) }) @@ -644,8 +644,8 @@ describe('server', () => { describe('categories and map topics', () => { test('adds links to categories on the dotcom homepage', async () => { const $ = await getDOM('/en/github') - expect($('a[href="/en/github/managing-large-files"]').length).toBe(1) - expect($('a[href="#managing-large-files"]').length).toBe(0) + expect($('a[href="/en/github/customizing-your-github-workflow"]').length).toBe(1) + expect($('a[href="#customizing-your-github-workflow"]').length).toBe(0) }) test('adds links to map topics on a category homepage', async () => { @@ -658,7 +658,7 @@ describe('server', () => { }) test('category page renders with TOC', async () => { - const $ = await getDOM('/en/github/managing-large-files') + const $ = await getDOM('/en/github/writing-on-github') expect($('[data-testid=table-of-contents] ul li a').length).toBeGreaterThan(5) })